~ubuntu-branches/ubuntu/precise/corosync/precise-proposed

« back to all changes in this revision

Viewing changes to man/confdb_object_iter.3

  • Committer: Bazaar Package Importer
  • Author(s): Ante Karamatic
  • Date: 2009-08-21 09:29:56 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090821092956-w9qxxxx3zeoh8dem
Tags: 1.0.0-4ubuntu2
* debian/control:
  - 'Ubuntu Developers' instead of 'Ubuntu Core Developers'
    as maintainer
  - Bump debhelper dependecy to 7

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
.\" * Author: Christine Caulfield <ccaulfie@redhat.com>
7
7
.\" *
8
8
.\" * This software licensed under BSD license, the text of which follows:
9
 
.\" * 
 
9
.\" *
10
10
.\" * Redistribution and use in source and binary forms, with or without
11
11
.\" * modification, are permitted provided that the following conditions are met:
12
12
.\" *
46
46
.SH DESCRIPTION
47
47
The
48
48
.B confdb_object_iter
49
 
function repeatedly returns all objects that are subobjects of the specified parent. You must call 
 
49
function repeatedly returns all objects that are subobjects of the specified parent. You must call
50
50
.B confdb_object_iter_start
51
51
first. This establishes a context for the parent object so that it knows where you are in the list. Then the next call to
52
52
.B confdb_object_iter
53
53
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
54
54
as its handle.
55
55
.BR
56
 
.B When you have finished searching for objects, call the 
 
56
.B When you have finished searching for objects, call the
57
57
.B confdb_object_iter_destroy
58
58
library call to free up memory associated with the search context.
59
59
.BR
71
71
.BR confdb_object_create (3),
72
72
.BR confdb_object_destroy (3),
73
73
.BR confdb_object_parent_get (3),
74
 
.BR confdb_key_create (3),      
75
 
.BR confdb_key_delete (3),      
 
74
.BR confdb_key_create (3),
 
75
.BR confdb_key_delete (3),
76
76
.BR confdb_key_get (3),
77
77
.BR confdb_key_replace (3),
78
78
.BR confdb_object_find_start (3),
79
79
.BR confdb_object_find (3),
80
 
.BR confdb_object_iter_start (3),       
81
 
.BR confdb_object_iter (3),     
82
 
.BR confdb_key_iter_start (3),  
83
 
.BR confdb_key_iter (3),        
 
80
.BR confdb_object_iter_start (3),
 
81
.BR confdb_object_iter (3),
 
82
.BR confdb_key_iter_start (3),
 
83
.BR confdb_key_iter (3),
84
84
.PP