Class wwSftpClient - West Wind Client Tools

Class wwSftpClient

about 1 minute to read

Ftp class that uses the .NET SSH.NET library to provide FTP and FTPS (FTP over TLS). This class does not support SFTPS.

Remarks

Dependencies

This API uses a .NET library to provide FTP functionality.

wwIpstuff.dll

wwDotnetBridge.dll

Renci.sshNet.dll

Class Members

Member		Description
	OnFtpBufferUpdate	OnFtpBufferUpdate
	ChangeDirectory	Changes the active directory on the FTP server. This affects how relative paths are handled. o.ChangeDirectory(lcFtpPath)
	Close	Closes the FTP connections. o.Close()
	Connect	This establishes the initial connection to the server. The connection needs to stay open for any of the FTP operation commands. o.Connect(lcServer, lcUsername, lcPassword)
	CreateDirectory	Creates a new directory on the server. o.CreateDirectory(lcFtpPath)
	DeleteDirectory	Deletes a directory from the FTP server. o.DeleteDirectory(lcFtpPath)
	DeleteFile	Deletes a file from the server. o.DeleteFile(lcFile)
	DownloadFile	Downloads a file from the FTP server to a local file. o.DownloadFile(lcFtpPath, lcTargetFile)
	ExecuteCommand	FtpCommand o.ExecuteCommand(lcCommand)
	ExecuteDownloadCommand	ExecuteDownloadCommand o.ExecuteDownloadCommand(lcCommand)
	Exists	Checks to see if a remote file exists. o.Exists(lcRemoteFile)
	ListFiles	Retrieves a directory listing from the server with all files returned as a collection. o.ListFiles(lcFtpPath)
	RenameFile	Renames a file on the server which allows for fast copying. o.RenameFile(lcOldName, lcNewName)
	UploadFile	Uploads a file to the server from a local file. o.UploadFile(lcLocalFile, lcFtpPath)
	cErrorMsg	Error message set after a method call that fails
	cftpserver	The FTP server to connect to
	cftpsource	The Source file to upload from the client or download from the server.
	cftptarget	The file to download to from the server or upload to on the server.
	cHttpProxyByPass
	cHttpProxyName
	cHttpProxyPassword
	cHttpProxyPort
	cHttpProxyUsername
	cLogFile	Optional log file that receives ftp log output
	cPassword	Password for the connection
	cPrivateKeyFile	Optional Private key file for sign on
	cPrivateKeyFilePassword	Optional Private key file password for sign on
	cUsername	Username for the connection
	lcanceldownload	Cancel flag that can be set in OnFTPBufferUpdate to let wwFTP know to stop downloading a file from the Internet.
	lEnableProgressEvents
	lIgnoreCertificateErrors	Allows you to ignore certificate errors NOT RECOMMENDED: Fix your Certs!
	lpassiveftp	Flag that sets whether to use passive FTP.
	lUseTls	Tsl used for this request (FTPS protocol: FTP over TLS)
	nftpworkbuffersize
	nPort	The port to run the FTP connection on
	nTimeout	Connection timeout in seconds
	oBridge	wwDotnetBridge instance
	oFtpClient	.NET wwFtpClient instance
	oProgressEventObject

Requirements

Assembly: wwsftpclient.prg