hidd_get_collections()

Find device collections or sub-collections

Synopsis:

#include <sys/hiddi.h>

int hidd_get_collections( struct hidd_device_instance *device_instance,
                          struct hidd_collection *search,
                          struct hidd_collection ***found,
                          _Uint16t *num_collections );

Arguments:

device_instance

A pointer to hidd_device_instance_t instance, or NULL if sub-collection search should be performed.

search

A handle of the collection to be searched for sub-collections, or NULL if device search should be performed.

found

The location to store the array of collection handlers found.

num_collections

The number of collection handles found and returned in the found parameter.

Description:

The hidd_get_collections() function finds all collections for the device or sub-collections for the collection specified.

Only one of device_instance or search should be specified, with the other one left NULL. If both are specified, only the device search will be performed.

Returns:

EOK
Success.
EINVAL
The found or num_collections argument is NULL.
ENOENT
No collections were found, or both device_instance and search are NULL.

Classification:

QNX OS

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