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. Neither the name of the University nor the names of its contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)getmntinfo.3 8.1 (Berkeley) 6/9/93 29.\" $FreeBSD$ 30.\" 31.Dd December 27, 2016 32.Dt GETMNTINFO 3 33.Os 34.Sh NAME 35.Nm getmntinfo 36.Nd get information about mounted file systems 37.Sh LIBRARY 38.Lb libc 39.Sh SYNOPSIS 40.In sys/param.h 41.In sys/ucred.h 42.In sys/mount.h 43.Ft int 44.Fn getmntinfo "struct statfs **mntbufp" "int mode" 45.Sh DESCRIPTION 46The 47.Fn getmntinfo 48function 49returns an array of 50.Fn statfs 51structures describing each currently mounted file system (see 52.Xr statfs 2 ) . 53.Pp 54The 55.Fn getmntinfo 56function 57passes its 58.Fa mode 59argument 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 mount 2 , 88.Xr statfs 2 , 89.Xr mount 8 90.Sh HISTORY 91The 92.Fn getmntinfo 93function first appeared in 94.Bx 4.4 . 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. 101Subsequent 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