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