postArrayDec

postArrayDec( 
g_array 
g_index 
) 
=> n_oldValue

Description

Takes an array or an associated table element with an index g_index, decrements its value by one, stores the new value back into the array, and returns the original value. This function is a prefix form of s--.

If the associated table element is not a number or g_index is not valid, it returns an error.

Arguments

g_array	An array or an associated table.
g_index	An index in the array or an associated table.

Value Returned

n_oldValue

Original value of the element.

Examples

a = vector(1 2 34)
array@0x8382028
postArrayDec(a 2)
=> 34 

postArrayDec(a -4) 
*Error* setarray: array index out of bounds - 
postArrayDec(a -4)

Related Topics

postArrayInc

postArraySet

postArrayDec

preArrayInc

preArraySet

Return to top