PhixFlow Help

getElement



Function: getElement()

Returns the item at a specified index position within an Array or Recordset.

Syntax

  1. getElement(set, index)
  2. set[index]
  3. set.index
ArgumentTypeDescription
setArray or RecordsetThe Array or Recordset to get the result from
indexIntegerThe position of the item in set to be returned.

If index is not a valid entry the function will return _NULL.

Examples

getElement(["Red", "Green", "Blue"], 2)

Returns the 2nd element, "Green".


["Red", "Green", "Blue"].3

Returns the 3rd element, "Blue".


["Red", "Green", "Blue"].8

Returns _NULL, as there is no element at position 8.


[].1

Returns _NULL.


in.CustomerNames

returns a list of customer names that exist on the records on the in pipe. Please note that only recordsets can be indexed in this way, and lists must be accessed using numerical indices, as above.


in.$attributeName

will return the same as in.CustomerNames, if $attributeName is set to the string value $attributeName = "CustomerNames".

See Also

Please let us know if we could improve this page feedback@phixflow.com