The CM_Get_Device_ID_Ex function retrieves the device instance ID for a specified device instance, on a local or a remote machine.

CMAPI CONFIGRET WINAPI
  CM_Get_Device_ID_Ex(
    IN DEVINST  dnDevInst,
    OUT PTCHAR  Buffer,
    IN ULONG  BufferLen,
    IN ULONG  ulFlags,
    IN HMACHINE  hMachine
    );

Parameters

dnDevInst

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

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_Ex, 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.

hMachine

Caller-supplied machine handle to which the caller-supplied device instance handle is bound.

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.

Comments

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 a local or a remote machine, see CM_Get_Child_Ex.

Requirements

Versions: The CM_Get_Device_ID_Ex function is available in Microsoft Windows 2000 and later versions of Windows.

Headers: Declared in Cfgmgr32.h. Include Cfgmgr32.h.

Library: Contained in Cfgmgr32.lib. Link to Cfgmgr32.lib.

See Also

CM_Get_Child_Ex, CM_Get_Device_ID