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

BuddyCount Property

The number of records in the Buddy arrays.

Syntax

 xmpp.getBuddyCount([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 getBuddyCount([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 setBuddyCount([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 BuddyCount-1.

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

Data Type

Integer

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