Ping Method
Sends a keep-alive request to the SSH server.
Syntax
ANSI (Cross Platform) int Ping(); Unicode (Windows) INT Ping();
- (void)ping;
#define MID_SSHCLIENT_PING 6 SECUREBLACKBOX_EXTERNAL int SECUREBLACKBOX_CALL SecureBlackbox_SSHClient_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
Remarks
Use this method to send a keep-alive message to the SSH server. Keep-alive messages are empty data packets which carry no useful information but are a handy way of checking if the connection is still alive.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)