|
| ELZED | Documentation | The Details | API |
| lzLinkStrVarThe lzLinkStrVar function establishes the named variable within Elzed and associates it with the passed-in host string variable. bool lzLinkStrVar(| | char cScope, | | // the scope of the linked variable | | | const char* szVariableName, | | // the name of the linked variable | | | char* cpVariable, | | // pointer to the host character string | | | long lStringSize | | // maximum string size |
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 new variable. Must be unique within the indicated scope. |
| cpVariable | | | A pointer to a null-termintated character string to be linked to the target Elzed variable. |
| lStringSize | | | A long integer value indicating the maximum capacity (in characters) of the string variable. |
Return Value| | Returns TRUE if the variable was successfully linked, otherwise FALSE. |
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 lzLinkStrVar active in Elzed 2.5.0 (220: 2.5.0) |
See Also |
| |