struct _CMPIErrorFT

This structure is a table of pointers providing access to Error support services

Documentation

This structure is a table of pointers providing access to Error support services

[more]CMPISint32 ftVersion
Function table version
[more]CMPIStatus (*release)(CMPIError*)
The Error object will not be used any further and may be freed by CMPI run time system.
[more]CMPIError* (*clone)(const CMPIError*, CMPIStatus*)
Create an independent copy of this Error object.
[more]CMPIErrorType (*getErrorType)(const CMPIError*, CMPIStatus*)
Gets the type of this Error
[more]CMPIString* (*getOtherErrorType)(const CMPIError*, CMPIStatus*)
Returns a string which describes the alternate error type.
[more]CMPIString* (*getOwningEntity)(const CMPIError*, CMPIStatus*)
Returns a string which describes the owneing entity
[more]CMPIString* (*getMessageID)(const CMPIError*, CMPIStatus*)
Returns a string which is the message ID.
[more]CMPIString* (*getMessage)(const CMPIError*, CMPIStatus*)
Returns a string comnating an error message.
[more]CMPIErrorSeverity (*getPerceivedSeverity)(const CMPIError*, CMPIStatus*)
Returns the perceieved severity of this error.
[more]CMPIErrorProbableCause (*getProbableCause)(const CMPIError*, CMPIStatus*)
Returns the probable cause of this error.
[more]CMPIString* (*getProbableCauseDescription)(const CMPIError*, CMPIStatus*)
Returns a string which describes the probable cause.
[more]CMPIArray* (*getRecommendedActions)(const CMPIError*, CMPIStatus*)
Returns an array of strings which describes recomended actions.
[more]CMPIString* (*getErrorSource)(const CMPIError*, CMPIStatus*)
Returns a string which describes the Error source.
[more]CMPIErrorSrcFormat (*getErrorSourceFormat)(const CMPIError*, CMPIStatus*)
Returns a the format that the error src is in.
[more]CMPIString* (*getOtherErrorSourceFormat)(const CMPIError*, CMPIStatus*)
Returns a string which describes the 'other' format, only available if the error source is OTHER.
[more]CMPIrc (*getCIMStatusCode)(const CMPIError*, CMPIStatus*)
Returns the status code of this error.
[more]CMPIString* (*getCIMStatusCodeDescription)(const CMPIError*, CMPIStatus*)
Returns a string which describes the status code error.
[more]CMPIArray* (*getMessageArguments)(const CMPIError*, CMPIStatus*)
Returns an array which contains the dynamic content of the message.
[more]CMPIStatus (*setErrorType)(CMPIError*, const CMPIErrorType)
Sets the error type of this error object.
[more]CMPIStatus (*setOtherErrorType)(CMPIError*, const char* )
Sets the 'other' error type of this error object.
[more]CMPIStatus (*setProbableCauseDescription)(CMPIError*, const char* )
Sets the description of the probable cause.
[more]CMPIStatus (*setRecommendedActions)(CMPIError*, const CMPIArray*)
Sets the recomended actions array.
[more]CMPIStatus (*setErrorSource)(CMPIError*, const char*)
Specifies a string which specifes The identifying information of the entity (ie, the instance) generating the error.
[more]CMPIStatus (*setErrorSourceFormat)(CMPIError*, const CMPIErrorSrcFormat )
Sets the source format of the error object
[more]CMPIStatus (*setOtherErrorSourceFormat)(CMPIError*, const char*)
specifies A string defining "Other" values for ErrorSourceFormat
[more]CMPIStatus (*setCIMStatusCodeDescription)(CMPIError*, const char*)
Sets the description of the status code.
[more]CMPIStatus (*setMessageArguments)(CMPIError*, CMPIArray*)
Sets an array of strings for the dynamic content of the message

oCMPISint32 ftVersion
Function table version

oCMPIStatus (*release)(CMPIError*)
The Error object will not be used any further and may be freed by CMPI run time system.
Parameters:
er - Error this pointer.
Returns:
Service return status.

oCMPIError* (*clone)(const CMPIError*, CMPIStatus*)
Create an independent copy of this Error object.
Parameters:
er - Error this pointer.
- rc Output: Service return status (suppressed when NULL).
Returns:
Pointer to copied Error object.

oCMPIErrorType (*getErrorType)(const CMPIError*, CMPIStatus*)
Gets the type of this Error
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
the error type this Error object conatins

oCMPIString* (*getOtherErrorType)(const CMPIError*, CMPIStatus*)
Returns a string which describes the alternate error type.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A string, which can be NULL

oCMPIString* (*getOwningEntity)(const CMPIError*, CMPIStatus*)
Returns a string which describes the owneing entity
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A string, which can be NULL

oCMPIString* (*getMessageID)(const CMPIError*, CMPIStatus*)
Returns a string which is the message ID.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A string, which can be NULL

oCMPIString* (*getMessage)(const CMPIError*, CMPIStatus*)
Returns a string comnating an error message.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A string, which can be NULL

oCMPIErrorSeverity (*getPerceivedSeverity)(const CMPIError*, CMPIStatus*)
Returns the perceieved severity of this error.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
the perceived severity

oCMPIErrorProbableCause (*getProbableCause)(const CMPIError*, CMPIStatus*)
Returns the probable cause of this error.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A probable cause value

oCMPIString* (*getProbableCauseDescription)(const CMPIError*, CMPIStatus*)
Returns a string which describes the probable cause.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A string, which can be NULL

oCMPIArray* (*getRecommendedActions)(const CMPIError*, CMPIStatus*)
Returns an array of strings which describes recomended actions.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A array of strings, which can be NULL

oCMPIString* (*getErrorSource)(const CMPIError*, CMPIStatus*)
Returns a string which describes the Error source.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A string, which can be NULL

oCMPIErrorSrcFormat (*getErrorSourceFormat)(const CMPIError*, CMPIStatus*)
Returns a the format that the error src is in.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A error source format code

oCMPIString* (*getOtherErrorSourceFormat)(const CMPIError*, CMPIStatus*)
Returns a string which describes the 'other' format, only available if the error source is OTHER.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A string, which can be NULL

oCMPIrc (*getCIMStatusCode)(const CMPIError*, CMPIStatus*)
Returns the status code of this error.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A CMPI Status code

oCMPIString* (*getCIMStatusCodeDescription)(const CMPIError*, CMPIStatus*)
Returns a string which describes the status code error.
Parameters:
er - Error this pointer
- rc Output: Service return status (suppressed when NULL).
Returns:
A string, which can be NULL

oCMPIArray* (*getMessageArguments)(const CMPIError*, CMPIStatus*)
Returns an array which contains the dynamic content of the message.
Parameters:
er - The Error this pointer
- rc Output: Serbice return status (surpressed when NULL)
Returns:
An array of CMPIStrings which represents the dynamic values

oCMPIStatus (*setErrorType)(CMPIError*, const CMPIErrorType)
Sets the error type of this error object.
Parameters:
er - Error this pointer
et - The error type
Returns:
Output: Service return status

oCMPIStatus (*setOtherErrorType)(CMPIError*, const char* )
Sets the 'other' error type of this error object.
Parameters:
er - Error this pointer
oet - A string which describes the error type, it is only valis when error type is "OTHER"
Returns:
Output: Service return status

oCMPIStatus (*setProbableCauseDescription)(CMPIError*, const char* )
Sets the description of the probable cause.
Parameters:
er - Error this pointer
pc - The probable cause string
Returns:
Output: Service return status

oCMPIStatus (*setRecommendedActions)(CMPIError*, const CMPIArray*)
Sets the recomended actions array.
Parameters:
er - Error this pointer
ar - An array of strings describing actions that shoudl be taken to deal with this error
Returns:
Output: Service return status

oCMPIStatus (*setErrorSource)(CMPIError*, const char*)
Specifies a string which specifes The identifying information of the entity (ie, the instance) generating the error.
Parameters:
er - Error this pointer
es - the string which describes the source
Returns:
Output: Service return status

oCMPIStatus (*setErrorSourceFormat)(CMPIError*, const CMPIErrorSrcFormat )
Sets the source format of the error object
Parameters:
er - Error this pointer
esf - the string which describes the source format
Returns:
Output: Service return status

oCMPIStatus (*setOtherErrorSourceFormat)(CMPIError*, const char*)
specifies A string defining "Other" values for ErrorSourceFormat
Parameters:
er - Error this pointer
oef - the string which describes the other source format
Returns:
Output: Service return status

oCMPIStatus (*setCIMStatusCodeDescription)(CMPIError*, const char*)
Sets the description of the status code.
Parameters:
er - Error this pointer
scd - A string whcih describes the status code.
Returns:
Output: Service return status

oCMPIStatus (*setMessageArguments)(CMPIError*, CMPIArray*)
Sets an array of strings for the dynamic content of the message
Parameters:
er - Error this pointer
values - Specifies an array of CMPIStrings containing the dynamic content of the message.
Returns:
Service return status

Alphabetic index