am_properties_get_boolean_with_default()

Retrieves values from the properties map.

Syntax

#include "am_properties.h"
am_properties_get_boolean_with_default(am_properties_t properties,
                      const char *key, int default_value,
                      int *value_ptr);

Parameters

See am_properties_get().

Returns

• The unparsed string form of the value associated with the specified key. See am_properties_get().

• A value stored in value_ptr with one of the following values.

!0

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

0

If the value associated with the specified key is one of: false, off, or no.

Details

If the associated value does not match any of the recognized boolean values, then AM_INVALID_VALUE will be returned.

See also am_properties_get().