1CONFDB_KEY_ITER(3)Corosync Cluster Engine Programmer's ManualCONFDB_KEY_ITER(3)
2
3
4
6 confdb_key_iter - Iterate through key/value pairs in the Configuration
7 Database
8
10 #include <corosync/confdb.h>
11
12 confdb_error_t confdb_key_iter_start(confdb_handle_t handle, unsigned
13 int parent_object_handle );
14
15 confdb_error_t confdb_key_iter(confdb_handle_t handle, unsigned int
16 parent_object_handle, void *key_name, int *key_name_len, void *value,
17 int *value_len );
18
19
21 The confdb_key_iter function repeatedly returns all key/value pairs
22 that are subobjects of the specified parent. You must call
23 confdb_key_iter_start first. This establishes a context for the parent
24 object so that it knows where you are in the list. Then the next call
25 to confdb_key_iter will return the first key/value in the list. Subseā
26 quent calls will return any remaining keys. The function returns
27 CONFDB_ERR_ACCESS when the all of the matching keys have been seen.
28 The library holds a seperate context for each parent object, so you can
29 call confdb_key_iter() on several parent objects at the same time and
30 they will not interfere. Nor will they interfere with
31 confdb_object_find or confdb_object_iter calls on the same parent
32 object.
33
35 This call returns the CONFDB_OK value if successful, otherwise an error
36 is returned.
37
39 The errors are undocumented.
40
42 confdb_overview(8), confdb_initialize(3), confdb_finalize(3),
43 confdb_dispatch(3), confdb_object_create(3), confdb_object_destroy(3),
44 confdb_object_parent_get(3), confdb_key_create(3),
45 confdb_key_delete(3), confdb_key_get(3), confdb_key_replace(3),
46 confdb_object_find_start(3), confdb_object_find(3),
47 confdb_object_iter_start(3), confdb_object_iter(3),
48 confdb_key_iter_start(3), confdb_key_iter(3),
49
50corosync Man Page 2008-04-17 CONFDB_KEY_ITER(3)