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 

lzSetBoolVar

The lzSetBoolVar function finds the named boolean variable within the current context and assigns it the passed-in value.

bool lzSetBoolVar(
   char cScope,   // the scope of the target variable
   const char* szVariableName,   // the name of the target variable
   bool bVariableValue   // the value of the target variable
);

Parameters

cScope
   A character code indicating the scope of the new 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 target variable. Must be unique within the indicated scope.

bVariableValue
   A boolean value to be applied to the target variable.

Return Value

   Returns TRUE if the target variable was successfully found or created, otherwise FALSE.

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 lzSetBoolVar active in Elzed 2.5.0 (224: 2.5.0)

See Also



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