SSHHost Property

The address of the SSH host.

Syntax

ANSI (Cross Platform)
char* GetSSHHost();
int SetSSHHost(const char* lpszSSHHost);

Unicode (Windows)
LPWSTR GetSSHHost();
INT SetSSHHost(LPCWSTR lpszSSHHost);
@property (nonatomic,readwrite,assign,getter=SSHHost,setter=setSSHHost:) NSString* SSHHost;
- (NSString*)SSHHost;
- (void)setSSHHost:(NSString*)newSSHHost;

#define PID_SFTP_SSHHOST 47

IPWORKSSFTP_EXTERNAL void* IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSSFTP_EXTERNAL int IPWORKSSFTP_CALL IPWorksSFTP_SFTP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the SSHHost property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.

Data Type

String
Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 C++ Edition - Version 20.0 [Build 8263]