BARfly Help - BAR Interfacial Function Reference - BAR type lookup functions

  BAR::Get_Variable_Type

Purpose: To retrieve info on a variable type.

Value_Info Get_Variable_Name(Variable_Identifier Variable_ID);


Parameters

Variable_Identifier Variable_ID: A variable identifier (generally name or UID).

Return Values

  • Normal: Results for unit type.
  • Invalid_Value_Info: Error.

Remarks

This function retrieves information about the type of a variable, identified by Variable_ID. The information is placed in a Value_Info type.

The function will fail (return Invalid_Value_Info) if Variable_ID is not a valid identifier for a variable.

Variable_ID is a platform-dependent identifier.

Compatibility

  All Platforms Win32 C++ LIB
BAR version 1.1 1.1
  All Platforms Win32
BARfly version 1.0 1.0


  See also:  [BAR type lookup functions] [BAR loading and saving functions] [BAR node navigation functions]
[BAR node information functions] [BAR data reading functions] [BAR data writing functions] [BAR miscellaneous functions]


BARfly Help Copyright © 2009 Christopher Allen