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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
<?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_file_mkpath">
<refmeta>
<refentrytitle>file_mkpath</refentrytitle>
<refmiscinfo>file</refmiscinfo>
</refmeta>
<refnamediv>
<refname>file_mkpath</refname>
<refpurpose>Make a directory chain</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_file_mkpath">
<funcprototype id="fproto_file_mkpath">
<funcdef><function>file_mkpath</function></funcdef>
<paramdef>in <parameter>path</parameter> varchar</paramdef>
<paramdef><optional>inout <parameter>istest</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_file_mkpath"><title>Description</title>
<para>This function requires dba privileges.</para>
<para>This is to create a directory chain i.e. 'a/b/c/d',
where one or more elements in the path may not exist.
</para>
</refsect1>
<refsect1 id="params_file_mkpath"><title>Parameters</title>
<refsect2><title>path</title>
<para>string containing file system path to be crated as directory chain</para>
</refsect2>
<refsect2><title>istest</title>
<para>Variable for returning the error message. If specified, errors are not signalled.
</para>
</refsect2>
</refsect1>
<refsect1 id="ret_file_mkpath"><title>Return Types</title>
<para>
On success returns zero.
</para>
</refsect1>
<refsect1 id="errors_file_mkpath"><title>Errors</title>
<table><title>Errors signalled by</title>
<tgroup cols="4">
<thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
<tbody>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>FA014</errorcode></entry>
<entry><errorname>Access to %s is denied due to access control in ini file</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>FA015</errorcode></entry>
<entry><errorname>Access to %s is denied due to access control in ini file</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>FA116</errorcode></entry>
<entry><errorname>Abnormally long path is passed as argument to sys_mkpath()</errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<!--
<refsect1 id="examples_file_mkpath"><title>Examples</title>
<example id="ex_file_mkpath"><title></title>
<para></para>
<screen></screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_file_mkpath"><title>See Also</title>
<para>
<link linkend="fn_file_delete"><function>file_unlink()</function></link>
<link linkend="fn_file_delete"><function>file_delete()</function></link>
<link linkend="fn_file_mkdir"><function>file_mkdir()</function></link>
<link linkend="fn_file_mkpath"><function>file_mkpath()</function></link>
<link linkend="fn_file_stat"><function>file_stat()</function></link>
</para>
</refsect1>
</refentry>
|
