HidD_GetPhysicalDescriptor routine

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

Syntax


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

Parameters

HidDeviceObject [in]

Specifies an open handle to a top-level collection.

Buffer [out]

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

BufferLength [in]

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

Return value

HidD_GetPhysicalDescriptor returns TRUE if it succeeds; otherwise, it returns FALSE.

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

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidsdi.h (include Hidsdi.h)

Library

Hid.lib

See also

HidD_GetIndexedString
HidD_GetManufacturerString
HidD_GetProductString
HidD_GetSerialNumberString
IOCTL_GET_PHYSICAL_DESCRIPTOR

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft