|Description:||Removes the first (leftmost) element of an array and returns it. The array is modified by reference.|
|Syntax:||array call fn_vbs_arrayShift|
|Return Value:||Array - Element removed from left of the array.|
When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.
_array = [1,2,3]; _num = _array call fn_vbs_arrayShift; // Result: _array now holds [2,3], _num holds 1
|See also:||fn vbs arrayShiftStack (shifts multiple items), fn vbs arrayUnShift (reverse of shift), fn vbs arrayPop (removes items from the other end of the array)|
- Posted on August 28, 2008 - 18:22
- Has a bug in versions before 1.22: The last element is removed also.