1.\" $OpenBSD: getmntinfo.3,v 1.14 2018/04/27 13:42:08 guenther Exp $ 2.\" 3.\" Copyright (c) 1989, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd $Mdocdate: April 27 2018 $ 31.Dt GETMNTINFO 3 32.Os 33.Sh NAME 34.Nm getmntinfo 35.Nd get information about mounted file systems 36.Sh SYNOPSIS 37.In sys/types.h 38.In sys/mount.h 39.Ft int 40.Fn getmntinfo "struct statfs **mntbufp" "int flags" 41.Sh DESCRIPTION 42The 43.Fn getmntinfo 44function returns an array of 45.Vt statfs 46structures describing each currently mounted file system (see 47.Xr statfs 2 ) . 48.Pp 49The 50.Fn getmntinfo 51function passes its 52.Fa flags 53parameter transparently to 54.Xr getfsstat 2 . 55.Sh RETURN VALUES 56On successful completion, 57.Fn getmntinfo 58returns a count of the number of elements in the array. 59The pointer to the array is stored into 60.Fa mntbufp . 61.Pp 62If an error occurs, zero is returned and the external variable 63.Va errno 64is set to indicate the error. 65Although the pointer 66.Fa mntbufp 67will be unmodified, any information previously returned by 68.Fn getmntinfo 69will be lost. 70.Sh ERRORS 71The 72.Fn getmntinfo 73function may fail and set 74.Va errno 75for any of the errors specified for the library routines 76.Xr getfsstat 2 77or 78.Xr malloc 3 . 79.Sh SEE ALSO 80.Xr getfsstat 2 , 81.Xr mount 2 , 82.Xr statfs 2 , 83.Xr mount 8 84.Sh HISTORY 85The 86.Fn getmntinfo 87function first appeared in 88.Bx 4.4 . 89.Sh BUGS 90The 91.Fn getmntinfo 92function writes the array of structures to an internal static object 93and returns a pointer to that object. 94Subsequent calls to 95.Fn getmntinfo 96will modify the same object. 97.Pp 98The memory allocated by 99.Fn getmntinfo 100cannot be 101.Xr free 3 Ns 'd 102by the application. 103