share/man/man3devinfo/di_walk_link.3devinfo

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH DI_WALK_LINK 3DEVINFO "Mar 22, 2004"
   7 .SH NAME
   8 di_walk_link \- traverse libdevinfo links
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldevinfo\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <libdevinfo.h>
  14
  15 \fBint\fR \fBdi_walk_link\fR(\fBdi_node_t\fR \fIroot\fR, \fBuint_t\fR \fIflag\fR, \fBuint_t\fR \fIendpoint\fR, \fBvoid *\fR\fIarg\fR,
  16      \fBint (*\fR\fIlink_callback\fR)(di_link_t \fIlink\fR, void *\fIarg\fR));
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIroot\fR\fR
  24 .ad
  25 .RS 17n
  26 The handle to the root node of the subtree to visit.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIflag\fR\fR
  33 .ad
  34 .RS 17n
  35 Specify 0. Reserved for future use.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIendpoint\fR\fR
  42 .ad
  43 .RS 17n
  44 Specify if the current node being visited should be the target or source of an
  45 link, either \fBDI_LINK_TGT\fR or \fBDI_LINK_SRC\fR
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIarg\fR\fR
  52 .ad
  53 .RS 17n
  54 A pointer to caller-specific data.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIlink_callback\fR\fR
  61 .ad
  62 .RS 17n
  63 The caller-supplied callback function.
  64 .RE
  65
  66 .SH DESCRIPTION
  67 .sp
  68 .LP
  69 The \fBdi_walk_link()\fR function visits all nodes in the subtree rooted at
  70 \fIroot\fR.  For each node found, the caller-supplied function
  71 \fIlink_callback\fR() is invoked for each link associated with that node where
  72 that node is the specified \fIendpoint\fR of the link.  The return value of
  73 \fIlink_callback\fR() specifies subsequent walking behavior. See RETURN VALUES.
  74 .SH RETURN VALUES
  75 .sp
  76 .LP
  77 Upon successful completion, \fBdi_walk_link()\fR returns 0.  Otherwise, -1 is
  78 returned and \fBerrno\fR is set to indicate the error.
  79 .sp
  80 .LP
  81 The callback function, \fIlink_callback\fR(), can return one of the following:
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBDI_WALK_CONTINUE\fR\fR
  86 .ad
  87 .RS 21n
  88 Continue walking.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBDI_WALK_TERMINATE\fR\fR
  95 .ad
  96 .RS 21n
  97 Terminate the walk immediately.
  98 .RE
  99
 100 .SH ERRORS
 101 .sp
 102 .LP
 103 The \fBdi_walk_link()\fR function will fail if:
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBEINVAL\fR\fR
 108 .ad
 109 .RS 10n
 110 An argument is invalid.
 111 .RE
 112
 113 .SH ATTRIBUTES
 114 .sp
 115 .LP
 116 See \fBattributes\fR(5) for descriptions of the following attributes:
 117 .sp
 118
 119 .sp
 120 .TS
 121 box;
 122 c | c
 123 l | l .
 124 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 125 _
 126 Interface Stability     Evolving
 127 _
 128 MT-Level        Safe
 129 .TE
 130
 131 .SH SEE ALSO
 132 .sp
 133 .LP
 134 \fBdi_init\fR(3DEVINFO), \fBlibdevinfo\fR(3LIB), \fBattributes\fR(5)