|
| ELZED | Documentation | The Details | API |
| lzSetStrVarThe lzSetStrVar function finds the named string variable within Elzed and assigns it the passed-in value. bool lzSetStrVar(| | char cScope, | | // the scope of the target variable | | | const char* szVariableName, | | // the name of the target variable | | | const char* szVariableValue | | // the value of the target variable |
Parameters| cScope | | | A character code indicating the scope of the target 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. |
| szVariableValue | | | A null-terminated character string value to be applied to the target variable. |
Return Value| | Returns TRUE if the variable was successfully found or created, otherwise FALSE. |
Remarks| | This call will not create a string variable. Use lzCreateStrVar or lzLinkStrVar to establish the string within Elzed before calling lzSetStrVar.
Elzed copies the contents of the passed-in string value rather than saving a copy of the pointer. |
Versions| | Introduced in Elzed 1.0.0
Modified in Elzed 2.4.0 -- String (char*) parameters are now declared const. | | | This page describes the version of lzSetStrVar active in Elzed 2.5.0 (237: 2.5.0) |
See Also |
| |