File: FtpSize.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 (38 lines) | stat: -rw-r--r-- 1,176 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
35
36
37
38
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
<head>
<title>FtpSize</title>
<link rel="stylesheet" type="text/css" href="doc.css">
</head>
<body>
<h1>FtpSize</h1>
<p>Determine size of remote file.</p>
<h2>SYNOPSIS</h2>
<pre>
#include &lt;ftplib.h&gt;
int FtpSize(char *path, unsigned int *size, char mode, netbuf *nControl);
</pre>
<h2>PARAMETERS</h2>
<dl>
<dt><b>path</b></dt>
<dd>Name of a file on the remote server.</dd>
<dt><b>size</b></dt>
<dd>A pointer to an unsigned integer where the size will be returned.</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">FtpConnect()</a>.</dd>
</dl>
<h2>DESCRIPTION</h2>
<p>FtpSize() attempts to determine the size of a remote file.</p>
<h2>RETURN VALUE</h2>
<p>If a good response is received and the size is successfully
parsed out of the result, 1 is returned. Otherwise, 0 is
returned.</p>
<p>Some servers may not support the SIZE command. If this request
fails, the size may be available in the response to a RETR
(<a href="FtpOpen.html">FtpOpen()</a> with
typ=FTPLIB_FILE_READ).</p>
</body>
</html>