man-pages/man3/mktemp.3.html
2021-03-31 01:06:50 +01:00

191 lines
4.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of MKTEMP</TITLE>
</HEAD><BODY>
<H1>MKTEMP</H1>
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
mktemp - make a unique temporary filename
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
<B>#include &lt;<A HREF="file:///usr/include/stdlib.h">stdlib.h</A>&gt;</B>
<B>char *mktemp(char *</B><I>template</I><B>);</B>
</PRE>
<P>
Feature Test Macro Requirements for glibc (see
<B><A HREF="/cgi-bin/man/man2html?7+feature_test_macros">feature_test_macros</A></B>(7)):
<P>
<B>mktemp</B>():
<DL COMPACT><DT id="1"><DD>
<DL COMPACT>
<DT id="2">Since glibc 2.12:<DD>
(_XOPEN_SOURCE&nbsp;&gt;=&nbsp;500) &amp;&amp; ! (_POSIX_C_SOURCE&nbsp;&gt;=&nbsp;200112L)
<BR>&nbsp;&nbsp;&nbsp;&nbsp;||&nbsp;/*&nbsp;Glibc&nbsp;since&nbsp;2.19:&nbsp;*/&nbsp;_DEFAULT_SOURCE
<BR>&nbsp;&nbsp;&nbsp;&nbsp;||&nbsp;/*&nbsp;Glibc&nbsp;&lt;=&nbsp;2.19:&nbsp;*/&nbsp;_SVID_SOURCE&nbsp;||&nbsp;_BSD_SOURCE
<DT id="3">Before glibc 2.12:<DD>
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE&nbsp;&gt;=&nbsp;500
</DL>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<I>Never use this function</I>;
see BUGS.
<P>
The
<B>mktemp</B>()
function generates a unique temporary filename
from <I>template</I>.
The last six characters of <I>template</I> must
be XXXXXX and these are replaced with a string that makes the
filename unique.
Since it will be modified,
<I>template</I>
must not be a string constant, but should be declared as a character array.
<A NAME="lbAE">&nbsp;</A>
<H2>RETURN VALUE</H2>
The
<B>mktemp</B>()
function always returns <I>template</I>.
If a unique name was created, the last six bytes of <I>template</I> will
have been modified in such a way that the resulting name is unique
(i.e., does not exist already)
If a unique name could not be created,
<I>template</I> is made an empty string, and
<I>errno</I>
is set to indicate the error.
<A NAME="lbAF">&nbsp;</A>
<H2>ERRORS</H2>
<DL COMPACT>
<DT id="4"><B>EINVAL</B>
<DD>
The last six characters of <I>template</I> were not XXXXXX.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>ATTRIBUTES</H2>
For an explanation of the terms used in this section, see
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
<TABLE BORDER>
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
<TR VALIGN=top><TD>
<B>mktemp</B>()
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
</TABLE>
<A NAME="lbAH">&nbsp;</A>
<H2>CONFORMING TO</H2>
4.3BSD, POSIX.1-2001.
POSIX.1-2008 removes the specification of
<B>mktemp</B>().
<A NAME="lbAI">&nbsp;</A>
<H2>BUGS</H2>
Never use
<B>mktemp</B>().
Some implementations follow 4.3BSD
and replace XXXXXX by the current process ID and a single letter,
so that at most 26 different names can be returned.
Since on the one hand the names are easy to guess, and on the other
hand there is a race between testing whether the name exists and
opening the file, every use of
<B>mktemp</B>()
is a security risk.
The race is avoided by
<B><A HREF="/cgi-bin/man/man2html?3+mkstemp">mkstemp</A></B>(3)
and
<B><A HREF="/cgi-bin/man/man2html?3+mkdtemp">mkdtemp</A></B>(3).
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?1+mktemp">mktemp</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?3+mkdtemp">mkdtemp</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+mkstemp">mkstemp</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+tempnam">tempnam</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+tmpfile">tmpfile</A></B>(3),
<B><A HREF="/cgi-bin/man/man2html?3+tmpnam">tmpnam</A></B>(3)
<A NAME="lbAK">&nbsp;</A>
<H2>COLOPHON</H2>
This page is part of release 5.05 of the Linux
<I>man-pages</I>
project.
A description of the project,
information about reporting bugs,
and the latest version of this page,
can be found at
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="5"><A HREF="#lbAB">NAME</A><DD>
<DT id="6"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="7"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="8"><A HREF="#lbAE">RETURN VALUE</A><DD>
<DT id="9"><A HREF="#lbAF">ERRORS</A><DD>
<DT id="10"><A HREF="#lbAG">ATTRIBUTES</A><DD>
<DT id="11"><A HREF="#lbAH">CONFORMING TO</A><DD>
<DT id="12"><A HREF="#lbAI">BUGS</A><DD>
<DT id="13"><A HREF="#lbAJ">SEE ALSO</A><DD>
<DT id="14"><A HREF="#lbAK">COLOPHON</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:48 GMT, March 31, 2021
</BODY>
</HTML>