get_metadata_limits_func_t

Updated: April 19, 2023

Retrieve the metadata if the specified metadata type is supported and is within the specified limits

Synopsis:

#include <sensor/external_sensor_api.h>
typedef int(* get_metadata_limits_func_t)(void *handle,
            sensor_metadata_type_t time,
            sensor_metadata_limits_t *limits);

Arguments:

handle
The handle that's returned from calling the function referred to by open_external_sensor_func_t.
type
The specific metadata type to query.
limits
Gets filled with details on the range of supported values for the metadata.

Library:

libsensor

Description:

If the metadata type is not supported by the sensor, only the metadata_supported field needs to be set. If the metadata type is supported, the limit values associated with the metadata need to be set as well.

Note:

This function is optional.

Returns:

SENSOR_EOK when the function successfully completes; otherwise another sensor_error_t value that provides the reason that the call failed.