hidd_get_indexed_string()

Get the indexed string

Synopsis:

#include <sys/hiddi.h>

int hidd_get_indexed_string( struct hidd_connection *connection,
                             struct hidd_device_instance *device_instance,
                             _Uint16t index,
                             void *buff,
                             _Uint16t buff_len );

Arguments:

connection

The HID stack connection handle (from hidd_connect()).

device_instance

A pointer to hidd_device_instance_t instance containing the number of the device.

index
The index of the string to get.
buff
A pre-allocated memory buffer to store the indexed string.
buff_len
The length of the provided buffer in bytes.

Description:

The hidd_get_indexed_string() function gets the string with index index from the device.

CAUTION:
Some device don't implement the indexed string.

Returns:

EOK
Success.
ENOTCONN
The connection argument is NULL.
EINVAL
The device_instance or buff is NULL.
ENODEV
The device was removed.
ENOTSUP
The device doesn't support getting indexed strings.

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

Classification:

QNX OS

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