CM_Get_Device_ID function

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

Syntax

CMAPI
CONFIGRET
WINAPI CM_Get_Device_ID(
  _In_  DEVINST dnDevInst,
  _Out_ PWSTR   Buffer,
  _In_  ULONG   BufferLen,
  _In_  ULONG   ulFlags
);

Parameters

dnDevInst [in]

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

Buffer [out]

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 [in]

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

ulFlags [in]

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

See also

CM_Get_Child

CM_Get_Device_ID_Ex

Send comments about this topic to Microsoft