share/man/man3picltree/ptree_get_prop_by_name.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_PROP_BY_NAME 3PICLTREE "Mar 28, 2000"
   7 .SH NAME
   8 ptree_get_prop_by_name \- get a property handle by name
   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_prop_by_name\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR, \fBchar *\fR\fIname\fR,
  16      \fBpicl_prophdl_t *\fR\fIproph\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBptree_get_prop_by_name()\fR function gets the handle of the property,
  23 whose name is specified in \fIname\fR, of the node specified by the handle
  24 \fInodeh\fR.  The property handle is copied into the location specified by
  25 \fIproph\fR.
  26 .SH RETURN VALUES
  27 .sp
  28 .LP
  29 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  30 integer is returned to indicate an error.
  31 .sp
  32 .LP
  33 \fBPICL_RESERVEDNAME\fR is returned if the name specified is a PICL reserved
  34 name property. Reserved name properties do not have an associated property
  35 handle. Use \fBptree_get_propval_by_name\fR(3PICLTREE) to get the value of a
  36 reserved property.
  37 .sp
  38 .LP
  39 \fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
  40 occurs if the PICL tree was refreshed or reinitialized.
  41 .sp
  42 .LP
  43 \fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
  44 .SH ERRORS
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBPICL_NOTNODE\fR\fR
  49 .ad
  50 .RS 22n
  51 Not a node
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBPICL_RESERVEDNAME\fR\fR
  58 .ad
  59 .RS 22n
  60 Property name is reserved
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBPICL_INVALIDHANDLE\fR\fR
  67 .ad
  68 .RS 22n
  69 Invalid handle
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBPICL_STALEHANDLE\fR\fR
  76 .ad
  77 .RS 22n
  78 Stale handle
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBPICL_PROPNOTFOUND\fR\fR
  85 .ad
  86 .RS 22n
  87 Property not found
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBPICL_FAILURE\fR\fR
  94 .ad
  95 .RS 22n
  96 General system failure
  97 .RE
  98
  99 .SH ATTRIBUTES
 100 .sp
 101 .LP
 102 See \fBattributes\fR(5) for descriptions of the following attributes:
 103 .sp
 104
 105 .sp
 106 .TS
 107 box;
 108 c | c
 109 l | l .
 110 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 111 _
 112 Interface Stability     Evolving
 113 _
 114 MT-Level        MT-Safe
 115 .TE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBptree_get_first_prop\fR(3PICLTREE),
 121 \fBptree_get_propval_by_name\fR(3PICLTREE), \fBattributes\fR(5)