CMPI 2.1.0 API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Typedefs
CMPIFlags (Subclause 5.16)

Typedefs

typedef unsigned int CMPIFlags
 A bitmask type that represents options specified by the WBEM client. More...
 

Test masks for CMPIFlags

These test masks are used on CMPIFlags.

For considerations on the use of CMPI_FLAG_LocalOnly and CMPI_FLAG_DeepInheritance, see Subclause 4.4 of the CMPI Standard.

#define CMPI_FLAG_LocalOnly   1
 LocalOnly flag.
 
#define CMPI_FLAG_DeepInheritance   2
 DeepInheritance flag.
 
#define CMPI_FLAG_IncludeQualifiers   4
 IncludeQualifiers flag.
 
#define CMPI_FLAG_IncludeClassOrigin   8
 IncludeClassOrigin flag.
 

Detailed Description

Typedef Documentation

typedef unsigned int CMPIFlags

A bitmask type that represents options specified by the WBEM client.

The CMPIFlags type is used to inform MI functions about options specified by the WBEM client and passed on to the MI for certain requests. Normally, MIs will ignore these flags; however, these flags can be useful when MB services are invoked, or an external MB is contacted.

CMPIFlags are not passed to MIs directly. MIs can use CMPIContext services to gain access under the entry name CMPIInvocationFlags.

These flags may not be supported by all WBEM protocols.

If a particular flag is not defined for the operation that is invoked, it shall have a value of 0 (false).

See Test masks for CMPIFlags for a definition of test masks for CMPIFlags.