ISFTPConnection Interface

ISFTPConnection

IDL

interface ISFTPConnection : IDispatch;

File

sfFTPLib.idl

Remarks

This is class ISFTPConnection.

ISFTPConnection Methods

ISFTPConnection Methods	Description
Abort	Aborts the current operation.
Close	Closes the connection. To gracefully close a connection use the Disconnect method.
Connect	This is Connect, a member of class ISFTPConnection.
CopyFile	This is CopyFile, a member of class ISFTPConnection.
CreateStreamForRead	This is CreateStreamForRead, a member of class ISFTPConnection.
CreateStreamForWrite	This is CreateStreamForWrite, a member of class ISFTPConnection.
Disconnect	This is Disconnect, a member of class ISFTPConnection.
DownloadFile	Downloads a file.
DownloadFileEx	This is DownloadFileEx, a member of class ISFTPConnection.
GetFileHash	MD5 128 bit hash Format: hex string, 32 chars, lower case Example: "0123456789abcdef0123456789abcdef" Reference: RFC 1321 - The MD5 Message-Digest Algorithm
GetSpaceAvailable	This is GetSpaceAvailable, a member of class ISFTPConnection.
Link	Creates a link.
LStat	Retrieves attributes from a file system object. This method does not follow symbolic links. To follow symbolic links use the Stat method.
MakeDirectory	Creates a new directory.
NewFile	Creates a new empty file.
ReadDirectory	Retrieves directory listing.
ReadDirectoryEx	This is ReadDirectoryEx, a member of class ISFTPConnection.
ReadLink	Reads the target of a symbolic link.
RealPath	Canonicalize any given path name to an absolute path. If protocol version 6 is supported, use the RealPathEx method.
RealPathEx	Canonicalize any given path name to an absolute path.
RemoveDirectory	Removes a directory.
RemoveFile	Removes a file.
Rename	Renames a file or directory.
SetFileLogger	This is SetFileLogger, a member of class ISFTPConnection.
SetStat	Modifies file attributes of a file system object.
Stat	Retrieves attributes from a file system object. This method does follow symbolic links. To retrieve the attributes of the link itself use the LStat method.
StatEx	Retrieves attributes from a file system object. This method is a wrapper for the Stat and LStat methods.
StatVFS	This is StatVFS, a member of class ISFTPConnection.
UploadFile	Uploads a file.
UploadFileEx	This is UploadFileEx, a member of class ISFTPConnection.

ISFTPConnection Properties

ISFTPConnection Properties	Description
Busy	This is Busy, a member of class ISFTPConnection.
CodePage	Specifies the code page used to perform conversations. Default: -1 (Auto).
LastIOBytes	Contains the number of bytes read/written from/to the file/stream during the last transfer.
LastStatusCode	Contains the numeric code of the last status message from the server.
LastStatusMessage	Contains the last status message from the server.
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.
LastTransferTime	Contains the total time in milliseconds of the last data transfer.
Logger	This is Logger, a member of class ISFTPConnection.
ProtocolVersion	Returns the protocol version negotiated.
ProtocolVersionPreference	Specifies the preferred protocol version. Default: 6
ServerLineTerminator	This is ServerLineTerminator, a member of class ISFTPConnection.
ServerState	Contains the server state.
SFTPServerCommand	This is SFTPServerCommand, a member of class ISFTPConnection.
SSHConnection	This is SSHConnection, a member of class ISFTPConnection.
Status	This is Status, a member of class ISFTPConnection.
Timeout	Specifies the timeout in seconds of the channel. Default: 30
UseMessageLoop	This is UseMessageLoop, a member of class ISFTPConnection.
VendorId	This is VendorId, a member of class ISFTPConnection.