am_properties_get_boolean()

Retrieves boolean type values associated with the specified key from the specified properties object.

Syntax

#include "am_properties.h"
AM_EXPORT am_status_t
am_properties_get_boolean(am_properties_t properties, 
                          const char *key,
                          int *value_ptr);

Parameters

This function takes the following parameters:

properties

The specified properties object.

key

Pointer to the specified key in the specified properties object.

value_ptr

Pointer to the location where the boolean associated with the specified key will be stored.

Returns

One of the following values stored in value_ptr:

!0

If the value associated with the specified key is true, on, or yes.

0

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.