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