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

Active Property

Enables or disables sending and receiving of data.

Syntax

 syslog.getActive([callback])
 syslog.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

Setting the Active property to True makes the class create a communication endpoint (socket) which can be used for sending and receiving UDP datagrams. Setting it to False destroys the socket and disables data communications.

Data Type

Boolean

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