share/man/man3devinfo/di_lnode_next.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_LNODE_NEXT 3DEVINFO "Mar 22, 2004"
   7 .SH NAME
   8 di_lnode_next \- libdevinfo lnode traversal function
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldevinfo\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <libdevinfo.h>
  14
  15 \fBdi_lnode_t\fR \fBdi_lnode_next\fR(\fBdi_node_t\fR \fInode\fR, \fBdi_lnode_t\fR \fIlnode\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fInode\fR\fR
  23 .ad
  24 .RS 9n
  25 A handle to a di_node.
  26 .RE
  27
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fIlnode\fR\fR
  32 .ad
  33 .RS 9n
  34 A handle to an lnode.
  35 .RE
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBdi_lnode_next()\fR function returns a handle to the next lnode for the
  41 device node specified by \fInode\fR. If \fIlnode\fR is \fBDI_LNODE_NIL\fR, a
  42 handle to the first lnode is returned.
  43 .SH RETURN VALUES
  44 .sp
  45 .LP
  46 Upon successful completion, a  handle to an lnode is returned. Otherwise,
  47 \fBDI_LNODE_NIL\fR is returned and \fBerrno\fR is set to indicate the error.
  48 .SH ERRORS
  49 .sp
  50 .LP
  51 The \fBdi_lnode_next()\fR function will fail if:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBEINVAL\fR\fR
  56 .ad
  57 .RS 11n
  58 An argument is invalid.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBENOTSUP\fR\fR
  65 .ad
  66 .RS 11n
  67 Device usage information is not available in snapshot.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBENXIO\fR\fR
  74 .ad
  75 .RS 11n
  76 The end of the lnode list has been reached.
  77 .RE
  78
  79 .SH ATTRIBUTES
  80 .sp
  81 .LP
  82 See \fBattributes\fR(5) for descriptions of the following attributes:
  83 .sp
  84
  85 .sp
  86 .TS
  87 box;
  88 c | c
  89 l | l .
  90 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  91 _
  92 Interface Stability     Evolving
  93 _
  94 MT-Level        Safe
  95 .TE
  96
  97 .SH SEE ALSO
  98 .sp
  99 .LP
 100 \fBdi_init\fR(3DEVINFO), \fBlibdevinfo\fR(3LIB), \fBattributes\fR(5)