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]
picl_walk_tree_by_class - walk subtree by class

cc [ flag... ] file... -lpicl [ library... ]
#include <picl.h>

int picl_walk_tree_by_class(picl_nodehdl_t rooth,
 const char *classname, void *c_args,
 int (*callback)(picl_nodehdl_t nodeh, void *c_args));

The picl_walk_tree_by_class() function visits all the nodes of the subtree under the node specified by rooth. The PICL class name of the visited node is compared with the class name specified by classname. If the class names match, then the callback function specified by callback is called with the matching node handle and the argument provided in c_args. If the class name specified in classname is NULL, then the callback function is invoked for all the nodes.

The return value from the callback function is used to determine whether to continue or terminate the tree walk. The callback function returns PICL_WALK_CONTINUE or PICL_WALK_TERMINATE to continue or terminate the tree walk.

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. 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.

PICL_NOTINITIALIZED PICL_NORESPONSE PICL_NOTNODE PICL_INVALIDHANDLE PICL_STALEHANDLE PICL_FAILURE

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

MT-Level MT-Safe

picl_get_propval_by_name(3PICL), attributes(5)