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