'\" te
.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
.TH ptree_get_prop_by_name 3PICLTREE "28 Mar 2000" "SunOS 5.11" "PICL Plug-In Library Functions"
.SH NAME
ptree_get_prop_by_name \- get a property handle by name
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ] \fIfile\fR... \fB-lpicltree\fR [ \fIlibrary\fR... ]
#include <picltree.h>

\fBint\fR \fBptree_get_prop_by_name\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR, \fBchar *\fR\fIname\fR,
     \fBpicl_prophdl_t *\fR\fIproph\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBptree_get_prop_by_name()\fR function gets the handle of the property, whose name is specified in \fIname\fR, of the node specified by the handle \fInodeh\fR.  The property handle is copied into the location specified by \fIproph\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_RESERVEDNAME\fR is returned if the name specified is a PICL reserved name property. Reserved name properties do not have an associated property handle. Use \fBptree_get_propval_by_name\fR(3PICLTREE) to get the value of a reserved property.
.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.
.SH ERRORS
.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_RESERVEDNAME\fR\fR
.ad
.RS 22n
.rt  
Property name is reserved
.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_STALEHANDLE\fR\fR
.ad
.RS 22n
.rt  
Stale handle
.RE

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

.sp
.ne 2
.mk
.na
\fB\fBPICL_FAILURE\fR\fR
.ad
.RS 22n
.rt  
General system failure
.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
\fBptree_get_first_prop\fR(3PICLTREE), \fBptree_get_propval_by_name\fR(3PICLTREE), \fBattributes\fR(5)