usr/src/man/man3picl/picl_get_first_prop.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_GET_FIRST_PROP 3PICL "Mar 28, 2000"
   7 .SH NAME
   8 picl_get_first_prop, picl_get_next_prop \- get a property handle of a node
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ]
  13 #include <picl.h>
  14
  15 \fBint\fR \fBpicl_get_first_prop\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR,
  16      \fBpiclprop_hdl_t *\fR\fIproph\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBpicl_get_next_prop\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
  22      \fBpicl_prophdl_t *\fR\fInextprop\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBpicl_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 given by
  30 \fIproph\fR.
  31 .sp
  32 .LP
  33 The \fBpicl_get_next_prop()\fR function gets the handle of the next property
  34 after the one specified by \fIproph\fR from the property list of the node, and
  35 copies it into the location specified by \fInextprop\fR.
  36 .sp
  37 .LP
  38 If there are no more properties, this function returns \fBPICL_ENDOFLIST\fR.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  43 integer is returned to indicate an error.
  44 .sp
  45 .LP
  46 \fBPICL_ENDOFLIST\fR is returned to indicate that there are no more properties.
  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_NOTNODE\fR\fR
  80 .ad
  81 .RS 23n
  82 Not a node
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBPICL_NOTPROP\fR\fR
  89 .ad
  90 .RS 23n
  91 Not a property
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBPICL_INVALIDHANDLE\fR\fR
  98 .ad
  99 .RS 23n
 100 Invalid handle
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBPICL_STALEHANDLE\fR\fR
 107 .ad
 108 .RS 23n
 109 Stale handle
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBPICL_FAILURE\fR\fR
 116 .ad
 117 .RS 23n
 118 General system failure
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBPICL_ENDOFLIST\fR\fR
 125 .ad
 126 .RS 23n
 127 End of list
 128 .RE
 129
 130 .SH ATTRIBUTES
 131 .sp
 132 .LP
 133 See \fBattributes\fR(5) for descriptions of the following attributes:
 134 .sp
 135
 136 .sp
 137 .TS
 138 box;
 139 c | c
 140 l | l .
 141 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 142 _
 143 MT-Level        MT-Safe
 144 .TE
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBpicl_get_prop_by_name\fR(3PICL), \fBattributes\fR(5)