Contents

setReport

Sends a report to the HID device.

Declaration

virtual kern_return_t setReport(IOMemoryDescriptor *report, IOHIDReportType reportType, IOOptionBits options, uint32_t completionTimeout, OSAction *action);

Parameters

  • report:

    A memory descriptor that describes the report to send to the HID device.

  • reportType:

    The report type.

  • options:

    The lower 8 bits of the report ID. The other 24 bits are options to specify the request.

  • completionTimeout:

    The amount of time, in milliseconds, after which to abort the command if the entire command hasn’t finished.

  • action:

    The Osaction object to execute when the request completes. Specify NULL to execute the request synchronously, which blocks the current thread until the request completes.

Return Value

kIOReturnSuccess on success, or another value if an error occurs. See Error Codes.

Discussion

The default implementation of this method does nothing. Subclasses must override it and use their implementation to send the report information to the device.

See Also

Processing Device Reports