hidd_get_product_string()

Get the product string

Synopsis:

#include <sys/hiddi.h>

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

Arguments:

report_instance

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

device_instance

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

buff
A pre-allocated memory buffer to store the product string.
buff_len

The length of the provided buffer in bytes.

Description:

The hidd_get_product_string() function gets the product string from a device.
Note:
Some devices don't implement the product string descriptor.

Returns:

EOK
Success.
ENOTCONN
The connection is NULL
EINVAL
The device_instance or buff is NULL.
ENODEV
The device was removed.
ENOTSUP
The device doesn't support getting the product string.

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

Classification:

QNX OS

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