'\" te
.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
.TH picl_get_first_prop 3PICL "28 Mar 2000" "SunOS 5.11" "PICL Library Functions"
.SH NAME
picl_get_first_prop, picl_get_next_prop \- get a property handle of a node
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ] 
#include <picl.h>

\fBint\fR \fBpicl_get_first_prop\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR,
     \fBpiclprop_hdl_t *\fR\fIproph\fR);
.fi

.LP
.nf
\fBint\fR \fBpicl_get_next_prop\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
     \fBpicl_prophdl_t *\fR\fInextprop\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBpicl_get_first_prop()\fR function gets the handle of the first property of the node specified by \fInodeh\fR and copies it into the location given by \fIproph\fR.
.sp
.LP
The \fBpicl_get_next_prop()\fR function gets the handle of the next property after the one specified by \fIproph\fR from the property list of the node, and copies it into the location specified by \fInextprop\fR.
.sp
.LP
If there are no more properties, this function returns \fBPICL_ENDOFLIST\fR.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fB0\fR is returned. On failure, a non-negative integer is returned to indicate an error.
.sp
.LP
\fBPICL_ENDOFLIST\fR is returned to indicate that there are no more properties.
.sp
.LP
\fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This occurs if the PICL tree was refreshed or reinitialized.
.sp
.LP
\fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.  This error may be returned for a previously valid handle if the daemon was brought down and restarted. When this occurs a client must revalidate any saved handles.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBPICL_NOTINITIALIZED\fR\fR
.ad
.RS 23n
.rt  
Session not initialized
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_NORESPONSE\fR\fR
.ad
.RS 23n
.rt  
Daemon not responding
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_NOTNODE\fR\fR
.ad
.RS 23n
.rt  
Not a node
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_NOTPROP\fR\fR
.ad
.RS 23n
.rt  
Not a property
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_INVALIDHANDLE\fR\fR
.ad
.RS 23n
.rt  
Invalid handle
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_STALEHANDLE\fR\fR
.ad
.RS 23n
.rt  
Stale handle
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_FAILURE\fR\fR
.ad
.RS 23n
.rt  
General system failure
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_ENDOFLIST\fR\fR
.ad
.RS 23n
.rt  
End of list
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBpicl_get_prop_by_name\fR(3PICL), \fBattributes\fR(5)