share/man/man3picltree/ptree_update_propval.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_UPDATE_PROPVAL 3PICLTREE "Mar 28, 2000"
   7 .SH NAME
   8 ptree_update_propval, ptree_update_propval_by_name \- update a property value
   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_update_propval\fR(\fBpicl_prophdl_t\fR \fIproph\fR, \fBvoid *\fR\fIvalbuf\fR,
  16      \fBsize_t\fR \fInbytes\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBptree_update_propval_by_name\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR,
  22      \fBchar *\fR\fIname\fR, \fBvoid *\fR\fIvalbuf\fR, \fBsize_t\fR \fInbytes\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBptree_update_propval()\fR function updates the value of the property
  29 specified by \fIproph\fR with the value specified in the buffer \fIvalbuf\fR.
  30 The size of the buffer \fIvalbuf\fR is specified in \fInbytes\fR.
  31 .sp
  32 .LP
  33 The \fBptree_update_propval_by_name()\fR function updates the value of the
  34 property, whose name is specified by \fIname\fR, of the node specified by
  35 handle \fInodeh\fR.  The new value is specified in the buffer \fIvalbuf\fR,
  36 whose size is specified in \fInbytes\fR.
  37 .sp
  38 .LP
  39 For volatile properties, the write access function provided by the plug-in
  40 publishing the property is invoked.
  41 .SH RETURN VALUES
  42 .sp
  43 .LP
  44 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  45 integer is returned to indicate an error.
  46 .sp
  47 .LP
  48 \fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
  49 occurs if the PICL tree was refreshed or reinitialized.
  50 .sp
  51 .LP
  52 \fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
  53 .SH ERRORS
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBPICL_VALUETOOBIG\fR\fR
  58 .ad
  59 .RS 22n
  60 Value too big
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBPICL_NOTPROP\fR\fR
  67 .ad
  68 .RS 22n
  69 Not a property
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBPICL_NOTNODE\fR\fR
  76 .ad
  77 .RS 22n
  78 Not a node
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBPICL_INVALIDHANDLE\fR\fR
  85 .ad
  86 .RS 22n
  87 Invalid handle
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBPICL_STALEHANDLE\fR\fR
  94 .ad
  95 .RS 22n
  96 Stale handle
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBPICL_PROPNOTFOUND\fR\fR
 103 .ad
 104 .RS 22n
 105 Property not found
 106 .RE
 107
 108 .SH ATTRIBUTES
 109 .sp
 110 .LP
 111 See \fBattributes\fR(5) for descriptions of the following attributes:
 112 .sp
 113
 114 .sp
 115 .TS
 116 box;
 117 c | c
 118 l | l .
 119 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 120 _
 121 Interface Stability     Evolving
 122 _
 123 MT-Level        MT-Safe
 124 .TE
 125
 126 .SH SEE ALSO
 127 .sp
 128 .LP
 129 \fBptree_get_propval\fR(3PICLTREE), \fBattributes\fR(5)