CMPI 2.1.0 API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Enumerations
CMPIRc (Return Codes) (Subclause 5.9)

Enumerations

enum  CMPIrc {
  CMPI_RC_OK = 0, CMPI_RC_ERR_FAILED = 1, CMPI_RC_ERR_ACCESS_DENIED = 2, CMPI_RC_ERR_INVALID_NAMESPACE = 3,
  CMPI_RC_ERR_INVALID_PARAMETER = 4, CMPI_RC_ERR_INVALID_CLASS = 5, CMPI_RC_ERR_NOT_FOUND = 6, CMPI_RC_ERR_NOT_SUPPORTED = 7,
  CMPI_RC_ERR_CLASS_HAS_CHILDREN = 8, CMPI_RC_ERR_CLASS_HAS_INSTANCES = 9, CMPI_RC_ERR_INVALID_SUPERCLASS = 10, CMPI_RC_ERR_ALREADY_EXISTS = 11,
  CMPI_RC_ERR_NO_SUCH_PROPERTY = 12, CMPI_RC_ERR_TYPE_MISMATCH = 13, CMPI_RC_ERR_QUERY_LANGUAGE_NOT_SUPPORTED = 14, CMPI_RC_ERR_INVALID_QUERY = 15,
  CMPI_RC_ERR_METHOD_NOT_AVAILABLE = 16, CMPI_RC_ERR_METHOD_NOT_FOUND = 17, CMPI_RC_NO_MORE_ELEMENTS = 18, CMPI_RC_ERR_SERVER_LIMITS_EXCEEDED = 27,
  CMPI_RC_ERR_QUERY_FEATURE_NOT_SUPPORTED = 29, CMPI_RC_DO_NOT_UNLOAD = 50, CMPI_RC_NEVER_UNLOAD = 51, CMPI_RC_ERR_INVALID_HANDLE = 60,
  CMPI_RC_ERR_INVALID_DATA_TYPE = 61, CMPI_RC_ERR_NOT_IN_CODEPAGE = 62, CMPI_RC_ERROR_SYSTEM = 100, CMPI_RC_ERROR = 200
}
 An enumeration type that defines CMPI return code values. More...
 

Detailed Description

Enumeration Type Documentation

enum CMPIrc

An enumeration type that defines CMPI return code values.

CMPI return code values are used mainly for CMPIStatus::rc, and in rare cases directly in MB functions.

The enumerators can be categorized into these groups:

  • CMPI_RC_OK to CMPI_RC_ERR_QUERY_FEATURE_NOT_SUPPORTED:
    Return codes matching CIM status codes. They are sometimes used for CMPI-specific purposes as well.
  • CMPI_RC_DO_NOT_UNLOAD to CMPI_RC_NEVER_UNLOAD:
    Return codes used only by the MI cleanup() functions (e.g. CMPIInstanceMIFT.cleanup()).
  • CMPI_RC_ERR_INVALID_HANDLE to CMPI_RC_ERR_NOT_IN_CODEPAGE:
    Return codes for other errors detected by CMPI.
  • CMPI_RC_ERROR_SYSTEM to CMPI_RC_ERROR:
    Return codes for errors returned by the underlying operating system.

The descriptions of the enumerators in this module are meant to provide for a general understanding; their exact meaning is described in the MB or MI functions using them.

Enumerator
CMPI_RC_OK 

Success

CMPI_RC_ERR_FAILED 

Unspecific error occurred

CMPI_RC_ERR_ACCESS_DENIED 

Not authorized

CMPI_RC_ERR_INVALID_NAMESPACE 

Invalid namespace

CMPI_RC_ERR_INVALID_PARAMETER 

Invalid parameter

CMPI_RC_ERR_INVALID_CLASS 

Invalid class

CMPI_RC_ERR_NOT_FOUND 

Item (class, instance, message file, etc.) not found

CMPI_RC_ERR_NOT_SUPPORTED 

Operation not supported

CMPI_RC_ERR_CLASS_HAS_CHILDREN 

Class has subclasses

CMPI_RC_ERR_CLASS_HAS_INSTANCES 

Class has instances

CMPI_RC_ERR_INVALID_SUPERCLASS 

Invalid superclass

CMPI_RC_ERR_ALREADY_EXISTS 

Object already exists

CMPI_RC_ERR_NO_SUCH_PROPERTY 

Property not found (e.g. not defined in the class)

CMPI_RC_ERR_TYPE_MISMATCH 

Type mismatch

CMPI_RC_ERR_QUERY_LANGUAGE_NOT_SUPPORTED 

Query language not supported

CMPI_RC_ERR_INVALID_QUERY 

Invalid query

CMPI_RC_ERR_METHOD_NOT_AVAILABLE 

Method not available (e.g. not supported / implemented)

CMPI_RC_ERR_METHOD_NOT_FOUND 

Method not found (e.g. not defined in the class)

CMPI_RC_NO_MORE_ELEMENTS 

No more elements

CMPI_RC_ERR_SERVER_LIMITS_EXCEEDED 

Server limits exceeded

CMPI_RC_ERR_QUERY_FEATURE_NOT_SUPPORTED 

Query feature not supported

CMPI_RC_DO_NOT_UNLOAD 

Operation successful - Do not unload the MI now

CMPI_RC_NEVER_UNLOAD 

Operation successful - Never unload the MI

CMPI_RC_ERR_INVALID_HANDLE 

Invalid handle to CMPI data

CMPI_RC_ERR_INVALID_DATA_TYPE 

Invalid data type

CMPI_RC_ERR_NOT_IN_CODEPAGE 

Characters are not representable in the specified codepage

CMPI_RC_ERROR_SYSTEM 

Not currently used

CMPI_RC_ERROR 

Not currently used