xref: /titanic_41/usr/src/man/man3devinfo/di_walk_node.3devinfo (revision 1e4c938b57d1656808e4112127ff1dce3eba5314) 
 te
 Copyright (c) 2009, 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]
 di_walk_node 3DEVINFO "16 Jan 2009" "SunOS 5.11" "Device Information Library Functions"
 NAME
di_walk_node - traverse libdevinfo device nodes

 SYNOPSIS


cc [ flag... ] file... -ldevinfo [ library... ]
#include <libdevinfo.h>

int di_walk_node(di_node_t root, uint_t flag, void *arg,
 int (*node_callback)(di_node_t node, void *arg));




 DESCRIPTION

The di_walk_node() function visits all nodes in the subtree rooted at
root. For each node found, the caller-supplied function
node_callback() is invoked. The return value of node_callback()
specifies subsequent walking behavior.

 PARAMETERS

arg


Pointer to caller-specific data.





flag


Specifies walking order, either DI_WALK_CLDFIRST (depth first) or
DI_WALK_SIBFIRST (breadth first). DI_WALK_CLDFIRST is the default.





node


The node being visited.





root


The handle to the root node of the subtree to visit.




 RETURN VALUES

Upon successful completion, di_walk_node() returns 0. Otherwise, -1
is returned and errno is set to indicate the error.


The node_callback() function can return one of the following:


DI_WALK_CONTINUE


Continue walking.





DI_WALK_PRUNESIB


Continue walking, but skip siblings and their child nodes.





DI_WALK_PRUNECHILD


Continue walking, but skip subtree rooted at current node.





DI_WALK_TERMINATE


Terminate the walk immediately.




 ERRORS

The di_walk_node() function will fail if:


EINVAL


Invalid argument.




 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityCommitted
MT-LevelSafe



 SEE ALSO

di_init(3DEVINFO), libdevinfo(3LIB), attributes(5)


Writing Device Drivers