CM_Get_Device_Interface_Property_ExW function (cfgmgr32.h)

Article
10/13/2021

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

The CM_Get_Device_Interface_Property_ExW function retrieves a device property that is set for a device interface.

Syntax

CMAPI CONFIGRET CM_Get_Device_Interface_Property_ExW(
  [in]           LPCWSTR          pszDeviceInterface,
  [in]           const DEVPROPKEY *PropertyKey,
  [out]          DEVPROPTYPE      *PropertyType,
  [out]          PBYTE            PropertyBuffer,
  [in, out]      PULONG           PropertyBufferSize,
  [in]           ULONG            ulFlags,
  [in, optional] HMACHINE         hMachine
);

Parameters

[in] pszDeviceInterface

Pointer to a string that identifies the device interface instance to retrieve the property from.

[in] PropertyKey

Pointer to a DEVPROPKEY structure that represents the device interface property key of the device interface property to retrieve.

[out] PropertyType

Pointer to a DEVPROPTYPE-typed variable that receives the property-data-type identifier of the requested device interface property. The property-data-type identifier is a bitwise OR between a base-data-type identifier and, if the base-data type is modified, a property-data-type modifier.

[out] PropertyBuffer

A pointer to a buffer that receives the requested device interface property. CM_Get_Device_Interface_Property_ExW retrieves the requested property only if the buffer is large enough to hold all the property value data. The pointer can be NULL.

[in, out] PropertyBufferSize

The size, in bytes, of the PropertyBuffer buffer. If PropertyBuffer is set to NULL, *PropertyBufferSize must be set to zero. As output, if the buffer is not large enough to hold all the property value data, CM_Get_Device_Interface_Property_ExW returns the size of the data, in bytes, in *PropertyBufferSize.

[in] ulFlags

Reserved. Must be set to zero.

[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_Device_Interface_Property_ExW 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
DLL	CfgMgr32.dll