CM_Get_Device_IDW function

The CM_Get_Device_ID function retrieves the device instance ID for a specified device instance on the local machine.

Syntax

CMAPI CONFIGRET CM_Get_Device_IDW(
  DEVINST dnDevInst,
  PWSTR   Buffer,
  ULONG   BufferLen,
  ULONG   ulFlags
);

Parameters

dnDevInst

Caller-supplied device instance handle that is bound to the local machine.

Buffer

Address of a buffer to receive a device instance ID string. The required buffer size can be obtained by calling CM_Get_Device_ID_Size, then incrementing the received value to allow room for the string's terminating NULL.

BufferLen

Caller-supplied length, in characters, of the buffer specified by Buffer.

ulFlags

Not used, must be zero.

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

The function appends a NULL terminator to the supplied device instance ID string, unless the buffer is too small to hold the string. In this case, the function supplies as much of the identifier string as will fit into the buffer, and then returns CR_BUFFER_SMALL.

For information about device instance IDs, see Device Identification Strings.

For information about using device instance handles that are bound to the local machine, see CM_Get_Child.

Requirements

   
Minimum supported client Available in Microsoft Windows 2000 and later versions of Windows.
Target Platform Universal
Header cfgmgr32.h (include Cfgmgr32.h)
Library Cfgmgr32.lib

See Also

CM_Get_Child

CM_Get_Device_ID_Ex