'\" te
.\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
.TH picl_find_node 3PICL "5 Feb 2004" "SunOS 5.11" "PICL Library Functions"
.SH NAME
picl_find_node \- find node with given property and value
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-l\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <picl.h>

\fBint\fR \fBpicl_find_node\fR(\fBpicl_nodehdl_t\fR\fIrooth\fR, \fBchar *\fR\fIpname\fR,
     \fBpicl_prop_type_t\fR \fIptype\fR, \fBvoid *\fR\fIpval\fR, \fBsize_t\fR \fIvalsize\fR,
     \fBpicl_nodehdl_t *\fR\fIretnodeh\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBpicl_find_node()\fR function visits the nodes in the subtree under the node specified by \fIrooth\fR. The handle of the node that has the property whose name, type, and value matches the name, type, and value specified in \fIpname\fR, \fIptype\fR, and \fIpval\fR respectively, is returned in the location given by \fIretnodeh\fR. The \fIvalsize\fR argument specifies the size of the value in \fIpval\fR. The first \fIvalsize\fR number of bytes of the property value is compared with \fIpval\fR.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, 0 is returned. Otherwise a non-negative integer is returned to indicate an error.
.sp
.LP
The value \fBPICL_NODENOTFOUND\fR is returned if no node that matches the property criteria can be found.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBPICL_FAILURE\fR\fR
.ad
.RS 22n
.rt  
General system failure
.RE

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

.sp
.ne 2
.mk
.na
\fB\fBPICL_NODENOTFOUND\fR\fR
.ad
.RS 22n
.rt  
Node not found
.RE

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

.sp
.ne 2
.mk
.na
\fB\fBPICL_STALEHANDLE\fR\fR
.ad
.RS 22n
.rt  
Stale handle
.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
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
.TE

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