axl main logo
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
char * axl_node_annotate_get_string ( axlNode node,
const char *  key,
axl_bool  lookup_in_parent 
)

Allows to retrieve the annotated string value stored on the particular node, under the provided key.

Parameters
nodeThe node that is required to return the annotated data.
keyThe key to be used to lookup for the data annotated.
lookup_in_parentOnce the lookup fails, this variable allows to signal the function to also lookup the value in the parent nodes. This mechanism allows to store data on parent nodes that are shared by child nodes.

NOTE: To make this function work properly you must store double values using axl_node_annotate_string. Storing values using other functions will lead to unpredictable results.

Returns
The string value stored using axl_node_annotate_string. If the key provided doesn't exists, the function returns NULL.

References AXL_LEVEL_CRITICAL, axl_node_annotate_get(), and axl_return_val_if_fail.