[apple/libc.git] / gen / FreeBSD / getmntinfo.3

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