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