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