usr/src/man/man3c/mktemp.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) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH MKTEMP 3C "Sep 15, 2004"
  48 .SH NAME
  49 mktemp \- make a unique file name  from a template
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <stdlib.h>
  54
  55 \fBchar *\fR\fBmktemp\fR(\fBchar *\fR\fItemplate\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBmktemp()\fR function replaces the contents of the string pointed to by
  62 \fItemplate\fR with a unique file name, and returns \fItemplate\fR. The string
  63 in \fItemplate\fR should look like a file name with six trailing 'X's;
  64 \fBmktemp()\fR will replace the 'X's with a character string that can be used
  65 to create a unique file name. Only 26 unique file names per thread can be
  66 created for each unique \fItemplate\fR.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 The \fBmktemp()\fR function returns a pointer to the \fItemplate\fR on success
  71 and \fBNULL\fR if unique name cannot be created.
  72 .SH ERRORS
  73 .sp
  74 .LP
  75 No errors are defined.
  76 .SH EXAMPLES
  77 .LP
  78 \fBExample 1 \fRGenerate a filename.
  79 .sp
  80 .LP
  81 The following example replaces the contents of the "template" string with a
  82 10-character filename beginning with the characters "file" and returns a
  83 pointer to the "template" string that contains the new filename.
  84
  85 .sp
  86 .in +2
  87 .nf
  88 #include <stdlib.h>
  89 \&...
  90 char template[] = "/tmp/fileXXXXXX";
  91 char *ptr;
  92 ptr = mktemp(template);
  93 .fi
  94 .in -2
  95
  96 .SH USAGE
  97 .sp
  98 .LP
  99 Between the time a pathname is created and the file opened, it is possible for
 100 some other process to create a file with the same name. The \fBmkstemp\fR(3C)
 101 function avoids this problem and is preferred over this function.
 102 .SH ATTRIBUTES
 103 .sp
 104 .LP
 105 See \fBattributes\fR(5) for descriptions of the following attributes:
 106 .sp
 107
 108 .sp
 109 .TS
 110 box;
 111 c | c
 112 l | l .
 113 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 114 _
 115 Interface Stability     Standard
 116 _
 117 MT-Level        Safe
 118 .TE
 119
 120 .SH SEE ALSO
 121 .sp
 122 .LP
 123 \fBmkstemp\fR(3C), \fBtmpfile\fR(3C), \fBtmpnam\fR(3C), \fBattributes\fR(5),
 124 \fBstandards\fR(5)