freebsd-dev/lib/libc/sys/kldnext.2

90 lines
2.4 KiB
Groff
Raw Normal View History

.\"
.\" Copyright (c) 1999 Chris Costello
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
2001-07-15 07:53:42 +00:00
.\" $FreeBSD$
.\"
.Dd February 22, 2006
.Dt KLDNEXT 2
.Os
.Sh NAME
.Nm kldnext
2001-07-15 07:53:42 +00:00
.Nd return the fileid of the next kld file
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/param.h
.In sys/linker.h
.Ft int
.Fn kldnext "int fileid"
.Sh DESCRIPTION
The
.Fn kldnext
system call
returns the fileid of the next kld file (that is, the one after
2006-09-17 21:27:35 +00:00
.Fa fileid )
or 0 if
2006-09-17 21:27:35 +00:00
.Fa fileid
is the last file loaded.
To get the fileid of the first kld file, pass
2006-09-17 21:27:35 +00:00
.Fa fileid
of 0 to
.Fn kldnext .
.Sh RETURN VALUES
The
.Fn kldnext
system call
returns the fileid of the next kld file or 0 if successful.
Otherwise
.Fn kldnext
returns the value \-1 and sets the global variable
.Va errno
to indicate the error.
.Sh ERRORS
The only error set by
.Fn kldnext
is
.Er ENOENT ,
which is set when
2006-09-17 21:27:35 +00:00
.Fa fileid
2005-02-13 22:25:33 +00:00
refers to a kld file that does not exist (is not loaded).
.Sh SEE ALSO
.Xr kldfind 2 ,
.Xr kldfirstmod 2 ,
.Xr kldload 2 ,
.Xr kldstat 2 ,
.Xr kldsym 2 ,
.Xr kldunload 2 ,
.Xr modfind 2 ,
.Xr modfnext 2 ,
.Xr modnext 2 ,
.Xr modstat 2 ,
.Xr kld 4 ,
.Xr kldstat 8
.Sh HISTORY
The
.Nm kld
interface first appeared in
.Fx 3.0 .