Retrieves boolean type values associated with the specified key from the specified properties object.
#include "am_properties.h" AM_EXPORT am_status_t am_properties_get_boolean(am_properties_t properties, const char *key, int *value_ptr);
This function takes the following parameters:
The specified properties object.
Pointer to the specified key in the specified properties object.
Pointer to the location where the boolean associated with the specified key will be stored.
One of the following values stored in value_ptr:
If the value associated with the specified key is true, on, or yes.
If the value associated with the specified key is false, off, or no.
If the associated value does not match any of these recognized boolean values, AM_INVALID_VALUE will be returned.