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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="tabs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="logo">
<img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
</div>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="namespaces.htm"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.htm"><span>Classes</span></a></li>
<li><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.htm"><span>Alphabetical List</span></a></li>
<li><a href="annotated.htm"><span>Class List</span></a></li>
<li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1Ftp.htm">Ftp</a></div>
<h1>sf::Ftp Class Reference</h1><!-- doxytag: class="sf::Ftp" --><!-- doxytag: inherits="sf::NonCopyable" -->This class provides methods for manipulating the FTP protocol (described in RFC 959).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Ftp_8hpp-source.htm">Ftp.hpp</a>></code>
<p>
<p>Inheritance diagram for sf::Ftp:
<p><center><img src="classsf_1_1Ftp.png" usemap="#sf::Ftp_map" border="0" alt=""></center>
<map name="sf::Ftp_map">
<area href="structsf_1_1NonCopyable.htm" alt="sf::NonCopyable" shape="rect" coords="0,0,105,24">
</map>
<a href="classsf_1_1Ftp-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cb">TransferMode</a> { <br>
<a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cb6f253b362639fb5e059dc292762a21ee">Binary</a>,
<br>
<a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cbc9e544a22dce8ef3177449cb235d15c2">Ascii</a>,
<br>
<a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cbbb1e34435231e73c96534c71090be7f4">Ebcdic</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of transfer modes. <a href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cb">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#2edfa8e9009caf27bce74459ae76dc52">~Ftp</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor -- close the connection with the server. <a href="#2edfa8e9009caf27bce74459ae76dc52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#8fee5fc52934a4dfef076303b71995d8">Connect</a> (const <a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> &Server, unsigned short Port=21, float Timeout=0.f)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to the specified FTP server. <a href="#8fee5fc52934a4dfef076303b71995d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#45c9d8037f328aeae34b4eca7f277792">Login</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Log in using anonymous account. <a href="#45c9d8037f328aeae34b4eca7f277792"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#4d40a0f1d9c900eb7be7558f41a896b6">Login</a> (const std::string &UserName, const std::string &Password)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Log in using a username and a password. <a href="#4d40a0f1d9c900eb7be7558f41a896b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#384c7cc9b9b2b56a913d2c1b19be6053">Disconnect</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the connection with FTP server. <a href="#384c7cc9b9b2b56a913d2c1b19be6053"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#43455f62fe8ebec663d16e9f58c07b3d">KeepAlive</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a null command just to prevent from being disconnected. <a href="#43455f62fe8ebec663d16e9f58c07b3d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1DirectoryResponse.htm">DirectoryResponse</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#9eead95300df9c6fbbdb5b9f4ed546e6">GetWorkingDirectory</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current working directory. <a href="#9eead95300df9c6fbbdb5b9f4ed546e6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1ListingResponse.htm">ListingResponse</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#73d8e6222d3be4f70b9b6e8c5203be13">GetDirectoryListing</a> (const std::string &Directory="")</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the contents of the given directory (subdirectories and files). <a href="#73d8e6222d3be4f70b9b6e8c5203be13"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#4c3b2d61ea3b14512d62230c8d7ed16a">ChangeDirectory</a> (const std::string &Directory)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the current working directory. <a href="#4c3b2d61ea3b14512d62230c8d7ed16a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#0a87e424524a3b9a859401523f3fbe25">ParentDirectory</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Go to the parent directory of the current one. <a href="#0a87e424524a3b9a859401523f3fbe25"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#041469cd9933e25ff5b7e8e416268052">MakeDirectory</a> (const std::string &Name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new directory. <a href="#041469cd9933e25ff5b7e8e416268052"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#3134faf8de7dd67eccb0f368b628bc0e">DeleteDirectory</a> (const std::string &Name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an existing directory. <a href="#3134faf8de7dd67eccb0f368b628bc0e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#fc5a927da340c9098b81f770505197c8">RenameFile</a> (const std::string &File, const std::string &NewName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Rename a file. <a href="#fc5a927da340c9098b81f770505197c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#9bc9010d8f91446fec5574565ff07b4f">DeleteFile</a> (const std::string &Name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an existing file. <a href="#9bc9010d8f91446fec5574565ff07b4f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#3a2f842d29d83f7f036a32769ffd273d">Download</a> (const std::string &DistantFile, const std::string &DestPath, <a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cb">TransferMode</a> Mode=Binary)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Download a file from the server. <a href="#3a2f842d29d83f7f036a32769ffd273d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#6108cc321164bea360ca29b1e720051e">Upload</a> (const std::string &LocalFile, const std::string &DestPath, <a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cb">TransferMode</a> Mode=Binary)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Upload a file to the server. <a href="#6108cc321164bea360ca29b1e720051e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8dee57337b6a7e183bfe21d178757b0c"></a><!-- doxytag: member="sf::Ftp::DataChannel" ref="8dee57337b6a7e183bfe21d178757b0c" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp.htm#8dee57337b6a7e183bfe21d178757b0c">DataChannel</a></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp_1_1DirectoryResponse.htm">DirectoryResponse</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specialization of FTP response returning a directory. <a href="classsf_1_1Ftp_1_1DirectoryResponse.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp_1_1ListingResponse.htm">ListingResponse</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specialization of FTP response returning a filename lisiting. <a href="classsf_1_1Ftp_1_1ListingResponse.htm#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This class wraps a FTP response, which is basically :<ul>
<li>a status code</li><li>a message. </li></ul>
<a href="classsf_1_1Ftp_1_1Response.htm#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class provides methods for manipulating the FTP protocol (described in RFC 959).
<p>
It provides easy access and transfers to remote directories and files on a FTP server
<p>
<p>
Definition at line <a class="el" href="Ftp_8hpp-source.htm#l00047">47</a> of file <a class="el" href="Ftp_8hpp-source.htm">Ftp.hpp</a>.<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="1cd6b89ad23253f6d97e6d4ca4d558cb"></a><!-- doxytag: member="sf::Ftp::TransferMode" ref="1cd6b89ad23253f6d97e6d4ca4d558cb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cb">sf::Ftp::TransferMode</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enumeration of transfer modes.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="1cd6b89ad23253f6d97e6d4ca4d558cb6f253b362639fb5e059dc292762a21ee"></a><!-- doxytag: member="Binary" ref="1cd6b89ad23253f6d97e6d4ca4d558cb6f253b362639fb5e059dc292762a21ee" args="" -->Binary</em> </td><td>
Binary mode (file is transfered as a sequence of bytes). </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1cd6b89ad23253f6d97e6d4ca4d558cbc9e544a22dce8ef3177449cb235d15c2"></a><!-- doxytag: member="Ascii" ref="1cd6b89ad23253f6d97e6d4ca4d558cbc9e544a22dce8ef3177449cb235d15c2" args="" -->Ascii</em> </td><td>
Text mode using ASCII encoding. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="1cd6b89ad23253f6d97e6d4ca4d558cbbb1e34435231e73c96534c71090be7f4"></a><!-- doxytag: member="Ebcdic" ref="1cd6b89ad23253f6d97e6d4ca4d558cbbb1e34435231e73c96534c71090be7f4" args="" -->Ebcdic</em> </td><td>
Text mode using EBCDIC encoding. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="Ftp_8hpp-source.htm#l00054">54</a> of file <a class="el" href="Ftp_8hpp-source.htm">Ftp.hpp</a>.
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2edfa8e9009caf27bce74459ae76dc52"></a><!-- doxytag: member="sf::Ftp::~Ftp" ref="2edfa8e9009caf27bce74459ae76dc52" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::Ftp::~Ftp </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor -- close the connection with the server.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8fee5fc52934a4dfef076303b71995d8"></a><!-- doxytag: member="sf::Ftp::Connect" ref="8fee5fc52934a4dfef076303b71995d8" args="(const IPAddress &Server, unsigned short Port=21, float Timeout=0.f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::Connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1IPAddress.htm">IPAddress</a> & </td>
<td class="paramname"> <em>Server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"> <em>Port</em> = <code>21</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>Timeout</em> = <code>0.f</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect to the specified FTP server.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Server</em> </td><td>: FTP server to connect to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Port</em> </td><td>: Port used for connection (21 by default, standard FTP port) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Timeout</em> </td><td>: Maximum time to wait, in seconds (0 by default, means no timeout)</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="45c9d8037f328aeae34b4eca7f277792"></a><!-- doxytag: member="sf::Ftp::Login" ref="45c9d8037f328aeae34b4eca7f277792" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::Login </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Log in using anonymous account.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="4d40a0f1d9c900eb7be7558f41a896b6"></a><!-- doxytag: member="sf::Ftp::Login" ref="4d40a0f1d9c900eb7be7558f41a896b6" args="(const std::string &UserName, const std::string &Password)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::Login </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>UserName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>Password</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Log in using a username and a password.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>UserName</em> </td><td>: User name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Password</em> </td><td>: Password</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="384c7cc9b9b2b56a913d2c1b19be6053"></a><!-- doxytag: member="sf::Ftp::Disconnect" ref="384c7cc9b9b2b56a913d2c1b19be6053" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::Disconnect </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close the connection with FTP server.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="43455f62fe8ebec663d16e9f58c07b3d"></a><!-- doxytag: member="sf::Ftp::KeepAlive" ref="43455f62fe8ebec663d16e9f58c07b3d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::KeepAlive </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Send a null command just to prevent from being disconnected.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="9eead95300df9c6fbbdb5b9f4ed546e6"></a><!-- doxytag: member="sf::Ftp::GetWorkingDirectory" ref="9eead95300df9c6fbbdb5b9f4ed546e6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1DirectoryResponse.htm">DirectoryResponse</a> sf::Ftp::GetWorkingDirectory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current working directory.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="73d8e6222d3be4f70b9b6e8c5203be13"></a><!-- doxytag: member="sf::Ftp::GetDirectoryListing" ref="73d8e6222d3be4f70b9b6e8c5203be13" args="(const std::string &Directory="")" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1ListingResponse.htm">ListingResponse</a> sf::Ftp::GetDirectoryListing </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>Directory</em> = <code>""</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the contents of the given directory (subdirectories and files).
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Directory</em> </td><td>: Directory to list ("" by default, the current one)</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="4c3b2d61ea3b14512d62230c8d7ed16a"></a><!-- doxytag: member="sf::Ftp::ChangeDirectory" ref="4c3b2d61ea3b14512d62230c8d7ed16a" args="(const std::string &Directory)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::ChangeDirectory </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>Directory</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the current working directory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Directory</em> </td><td>: New directory, relative to the current one</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="0a87e424524a3b9a859401523f3fbe25"></a><!-- doxytag: member="sf::Ftp::ParentDirectory" ref="0a87e424524a3b9a859401523f3fbe25" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::ParentDirectory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Go to the parent directory of the current one.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="041469cd9933e25ff5b7e8e416268052"></a><!-- doxytag: member="sf::Ftp::MakeDirectory" ref="041469cd9933e25ff5b7e8e416268052" args="(const std::string &Name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::MakeDirectory </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>Name</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new directory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Name</em> </td><td>: Name of the directory to create</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="3134faf8de7dd67eccb0f368b628bc0e"></a><!-- doxytag: member="sf::Ftp::DeleteDirectory" ref="3134faf8de7dd67eccb0f368b628bc0e" args="(const std::string &Name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::DeleteDirectory </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>Name</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove an existing directory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Name</em> </td><td>: Name of the directory to remove</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="fc5a927da340c9098b81f770505197c8"></a><!-- doxytag: member="sf::Ftp::RenameFile" ref="fc5a927da340c9098b81f770505197c8" args="(const std::string &File, const std::string &NewName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::RenameFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>File</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>NewName</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Rename a file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>File</em> </td><td>: File to rename </td></tr>
<tr><td valign="top"></td><td valign="top"><em>NewName</em> </td><td>: New name</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="9bc9010d8f91446fec5574565ff07b4f"></a><!-- doxytag: member="sf::Ftp::DeleteFile" ref="9bc9010d8f91446fec5574565ff07b4f" args="(const std::string &Name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::DeleteFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>Name</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove an existing file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Name</em> </td><td>: File to remove</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="3a2f842d29d83f7f036a32769ffd273d"></a><!-- doxytag: member="sf::Ftp::Download" ref="3a2f842d29d83f7f036a32769ffd273d" args="(const std::string &DistantFile, const std::string &DestPath, TransferMode Mode=Binary)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::Download </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>DistantFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>DestPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cb">TransferMode</a> </td>
<td class="paramname"> <em>Mode</em> = <code>Binary</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Download a file from the server.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>DistantFile</em> </td><td>: Path of the distant file to download </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DestPath</em> </td><td>: Where to put to file on the local computer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mode</em> </td><td>: Transfer mode (binary by default)</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<a class="anchor" name="6108cc321164bea360ca29b1e720051e"></a><!-- doxytag: member="sf::Ftp::Upload" ref="6108cc321164bea360ca29b1e720051e" args="(const std::string &LocalFile, const std::string &DestPath, TransferMode Mode=Binary)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Ftp_1_1Response.htm">Response</a> sf::Ftp::Upload </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>LocalFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>DestPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsf_1_1Ftp.htm#1cd6b89ad23253f6d97e6d4ca4d558cb">TransferMode</a> </td>
<td class="paramname"> <em>Mode</em> = <code>Binary</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Upload a file to the server.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>LocalFile</em> </td><td>: Path of the local file to upload </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DestPath</em> </td><td>: Where to put to file on the server </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Mode</em> </td><td>: Transfer mode (binary by default)</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Server response to the request </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Ftp_8hpp-source.htm">Ftp.hpp</a></ul>
<p id="footer">
:: Copyright © 2007-2008 Laurent Gomila, all rights reserved ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> ::
</p>
</body>
</html>
|
