debian man page for confdb_object_iter

CONFDB_OBJECT_ITER(3)				    Corosync Cluster Engine Programmer's Manual 			     CONFDB_OBJECT_ITER(3)

NAME
       confdb_object_iter - Iterate through objects in the Configuration Database

SYNOPSIS
       #include <corosync/confdb.h>

       confdb_error_t confdb_object_iter_start(confdb_handle_t handle, unsigned int parent_object_handle );

       confdb_error_t	confdb_object_iter(confdb_handle_t   handle,   unsigned   int  parent_object_handle,  unsigned	int  *object_handle,  void
       *object_name, int *object_name_len );

       confdb_error_t confdb_object_iter_destroy(confdb_handle_t handle, unsigned int parent_object_handle );

DESCRIPTION
       The  confdb_object_iter	function  repeatedly  returns  all  objects  that  are	subobjects  of	the  specified	parent.  You   must   call
       confdb_object_iter_start  first. This establishes a context for the parent object so that it knows where you are in the list. Then the next
       call to confdb_object_iter will return the handle of the first object in the list. Subsequent calls will return any remaining objects.  The
       function  returns  CONFDB_ERR_ACCESS  when  the all of the matching objects have been seen. The function returns the name and length of the
       object as well as its handle.   When you have finished searching for objects, call the confdb_object_iter_destroy library call to  free	up
       memory associated with the search context.

RETURN VALUE
       This call returns the CONFDB_OK value if successful, otherwise an error is returned.

ERRORS
       The errors are undocumented.

SEE ALSO
       confdb_overview(8),   confdb_initialize(3),   confdb_finalize(3),  confdb_dispatch(3),  confdb_object_create(3),  confdb_object_destroy(3),
       confdb_object_parent_get(3),	  confdb_key_create(3),       confdb_key_delete(3),	  confdb_key_get(3),	    confdb_key_replace(3),
       confdb_object_find_start(3),    confdb_object_find(3),	 confdb_object_iter_start(3),	confdb_object_iter(3),	 confdb_key_iter_start(3),
       confdb_key_iter(3),

corosync Man Page						    2008-04-17						     CONFDB_OBJECT_ITER(3)