Expose confdb write to the library.
[openais.git] / man / confdb_object_parent_get.3
bloba686fccac26d4dec00d51e19205bb4cd58af8e45
1 .\"/*
2 .\" * Copyright (c) 2008 Red Hat, Inc.
3 .\" *
4 .\" * All rights reserved.
5 .\" *
6 .\" * Author: Christine Caulfield <ccaulfie@redhat.com>
7 .\" *
8 .\" * This software licensed under BSD license, the text of which follows:
9 .\" * 
10 .\" * Redistribution and use in source and binary forms, with or without
11 .\" * modification, are permitted provided that the following conditions are met:
12 .\" *
13 .\" * - Redistributions of source code must retain the above copyright notice,
14 .\" *   this list of conditions and the following disclaimer.
15 .\" * - Redistributions in binary form must reproduce the above copyright notice,
16 .\" *   this list of conditions and the following disclaimer in the documentation
17 .\" *   and/or other materials provided with the distribution.
18 .\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
19 .\" *   contributors may be used to endorse or promote products derived from this
20 .\" *   software without specific prior written permission.
21 .\" *
22 .\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23 .\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26 .\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 .\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 .\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 .\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 .\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32 .\" * THE POSSIBILITY OF SUCH DAMAGE.
33 .\" */
34 .TH CONFDB_OBJECT_PARENT_GET 3 2008-04-17 "openais Man Page" "Openais Programmer's Manual"
35 .SH NAME
36 confdb_parent_get \- Configuration Database Object Parent
37 .SH SYNOPSIS
38 .B #include <openais/confdb.h>
39 .sp
40 .BI "confdb_error_t confdb_object_parent_get(confdb_handle_t " handle ", unsigned int " object_handle ",        unsigned int " *parent_object_handle ");"
41 .SH DESCRIPTION
42 The
43 .B confdb_object_parent_get
44 returns the parent object handle of already known object.
45 .B object_handle 
46 is the handle of an existing object
47 .B parent_object_handle
48 returns the handle of its parent.
49 .SH RETURN VALUE
50 This call returns the CONFDB_OK value if successful, otherwise an error is returned.
51 .PP
52 .SH ERRORS
53 The errors are undocumented.
54 .SH "SEE ALSO"
55 .BR confdb_overview (8),
56 .BR confdb_initialize (3),
57 .BR confdb_finalize (3),
58 .BR confdb_dispatch (3),
59 .BR confdb_object_create (3),
60 .BR confdb_object_destroy (3),
61 .BR confdb_object_parent_get (3),
62 .BR confdb_key_create (3),      
63 .BR confdb_key_delete (3),      
64 .BR confdb_key_get (3),
65 .BR confdb_key_replace (3),
66 .BR confdb_object_find_start (3),
67 .BR confdb_object_find (3),
68 .BR confdb_object_iter_start (3),       
69 .BR confdb_object_iter (3),     
70 .BR confdb_key_iter_start (3),  
71 .BR confdb_key_iter (3),        
72 .PP