man/confdb_object_create.3

   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_CREATE 3 2008-04-17 "openais Man Page" "Openais Programmer's Manual"
  35 .SH NAME
  36 confdb_object_create \- Create a new object in the Configuration Database
  37 .SH SYNOPSIS
  38 .B #include <openais/confdb.h>
  39 .sp
  40 .BI "confdb_error_t confdb_object_create(confdb_handle_t " handle ", unsigned int " parent_object_handle ",
  41 .BI     void " *object_name ",
  42 .BI     int " object_name_len ",
  43 .BI     unsigned int " *object_handle "); "
  44
  45 .SH DESCRIPTION
  46 The
  47 .B confdb_object_create
  48 function create a new object in the configuration database. Objects may contain other sub-objects or
  49 keys with values.
  50 .BR
  51 On success the handle of the new object is returned in
  52 .B object_handle.
  53 This value should be used to refer to the object in future, eg when retrieving sub-keys or if the
  54 object is destroyed.
  55 .B parent_object_handle
  56 is the handle of the object that is the parent of the new object. This can be
  57 .B OBJECT_PARENT_HANDLE
  58 if the new object is to be a child of the top-level object.
  59 .BR
  60 Object names are not required to be unique in the database. If you call
  61 .B confdb_object_create
  62 twice with the same parameters you will create two different objects with the same name
  63 but distinct object handles. You can iterate through similarly name objects using the
  64 .B confdb_object_find
  65 call.
  66 .SH RETURN VALUE
  67 This call returns the CONFDB_OK value if successful, otherwise an error is returned.
  68 .PP
  69 .SH ERRORS
  70 The errors are undocumented.
  71 .SH "SEE ALSO"
  72 .BR confdb_initialize (3),
  73 .BR confdb_finalize (3),
  74 .BR confdb_fd_get (3),
  75 .BR confdb_dispatch (3),
  76 .BR confdb_object_create (3),
  77 .BR confdb_object_destroy (3),
  78 .BR confdb_object_parent_get (3),
  79 .BR confdb_key_create (3),
  80 .BR confdb_key_delete (3),
  81 .BR confdb_key_get (3),
  82 .BR confdb_key_replace (3),
  83 .BR confdb_object_find_start (3),
  84 .BR confdb_object_find (3),
  85 .BR confdb_object_iter_start (3),
  86 .BR confdb_object_iter (3),
  87 .BR confdb_key_iter_start (3),
  88 .BR confdb_key_iter (3),
  89 .PP