CMPI 2.1.0 API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions

Functions

static CMPIData CMGetProperty (const CMPIInstance *inst, const char *name, CMPIStatus *rc)
 Get a property in a CMPIInstance object by name. More...
 
static CMPIData CMGetPropertyAt (const CMPIInstance *inst, CMPICount index, CMPIString **name, CMPIStatus *rc)
 Get a property in a CMPIInstance object by index. More...
 
static CMPICount CMGetPropertyCount (const CMPIInstance *inst, CMPIStatus *rc)
 Get the number of properties in a CMPIInstance object. More...
 
static CMPIStatus CMSetProperty (const CMPIInstance *inst, const char *name, const CMPIValue *value, const CMPIType type)
 Add or replace a property value in a CMPIInstance object by name. More...
 
static CMPIObjectPathCMGetObjectPath (const CMPIInstance *inst, CMPIStatus *rc)
 Get the instance path component of a CMPIInstance object. More...
 
static CMPIStatus CMSetPropertyFilter (const CMPIInstance *inst, const char **properties, const char **keyList)
 Attach a property filter to a CMPIInstance object. More...
 
static CMPIStatus CMSetObjectPath (const CMPIInstance *inst, const CMPIObjectPath *op)
 Set the instance path component of a CMPIInstance object. More...
 
static CMPIStatus CMSetPropertyWithOrigin (const CMPIInstance *inst, const char *name, const CMPIValue *value, CMPIType type, const char *origin)
 Add or replace a property value and class origin in a CMPIInstance object by name. More...
 

Detailed Description

Function Documentation

static CMPIData CMGetProperty ( const CMPIInstance inst,
const char *  name,
CMPIStatus rc 
)
inlinestatic

Get a property in a CMPIInstance object by name.

Parameters
instCMPIInstance object.
nameName of the property.
[out]rcFunction return status (suppressed when NULL).
Returns
Property value and type.
Full Description
CMPIInstanceFT.getProperty()
Examples
(.c)
CMPIInstance *inst = NULL;
// . . . make the inst
CMPIData rtnData;
const char* name1 = "propertyName";
rtnData = CMGetProperty(inst, name1, &rc);
assert(rtnData.state != CMPI_badValue);
Status for OpenPegasus:
Used and tested extensively
static CMPIData CMGetPropertyAt ( const CMPIInstance inst,
CMPICount  index,
CMPIString **  name,
CMPIStatus rc 
)
inlinestatic

Get a property in a CMPIInstance object by index.

Parameters
instCMPIInstance object.
indexZero-based position of the property in the internal data array.
[out]nameName of the returned property (suppressed when NULL).
[out]rcFunction return status (suppressed when NULL).
Returns
Property value and type.
Full Description
CMPIInstanceFT.getPropertyAt()
Status for OpenPegasus:
Used
static CMPICount CMGetPropertyCount ( const CMPIInstance inst,
CMPIStatus rc 
)
inlinestatic

Get the number of properties in a CMPIInstance object.

Parameters
instCMPIInstance object.
[out]rcFunction return status (suppressed when NULL).
Returns
Number of properties in the instance.
Full Description
CMPIInstanceFT.getPropertyCount()
Status for OpenPegasus:
TBD
static CMPIStatus CMSetProperty ( const CMPIInstance inst,
const char *  name,
const CMPIValue value,
const CMPIType  type 
)
inlinestatic

Add or replace a property value in a CMPIInstance object by name.

Parameters
instCMPIInstance object.
nameName of the property.
valueCMPIValue structure containing the non-NULL value to be assigned to the element, or NULL to assign NULL.
typeType of the value.
Returns
Function return status.
Full Description
CMPIInstanceFT.setProperty()
Status for OpenPegasus:
Used and tested extensively
Todo:
TODO_KS AM: Why do we have the (CMPIValue *) cast in the macro version?
We agreed that the cast should be removed because it hides type errors and has no apparent value.
Karl to test this against all of OpenPegasus providers.
static CMPIObjectPath* CMGetObjectPath ( const CMPIInstance inst,
CMPIStatus rc 
)
inlinestatic

Get the instance path component of a CMPIInstance object.

Parameters
instCMPIInstance object.
[out]rcFunction return status (suppressed when NULL).
Returns
Instance path component of the CMPIInstance object.
Full Description
CMPIInstanceFT.getObjectPath()
Status for OpenPegasus:
Used and tested extensively in cmpiTestMethodProvider.c
static CMPIStatus CMSetPropertyFilter ( const CMPIInstance inst,
const char **  properties,
const char **  keyList 
)
inlinestatic

Attach a property filter to a CMPIInstance object.

Parameters
instCMPIInstance object.
propertiesIf not NULL, the members of the array define one or more property names to be accepted by subsequent setProperty() function calls.
keyListDeprecated, ignored by MB, maintained here for compatibility.
Returns
Function return status.
Full Description
CMPIInstanceFT.setPropertyFilter()
Status for OpenPegasus:
Not used
static CMPIStatus CMSetObjectPath ( const CMPIInstance inst,
const CMPIObjectPath op 
)
inlinestatic

Set the instance path component of a CMPIInstance object.

Parameters
instCMPIInstance object.
opNew instance path.
Returns
Function return status.
Full Description
CMPIInstanceFT.setObjectPath()
Status for OpenPegasus:
Used
static CMPIStatus CMSetPropertyWithOrigin ( const CMPIInstance inst,
const char *  name,
const CMPIValue value,
CMPIType  type,
const char *  origin 
)
inlinestatic

Add or replace a property value and class origin in a CMPIInstance object by name.

Parameters
instCMPIInstance object.
nameName of the property.
valueCMPIValue structure containing the non-NULL value to be assigned to the element, or NULL to assign NULL.
typeType of the value.
originClass origin of the property. If NULL, no class origin is attached to the property.
Returns
Function return status.
Full Description
CMPIInstanceFT.setPropertyWithOrigin()
Addition:
Added in CMPI 2.0.
Status for OpenPegasus:
TBD