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