NetBurner 3.5.0
PDF Version
 
ftp.h File Reference

NetBurner FTP Client API. More...

#include <nettypes.h>

Go to the source code of this file.

Macros

FTP Client Return Codes

#define FTP_OK   (0)
 OK.
 
#define FTP_TIMEOUT   (-1)
 Timeout.
 
#define FTP_PASSWORDERROR   (-2)
 Password error.
 
#define FTP_CONNECTFAIL   (-3)
 Connection failed.
 
#define FTP_COMMANDFAIL   (-4)
 Command failed.
 
#define FTP_COMMANDERROR   (-4)
 Command error.
 
#define FTP_BADSESSION   (-5)
 Bad session.
 
#define FTP_NETWORKERROR   (-6)
 Network error.
 

Functions

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.
 
int FTP_CloseSession (int session)
 Close a FTP session.
 
int FTPGetDir (int ftp_Session, char *dir_buf, int nbytes, uint16_t timeout)
 Get the current working directory.
 
int FTPSetDir (int ftp_Session, const char *new_dir, uint16_t timeout)
 Set the current working directory.
 
int FTPDeleteDir (int ftp_Session, const char *dir_to_delete, uint16_t timeout)
 Delete a directory.
 
int FTPMakeDir (int ftp_Session, const char *dir_to_make, uint16_t timeout)
 Create a new directory.
 
int FTPUpDir (int ftp_Session, uint16_t timeout)
 Move up one directory level.
 
int FTPDeleteFile (int ftp_Session, const char *file_name, uint16_t timeout)
 Delete a file.
 
int FTPRenameFile (int ftp_Session, const char *old_file_name, const char *new_file_name, uint16_t timeout)
 Rename a file.
 
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 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 FTPGetList (int ftp_Session, const char *full_dir_name, uint16_t timeout)
 Initialize the process to receive a directory listing from a 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 FTPRawCommand (int ftp_Session, const char *cmd, char *cmd_buf, int nbytes, uint16_t timeout)
 Send a FTP command to the FTP server.
 
int FTPGetCommandResult (int ftp_Session, char *cmd_buf, int nbytes, uint16_t timeout)
 Returns the result of the last FTP operation.
 
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.
 
void FTPActiveMode (int ftp_Session)
 Set mode to active.
 
void FTPPassiveMode (int ftp_Session)
 Set mode to passive.
 

Detailed Description

NetBurner FTP Client API.