DataToSend Property

A string of data to be sent to the remote host.

Syntax

 sshclient.setDataToSend(index,  dataToSend_Buffer, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getDataToSend([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setDataToSend([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

A string of data to be sent to the remote host. Write-only property.

Assigning a string to the DataToSend makes the class send the string to the remote host.

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

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

Data Type

Buffer