This function and all functions beginning with am_properties_get retrieve values from the properties map. The following parameters and exceptions are common to all functions in the am_propteries_get collection. Additional return values may be specified some functions.
#include "am_properties.h" AM_EXPORT am_status_t am_properties_get(am_properties_t properties, const char *key, const char **value_ptr);
This function takes the following parameters:
Handle to the properties object to be examined.
Name of the property to look up.
A pointer to where to store the value associated with the default value.
Default value to use if there is no value associated with the specified key.
This function returns the unparsed string form of the value associated with one of the following keys:
If no error is detected.
If the properties, key, or value_ptr argument is NULL.
If the specified key has no associated value and a default value is not provided.
If the value associated with the specified key is cannot be parsed as required by the particular accessor function.
If insufficient memory is available to look up the key.
This function checks if the key is present is the properties instance and returns its value.
Memory Concerns: Caller must not modify the value_ptr structure or free the memory.