|
| ELZED | Documentation | The Details | API |
| lzGetComplexArrayElementThe lzGetComplexArrayElement function gets both the real and imaginary parts of the indicated Elzed array element. bool lzGetComplexArrayElement(| | char cScope, | | // the scope of the array | | | const char* szVariableName, | | // the name of the array | | | double* dpRealValue, | | // pointer to the real part | | | double* dpImagValue, | | // pointer to the imaginary part | | | long lDimensions, | | // the number of array dimensions | | | long lDim1, | | // first array index | | | long lDim2, | | // second array index | | | long lDim3, | | // third array index | | | long lDim4, | | // fourth array index | | | long lDim5, | | // fifth array index | | | long lDim6 | | // sixth array index |
Parameters| cScope | | | A character code indicating the scope of the array. 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 array. |
| dpRealValue | | | A pointer to a double-precision variable which will contain the real part of the complex array element. |
| dpImagValue | | | A pointer to a double-precision variable which will contain the imaginary part of the complex array element. |
| lDimensions | | | A long integer value indicating the total number of array dimensions. |
| lDim1 | | | A long integer value indicating the first array dimension index. |
| lDim2 | | | A long integer value indicating the second array dimension index. Pass zero for this parameter if the dimension is not used. |
| lDim3 | | | A long integer value indicating the third array dimension index. Pass zero for this parameter if the dimension is not used. |
| lDim4 | | | A long integer value indicating the fourth array dimension index. Pass zero for this parameter if the dimension is not used. |
| lDim5 | | | A long integer value indicating the fifth array dimension index. Pass zero for this parameter if the dimension is not used. |
| lDim6 | | | A long integer value indicating the sixth array dimension index. Pass zero for this parameter if the dimension is not used. |
Return Value| | Returns TRUE if the complex array element is found, FALSE otherwise. The real and imaginary parts are returned in the variables pointed to by dpRealValue and dpImagValue, respectively. |
Remarks| | The named Elzed array must already exist.
It probably goes without saying that the number of dimensions declared must match the number of dimensions actually in the array. The dimension parameters must be used in order starting with the first one (no skipping). |
Versions| | Introduced in Elzed 1.0.0
Modified in Elzed 2.4.0 -- Array name parameter (char*) is now declared const. | | | This page describes the version of lzGetComplexArrayElement active in Elzed 2.5.0 (199: 2.5.0) |
See Also |
| |