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

ClientCount Property

The number of records in the Client arrays.

Syntax

 sshtunnel.getClientCount([callback])

Default Value

0


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 getClientCount([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 setClientCount([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 controls the size of the following arrays:

The array indices start at 0 and end at ClientCount-1.

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

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0