System.Variants.VarArrayRef

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function VarArrayRef(const A: Variant): Variant;

C++

extern DELPHI_PACKAGE System::Variant __fastcall VarArrayRef(const System::Variant &A);

Properties

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

Description

Returns a reference to the specified variant array.

Use VarArrayRef to reference a variant array when a referenced variant array is expected in an API call. VarArrayRef creates a new variant array of the same type as A, but with an extra level of indirection if A does not include the varByRef type bit. The returned variant includes the varByRef type bit.

If A is not an array, VarArrayRef raises an EVariantInvalidArgError exception.

See Also