QualifierSet_BeginEnumeration function

Article
09/15/2021

Resets an enumerator of the qualifiers of an object to the beginning of the enumeration.

Note

This API is for internal use only. It's not intended for use from developer code.

Syntax

HRESULT QualifierSet_BeginEnumeration (
   [in] int                  vFunc,
   [in] IWbemQualifierSet*   ptr,
   [in] LONG                 lFlags
);

Parameters

vFunc
[in] This parameter is unused.

ptr
[in] A pointer to an IWbemQualifierSet instance.

lFlags
[in] A bitwise combination of the flags or values described in the Remarks section that specifies the qualifiers to include in the enumeration.

Return value

The following values returned by this function are defined in the WbemCli.h header file, or you can define them as constants in your code:

Constant	Value	Description
`WBEM_E_INVALID_PARAMETER`	0x80041008	The `lFlags` parameter is not valid.
`WBEM_E_UNEXPECTED`	0x8004101d	A second call to `QualifierSet_BeginEnumeration` was made without an intervening call to `QualifierSet_EndEnumeration`.
`WBEM_E_OUT_OF_MEMORY`	0x80041006	Not enough memory is available to begin a new enumeration.
`WBEM_S_NO_ERROR`	0	The function call was successful.

Remarks

This function wraps a call to the IWbemQualifierSet::BeginEnumeration method.

To enumerate all of the qualifiers on an object, this method must be called before the first call to QualifierSet_Next. The order in which qualifiers are enumerated is guaranteed to be invariant for a given enumeration.

The flags that can be passed as the lEnumFlags argument are defined in the WbemCli.h header file, or you can define them as constants in your code.

Constant	Value	Description
	0	Return the names of all qualifiers.
`WBEM_FLAG_LOCAL_ONLY`	0x10	Return only the names of qualifiers specific to the current property or object. For a property: Return only the qualifiers specific to the property (including overrides), and not those qualifiers propagated from the class definition. For an instance: Return only instance-specific qualifier names. For a class: Return only qualifiers specific to the class being derived.
`WBEM_FLAG_PROPAGATED_ONLY`	0x20	Return only the names of qualifiers propagated from another object. For a property: Return only the qualifiers propagated to this property from the class definition, and not those from the property itself. For an instance: Return only those qualifiers propagated from the class definition. For a class: Return only those qualifier names inherited from the parent classes.

Requirements

Platforms: See System Requirements.

Header: WMINet_Utils.idl

.NET Framework Versions: Available since 4.7.2

Share via