xref: /titanic_50/usr/src/man/man3picltree/ptree_get_first_prop.3picltree (revision c10c16dec587a0662068f6e2991c29ed3a9db943) 
 te
 Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
 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.
 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.
 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]
 ptree_get_first_prop 3PICLTREE "28 Mar 2000" "SunOS 5.11" "PICL Plug-In Library Functions"
 NAME
ptree_get_first_prop, ptree_get_next_prop - get a property handle of the node

 SYNOPSIS


cc [ flag... ] file... -lpicltree [ library... ] 
#include <picltree.h>

int ptree_get_first_prop(picl_nodehdl_t nodeh,
 picl_prophdl_t *proph);






int ptree_get_next_prop(picl_prophdl_t proph,
 picl_prophdl_t *nextproph);




 DESCRIPTION

The ptree_get_first_prop() function gets the handle of the first property
of the node specified by nodeh and copies it into the location specified
by proph.


The ptree_get_next_prop() function gets the handle of the next property
after the one specified by proph from the list of properties of the node
and copies it into the location specified by nextproph.

 RETURN VALUES

Upon successful completion, 0 is returned. On failure, a non-negative
integer is returned to indicate an error.


PICL_STALEHANDLE is returned if the handle is no longer valid. This
occurs if the PICL tree was refreshed or reinitialized.


PICL_INVALIDHANDLE is returned if the specified handle never existed.

 ERRORS

PICL_NOTPROP


Not a property





PICL_NOTNODE


Not a node





PICL_ENDOFLIST


End of list





PICL_INVALIDHANDLE


Invalid handle





PICL_STALEHANDLE


Stale handle





PICL_FAILURE


General system failure




 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe



 SEE ALSO

ptree_get_prop_by_name(3PICLTREE), attributes(5)