share/man/man3picl/picl_set_propval.3picl

   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 PICL_SET_PROPVAL 3PICL "Mar 28, 2000"
   7 .SH NAME
   8 picl_set_propval, picl_set_propval_by_name \- set the value of a property to
   9 the specified value
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ]
  14 #include <picl.h>
  15
  16 \fBint\fR \fBpicl_set_propval\fR(\fBpicl_prophdl_t\fR \fIproph\fR, \fBvoid *\fR\fIvalbuf\fR,
  17      \fBsize_t\fR \fInbytes\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBpicl_set_propval_by_name\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR,
  23      \fBconst char *\fR\fIpname\fR, \fBvoid *\fR\fIvalbuf\fR, \fBsize_t\fR \fInbytes\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBpicl_set_propval()\fR function sets the value of the property specified
  30 by the handle \fIproph\fR to the value contained in the buffer \fIvalbuf\fR.
  31 The argument \fInbytes\fR specifies the size of the buffer \fIvalbuf\fR.
  32 .sp
  33 .LP
  34 The \fBpicl_set_propval_by_name()\fR function sets the value of the property
  35 named \fIpname\fR of the node specified by the handle \fInodeh\fR to the value
  36 contained in the buffer \fIvalbuf\fR. The argument \fInbytes\fR specifies the
  37 size of the buffer \fIvalbuf\fR.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  42 integer is returned to indicate an error.
  43 .sp
  44 .LP
  45 \fBPICL_PERMDENIED\fR is returned if the client does not have sufficient
  46 permission to access the property.
  47 .sp
  48 .LP
  49 \fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
  50 occurs if the PICL tree was refreshed or reinitialized.
  51 .sp
  52 .LP
  53 \fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
  54 This error may be returned for a previously valid handle if the daemon was
  55 brought down and restarted. When this occurs a client must revalidate any saved
  56 handles.
  57 .SH ERRORS
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBPICL_NOTINITIALIZED\fR\fR
  62 .ad
  63 .RS 23n
  64 Session not initialized
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBPICL_NORESPONSE\fR\fR
  71 .ad
  72 .RS 23n
  73 Daemon not responding
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBPICL_PERMDENIED\fR\fR
  80 .ad
  81 .RS 23n
  82 Insufficient permission
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBPICL_NOTWRITABLE\fR\fR
  89 .ad
  90 .RS 23n
  91 Property is read-only
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBPICL_VALUETOOBIG\fR\fR
  98 .ad
  99 .RS 23n
 100 Value too big
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBPICL_NOTPROP\fR\fR
 107 .ad
 108 .RS 23n
 109 Not a property
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBPICL_NOTNODE\fR\fR
 116 .ad
 117 .RS 23n
 118 Not a node
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBPICL_INVALIDHANDLE\fR\fR
 125 .ad
 126 .RS 23n
 127 Invalid handle specified
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fBPICL_STALEHANDLE\fR\fR
 134 .ad
 135 .RS 23n
 136 Stale handle specified
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fBPICL_FAILURE\fR\fR
 143 .ad
 144 .RS 23n
 145 General system failure
 146 .RE
 147
 148 .SH ATTRIBUTES
 149 .sp
 150 .LP
 151 See \fBattributes\fR(5)  for descriptions of the following attributes:
 152 .sp
 153
 154 .sp
 155 .TS
 156 box;
 157 c | c
 158 l | l .
 159 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 160 _
 161 MT-Level        MT-Safe
 162 .TE
 163
 164 .SH SEE ALSO
 165 .sp
 166 .LP
 167 \fBattributes\fR(5)