IPWorks S/MIME 2020 Node.js Edition

Questions / Feedback?

Connected Property

Shows whether the class is connected.

Syntax

 spop.getConnected([callback])
 spop.setConnected( connected, [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 getConnected([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 setConnected([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 is used to determine whether or not the class is connected to the remote host.

This property is not available at design time.

Data Type

Boolean

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 Node.js Edition - Version 20.0 [Build 8154]