wodSFTP ActiveX Control - wodSFTP Object
wodSFTP Object
    
 
Description

wodSFTP Class


Members
Methods
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 a 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 the contents of a remote file to a string variable
GetDataAt Retrieves the contents of part of a remote file to string a 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.
PutDatAt Sends data from a string variable to the server, at a specified file position.
PutFile Sends file to the server.
PutFileAt Sends part of a file to the server.
PutFiles Uploads multiple files in a sequence, recursive.
RealPath Retrieves the 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 Read-write property Determines which authentication type is used.
Blocking Read-write property Determines if methods are blocking.
BufferSize Read-write property Determines the size of incoming and outgoing buffers.
Compression Read-write property Determines the level of compression used.
Encryption Read-write property Determines the encryption algorithm to be used with SFTP.
ErrorText Read-only property Provides a string representation of an error.
Extensions Read-only property Holds list of extensions supported by the server.
FingerPrint Read-only property Returns fingerprint of the host's key.
FIPS Read-write property Specifies FIPS enabled libeay32.dll to load.
Hostname Read-write property Determines the Hostname of the remote server.
KeepAlives Read-write property Number of seconds of inactivity before KeepAlive ignore packets are sent.
LastError Read-only property Holds the last error returned by the method.
ListItem Read-only property Holds the value of the last ListItems and Attributes event
LocalPath Read-write property Holds the name of the local path to be used for transfers.
Login Read-write property Determines the username/login to be used with the server.
MaxTransferRate Read-write property Determines maximum upload/download speed.
MyHostname Read-write property Holds the hostname of the local computer.
MyIP Read-write property Holds the IP address of the local computer.
Notification Read-write property Fast notification interface to use instead of events.
Password Read-write property Determines the password to be used with the server.
Port Read-write property Determines the port on the remote server where wodSFTP will connect.
PrivateKey Read-write property Private key used for authentication.
ProxyHostname Read-write property Specifies the hostname of the proxy to use.
ProxyLogin Read-write property Specifies the login/username to use when connecting to a proxy server.
ProxyPassword Read-write property Specifies the password to use when connecting to a proxy server.
ProxyPort Read-write property Specifies the port to use when connecting to a proxy server.
ProxyType Read-write property Specifies the type of proxy to use.
RemoteIdentification Read-only property Holds the remote identification string.
RemotePath Read-write property Holds the name of the path on the server used for transfers.
Resume Read-write property Determines if wodSFTP will resume file transfers.
ServerErrorCode Read-only property Holds the error code returned by the server.
ServerErrorText Read-only property Holds error text returned by the server.
State Read-only property Holds current state information.
StateText Read-only property Provides a string describing a state.
Timeout Read-write property Timeout value, in seconds.
Timezone Read-write property Specifies the time zone for representing file dates.
TransferMode Read-write property Determines if transfers are Binary or ASCII.
TransferRate Read-only property Returns average speed of the file transfer.
TransferTime Read-only property Returns time needed to transfer current or previous file.
UseIPv6 Read-write property Determines if IPv6 addresses are allowed.
Version Read-write property 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 a 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 the server returns information about a file or directory.
LoginChallenge Fires when the server requests a 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.