summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/tmpfile.3p
blob: be5d7b4f2f57b59bdfaa1aaa571e9d050bad9339 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
'\" et
.TH TMPFILE "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
tmpfile
\(em create a temporary file
.SH SYNOPSIS
.LP
.nf
#include <stdio.h>
.P
FILE *tmpfile(void);
.fi
.SH DESCRIPTION
The functionality described on this reference page is aligned with the
ISO\ C standard. Any conflict between the requirements described here and the
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
.P
The
\fItmpfile\fR()
function shall create a temporary file and open a corresponding
stream. The file shall be automatically deleted when all references
to the file are closed. The file shall be opened as in
\fIfopen\fR()
for update (\fIwb\fP+), except that implementations may restrict the
permissions, either by clearing the file mode bits or setting them
to the value S_IRUSR | S_IWUSR.
.P
In some implementations, a permanent file may be left behind if
the process calling
\fItmpfile\fR()
is killed while it is processing a call to
\fItmpfile\fR().
.P
An error message may be written to standard error if the stream cannot
be opened.
.SH "RETURN VALUE"
Upon successful completion,
\fItmpfile\fR()
shall return a pointer to the stream of the file that is created.
Otherwise, it shall return a null pointer
and set
.IR errno
to indicate the error.
.SH ERRORS
The
\fItmpfile\fR()
function shall fail if:
.TP
.BR EINTR
A signal was caught during
\fItmpfile\fR().
.TP
.BR EMFILE
All file descriptors available to the process are currently open.
.TP
.BR EMFILE
{STREAM_MAX}
streams are currently open in the calling process.
.TP
.BR ENFILE
The maximum allowable number of files is currently open in the system.
.TP
.BR ENOSPC
The directory or file system which would contain the new file cannot be
expanded.
.TP
.BR EOVERFLOW
The file is a regular file and the size of the file cannot be
represented correctly in an object of type
.BR off_t .
.P
The
\fItmpfile\fR()
function may fail if:
.TP
.BR EMFILE
{FOPEN_MAX}
streams are currently open in the calling process.
.TP
.BR ENOMEM
Insufficient storage space is available.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
.SS "Creating a Temporary File"
.P
The following example creates a temporary file for update, and returns
a pointer to a stream for the created file in the
.IR fp
variable.
.sp
.RS 4
.nf

#include <stdio.h>
\&...
FILE *fp;
.P
fp = tmpfile ();
.fi
.P
.RE
.SH "APPLICATION USAGE"
It should be possible to open at least
{TMP_MAX}
temporary files during the lifetime of the program (this limit may be
shared with
\fItmpnam\fR())
and there should be no limit on the number simultaneously open other
than this limit and any limit on the number of open file descriptors
or streams (\c
{OPEN_MAX},
{FOPEN_MAX},
{STREAM_MAX}).
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "Section 2.5" ", " "Standard I/O Streams",
.IR "\fIfopen\fR\^(\|)",
.IR "\fImkdtemp\fR\^(\|)",
.IR "\fItmpnam\fR\^(\|)",
.IR "\fIunlink\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<stdio.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version 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 .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .