File: FtpGet.html

package info (click to toggle)
ftplib 4.0-1-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, forky, sid, trixie
  • size: 560 kB
  • sloc: ansic: 1,711; makefile: 66
file content (34 lines) | stat: -rw-r--r-- 974 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title>FtpGet</title>
<link rel="stylesheet" type="text/css" href="doc.css">
</head>
<body>
<h1>FtpGet</h1>
<p>Retreive a file from the remote system.</p>
<h2>SYNOPSIS</h2>
<pre>
#include &lt;ftplib.h&gt;
int FtpGet(const char *output, const char *path, char mode, netbuf *nControl);
</pre>
<h2>PARAMETERS</h2>
<dl>
<dt><b>output</b></dt>
<dd>Name of a local file to receive the contents of the remote
file.  If specified as NULL file data will be written to stdout.</dd>
<dt><b>path</b></dt>
<dd>Name of remote file to be retrieved.</dd>
<dt><b>mode</b></dt>
<dd>Specifies the transfer mode as FTPLIB_ASCII or
FTPLIB_IMAGE.</dd>
<dt><b>nControl</b></dt>
<dd>A handle returned by <a href="FtpConnect.html">FtpConnect()</a>.</dd>
</dl>
<h2>DESCRIPTION</h2>
<p>FtpGet() copies the contents of a remote file to a local
file.</p>
<h2>RETURN VALUE</h2>
<p>Returns 1 if successful or 0 on error.</p>
</body>
</html>