IFTPConnection Interface

The IFTPConnection interface is implemented by the FTPConnectionMTA and the FTPConnectionSTA class.

IFTPConnection

IDL

interface IFTPConnection : IDispatch;

VBScript

Dim objFTP
Set objFTP = CreateObject("sfFTPLib.FTPConnectionSTA")
...
Set objFTP = Nothing

JavaScript

Copy Code

var objFTP = new ActiveXObject("sfFTPLib.FTPConnectionSTA");

Copy Code

CFTPConnectionMTA ftp = new CFTPConnectionMTA();

C++

Copy Code

#import "libid:7A3A786C-EB8C-43b3-BC10-8D09ACF5D195" version("1.5")
// Note: Uncomment for Microsoft Visual Studio 6.0
//#import "C:\Program Files\SmartFTP FTP Library\sfFTPLib.dll"

::CoInitializeEx(0, COINIT_MULTITHREADED); // Init COM
sfFTPLib :: IFTPConnectionPtr m_FTP;
m_FTP.CreateInstance(__uuidof(sfFTPLib::FTPConnectionMTA));
::CoUninitialize();

IFTPConnection Methods

IFTPConnection Methods	Description
Abort	Aborts the current operation. The OnAbort event is fired once the operation completed.
ChangeDirectory	Changes the current/working directory on the server.
ChangeDirectoryUp	Sends the CDUP command to the server to go up one directory.
ClearCommandChannel	Clears the command channel by sending a CCC command. If the CCC server reply is successful the control connection continues in non-secure mode.
Close	Closes the connection. To ungracefully close the connection use the Disconnect method.
Command	Sends the specified command to the server.
Connect	Connects to remote host.
Continue	Continues a pending operation. This method can resume an operation which returned with ftpErrorPaused or ftpErrorMoreData.
CopyFile	This is CopyFile, a member of class IFTPConnection.
DeleteFile	Deletes a file from the server.
Disconnect	Disconnects from the remote host. To ungracefully close the connection use the Close method.
Download	This is Download, a member of class IFTPConnection.
DownloadFile	Downloads a file.
DownloadFileEx	Downloads a specified remote file to a specified local file.
DownloadFileEx2	This is DownloadFileEx2, a member of class IFTPConnection.
FXPDownloadFile	FXP downloads a specified remote file.
FXPUploadFile	FXP uploads a specified remote file.
GetFileHash	Retrieves the hash value of a file or portion specified with nStart and nLen.
GetFileSize	Retrieves the size of a specified file.
GetMLST	Retrieves the machine list of the specified file.
GetModifyTime	Retrieves the last modified time of a specified file. On success the result is saved in the LastFileTime property.
GetSpaceAvailable	This is GetSpaceAvailable, a member of class IFTPConnection.
InitializeTransfer	Initializes a data transfer.
MakeDirectory	Makes/Creates a new directory. The clients sends a MKD command to create a new directory on the server.
NewFile	Creates a new empty file. The clients sends the STOR command to create a new empty file on the server.
ReadDirectory	Reads the content of the current working directory. The result is stored in the Items property.
ReadDirectoryFromCommand	Reads the content of the current working directory. The result is stored in the Directory property.
ReadDirectoryRaw	Reads the content of the current working directory and saves it into the specified local file.
ReadDirectoryRawFromCommand	Reads the content of the current working directory and saves it into a specified local file. The function sends the command supplied in the argument directly to the server and opens a data connection for the directory listing.
RemoveDirectory	Removes the specified directory. The client sends a RMD command to remove the directory. Due to the nature of FTP the directory is not removed if it's not empty.
RenameDirectory	Renames the specified directory. The client sends RNFR to initiate a rename and completes it with RNTO.
RenameFile	Renames a file. The client sends RNFR to initiate a rename and completes it with RNTO.
SetCreateTime	Sets the creation time of the file.
SetCreateTimeAsDate	Wrapper for SetCreateTime.
SetModifyTime	Sets the last modified time of the file.
SetModifyTimeAsDate	Wrapper for SetModifyTime.
SetUnixAttributes	Sets the unix attributes of a remote file or folder. The client sends a SITE CHMOD command. If the FTP command is not supported the function fails.
Stat	Sends STAT command to retrieve statistics or file listing.
Uninit	Uninitializes object and stops internal thread.
UpdateWorkingDirectory	Updates the WorkingDirectory property by sending a PWD command to the server.
UploadFile	Uploads a specified local file to a specified remote file.
UploadFileEx	Uploads a specified local file to a specified remote file.
WaitForReturn	Reserved.

IFTPConnection Properties

IFTPConnection Properties	Description
Account	The account name being used together with the ACCT command. Default: empty
Async	Set asynchronous mode. Default: false
BaseSocketLayer	This is BaseSocketLayer, a member of class IFTPConnection.
Busy	Indicates whether an operation is in progress or paused.
ClientId	Retrieves the ClientId object.
CodePage	Specifies the code page used to perform conversations. Default: -1 (Auto).
CommandProtection	Specified whether the protection of command channel (control connection). Default: ftpDataProtectionPrivate
ConnectionStatus	Contains the connection status.
DataProtection	The protection for secure data transfers. Default: ftpDataProtectionClear
DataTransferKeepAlive	When enabled a NOOP command is sent every 30 seconds during a data transfer.
DataTransferMode	The data transfer mode. Default: ftpDataTransferModeStream
DataTransferSpeedLimit	The speed limit in bytes/second of the data transfer. Default: 0 (no limit)
DataTransferType	The data transfer type. Default: ftpDataTransferTypeImage
FEAT	Specifies if the FEAT command is sent. Default: true
FileBufferSize	The size of the buffer in bytes when reading data from a local file. Default: 32768
FTPProxy	Contains the FTPProxy object.
HidePassword	Specifies whether the password is replaced with "(hidden)" in the OnStatus method and in the log file. Default: true
Host	Host name of the server.
IPRepeater	Contains the URL to the IP repeater. Default: empty
Items	Contains the items of the last successful call to the ReadDirectory method.
LastBytesWritten	Contains the number of bytes written during the last transfer.
LastCommand	Contains the last command sent to the server.
LastDataConnectionError	Returns the data connection error.
LastError	Contains the error value from the last operation.
LastFileHash	Contains the hash value represented as a hex string from the last successful call to the GetFileHash method.
LastFileSize	Contains the file size of the last successful call to the GetFileSize method.
LastFileSizeHi	Contains the file size (high 32-bit integer) of the last successful call to the GetFileSize method.
LastFileSizeLo	Contains the file size (low 32-bit integer) of the last successful call to the GetFileSize method.
LastFileTime	Contains the file time from the last successful call to the GetModifyTime or GetCreateTime method.
LastFileTimeAsDate	Contains the file time as a date/double from of the last successful call to to the GetModifyTime or GetCreateTime method.
LastItem	Contains the last FTPItem.
LastReply	Contains the last server reply.
LastReplyCode	Contains the 3 digit reply code of the last server reply.
LastSpaceAvailable	This is LastSpaceAvailable, a member of class IFTPConnection.
LastTransferBytes	Contains the number of transferred bytes (64-bit) during the last data transfer.
LastTransferBytesHi	Contains the number of transferred bytes (high 32-bit integer) during the last data transfer.
LastTransferBytesLo	Contains the number of transferred bytes (low 32-bit integer) during the last data transfer.
LastTransferSpeed	Contains the average transfer speed in bytes/second of the last data transfer.
LastTransferStartPosition	The start position of the last data transfer.
LastTransferStartPositionHi	The start position (high 32-bit integer) of the last data transfer.
LastTransferStartPositionLo	The start position (low 32-bit integer) of the last data transfer.
LastTransferTime	Contains the total time in milliseconds of the last data transfer.
LimitLocalPortRange	Specifies whether to use the ports provided by the IFTPPortPool. Default: false
LimitSocketLayer	This is LimitSocketLayer, a member of class IFTPConnection.
LISTOption	Specifies the LIST options to be used for the LIST command.
LogFile	This is LogFile, a member of class IFTPConnection.
Login	If true client sends USER/PASS/ACCT pair to login. Default: true
MLST	Specifies whether to use the MLSD command to list directories. Default: true
Passive	Specifies whether to use passive mode. Default: true
PassiveAddress
PassiveForceIP	Specifies whether to force using the server IP address for passive mode. Default: true
Password	The password to login to the FTP server.
PeerName	Contains the IP address of the peer. The value is represented as a string in the following format: a.b.c.d
Port	The port number of the server. Default: 21
PortIP	The IP address being used when PortMode is set to ftpPortModeManual. Default: empty
PortMode	Specifies the port mode for the PORT command. Default: ftpPortModeDefault
PROTFallback	Specifies whether to fall back to PROT C if PROT P fails. Default: true
Protocol	Specifies the protocol for the FTP connection. Default: ftpProtocolNormal
ProtocolFamily	Specifies the protocol family of the connection. Default: ftpProtocolFamilyUNSPEC
ProtocolFamilyPreference	The preferred protocol family. Default: ftpProtocolFamilyINET4
Proxy	Contains the Proxy object.
SendHOST	Specifies whether to the HOST command is sent. Default: false
ServerState	Contains a server state.
SSCN	Specifies whether to use use the SSCN command. Default: false
SSLSocketLayer	This is SSLSocketLayer, a member of class IFTPConnection.
StreamFilter	Contains a StreamFilter. Default: empty
Timeout	Specifies the timeout in seconds for the control and data connection. Default: 30
TransferProgressEventInterval	Interval in ms (1/1000 s) in which the OnTransferProgress event is fired. Default: 1000 ms
UPnP	Specifies whether port mappings for Active Mode (PORT) are automatically created and removed for data connections if a UPnP enabled router is present.
UseMessageLoop	Specifies whether the component uses a message loop while waiting for an operation to return. The message loop dispatches the windows messages queued in the windows message queue. Default: FTPConnectionMTA: false FTPConnectionSTA: true
Username	The user name to login to the FTP server. Default: empty
WorkingDirectory	Returns the current working directory. (read-only) The directory is extracted from the last successful PWD server reply. Double quotes are automatically converted.