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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
<?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_unlink">
<refmeta>
<refentrytitle>file_unlink</refentrytitle>
<refmiscinfo>file</refmiscinfo>
</refmeta>
<refnamediv>
<refname>file_unlink</refname>
<refpurpose>Delete a file from the file system</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_file_unlink">
<funcprototype id="fproto_file_unlink">
<funcdef><function>file_unlink</function></funcdef>
<paramdef>in <parameter>path</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_file_unlink"><title>Description</title>
<para>This function requires dba privileges.</para>
<para>
This function deletes a file from the file system. sys_unlink is a synonym of this function.
</para>
</refsect1>
<refsect1 id="params_file_unlink"><title>Parameters</title>
<refsect2><title>path</title>
<para>Path name of the file to delete.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_file_unlink"><title>Return Types</title>
<para>
On success returns zero. Otherwise signals an error.
</para>
</refsect1>
<refsect1 id="errors_set_row_count"><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>FA003</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>FA004</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>SR426</errorcode></entry>
<entry><errorname>Permission is denied for the file '%s' in sys_unlink()</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR427</errorcode></entry>
<entry><errorname>Path name '%s' too long in sys_unlink()</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR428</errorcode></entry>
<entry><errorname>A directory component in '%s' does not exist or is a dangling symbolic link in sys_unlink()</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR429</errorcode></entry>
<entry><errorname>A component used as a directory in '%s' is not, in fact, a directory in sys_unlink()</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR430</errorcode></entry>
<entry><errorname>'%s' refers to a directory in sys_unlink()</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR431</errorcode></entry>
<entry><errorname>Insufficient kernel memory was available in sys_unlink()</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR432</errorcode></entry>
<entry><errorname>'%s' refers to a file on a read-only filesystem in sys_unlink()</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR433</errorcode></entry>
<entry><errorname>Too many symbolic links were encountered in translating '%s' in sys_unlink()</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>42000</errorcode></entry>
<entry><errorcode>SR434</errorcode></entry>
<entry><errorname>An I/O error occurred in sys_unlink()</errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<!--
<refsect1 id="examples_file_unlink"><title>Examples</title>
<example id="ex_file_unlink"><title></title>
<para></para>
<screen></screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_file_unlink"><title>See Also</title>
<para>
<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>
|
