Show: Delphi C++
Display Preferences

System.VarClear

From XE2 API Documentation
Jump to: navigation, search

Delphi

procedure VarClear(var V: Variant);

C++

extern void __fastcall  VarClear(Variant& v);

Contents

Properties

Type Visibility Source Unit Parent
procedure
function
public
System.pas
sysvari.h
System System

Description

Empties a Variant so that it is unassigned.

Calling VarClear is equivalent to assigning the Unassigned constant to the Variant. V can be either a Variant or an OleVariant, but it must be possible to assign a value to it (it must be an lvalue).

After calling VarClear, the VarIsEmpty function returns true, and the VarType function returns varEmpty. Using an unassigned variant in an expression causes an exception to be thrown. Likewise, if you attempt to convert an unassigned Variant to another type (using VarAsType ), an exception is thrown.

Note: Do not confuse clearing a Variant, which leaves it unassigned, with assigning a Null value. A Null Variant is still assigned, but has the value Null. Unlike unassigned Variants, Null Variants can be used in expressions and can be converted to other types of Variants.

See Also


Code Examples

Personal tools
Previous Versions
Translations