NetBurner 3.5.0
PDF Version
 
ftp.h
Go to the documentation of this file.
1/*NB_REVISION*/
2
3/*NB_COPYRIGHT*/
4
16#ifndef _NB_FTP_H
17#define _NB_FTP_H
18
19#include <nettypes.h>
20
26#define FTP_OK (0)
27#define FTP_TIMEOUT (-1)
28#define FTP_PASSWORDERROR (-2)
29#define FTP_CONNECTFAIL (-3)
30#define FTP_COMMANDFAIL (-4)
31#define FTP_COMMANDERROR (-4)
32#define FTP_BADSESSION (-5)
33#define FTP_NETWORKERROR (-6)
53int FTP_InitializeSession(IPADDR4 server_address, uint16_t port, PCSTR UserName, PCSTR Password, uint32_t time_out);
54
65int FTP_CloseSession(int session);
66
78int FTPGetDir(int ftp_Session, char *dir_buf, int nbytes, uint16_t timeout);
79
90int FTPSetDir(int ftp_Session, const char *new_dir, uint16_t timeout);
91
102int FTPDeleteDir(int ftp_Session, const char *dir_to_delete, uint16_t timeout);
103
114int FTPMakeDir(int ftp_Session, const char *dir_to_make, uint16_t timeout);
115
125int FTPUpDir(int ftp_Session, uint16_t timeout);
126
137int FTPDeleteFile(int ftp_Session, const char *file_name, uint16_t timeout);
138
150int FTPRenameFile(int ftp_Session, const char *old_file_name, const char *new_file_name, uint16_t timeout);
151
192int FTPSendFile(int ftp_Session, const char *full_file_name, BOOL bBinaryMode, uint16_t timeout);
193
232int FTPGetFile(int ftp_Session, const char *full_file_name, BOOL bBinaryMode, uint16_t timeout);
233
252int FTPGetList(int ftp_Session, const char *full_dir_name, uint16_t timeout);
253
272int FTPGetFileNames(int ftp_Session, const char *full_dir_name, uint16_t timeout);
273
286int FTPRawCommand(int ftp_Session, const char *cmd, char *cmd_buf, int nbytes, uint16_t timeout);
287
307int FTPGetCommandResult(int ftp_Session, char *cmd_buf, int nbytes, uint16_t timeout);
308
327int FTPRawStreamCommand(int ftp_Session, const char *cmd, int *pResult, char *cmd_buf, int nbytes, uint16_t timeout);
328
335void FTPActiveMode(int ftp_Session);
336
343void FTPPassiveMode(int ftp_Session);
344
345#endif
346
Used to store and manipulate IPv4 addresses in dual stack mode.
Definition nettypes.h:208
int FTPRenameFile(int ftp_Session, const char *old_file_name, const char *new_file_name, uint16_t timeout)
Rename a file.
int FTPRawStreamCommand(int ftp_Session, const char *cmd, int *pResult, char *cmd_buf, int nbytes, uint16_t timeout)
Send a command and receive a response over a stream connection.
int FTPSendFile(int ftp_Session, const char *full_file_name, BOOL bBinaryMode, uint16_t timeout)
Initialize the process to send a file to s FTP server.
int FTPGetList(int ftp_Session, const char *full_dir_name, uint16_t timeout)
Initialize the process to receive a directory listing from a FTP server.
void FTPActiveMode(int ftp_Session)
Set mode to active.
int FTPRawCommand(int ftp_Session, const char *cmd, char *cmd_buf, int nbytes, uint16_t timeout)
Send a FTP command to the FTP server.
int FTPGetFileNames(int ftp_Session, const char *full_dir_name, uint16_t timeout)
Initialize the process to receive just the file names in a directory from a FTP server.
int FTPDeleteDir(int ftp_Session, const char *dir_to_delete, uint16_t timeout)
Delete a directory.
int FTPGetCommandResult(int ftp_Session, char *cmd_buf, int nbytes, uint16_t timeout)
Returns the result of the last FTP operation.
int FTPMakeDir(int ftp_Session, const char *dir_to_make, uint16_t timeout)
Create a new directory.
int FTPSetDir(int ftp_Session, const char *new_dir, uint16_t timeout)
Set the current working directory.
int FTP_CloseSession(int session)
Close a FTP session.
int FTPDeleteFile(int ftp_Session, const char *file_name, uint16_t timeout)
Delete a file.
int FTPUpDir(int ftp_Session, uint16_t timeout)
Move up one directory level.
int FTPGetFile(int ftp_Session, const char *full_file_name, BOOL bBinaryMode, uint16_t timeout)
Initialize the process to get a file from a FTP server.
int FTP_InitializeSession(IPADDR4 server_address, uint16_t port, PCSTR UserName, PCSTR Password, uint32_t time_out)
Initialize a FTP session with a FTP server.
void FTPPassiveMode(int ftp_Session)
Set mode to passive.
int FTPGetDir(int ftp_Session, char *dir_buf, int nbytes, uint16_t timeout)
Get the current working directory.
NetBurner IPADDR4 Class. See the IPADDR4 Class page for complete documentation.