Sign in Join
FPDoc Onlineexperiment

VarArrayLock function

In unit Variants

get a pointer to data of a variant array.

Declaration

pascal
function VarArrayLock(const A: Variant): Pointer

Arguments

A

Variant array to get data from.

Function result

A pointer to the data of the variant.

Description

VarArrayLock returns a pointer to the data of an array-typed variant A and locks the variant. The pointer can then be used to manipulate the data of the array and be sure that the data is not modified by another process or thread. While the data is not released using VarArrayUnlock the variant cannot be changed or released, it is therefor impperative that the variant is again released. Memory leaks will be the result if this is not done.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.