share/man/man3dlpi/dlpi_walk.3dlpi

   1 '\" te
   2 .\" Copyright (c) 2008, 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 DLPI_WALK 3DLPI "Sep 18, 2008"
   7 .SH NAME
   8 dlpi_walk \- traverse DLPI links
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... -\fBldlpi\fR [ \fIlibrary\fR... ]
  13 #include <libdlpi.h>
  14
  15 \fBvoid\fR \fBdlpi_walk\fR(\fBdlpi_walkfunc_t *\fR\fIfn\fR, \fBvoid *\fR\fIarg\fR, \fBuint_t\fR \fIflags\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBtypedef boolean_t\fR \fBdlpi_walkfunc_t\fR(\fBconst char *\fR\fIname\fR, \fBvoid *\fR\fIarg\fR);
  21 .fi
  22
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIfn\fR\fR
  28 .ad
  29 .RS 13n
  30 Function to invoke for each link.  Arguments are:
  31 .sp
  32 .ne 2
  33 .na
  34 \fB\fIname\fR\fR
  35 .ad
  36 .RS 8n
  37 The name of the DLPI interface.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fIarg\fR\fR
  44 .ad
  45 .RS 8n
  46 The \fIarg\fR parameter passed in to \fBdlpi_walk()\fR.
  47 .RE
  48
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fIarg\fR\fR
  55 .ad
  56 .RS 13n
  57 An opaque argument that is passed transparently to the user-supplied \fIfn\fR()
  58 function.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIflags\fR\fR
  65 .ad
  66 .RS 13n
  67 This parameter is reserved for future use. The caller should pass in 0.
  68 .RE
  69
  70 .SH DESCRIPTION
  71 .sp
  72 .LP
  73 The \fBdlpi_walk()\fR function visits all DLPI links on the system.  For each
  74 link visited, the user-supplied fn() function is invoked. The walk terminates
  75 either when all links have been visited or when \fIfn\fR() returns
  76 \fBB_TRUE\fR.
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5) for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 _
  90 Interface Stability     Committed
  91 _
  92 MT-Level        Safe
  93 .TE
  94
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBlibdlpi\fR(3LIB), \fBattributes\fR(5)