xref: /dflybsd-src/lib/libc/sys/modnext.2 (revision 86d7f5d305c6adaa56ff4582ece9859d73106103)
186d7f5d3SJohn Marino.\"
286d7f5d3SJohn Marino.\" Copyright (c) 1999 Chris Costello
386d7f5d3SJohn Marino.\" All rights reserved.
486d7f5d3SJohn Marino.\"
586d7f5d3SJohn Marino.\" Redistribution and use in source and binary forms, with or without
686d7f5d3SJohn Marino.\" modification, are permitted provided that the following conditions
786d7f5d3SJohn Marino.\" are met:
886d7f5d3SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
986d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
1086d7f5d3SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
1186d7f5d3SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
1286d7f5d3SJohn Marino.\"    documentation and/or other materials provided with the distribution.
1386d7f5d3SJohn Marino.\"
1486d7f5d3SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
1586d7f5d3SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1686d7f5d3SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1786d7f5d3SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
1886d7f5d3SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
1986d7f5d3SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2086d7f5d3SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2186d7f5d3SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2286d7f5d3SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2386d7f5d3SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
2486d7f5d3SJohn Marino.\" SUCH DAMAGE.
2586d7f5d3SJohn Marino.\"
2686d7f5d3SJohn Marino.\" $FreeBSD: src/lib/libc/sys/modnext.2,v 1.1.2.4 2001/12/14 18:34:01 ru Exp $
2786d7f5d3SJohn Marino.\" $DragonFly: src/lib/libc/sys/modnext.2,v 1.3 2007/02/25 18:35:05 swildner Exp $
2886d7f5d3SJohn Marino.\"
2986d7f5d3SJohn Marino.Dd September 28, 2000
3086d7f5d3SJohn Marino.Dt MODNEXT 2
3186d7f5d3SJohn Marino.Os
3286d7f5d3SJohn Marino.Sh NAME
3386d7f5d3SJohn Marino.Nm modnext ,
3486d7f5d3SJohn Marino.Nm modfnext
3586d7f5d3SJohn Marino.Nd return the modid of the next kernel module
3686d7f5d3SJohn Marino.Sh LIBRARY
3786d7f5d3SJohn Marino.Lb libc
3886d7f5d3SJohn Marino.Sh SYNOPSIS
3986d7f5d3SJohn Marino.In sys/param.h
4086d7f5d3SJohn Marino.In sys/module.h
4186d7f5d3SJohn Marino.Ft int
4286d7f5d3SJohn Marino.Fn modnext "int modid"
4386d7f5d3SJohn Marino.Ft int
4486d7f5d3SJohn Marino.Fn modfnext "int modid"
4586d7f5d3SJohn Marino.Sh DESCRIPTION
4686d7f5d3SJohn MarinoThe function
4786d7f5d3SJohn Marino.Fn modnext
4886d7f5d3SJohn Marinoreturns the modid of the next kernel module (that is, the one after
4986d7f5d3SJohn Marino.Va modid )
5086d7f5d3SJohn Marinoor 0 if
5186d7f5d3SJohn Marino.Va modid
5286d7f5d3SJohn Marinois the last module in the list.
5386d7f5d3SJohn Marino.Pp
5486d7f5d3SJohn MarinoIf the
5586d7f5d3SJohn Marino.Va modid
5686d7f5d3SJohn Marinovalue is 0, then
5786d7f5d3SJohn Marino.Fn modnext
5886d7f5d3SJohn Marinowill return the modid of the first module.
5986d7f5d3SJohn Marino.Fn modfnext
6086d7f5d3SJohn Marinomust always be given a valid modid.
6186d7f5d3SJohn Marino.Sh RETURN VALUES
6286d7f5d3SJohn Marino.Fn modnext
6386d7f5d3SJohn Marinoreturns the modid of the next module (see DESCRIPTION) or 0.  If an error
6486d7f5d3SJohn Marinooccurs,
6586d7f5d3SJohn Marino.Va errno
6686d7f5d3SJohn Marinois set to indicate the error.
6786d7f5d3SJohn Marino.Sh ERRORS
6886d7f5d3SJohn MarinoThe only error set by
6986d7f5d3SJohn Marino.Fn modnext
7086d7f5d3SJohn Marinois
7186d7f5d3SJohn Marino.Er ENOENT ,
7286d7f5d3SJohn Marinowhich is set when
7386d7f5d3SJohn Marino.Va modid
7486d7f5d3SJohn Marinorefers to a kernel module that does not exist (isn't loaded).
7586d7f5d3SJohn Marino.Sh SEE ALSO
7686d7f5d3SJohn Marino.Xr kldfind 2 ,
7786d7f5d3SJohn Marino.Xr kldfirstmod 2 ,
7886d7f5d3SJohn Marino.Xr kldload 2 ,
7986d7f5d3SJohn Marino.Xr kldnext 2 ,
8086d7f5d3SJohn Marino.Xr kldstat 2 ,
8186d7f5d3SJohn Marino.Xr kldsym 2 ,
8286d7f5d3SJohn Marino.Xr kldunload 2 ,
8386d7f5d3SJohn Marino.Xr modfind 2 ,
8486d7f5d3SJohn Marino.Xr modstat 2 ,
8586d7f5d3SJohn Marino.Xr kld 4 ,
8686d7f5d3SJohn Marino.Xr kldstat 8
8786d7f5d3SJohn Marino.Sh HISTORY
8886d7f5d3SJohn MarinoThe
8986d7f5d3SJohn Marino.Nm kld
9086d7f5d3SJohn Marinointerface first appeared in
9186d7f5d3SJohn Marino.Fx 3.0 .
92