usr/src/man/man3c/tmpfile.3c

   1 '\" te
   2 .\" Copyright 1989 AT&T.  Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.  Portions Copyright (c) 2003, Sun Microsystems, Inc.  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 TMPFILE 3C "Aug 4, 2003"
  11 .SH NAME
  12 tmpfile \- create a temporary file
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17
  18 \fBFILE *\fR\fBtmpfile\fR(\fBvoid\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBtmpfile()\fR function creates a temporary file and opens a corresponding
  25 stream.  The file will automatically be deleted when all references to the file
  26 are closed.  The file is opened as in \fBfopen\fR(3C) for update (\fBw+\fR).
  27 .sp
  28 .LP
  29 The largest value that can be represented correctly in an object of type
  30 \fBoff_t\fR will be established as the offset maximum in the open file
  31 description.
  32 .SH RETURN VALUES
  33 .sp
  34 .LP
  35 Upon successful completion, \fBtmpfile()\fR returns a pointer to the stream of
  36 the file that is created. Otherwise, it returns a null pointer and sets
  37 \fBerrno\fR to indicate the error.
  38 .SH ERRORS
  39 .sp
  40 .LP
  41 The \fBtmpfile()\fR function will fail if:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBEINTR\fR\fR
  46 .ad
  47 .RS 10n
  48 A signal was caught during the execution of \fBtmpfile()\fR.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBEMFILE\fR\fR
  55 .ad
  56 .RS 10n
  57 There are \fBOPEN_MAX\fR file descriptors currently open in the calling
  58 process.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBENFILE\fR\fR
  65 .ad
  66 .RS 10n
  67 The maximum allowable number of files is currently open in the system.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBENOSPC\fR\fR
  74 .ad
  75 .RS 10n
  76 The directory or file system which would contain the new file cannot be
  77 expanded.
  78 .RE
  79
  80 .sp
  81 .LP
  82 The \fBtmpfile()\fR function may fail if:
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBEMFILE\fR\fR
  87 .ad
  88 .RS 10n
  89 There are \fBFOPEN_MAX\fR streams currently open in the calling process.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBENOMEM\fR\fR
  96 .ad
  97 .RS 10n
  98 Insufficient storage space is available.
  99 .RE
 100
 101 .SH USAGE
 102 .sp
 103 .LP
 104 The stream refers to a file which is unlinked.  If the process is killed in the
 105 period between file creation and unlinking, a permanent file may be left
 106 behind.
 107 .sp
 108 .LP
 109 The \fBtmpfile()\fR function has a transitional interface for 64-bit file
 110 offsets. See \fBlf64\fR(5).
 111 .SH ATTRIBUTES
 112 .sp
 113 .LP
 114 See \fBattributes\fR(5) for descriptions of the following attributes:
 115 .sp
 116
 117 .sp
 118 .TS
 119 box;
 120 c | c
 121 l | l .
 122 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 123 _
 124 Interface Stability     Standard
 125 .TE
 126
 127 .SH SEE ALSO
 128 .sp
 129 .LP
 130 \fBunlink\fR(2), \fBfopen\fR(3C), \fBmkstemp\fR(3C), \fBmktemp\fR(3C),
 131 \fBtmpnam\fR(3C), \fBlf64\fR(5), \fBstandards\fR(5)