<<< Previous | Home | Next >>>

The Open Group Base Specifications Issue 7
IEEE Std 1003.1-2008
Copyright © 2001-2008 The IEEE and The Open Group

#### NAME

> fdetach - detach a name from a STREAMS-based file descriptor (STREAMS)

#### SYNOPSIS

> ``[OB XSR] #include <stropts.h>
> int fdetach(const char *`path`);``
> `
> `

#### DESCRIPTION

> The fdetach() function shall detach a STREAMS-based file from the file to which it was attached by a previous call to fattach(). The path argument points to the pathname of the attached STREAMS file. The process shall have appropriate privileges or be the owner of the file. A successful call to fdetach() shall cause 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 shall 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 shall 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() shall be equivalent to performing the last close() on the attached file.

#### RETURN VALUE

> Upon successful completion, fdetach() shall return 0; otherwise, it shall return -1 and set errno to indicate the error.

#### ERRORS

> The fdetach() function shall fail if:

> [EACCES]
>   Search permission is denied on a component of the path prefix.
> [EINVAL]
>   The path argument names a file that is not currently attached.
> [ELOOP]
>   A loop exists in symbolic links encountered during resolution of the path argument.
> [ENAMETOOLONG]
>   The length of a component of a pathname is longer than {NAME_MAX}.
> [ENOENT]
>   A component of path does not name an existing file or path is an empty string.
> [ENOTDIR]
>   A component of the path prefix is not a directory, or the path argument contains at least one non- <slash> character and ends with one or more trailing <slash> characters and the last pathname component names an existing file that is neither a directory nor a symbolic link to a directory.
> [EPERM]
>   The effective user ID is not the owner of path and the process does not have appropriate privileges.

> The fdetach() function may fail if:

> [ELOOP]
>   More than {SYMLOOP_MAX} symbolic links were encountered during resolution of the path argument.
> [ENAMETOOLONG]
>   The length of a pathname exceeds {PATH_MAX}, or pathname resolution of a symbolic link produced an intermediate result with a length that exceeds {PATH_MAX}.

The following sections are informative.

#### EXAMPLES

> ##### Detaching a File

> The following example detaches the STREAMS-based file /tmp/named-STREAM from the file to which it was attached by a previous, successful call to fattach(). Subsequent calls to open this file refer to the underlying file, not to the STREAMS file.

>     #include <stropts.h>
>     ...
>         char *filename = "/tmp/named-STREAM";
>         int ret;

>         ret = fdetach(filename);

#### APPLICATION USAGE

> None.

#### RATIONALE

> None.

#### FUTURE DIRECTIONS

> The fdetach() function may be removed in a future version.

#### SEE ALSO

> fattach

> XBD <stropts.h>

#### CHANGE HISTORY

> First released in Issue 4, Version 2.

#### Issue 5

> Moved from X/OPEN UNIX extension to BASE.

#### Issue 6

> The normative text is updated to avoid use of the term "must" for application requirements.

> The wording of the mandatory [ELOOP] error condition is updated, and a second optional [ELOOP] error condition is added.

#### Issue 7

> Austin Group Interpretation 1003.1-2001 #143 is applied.

> The fdetach() function is marked obsolescent.

> The [ENOTDIR] error condition is clarified to cover the condition where the last component of a pathname exists but is not a directory or a symbolic link to a directory.

End of informative text.

return to top of page

UNIX ® is a registered Trademark of The Open Group.
POSIX ® is a registered Trademark of The IEEE.
Copyright © 2001-2008 The IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]

<<< Previous | Home | Next >>>