|
| ELZED | Documentation | The Details | API |
| lzGetStrArrayElementBThe lzGetStrArrayElementB function returns the value of the indicated Elzed string array element in a BSTR. BSTR lzGetStrArrayElementB(| | char cScope, | | // the scope of the array | | | const char* szVariableName, | | // the name of the array | | | 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 new 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 new array. Must be unique within the indicated scope. |
| 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 a BSTR containing the string array element. |
Remarks| | This function is provided to support Visual Basic. For VB, the lzGetStrArrayElement 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.
The named Elzed string array must already exist.
This function fails silently and returns a value of NULL if the named array is not found, is not of string type, or if there is a dimension mismatch. Use lzGetLastErrorID or lzGetLastErrorText to find out what failed.
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.2.0
Modified in Elzed 2.4.0 -- Array name parameter (char*) is now declared const. | | | This page describes the version of lzGetStrArrayElementB active in Elzed 2.5.0 (205: 2.5.0) |
See Also |
| |