IOHIDValue.h

Overview

IOHIDValue defines a value at a given time from an parsed item (IOHIDElement) contained within a Human Interface Device (HID) object. It is used to obtain either integer or data element values along with scaled values based on physical or calibrated settings. IOHIDValue is a CFType object and as such conforms to all the conventions expected such object.

This documentation assumes that you have a basic understanding of the material contained in Accessing Hardware From Applications For definitions of I/O Kit terms used in this documentation, such as matching dictionary, family, and driver, see the overview of I/O Kit terms and concepts in the "Device Access and the I/O Kit" chapter of Accessing Hardware From Applications.

This documentation also assumes you have read Human Interface Device & Force Feedback. Please review documentation before using this reference.

All of the information described in this document is contained in the header file IOHIDValue.h found at /System/Library/Frameworks/IOKit.framework/Headers/hid/IOHIDValue.h.

Included Headers

  • <CoreFoundation/CoreFoundation.h>

  • <IOKit/hid/IOHIDBase.h>

  • <IOKit/hid/IOHIDKeys.h>

Topics

Miscellaneous

IOHIDValueCreateWithBytes

Creates a new element value using byte data.

IOHIDValueCreateWithBytesNoCopy

Creates a new element value using byte data without performing a copy.

IOHIDValueCreateWithIntegerValue

Creates a new element value using an integer value.

IOHIDValueGetBytePtr

Returns a byte pointer to the value contained in this IOHIDValueRef.

IOHIDValueGetElement

Returns the element value associated with this IOHIDValueRef.

IOHIDValueGetIntegerValue

Returns an integer representaion of the value contained in this IOHIDValueRef.

IOHIDValueGetLength

Returns the size, in bytes, of the value contained in this IOHIDValueRef.

IOHIDValueGetScaledValue

Returns an scaled representaion of the value contained in this IOHIDValueRef based on the scale type.

IOHIDValueGetTimeStamp

Returns the timestamp value contained in this IOHIDValueRef.

IOHIDValueGetTypeID

Returns the type identifier of all IOHIDValue instances.