Back to product page

wodSFTPdll



Create functionCreates a new instance of the wodSFTPdll API library.
Destroy functionDestroys an instance of the wodSFTPdll library.
Methods
AbortAborts the current method execution.
AboutDisplays the About box.
AppendDataAppends data from a string variable to a remote file.
AppendDataLenAppends data from a fixed-size buffer to a remote file.
AppendFileAppends to a remote file.
ConnectAppends to a remote file.
DeleteFileDeletes a file on the server.
DeleteFilesDeletes multiple files in a sequence, recursive.
DisconnectDisconnects from the remote server.
ExtendedCmdSends extended command to the server.
GetAttributesRetrieves a file or folder attributes.
GetDataRetrieves the contents of a remote file to a string variable
GetDataAtRetrieves the contents of a remote file to a string variable, starting from a given position.
GetDataToBufferRetrieves the contents of a remote file to a locally specified buffer.
GetDataToBufferAtRetrieves the contents of a remote file to a locally specified buffer.
GetFileReceives a file from the server.
GetFileAtAborts the current method execution.
GetFilesDownloads multiple files in a sequence, recursive.
ListAttributesLists the contents of a directory as a structure.
ListDirLists the contents of a directory on the server.
ListNamesLists the file and folder names in a directory on the server.
LoadPrivateKeyLoads a private key from an external file.
LoopFilesLoops through multiple files in a sequence, recursive, giving their names.
MakeDirCreates a directory on the server.
PutDataCreates a directory on the server.
PutDataAtReceives a file from the server, starting from a given position.
PutDataLenStores data from a fixed-size buffer to a remote file.
PutDataLenAtStores data from a fixed-size buffer to a remote file, at a given position.
PutFileStores data from a fixed-size buffer to a remote file, at a given position.
PutFileAtSends a file to the server, appending it at a given position.
PutFilesUploads multiple files in a sequence, recursive.
RealPathRetrieves the real path for a symbolic link.
RemoteCloseCloses remote file.
RemoteOpenOpens remote file for raw access.
RemoteReadReads from remote file.
RemoteWriteWrites to remote file.
RemoveDirRemoves a directory from the server.
RenameRenames a file or directory on the server
SetAttributesSets attributes for a file or folder.
Properties
AuthenticationDetermines which authentication type is used.
BlockingDetermines whether methods are blocking.
BufferSizeDetermines the size of incoming and outgoing buffers.
ClientNameDetermines client name that will be used with the server during initial exchange.
CompressionDetermines the level of compression used.
EncryptionDetermines the encryption algorithm to be used with SFTP.
EncryptionListDetermines list of encryption algorithms supported and offered by wodSFTPdll.
ErrorTextProvides a string expression describing an error.
ExtensionsHolds list of extensions supported by the server.
FIPSSpecifies FIPS enabled OpenSSL configuration to load.
HMacListDetermines list of digest algorithms supported and offered by wodSFTPdll.
HostnameDetermines the Hostname of remote server.
KeyExchangeListDetermines list of key exchange algorithms supported and offered by wodSFTPdll.
KeySignatureListDetermines list of server key signature algorithms supported and offered by wodSFTPdll.
LastErrorHolds the last error returned by the method.
ListItemHolds the value of the last ListItems and Attributes event
LocalPathHolds the name of the local path used for transferring.
LoginDetermines the username/login to be used with the server.
MaxTransferRateDetermines maximum upload/download speed.
MyHostnameHolds the hostname of the local computer.
MyIPHolds the IP address of the local computer.
PasswordDetermines the password to be used with the server.
PortDetermines the port on the remote server where wodSFTP will connect.
PrivateKeyPrivate key used for authentication
ProxyHostnameSpecifies the hostname of the proxy to use.
ProxyLoginSpecifies the login/username to use when connecting to a proxy server.
ProxyPasswordSpecifies the login/username to use when connecting to a proxy server.
ProxyPortSpecifies the port to use for a proxy server.
ProxyTypeSpecifies the type of proxy to use.
RemoteIdentificationHolds the remote identification string.
RemotePathHolds the name of the path on the server used for transferring.
ResumeDetermines if wodSFTP will resume file transfer.
ServerErrorCodeHolds the error code returned by the server.
ServerErrorTextHolds the error text returned by the server.
StateHolds the current state information.
StateTextProvides a string expression describing a state.
TimeoutTimeout value, in seconds.
TimezoneDetermines if dates are shown in Local or UTC timezone.
TransferModeDetermines if transfers are Binary or AscII.
TransferRateReturns average speed of the file transfer.
TransferTimeReturns time needed to transfer current or previous file.
UseIPv6Determines if IPv6 addresses are allowed.
VersionHolds version information.
Callbacks
AttributesCalled when wodSFTP retrieves file or directory attributes.
AttributesDataCalled when wodSFTP retrieves directory attributes.
ConnectedCalled when wodSFTP connects to the remote server.
CryptoInformationCalled before wodSFTP establishes an encrypted connection with the server.
DisconnectedCalled when wodSFTP disconnects from the server.
DoneFires when wodSFTP finishes a method.
ExtendedCmdReplyCalled after wodSFTP receives reply on ExtendedCmd.
HostFingerprintCalled when the remote server provides public key fingerprint information.
ListItemsCalled when the server returns information about a file or directory.
LoginChallengeCalled when server requests a response to login challenge.
LoopErrorCalled after wodSFTP performs operation on item and error occurs.
LoopItemCalled before wodSFTP performs operation on item from the GetFiles/PutFiles/DeleteFiles/LoopFiles sequence.
ProgressCalled during file sending or receiving.
RemoteDataCalled after wodSFTP has some data to be provided as result of RemoteRead command.
StateChangeCalled when wodSFTP changes its state.

Platforms

Windows