xref: /freebsd/lib/libsys/kldfirstmod.2 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
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 March 3, 1999
27.Dt KLDFIRSTMOD 2
28.Os
29.Sh NAME
30.Nm kldfirstmod
31.Nd "return first module id from the kld file specified"
32.Sh LIBRARY
33.Lb libc
34.Sh SYNOPSIS
35.In sys/param.h
36.In sys/linker.h
37.Ft int
38.Fn kldfirstmod "int fileid"
39.Sh DESCRIPTION
40The
41.Fn kldfirstmod
42system call returns the module id pertaining to the first module referenced by
43.Fa fileid .
44.Sh RETURN VALUES
45The
46.Fn kldfirstmod
47will return the id of the first module referenced by
48.Fa fileid
49or 0 if there are no references.
50.Sh ERRORS
51.Bl -tag -width Er
52.It Bq Er ENOENT
53The kld file referenced by
54.Fa fileid
55was not found.
56.El
57.Sh SEE ALSO
58.Xr kldfind 2 ,
59.Xr kldload 2 ,
60.Xr kldnext 2 ,
61.Xr kldstat 2 ,
62.Xr kldsym 2 ,
63.Xr kldunload 2 ,
64.Xr modfind 2 ,
65.Xr modfnext 2 ,
66.Xr modnext 2 ,
67.Xr modstat 2 ,
68.Xr kld 4 ,
69.Xr kldstat 8
70.Sh HISTORY
71The
72.Nm kld
73interface first appeared in
74.Fx 3.0 .
75