share/man/man3c/fdetach.3c

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" 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
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" 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 Sun OS 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.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH FDETACH 3C "Jul 24, 2002"
  11 .SH NAME
  12 fdetach \- detach a name from a STREAMS-based file descriptor
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stropts.h>
  17
  18 \fBint\fR \fBfdetach\fR(\fBconst char *\fR\fIpath\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBfdetach()\fR function detaches a STREAMS-based file from the file to
  25 which it was attached by a previous call to \fBfattach\fR(3C). The \fIpath\fR
  26 argument points to the pathname of the attached \fBSTREAMS\fR file. The process
  27 must have appropriate privileges or be the owner of the file. A successful call
  28 to \fBfdetach()\fR causes all pathnames that named the attached \fBSTREAMS\fR
  29 file to again name the file to which the \fBSTREAMS\fR file was attached.  All
  30 subsequent operations on \fIpath\fR will operate on the underlying file and not
  31 on the \fBSTREAMS\fR file.
  32 .sp
  33 .LP
  34 All open file descriptions established while the \fBSTREAMS\fR file was
  35 attached to the file referenced by \fIpath\fR, will still refer to the
  36 \fBSTREAMS\fR file after the \fBfdetach()\fR has taken effect.
  37 .sp
  38 .LP
  39 If there are no open file descriptors or other references to the \fBSTREAMS\fR
  40 file, then a successful call to \fBfdetach()\fR has the same effect as
  41 performing the last \fBclose\fR(2) on the attached file.
  42 .SH RETURN VALUES
  43 .sp
  44 .LP
  45 Upon successful completion, \fBfdetach()\fR returns \fB0\fR. Otherwise, it
  46 returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
  47 .SH ERRORS
  48 .sp
  49 .LP
  50 The \fBfdetach()\fR function will fail if:
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBEACCES\fR\fR
  55 .ad
  56 .RS 16n
  57 Search permission is denied on a component of the path prefix.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBEPERM\fR\fR
  64 .ad
  65 .RS 16n
  66 The effective user \fBID\fR is not the owner of \fIpath\fR and the process does
  67 not have appropriate privileges.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBENOTDIR\fR\fR
  74 .ad
  75 .RS 16n
  76 A component of the path prefix is not a directory.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBENOENT\fR\fR
  83 .ad
  84 .RS 16n
  85 A component of \fIpath\fR does not name an existing file or \fIpath\fR is an
  86 empty string.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBEINVAL\fR\fR
  93 .ad
  94 .RS 16n
  95 The \fIpath\fR argument names a file that is not currently attached.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBENAMETOOLONG\fR\fR
 102 .ad
 103 .RS 16n
 104 The size of a pathname exceeds \fBPATH_MAX\fR, or a pathname component is
 105 longer than \fBNAME_MAX\fR while \fB_POSIX_NO_TRUNC\fR is in effect.
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fB\fBELOOP\fR\fR
 112 .ad
 113 .RS 16n
 114 Too many symbolic links were encountered in resolving \fIpath\fR.
 115 .RE
 116
 117 .sp
 118 .LP
 119 The \fBfdetach()\fR function may fail if:
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBENAMETOOLONG\fR\fR
 124 .ad
 125 .RS 16n
 126 Pathname resolution of a symbolic link produced an intermediate result whose
 127 length exceeds \fBPATH_MAX\fR.
 128 .RE
 129
 130 .SH ATTRIBUTES
 131 .sp
 132 .LP
 133 See \fBattributes\fR(5) for descriptions of the following attributes:
 134 .sp
 135
 136 .sp
 137 .TS
 138 box;
 139 l | l
 140 l | l .
 141 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 142 _
 143 Interface Stability     Standard
 144 .TE
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBfdetach\fR(1M), \fBclose\fR(2), \fBfattach\fR(3C), \fBattributes\fR(5),
 150 \fBstandards\fR(5), \fBstreamio\fR(7I)
 151 .sp
 152 .LP
 153 \fISTREAMS Programming Guide\fR