Slice

Description

The Slice() method returns a shallow copy of a portion of an array into a new array selected from begin to end (end not included) where begin and end represent the index of items in that array. The original array will not be modified.

Syntax

expression.Slice(StartIndex, [EndIndex])

Parameters

Name: StartIndex
Type: Long
Necessity: Required
Description: The index at which to begin extraction. A negative index can be used, indicating an offset from the end of the sequence. Slice(-2) extracts the last two elements in the sequence. If begin is undefined, slice begins from the value of the LowerBound property. If begin is greater than the length of the sequence, an empty array is returned.

Name: EndIndex
Type: Long
Necessity: Optional
Description: The index before which to end extraction. Slice extracts up to but not including end. For example, Slice(1,4) extracts the element at index 1 through the element indexed at 4 (elements indexed 1, 2, and 3). A negative index can be used, indicating an offset from the end of the sequence. Slice(2,-1) extracts the third element through the second-to-last element in the sequence. If EndIndex is omitted or is greater than the UpperBound value, Slice extracts through the end of the sequence (the UpperBound value).

Returns

Type: Variant()
Description: A new array containing the extracted elements.

Example

Public Sub SliceExample()
    Dim citrus() As Variant
    Dim MyArray As BetterArray
    Set MyArray = New BetterArray

    MyArray.Push "Banana", "Orange", "Lemon", "Apple", "Mango"
    citrus = MyArray.Slice(1, 3)
    ' expected output:
    ' citrus =  "Orange", "Lemon"
    ' MyArray still contains all of: "Banana", "Orange", "Lemon", "Apple", "Mango"
End Sub

Inspiration

Back to Docs