ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference

IOHIDDeviceInterface121

Declared In:

Overview

CFPlugin object subclass which provides the primary interface to HID devices. This class is a subclass of IOHIDDeviceInterface.

Functions

getReport: Obtains a report from the device.
setReport: Sends a report to the device.

getReport

Obtains a report from the device.

IOReturn ( *getReport) (
    void *self, 
    IOHIDReportType reportType, 
    uint32_t reportID, 
    void *reportBuffer, 
    uint32_t *reportBufferSize, 
    uint32_t timeoutMS, 
    IOHIDReportCallbackFunction callback, 
    void *callbackTarget, 
    void *callbackRefcon);

Parameters

reportType: The report type.
reportID: The report ID.
reportBuffer: Pointer to a preallocated buffer.
reportBufferSize: Size of the reportBuffer in bytes. When finished, will contain the actual size of the report.
timeoutMS
callback: If null, this method will behave synchronously.
callbackTarget: The callback target passed to the callback.
callbackRefcon: The callback refcon passed to the callback.

Return Value

Returns an IOReturn code.

setReport

Sends a report to the device.

IOReturn ( *setReport) (
    void *self, 
    IOHIDReportType reportType, 
    uint32_t reportID, 
    void *reportBuffer, 
    uint32_t reportBufferSize, 
    uint32_t timeoutMS, 
    IOHIDReportCallbackFunction callback, 
    void *callbackTarget, 
    void *callbackRefcon);

Parameters

reportType: The report type.
reportID: The report id.
reportBuffer: Pointer to a preallocated buffer.
reportBufferSize: Size of the reportBuffer in bytes.
timeoutMS
callback: If null, this method will behave synchronously.
callbackTarget: The callback target passed to the callback.
callbackRefcon: The callback refcon passed to the callback.

Return Value

Returns an IOReturn code.

Did this document help you?

Yes: Tell us what works for you.

It’s good, but: Report typos, inaccuracies, and so forth.

It wasn’t helpful: Tell us what would have helped.

Last Updated: 2009-02-23