HidD_GetPhysicalDescriptor function

The HidD_GetPhysicalDescriptor routine returns the embedded string of a top-level collection that identifies the collection's physical device.

Syntax

BOOLEAN HidD_GetPhysicalDescriptor(
  HANDLE HidDeviceObject,
  PVOID  Buffer,
  ULONG  BufferLength
);

Parameters

HidDeviceObject

Specifies an open handle to a top-level collection.

Buffer

Pointer to a caller-allocated buffer that the routine uses to return the requested physical descriptor.

BufferLength

Specifies the length, in bytes, of the buffer at Buffer.

Return Value

HidD_GetPhysicalDescriptor returns TRUE if it succeeds; otherwise, it returns FALSE. Use GetLastError to get extended error information.

Remarks

Only user-mode applications can call HidD_GetPhysicalDescriptor. Kernel-mode drivers can use an IOCTL_GET_PHYSICAL_DESCRIPTOR request.

For more information, see HID Collections.

Requirements

   
Minimum supported client Available in Windows 2000 and later versions of Windows.
Target Platform Universal
Header hidsdi.h (include Hidsdi.h)
Library Hid.lib
DLL Hid.dll

See Also

HidD_GetIndexedString

HidD_GetManufacturerString

HidD_GetProductString

HidD_GetSerialNumberString

IOCTL_GET_PHYSICAL_DESCRIPTOR