usr/src/man/man3picltree/ptree_get_propinfo_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_PROPINFO_BY_NAME 3PICLTREE "Aug 1, 2000"
   7 .SH NAME
   8 ptree_get_propinfo_by_name \- get property information and handle of named
   9 property
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicltree\fR [ \fIlibrary\fR... ]
  14 #include <picltree.h>
  15
  16 \fBint\fR \fBptree_get_propinfo_by_name\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR,
  17      \fBconst char *\fR\fIpname\fR, \fBptree_propinfo_t *\fR\fIpinfo\fR,
  18      \fBpicl_prophdl_t *\fR\fIproph\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBptree_get_propinfo_by_name()\fR function copies the property information
  25 of the property specified by \fIpname\fR in the node \fInodeh\fR into the
  26 location given by \fIpinfo\fR. The handle of the property is returned in the
  27 location \fIproph\fR.
  28 .SH RETURN VALUES
  29 .sp
  30 .LP
  31 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  32 integer is returned to indicate an error.
  33 .SH ERRORS
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBPICL_NOTNODE\fR\fR
  38 .ad
  39 .RS 22n
  40 Not a node
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBPICL_PROPNOTFOUND\fR\fR
  47 .ad
  48 .RS 22n
  49 Property not found
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBPICL_RESERVEDNAME\fR\fR
  56 .ad
  57 .RS 22n
  58 Reserved property name specified
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBPICL_INVALIDHANDLE\fR\fR
  65 .ad
  66 .RS 22n
  67 Invalid handle
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBPICL_STALEHANDLE\fR\fR
  74 .ad
  75 .RS 22n
  76 Stale handle
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBPICL_FAILURE\fR\fR
  83 .ad
  84 .RS 22n
  85 General system failure
  86 .RE
  87
  88 .SH ATTRIBUTES
  89 .sp
  90 .LP
  91 See \fBattributes\fR(5) for descriptions of the following attributes:
  92 .sp
  93
  94 .sp
  95 .TS
  96 box;
  97 c | c
  98 l | l .
  99 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 100 _
 101 Interface Stability     Evolving
 102 _
 103 MT-Level        MT-Safe
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBpicl_get_propinfo\fR(3PICL), \fBpicl_get_prop_by_name\fR(3PICL),
 110 \fBattributes\fR(5)