---
title: getReport
framework: hiddriverkit
role: symbol
role_heading: Instance Method
path: hiddriverkit/iohiddevice/getreport
---

# getReport

Gets a report from the HID device.

## Declaration

```occ
virtual kern_return_t getReport(IOMemoryDescriptor *report, IOHIDReportType reportType, IOOptionBits options, uint32_t completionTimeout, OSAction *action);
```

## Parameters

- `report`: A memory descriptor that contains the report from the HID device.
- `reportType`: The report type.
- `options`: The lower 8 bits of the report ID. The other 24 bits are options to specify the request.
- `completionTimeout`: The amount of time, in milliseconds, after which to abort the command if the entire command hasn’t completed.
- `action`: The function to call when the request completes. If you omit this function, the method executes synchronously, blocking the current thread until the request completes.

## Return Value

Return Value kIOReturnSuccess on success, or another value if an error occurs. See Error Codes.

## Discussion

Discussion The default implementation of this method does nothing. Subclasses must override it and use their implementation to retrieve the report information from the device.

## See Also

### Processing Device Reports

- [handleReport](hiddriverkit/iohiddevice/handlereport.md)
- [setReport](hiddriverkit/iohiddevice/setreport.md)
- [CompleteReport](hiddriverkit/iohiddevice/completereport.md)
- [Report Options](hiddriverkit/report-options-enum.md)