__ExtendedStatus

[This is preliminary documentation and subject to change.]

Instances of the __ExtendedStatus system class are recommended for use as a standard way to report status and error information for operations that require feedback more detailed than a simple result code. Typical uses for instances of this class are for error objects and in the SetStatus method of IWbemObjectSink.

It is typical for dynamic instance and class providers to return an instance of this class to provide detailed information about why a particular operation failed.

class __ExtendedStatus : __NotifyStatus
{
    // sint32 StatusCode; inherited from base class
    string Description;
    string Operation;
    string ParameterInfo;
    string ProviderName;
};

Properties

StatusCode

Inherited from __NotifyStatus.This field is user-defined and can be any type of result code expected by the end user.

Description

This field is user-defined and can be any string value describing the error.

Operation

This field is typically set by CIMOM to indicate which operation occurred at the time of the failure or anomaly. For example, this often contains one of the IWbemServices API names, such as "CreateInstanceEnum".

ParameterInfo

This field is typically set by CIMOM to indicate a particular parameter or parameters that appeared to cause the error. For example, if a user attempts to retrieve a class that does not exist, this field is set to the offending class name.

ProviderName

This field is typically set by CIMOM to indicate the provider name that occasioned the failure or that reported the error. If no provider is involved, this string is set to "CIMOM".

Note:  When objects of this class are returned from a dynamic provider, the first two fields are set by the provider and returned unmodified to the client and the remainder are set by CIMOM.

See Also

Error Objects