|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH TMPNAM "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
tmpnam
|
|
Packit |
7cfc04 |
\(em create a name for a temporary file
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <stdio.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
char *tmpnam(char *\fIs\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The functionality described on this reference page is aligned with the
|
|
Packit |
7cfc04 |
ISO\ C standard. Any conflict between the requirements described here and the
|
|
Packit |
7cfc04 |
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2008 defers to the ISO\ C standard.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
function shall generate a string that is a valid pathname that does not
|
|
Packit |
7cfc04 |
name an existing file. The function is potentially capable of generating
|
|
Packit |
7cfc04 |
{TMP_MAX}
|
|
Packit |
7cfc04 |
different strings, but any or all of them may already be in use by
|
|
Packit |
7cfc04 |
existing files and thus not be suitable return values.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
function generates a different string each time it is called from the
|
|
Packit |
7cfc04 |
same process, up to
|
|
Packit |
7cfc04 |
{TMP_MAX}
|
|
Packit |
7cfc04 |
times. If it is called more than
|
|
Packit |
7cfc04 |
{TMP_MAX}
|
|
Packit |
7cfc04 |
times, the behavior is implementation-defined.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The implementation shall behave as if no function defined in this volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
except
|
|
Packit |
7cfc04 |
\fItempnam\fR(),
|
|
Packit |
7cfc04 |
calls
|
|
Packit |
7cfc04 |
\fItmpnam\fR().
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
function need not be thread-safe if called with a NULL parameter.
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
Upon successful completion,
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
shall return a pointer to a string. If no suitable string can be
|
|
Packit |
7cfc04 |
generated, the
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
function shall return a null pointer.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
If the argument
|
|
Packit |
7cfc04 |
.IR s
|
|
Packit |
7cfc04 |
is a null pointer,
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
shall leave its result in an internal static object and return a
|
|
Packit |
7cfc04 |
pointer to that object. Subsequent calls to
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
may modify the same object. If the argument
|
|
Packit |
7cfc04 |
.IR s
|
|
Packit |
7cfc04 |
is not a null pointer, it is presumed to point to an array of at least
|
|
Packit |
7cfc04 |
L_tmpnam
|
|
Packit |
7cfc04 |
.BR char s;
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
shall write its result in that array and shall return the argument
|
|
Packit |
7cfc04 |
as its value.
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
No errors are defined.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
.SS "Generating a Pathname"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The following example generates a unique pathname and stores it in the
|
|
Packit |
7cfc04 |
array pointed to by
|
|
Packit |
7cfc04 |
.IR ptr .
|
|
Packit |
7cfc04 |
.sp
|
|
Packit |
7cfc04 |
.RS 4
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
\fB
|
|
Packit |
7cfc04 |
#include <stdio.h>
|
|
Packit |
7cfc04 |
\&...
|
|
Packit |
7cfc04 |
char pathname[L_tmpnam+1];
|
|
Packit |
7cfc04 |
char *ptr;
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
ptr = tmpnam(pathname);
|
|
Packit |
7cfc04 |
.fi \fR
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
.RE
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
This function only creates pathnames. It is the application's
|
|
Packit |
7cfc04 |
responsibility to create and remove the files.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
Between the time a pathname is created and the file is opened, it is
|
|
Packit |
7cfc04 |
possible for some other process to create a file with the same name.
|
|
Packit |
7cfc04 |
Applications may find
|
|
Packit |
7cfc04 |
\fItmpfile\fR()
|
|
Packit |
7cfc04 |
more useful.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
Applications should use the
|
|
Packit |
7cfc04 |
\fItmpfile\fR(),
|
|
Packit |
7cfc04 |
\fImkstemp\fR(),
|
|
Packit |
7cfc04 |
or
|
|
Packit |
7cfc04 |
\fImkdtemp\fR()
|
|
Packit |
7cfc04 |
functions instead of the obsolescent
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
function.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fItmpnam\fR()
|
|
Packit |
7cfc04 |
function may be removed in a future version.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fIfopen\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIopen\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fImkdtemp\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fItempnam\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fItmpfile\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIunlink\fR\^(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Base Definitions volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fB<stdio.h>\fP"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|