IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

EoF Property

If True, the connection has closed, and there is no buffered data available.

Syntax

 rshell.getEoF([callback])

Default Value

TRUE


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 getEoF([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setEoF([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

EOF is an acronym for "End Of File".

This property is read-only.

Data Type

Boolean

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0