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