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
|
<?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_delete">
<refmeta>
<refentrytitle>file_delete</refentrytitle>
<refmiscinfo>file</refmiscinfo>
</refmeta>
<refnamediv>
<refname>file_delete</refname>
<refpurpose>Delete a file from the file system</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_file_delete">
<funcprototype id="fproto_file_delete">
<funcdef>integer <function>file_delete</function></funcdef>
<paramdef>in <parameter>path</parameter> varchar</paramdef>
<paramdef>in <parameter>silent</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_file_delete"><title>Description</title>
<para>This function requires dba privileges.</para>
<para>
This function is used to delete a file from file system. This function has a silent mode,
where no errors will be signalled upon failure.</para>
</refsect1>
<refsect1 id="params_file_delete"><title>Parameters</title>
<refsect2>
<title>path</title>
<para>Path name of the file to delete.</para>
</refsect2>
<refsect2>
<title>silent</title>
<para>Flag which if true (integer 1) will suppress signalling file system errors.
</para>
</refsect2>
</refsect1>
<refsect1 id="errors_file_delete"><title>Errors</title>
<para><link linkend="datatypeerror">Parameter data type checking errors</link></para>
</refsect1>
</refentry>
|
