_CMPIErrorFT Struct Reference

#include <cmpi/cmpift.h>

Public Attributes
CMPISint32	ftVersion
CMPIStatus(*	release )(CMPIError *)
CMPIError *(*	clone )(const CMPIError *, CMPIStatus *)
CMPIErrorType(*	getErrorType )(const CMPIError *, CMPIStatus *)
CMPIString *(*	getOtherErrorType )(const CMPIError *, CMPIStatus *)
CMPIString *(*	getOwningEntity )(const CMPIError *, CMPIStatus *)
CMPIString *(*	getMessageID )(const CMPIError *, CMPIStatus *)
CMPIString *(*	getMessage )(const CMPIError *, CMPIStatus *)
CMPIErrorSeverity(*	getPerceivedSeverity )(const CMPIError *, CMPIStatus *)
CMPIErrorProbableCause(*	getProbableCause )(const CMPIError *, CMPIStatus *)
CMPIString *(*	getProbableCauseDescription )(const CMPIError *, CMPIStatus *)
CMPIArray *(*	getRecommendedActions )(const CMPIError *, CMPIStatus *)
CMPIString *(*	getErrorSource )(const CMPIError *, CMPIStatus *)
CMPIErrorSrcFormat(*	getErrorSourceFormat )(const CMPIError *, CMPIStatus *)
CMPIString *(*	getOtherErrorSourceFormat )(const CMPIError *, CMPIStatus *)
CMPIrc(*	getCIMStatusCode )(const CMPIError *, CMPIStatus *)
CMPIString *(*	getCIMStatusCodeDescription )(const CMPIError *, CMPIStatus *)
CMPIArray *(*	getMessageArguments )(const CMPIError *, CMPIStatus *)
CMPIStatus(*	setErrorType )(CMPIError *, const CMPIErrorType)
CMPIStatus(*	setOtherErrorType )(CMPIError *, const char *)
CMPIStatus(*	setProbableCauseDescription )(CMPIError *, const char *)
CMPIStatus(*	setRecommendedActions )(CMPIError *, const CMPIArray *)
CMPIStatus(*	setErrorSource )(CMPIError *, const char *)
CMPIStatus(*	setErrorSourceFormat )(CMPIError *, const CMPIErrorSrcFormat)
CMPIStatus(*	setOtherErrorSourceFormat )(CMPIError *, const char *)
CMPIStatus(*	setCIMStatusCodeDescription )(CMPIError *, const char *)
CMPIStatus(*	setMessageArguments )(CMPIError *, CMPIArray *)

Detailed Description

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

Member Data Documentation

clone

CMPIError *(* _CMPIErrorFT::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.

ftVersion

CMPISint32 _CMPIErrorFT::ftVersion

Function table version

getCIMStatusCode

CMPIrc(* _CMPIErrorFT::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

getCIMStatusCodeDescription

CMPIString *(* _CMPIErrorFT::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

getErrorSource

CMPIString *(* _CMPIErrorFT::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

getErrorSourceFormat

CMPIErrorSrcFormat(* _CMPIErrorFT::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

getErrorType

CMPIErrorType(* _CMPIErrorFT::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

getMessage

CMPIString *(* _CMPIErrorFT::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

getMessageArguments

CMPIArray *(* _CMPIErrorFT::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

getMessageID

CMPIString *(* _CMPIErrorFT::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

getOtherErrorSourceFormat

CMPIString *(* _CMPIErrorFT::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

getOtherErrorType

CMPIString *(* _CMPIErrorFT::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

getOwningEntity

CMPIString *(* _CMPIErrorFT::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

getPerceivedSeverity

CMPIErrorSeverity(* _CMPIErrorFT::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

getProbableCause

CMPIErrorProbableCause(* _CMPIErrorFT::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

getProbableCauseDescription

CMPIString *(* _CMPIErrorFT::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

getRecommendedActions

CMPIArray *(* _CMPIErrorFT::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

release

CMPIStatus(* _CMPIErrorFT::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.

setCIMStatusCodeDescription

CMPIStatus(* _CMPIErrorFT::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

setErrorSource

CMPIStatus(* _CMPIErrorFT::setErrorSource) (CMPIError *, const char *)

Specifies a string which specifes The identifying information of the entity (i.e., the instance) generating the error..

Parameters

er	Error this pointer
es	the string which describes the source

Returns

Output: Service return status

setErrorSourceFormat

CMPIStatus(* _CMPIErrorFT::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

setErrorType

CMPIStatus(* _CMPIErrorFT::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

setMessageArguments

CMPIStatus(* _CMPIErrorFT::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

setOtherErrorSourceFormat

CMPIStatus(* _CMPIErrorFT::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

setOtherErrorType

CMPIStatus(* _CMPIErrorFT::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

setProbableCauseDescription

CMPIStatus(* _CMPIErrorFT::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

setRecommendedActions

CMPIStatus(* _CMPIErrorFT::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

---

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

• cmpi/cmpift.h