<!--
{
  "availability" : [
    "driverkit: 19.0.0 -",
    "macOS: -"
  ],
  "documentType" : "symbol",
  "framework" : "HIDDriverKit",
  "identifier" : "/documentation/HIDDriverKit/IOUserUSBHostHIDDevice/getReport-2v8zk",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "HIDDriverKit"
    ],
    "preciseIdentifier" : "c:@S@IOUserUSBHostHIDDevice@F@getReport#*$@S@IOMemoryDescriptor#$@E@IOHIDReportType#i#i#*i#"
  },
  "title" : "getReport"
}
-->

# getReport

Gets a report from the HID device.

```
kern_return_t getReport(IOMemoryDescriptor *report, IOHIDReportType reportType, IOOptionBits options, uint32_t completionTimeout, uint32_t *bytesTransferred);
```

## Parameters

`report`

The report type.

`reportType`

The lower 8 bits will represent the Report ID.  The other 24 bits are options to specify the request.

`options`

Specifies an amount of time (in ms) after which the command will be aborted if the entire command has not been completed.

## Return Value

<doc://com.apple.documentation/documentation/DriverKit/kIOReturnSuccess> on success, or another value if an error occurs. See <doc://com.apple.documentation/documentation/DriverKit/error-codes>.

## Discussion

The report read from the HID device.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)