CM_Get_Class_Property_Keys_Ex function (cfgmgr32.h)

Article
10/13/2021

[Beginning with Windows 8 and Windows Server 2012, this function has been deprecated. Please use CM_Get_Class_Property_Keys instead.]

The CM_Get_Class_Property_Keys_Ex function retrieves an array of the device property keys that represent the device properties that are set for a device interface class or device setup class.

Syntax

CMAPI CONFIGRET CM_Get_Class_Property_Keys_Ex(
  [in]            LPCGUID    ClassGUID,
  [out, optional] DEVPROPKEY *PropertyKeyArray,
  [in, out]       PULONG     PropertyKeyCount,
  [in]            ULONG      ulFlags,
  [in, optional]  HMACHINE   hMachine
);

Parameters

[in] ClassGUID

Pointer to the GUID that identifies the device interface class or device setup class for which to retrieve the property keys for. For information about specifying the class type, see the ulFlags parameter.

[out, optional] PropertyKeyArray

Pointer to a buffer that receives an array of DEVPROPKEY-typed values, where each value is a device property key that represents a device property that is set for the device class. The pointer is optional and can be NULL.

[in, out] PropertyKeyCount

The size, in DEVPROPKEY-typed units, of the PropertyKeyArray buffer. If PropertyKeyArray is set to NULL, *PropertyKeyCount must be set to zero. As output, if PropertyKeyArray is not large enough to hold all the property key data, CM_Get_Class_Property_Keys_Ex returns the count of the keys, in *PropertyKeyCount.

[in] ulFlags

Class property key flags:

CM_CLASS_PROPERTY_INSTALLER

ClassGUID specifies a device setup class. Do not combine with CM_CLASS_PROPERTY_INTERFACE.

CM_CLASS_PROPERTY_INTERFACE

ClassGUID specifies a device interface class. Do not combine with CM_CLASS_PROPERTY_INSTALLER.

[in, optional] hMachine

Caller-supplied machine handle, obtained from a previous call to CM_Connect_Machine.

Note Using this function to access remote machines is not supported beginning with Windows 8 and Windows Server 2012, as this functionality has been removed.

Return value

If the operation succeeds, the function returns CR_SUCCESS. Otherwise, it returns one of the CR_-prefixed error codes defined in Cfgmgr32.h.

Remarks

CM_Get_Class_Property_Keys_Ex is part of the Unified Device Property Model.

Requirements

Requirement	Value
Minimum supported client	Available in Microsoft Windows 10 and later versions of Windows.
Target Platform	Desktop
Header	cfgmgr32.h (include Cfgmgr32.h)
Library	Cfgmgr32.lib; OneCoreUAP.lib on Windows 10
DLL	CfgMgr32.dll

Share via