|
| ELZED | Documentation | The Details | API |
| lzGetStrVarValueBThe lzGetStrVarValueB function returns the value of the named Elzed string variable. BSTR lzGetStrVarValueB(| | 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 string variable. |
Return Value| | Returns a BSTR containing the value of the named string variable. |
Remarks| | This function is provided to support Visual Basic. For VB, the lzGetStrVarValue API call maps to this function. The caller is responsible for disposing of the returned BSTR. In general, VB will handle this for you automatically.
This function fails silently and returns a value of NULL if the named variable is not found or is not of string 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 lzGetStrVarValueB active in Elzed 2.5.0 (207: 2.5.0) |
See Also |
| |