[apple/xnu.git] / bsd / man / man2 / getfh.2

.\"	$NetBSD: getfh.2,v 1.7 1995/10/12 15:40:53 jtc Exp $
.\"
.\" 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.
.\"
.\"	@(#)getfh.2	8.1 (Berkeley) 6/9/93
.\"
.Dd June 9, 1993
.Dt GETFH 2
.Os
.Sh NAME
.Nm getfh
.Nd get file handle
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/mount.h>
.Ft int
.Fn getfh "const char *path" "fhandle_t *fhp"
.Sh DESCRIPTION
.Fn Getfh
returns a file handle for the specified file or directory
in the file handle pointed to by
.Fa fhp .
This system call is restricted to the superuser.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, -1 is returned and the global variable
.Va errno
is set to indicate the error.
.Sh ERRORS
.Fn Getfh
fails if one or more of the following are true:
.Bl -tag -width Er
.It Bq ENOTDIR
A component of the path prefix of
.Fa path
is not a directory.
.It Bq ENAMETOOLONG
The length of a component of
.Fa path
exceeds 
.Dv {NAME_MAX}
characters, or the length of
.Fa path
exceeds 
.Dv {PATH_MAX} 
characters.
.It Bq ENOENT
The file referred to by
.Fa path
does not exist.
.It Bq EACCES
Search permission is denied for a component of the path prefix of
.Fa path .
.It Bq ELOOP
Too many symbolic links were encountered in translating
.Fa path .
.It Bq EFAULT
.Fa Fhp
points to an invalid address.
.It Bq EIO
An
.Tn I/O
error occurred while reading from or writing to the file system.
.El
.Sh HISTORY
The
.Fn getfh
function
first appeared in 4.4BSD.
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: getfh.2,v 1.7 1995/10/12 15:40:53 jtc Exp $
	2	.\"
	3	.\" Copyright (c) 1989, 1991, 1993
	4	.\" The Regents of the University of California. All rights reserved.
	5	.\"
	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
	14	.\" 3. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
	34	.\" @(#)getfh.2 8.1 (Berkeley) 6/9/93
	35	.\"
	36	.Dd June 9, 1993
	37	.Dt GETFH 2
	38	.Os
	39	.Sh NAME
	40	.Nm getfh
	41	.Nd get file handle
	42	.Sh SYNOPSIS
	43	.Fd #include <sys/types.h>
	44	.Fd #include <sys/mount.h>
	45	.Ft int
	46	.Fn getfh "const char path" "fhandle_t fhp"
	47	.Sh DESCRIPTION
	48	.Fn Getfh
	49	returns a file handle for the specified file or directory
	50	in the file handle pointed to by
	51	.Fa fhp .
	52	This system call is restricted to the superuser.
	53	.Sh RETURN VALUES
	54	Upon successful completion, a value of 0 is returned.
	55	Otherwise, -1 is returned and the global variable
	56	.Va errno
	57	is set to indicate the error.
	58	.Sh ERRORS
	59	.Fn Getfh
	60	fails if one or more of the following are true:
	61	.Bl -tag -width Er
	62	.It Bq ENOTDIR
	63	A component of the path prefix of
	64	.Fa path
65	is not a directory.
66	.It Bq ENAMETOOLONG
67	The length of a component of
68	.Fa path
69	exceeds
70	.Dv {NAME_MAX}
71	characters, or the length of
72	.Fa path
73	exceeds
74	.Dv {PATH_MAX}
75	characters.
76	.It Bq ENOENT
77	The file referred to by
78	.Fa path
79	does not exist.
80	.It Bq EACCES
81	Search permission is denied for a component of the path prefix of
82	.Fa path .
83	.It Bq ELOOP
84	Too many symbolic links were encountered in translating
85	.Fa path .
86	.It Bq EFAULT
87	.Fa Fhp
88	points to an invalid address.
89	.It Bq EIO
90	An
91	.Tn I/O
92	error occurred while reading from or writing to the file system.
93	.El
94	.Sh HISTORY
95	The
96	.Fn getfh
97	function
98	first appeared in 4.4BSD.