share/man/man3picltree/ptree_create_prop.3picltree

   1 '\" te
   2 .\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH PTREE_CREATE_PROP 3PICLTREE "Mar 28, 2000"
   7 .SH NAME
   8 ptree_create_prop, ptree_destroy_prop \- create or destroy a property
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicltree\fR [ \fIlibrary\fR... ]
  13 #include <picltree.h>
  14
  15 \fBint\fR \fBptree_create_prop\fR(\fBptree_propinfo_t *\fR\fIpinfo\fR, \fBvoid *\fR\fIvalbuf\fR,
  16      \fBpicl_prophdl_t *\fR\fIproph\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBptree_destroy_prop\fR(\fBpicl_prophdl_t\fR \fIproph\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBptree_create_prop()\fR function creates a property using the information
  28 specified in \fIpinfo\fR, which includes the name, type, access mode, and size
  29 of the property, as well as the read access function for a volatile property.
  30 The value of the property is specified in the buffer \fIvalbuf\fR, which may be
  31 \fINULL\fR for volatile properties. The handle of the property created is
  32 copied into the location given by \fIproph\fR.  See
  33 \fBlibpicltree\fR(3PICLTREE) for more information on the structure of
  34 \fBptree_propinfo_t\fR structure.
  35 .sp
  36 .LP
  37 The \fBptree_destroy_prop()\fR function destroys the property specified by the
  38 handle \fIproph\fR.  For a table property, the entire table is destroyed. The
  39 property to be destroyed must have been previously deleted.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  44 integer is returned to indicate an error.
  45 .sp
  46 .LP
  47 \fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
  48 occurs if the PICL tree was refreshed or reinitialized.
  49 .sp
  50 .LP
  51 \fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
  52 .SH ERRORS
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBPICL_NOTSUPPORTED\fR\fR
  57 .ad
  58 .RS 22n
  59 Property version not supported
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBPICL_VALUETOOBIG\fR\fR
  66 .ad
  67 .RS 22n
  68 Value exceeds maximum size
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBPICL_NOTPROP\fR\fR
  75 .ad
  76 .RS 22n
  77 Not a property
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBPICL_CANTDESTROY\fR\fR
  84 .ad
  85 .RS 22n
  86 Attempting to destroy before delete
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBPICL_RESERVEDNAME\fR\fR
  93 .ad
  94 .RS 22n
  95 Property name is reserved
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBPICL_INVREFERENCE\fR\fR
 102 .ad
 103 .RS 22n
 104 Invalid reference property value
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBPICL_INVALIDHANDLE\fR\fR
 111 .ad
 112 .RS 22n
 113 Invalid handle
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBPICL_STALEHANDLE\fR\fR
 120 .ad
 121 .RS 22n
 122 Stale handle
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBPICL_FAILURE\fR\fR
 129 .ad
 130 .RS 22n
 131 General system failure
 132 .RE
 133
 134 .SH ATTRIBUTES
 135 .sp
 136 .LP
 137 See \fBattributes\fR(5) for descriptions of the following attributes:
 138 .sp
 139
 140 .sp
 141 .TS
 142 box;
 143 c | c
 144 l | l .
 145 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 146 _
 147 Interface Stability     Evolving
 148 _
 149 MT-Level        MT-Safe
 150 .TE
 151
 152 .SH SEE ALSO
 153 .sp
 154 .LP
 155 \fBlibpicltree\fR(3PICLTREE), \fBptree_add_prop\fR(3PICLTREE),
 156 \fBattributes\fR(5)