|
| ELZED | Documentation | The Details | API |
| lzGetComplexVarValueThe lzGetComplexVarValue function returns the value of the named Elzed complex numeric variable. bool lzGetComplexVarValue(| | char cScope, | | // the scope of the variable | | | const char* szVariableName, | | // the name of the variable | | | double* dpRealPart, | | // pointer to the real part | | | double* dpImagPart | | // pointer to the imaginary part |
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. |
| dpRealPart | | | A pointer to a double-precision variable which will receive the real part of the complex numeric variable. |
| dpImagPart | | | A pointer to a double-precision variable which will receive the imaginary part of the complex numeric variable. |
Return Value| | Returns TRUE if the target variable is found, FALSE otherwise. |
Remarks| | This function fails silently and returns values of zero if the named variable is not found or is not of numeric type. Use lzGetLastErrorID or lzGetLastErrorText to find out what failed. |
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 lzGetComplexVarValue active in Elzed 2.5.0 (200: 2.5.0) |
See Also |
| |