Skip to end of banner
Go to start of banner

arrayAddElementIfNotExist

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Availability

This routine is available starting with SIL Engine™ 1.0.


Syntax

arrayAddElementIfNotExist(arrayName, elem)

Description

If elem is an element of the array type, returns a new array that includes the specified element at the end. The element is added only if it is not already in the array.

Alias

addElementIfNotExist(arrayName, elem)

Parameters

Parameter name

Type

Required

Description

arrayName

array

Yes

Array the new element is added to.

elem

any

Yes

Element to be added. Must be the same type as the array type.

Return Type

array

Example

example 1

watchers2 = addElementIfNotExist(watchers, currentUser());

Adds currentUser to the watchers array if currentUser is not already present. The routine returns a new array watchers2, so the initial array will not be modified.

example 2

watchers = addElementIfNotExist(watchers, currentUser());

The initial array will be modified as a result of the = operator and NOT of the routine call.

Notes

  1. If arrayName is not defined as an array, the routine returns error.
  2. If elem is not the same type as declared in the array definition, the routine returns error.

See also

  • No labels