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

Functions

static CMPIErrorType CMGetErrorType (const CMPIError *er, CMPIStatus *rc)
 Get the ErrorType attribute of a CMPIError object. More...
 
static CMPIStringCMGetOtherErrorType (const CMPIError *er, CMPIStatus *rc)
 Get the OtherErrorType attribute of a CMPIError object. More...
 
static CMPIStringCMGetOwningEntity (const CMPIError *er, CMPIStatus *rc)
 Get the OwningEntity attribute of a CMPIError object. More...
 
static CMPIStringCMGetMessageID (const CMPIError *er, CMPIStatus *rc)
 Get the MessageID attribute of a CMPIError object. More...
 
static CMPIStringCMGetErrorMessage (const CMPIError *er, CMPIStatus *rc)
 Get the Message attribute of a CMPIError object. More...
 
static CMPIErrorSeverity CMGetPerceivedSeverity (const CMPIError *er, CMPIStatus *rc)
 Get the PerceivedSeverity attribute of a CMPIError object. More...
 
static CMPIErrorProbableCause CMGetProbableCause (const CMPIError *er, CMPIStatus *rc)
 Get the ProbableCause attribute of a CMPIError object. More...
 
static CMPIStringCMGetProbableCauseDescription (const CMPIError *er, CMPIStatus *rc)
 Get the ProbableCauseDescription attribute of a CMPIError object. More...
 
static CMPIArrayCMGetRecommendedActions (const CMPIError *er, CMPIStatus *rc)
 Get the RecommendedActions array attribute of a CMPIError object. More...
 
static CMPIStringCMGetErrorSource (const CMPIError *er, CMPIStatus *rc)
 Get the ErrorSource attribute of a CMPIError object. More...
 
static CMPIErrorSrcFormat CMGetErrorSourceFormat (const CMPIError *er, CMPIStatus *rc)
 Get the ErrorSourceFormat attribute of a CMPIError object. More...
 
static CMPIStringCMGetOtherErrorSourceFormat (const CMPIError *er, CMPIStatus *rc)
 Get the OtherErrorSourceFormat attribute of a CMPIError object. More...
 
static CMPIrc CMGetCIMStatusCode (const CMPIError *er, CMPIStatus *rc)
 Get the CIMStatusCode attribute of a CMPIError object. More...
 
static CMPIStringCMGetCIMStatusCodeDescription (const CMPIError *er, CMPIStatus *rc)
 Get the CIMStatusCodeDescription attribute of a CMPIError object. More...
 
static CMPIArrayCMGetMessageArguments (const CMPIError *er, CMPIStatus *rc)
 Get the MessageArguments array attribute of a CMPIError object. More...
 
static CMPIStatus CMSetErrorType (const CMPIError *er, const CMPIErrorType et)
 Set the ErrorType attribute of a CMPIError object. More...
 
static CMPIStatus CMSetOtherErrorType (const CMPIError *er, const char *ot)
 Set the OtherErrorType attribute of a CMPIError object. More...
 
static CMPIStatus CMSetProbableCauseDescription (const CMPIError *er, const char *pcd)
 Set the ProbableCauseDescription attribute of a CMPIError object. More...
 
static CMPIStatus CMSetRecommendedActions (const CMPIError *er, const CMPIArray *ra)
 Set the RecommendedActions array attribute of a CMPIError object. More...
 
static CMPIStatus CMSetErrorSource (const CMPIError *er, const char *es)
 Set the ErrorSource attribute of a CMPIError object. More...
 
static CMPIStatus CMSetErrorSourceFormat (const CMPIError *er, const CMPIErrorSrcFormat esf)
 Set the ErrorSourceFormat attribute of a CMPIError object. More...
 
static CMPIStatus CMSetOtherErrorSourceFormat (const CMPIError *er, const char *oef)
 Set the OtherErrorSourceFormat attribute of a CMPIError object. More...
 
static CMPIStatus CMSetCIMStatusCodeDescription (const CMPIError *er, const char *scd)
 Set the CIMStatusCodeDescription attribute of a CMPIError object. More...
 
static CMPIStatus CMSetMessageArguments (const CMPIError *er, const CMPIArray *values)
 Set the MessageArguments array attribute of a CMPIError object. More...
 
static CMPIBoolean CMIsPropertyInList (const CMPIPropertyList *plist, const char *pname, CMPIStatus *rc)
 Test whether a property is in the property list represented by a CMPIPropertyList object. More...
 
static const char ** CMGetListProperties (const CMPIPropertyList *plist, CMPIStatus *rc)
 Return the property list represented by a CMPIPropertyList object as an array of C-language strings. More...
 
static CMPIBoolean CMFilterMatch (const CMPIEnumerationFilter *ef, const CMPIInstance *inst, CMPIStatus *rc)
 Test whether an instance matches the filter represented by a CMPIEnumerationFilter object. More...
 

Detailed Description

Function Documentation

static CMPIErrorType CMGetErrorType ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the ErrorType attribute of a CMPIError object.

For a description of the ErrorType attribute, see CMPIErrorType and the description of the ErrorType property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The ErrorType attribute.
Full Description
CMPIErrorFT.getErrorType()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Used and tested
static CMPIString* CMGetOtherErrorType ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the OtherErrorType attribute of a CMPIError object.

For a description of the OtherErrorType attribute, see the description of the OtherErrorType property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The OtherErrorType attribute.
Full Description
CMPIErrorFT.getOtherErrorType()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Used and tested
static CMPIString* CMGetOwningEntity ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the OwningEntity attribute of a CMPIError object.

For a description of the OwningEntity attribute, see the description of the OwningEntity property in the CIM_Error class in the CIM Schema, and the description of the owner argument of CMPIBrokerEncFT.newCMPIError().

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The OwningEntity attribute.
Full Description
CMPIErrorFT.getOwningEntity()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIString* CMGetMessageID ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the MessageID attribute of a CMPIError object.

For a description of the MessageID attribute, see the description of the MessageID property in the CIM_Error class in the CIM Schema, and the description of the msgID argument of CMPIBrokerEncFT.newCMPIError().

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The MessageID attribute.
Full Description
CMPIErrorFT.getMessageID()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIString* CMGetErrorMessage ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the Message attribute of a CMPIError object.

For a description of the Message attribute, see the description of the Message property in the CIM_Error class in the CIM Schema, and the description of the msg argument of CMPIBrokerEncFT.newCMPIError().

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The Message attribute.
Full Description
CMPIErrorFT.getMessage()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIErrorSeverity CMGetPerceivedSeverity ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the PerceivedSeverity attribute of a CMPIError object.

For a description of the PerceivedSeverity attribute, see CMPIErrorSeverity, the description of the PerceivedSeverity property in the CIM_Error class in the CIM Schema, and the description of the sev argument of CMPIBrokerEncFT.newCMPIError().

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The PerceivedSeverity attribute.
Full Description
CMPIErrorFT.getPerceivedSeverity()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIErrorProbableCause CMGetProbableCause ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the ProbableCause attribute of a CMPIError object.

For a description of the ProbableCause attribute, see CMPIErrorProbableCause, the description of the ProbableCause property in the CIM_Error class in the CIM Schema, and the description of the pc argument of CMPIBrokerEncFT.newCMPIError().

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The ProbableCause attribute.
Full Description
CMPIErrorFT.getProbableCause()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIString* CMGetProbableCauseDescription ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the ProbableCauseDescription attribute of a CMPIError object.

For a description of the ProbableCauseDescription attribute, see the description of the ProbableCauseDescription property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The ProbableCauseDescription attribute.
Full Description
CMPIErrorFT.getProbableCauseDescription()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIArray* CMGetRecommendedActions ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the RecommendedActions array attribute of a CMPIError object.

For a description of the RecommendedActions attribute, see the description of the RecommendedActions property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The RecommendedActions array attribute.
Full Description
CMPIErrorFT.getRecommendedActions()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIString* CMGetErrorSource ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the ErrorSource attribute of a CMPIError object.

For a description of the ErrorSource attribute, see the description of the ErrorSource property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The ErrorSource attribute.
Full Description
CMPIErrorFT.getErrorSource()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIErrorSrcFormat CMGetErrorSourceFormat ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the ErrorSourceFormat attribute of a CMPIError object.

For a description of the ErrorSourceFormat attribute, see the description of the ErrorSourceFormat property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The ErrorSourceFormat attribute.
Full Description
CMPIErrorFT.getErrorSourceFormat()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIString* CMGetOtherErrorSourceFormat ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the OtherErrorSourceFormat attribute of a CMPIError object.

For a description of the OtherErrorSourceFormat attribute, see the description of the OtherErrorSourceFormat property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The OtherErrorSourceFormat attribute.
Full Description
CMPIErrorFT.getOtherErrorSourceFormat()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIrc CMGetCIMStatusCode ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the CIMStatusCode attribute of a CMPIError object.

For a description of the CIMStatusCode attribute, see the description of the CIMStatusCode property in the CIM_Error class in the CIM Schema, and the description of the cimStatusCode argument of CMPIBrokerEncFT.newCMPIError().

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The CIMStatusCode attribute.
Full Description
CMPIErrorFT.getCIMStatusCode()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
Tested
static CMPIString* CMGetCIMStatusCodeDescription ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the CIMStatusCodeDescription attribute of a CMPIError object.

For a description of the CIMStatusCodeDescription attribute, see the description of the CIMStatusCodeDescription property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The CIMStatusCodeDescription attribute.
Full Description
CMPIErrorFT.getCIMStatusCodeDescription()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIArray* CMGetMessageArguments ( const CMPIError er,
CMPIStatus rc 
)
inlinestatic

Get the MessageArguments array attribute of a CMPIError object.

For a description of the MessageArguments attribute, see the description of the MessageArguments property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
[out]rcFunction return status (suppressed when NULL).
Returns
The MessageArguments array attribute.
Full Description
CMPIErrorFT.getMessageArguments()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetErrorType ( const CMPIError er,
const CMPIErrorType  et 
)
inlinestatic

Set the ErrorType attribute of a CMPIError object.

For a description of the ErrorType attribute, see CMPIErrorType and the description of the ErrorType property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
etThe ErrorType attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setErrorType()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetOtherErrorType ( const CMPIError er,
const char *  ot 
)
inlinestatic

Set the OtherErrorType attribute of a CMPIError object.

For a description of the OtherErrorType attribute, see the description of the OtherErrorType property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
otThe OtherErrorType attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setOtherErrorType()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetProbableCauseDescription ( const CMPIError er,
const char *  pcd 
)
inlinestatic

Set the ProbableCauseDescription attribute of a CMPIError object.

For a description of the ProbableCauseDescription attribute, see the description of the ProbableCauseDescription property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
pcdThe ProbableCauseDescription attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setProbableCauseDescription()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetRecommendedActions ( const CMPIError er,
const CMPIArray ra 
)
inlinestatic

Set the RecommendedActions array attribute of a CMPIError object.

For a description of the RecommendedActions attribute, see the description of the RecommendedActions property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
raThe RecommendedActions array attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setRecommendedActions()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetErrorSource ( const CMPIError er,
const char *  es 
)
inlinestatic

Set the ErrorSource attribute of a CMPIError object.

For a description of the ErrorSource attribute, see the description of the ErrorSource property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
esThe ErrorSource attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setErrorSource()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetErrorSourceFormat ( const CMPIError er,
const CMPIErrorSrcFormat  esf 
)
inlinestatic

Set the ErrorSourceFormat attribute of a CMPIError object.

For a description of the ErrorSourceFormat attribute, see the description of the ErrorSourceFormat property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
esfThe ErrorSourceFormat attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setErrorSourceFormat()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetOtherErrorSourceFormat ( const CMPIError er,
const char *  oef 
)
inlinestatic

Set the OtherErrorSourceFormat attribute of a CMPIError object.

For a description of the OtherErrorSourceFormat attribute, see the description of the OtherErrorSourceFormat property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
oefThe OtherErrorSourceFormat attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setOtherErrorSourceFormat()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetCIMStatusCodeDescription ( const CMPIError er,
const char *  scd 
)
inlinestatic

Set the CIMStatusCodeDescription attribute of a CMPIError object.

For a description of the CIMStatusCodeDescription attribute, see the description of the CIMStatusCodeDescription property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
scdThe CIMStatusCodeDescription attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setCIMStatusCodeDescription()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIStatus CMSetMessageArguments ( const CMPIError er,
const CMPIArray values 
)
inlinestatic

Set the MessageArguments array attribute of a CMPIError object.

For a description of the MessageArguments attribute, see the description of the MessageArguments property in the CIM_Error class in the CIM Schema.

Parameters
erCMPIError object.
valuesThe MessageArguments array attribute.
Returns
Function return status.
Full Description
CMPIErrorFT.setMessageArguments()
Addition:
Added in CMPI 2.0.
Change:
The inline function was fixed in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIBoolean CMIsPropertyInList ( const CMPIPropertyList plist,
const char *  pname,
CMPIStatus rc 
)
inlinestatic

Test whether a property is in the property list represented by a CMPIPropertyList object.

Parameters
plistCMPIPropertyList object.
pnameName of the property to be tested.
[out]rcFunction return status (suppressed when NULL).
Return values
trueThe property is in the property list.
falseThe property is not in the property list.
Full Description
CMPIPropertyListFT.isPropertyInList()
Addition:
Added in CMPI 2.1.
Status for OpenPegasus:
TBD
static const char** CMGetListProperties ( const CMPIPropertyList plist,
CMPIStatus rc 
)
inlinestatic

Return the property list represented by a CMPIPropertyList object as an array of C-language strings.

Parameters
plistCMPIPropertyList object.
[out]rcFunction return status (suppressed when NULL).
Returns
The property list.
Full Description
CMPIPropertyListFT.getProperties()
Addition:
Added in CMPI 2.1.
Status for OpenPegasus:
TBD
static CMPIBoolean CMFilterMatch ( const CMPIEnumerationFilter ef,
const CMPIInstance inst,
CMPIStatus rc 
)
inlinestatic

Test whether an instance matches the filter represented by a CMPIEnumerationFilter object.

Parameters
efCMPIEnumerationFilter object.
instInstance to be tested against the filter.
[out]rcFunction return status (suppressed when NULL).
Return values
trueThe instance matches the filter.
falseThe instance does not match the filter.
Full Description
CMPIEnumerationFilterFT.match()
Addition:
Added in CMPI 2.1.
Status for OpenPegasus:
TBD