CM_Set_Device_Interface_Property_ExW function (cfgmgr32.h)

Article
02/22/2024

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

The CM_Set_Device_Interface_Property_ExW function sets a device property of a device interface.

Syntax

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

Parameters

[in] pszDeviceInterface

Pointer to a string that identifies the device interface instance for which to set a property for.

[in] PropertyKey

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

[in] PropertyType

A DEVPROPTYPE-typed value that represents the property-data-type identifier for the device interface property. To delete a property, this must be set to DEVPROP_TYPE_EMPTY.

[in] PropertyBuffer

Pointer to a buffer that contains the property value of the device interface property. If either the property or the data is being deleted, this pointer must be set to NULL, and PropertyBufferSize must be set to zero.

[in] PropertyBufferSize

The size, in bytes, of the PropertyBuffer buffer. If PropertyBuffer is set to NULL, PropertyBufferSize must be set to zero.

[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_Set_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