annotate docs/ccguide/mktemp.refentry @ 1914:395e22e5c0bd

Added more defs for porting back to level 1 someday
author boisy
date Sun, 20 Nov 2005 17:11:16 +0000
parents 42b2c775f05f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
1 <refentry id="mktemp">
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
2 <refnamediv>
570
253b6096ee01 All function prototypes are added.
roug
parents: 542
diff changeset
3 <refname>Mktemp</refname>
253b6096ee01 All function prototypes are added.
roug
parents: 542
diff changeset
4 <refpurpose>create unique temporary file name</refpurpose>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
5 </refnamediv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
6
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
7 <refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
8 <funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
9 <funcprototype>
570
253b6096ee01 All function prototypes are added.
roug
parents: 542
diff changeset
10 <funcdef>char *<function>mktemp</function></funcdef>
253b6096ee01 All function prototypes are added.
roug
parents: 542
diff changeset
11 <paramdef>char *<parameter>name</parameter></paramdef>
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
12 </funcprototype>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
13 </funcsynopsis>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
14
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
15 </refsynopsisdiv>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
16
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
17 <refsect1><title>Description</title>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
18 <para>
602
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
19 Mktemp may be used to ensure that the name of a temporary file
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
20 is unique in the system and does not clash with any other file
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
21 name.
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
22 </para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
23 <para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
24 "Name" must point to a string whose last five characters are "X";
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
25 the Xs will be replaced with the ascii representation of
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
26 the task id.
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
27 </para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
28 <para>
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
29 For example, if "name" points to "foo.XXXXX", and the task id
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
30 is 351, the returned value points at the same place, but it
42b2c775f05f All refentries finished.
roug
parents: 570
diff changeset
31 now holds "foo.351".
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
32 </para>
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
33 </refsect1>
542
73319ee6a57e All "See Also" implemented
roug
parents: 466
diff changeset
34
73319ee6a57e All "See Also" implemented
roug
parents: 466
diff changeset
35 <refsect1><title>See Also</title>
73319ee6a57e All "See Also" implemented
roug
parents: 466
diff changeset
36 <para>
73319ee6a57e All "See Also" implemented
roug
parents: 466
diff changeset
37 System call
73319ee6a57e All "See Also" implemented
roug
parents: 466
diff changeset
38 <link linkend="getpid">getpid()</link>
73319ee6a57e All "See Also" implemented
roug
parents: 466
diff changeset
39 </para>
73319ee6a57e All "See Also" implemented
roug
parents: 466
diff changeset
40 </refsect1>
73319ee6a57e All "See Also" implemented
roug
parents: 466
diff changeset
41
466
bea58398bb15 Skeletons for the C Compiler User's Guide, 1983
roug
parents:
diff changeset
42 </refentry>