ISSHConnection Interface

The ISSHConnection interface is implemented by the SSHConnection class.

ISSHConnection

IDL

interface ISSHConnection : IDispatch;

VBScript

Dim objSSH
Set objSSH = CreateObject("sfFTPLib.SSHConnection")
...
Set objSSH = Nothing

JavaScript

Copy Code

var objSSH = new ActiveXObject("sfFTPLib.SSHConnection");

Copy Code

CSSHConnection ssh = new CSSHConnection();

C++

Copy Code

#import "libid:7A3A786C-EB8C-43b3-BC10-8D09ACF5D195"
// Note: Uncomment for Microsoft Visual Studio 6.0
//#import "C:\Program Files\SmartFTP FTP Library\sfFTPLib.dll"

#include <atlcom.h>

::CoInitializeEx(0, COINIT_MULTITHREADED);
CComPtr<sfFTPLib::ISSHConnection> sshConnection;
sshConnection.CoCreateInstance(__uuidof(sfFTPLib::SSHConnection));
::CoUninitialize();

ISSHConnection Methods

ISSHConnection Methods	Description
Abort	Aborts the current operation.
Close	This is Close, a member of class ISSHConnection.
Connect	Connects to remote host.
CreateSFTPConnection	This is CreateSFTPConnection, a member of class ISSHConnection.
Disconnect	Disconnects from the remote host. To ungracefully close the connection use the Close method.
SendPacket	This is SendPacket, a member of class ISSHConnection.
SetFileLogger	This is SetFileLogger, a member of class ISSHConnection.

ISSHConnection Properties

ISSHConnection Properties	Description
AgentKeyBlob	This is AgentKeyBlob, a member of class ISSHConnection.
Authentications	Contains an ordered list of supported authentication methods. Default: { ftpSSHAuthenticationNone, ftpSSHAuthenticationPublicKey, ftpSSHAuthenticationPassword }
Busy	Specifies whether an operation is in progress.
Client	The client id. Default: SmartFTP
ClientHostKey	The client host key for a "Host-Based" authentication (ftpAuthenticationHostBased).
ClientHostname	The client host name for the "Host-Based" authentication (ftpAuthenticationHostBased).
CompressionLevel	Specifies zlib compression level. Default: 5
Compressions	Contains an ordered list of supported compression methods. Default: { ftpSSHCompressionzlib, ftpSSHCompressionNone }
ConnectionInfo	This is ConnectionInfo, a member of class ISSHConnection.
ConnectionStatus	Contains the connection status.
Encryptions	Contains an ordered list of supported encryptions. Default: { ftpEncryptionAES128, ftpEncryption3DES, ftpEncryptionAES192, ftpEncryptionAES256, ftpEncryptionBlowfish, ftpEncryptionCAST128, ftpEncryptionDES
GSSAPIMethod	This is GSSAPIMethod, a member of class ISSHConnection.
Host	Host name of the server.
KeepAliveInterval	This is KeepAliveInterval, a member of class ISSHConnection.
KeyExchanges	Contains a list of supported key exchange algorithms. Default: { ftpKeyExchangeDiffieHellmanGroupExchangeSHA256, ftpKeyExchangeDiffieHellmanGroupExchangeSHA1, ftpKeyExchangeDiffieHellmanGroup1SHA1, ftpKeyExchangeDiffieHellmanGroup14SHA1 }
Languages	Contains an ordered list of preferred language ids (LANGID).
Logger	This is Logger, a member of class ISSHConnection.
MACs	Contains an ordered list of supported HMAC algorithms. Default: { ftpMACSHA1, ftpMACMD5, ftpMACSHA196, ftpMACMD596, ftpMACRIPEMD160 }
Password	The password to login to server.
Port	The port number of the server. Default: 22
PrivateKey	Specifies the user's private key.
ProtocolFamily	Specifies the protocol family of the connection. Default: ftpProtocolFamilyUNSPEC
ProtocolFamilyPreference	Specifies the preferred protocol family. Default: ftpProtocolFamilyINET4
Proxy	Contains the Proxy object.
ServerHostKey	Contains the host's public key.
ServerHostKeyAlgorithms	This is ServerHostKeyAlgorithms, a member of class ISSHConnection.
ServerState	Contains the server state.
SocketSettings	This is SocketSettings, a member of class ISSHConnection.
SpeedLimitSettings	This is SpeedLimitSettings, a member of class ISSHConnection.
Timeout	Specifies the timeout in seconds of the connection.
UseMessageLoop	Specifies if the component uses a message loop while waiting for an operation to return. The message loop dispatches the windows messages queued in the windows message queue. Default: false
UsePasswordForKeyboardInteractive	This is UsePasswordForKeyboardInteractive, a member of class ISSHConnection.
Username	Specifies the user name to login to the server.