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.

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.

Detailed Description

#include< ftp.h >

The NetBurner FTP Client Group

Function Documentation

◆ FTP_CloseSession()

int FTP_CloseSession ( int session )

#include <ftp.h>

Close a FTP session.

Parameters

session FTP session number to close

Returns: ftpClientReturnCodes

See also: FTP_InitializeSession()

◆ FTP_InitializeSession()

int FTP_InitializeSession	(	IPADDR4	server_address,
		uint16_t	port,
		PCSTR	UserName,
		PCSTR	Password,
		uint32_t	time_out )

#include <ftp.h>

Initialize a FTP session with a FTP server.

Open a connection to a FTP server and log in with the specified username and password. The session number returned from this call can be used with the file and directory functions.

Parameters

server_address	The IP address of the FTP server
port	The listen port number of the FTP server. Typically 21.
UserName	Log-in username
Password	Log-in password
time_out	Timeout in system Time Ticks

Returns: A value greater than 0 is a FTP session handle, otherwise ftpClientReturnCodes

See also: FTP_CloseSession()

◆ FTPActiveMode()

void FTPActiveMode ( int ftp_Session )

#include <ftp.h>

Set mode to active.

Parameters

ftp_Session FTP session number

◆ FTPDeleteDir()

int FTPDeleteDir	(	int	ftp_Session,
		const char *	dir_to_delete,
		uint16_t	timeout )

#include <ftp.h>

Delete a directory.

Parameters

ftp_Session	FTP session number
dir_to_delete	Directory to delete
timeout	Timeout in system Time Ticks

Returns: ftpClientReturnCodes

◆ FTPDeleteFile()

int FTPDeleteFile	(	int	ftp_Session,
		const char *	file_name,
		uint16_t	timeout )

#include <ftp.h>

Delete a file.

Parameters

ftp_Session	FTP session number
file_name	Name of file to delete
timeout	Timeout in system Time Ticks

Returns: ftpClientReturnCodes

◆ FTPGetCommandResult()

int FTPGetCommandResult	(	int	ftp_Session,
		char *	cmd_buf,
		int	nbytes,
		uint16_t	timeout )

#include <ftp.h>

Returns the result of the last FTP operation.

Queries the FTP server for the last FTP operation status.

Must be called after the following functions are used:

FTPGetList()
FTPFileNames()
FTPGetFile()
FTPSendFile()

Parameters

ftp_Session	FTP session number
cmd_buf	The buffer to hold the ASCII FTP server response. See FTP Server return codes for details.
nbytes	The maximum number of bytes cmd_buf can hold
timeout	Timeout in system Time Ticks

Returns: The FTP server response number on success, otherwise ftpClientReturnCodes

◆ FTPGetDir()

int FTPGetDir	(	int	ftp_Session,
		char *	dir_buf,
		int	nbytes,
		uint16_t	timeout )

#include <ftp.h>

Get the current working directory.

Parameters

ftp_Session	FTP session number
dir_buf	The buffer to copy the directory information into
nbytes	Maximum number of bytes in the dir_buf
timeout	Timeout in system Time Ticks

Returns: ftpClientReturnCodes

◆ FTPGetFile()

int FTPGetFile	(	int	ftp_Session,
		const char *	full_file_name,
		BOOL	bBinaryMode,
		uint16_t	timeout )

#include <ftp.h>

Initialize the process to get a file from a FTP server.

This function opens a TCP connection to a FTP server so that a file may be read. it will return a file descriptor that can then be used to read the file data using file I/O functions such as: read() and ReadWithTimeout().

IMPORTANT After reading the file data you must do 2 things:

The TCP connection must be closed with the close() function.
FTPGetCommandResult() must be called to check the result of the operation.

Parameters

ftp_Session	FTP session number
full_file_name	Full file name being read, including the path
bBinaryMode	True = read file as binary data, False = read file as ASCII data
timeout	Timeout in system Time Ticks

Returns: TCP file descriptor if greater than 0, otherwise ftpClientReturnCodes

int fd = FTPGetFile(ftp, "testfile.txt", FALSE, 5 * TICKS_PER_SECOND);    // Send file in ASCII mode
 
if (fd > 0)
{
    // Code to read all data from the file descriptor goes here
    close(fd);
 
    int rv = FTPGetCommandResult(ftpSession, resultBuffer, 80, 5 * TICKS_PER*SECOND );
 
    if ( rv != 226)   // Return code 226 = Closing data connection. Requested file action successful.
       iprintf("Read error result = %d %s\r\n", rv, resultBuffer);
}
else
{
    iprintf("Failed to read file\r\n");
}

◆ FTPGetFileNames()

int FTPGetFileNames	(	int	ftp_Session,
		const char *	full_dir_name,
		uint16_t	timeout )

#include <ftp.h>

Initialize the process to receive just the file names in a directory from a FTP server.

This function opens a TCP connection to a FTP server so that a list of file names may be read. it will return a file descriptor that can then be used to read the file data using file I/O functions such as: read() and ReadWithTimeout().

IMPORTANT After reading the file data you must do 2 things:

The TCP connection must be closed with the close() function.
FTPGetCommandResult() must be called to check the result of the operation.

Parameters

ftp_Session	FTP session number
full_dir_name	Full directory name to read, including the path
timeout	Timeout in system Time Ticks

Returns: TCP file descriptor if greater than 0, otherwise ftpClientReturnCodes

◆ FTPGetList()

int FTPGetList	(	int	ftp_Session,
		const char *	full_dir_name,
		uint16_t	timeout )

#include <ftp.h>

Initialize the process to receive a directory listing from a FTP server.

This function opens a TCP connection to a FTP server so that a directory list may be read. it will return a file descriptor that can then be used to read the file data using file I/O functions such as: read() and ReadWithTimeout().

IMPORTANT After reading the file data you must do 2 things:

The TCP connection must be closed with the close() function.
FTPGetCommandResult() must be called to check the result of the operation.

Parameters

ftp_Session	FTP session number
full_dir_name	Full directory name to read, including the path
timeout	Timeout in system Time Ticks

Returns: TCP file descriptor if greater than 0, otherwise ftpClientReturnCodes

◆ FTPMakeDir()

int FTPMakeDir	(	int	ftp_Session,
		const char *	dir_to_make,
		uint16_t	timeout )

#include <ftp.h>

Create a new directory.

Parameters

ftp_Session	FTP session number
dir_to_make	Directory to create
timeout	Timeout in system Time Ticks

Returns: ftpClientReturnCodes

◆ FTPPassiveMode()

void FTPPassiveMode ( int ftp_Session )

#include <ftp.h>

Set mode to passive.

Parameters

ftp_Session FTP session number

◆ FTPRawCommand()

int FTPRawCommand	(	int	ftp_Session,
		const char *	cmd,
		char *	cmd_buf,
		int	nbytes,
		uint16_t	timeout )

#include <ftp.h>

Send a FTP command to the FTP server.

Parameters

ftp_Session	FTP session number.
cmd	The command to send. Do not include termination such as `\r\n`.
cmd_buf	The buffer to hold the FTP server response, in ASCII.
nbytes	The maximum number of bytes the cmd_buf can hold.
timeout	Timeout in system Time Ticks.

Returns: The FTP server response code if greater than 0, otherwise ftpClientReturnCodes

◆ FTPRawStreamCommand()

int FTPRawStreamCommand	(	int	ftp_Session,
		const char *	cmd,
		int *	pResult,
		char *	cmd_buf,
		int	nbytes,
		uint16_t	timeout )

#include <ftp.h>

Send a command and receive a response over a stream connection.

The FTP server will close the connection after all the data has been read. This function is the basis for such functions as FTPGetList() and FTPGetFiles().

IMPORTANT After reading the file data you must call FTPGetCommandResult() to check the result of the operation.

Parameters

ftp_Session	FTP session number
cmd	Command to send
pResult	The server response code integer value
cmd_buf	The server response code ASCII value (including `\r\n`)
nbytes	Maximum number of bytes cmd_buf can hold
timeout	Timeout in system Time Ticks

Returns: TCP file descriptor if greater than 0, otherwise ftpClientReturnCodes

◆ FTPRenameFile()

int FTPRenameFile	(	int	ftp_Session,
		const char *	old_file_name,
		const char *	new_file_name,
		uint16_t	timeout )

#include <ftp.h>

Rename a file.

Parameters

ftp_Session	FTP session number
old_file_name	Name of file to rename
new_file_name	New name of file
timeout	Timeout in system Time Ticks

Returns: ftpClientReturnCodes

◆ FTPSendFile()

int FTPSendFile	(	int	ftp_Session,
		const char *	full_file_name,
		BOOL	bBinaryMode,
		uint16_t	timeout )

#include <ftp.h>

Initialize the process to send a file to s FTP server.

This function opens a TCP connection to a FTP server so that a file may be sent. it will return a file descriptor that can then be used to send the file data using file I/O write functions such as: write(), writeall(), writestring(), etc.

IMPORTANT After sending the file data you must do 2 things:

The TCP connection must be closed with the close() function.
FTPGetCommandResult() must be called to check the result of the operation.

Parameters

ftp_Session	FTP session number
full_file_name	Name of the file being sent
bBinaryMode	True = send file as binary data, False = send file as ASCII data
timeout	Timeout in system Time Ticks

Returns: TCP file descriptor if greater than 0, otherwise ftpClientReturnCodes

int fd = FTPSendFile(ftp, "testfile.txt", FALSE, 5 * TICKS_PER_SECOND);    // Send file in ASCII mode
 
if (fd > 0)
{
    writestring(fd, "This is a test file\r\n");
    writestring(fd, "This is line 2 of the test file\r\n");
    writestring(fd, "Last Line\r\n");
    close(fd);
 
    int rv = FTPGetCommandResult(ftpSession, resultBuffer, 80, 5 * TICKS_PER*SECOND );
 
    if ( rv != 226)   // Return code 226 = Closing data connection. Requested file action successful.
       iprintf("Write error result = %d %s\r\n", rv, resultBuffer);
}
else
{
    iprintf("Failed to send file\r\n");
}

◆ FTPSetDir()

int FTPSetDir	(	int	ftp_Session,
		const char *	new_dir,
		uint16_t	timeout )

#include <ftp.h>

Set the current working directory.

Parameters

ftp_Session	FTP session number
new_dir	Directory path to set
timeout	Timeout in system Time Ticks

Returns: ftpClientReturnCodes

◆ FTPUpDir()

int FTPUpDir	(	int	ftp_Session,
		uint16_t	timeout )

#include <ftp.h>

Move up one directory level.

Parameters

ftp_Session	FTP session number
timeout	Timeout in system Time Ticks

Returns: ftpClientReturnCodes

Functions

FTP Client Return Codes

Detailed Description

Function Documentation

◆ FTP_CloseSession()

◆ FTP_InitializeSession()

◆ FTPActiveMode()

◆ FTPDeleteDir()

◆ FTPDeleteFile()

◆ FTPGetCommandResult()

◆ FTPGetDir()

◆ FTPGetFile()

◆ FTPGetFileNames()

◆ FTPGetList()

◆ FTPMakeDir()

◆ FTPPassiveMode()

◆ FTPRawCommand()

◆ FTPRawStreamCommand()

◆ FTPRenameFile()

◆ FTPSendFile()

◆ FTPSetDir()

◆ FTPUpDir()