am_properties_get_entries()

Returns an iterator object that can be used to sequence through the entries in the specified properties object.

Syntax

#include "am_properties.h"
AM_EXPORT am_status_t
am_properties_get_entries(am_properties_t properties,
                          am_properties_iter_t *properties_iter_ptr);

Parameters

This function takes the following parameters:

properties

The specified properties object.

properties_iter_ptr

Pointer to the location of the new properties iterator object.

Returns

This function returns one of the following values of the am_status_t enumeration (defined in the <am_types.h> header file):

AM_SUCCESS

If no error was detected.

AM_NO_MEMORY

If unable to allocate memory for the iterator object.

AM_INVALID_ARGUMENT

If properties_iter_ptr is NULL. If properties_iter_ptr is not NULL and an error is returned, the location that it refers to will be set to NULL.

AM_NOT_FOUND

If the specified properties object contains no entries.