Sun Java System Access Manager 7 2005Q4 C API Reference

am_properties_get_entries()

Returns an iterator object that can be used to enumerate all of the entries in the specified properties object. See also am_properties_get() .

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 handle for the properties object to be examined
properties_iter_ptr: Pointer to where the handle for the new properties iterator object should be stored.

Returns

This function returns am_status_t with one of the following values:

AM_SUCCESS: If no error was detected.
AM_NO_MEMORY: If unable to allocate memory for the properties iterator object.
AM_INVALID_ARGUMENT: If the properties_iter_ptr argument is NULL.
AM_NOT_FOUND: If the specified properties object contains no entries.

Details

If the properties_iter_ptr argument is non-NULL, then the location that it refers to will be set to NULL if an error is returned.