|
| ELZED | Documentation | The Details | API |
| lzGetStrArrayElementByHandleThe lzGetStrArrayElementByHandle function returns the value of the indicated element of the indicated string array. char* lzGetStrArrayElementByHandle(| | LZObjectHandle hHandle, | | // a handle to 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| hHandle | | | An LZObjectHandle to the array. |
| 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 pointer to the string array element. |
Remarks| | See lzGetStrArrayElementByHandleB for Visual Basic support.
The Elzed string array must already exist.
This function fails silently and returns a value of NULL if the 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 2.4.0 | | | This page describes the version of lzGetStrArrayElementByHandle active in Elzed 2.5.0 (252: 2.5.0) |
See Also |
| |