|
| ELZED | Documentation | The Details | API |
| lzGetBoolVarValueThe lzGetBoolVarValue function returns the value of the named Elzed boolean variable. bool lzGetBoolVarValue(| | 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 variable. |
Remarks| | This function fails silently and returns a value of zero if the named variable is not found or is not of boolean type. Use lzGetLastErrorID or lzGetLastErrorText to find out what failed. |
Versions| | Introduced in Elzed 1.2.0
Modified in Elzed 2.4.0 -- Variable name parameter (char*) is now declared const. | | | This page describes the version of lzGetBoolVarValue active in Elzed 2.5.0 (198: 2.5.0) |
See Also |
| |