1.\" $NetBSD: getmntinfo.3,v 1.11 2002/02/07 07:00:13 ross 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. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)getmntinfo.3 8.1 (Berkeley) 6/9/93 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.Fd #include \*[Lt]sys/param.h\*[Gt] 46.Fd #include \*[Lt]sys/ucred.h\*[Gt] 47.Fd #include \*[Lt]sys/mount.h\*[Gt] 48.Ft int 49.Fn getmntinfo "struct statfs **mntbufp" "int flags" 50.Sh DESCRIPTION 51The 52.Fn getmntinfo 53function returns an array of 54.Em 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 63parameter 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 85.Va errno 86for any of the errors specified for the library routines 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