xref: /titanic_52/usr/src/man/man3devinfo/di_walk_lnode.3devinfo (revision c10c16dec587a0662068f6e2991c29ed3a9db943) 
 te
 Copyright (c) 2004, 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_lnode 3DEVINFO "22 Mar 2004" "SunOS 5.11" "Device Information Library Functions"
 NAME
di_walk_lnode - traverse libdevinfo lnodes

 SYNOPSIS


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

int di_walk_lnode(di_node_t root, uint_t flag, void *arg,
 int (*lnode_callback)(di_lnode_t link, void *arg));




 PARAMETERS

root


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





flag


Specify 0. Reserved for future use.





arg


A pointer to caller-specific data.





lnode_callback


The caller-supplied callback function.




 DESCRIPTION

The di_walk_lnode() function visits all nodes in the subtree rooted at
root. For each node found, the caller-supplied function
lnode_callback() is invoked for each lnode associated with that node.
The return value of lnode_callback() specifies subsequent walking
behavior where that node is the specified endpoint of the link.

 RETURN VALUES

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


The callback function lnode_callback() can return one of the following:


DI_WALK_CONTINUE


Continue walking.





DI_WALK_TERMINATE


Terminate the walk immediately.




 ERRORS

The di_walk_lnode() function will fail if:


EINVAL


An argument is invalid.




 ATTRIBUTES

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







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelSafe



 SEE ALSO

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