source: trunk/Packages/synapse/docs/help/ftpsend.TFTPSend.html

Last change on this file was 2, checked in by chronos, 12 years ago
  • Přidáno: Základní kostra projektu.
  • Přidáno: Knihovna synapse.
File size: 41.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
2<html>
3<head>
4<meta name="GENERATOR" content="PasDoc 0.9.0">
5<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
6<title>ftpsend: Class TFTPSend</title>
7<link rel="StyleSheet" type="text/css" href="pasdoc.css">
8</head>
9<body bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#800080" alink="#FF0000">
10<a name="TFTPSend"></a><h1 class="cio">Class TFTPSend</h1>
11<table class="sections">
12<tr>
13<td><a class="section" href="#@Description">Description</a></td><td><a class="section" href="#@Hierarchy">Hierarchy</a></td><td><a class="section" href="#@Fields">Fields</a></td><td><a class="section" href="#@Methods">Methods</a></td><td><a class="section" href="#@Properties">Properties</a></td></tr></table>
14<a name="@Description"></a><h2 class="unit">Unit</h2>
15<p class="unitlink">
16<a href="ftpsend.html">ftpsend</a></p>
17<h2 class="declaration">Declaration</h2>
18<p class="declaration">
19<code>type TFTPSend = class(<a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a>)</code></p>
20<h2 class="description">Description</h2>
21<p>
22Implementation of FTP protocol.</p>
23<p>
24 Note: Are you missing properties for setting Username and Password? Look to parent <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a> object! (Username and Password have default values for &quot;anonymous&quot; FTP login)
25
26<p>Are you missing properties for specify server address and port? Look to parent <a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a> too!</p>
27<a name="@Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
28<ul class="hierarchy"><li class="ancestor">TObject</li>
29<li class="ancestor"><a class="normal" href="blcksock.TSynaClient.html">TSynaClient</a></li>
30<li class="thisitem">TFTPSend</li></ul><h2 class="overview">Overview</h2>
31<a name="@Fields"></a><h3 class="summary">Fields</h3>
32<table class="summary">
33<tr class="list">
34<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
35<td class="itemcode"><code><b><a href="ftpsend.TFTPSend.html#CustomLogon">CustomLogon</a></b>: <a href="ftpsend.html#TLogonActions">TLogonActions</a>;</code></td>
36</tr>
37</table>
38<a name="@Methods"></a><h3 class="summary">Methods</h3>
39<table class="summary">
40<tr class="list">
41<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
42<td class="itemcode"><code>constructor <b><a href="ftpsend.TFTPSend.html#Create">Create</a></b>;</code></td>
43</tr>
44<tr class="list2">
45<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
46<td class="itemcode"><code>destructor <b><a href="ftpsend.TFTPSend.html#Destroy">Destroy</a></b>; override;</code></td>
47</tr>
48<tr class="list">
49<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
50<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#ReadResult">ReadResult</a></b>: Integer; virtual;</code></td>
51</tr>
52<tr class="list2">
53<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
54<td class="itemcode"><code>procedure <b><a href="ftpsend.TFTPSend.html#ParseRemote">ParseRemote</a></b>(Value: string); virtual;</code></td>
55</tr>
56<tr class="list">
57<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
58<td class="itemcode"><code>procedure <b><a href="ftpsend.TFTPSend.html#ParseRemoteEPSV">ParseRemoteEPSV</a></b>(Value: string); virtual;</code></td>
59</tr>
60<tr class="list2">
61<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
62<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#FTPCommand">FTPCommand</a></b>(const Value: string): integer; virtual;</code></td>
63</tr>
64<tr class="list">
65<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
66<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#Login">Login</a></b>: Boolean; virtual;</code></td>
67</tr>
68<tr class="list2">
69<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
70<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#Logout">Logout</a></b>: Boolean; virtual;</code></td>
71</tr>
72<tr class="list">
73<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
74<td class="itemcode"><code>procedure <b><a href="ftpsend.TFTPSend.html#Abort">Abort</a></b>; virtual;</code></td>
75</tr>
76<tr class="list2">
77<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
78<td class="itemcode"><code>procedure <b><a href="ftpsend.TFTPSend.html#TelnetAbort">TelnetAbort</a></b>; virtual;</code></td>
79</tr>
80<tr class="list">
81<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
82<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#List">List</a></b>(Directory: string; NameList: Boolean): Boolean; virtual;</code></td>
83</tr>
84<tr class="list2">
85<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
86<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#RetrieveFile">RetrieveFile</a></b>(const FileName: string; Restore: Boolean): Boolean; virtual;</code></td>
87</tr>
88<tr class="list">
89<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
90<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#StoreFile">StoreFile</a></b>(const FileName: string; Restore: Boolean): Boolean; virtual;</code></td>
91</tr>
92<tr class="list2">
93<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
94<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#StoreUniqueFile">StoreUniqueFile</a></b>: Boolean; virtual;</code></td>
95</tr>
96<tr class="list">
97<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
98<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#AppendFile">AppendFile</a></b>(const FileName: string): Boolean; virtual;</code></td>
99</tr>
100<tr class="list2">
101<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
102<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#RenameFile">RenameFile</a></b>(const OldName, NewName: string): Boolean; virtual;</code></td>
103</tr>
104<tr class="list">
105<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
106<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#DeleteFile">DeleteFile</a></b>(const FileName: string): Boolean; virtual;</code></td>
107</tr>
108<tr class="list2">
109<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
110<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#FileSize">FileSize</a></b>(const FileName: string): int64; virtual;</code></td>
111</tr>
112<tr class="list">
113<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
114<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#NoOp">NoOp</a></b>: Boolean; virtual;</code></td>
115</tr>
116<tr class="list2">
117<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
118<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#ChangeWorkingDir">ChangeWorkingDir</a></b>(const Directory: string): Boolean; virtual;</code></td>
119</tr>
120<tr class="list">
121<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
122<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#ChangeToParentDir">ChangeToParentDir</a></b>: Boolean; virtual;</code></td>
123</tr>
124<tr class="list2">
125<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
126<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#ChangeToRootDir">ChangeToRootDir</a></b>: Boolean; virtual;</code></td>
127</tr>
128<tr class="list">
129<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
130<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#DeleteDir">DeleteDir</a></b>(const Directory: string): Boolean; virtual;</code></td>
131</tr>
132<tr class="list2">
133<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
134<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#CreateDir">CreateDir</a></b>(const Directory: string): Boolean; virtual;</code></td>
135</tr>
136<tr class="list">
137<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
138<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#GetCurrentDir">GetCurrentDir</a></b>: String; virtual;</code></td>
139</tr>
140<tr class="list2">
141<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
142<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#DataRead">DataRead</a></b>(const DestStream: TStream): Boolean; virtual;</code></td>
143</tr>
144<tr class="list">
145<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
146<td class="itemcode"><code>function <b><a href="ftpsend.TFTPSend.html#DataWrite">DataWrite</a></b>(const SourceStream: TStream): Boolean; virtual;</code></td>
147</tr>
148</table>
149<a name="@Properties"></a><h3 class="summary">Properties</h3>
150<table class="summary">
151<tr class="list">
152<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
153<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#ResultCode">ResultCode</a></b>: Integer read FResultCode;</code></td>
154</tr>
155<tr class="list2">
156<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
157<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#ResultString">ResultString</a></b>: string read FResultString;</code></td>
158</tr>
159<tr class="list">
160<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
161<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#FullResult">FullResult</a></b>: TStringList read FFullResult;</code></td>
162</tr>
163<tr class="list2">
164<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
165<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#Account">Account</a></b>: string read FAccount Write FAccount;</code></td>
166</tr>
167<tr class="list">
168<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
169<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#FWHost">FWHost</a></b>: string read FFWHost Write FFWHost;</code></td>
170</tr>
171<tr class="list2">
172<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
173<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#FWPort">FWPort</a></b>: string read FFWPort Write FFWPort;</code></td>
174</tr>
175<tr class="list">
176<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
177<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#FWUsername">FWUsername</a></b>: string read FFWUsername Write FFWUsername;</code></td>
178</tr>
179<tr class="list2">
180<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
181<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#FWPassword">FWPassword</a></b>: string read FFWPassword Write FFWPassword;</code></td>
182</tr>
183<tr class="list">
184<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
185<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#FWMode">FWMode</a></b>: integer read FFWMode Write FFWMode;</code></td>
186</tr>
187<tr class="list2">
188<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
189<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#Sock">Sock</a></b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
190</tr>
191<tr class="list">
192<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
193<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#DSock">DSock</a></b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FDSock;</code></td>
194</tr>
195<tr class="list2">
196<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
197<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#DataStream">DataStream</a></b>: TMemoryStream read FDataStream;</code></td>
198</tr>
199<tr class="list">
200<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
201<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#DataIP">DataIP</a></b>: string read FDataIP;</code></td>
202</tr>
203<tr class="list2">
204<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
205<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#DataPort">DataPort</a></b>: string read FDataPort;</code></td>
206</tr>
207<tr class="list">
208<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
209<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#DirectFile">DirectFile</a></b>: Boolean read FDirectFile Write FDirectFile;</code></td>
210</tr>
211<tr class="list2">
212<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
213<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#DirectFileName">DirectFileName</a></b>: string read FDirectFileName Write FDirectFileName;</code></td>
214</tr>
215<tr class="list">
216<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
217<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#CanResume">CanResume</a></b>: Boolean read FCanResume;</code></td>
218</tr>
219<tr class="list2">
220<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
221<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#PassiveMode">PassiveMode</a></b>: Boolean read FPassiveMode Write FPassiveMode;</code></td>
222</tr>
223<tr class="list">
224<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
225<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#ForceDefaultPort">ForceDefaultPort</a></b>: Boolean read FForceDefaultPort Write FForceDefaultPort;</code></td>
226</tr>
227<tr class="list2">
228<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
229<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#ForceOldPort">ForceOldPort</a></b>: Boolean read FForceOldPort Write FForceOldPort;</code></td>
230</tr>
231<tr class="list">
232<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
233<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#OnStatus">OnStatus</a></b>: <a href="ftpsend.html#TFTPStatus">TFTPStatus</a> read FOnStatus write FOnStatus;</code></td>
234</tr>
235<tr class="list2">
236<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
237<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#FtpList">FtpList</a></b>: <a href="ftpsend.TFTPList.html">TFTPList</a> read FFtpList;</code></td>
238</tr>
239<tr class="list">
240<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
241<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#BinaryMode">BinaryMode</a></b>: Boolean read FBinaryMode Write FBinaryMode;</code></td>
242</tr>
243<tr class="list2">
244<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
245<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#AutoTLS">AutoTLS</a></b>: Boolean read FAutoTLS Write FAutoTLS;</code></td>
246</tr>
247<tr class="list">
248<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
249<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#FullSSL">FullSSL</a></b>: Boolean read FFullSSL Write FFullSSL;</code></td>
250</tr>
251<tr class="list2">
252<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
253<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#IsTLS">IsTLS</a></b>: Boolean read FIsTLS;</code></td>
254</tr>
255<tr class="list">
256<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
257<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#IsDataTLS">IsDataTLS</a></b>: Boolean read FIsDataTLS;</code></td>
258</tr>
259<tr class="list2">
260<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
261<td class="itemcode"><code>property <b><a href="ftpsend.TFTPSend.html#TLSonData">TLSonData</a></b>: Boolean read FTLSonData write FTLSonData;</code></td>
262</tr>
263</table>
264<h2 class="description">Description</h2>
265<h3 class="detail">Fields</h3>
266<table class="detail">
267<tr class="list">
268<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
269<td class="itemcode"><a name="CustomLogon"></a><code><b>CustomLogon</b>: <a href="ftpsend.html#TLogonActions">TLogonActions</a>;</code></td>
270</tr>
271</table>
272<p>
273Custom definition of login sequence. You can use this when you set <a class="normal" href="ftpsend.TFTPSend.html#FWMode">FWMode</a> to value -1.</p>
274<h3 class="detail">Methods</h3>
275<table class="detail">
276<tr class="list">
277<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
278<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
279</tr>
280</table>
281&nbsp;<table class="detail">
282<tr class="list">
283<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
284<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
285</tr>
286</table>
287&nbsp;<table class="detail">
288<tr class="list">
289<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
290<td class="itemcode"><a name="ReadResult"></a><code>function <b>ReadResult</b>: Integer; virtual;</code></td>
291</tr>
292</table>
293<p>
294Waits and read FTP server response. You need this only in special cases!</p>
295<table class="detail">
296<tr class="list">
297<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
298<td class="itemcode"><a name="ParseRemote"></a><code>procedure <b>ParseRemote</b>(Value: string); virtual;</code></td>
299</tr>
300</table>
301<p>
302Parse remote side information of data channel from value string (returned by PASV command). This function you need only in special cases!</p>
303<table class="detail">
304<tr class="list">
305<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
306<td class="itemcode"><a name="ParseRemoteEPSV"></a><code>procedure <b>ParseRemoteEPSV</b>(Value: string); virtual;</code></td>
307</tr>
308</table>
309<p>
310Parse remote side information of data channel from value string (returned by EPSV command). This function you need only in special cases!</p>
311<table class="detail">
312<tr class="list">
313<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
314<td class="itemcode"><a name="FTPCommand"></a><code>function <b>FTPCommand</b>(const Value: string): integer; virtual;</code></td>
315</tr>
316</table>
317<p>
318Send Value as FTP command to FTP server. Returned result code is result of this function. This command is good for sending site specific command, or non-standard commands.</p>
319<table class="detail">
320<tr class="list">
321<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
322<td class="itemcode"><a name="Login"></a><code>function <b>Login</b>: Boolean; virtual;</code></td>
323</tr>
324</table>
325<p>
326Connect and logon to FTP server. If you specify any FireWall, connect to firewall and throw them connect to FTP server. Login sequence depending on <a class="normal" href="ftpsend.TFTPSend.html#FWMode">FWMode</a>.</p>
327<table class="detail">
328<tr class="list">
329<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
330<td class="itemcode"><a name="Logout"></a><code>function <b>Logout</b>: Boolean; virtual;</code></td>
331</tr>
332</table>
333<p>
334Logoff and disconnect from FTP server.</p>
335<table class="detail">
336<tr class="list">
337<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
338<td class="itemcode"><a name="Abort"></a><code>procedure <b>Abort</b>; virtual;</code></td>
339</tr>
340</table>
341<p>
342Break current transmission of data. (You can call this method from Sock.OnStatus event, or from another thread.)</p>
343<table class="detail">
344<tr class="list">
345<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
346<td class="itemcode"><a name="TelnetAbort"></a><code>procedure <b>TelnetAbort</b>; virtual;</code></td>
347</tr>
348</table>
349<p>
350Break current transmission of data. It is same as Abort, but it send abort telnet commands prior ABOR FTP command. Some servers need it. (You can call this method from Sock.OnStatus event, or from another thread.)</p>
351<table class="detail">
352<tr class="list">
353<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
354<td class="itemcode"><a name="List"></a><code>function <b>List</b>(Directory: string; NameList: Boolean): Boolean; virtual;</code></td>
355</tr>
356</table>
357<p>
358Download directory listing of Directory on FTP server. If Directory is empty string, download listing of current working directory. If NameList is <code>True</code>, download only names of files in directory. (internally use NLST command instead LIST command) If NameList is <code>False</code>, returned list is also parsed to <a class="normal" href="ftpsend.TFTPSend.html#FtpList">FtpList</a> property.</p>
359<table class="detail">
360<tr class="list">
361<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
362<td class="itemcode"><a name="RetrieveFile"></a><code>function <b>RetrieveFile</b>(const FileName: string; Restore: Boolean): Boolean; virtual;</code></td>
363</tr>
364</table>
365<p>
366Read data from FileName on FTP server. If Restore is <code>True</code> and server supports resume dowloads, download is resumed. (received is only rest of file)</p>
367<table class="detail">
368<tr class="list">
369<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
370<td class="itemcode"><a name="StoreFile"></a><code>function <b>StoreFile</b>(const FileName: string; Restore: Boolean): Boolean; virtual;</code></td>
371</tr>
372</table>
373<p>
374Send data to FileName on FTP server. If Restore is <code>True</code> and server supports resume upload, upload is resumed. (send only rest of file) In this case if remote file is same length as local file, nothing will be done. If remote file is larger then local, resume is disabled and file is transfered from begin!</p>
375<table class="detail">
376<tr class="list">
377<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
378<td class="itemcode"><a name="StoreUniqueFile"></a><code>function <b>StoreUniqueFile</b>: Boolean; virtual;</code></td>
379</tr>
380</table>
381<p>
382Send data to FTP server and assing unique name for this file.</p>
383<table class="detail">
384<tr class="list">
385<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
386<td class="itemcode"><a name="AppendFile"></a><code>function <b>AppendFile</b>(const FileName: string): Boolean; virtual;</code></td>
387</tr>
388</table>
389<p>
390Append data to FileName on FTP server.</p>
391<table class="detail">
392<tr class="list">
393<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
394<td class="itemcode"><a name="RenameFile"></a><code>function <b>RenameFile</b>(const OldName, NewName: string): Boolean; virtual;</code></td>
395</tr>
396</table>
397<p>
398Rename on FTP server file with OldName to NewName.</p>
399<table class="detail">
400<tr class="list">
401<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
402<td class="itemcode"><a name="DeleteFile"></a><code>function <b>DeleteFile</b>(const FileName: string): Boolean; virtual;</code></td>
403</tr>
404</table>
405<p>
406Delete file FileName on FTP server.</p>
407<table class="detail">
408<tr class="list">
409<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
410<td class="itemcode"><a name="FileSize"></a><code>function <b>FileSize</b>(const FileName: string): int64; virtual;</code></td>
411</tr>
412</table>
413<p>
414Return size of Filename file on FTP server. If command failed (i.e. not implemented), return -1.</p>
415<table class="detail">
416<tr class="list">
417<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
418<td class="itemcode"><a name="NoOp"></a><code>function <b>NoOp</b>: Boolean; virtual;</code></td>
419</tr>
420</table>
421<p>
422Send NOOP command to FTP server for preserve of disconnect by inactivity timeout.</p>
423<table class="detail">
424<tr class="list">
425<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
426<td class="itemcode"><a name="ChangeWorkingDir"></a><code>function <b>ChangeWorkingDir</b>(const Directory: string): Boolean; virtual;</code></td>
427</tr>
428</table>
429<p>
430Change currect working directory to Directory on FTP server.</p>
431<table class="detail">
432<tr class="list">
433<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
434<td class="itemcode"><a name="ChangeToParentDir"></a><code>function <b>ChangeToParentDir</b>: Boolean; virtual;</code></td>
435</tr>
436</table>
437<p>
438walk to upper directory on FTP server.</p>
439<table class="detail">
440<tr class="list">
441<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
442<td class="itemcode"><a name="ChangeToRootDir"></a><code>function <b>ChangeToRootDir</b>: Boolean; virtual;</code></td>
443</tr>
444</table>
445<p>
446walk to root directory on FTP server. (May not work with all servers properly!)</p>
447<table class="detail">
448<tr class="list">
449<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
450<td class="itemcode"><a name="DeleteDir"></a><code>function <b>DeleteDir</b>(const Directory: string): Boolean; virtual;</code></td>
451</tr>
452</table>
453<p>
454Delete Directory on FTP server.</p>
455<table class="detail">
456<tr class="list">
457<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
458<td class="itemcode"><a name="CreateDir"></a><code>function <b>CreateDir</b>(const Directory: string): Boolean; virtual;</code></td>
459</tr>
460</table>
461<p>
462Create Directory on FTP server.</p>
463<table class="detail">
464<tr class="list">
465<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
466<td class="itemcode"><a name="GetCurrentDir"></a><code>function <b>GetCurrentDir</b>: String; virtual;</code></td>
467</tr>
468</table>
469<p>
470Return current working directory on FTP server.</p>
471<table class="detail">
472<tr class="list">
473<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
474<td class="itemcode"><a name="DataRead"></a><code>function <b>DataRead</b>(const DestStream: TStream): Boolean; virtual;</code></td>
475</tr>
476</table>
477<p>
478Establish data channel to FTP server and retrieve data. This function you need only in special cases, i.e. when you need to implement some special unsupported FTP command!</p>
479<table class="detail">
480<tr class="list">
481<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
482<td class="itemcode"><a name="DataWrite"></a><code>function <b>DataWrite</b>(const SourceStream: TStream): Boolean; virtual;</code></td>
483</tr>
484</table>
485<p>
486Establish data channel to FTP server and send data. This function you need only in special cases, i.e. when you need to implement some special unsupported FTP command.</p>
487<h3 class="detail">Properties</h3>
488<table class="detail">
489<tr class="list">
490<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
491<td class="itemcode"><a name="ResultCode"></a><code>property <b>ResultCode</b>: Integer read FResultCode;</code></td>
492</tr>
493</table>
494<p>
495After FTP command contains result number of this operation.</p>
496<table class="detail">
497<tr class="list">
498<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
499<td class="itemcode"><a name="ResultString"></a><code>property <b>ResultString</b>: string read FResultString;</code></td>
500</tr>
501</table>
502<p>
503After FTP command contains main line of result.</p>
504<table class="detail">
505<tr class="list">
506<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
507<td class="itemcode"><a name="FullResult"></a><code>property <b>FullResult</b>: TStringList read FFullResult;</code></td>
508</tr>
509</table>
510<p>
511After any FTP command it contains all lines of FTP server reply.</p>
512<table class="detail">
513<tr class="list">
514<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
515<td class="itemcode"><a name="Account"></a><code>property <b>Account</b>: string read FAccount Write FAccount;</code></td>
516</tr>
517</table>
518<p>
519Account information used in some cases inside login sequence.</p>
520<table class="detail">
521<tr class="list">
522<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
523<td class="itemcode"><a name="FWHost"></a><code>property <b>FWHost</b>: string read FFWHost Write FFWHost;</code></td>
524</tr>
525</table>
526<p>
527Address of firewall. If empty string (default), firewall not used.</p>
528<table class="detail">
529<tr class="list">
530<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
531<td class="itemcode"><a name="FWPort"></a><code>property <b>FWPort</b>: string read FFWPort Write FFWPort;</code></td>
532</tr>
533</table>
534<p>
535port of firewall. standard value is same port as ftp server used. (21)</p>
536<table class="detail">
537<tr class="list">
538<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
539<td class="itemcode"><a name="FWUsername"></a><code>property <b>FWUsername</b>: string read FFWUsername Write FFWUsername;</code></td>
540</tr>
541</table>
542<p>
543Username for login to firewall. (if needed)</p>
544<table class="detail">
545<tr class="list">
546<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
547<td class="itemcode"><a name="FWPassword"></a><code>property <b>FWPassword</b>: string read FFWPassword Write FFWPassword;</code></td>
548</tr>
549</table>
550<p>
551password for login to firewall. (if needed)</p>
552<table class="detail">
553<tr class="list">
554<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
555<td class="itemcode"><a name="FWMode"></a><code>property <b>FWMode</b>: integer read FFWMode Write FFWMode;</code></td>
556</tr>
557</table>
558<p>
559Type of Firewall. Used only if you set some firewall address. Supported predefined firewall login sequences are described by comments in source file where you can see pseudocode decribing each sequence.</p>
560<table class="detail">
561<tr class="list">
562<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
563<td class="itemcode"><a name="Sock"></a><code>property <b>Sock</b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FSock;</code></td>
564</tr>
565</table>
566<p>
567Socket object used for TCP/IP operation on control channel. Good for seting OnStatus hook, etc.</p>
568<table class="detail">
569<tr class="list">
570<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
571<td class="itemcode"><a name="DSock"></a><code>property <b>DSock</b>: <a href="blcksock.TTCPBlockSocket.html">TTCPBlockSocket</a> read FDSock;</code></td>
572</tr>
573</table>
574<p>
575Socket object used for TCP/IP operation on data channel. Good for seting OnStatus hook, etc.</p>
576<table class="detail">
577<tr class="list">
578<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
579<td class="itemcode"><a name="DataStream"></a><code>property <b>DataStream</b>: TMemoryStream read FDataStream;</code></td>
580</tr>
581</table>
582<p>
583If you not use <a class="normal" href="ftpsend.TFTPSend.html#DirectFile">DirectFile</a> mode, all data transfers is made to or from this stream.</p>
584<table class="detail">
585<tr class="list">
586<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
587<td class="itemcode"><a name="DataIP"></a><code>property <b>DataIP</b>: string read FDataIP;</code></td>
588</tr>
589</table>
590<p>
591After data connection is established, contains remote side IP of this connection.</p>
592<table class="detail">
593<tr class="list">
594<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
595<td class="itemcode"><a name="DataPort"></a><code>property <b>DataPort</b>: string read FDataPort;</code></td>
596</tr>
597</table>
598<p>
599After data connection is established, contains remote side port of this connection.</p>
600<table class="detail">
601<tr class="list">
602<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
603<td class="itemcode"><a name="DirectFile"></a><code>property <b>DirectFile</b>: Boolean read FDirectFile Write FDirectFile;</code></td>
604</tr>
605</table>
606<p>
607Mode of data handling by data connection. If <code>False</code>, all data operations are made to or from <a class="normal" href="ftpsend.TFTPSend.html#DataStream">DataStream</a> TMemoryStream. If <code>True</code>, data operations is made directly to file in your disk. (filename is specified by <a class="normal" href="ftpsend.TFTPSend.html#DirectFileName">DirectFileName</a> property.) Dafault is <code>False</code>!</p>
608<table class="detail">
609<tr class="list">
610<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
611<td class="itemcode"><a name="DirectFileName"></a><code>property <b>DirectFileName</b>: string read FDirectFileName Write FDirectFileName;</code></td>
612</tr>
613</table>
614<p>
615Filename for direct disk data operations.</p>
616<table class="detail">
617<tr class="list">
618<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
619<td class="itemcode"><a name="CanResume"></a><code>property <b>CanResume</b>: Boolean read FCanResume;</code></td>
620</tr>
621</table>
622<p>
623Indicate after <a class="normal" href="ftpsend.TFTPSend.html#Login">Login</a> if remote server support resume downloads and uploads.</p>
624<table class="detail">
625<tr class="list">
626<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
627<td class="itemcode"><a name="PassiveMode"></a><code>property <b>PassiveMode</b>: Boolean read FPassiveMode Write FPassiveMode;</code></td>
628</tr>
629</table>
630<p>
631If true (default value), all transfers is made by passive method. It is safer method for various firewalls.</p>
632<table class="detail">
633<tr class="list">
634<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
635<td class="itemcode"><a name="ForceDefaultPort"></a><code>property <b>ForceDefaultPort</b>: Boolean read FForceDefaultPort Write FForceDefaultPort;</code></td>
636</tr>
637</table>
638<p>
639Force to listen for dataconnection on standard port (20). Default is <code>False</code>, dataconnections will be made to any non-standard port reported by PORT FTP command. This setting is not used, if you use passive mode.</p>
640<table class="detail">
641<tr class="list">
642<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
643<td class="itemcode"><a name="ForceOldPort"></a><code>property <b>ForceOldPort</b>: Boolean read FForceOldPort Write FForceOldPort;</code></td>
644</tr>
645</table>
646<p>
647When is <code>True</code>, then is disabled EPSV and EPRT support. However without this commands you cannot use IPv6! (Disabling of this commands is needed only when you are behind some crap firewall/NAT.</p>
648<table class="detail">
649<tr class="list">
650<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
651<td class="itemcode"><a name="OnStatus"></a><code>property <b>OnStatus</b>: <a href="ftpsend.html#TFTPStatus">TFTPStatus</a> read FOnStatus write FOnStatus;</code></td>
652</tr>
653</table>
654<p>
655You may set this hook for monitoring FTP commands and replies.</p>
656<table class="detail">
657<tr class="list">
658<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
659<td class="itemcode"><a name="FtpList"></a><code>property <b>FtpList</b>: <a href="ftpsend.TFTPList.html">TFTPList</a> read FFtpList;</code></td>
660</tr>
661</table>
662<p>
663After LIST command is here parsed list of files in given directory.</p>
664<table class="detail">
665<tr class="list">
666<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
667<td class="itemcode"><a name="BinaryMode"></a><code>property <b>BinaryMode</b>: Boolean read FBinaryMode Write FBinaryMode;</code></td>
668</tr>
669</table>
670<p>
671if <code>True</code> (default), then data transfers is in binary mode. If this is set to <code>False</code>, then ASCII mode is used.</p>
672<table class="detail">
673<tr class="list">
674<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
675<td class="itemcode"><a name="AutoTLS"></a><code>property <b>AutoTLS</b>: Boolean read FAutoTLS Write FAutoTLS;</code></td>
676</tr>
677</table>
678<p>
679if is true, then if server support upgrade to SSL/TLS mode, then use them.</p>
680<table class="detail">
681<tr class="list">
682<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
683<td class="itemcode"><a name="FullSSL"></a><code>property <b>FullSSL</b>: Boolean read FFullSSL Write FFullSSL;</code></td>
684</tr>
685</table>
686<p>
687if server listen on SSL/TLS port, then you set this to true.</p>
688<table class="detail">
689<tr class="list">
690<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
691<td class="itemcode"><a name="IsTLS"></a><code>property <b>IsTLS</b>: Boolean read FIsTLS;</code></td>
692</tr>
693</table>
694<p>
695Signalise, if control channel is in SSL/TLS mode.</p>
696<table class="detail">
697<tr class="list">
698<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
699<td class="itemcode"><a name="IsDataTLS"></a><code>property <b>IsDataTLS</b>: Boolean read FIsDataTLS;</code></td>
700</tr>
701</table>
702<p>
703Signalise, if data transfers is in SSL/TLS mode.</p>
704<table class="detail">
705<tr class="list">
706<td class="visibility"><a href="legend.html"><img src="published.gif" alt="Published" title="Published"></a></td>
707<td class="itemcode"><a name="TLSonData"></a><code>property <b>TLSonData</b>: Boolean read FTLSonData write FTLSonData;</code></td>
708</tr>
709</table>
710<p>
711If <code>True</code> (default), then try to use SSL/TLS on data transfers too. If <code>False</code>, then SSL/TLS is used only for control connection.</p>
712<hr noshade size="1"><span class="appinfo"><em>Generated by <a target="_parent" href="http://pasdoc.sourceforge.net/">PasDoc 0.9.0</a> on 2012-04-23 21:38:50</em>
713</span>
714</body></html>
Note: See TracBrowser for help on using the repository browser.