[apple/libc.git] / gen / getvfsbyname.3

.\" Copyright (c) 1995
.\"	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.
.\"
.\"     @(#)kvm_getvfsbyname.3	8.3 (Berkeley) 5/4/95
.\" $FreeBSD: src/lib/libc/gen/getvfsbyname.3,v 1.12 2001/10/01 16:08:51 ru Exp $
.\"
.Dd May 4, 1995
.Dt GETVFSBYNAME 3
.Os
.Sh NAME
.Nm getvfsbyname
.Nd get information about a filesystem
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/param.h
.In sys/mount.h
.Ft int
.Fn getvfsbyname "const char *name" "struct vfsconf *vfc"
.Sh DESCRIPTION
The
.Fn getvfsbyname
function provides access to information about a
filesystem module that is configured in the kernel.
If successful,
the requested filesystem
.Fa vfsconf
is returned in the location pointed to by
.Fa vfc .
The fields in a
.Dq Li struct vfsconf
are defined as follows:
.Pp
.Bl -tag -compact -width vfc_refcount
.It vfc_name
the name of the filesystem
.It vfc_typenum
the filesystem type number assigned by the kernel
.It vfc_refcount
the number of active mount points using the filesystem
.It vfc_flags
flag bits as described in
.Xr getvfsent 3
.El
.Sh RETURN VALUES
.Rv -std getvfsbyname
.Sh ERRORS
The following errors may be reported:
.Bl -tag -width Er
.It Bq Er EFAULT
The
.Fa vfc
pointer contains an invalid address.
.It Bq Er ENOENT
The
.Fa name
specifies a filesystem that is unknown or not configured in the kernel.
.El
.Sh SEE ALSO
.Xr mount 2 ,
.Xr getvfsent 3 ,
.Xr sysctl 3 ,
.Xr mount 8 ,
.Xr sysctl 8
.Sh HISTORY
A variant of the
.Fn getvfsbyname
function first appeared in
.Fx 2.0 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1995
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 A	32	.\" @(#)kvm_getvfsbyname.3 8.3 (Berkeley) 5/4/95
5b2abdfb A	33	.\" $FreeBSD: src/lib/libc/gen/getvfsbyname.3,v 1.12 2001/10/01 16:08:51 ru Exp $
e9ce8d39	34	.\"
5b2abdfb A	35	.Dd May 4, 1995
5b2abdfb A	36	.Dt GETVFSBYNAME 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
5b2abdfb A	39	.Nm getvfsbyname
5b2abdfb A	40	.Nd get information about a filesystem
e9ce8d39 A	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
5b2abdfb A	44	.In sys/param.h
5b2abdfb A	45	.In sys/mount.h
e9ce8d39	46	.Ft int
5b2abdfb	47	.Fn getvfsbyname "const char name" "struct vfsconf vfc"
e9ce8d39 A	48	.Sh DESCRIPTION
e9ce8d39 A	49	The
5b2abdfb A	50	.Fn getvfsbyname
	51	function provides access to information about a
	52	filesystem module that is configured in the kernel.
	53	If successful,
	54	the requested filesystem
	55	.Fa vfsconf
	56	is returned in the location pointed to by
	57	.Fa vfc .
	58	The fields in a
	59	.Dq Li struct vfsconf
	60	are defined as follows:
	61	.Pp
	62	.Bl -tag -compact -width vfc_refcount
	63	.It vfc_name
	64	the name of the filesystem
	65	.It vfc_typenum
	66	the filesystem type number assigned by the kernel
	67	.It vfc_refcount
	68	the number of active mount points using the filesystem
	69	.It vfc_flags
	70	flag bits as described in
	71	.Xr getvfsent 3
	72	.El
e9ce8d39	73	.Sh RETURN VALUES
5b2abdfb	74	.Rv -std getvfsbyname
e9ce8d39	75	.Sh ERRORS
5b2abdfb	76	The following errors may be reported:
e9ce8d39	77	.Bl -tag -width Er
5b2abdfb A	78	.It Bq Er EFAULT
	79	The
	80	.Fa vfc
	81	pointer contains an invalid address.
	82	.It Bq Er ENOENT
	83	The
	84	.Fa name
	85	specifies a filesystem that is unknown or not configured in the kernel.
	86	.El
e9ce8d39	87	.Sh SEE ALSO
5b2abdfb A	88	.Xr mount 2 ,
	89	.Xr getvfsent 3 ,
	90	.Xr sysctl 3 ,
	91	.Xr mount 8 ,
	92	.Xr sysctl 8
e9ce8d39	93	.Sh HISTORY
5b2abdfb A	94	A variant of the
5b2abdfb A	95	.Fn getvfsbyname
e9ce8d39	96	function first appeared in
5b2abdfb	97	.Fx 2.0 .