countElements



Function: countElements()

Returns the number of elements in an Array or Recordset.

Syntax

countElements(list, selection)

ArgumentTypeDescription
listArray or RecordsetThe object to be counted.
selectionString

An optional parameter which can be set to "All".

This parameter is only used by CSS elements or Formatting Rules, when set to "All" countElements will count all elements in a grid. If not set countElements only returns the number of selected records.

Examples

countElements([1,2,"many"])

Returns the number of elements in this list, 3


$list = [1,2,"many"],

countElements($list)

Returns 3 since this list has the value [1,2,"many"]


countElements(in)

Returns the number of records being read from the 'in' pipe during the current table processing cycle. This can be useful when deciding whether or not to read values from a pipe, for instance when using calculate tables.


countElements(in.AnyFieldName)

Also returns the number of records being read from the 'in' pipe, if AnyFieldName is an attribute that exists on the table being read from.


countElements(lookupPipe)

Returns the number of rows in the Pipe referenced by lookupPipe.


$userArray = split(in.users,","),
$numUsers = countElements($userArray)

in.users is a list of user names separated by commas. The split() function converts this into an Array and countElements() returns the number of users.

See Also