share/man/man3c/tmpfile.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T.
  44 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH TMPFILE 3C "Aug 4, 2003"
  48 .SH NAME
  49 tmpfile \- create a temporary file
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <stdio.h>
  54
  55 \fBFILE *\fR\fBtmpfile\fR(\fBvoid\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBtmpfile()\fR function creates a temporary file and opens a corresponding
  62 stream.  The file will automatically be deleted when all references to the file
  63 are closed.  The file is opened as in \fBfopen\fR(3C) for update (\fBw+\fR).
  64 .sp
  65 .LP
  66 The largest value that can be represented correctly in an object of type
  67 \fBoff_t\fR will be established as the offset maximum in the open file
  68 description.
  69 .SH RETURN VALUES
  70 .sp
  71 .LP
  72 Upon successful completion, \fBtmpfile()\fR returns a pointer to the stream of
  73 the file that is created. Otherwise, it returns a null pointer and sets
  74 \fBerrno\fR to indicate the error.
  75 .SH ERRORS
  76 .sp
  77 .LP
  78 The \fBtmpfile()\fR function will fail if:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBEINTR\fR\fR
  83 .ad
  84 .RS 10n
  85 A signal was caught during the execution of \fBtmpfile()\fR.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBEMFILE\fR\fR
  92 .ad
  93 .RS 10n
  94 There are \fBOPEN_MAX\fR file descriptors currently open in the calling
  95 process.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBENFILE\fR\fR
 102 .ad
 103 .RS 10n
 104 The maximum allowable number of files is currently open in the system.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBENOSPC\fR\fR
 111 .ad
 112 .RS 10n
 113 The directory or file system which would contain the new file cannot be
 114 expanded.
 115 .RE
 116
 117 .sp
 118 .LP
 119 The \fBtmpfile()\fR function may fail if:
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBEMFILE\fR\fR
 124 .ad
 125 .RS 10n
 126 There are \fBFOPEN_MAX\fR streams currently open in the calling process.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBENOMEM\fR\fR
 133 .ad
 134 .RS 10n
 135 Insufficient storage space is available.
 136 .RE
 137
 138 .SH USAGE
 139 .sp
 140 .LP
 141 The stream refers to a file which is unlinked.  If the process is killed in the
 142 period between file creation and unlinking, a permanent file may be left
 143 behind.
 144 .SH ATTRIBUTES
 145 .sp
 146 .LP
 147 See \fBattributes\fR(5) for descriptions of the following attributes:
 148 .sp
 149
 150 .sp
 151 .TS
 152 box;
 153 c | c
 154 l | l .
 155 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 156 _
 157 Interface Stability     Standard
 158 .TE
 159
 160 .SH SEE ALSO
 161 .sp
 162 .LP
 163 \fBunlink\fR(2), \fBfopen\fR(3C), \fBmkstemp\fR(3C), \fBmktemp\fR(3C),
 164 \fBtmpnam\fR(3C), \fBstandards\fR(5)