Function table of CMPIError encapsulated data type object. More...

#include <cmpift.h>

Data Fields
CMPIVersion	ftVersion
	CMPI version supported by the MB for this function table. More...

CMPIStatus(*	release )(CMPIError *er)
	Release a CMPIError object. More...

CMPIError (	clone )(const CMPIError er, CMPIStatus rc)
	Create an independent copy of a CMPIError object. More...

CMPIErrorType(*	getErrorType )(const CMPIError er, CMPIStatus rc)
	Get the `ErrorType` attribute of a CMPIError object. More...

CMPIString (	getOtherErrorType )(const CMPIError er, CMPIStatus rc)
	Get the `OtherErrorType` attribute of a CMPIError object. More...

CMPIString (	getOwningEntity )(const CMPIError er, CMPIStatus rc)
	Get the `OwningEntity` attribute of a CMPIError object. More...

CMPIString (	getMessageID )(const CMPIError er, CMPIStatus rc)
	Get the `MessageID` attribute of a CMPIError object. More...

CMPIString (	getMessage )(const CMPIError er, CMPIStatus rc)
	Get the `Message` attribute of a CMPIError object. More...

CMPIErrorSeverity(*	getPerceivedSeverity )(const CMPIError er, CMPIStatus rc)
	Get the `PerceivedSeverity` attribute of a CMPIError object. More...

CMPIErrorProbableCause(*	getProbableCause )(const CMPIError er, CMPIStatus rc)
	Get the `ProbableCause` attribute of a CMPIError object. More...

CMPIString (	getProbableCauseDescription )(const CMPIError er, CMPIStatus rc)
	Get the `ProbableCauseDescription` attribute of a CMPIError object. More...

CMPIArray (	getRecommendedActions )(const CMPIError er, CMPIStatus rc)
	Get the `RecommendedActions` array attribute of a CMPIError object. More...

CMPIString (	getErrorSource )(const CMPIError er, CMPIStatus rc)
	Get the `ErrorSource` attribute of a CMPIError object. More...

CMPIErrorSrcFormat(*	getErrorSourceFormat )(const CMPIError er, CMPIStatus rc)
	Get the `ErrorSourceFormat` attribute of a CMPIError object. More...

CMPIString (	getOtherErrorSourceFormat )(const CMPIError er, CMPIStatus rc)
	Get the `OtherErrorSourceFormat` attribute of a CMPIError object. More...

CMPIrc(*	getCIMStatusCode )(const CMPIError er, CMPIStatus rc)
	Get the `CIMStatusCode` attribute of a CMPIError object. More...

CMPIString (	getCIMStatusCodeDescription )(const CMPIError er, CMPIStatus rc)
	Get the `CIMStatusCodeDescription` attribute of a CMPIError object. More...

CMPIArray (	getMessageArguments )(const CMPIError er, CMPIStatus rc)
	Get the `MessageArguments` array attribute of a CMPIError object. More...

CMPIStatus(*	setErrorType )(const CMPIError *er, const CMPIErrorType et)
	Set the `ErrorType` attribute of a CMPIError object. More...

CMPIStatus(*	setOtherErrorType )(const CMPIError er, const char ot)
	Set the `OtherErrorType` attribute of a CMPIError object. More...

CMPIStatus(*	setProbableCauseDescription )(const CMPIError er, const char pcd)
	Set the `ProbableCauseDescription` attribute of a CMPIError object. More...

CMPIStatus(*	setRecommendedActions )(const CMPIError er, const CMPIArray ra)
	Set the `RecommendedActions` array attribute of a CMPIError object. More...

CMPIStatus(*	setErrorSource )(const CMPIError er, const char es)
	Set the `ErrorSource` attribute of a CMPIError object. More...

CMPIStatus(*	setErrorSourceFormat )(const CMPIError *er, const CMPIErrorSrcFormat esf)
	Set the `ErrorSourceFormat` attribute of a CMPIError object. More...

CMPIStatus(*	setOtherErrorSourceFormat )(const CMPIError er, const char oef)
	Set the `OtherErrorSourceFormat` attribute of a CMPIError object. More...

CMPIStatus(*	setCIMStatusCodeDescription )(const CMPIError er, const char scd)
	Set the `CIMStatusCodeDescription` attribute of a CMPIError object. More...

CMPIStatus(*	setMessageArguments )(const CMPIError er, const CMPIArray values)
	Set the `MessageArguments` array attribute of a CMPIError object. More...

Detailed Description

Function table of CMPIError encapsulated data type object.

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Field Documentation

CMPIVersion CMPIErrorFT::ftVersion

CMPI version supported by the MB for this function table.

Any earlier CMPI versions are implicitly also supported.

See CMPIVersion<NNN> for valid CMPI version numbers.

CMPIStatus(* CMPIErrorFT::release)(CMPIError *er)

Release a CMPIError object.

CMPIErrorFT.release() releases a CMPIError object.

This indicates to the MB that the object (including any objects it contains) will no longer be used by the MI. The MB may free (=reclaim) the memory associated with the object during the call to this function, or later during some garbage collection cycle (see Subclause 4.1.7 of the CMPI Standard).

Parameters

er	Points to the CMPIError object that is to be released. That object shall have been created using CMPIErrorFT.clone().

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - er is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMRelease()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIError*(* CMPIErrorFT::clone)(const CMPIError *er, CMPIStatus *rc)

Create an independent copy of a CMPIError object.

CMPIErrorFT.clone() creates an independent copy of a CMPIError object.

Parameters

	er	Points to the CMPIError object that is to be copied.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a pointer to the copied CMPIError object will be returned.

The returned CMPIError object shall be explicitly released by the MI using CMPIErrorFT.release().

If not successful, NULL will be returned.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMClone()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIErrorType(* CMPIErrorFT::getErrorType)(const CMPIError *er, CMPIStatus *rc)

Get the ErrorType attribute of a CMPIError object.

CMPIErrorFT.getErrorType() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIErrorType enumeration value will be returned, indicating the value of the ErrorType attribute of the CMPIError object.

If not successful, the returned value is undefined.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetErrorType()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIString*(* CMPIErrorFT::getOtherErrorType)(const CMPIError *er, CMPIStatus *rc)

Get the OtherErrorType attribute of a CMPIError object.

CMPIErrorFT.getOtherErrorType() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the OtherErrorType attribute of the CMPIError object is non-NULL, a pointer to a CMPIString object will be returned, indicating the value of the OtherErrorType attribute of the CMPIError object.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIError object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetOtherErrorType()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIString*(* CMPIErrorFT::getOwningEntity)(const CMPIError *er, CMPIStatus *rc)

Get the OwningEntity attribute of a CMPIError object.

CMPIErrorFT.getOwningEntity() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the OwningEntity attribute of the CMPIError object is non-NULL, a pointer to a CMPIString object will be returned, indicating the value of the OwningEntity attribute of the CMPIError object.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIError object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetOwningEntity()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIString*(* CMPIErrorFT::getMessageID)(const CMPIError *er, CMPIStatus *rc)

Get the MessageID attribute of a CMPIError object.

CMPIErrorFT.getMessageID() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the MessageID attribute of the CMPIError object is non-NULL, a pointer to a CMPIString object will be returned, indicating the value of the MessageID attribute of the CMPIError object.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIError object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetMessageID()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIString*(* CMPIErrorFT::getMessage)(const CMPIError *er, CMPIStatus *rc)

Get the Message attribute of a CMPIError object.

CMPIErrorFT.getMessage() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the Message attribute of the CMPIError object is non-NULL, a pointer to a CMPIString object will be returned, indicating the value of the Message attribute of the CMPIError object.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIError object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetErrorMessage()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIErrorSeverity(* CMPIErrorFT::getPerceivedSeverity)(const CMPIError *er, CMPIStatus *rc)

Get the PerceivedSeverity attribute of a CMPIError object.

CMPIErrorFT.getPerceivedSeverity() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIErrorSeverity enumeration value will be returned, indicating the value of the PerceivedSeverity attribute of the CMPIError object.

If not successful, the returned value is undefined.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetPerceivedSeverity()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIErrorProbableCause(* CMPIErrorFT::getProbableCause)(const CMPIError *er, CMPIStatus *rc)

Get the ProbableCause attribute of a CMPIError object.

CMPIErrorFT.getProbableCause() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIErrorProbableCause enumeration value will be returned, indicating the value of the ProbableCause attribute of the CMPIError object.

If not successful, the returned value is undefined.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetProbableCause()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIString*(* CMPIErrorFT::getProbableCauseDescription)(const CMPIError *er, CMPIStatus *rc)

Get the ProbableCauseDescription attribute of a CMPIError object.

CMPIErrorFT.getProbableCauseDescription() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the ProbableCauseDescription attribute of the CMPIError object is non-NULL, a pointer to a CMPIString object will be returned, indicating the value of the ProbableCauseDescription attribute of the CMPIError object.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIError object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetProbableCauseDescription()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIArray*(* CMPIErrorFT::getRecommendedActions)(const CMPIError *er, CMPIStatus *rc)

Get the RecommendedActions array attribute of a CMPIError object.

CMPIErrorFT.getRecommendedActions() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the RecommendedActions array attribute of the CMPIError object is non-NULL, a pointer to a CMPIArray object will be returned, containing CMPIString elements that represent the array elements of the RecommendedActions array attribute in the CMPIError object.

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetRecommendedActions()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIString*(* CMPIErrorFT::getErrorSource)(const CMPIError *er, CMPIStatus *rc)

Get the ErrorSource attribute of a CMPIError object.

CMPIErrorFT.getErrorSource() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the ErrorSource attribute of the CMPIError object is non-NULL, a pointer to a CMPIString object will be returned, indicating the value of the ErrorSource attribute of the CMPIError object.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIError object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetErrorSource()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIErrorSrcFormat(* CMPIErrorFT::getErrorSourceFormat)(const CMPIError *er, CMPIStatus *rc)

Get the ErrorSourceFormat attribute of a CMPIError object.

CMPIErrorFT.getErrorSourceFormat() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIErrorSrcFormat enumeration will be returned, indicating the value of the ErrorSourceFormat attribute of the CMPIError object.

If not successful, the returned value is undefined.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetErrorSourceFormat()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIString*(* CMPIErrorFT::getOtherErrorSourceFormat)(const CMPIError *er, CMPIStatus *rc)

Get the OtherErrorSourceFormat attribute of a CMPIError object.

CMPIErrorFT.getOtherErrorSourceFormat() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the OtherErrorSource attribute of the CMPIError object is non-NULL, a pointer to a CMPIString object will be returned, indicating the value of the OtherErrorSourceFormat attribute of the CMPIError object.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIError object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetOtherErrorSourceFormat()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIrc(* CMPIErrorFT::getCIMStatusCode)(const CMPIError *er, CMPIStatus *rc)

Get the CIMStatusCode attribute of a CMPIError object.

CMPIErrorFT.getCIMStatusCode() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful, a CMPIrc value will be returned, indicating the value of the CIMStatusCode attribute of the CMPIError object. Please note that not all status codes apply to all situations.

It is up to the MI to ensure the correct status code is set.

If not successful, the returned value is undefined.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetCIMStatusCode()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIString*(* CMPIErrorFT::getCIMStatusCodeDescription)(const CMPIError *er, CMPIStatus *rc)

Get the CIMStatusCodeDescription attribute of a CMPIError object.

CMPIErrorFT.getCIMStatusCodeDescription() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the CIMStatusCodeDescription attribute of the CMPIError object is non-NULL, a pointer to a CMPIString object will be returned, indicating the value of the CIMStatusCodeDescription attribute of the CMPIError object.

The returned CMPIString object shall not be explicitly released by the MI, because it may be an internal object of the CMPIError object which will be released along with that object, or a new object created by the MB which will be released automatically by the MB (see Subclause 4.1.7 of the CMPI Standard).

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetCIMStatusCodeDescription()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIArray*(* CMPIErrorFT::getMessageArguments)(const CMPIError *er, CMPIStatus *rc)

Get the MessageArguments array attribute of a CMPIError object.

CMPIErrorFT.getMessageArguments() gets the value of 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

	er	Points to the CMPIError object for this function.
[out]	rc	If not NULL, points to a CMPIStatus structure that upon return will have been updated with the function return status.

Returns

If successful and the MessageArguments array attribute of the CMPIError object is non-NULL, a pointer to a CMPIArray object will be returned, containing CMPIString objects that represent the array elements of the MessageArguments array attribute of the CMPIError object.

Otherwise, NULL will be returned.

The caller must inspect the function return status to see whether the function failed.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMGetMessageArguments()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setErrorType)(const CMPIError *er, const CMPIErrorType et)

Set the ErrorType attribute of a CMPIError object.

CMPIErrorFT.setErrorType() sets the value of 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

er	Points to the CMPIError object for this function.
et	A CMPIErrorType enumeration value specifying the new value for the `ErrorType` attribute. If the error message in the CMPIError object is defined in a DMTF message registry, `et` shall reflect the content of the ERROR_TYPE element defined for the message in the registry.

Returns: CMPIStatus structure containing the function return status

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetErrorType()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setOtherErrorType)(const CMPIError *er, const char *ot)

Set the OtherErrorType attribute of a CMPIError object.

CMPIErrorFT.setOtherErrorType() sets the value of 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

er	Points to the CMPIError object for this function.
ot	New non-NULL value for the `OtherErrorType` attribute, or is NULL specifying that the attribute will be set to NULL. If the error message is defined in a DMTF message registry, the string value of `ot` shall be the content of the OTHER_ERROR_TYPE element defined for the message in the registry.

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetOtherErrorType()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setProbableCauseDescription)(const CMPIError *er, const char *pcd)

Set the ProbableCauseDescription attribute of a CMPIError object.

CMPIErrorFT.setProbableCauseDescription() sets the value of 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

er	Points to the CMPIError object for this function.
pcd	New non-NULL value for the `ProbableCauseDescription` attribute, or is NULL specifying that the attribute will be set to NULL. If the error message is defined in a DMTF message registry, note that the string value of `pcd` is not defined in the message in the registry.

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetProbableCauseDescription()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setRecommendedActions)(const CMPIError *er, const CMPIArray *ra)

Set the RecommendedActions array attribute of a CMPIError object.

CMPIErrorFT.setRecommendedActions() sets the value of 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

er	Points to the CMPIError object for this function.
ra	Points to a CMPIArray object specifying the new array value for the `RecommendedActions` array attribute. The CMPIArray object contains CMPIString objects or NULL values as array elements. `ra`

may be NULL, specifying that the RecommendedActions array attribute will be set to NULL. If the error message is defined in a DMTF message registry, ra shall reflect the values defined in the RECOMMENDED_ACTION elements defined for the message in the registry, in the order defined there.

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetRecommendedActions()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setErrorSource)(const CMPIError *er, const char *es)

Set the ErrorSource attribute of a CMPIError object.

CMPIErrorFT.setErrorSource() sets the value of 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

er	Points to the CMPIError object for this function.
es	New non-NULL value for the `ErrorSource` attribute, or is NULL specifying that the attribute will be set to NULL. If the error message is defined in a DMTF message registry, the string value of `es` shall be the content of the ERROR_SOURCE element defined for the message in the registry.

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetErrorSource()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setErrorSourceFormat)(const CMPIError *er, const CMPIErrorSrcFormat esf)

Set the ErrorSourceFormat attribute of a CMPIError object.

CMPIErrorFT.setErrorSourceFormat() sets the value of 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

er	Points to the CMPIError object for this function.
esf	A CMPIErrorSrcFormat enumeration value specifying the new value for the `ErrorSourceFormat` attribute. If the error message is defined in a DMTF message registry, the string value of `esf` shall be the content of the ERROR_SOURCE_FORMAT element defined for the message in the registry.

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetErrorSourceFormat()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setOtherErrorSourceFormat)(const CMPIError *er, const char *oef)

Set the OtherErrorSourceFormat attribute of a CMPIError object.

CMPIErrorFT.setOtherErrorSourceFormat() sets the value of 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

er	Points to the CMPIError object for this function.
oef	New non-NULL value for the `OtherErrorSourceFormat` attribute, or NULL specifying that the attribute will be set to NULL. If the error message is defined in a DMTF message registry, the string value of `oef` shall be the content of the OTHER_ERROR_SOURCE_FORMAT element defined for the message in the registry.

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetOtherErrorSourceFormat()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setCIMStatusCodeDescription)(const CMPIError *er, const char *scd)

Set the CIMStatusCodeDescription attribute of a CMPIError object.

CMPIErrorFT.setCIMStatusCodeDescription() sets the value of 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

er	Points to the CMPIError object for this function.
scd	New non-NULL value for the `CIMStatusCodeDescription` attribute, or NULL specifying that the attribute will be set to NULL. If the error message is defined in a DMTF message registry, note that the string value of `scd` is not defined in the message in the registry.

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetCIMStatusCodeDescription()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

CMPIStatus(* CMPIErrorFT::setMessageArguments)(const CMPIError *er, const CMPIArray *values)

Set the MessageArguments array attribute of a CMPIError object.

CMPIErrorFT.setMessageArguments() sets the value of 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

er Points to the CMPIError object for this function.

values CMPIArray object specifying the new array value for the MessageArguments array attribute. The CMPIArray object contains CMPIString objects or NULL values as array elements. values may be NULL, specifying that the MessageArguments array attribute will be set to NULL. If the error message is defined in a DMTF message registry, values shall reflect the values defined in the DYNAMIC_ELEMENT elements defined for the message in the registry, in the order defined there.

Returns: CMPIStatus structure containing the function return status.

Errors

The function return status will indicate one of the following CMPIrc codes:

CMPI_RC_OK - Function successful.
CMPI_RC_ERR_NOT_SUPPORTED - Function is not supported by the MB. (Deprecated)
CMPI_RC_ERR_INVALID_PARAMETER - One of the arguments is invalid.
CMPI_RC_ERR_FAILED - Other error occurred.

Convenience Function: CMSetMessageArguments()

Capabilities:: Part of the Extended Errors capability.

Addition:: Added in CMPI 2.0.

Requirement Change:: Required to be supported since CMPI 2.1.

Deprecated:: The return code CMPI_RC_ERR_NOT_SUPPORTED of this function is deprecated since CMPI 2.1. It will not be returned because the Extended Errors capability will be available.

The documentation for this struct was generated from the following file:

cmpift.h

Data Fields

Detailed Description

Field Documentation