BuiltIn.VarArrayLowBound Method

Applies to TestComplete 15.69, last modified on November 13, 2024

Description

The VarArrayLowBound method returns the low bound for a particular dimension in the Arr array, which must be created with the CreateVariantArray, CreateVariantArray2 or CreateVariantArray3 function. Use the VarArrayLowBound and VarArrayHighBound functions to iterate through the elements of an array when the number of elements is unknown.

This method is available if the BuiltIn plugin is installed and enabled. The plugin is installed and enabled by default.

Declaration

BuiltIn.VarArrayLowBound(Arr, Dim)

Arr [in]    Required    Variant    
Dim [in]    Required    Integer    
Result Integer

Applies To

The method is applied to the following object:

Parameters

The method has the following parameters:

Arr

The desired array whose elements are of the Variant type.

Dim

The index of the array's dimension whose low bound you want to get. The leftmost dimension has index 1, the second dimension index is 2, etc.

Result Value

An integer value that means the low bound of the desired dimension of the specified array.

See Also

CreateVariantArray Method
CreateVariantArray2 Method
CreateVariantArray3 Method
VarArrayRedim Method
VarArrayHighBound Method

Highlight search results