share/man/man3picltree/ptree_get_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_GET_PROPVAL 3PICLTREE "Mar 28, 2000"
   7 .SH NAME
   8 ptree_get_propval, ptree_get_propval_by_name \- get the value of 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_get_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_get_propval_by_name\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR,
  22      \fBvoid *\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_get_propval()\fR function gets the value of the property specified
  29 by the handle \fIproph\fR and copies it into the buffer specified by
  30 \fIvalbuf\fR.  The size of the buffer \fIvalbuf\fR is specifed in \fInbytes\fR.
  31 .sp
  32 .LP
  33 The \fBptree_get_propval_by_name()\fR function gets the value of the property,
  34 whose name is specified by \fIname\fR, from the node specified by handle
  35 \fInodeh\fR.  The value is copied into the buffer specified by \fIvalbuf\fR.
  36 The size of the buffer is specified by \fInbytes\fR.
  37 .sp
  38 .LP
  39 For volatile properties, the read 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 .sp
 109 .ne 2
 110 .na
 111 \fB\fBPICL_FAILURE\fR\fR
 112 .ad
 113 .RS 22n
 114 General system failure
 115 .RE
 116
 117 .SH ATTRIBUTES
 118 .sp
 119 .LP
 120 See \fBattributes\fR(5) for descriptions of the following attributes:
 121 .sp
 122
 123 .sp
 124 .TS
 125 box;
 126 c | c
 127 l | l .
 128 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 129 _
 130 MT-Level        MT-Safe
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBptree_update_propval\fR(3PICLTREE), \fBattributes\fR(5)