Mac Dev Center Mac OS X Reference Library Drivers, Kernel, & Hardware: User-Space Device Access I/O Kit Framework Reference

IOHIDBase.h

Includes:

Overview

Use the links in the table of contents to the left to access the documentation.

Typedefs

IOHIDCallback
IOHIDDeviceCallback
IOHIDDeviceRef
IOHIDElementRef
IOHIDReportCallback
IOHIDTransactionDirectionType: Direction for an IOHIDDeviceTransactionInterface.
IOHIDValueCallback
IOHIDValueMultipleCallback
IOHIDValueRef
IOHIDValueScaleType: Describes different types of scaling that can be performed on element values.

IOHIDCallback

typedef void ( *IOHIDCallback)( 
    void *context, 
    IOReturn result, 
    void *sender);

Fields

target: void * pointer to your data, often a pointer to an object.
result: Completion result of desired operation.
refcon: void * pointer to more data.
sender: Interface instance sending the completion routine.

Discussion

Type and arguments of callout C function that is used when a completion routine is called.

IOHIDDeviceCallback

typedef void ( *IOHIDDeviceCallback) ( 
    void *context, 
    IOReturn result, 
    void *sender, 
    IOHIDDeviceRef device);

Fields

context: void * pointer to more data.
result: Completion result of desired operation.
device: IOHIDDeviceRef containing the sending device.

Discussion

Type and arguments of callout C function that is used when a device routine is called.

IOHIDDeviceRef

typedef struct __IOHIDDevice * IOHIDDeviceRef;

Discussion

This is the type of a reference to the IOHIDDevice.

IOHIDElementRef

typedef struct __IOHIDElement * IOHIDElementRef;

Discussion

This is the type of a reference to the IOHIDElement.

IOHIDReportCallback

typedef void ( *IOHIDReportCallback) ( 
    void *context, 
    IOReturn result, 
    void *sender, 
    IOHIDReportType type, 
    uint32_t reportID, 
    uint8_t *report, 
    CFIndex reportLength);

Fields

target: void * pointer to your data, often a pointer to an object.
result: Completion result of desired operation.
refcon: void * pointer to more data.
sender: Interface instance sending the completion routine.
type: The type of the report that was completed.
reportID: The ID of the report that was completed.
report: Pointer to the buffer containing the contents of the report.
reportLength: Size of the buffer received upon completion.

Discussion

Type and arguments of callout C function that is used when a HID report completion routine is called.

IOHIDTransactionDirectionType

Direction for an IOHIDDeviceTransactionInterface.

See Also:

IOHIDTransactionDirectionType

typedef uint32_t IOHIDTransactionDirectionType;

Constants

kIOHIDTransactionDirectionTypeInput: Transaction direction used for requesting element values from a device.
kIOHIDTransactionDirectionTypeOutput: Transaction direction used for dispatching element values to a device.

IOHIDValueCallback

typedef void ( *IOHIDValueCallback) ( 
    void *context, 
    IOReturn result, 
    void *sender, 
    IOHIDValueRef value);

Fields

context: void * pointer to more data.
result: Completion result of desired operation.
sender: Interface instance sending the completion routine.
value: IOHIDValueRef containing the returned element value.

Discussion

Type and arguments of callout C function that is used when an element value completion routine is called.

IOHIDValueMultipleCallback

typedef void ( *IOHIDValueMultipleCallback) ( 
    void *context, 
    IOReturn result, 
    void *sender, 
    CFDictionaryRef multiple);

Fields

context: void * pointer to more data.
result: Completion result of desired operation.
sender: Interface instance sending the completion routine.
multiple: CFDictionaryRef containing the returned element key value pairs.

Discussion

Type and arguments of callout C function that is used when an element value completion routine is called.

IOHIDValueRef

typedef struct __IOHIDValue * IOHIDValueRef;

Discussion

This is the type of a reference to the IOHIDValue.

IOHIDValueScaleType

Describes different types of scaling that can be performed on element values.

See Also:

IOHIDValueScaleType

typedef uint32_t IOHIDValueScaleType;

Constants

kIOHIDValueScaleTypeCalibrated: Type for value that is scaled with respect to the calibration properties.
kIOHIDValueScaleTypePhysical: Type for value that is scaled with respect to the physical min and physical max of the element.

Enumerated Types

IOHIDTransactionDirectionType: Direction for an IOHIDDeviceTransactionInterface.
IOHIDTransactionOption: Options to be used in conjuntion with an IOHIDDeviceTransactionInterface.
IOHIDValueScaleType: Describes different types of scaling that can be performed on element values.

IOHIDTransactionDirectionType

Direction for an IOHIDDeviceTransactionInterface.

See Also:

IOHIDTransactionDirectionType

enum { 
    kIOHIDTransactionDirectionTypeInput, 
    kIOHIDTransactionDirectionTypeOutput 
};

IOHIDTransactionOption

Options to be used in conjuntion with an IOHIDDeviceTransactionInterface.

enum { 
    kIOHIDTransactionOptionDefaultOutputValue = 0x0001 
};

Constants

kIOHIDTransactionOptionDefaultOutputValue: Option to set the default element value to be used with an IOHIDDeviceTransactionInterface of direction kIOHIDTransactionDirectionTypeOutput.

IOHIDValueScaleType

Describes different types of scaling that can be performed on element values.

See Also:

IOHIDValueScaleType

enum { 
    kIOHIDValueScaleTypeCalibrated, 
    kIOHIDValueScaleTypePhysical 
};

Did this document help you?

Shop the Apple Online Store (1-800-MY-APPLE), visit an Apple Retail Store, or find a reseller.

Last Updated: 2009-10-15