lib/libc/sys/kldnext.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$
  27 .\"
  28 .Dd February 22, 2006
  29 .Dt KLDNEXT 2
  30 .Os
  31 .Sh NAME
  32 .Nm kldnext
  33 .Nd return the fileid of the next kld file
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/linker.h
  39 .Ft int
  40 .Fn kldnext "int fileid"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn kldnext
  44 system call
  45 returns the fileid of the next kld file (that is, the one after
  46 .Fa fileid )
  47 or 0 if
  48 .Fa fileid
  49 is the last file loaded.
  50 To get the fileid of the first kld file, pass
  51 .Fa fileid
  52 of 0 to
  53 .Fn kldnext .
  54 .Sh RETURN VALUES
  55 The
  56 .Fn kldnext
  57 system call
  58 returns the fileid of the next kld file or 0 if successful.
  59 Otherwise
  60 .Fn kldnext
  61 returns the value \-1 and sets the global variable
  62 .Va errno
  63 to indicate the error.
  64 .Sh ERRORS
  65 The only error set by
  66 .Fn kldnext
  67 is
  68 .Er ENOENT ,
  69 which is set when
  70 .Fa fileid
  71 refers to a kld file that does not exist (is not loaded).
  72 .Sh SEE ALSO
  73 .Xr kldfind 2 ,
  74 .Xr kldfirstmod 2 ,
  75 .Xr kldload 2 ,
  76 .Xr kldstat 2 ,
  77 .Xr kldsym 2 ,
  78 .Xr kldunload 2 ,
  79 .Xr modfind 2 ,
  80 .Xr modfnext 2 ,
  81 .Xr modnext 2 ,
  82 .Xr modstat 2 ,
  83 .Xr kld 4 ,
  84 .Xr kldstat 8
  85 .Sh HISTORY
  86 The
  87 .Nm kld
  88 interface first appeared in
  89 .Fx 3.0 .