hidd_set_idle()

Set idle rate of a HID device

Synopsis:

#include <sys/hiddi.h>

int hidd_set_idle( struct hidd_report *report,
                   _Uint16t idle_rate );

Arguments:

report

The handle of a report (from hidd_report_attach()).

idle_rate

The idle rate of the device, as defined by the HID class specification.

Description:

The hidd_set_idle() function sets the idle rate of a device. Idle rate is the rate at which the device will send input reports when the data device would send hasn't changed. This could be used to implement repeat rates for buttons on keyboards. Note that this on a device basis not a report basis.

Returns:

EOK
Success.
EINVAL

The report is NULL, or idle_rate is 0.

ENODEV

The specified report doesn't exist. If in a loop, then there's nothing at that report. If from a callback, then the device has since been removed.

ENOTSUP

The device doesn't implement this feature.

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

Classification:

QNX OS

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