tfFtpHelp

Table of Contents >> Application Reference >> FTP Client API

#include <trsocket.h>

int tfFtpHelp	(
	ttUserFtpHandle ftpUserHandle,
	char * commandPtr,
	ttFtpCBFuncPtr ftpUserCBFuncPtr
	);

Function Description

This function retrieves help on the specified command from the remote FTP server. When this data is retrieved, a user-supplied function is called.

The prototype for the callback function is:

int ftpCBFunc	(
	ttUserFtpHandle ftpUserHandle,
	char * bufferPtr,
	int bufferSize
	);

Parameters

• ftpUserHandle

  The FTP session handle.

• commandPtr

  A pointer to the command to receive help on. This can be NULL.

• ftpUserCBFuncPtr

  A pointer to the user-supplied callback function to call for each received line of help.

Returns

• TM_ENOERROR

  Success.

• TM_WOULDBLOCK

  This FTP session is non-blocking and the call did not complete.

• TM_EACCES

  Previous command did not complete.

• TM_ENOTCONN

  The user is not currently connected to a FTP server.

• TM_EINVAL

  Invalid FTP session pointer.

• TM_FTP_SYNTAXCMD

  Syntax error, command unrecognized.

• TM_FTP_SYNTAXARG

  Syntax error in parameters or arguments.

• TM_FTP_NOCMD

  Command not implemented.

• TM_FTP_SERVNAVAIL

  Service not available, closing FTP connection.

Table of Contents >> Application Reference >> FTP Client API