1CONFDB_OBJECT_ITER(C3o)rosync Cluster Engine Programmer's ManCuOaNlFDB_OBJECT_ITER(3)
2
3
4
6 confdb_object_iter - Iterate through objects in the Configuration Data‐
7 base
8
10 #include <corosync/confdb.h>
11
12 confdb_error_t confdb_object_iter_start(confdb_handle_t handle,
13 unsigned int parent_object_handle );
14
15 confdb_error_t confdb_object_iter(confdb_handle_t handle, unsigned int
16 parent_object_handle, unsigned int *object_handle, void *object_name,
17 int *object_name_len );
18
19 confdb_error_t confdb_object_iter_destroy(confdb_handle_t handle,
20 unsigned int parent_object_handle );
21
22
24 The confdb_object_iter function repeatedly returns all objects that are
25 subobjects of the specified parent. You must call
26 confdb_object_iter_start first. This establishes a context for the par‐
27 ent object so that it knows where you are in the list. Then the next
28 call to confdb_object_iter will return the handle of the first object
29 in the list. Subsequent calls will return any remaining objects. The
30 function returns CONFDB_ERR_ACCESS when the all of the matching objects
31 have been seen. The function returns the name and length of the object
32 as well as its handle. When you have finished searching for objects,
33 call the confdb_object_iter_destroy library call to free up memory
34 associated with the search context.
35
37 This call returns the CONFDB_OK value if successful, otherwise an error
38 is returned.
39
41 The errors are undocumented.
42
44 confdb_overview(8), confdb_initialize(3), confdb_finalize(3),
45 confdb_dispatch(3), confdb_object_create(3), confdb_object_destroy(3),
46 confdb_object_parent_get(3), confdb_key_create(3),
47 confdb_key_delete(3), confdb_key_get(3), confdb_key_replace(3),
48 confdb_object_find_start(3), confdb_object_find(3),
49 confdb_object_iter_start(3), confdb_object_iter(3),
50 confdb_key_iter_start(3), confdb_key_iter(3),
51
52corosync Man Page 2008-04-17 CONFDB_OBJECT_ITER(3)