HIDDescriptor Property

Article
09/21/2010

The HIDDescriptor property gets or sets the HID descriptor that the device uses.

This property is read/write.

Syntax

HRESULT put_HIDDescriptor(
  [in]   ISoftUSBHIDDescriptor *piSoftUSBHIDDescriptor
);

HRESULT putref_HIDDescriptor(
  [in]   ISoftUSBHIDDescriptor *piSoftUSBHIDDescriptor
);

HRESULT get_HIDDescriptor(
  [out]  ISoftUSBHIDDescriptor **ppiSoftUSBHidDescriptor
);

Property Value

A pointer to new HID descriptor interface.

Error Codes

Returns S_OK on success. This property might return other standard COM return values.

Remarks

If a HID device simulator sets SoftHIDProtocolXlator.DeviceType to DEVICE_TYPE_NONE, it must first call SoftHIDProtocolXlator.WriteReportDescriptor and create and configure a SoftUSBHidDescriptor object. It must also set the SoftHIDProtocolXlator.HIDDescriptor.

Together, these actions determine the content of the HID descriptor that is appended to the device's interface descriptor.

Examples

The following C++ code example shows you how to get and set the HIDDescriptor property.

HRESULT GetHIDDescriptor(ISoftHIDProtocolXlator *piSoftHIDProtocolXlator, ISoftUSBHIDDescriptor **ppiSoftUSBHIDDescriptor)
{
    return piSoftHIDProtocolXlator->get_HIDDescriptor(ppiSoftUSBHIDDescriptor);
}

HRESULT SetHIDDescriptor(ISoftHIDProtocolXlator *piSoftHIDProtocolXlator, ISoftUSBHIDDescriptor *piSoftUSBHIDDescriptor)
{
    return piSoftHIDProtocolXlator->put_HIDDescriptor(piSoftUSBHIDDescriptor);
}

Requirements

Header

SoftHIDUSBif.h

Share via