GetVarMetadata

Description:              Every variable object contains an embedded value. This function is used to retrieve those values.

Warning:               For use by advanced programmers only.  Effective use of this function requires a thorough understanding of VTS programming. 

Returns:                    Varies

Usage:                       Script

Format:                      GetVarMetadata(Variable)

Parameters:             Variable     { Variable }  { required }  { no default }

                                              A variable handle, such as would be returned from the FindVariable or AddVariable functions.

Comments:               Commonly used in conjunction with SetVarMetadata, FindVariable or AddVariable.  Note that type data for each variable is stored within the variable using metadata.

Example:

< 

TestMod

[

  X;

  Y;

  Var;

]

Main [

  If ! Valid(X);

  [

    X = "This is the value of X"

    Var = FindVariable("X", Self(), 0, 0);

    SetVarMetadata(Var, "This is the metadata in variable X");

    Y = GetVarMetadata(Var);

  ]

  ZText(50, 100, Concat("X: ", X), 14, 0);

  ZText(50, 120, Concat("Y: ", Y), 14, 0);

]

> 

 

See Also:

SetVarMetadata | FindVariable | AddVariable