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
|
<?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
-
-
-->
<!-- Created with Funcmake.vsp -->
<refentry id="fn_ftp_get">
<refmeta>
<refentrytitle>ftp_get</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ftp_get</refname>
<refpurpose>FTP get command; Virtuoso FTP client</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_ftp_get">
<funcprototype id="fproto_ftp_get">
<funcdef>integer <function>ftp_get</function></funcdef>
<paramdef>in <parameter>server</parameter> varchar</paramdef>
<paramdef>in <parameter>user</parameter> varchar</paramdef>
<paramdef>in <parameter>pass</parameter> varchar</paramdef>
<paramdef>in <parameter>remote_file_name</parameter> varchar</paramdef>
<paramdef>in <parameter>local_file_name</parameter> varchar</paramdef>
<paramdef><optional>in <parameter>is_pasv</parameter> integer</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_ftp_get">
<title>Description</title>
<para>Virtuoso has FTP client functionality, that can be used inside Virtuoso/PL. This Virtuoso function mimics the FTP get command. As with any PL, this can be combined with Web Services and SOAP.</para>
</refsect1>
<refsect1 id="params_ftp_get"><title>Parameters</title>
<refsect2><title>server</title>
<para>The remote server address or IP Address.</para></refsect2>
<refsect2><title>user</title>
<para>The username for authentication at the FTP server.</para></refsect2>
<refsect2><title>pass</title>
<para>The accompanying password for authentication at the FTP server.</para></refsect2>
<refsect2><title>remote_file_name</title>
<para>Full path and file name to the file on the FTP server to be downloaded.</para></refsect2>
<refsect2><title>local_file_name</title>
<para>The full path and file name of the local save point. This is relative to the server root directory. This directory must be included in DirsAllowed ACL list in the Virtuoso.INI file.</para></refsect2>
<refsect2><title>is_pasv</title>
<para>Flag to specify whether to use passive mode. This can be one "1"
for passive mode, or zero "0" for active mode. One "1" is assumed by default.</para></refsect2>
</refsect1>
<refsect1 id="ret_ftp_get"><title>Return Types</title>
<para>This function returns the size of the file written to the local file system.</para>
</refsect1>
<refsect1 id="errors_ftp_get">
<title>Errors</title>
<para>This function will return any errors returned by the remote FTP server.</para>
</refsect1>
<refsect1 id="examples_ftp_get">
<title>Examples</title>
<example id="ex_ftp_get"><title>Retrieving a file from an FTP server</title>
<para>To get the file virtuoso30.tar.gz from the ftp server ftp.openlinksw.com, one can use:</para>
<screen>
select ftp_get ('ftp.openlinksw.com', 'user_name', 'password', 'virtuoso30.tar.gz', 'virtuoso30.tar.gz');
</screen>
<para>This will download the file which occurs on the root directory of the server, and save
it to the local server root directory.</para>
</example>
</refsect1>
<refsect1 id="seealso_ftp_get">
<title>See Also</title>
<para><link linkend="fn_ftp_put"><function>ftp_put()</function></link></para>
<para><link linkend="fn_ftp_ls"><function>ftp_ls()</function></link></para>
</refsect1>
</refentry>
|
