xref: /freebsd-12.1/lib/libc/sys/modnext.2 (revision 0227791b)
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 September 28, 2000
29.Dt MODNEXT 2
30.Os
31.Sh NAME
32.Nm modnext
33.Nd return the modid of the next kernel module
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/param.h
38.In sys/module.h
39.Ft int
40.Fn modnext "int modid"
41.Ft int
42.Fn modfnext "int modid"
43.Sh DESCRIPTION
44The
45.Fn modnext
46system call
47returns the modid of the next kernel module (that is, the one after
48.Va modid )
49or 0 if
50.Va modid
51is the last module in the list.
52.Pp
53If the
54.Va modid
55value is 0, then
56.Fn modnext
57will return the modid of the first module.
58The
59.Fn modfnext
60system call
61must always be given a valid modid.
62.Sh RETURN VALUES
63The
64.Fn modnext
65system call
66returns the modid of the next module (see
67.Sx DESCRIPTION )
68or 0.
69If an error
70occurs,
71.Va errno
72is set to indicate the error.
73.Sh ERRORS
74The only error set by
75.Fn modnext
76is
77.Er ENOENT ,
78which is set when
79.Va modid
80refers to a kernel module that does not exist (is not loaded).
81.Sh SEE ALSO
82.Xr kldfind 2 ,
83.Xr kldfirstmod 2 ,
84.Xr kldload 2 ,
85.Xr kldnext 2 ,
86.Xr kldstat 2 ,
87.Xr kldsym 2 ,
88.Xr kldunload 2 ,
89.Xr modfind 2 ,
90.Xr modstat 2 ,
91.Xr kld 4 ,
92.Xr kldstat 8
93.Sh HISTORY
94The
95.Nm kld
96interface first appeared in
97.Fx 3.0 .
98