386BSD 0.1 development
[unix-history] / usr / src / lib / libc / gen / getmntinfo.3
CommitLineData
8168e750
WJ
1.\" Copyright (c) 1989, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" @(#)getmntinfo.3 6.5 (Berkeley) 4/19/91
33.\"
34.Dd April 19, 1991
35.Dt GETMNTINFO 3
36.Os
37.Sh NAME
38.Nm getmntinfo
39.Nd get information about mounted file systems
40.Sh SYNOPSIS
41.Fd #include <sys/types.h>
42.Fd #include <sys/mount.h>
43.Ft int
44.Fn getmntinfo "int mntbufp" "int flags"
45.Sh DESCRIPTION
46The
47.Fn getmntinfo
48function
49returns an array of
50.Xr statfs
51structures describing each currently mounted file system (see
52.Xr statfs 2 ) .
53.Pp
54The
55.Fn getmntinfo
56function
57passes its
58.Fa flags
59parameter transparently to
60.Xr getfsstat 2 .
61.Sh RETURN VALUES
62On successful completion,
63.Fn getmntinfo
64returns a count of the number of elements in the array.
65The pointer to the array is stored into
66.Fa mntbufp .
67.Pp
68If an error occurs, zero is returned and the external variable
69.Va errno
70is set to indicate the error.
71Although the pointer
72.Fa mntbufp
73will be unmodified, any information previously returned by
74.Fn getmntinfo
75will be lost.
76.Sh ERRORS
77The
78.Fn getmntinfo
79function
80may fail and set errno for any of the errors specified for the library
81routines
82.Xr getfsstat 2
83or
84.Xr malloc 3 .
85.Sh SEE ALSO
86.Xr getfsstat 2 ,
87.Xr statfs 2 ,
88.Xr mount 2 ,
89.Xr mount 8
90.Sh HISTORY
91The
92.Fn getmntinfo
93function is
94.Ud .
95.Sh BUGS
96The
97.Fn getmntinfo
98function writes the array of structures to an internal static object
99and returns
100a pointer to that object. Subsequent calls to
101.Fn getmntinfo
102will modify the same object.
103.Pp
104The memory allocated by
105.Fn getmntinfo
106cannot be
107.Xr free 2 Ns 'd
108by the application.