System.Variants.VarArrayGet

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function VarArrayGet(const A: Variant; const Indices: array of Integer): Variant;

C++

extern DELPHI_PACKAGE System::Variant __fastcall VarArrayGet(const System::Variant &A, int const *Indices, const int Indices_High);

Properties

Type Visibility Source Unit Parent
function public
System.Variants.pas
System.Variants.hpp
System.Variants System.Variants

Description

Returns a Variant that represents a single value from a multi-dimensional Variant array.

Use VarArrayGet to obtain the value of a single cell from a multi-dimensional Variant array.

A is the Variant array that contains the desired value.

Indices is an array of index values, one for each dimension of the array.

Note: Indices_Size is the index of the last value in Indices (one less than the number of dimensions in the array).

If the values specified by Indices are out of bounds, VarArrayGet raises an EVariantBadIndexError.

See Also


Code Examples