3.1.4.3.10 IWbemServices::CreateClassEnum (Opnum 12)

Article
06/24/2021

The IWbemServices::CreateClassEnum method provides a class enumeration. When this method is invoked, the server MUST return all classes that satisfy the selection criteria from the namespace that is associated with the current IWbemServices interface.

 HRESULT CreateClassEnum(
   [in] const BSTR strSuperclass,
   [in] long lFlags,
   [in] IWbemContext* pCtx,
   [out] IEnumWbemClassObject** ppEnum
 );

strSuperClass: MUST specify a superclass name. Only classes that are subclasses of this class MUST be returned. If strSuperClass is NULL or a zero-length string, all classes in the namespace MUST be included in the result set. The results MUST be filtered by using the lFlags parameter. Classes without a base class MUST be considered to be derived from the NULL superclass.

lFlags: Flags affect the behavior of the CreateClassEnum method. Flag behavior MUST be interpreted as specified in the following table.

The server MUST allow any combination of zero or more flags from the following table and MUST comply with all the restrictions in a flag description. Any other DWORD value that does not match a flag condition MUST be treated as not valid.

Value	Meaning
WBEM_FLAG_USE_AMENDED_QUALIFIERS 0x00020000	If this bit is not set, the server SHOULD return no CIM localizable information. If this bit is set, the server SHOULD return CIM localizable information for the CIM object, as specified in section 2.2.6.
WBEM_FLAG_RETURN_IMMEDIATELY 0x00000010	If this bit is not set, the server MUST make the method call synchronously. If this bit is set, the server MUST make the method call semisynchronously.
WBEM_FLAG_SHALLOW 0x00000001	When this bit is not set, the server MUST return all classes that are derived from the requested class and all its subclasses. When this bit is set, the server MUST return only the classes that are directly derived from the requested class.
WBEM_FLAG_FORWARD_ONLY 0x00000020	When this bit is not set, the server MUST return an enumerator that has reset capability. When this bit is set, the server MUST return an enumerator that does not have reset capability, as specified in section 3.1.4.4.

Value

Meaning

WBEM_FLAG_USE_AMENDED_QUALIFIERS

0x00020000

If this bit is not set, the server SHOULD return no CIM localizable information.

If this bit is set, the server SHOULD return CIM localizable information for the CIM object, as specified in section 2.2.6.

WBEM_FLAG_RETURN_IMMEDIATELY

0x00000010

If this bit is not set, the server MUST make the method call synchronously.

If this bit is set, the server MUST make the method call semisynchronously.

WBEM_FLAG_SHALLOW

0x00000001

When this bit is not set, the server MUST return all classes that are derived from the requested class and all its subclasses.

When this bit is set, the server MUST return only the classes that are directly derived from the requested class.

WBEM_FLAG_FORWARD_ONLY

0x00000020

When this bit is not set, the server MUST return an enumerator that has reset capability.

When this bit is set, the server MUST return an enumerator that does not have reset capability, as specified in section 3.1.4.4.

pCtx: MUST be a pointer to an IWbemContext interface that MUST contain additional information that the client wants to pass to the server. If the pCtx parameter is NULL, it MUST be ignored.

ppEnum: MUST receive the pointer to the enumerator that implements the IEnumWbemClassObject interface. This parameter MUST NOT be NULL.

Return Values: This method MUST return an HRESULT value that MUST indicate the status of the method call. The server MUST return WBEM_S_NO_ERROR (as specified in section 2.2.11) to indicate the successful completion of the method.

WBEM_S_NO_ERROR (0x00)

The security principal that makes the call MUST have WBEM_REMOTE_ENABLE and WBEM_ENABLE accesses to the namespace; otherwise, WBEM_E_ACCESS_DENIED MUST be returned.

If strSuperClass is dynamic, the server MUST obtain SupportsEnumerate for the given provider in the ProviderTable. If SupportsEnumerate is FALSE, the server MUST return WBEM_E_PROVIDER_NOT_CAPABLE.

In response to the IWbemServices::CreateClassEnum method, the server MUST evaluate the strSuperClass parameter (specified in the preceding list) and MUST return all classes that match the input parameters from the current namespace. The method MUST fail if strSuperClass does not exist; if the method parameters or their combinations are not valid as previously specified; or if the server is unable to execute the method.

The successful synchronous method execution MUST fill the ppEnum parameter with an IEnumWbemClassObject interface pointer after all classes are collected and MUST return WBEM_S_NO_ERROR.

The semisynchronous method execution MUST follow the rules that are specified in section 3.1.1.1.2.

The failed method execution MUST set the value that is referenced by the output parameters to NULL and MUST return an error in the format that is specified in section 2.2.11.

The server SHOULD enforce a maximum length for the strSuperClass parameter, and return WBEM_E_QUOTA_VIOLATION if the limit is exceeded.<40>

3.1.4.3.10 IWbemServices::CreateClassEnum (Opnum 12)

Additional resources