wodSFTP

wodSFTP Class

Abort	Aborts the current method.
About	Displays the About box.
AppendData	Appends data from a string variable to a remote file.
AppendFile	Appends to a remote file.
Connect	Connects to the remote server.
DeleteFile	Deletes file on the server.
DeleteFiles	Delete multiple files in a sequence, recursive.
Disconnect	Disconnects from the remote server.
ExtendedCmd	Sends extended command to the server.
GetAttributes	Retrieves file or folder attributes.
GetData	Retrieves contents of remote file to string variable.
GetDataAt	Retrieves the contents of part of the remote file to a string variable.
GetFile	Receives data from the server.
GetFileAt	Receives part of a file from the server.
GetFiles	Downloads multiple files in a sequence, recursive.
ListAttributes	Lists the contents of a directory as a structure.
ListDir	Lists the contents of a directory on the server.
ListNames	Lists file and folder names in a directory on the server.
LoopFiles	Loops through multiple files in a sequence, recursive, giving their names.
MakeDir	Creates a directory on the server.
PutData	Stores data from a string variable to a remote file.
PutDataAt	Sends data from a string variable to the server, at a specified file position.
PutFile	Sends file to the server.
PutFileAt	Sends part of the file to the server.
PutFiles	Uploads multiple files in a sequence, recursive.
RealPath	Retrieves real path for the symbolic link.
RemoteClose	Closes remote file.
RemoteOpen	Opens remote file for raw access.
RemoteRead	Reads from remote file.
RemoteWrite	Writes to remote file.
RemoveDir	Removes a directory from the server.
Rename	Renames a file or directory on the server.
SetAttributes	Sets attributes for a file or folder.
SetAttributes64	Sets attributes for a file or folder.

Properties

Authentication	Determines which authentication type is used.
Blocking	Determines if methods are blocking.
BufferSize	Determines size of incoming and outgoing buffers.
ClientName	Determines client name that will be used with the server during initial exchange.
Compression	Determines the level of compression used.
Encryption	Determines encryption algorithm to be used with SFTP.
EncryptionList	Determines list of encryption algorithms supported and offered by wodSFTP.
ErrorText	Provides a string representation of an error.
Extensions	Holds list of extensions supported by the server.
FingerPrint	Returns fingerprint of the host's key.
FIPS	Specifies FIPS enabled OpenSSL configuration to load.
HMacList	Determines list of digest algorithms supported and offered by wodSFTP.
Hostname	Determines the Hostname of the remote server.
KeepAlives	Defines number of seconds of inactivity before KeepAlive ignore packets are sent.
KeyExchangeList	Determines list of key exchange algorithms supported and offered by wodSFTP.
KeySignatureList	Determines list of server key signature algorithms supported and offered by wodSFTP.
LastError	Holds the last error returned by the method.
ListItem	Holds the value of the last ListItems and Attributes event.
LocalPath	Holds the name of the local path used for transferring.
Login	Determines the username/login to be used with server.
MaxTransferRate	Determines maximum upload/download speed.
MyHostname	Holds the hostname of the local computer.
MyIP	Holds the IP address of the local computer.
Notification	Fast notification interface to use instead of events.
Password	Determines the password to be used with the server.
Port	Determines the port on the remote server.
PrivateKey	The Private key used for authentication.
ProxyHostname	Specifies the hostname of the proxy to use.
ProxyLogin	Specifies the login/username to use when connecting to a proxy server.
ProxyPassword	Specifies the password to use when connecting to a proxy server.
ProxyPort	Specifies the port to use when connecting to a proxy server.
ProxyType	Specifies the type of proxy to use.
RemoteIdentification	Holds the remote identification string.
RemotePath	Holds name of the path on the server used for transferring.
Resume	Determines if wodSFTP will resume file transfers.
ServerErrorCode	Holds the error code returned by the server.
ServerErrorText	Holds error text returned by the server.
State	Holds current state information.
StateText	Provides a string describing a state.
Timeout	Timeout value, in seconds.
Timezone	Determines if dates are shown in Local or UTC time zone.
TransferMode	Determines if transfers are Binary or ASCII.
TransferRate	Returns average speed of the file transfer.
TransferTime	Returns time needed to transfer current or previous file.
UseIPv6	Determines if IPv6 addresses are allowed.
Version	Holds version information.

Events

Attributes	Fires when wodSFTP retrieves file or directory attributes.
Attributes64	Fires when wodSFTP retrieves file or directory attributes.
AttributesData	Fires when wodSFTP retrieves directory attributes.
Connected	Fires when wodSFTP connects to the remote server.
CryptoInformation	Fires before wodSFTP establishes an encrypted connection with the server.
Disconnected	Fires when wodSFTP disconnects from the server.
Done	Fires when wodSFTP finishes a method.
ExtendedCmdReply	Fires after wodSFTP receives reply on ExtendedCmd.
HostFingerprint	Fires when the remote server provides public key fingerprint information.
ListItems	Fires when server returns information about a file or directory.
LoginChallenge	Fires when the server requests the response to a login challenge.
LoopError	Fires after wodSFTP performs operation on item and error occurs.
LoopItem	Fires before wodSFTP performs operation on file from the GetFiles/PutFiles/DeleteFiles/LoopFiles sequence.
Progress	Fires during file send/receive operations.
Progress64	Fires during file send/receive operations.
RemoteData	Fires after wodSFTP has some data to be provided as result of RemoteRead command.
StateChange	Fires when wodSFTP changes its state.

Platforms

Windows

wodSFTP help - wodSFTP

wodSFTP

Platforms