Sensor Library Referencesensor_api.h Parent topic: sensor_api.h

sensor_get_metadata_limits()

Updated: April 19, 2023

Retrieve limit values for a metadata type

Synopsis:

#include <sensor/sensor_api.h>
sensor_error_t sensor_get_metadata_limits(sensor_handle_t handle,
                                          sensor_metadata_type_t metadata_type,
                                          sensor_metadata_limits_t *limits)

Arguments:

handle
The handle that's returned from calling sensor_open().
metadata_type
The specific metadata type to query.
limits
A pointer to memory for storing a sensor_metadata_limits_t structure that will contain the metadata limit values.

Library:

libsensor

Description:

When this function succeeds, the limits->metadata_supported value is set to true if the metadata is supported by the sensor, or to false if it's not supported. In the former case, the other fields in the structure pointed to by limits specify the supported limits for this metadata type.

Returns:

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

Parent topic: sensor_api.h