KRASCHE
&
BYRNE
         ELZED  HOME       NEWS       DOCS       DOWNLOADS       LICENSING       SUPPORT       FAQ       ABOUT  US

What's An Elzed?
Features
Licensing
Downloads
Documentation
Elzed News
    ELZED 
 Documentation 
 The Details 
 API 

lzCreateNumArray

The lzCreateNumArray function establishes the named numeric array within Elzed.

LZObjectHandle lzCreateNumArray(
   char cScope,   // the scope of the new array
   const char* szVariableName,   // the name of the new array
   long lDimensions,   // the number of array dimensions
   long lDim1,   // first array dimension
   long lDim2,   // second array dimension
   long lDim3,   // third array dimension
   long lDim4,   // fourth array dimension
   long lDim5,   // fifth array dimension
   long lDim6   // sixth array dimension
);

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 size of the first array dimension.

lDim2
   A long integer value indicating the size of the second array dimension. Pass zero for this parameter if the dimension is not used.

lDim3
   A long integer value indicating the size of the third array dimension. Pass zero for this parameter if the dimension is not used.

lDim4
   A long integer value indicating the size of the fourth array dimension. Pass zero for this parameter if the dimension is not used.

lDim5
   A long integer value indicating the size of the fifth array dimension. Pass zero for this parameter if the dimension is not used.

lDim6
   A long integer value indicating the size of the sixth array dimension. Pass zero for this parameter if the dimension is not used.

Return Value

   Returns a handle to the created array if successful; NULL otherwise.

Remarks

   The elements of the new numeric array will be initialized to zero.

It probably goes without saying that the number of dimensions declared must match the number of non-zero dimension parameters. 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 -- Now returns an LZObjectHandle. Array name parameter (char*) is now const.
   This page describes the version of lzCreateNumArray active in Elzed 2.5.0 (181: 2.5.0)

See Also



  Copyright  ©  MMXXV  by  R R Le Cropane   •   All Rights Reserved   •   Terms of Use   •   Privacy Policy