Initial import from FreeBSD RELENG_4:
[dragonfly.git] / 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: src/lib/libc/sys/kldnext.2,v 1.5.2.6 2001/12/14 18:34:01 ru Exp $
27 .\"
28 .Dd March 3, 1999
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 function
43 .Fn kldnext
44 returns the fileid of the next kld file (that is, the one after
45 .Va fileid )
46 or 0 if
47 .Va fileid
48 is the last file loaded.
49 .Sh RETURN VALUES
50 .Fn kldnext
51 returns the fileid of the next kld file (see DESCRIPTION) or 0.  If an error
52 occurs,
53 .Va errno
54 is set to indicate the error.
55 .Sh ERRORS
56 The only error set by
57 .Fn kldnext
58 is
59 .Er ENOENT ,
60 which is set when
61 .Va fileid
62 refers to a kld file that does not exist (isn't loaded).
63 .Sh SEE ALSO
64 .Xr kldfind 2 ,
65 .Xr kldfirstmod 2 ,
66 .Xr kldload 2 ,
67 .Xr kldstat 2 ,
68 .Xr kldsym 2 ,
69 .Xr kldunload 2 ,
70 .Xr modfind 2 ,
71 .Xr modfnext 2 ,
72 .Xr modnext 2 ,
73 .Xr modstat 2 ,
74 .Xr kld 4 ,
75 .Xr kldstat 8
76 .Sh HISTORY
77 The
78 .Nm kld
79 interface first appeared in
80 .Fx 3.0 .