Active Property

Enables or disables receiving of data.

Syntax

 ping.getActive([callback])
 ping.setActive( active, [callback])

Default Value

FALSE

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 getActive([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 setActive([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

This property enables or disables receiving of data. Setting this property to True makes the class able to accept data. If this property is False, the component will not receive incoming data.

The PingHost method will automatically change the value of this property to True.

This property is not available at design time.

Data Type

Boolean