1.\" Copyright (c) 1989, 1991, 1993 2.\" The Regents of the University of California. 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 8.1 (Berkeley) 6/9/93 33.\" $FreeBSD$ 34.\" 35.Dd June 9, 1993 36.Dt GETMNTINFO 3 37.Os 38.Sh NAME 39.Nm getmntinfo 40.Nd get information about mounted file systems 41.Sh SYNOPSIS 42.Fd #include <sys/param.h> 43.Fd #include <sys/ucred.h> 44.Fd #include <sys/mount.h> 45.Ft int 46.Fn getmntinfo "struct statfs **mntbufp" "int flags" 47.Sh DESCRIPTION 48The 49.Fn getmntinfo 50function 51returns an array of 52.Fn statfs 53structures describing each currently mounted file system (see 54.Xr statfs 2 ) . 55.Pp 56The 57.Fn getmntinfo 58function 59passes its 60.Fa flags 61parameter transparently to 62.Xr getfsstat 2 . 63.Sh RETURN VALUES 64On successful completion, 65.Fn getmntinfo 66returns a count of the number of elements in the array. 67The pointer to the array is stored into 68.Fa mntbufp . 69.Pp 70If an error occurs, zero is returned and the external variable 71.Va errno 72is set to indicate the error. 73Although the pointer 74.Fa mntbufp 75will be unmodified, any information previously returned by 76.Fn getmntinfo 77will be lost. 78.Sh ERRORS 79The 80.Fn getmntinfo 81function 82may fail and set errno for any of the errors specified for the library 83routines 84.Xr getfsstat 2 85or 86.Xr malloc 3 . 87.Sh SEE ALSO 88.Xr getfsstat 2 , 89.Xr mount 2 , 90.Xr statfs 2 , 91.Xr mount 8 92.Sh HISTORY 93The 94.Fn getmntinfo 95function first appeared in 96.Bx 4.4 . 97.Sh BUGS 98The 99.Fn getmntinfo 100function writes the array of structures to an internal static object 101and returns 102a pointer to that object. 103Subsequent calls to 104.Fn getmntinfo 105will modify the same object. 106.Pp 107The memory allocated by 108.Fn getmntinfo 109cannot be 110.Xr free 3 Ns 'd 111by the application. 112