Read All VI

Owning Palette: Channel

Requires: LIBSSH2

Reads binary data from a SSH channel represented by this Channel object in chunks, or blocks, until the total read size is reached. This VI should be used if the Total Read Size is greater than 30KB because of a hard-coded per-read maximum of 30KB set in the libssh2lv shared library.

Read All VI

cToolkit_lvlib_ChannellvclassChannel In represents a libssh2lv shared library Channel struct.
cu64Total Read Size is the total number of bytes that will be read in smaller chunks, or blocks.
cerrcodeclstError In describes error conditions that occur before this node runs. This input provides standard error in functionality.

Right-click the Error In indicator on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.

cu64Per Read Size is the number of bytes for the smaller chunks, or blocks, read from the remote SSH server until the Total Read Size is reached. There is a hard-coded maximum per-read size of 30KB in the libssh2lv shared library.
iToolkit_lvlib_ChannellvclassChannel Out is the same object from Channel In.
i1du8Data is the byte array when the number of bytes read in smaller chunks, or blocks, reaches the Total Read Size.
iboolTimed Out? is TRUE if the the session timeout is reached before the Total Read Size is reached. This usually indicates the connection has been lost, or there is no more data available to read.
ierrcodeclstError Out contains error information. This provides standard error out functionality.

Right-click the Error Out indicator on the front panel and select Explain Error or Explain Warning from the shortcut menu for more information about the error.