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

Connected Property

Indicates whether or not the component is bound.

Syntax

 smpp.getConnected([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

The value of this property indicates whether or not the class has successfully bound to the SMPPServer. It will not be true until a successful Connected event has fired.

There are two ways to bind: by calling Connect with a user identifier and password which will set the UserId and Password properties before connecting; or by setting those two properties and calling SendMessage while not connected.

This property is read-only and not available at design time.

Data Type

Boolean

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