ReadyToSend Property

This property is True when data can be sent over the SSH Channel.

Syntax

ANSI (Cross Platform)
int GetReadyToSend(int iSSHChannelId);

Unicode (Windows)
BOOL GetReadyToSend(INT iSSHChannelId);
- (BOOL)readyToSend:(int)sSHChannelId;

#define PID_SSHCLIENT_READYTOSEND 5

IPWORKSSSH_EXTERNAL void* IPWORKSSSH_CALL IPWorksSSH_SSHClient_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);

IPWORKSSSH_EXTERNAL int IPWORKSSSH_CALL IPWorksSSH_SSHClient_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

FALSE

Remarks

This property is True when data can be sent over the SSH Channel.

When Timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor SSHChannelReadyToSend or ReadyToSend to determine when data can be sent again.

When Timeout is set to a positive value the class will block when sending data until the data can be successfully sent and SSHChannelReadyToSend and ReadyToSend do not need to be monitored.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only and not available at design time.

Data Type

Boolean
Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 C++ Edition - Version 20.0 [Build 8501]