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