|
@@ -0,0 +1,81 @@
|
|
|
|
|
+.\"/*
|
|
|
|
|
+.\" * Copyright (c) 2012 Red Hat, Inc.
|
|
|
|
|
+.\" *
|
|
|
|
|
+.\" * All rights reserved.
|
|
|
|
|
+.\" *
|
|
|
|
|
+.\" * Author: Jan Friesse <jfriesse@redhat.com>
|
|
|
|
|
+.\" *
|
|
|
|
|
+.\" * This software licensed under BSD license, the text of which follows:
|
|
|
|
|
+.\" *
|
|
|
|
|
+.\" * Redistribution and use in source and binary forms, with or without
|
|
|
|
|
+.\" * modification, are permitted provided that the following conditions are met:
|
|
|
|
|
+.\" *
|
|
|
|
|
+.\" * - Redistributions of source code must retain the above copyright notice,
|
|
|
|
|
+.\" * this list of conditions and the following disclaimer.
|
|
|
|
|
+.\" * - Redistributions in binary form must reproduce the above copyright notice,
|
|
|
|
|
+.\" * this list of conditions and the following disclaimer in the documentation
|
|
|
|
|
+.\" * and/or other materials provided with the distribution.
|
|
|
|
|
+.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
|
|
|
|
|
+.\" * contributors may be used to endorse or promote products derived from this
|
|
|
|
|
+.\" * software without specific prior written permission.
|
|
|
|
|
+.\" *
|
|
|
|
|
+.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
|
|
+.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
+.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
+.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
|
|
|
+.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
|
+.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
|
+.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
|
+.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
|
+.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
|
+.\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
|
|
|
|
|
+.\" * THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
+.\" */
|
|
|
|
|
+.TH CONFDB_KEY_GET 3 2012-11-07 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
|
|
|
|
|
+.SH NAME
|
|
|
|
|
+confdb_key_get \- Retreive key value from the Configuration Database
|
|
|
|
|
+.SH SYNOPSIS
|
|
|
|
|
+.B #include <corosync/confdb.h>
|
|
|
|
|
+.sp
|
|
|
|
|
+.BI "cs_error_t confdb_key_get (confdb_handle_t " handle ",
|
|
|
|
|
+.BI hdb_handle_t " parent_object_handle ",
|
|
|
|
|
+.BI void " *key_name ",
|
|
|
|
|
+.BI size_t " key_name_len ",
|
|
|
|
|
+.BI void " *value ",
|
|
|
|
|
+.BI size_t " *value_len"); "
|
|
|
|
|
+
|
|
|
|
|
+.SH DESCRIPTION
|
|
|
|
|
+The
|
|
|
|
|
+.B confdb_key_get
|
|
|
|
|
+function retreive key value for key with given name from specified parent object.
|
|
|
|
|
+.BR
|
|
|
|
|
+Unlike objects, keys do not have handles, so you can't go directly to a non-unique key
|
|
|
|
|
+without using the
|
|
|
|
|
+.B confdb_key_iter
|
|
|
|
|
+function, so
|
|
|
|
|
+.B confdb_key_get
|
|
|
|
|
+returns only first found key.
|
|
|
|
|
+.SH RETURN VALUE
|
|
|
|
|
+This call returns the CONFDB_OK value if successful, otherwise an error is returned.
|
|
|
|
|
+.PP
|
|
|
|
|
+.SH ERRORS
|
|
|
|
|
+The errors are undocumented.
|
|
|
|
|
+.SH "SEE ALSO"
|
|
|
|
|
+.BR confdb_overview (8),
|
|
|
|
|
+.BR confdb_initialize (3),
|
|
|
|
|
+.BR confdb_finalize (3),
|
|
|
|
|
+.BR confdb_dispatch (3),
|
|
|
|
|
+.BR confdb_object_create (3),
|
|
|
|
|
+.BR confdb_object_destroy (3),
|
|
|
|
|
+.BR confdb_object_parent_get (3),
|
|
|
|
|
+.BR confdb_key_create (3),
|
|
|
|
|
+.BR confdb_key_delete (3),
|
|
|
|
|
+.BR confdb_key_get (3),
|
|
|
|
|
+.BR confdb_key_replace (3),
|
|
|
|
|
+.BR confdb_object_find_start (3),
|
|
|
|
|
+.BR confdb_object_find (3),
|
|
|
|
|
+.BR confdb_object_iter_start (3),
|
|
|
|
|
+.BR confdb_object_iter (3),
|
|
|
|
|
+.BR confdb_key_iter_start (3),
|
|
|
|
|
+.BR confdb_key_iter (3),
|
|
|
|
|
+.PP
|
Jan Friesse