KRASCHE
&
BYRNE
         ELZED  HOME       NEWS       DOCS       DOWNLOADS       LICENSING       SUPPORT       FAQ       ABOUT  US

What's An Elzed?
Features
Licensing
Downloads
Documentation
Elzed News
    ELZED 
 Documentation 
 The Details 
 API 

lzGetNumVarValue

The lzGetNumVarValue function returns the value of the named Elzed numeric variable.

double lzGetNumVarValue(
   char cScope,   // the scope of the variable
   const char* szVariableName   // the name of the variable
);

Parameters

cScope
   A character code indicating the scope of the desired variable. The character code must be one of the following values:

Code
Constant
Meaning
'C'
kCosmicScope
Available in all contexts
'G'
kGlobalScope
Available in current context only


szVariableName
   A null-terminated character string containing the name of the desired variable.

Return Value

   Returns the value of the named numeric variable.

Remarks

   This function fails silently and returns a value of zero if the named variable is not found or is not of numeric type. Use lzGetLastErrorID or lzGetLastErrorText to find out what failed.

Versions

   Introduced in Elzed 1.0.0
Modified in Elzed 2.4.0 -- Variable name parameter (char*) is now declared const.
   This page describes the version of lzGetNumVarValue active in Elzed 2.5.0 (203: 2.5.0)

See Also



  Copyright  ©  MMXXV  by  R R Le Cropane   •   All Rights Reserved   •   Terms of Use   •   Privacy Policy