1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_tmp_file_name">
<refmeta>
<refentrytitle>tmp_file_name</refentrytitle>
<refmiscinfo>string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>tmp_file_name</refname>
<refpurpose>returns the unique file name within temporary directory of the operating system</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_tmp_file_name">
<funcprototype id="fproto_tmp_file_name">
<funcdef>varchar <function>tmp_file_name</function></funcdef>
<paramdef>in <parameter>prefix</parameter> varchar</paramdef>
<paramdef>in <parameter>suffix</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_tmp_file_name"><title>Description</title>
<para>
The following function is used to obtain unique name of a file, which is located in
temporary directory on file system. The two optional parameters can be supplied:
prefix of the file and extension for it. These will be prepended and appended (dot MUST be omitted) to the unique string.
The directory where this file is located depends of $TMPDIR or %TMP% environment settings for UNIX's and Windows platforms respectively. If these environment settings are not available or empty, the defaults will be used for the
operation system. (in practice for most UNIX's it's /tmp or /var/tmp directory).
Note that this function do NOT open the file, it only give us a name.
</para>
</refsect1>
<refsect1 id="params_tmp_file_name"><title>Parameters</title>
<refsect2>
<title>prefix</title>
prefix to the file name to be added. MUST be at most five characters.
<para>
</para>
</refsect2>
<refsect2>
<title>suffix</title>
extension to the file to be added, the leading dot MUST be omitted.
<para>
</para>
</refsect2>
</refsect1>
<refsect1 id="errors_tmp_file_name"><title>Errors</title>
<para><link linkend="datatypeerror">Parameter data type checking errors</link></para>
</refsect1>
<refsect1 id="examples"><title>Examples</title>
<example id="ex_tmp_file_name"><title>Getting a unique file name</title>
<programlisting>
<![CDATA[
SQL> select tmp_file_name('FOO', 'EXT');
callret
VARCHAR
________________________________________
/tmp/FOOFoCnq5.EXT
1 Rows. -- 7 msec.
]]>
</programlisting>
</example>
</refsect1>
</refentry>
|
