xref: /illumos-gate/usr/src/man/man3c/fdetach.3c (revision 45ede40b2394db7967e59f19288fae9b62efd4aa)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.

FDETACH 3C "Jul 24, 2002"
NAME
fdetach - detach a name from a STREAMS-based file descriptor
SYNOPSIS

#include <stropts.h>

int fdetach(const char *path);
DESCRIPTION

The fdetach() function detaches a STREAMS-based file from the file to which it was attached by a previous call to fattach(3C). The path argument points to the pathname of the attached STREAMS file. The process must have appropriate privileges or be the owner of the file. A successful call to fdetach() causes all pathnames that named the attached STREAMS file to again name the file to which the STREAMS file was attached. All subsequent operations on path will operate on the underlying file and not on the STREAMS file.

All open file descriptions established while the STREAMS file was attached to the file referenced by path, will still refer to the STREAMS file after the fdetach() has taken effect.

If there are no open file descriptors or other references to the STREAMS file, then a successful call to fdetach() has the same effect as performing the last close(2) on the attached file.

RETURN VALUES

Upon successful completion, fdetach() returns 0. Otherwise, it returns -1 and sets errno to indicate the error.

ERRORS

The fdetach() function will fail if: EACCES

Search permission is denied on a component of the path prefix.

EPERM

The effective user ID is not the owner of path and the process does not have appropriate privileges.

ENOTDIR

A component of the path prefix is not a directory.

ENOENT

A component of path does not name an existing file or path is an empty string.

EINVAL

The path argument names a file that is not currently attached.

ENAMETOOLONG

The size of a pathname exceeds PATH_MAX, or a pathname component is longer than NAME_MAX while _POSIX_NO_TRUNC is in effect.

ELOOP

Too many symbolic links were encountered in resolving path.

The fdetach() function may fail if: ENAMETOOLONG

Pathname resolution of a symbolic link produced an intermediate result whose length exceeds PATH_MAX.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
SEE ALSO

fdetach(1M), close(2), fattach(3C), attributes(5), standards(5), streamio(7I)

STREAMS Programming Guide