tempname function added (it will be used to fix bug 9614)
[scilab.git] / scilab / modules / fileio / help / en_US / tempname.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2011 - DIGITEO - Allan CORNET
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="tempname">
14   <info>
15     <pubdate>$LastChangedDate: 2006-09-10 20:58:00 +0200 (dim., 10 sept. 2006)$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>tempname</refname>
19     <refpurpose>Unique name for temporary file</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>tmp_name = tempname([prefix])</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Arguments</title>
27     <variablelist>
28       <varlistentry>
29         <term>tmp_name</term>
30         <listitem>
31           <para>a string</para>
32         </listitem>
33       </varlistentry>
34     </variablelist>
35     <variablelist>
36       <varlistentry>
37         <term>prefix</term>
38         <listitem>
39           <para>a string: prefix of filename (On Windows, 3 characters maximum).</para>
40         </listitem>
41       </varlistentry>
42     </variablelist>
43   </refsection>
44   <refsection>
45     <title>Description</title>
46     <para>Creates a file with a unique filename in the TMPDIR directory.</para>
47     <para>tmp_nam = tempname() returns a unique string, tmp_nam, suitable for use as a temporary filename.</para>
48   </refsection>
49   <refsection>
50     <title>Examples</title>
51     <programlisting role="example"><![CDATA[
52       F1 = tempname()
53       isfile(F1)
54       F2 = tempname('TMP')
55       isfile(F2)
56  ]]></programlisting>
57   </refsection>
58   <refsection>
59     <title>Author</title>
60     <simplelist type="vert">
61       <member>A.C</member>
62     </simplelist>
63   </refsection>
64 </refentry>