hidd_get_report_instance()

Get a report instance

Synopsis:

#include <sys/hiddi.h>

int hidd_get_report_instance( struct hidd_collection *collection,
                              _Uint16t report_index,
                              _Uint16t report_type,
                              struct hidd_report_instance **report_instance );

Arguments:

collection

The handle of the collection the report belongs to, as returned by hidd_get_collections() or by hidd_report_collection().

report_index

The index of the report.

report_type
The report type. One of:
  • HIDD_INPUT_REPORT
  • HIDD_OUTPUT_REPORT
  • HIDD_FEATURE_REPORT
report_instance

The location to store the report instance.

Description:

The hidd_get_report_instance() function gets a handle to the report_index report instance with the report_type in the given collection. This handle can then be passed to hidd_report_attach().

Returns:

EOK
Success.
EINVAL
The collection or report_instance is NULL.
ENOENT
Can't find a report with given report_type and report_index.

This function can also return a device-specific error code.

Classification:

QNX OS

Safety:
Cancellation point Yes
Signal handler No
Thread Yes
Page updated: