IP*Works! SSH sftp Component : sftp OCX, sftp .NET Component, sftp Class, sftp Bean, sftp Object

login

Red Carpet Subscriptions

IP*Works! Products

IBiz - Internet Business

QuickBooks Integrator

E-Payment Integrator

Vital/TSYS Integrator

Paymentech Integrator

Enterprise Adapters

SQL Server SSIS Tasks

Verified By Visa

3-D Secure MPI

Testimonials

"I have developed several internet applications using your IPPORT and UDPPORT. You have done a great job in offering a simple interface to IP from VB. Good work!"

-- T. Chumak

[more...]

Available in: SSH

Sftp Class

SFTP Component [IP*Works! SSH V8]

Properties Methods Events Configuration Settings

The SFTP component can be used to transfer files to and from SFTP servers using the SFTP Protocol.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The SFTP component is the SSH-enabled equivalent of the IP*Works! FTP component. The main difference is the introduction of a set of new properties and events that deal with SSH security. The SSHHost and SSHPort properties specify the SSH server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event and/or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

The SFTP component implements a standard SSH File Transfer client.

The first step in using the component is specifying the SSHHost, SSHUser and SSHPassword. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is specified by the RemotePath property.

If LocalFile is set to something other than an empty string, then files are received in LocalFile, otherwise the data is received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

Directory listings are received through the DirList event.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


Connected	Triggers a connection or disconnection.
DirList	Collection of entries resulting in the last directory listing.
FileAttributes	The attributes of the RemoteFile.
FileExists	Returns true if the file specified by RemoteFile exists on the remote server.
Firewall	A set of properties related to firewall access. A set of properties related to firewall access.
Idle	The current status of the component.
LocalFile	The path to a local file for download/upload. If the file exists, it is overwritten.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted. The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where IPPort binds.
Overwrite	Whether or not the component should overwrite files during transfer.
RemoteFile	The name of the remote file for uploading, downloading, etc.
RemotePath	The current path in the SFTP server.
SSHAuthMode	The authentication method to be used the component when performing an SSHLogon.
SSHCert	A certificate to be used for authenticating the SSHUser.
SSHCompressionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithms	A comma-separated list containing all allowable compression algorithms.
SSHHost	The address of the SSH host.
SSHPassword	The password for SSH password-based authentication.
SSHPort	The port on the SSH server where the SSH service is running; by default, 22.
SSHUser	The username for SSH authentication.
Timeout	A timeout for the component.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


Append	Append data from LocalFile to a remote file RemoteFile on an SFTP server.
Config	Sets or retrieves a component configuration setting.
DeleteFile	Remove a file specified by FileName from an SFTP server.
DoEvents	Processes events from the internal message queue.
Download	Download a RemoteFile from an SFTP server.
Interrupt	Interrupt the current method.
ListDirectory	List the current directory specified by RemotePath on an SFTP server.
MakeDirectory	Create a directory on an SFTP server.
RemoveDirectory	Remove a directory specified by DirName from an SFTP server.
RenameFile	Change the name of RemoteFile to NewName.
SSHLogoff	Logoff from the SSH server.
SSHLogon	Logon to the SSHHost using the current SSHUser and SSHPassword.
SetDownloadStream	Sets the stream to which the downloaded data from the server will be written.
SetUploadStream	Sets the stream from which the component will read data to upload to the server.
UpdateFileAttributes	Instructs the component to send the FileAttributes to the server.
Upload	Upload a file specified by LocalFile to an SFTP server.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	Fired to indicate changes in connection state.
DirList	Fired when a directory entry is received.
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a file completes downloading/uploading.
Error	Information about errors during data delivery.
SSHServerAuthentication	Fired after the server presents its public key to the client.
SSHStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a file starts downloading/uploading.
Transfer	Fired during file download/upload.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
AcceptAnyServerCert	If set the component will accept any certificate presented by the server
AuthModeList	A comma-delimited list of modes to be used during multi-factor authentication.
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FiletimeFormat	Specifies the format to use when returning filetime strings.
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
IgnoreFileMaskCasing	Controls whether or not the file mask is case sensitive.
InBufferSize	The size in bytes of the incoming queue of the socket.
MaxFileData	Specifies the maximum payload size of an SFTP packet.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
SSHAcceptServerHostKeyFingerPrint	The fingerprint of the server key to accept
TcpNoDelay	Whether or not to delay when sending packets

|

About

|

Privacy Policy

|

Terms of Use

|