SMS_ExtendedStatus

The SMS_ExtendedStatus WMI class is the error object that tells you the cause and nature of the current error.

The following syntax is simplified from MOF code and includes all inherited properties.

Class SMS_ExtendedStatus : __ExtendedStatus
{
  string CauseInfo;
  string Description;
  uint32 ErrorCode;
  string File;
  uint32 Line;
  string ObjectInfo;
  string Operation;
  string ParameterInfo;
  string ProviderName;
  string SQLMessage;
  uint32 SQLSeverity;
  uint32 SQLStatus;
  uint32 StatusCode;
};

Properties

• CauseInfo
  Data type: string
  Access type: Read-only

  Optional error information, if any. This property could contain, but is not limited to, the reason the error occurred. For example, Software Product Compliance sets this property to the field number that caused the error.

• Description
  Data type: string
  Access type: Read-only

  Optional detailed description of an error or operational status, if any.

• ErrorCode
  Data type: uint32
  Access type: Read-only

  Composite error code that defines the severity, facility, action, object, and the reason for the error. The Ssperrcode.h header file contains macros that you can use to evaluate the error condition. The following table contains the five bit field masks that comprise ErrorCode.

  Mask	Description
  Severity (bits 31-30)	Identifies whether or not you can continue, and to what extent you can continue. The three levels of severity are functional, minor, and major. A functional error allows you to continue with any aspect of SMS. A minor error allows you to continue with other areas of SMS that are not related to the area that caused this error. If you receive a major error, however, you should stop processing requests and terminate your application.
  Facility (bits 27-22)	Identifies what was being accessed when the error occurred, such as internal, file, SQL, or security.
  Action (bits 21-16)	Identifies the action that failed, such as open, read, or persist.
  Object (bits 15-8)	Identifies the type of object that the action was being performed against, such as a parameter or instance.
  Reason (bits 7-0)	Identifies the reason for the failure. This value may or may not be set. For example, R_PDFERROR is set if an error occurred while loading a PDF file.

• File
  Data type: string
  Access type: Read-only

  Module that raised the error condition.

• Line
  Data type: Uint32
  Access type: Read-only

  Line number inside the module where the error was raised.

• ObjectInfo
  Data type: string
  Access type: Read-only

  Optional error information that contains, but is not limited to the object that caused the error, the parameter that caused the error, or the Structured Query Language (SQL) message text. For example, Software Product Compliance sets this property to the record number that caused the error.

• Operation
  Data type: string
  Access type: Read-only

  Operation taking place at the time of the failure or anomaly.

• ParameterInfo
  Data type: string
  Access type: Read-only

  One or more parameters involved in the error or status change.

• ProviderName
  Data type: string
  Access type: Read-only

  Provider that caused or reported the error or status change. If a provider was not involved, this string is set to "Windows Management".

• SQLMessage
  Data type: string
  Access type: Read-only

  Error message text of the last SQL error. It is null if no SQL error is present.

• SQLSeverity
  Data type: uint32
  Access type: Read-only

  Severity code of the last SQL error. It is null if no SQL error is present.

• SQLStatus
  Data type: uint32
  Access type: Read-only

  Error code of the last SQL error. It is null if no SQL error is present.

• StatusCode
  Data type: uint32
  Access type: Read-only

  Error or information code for an operation.

Remarks

For more information on how to use the information presented in this class, see Handling Synchronous Errors.

See Also

__ExtendedStatus, SMS Error Handling, Supporting Classes