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

# GetReport

Retrieves a new input report from the HID device.

```
virtual kern_return_t GetReport(IOMemoryDescriptor *report, IOHIDReportType reportType, uint32_t reportID, IOOptionBits options);
```

## Parameters

`report`

The memory descriptor in which to store the report data. On output, this descriptor contains the bytes of the report.

`reportType`

The type of report you want.

`reportID`

The unique identifier for the report.

`options`

Options to specify when requesting the report.

## 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

This method requests the report by calling the [`getReport`](/documentation/HIDDriverKit/IOHIDDevice/getReport) method of its associated [`IOHIDDevice`](/documentation/HIDDriverKit/IOHIDDevice) object. When getting the report from the device, this method combines the `reportID` and `options` together, with the `reportID` occupying the lower 8 bits of a 32-bit integer, and the `options` occupying the upper 24 bits.

---

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)