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