lib/libcr/sys/modnext.2

   1 .\"
   2 .\" Copyright (c) 1999 Chris Costello
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/libc/sys/modnext.2,v 1.1.2.4 2001/12/14 18:34:01 ru Exp $
  27 .\" $DragonFly: src/lib/libcr/sys/Attic/modnext.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  28 .\"
  29 .Dd September 28, 2000
  30 .Dt MODNEXT 2
  31 .Os
  32 .Sh NAME
  33 .Nm modnext
  34 .Nd return the modid of the next kernel module
  35 .Sh LIBRARY
  36 .Lb libc
  37 .Sh SYNOPSIS
  38 .In sys/param.h
  39 .In sys/module.h
  40 .Ft int
  41 .Fn modnext "int modid"
  42 .Ft int
  43 .Fn modfnext "int modid"
  44 .Sh DESCRIPTION
  45 The function
  46 .Fn modnext
  47 returns the modid of the next kernel module (that is, the one after
  48 .Va modid )
  49 or 0 if
  50 .Va modid
  51 is the last module in the list.
  52 .Pp
  53 If the
  54 .Va modid
  55 value is 0, then
  56 .Fn modnext
  57 will return the modid of the first module.
  58 .Fn modfnext
  59 must always be given a valid modid.
  60 .Sh RETURN VALUES
  61 .Fn modnext
  62 returns the modid of the next module (see DESCRIPTION) or 0.  If an error
  63 occurs,
  64 .Va errno
  65 is set to indicate the error.
  66 .Sh ERRORS
  67 The only error set by
  68 .Fn modnext
  69 is
  70 .Er ENOENT ,
  71 which is set when
  72 .Va modid
  73 refers to a kernel module that does not exist (isn't loaded).
  74 .Sh SEE ALSO
  75 .Xr kldfind 2 ,
  76 .Xr kldfirstmod 2 ,
  77 .Xr kldload 2 ,
  78 .Xr kldnext 2 ,
  79 .Xr kldstat 2 ,
  80 .Xr kldsym 2 ,
  81 .Xr kldunload 2 ,
  82 .Xr modfind 2 ,
  83 .Xr modstat 2 ,
  84 .Xr kld 4 ,
  85 .Xr kldstat 8
  86 .Sh HISTORY
  87 The
  88 .Nm kld
  89 interface first appeared in
  90 .Fx 3.0 .