xref: /freebsd/share/man/man9/VOP_VPTOFH.9 (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1996 Doug Rabson
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $Id: VFS_VPTOFH.9,v 1.4 1998/03/12 07:31:07 charnier Exp $
30.\"
31.Dd July 24, 1996
32.Os
33.Dt VFS_VPTOFH 9
34.Sh NAME
35.Nm VFS_VPTOFH
36.Nd turn a vnode into an NFS filehandle
37.Sh SYNOPSIS
38.Fd #include <sys/param.h>
39.Fd #include <sys/mount.h>
40.Fd #include <sys/vnode.h>
41.Ft int
42.Fn VFS_VPTOFH "struct vnode *vp" "struct fid *fhp"
43.Sh DESCRIPTION
44This is used by the NFS server to create an opaque filehandle which
45uniquely identifies the file and which can be used by an NFS client
46to access the file in the future.
47.Pp
48Its arguments are:
49.Bl -tag -width fhp
50.It Ar vp
51The vnode to make a filehandle for.
52.It Ar fhp
53Return parameter for the filehandle.
54.El
55.Sh SEE ALSO
56.Xr VFS 9 ,
57.Xr VFS_FHTOVP 9 ,
58.Xr vnode 9
59.Sh AUTHORS
60This man page was written by
61.An Doug Rabson .
62