---
title: IOHIDDeviceGetReport
framework: IOKit
role: symbol
role_heading: Function
platforms: [Mac Catalyst 13.1+, macOS 10.5+]
path: iokit/1588659-iohiddevicegetreport
---

# IOHIDDeviceGetReport

Obtains a report from the device.

## Declaration

```occ
IOReturn IOHIDDeviceGetReport(IOHIDDeviceRef device, IOHIDReportType reportType, CFIndex reportID, uint8_t *report, CFIndex *pReportLength);
```

## Parameters

- `device`: Reference to an IOHIDDevice.
- `reportType`: Type of report being requested.
- `reportID`: ID of the report being requested.
- `report`: Pointer to preallocated buffer in which to copy inbound report data.
- `pReportLength`: Pointer to length of preallocated buffer. This value will be modified to refect the length of the returned report.

## Return Value

Return Value Returns kIOReturnSuccess if successful.

## Discussion

Discussion This method behaves synchronously and will block until the report has been received from the device. This is only intended for feature reports because of sporadic devicesupport for polling input reports. Please defer to using IOHIDDeviceRegisterInputReportCallback for obtaining input reports.

## See Also

### Miscellaneous

- [IOHIDDeviceClose](iokit/1588668-iohiddeviceclose.md)
- [IOHIDDeviceConformsTo](iokit/1588665-iohiddeviceconformsto.md)
- [IOHIDDeviceCopyMatchingElements](iokit/1588671-iohiddevicecopymatchingelements.md)
- [IOHIDDeviceCopyValueMultiple](iokit/1588652-iohiddevicecopyvaluemultiple.md)
- [IOHIDDeviceCopyValueMultipleWithCallback](iokit/1588655-iohiddevicecopyvaluemultiplewith.md)
- [IOHIDDeviceCreate](iokit/1588663-iohiddevicecreate.md)
- [IOHIDDeviceGetProperty](iokit/1588648-iohiddevicegetproperty.md)
- [IOHIDDeviceGetReportWithCallback](iokit/1588662-iohiddevicegetreportwithcallback.md)
- [IOHIDDeviceGetService](iokit/1588646-iohiddevicegetservice.md)
- [IOHIDDeviceGetTypeID](iokit/1588664-iohiddevicegettypeid.md)
- [IOHIDDeviceGetValue](iokit/1588657-iohiddevicegetvalue.md)
- [IOHIDDeviceGetValueWithCallback](iokit/1588647-iohiddevicegetvaluewithcallback.md)
- [IOHIDDeviceOpen](iokit/1588670-iohiddeviceopen.md)
- [IOHIDDeviceRegisterInputReportCallback](iokit/1588666-iohiddeviceregisterinputreportca.md)
- [IOHIDDeviceRegisterInputValueCallback](iokit/1588672-iohiddeviceregisterinputvaluecal.md)
- [IOHIDDeviceRegisterRemovalCallback](iokit/1588673-iohiddeviceregisterremovalcallba.md)
- [IOHIDDeviceScheduleWithRunLoop](iokit/1588660-iohiddeviceschedulewithrunloop.md)
- [IOHIDDeviceSetInputValueMatching](iokit/1588654-iohiddevicesetinputvaluematching.md)
- [IOHIDDeviceSetInputValueMatchingMultiple](iokit/1588645-iohiddevicesetinputvaluematching.md)
- [IOHIDDeviceSetProperty](iokit/1588653-iohiddevicesetproperty.md)
- [IOHIDDeviceSetReport](iokit/1588656-iohiddevicesetreport.md)
- [IOHIDDeviceSetReportWithCallback](iokit/1588661-iohiddevicesetreportwithcallback.md)
- [IOHIDDeviceSetValue](iokit/1588651-iohiddevicesetvalue.md)
- [IOHIDDeviceSetValueMultiple](iokit/1588669-iohiddevicesetvaluemultiple.md)
- [IOHIDDeviceSetValueMultipleWithCallback](iokit/1588658-iohiddevicesetvaluemultiplewithc.md)
- [IOHIDDeviceSetValueWithCallback](iokit/1588667-iohiddevicesetvaluewithcallback.md)
- [IOHIDDeviceUnscheduleFromRunLoop](iokit/1588650-iohiddeviceunschedulefromrunloop.md)
