IWbemClassObject::BeginEnumeration

[This is preliminary documentation and subject to change.]

The IWbemClassObject::BeginEnumeration method resets the enumeration sequence of all the properties in the object. The caller must call this method prior to the first call to IWbemClassObject::Next to enumerate all of the properties on an object.

HRESULT IWbemClassObject::BeginEnumeration(
  [in] Long lEnumFlags 
);
 

Parameters

lEnumFlags
A combination of flags described in Remarks.

Return Values

WBEM_E_INVALID_PARAMETER The specified combination of flags was invalid, an invalid parameter was specified, or the namespace could not be parsed.
WBEM_E_OUT_OF_MEMORY There is not enough memory to begin a new enumeration.
WBEM_NO_ERROR Success.

Remarks

You can control the properties included in the enumeration by specifying a combination of the following flags. You can combine one flag from each group with any flag from any other group. However, flags from the same group are mutually exclusive.

GROUP 1

WBEM_FLAG_KEYS_ONLY
Only include properties that constitute the key.
WBEM_FLAG_REFS_ONLY
Only include properties that are object references.

GROUP 2

WBEM_FLAG_LOCAL_ONLY
Only include properties that are defined or modified in the class itself. Exclude all properties that are inherited from superclasses. Exclude system properties from the enumeration.
WBEM_FLAG_PROPAGATED_ONLY
Only include properties that are inherited from superclasses. Exclude properties that are defined or modified in the class itself. Exclude system properties from the enumeration.
WBEM_FLAG_SYSTEM_ONLY
Limit the enumeration to system properties only.
WBEM_FLAG_NONSYSTEM_ONLY
Exclude system properties from the enumeration. Includes local and propagated properties.

See Also

IWbemClassObject::Next, System Properties, IWbemClassObject::EndEnumeration