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