The following functions can be used to manipulate an array.

Click each function name in the table below for more details of it, with examples.

Functions

push

Usage: array.push("x")

Adds one or more elements to the end of an array and returns the new length of the array.

Example:

• myArray = ["a","b","c","d"]
• echo "myArray = "+myArray
• returnVal = myArray.push("e")
• echo "myArray = "+myArray
• echo "returnVal = "+returnVal

Result:

• a,b,c,d
• a,b,c,d,e
• 5

pop

Usage: array.pop()

Removes the last element from an array and returns the value of that element.

Example:

• myArray = ["a","b","c","d"]
• echo "myArray = "+myArray
• returnVal = myArray.pop()
• echo "myArray = "+myArray
• echo "returnVal = "+returnVal

Result:

• a,b,c,d
• a,b,c
• d

unshift

Usage: array.unshift("x")

Adds one or more elements to the beginning of an array and returns the new length of the array. The other elements in the array are moved from their original position, i, to i+1.

Example:

• myArray = ["a","b","c","d"]
• echo "myArray = "+myArray
• returnVal = myArray.unshift("_")
• echo "myArray = "+myArray
• echo "returnVal = "+returnVal

Result:

• a,b,c,d
• _,a,b,c,d
• 5

shift

Usage: array.shift()

Removes the first element from an array and returns that element. The remaining array elements are moved from their original position, i, to i-1.

Example:

• myArray = ["a","b","c","d"]
• echo "myArray = "+myArray
• returnVal = myArray.shift()
• echo "myArray = "+myArray
• echo "returnVal = "+returnVal

Result:

• a,b,c,d
• b,c,d
• a

CategoryFunctions