← Back to branch summary

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

« back to all changes in this revision

Viewing changes to man/confdb_object_find.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:
man/confdb_object_find.3
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_find
49
 
function repeatedly returns objects that match a given name. You must call 
 
49
function repeatedly returns objects that match a given name. You must call
50
50
.B confdb_object_find_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_find
53
53
will return the handle of the first object that matches the passed in name. Subsequent calls will return any remaining objects
54
54
with the same name. The function returns CONFDB_ERR_ACCESS when the all of the matching objects have been seen.
55
55
.BR
56
 
You need to provide the same object name and length for each call to 
 
56
You need to provide the same object name and length for each call to
57
57
.B confdb_object_find,
58
58
If you change either of then, the results are undefined.
59
59
.BR
60
 
The library holds a seperate context for each parent object, so you can call confdb_object_iter() on several parent objects at the same time and they will not interfere. Nor will they interfere with 
 
60
The library holds a seperate context for each parent object, so you can call confdb_object_iter() on several parent objects at the same time and they will not interfere. Nor will they interfere with
61
61
.B confdb_object_iter
62
62
or
63
63
.B confdb_key_iter
64
64
calls on the same parent object.
65
65
.BR
66
 
.B When you have finished searching for objects, call the 
 
66
.B When you have finished searching for objects, call the
67
67
.B confdb_object_find_destroy
68
68
library call to free up memory associated with the search context.
69
69
.SH RETURN VALUE
79
79
.BR confdb_object_create (3),
80
80
.BR confdb_object_destroy (3),
81
81
.BR confdb_object_parent_get (3),
82
 
.BR confdb_key_create (3),      
83
 
.BR confdb_key_delete (3),      
 
82
.BR confdb_key_create (3),
 
83
.BR confdb_key_delete (3),
84
84
.BR confdb_key_get (3),
85
85
.BR confdb_key_replace (3),
86
86
.BR confdb_object_find_start (3),
87
87
.BR confdb_object_find (3),
88
 
.BR confdb_object_iter_start (3),       
89
 
.BR confdb_object_iter (3),     
90
 
.BR confdb_key_iter_start (3),  
91
 
.BR confdb_key_iter (3),        
 
88
.BR confdb_object_iter_start (3),
 
89
.BR confdb_object_iter (3),
 
90
.BR confdb_key_iter_start (3),
 
91
.BR confdb_key_iter (3),
92
92
.PP