Difference between revisions of "ASTORE()"

From Lianjapedia
Jump to: navigation, search
(Description)
(Description)
 
Line 9: Line 9:
  
 
==Description==
 
==Description==
The ASTORE() function fills the <array> with character strings from <expC1> which are separated by the character specified in <expC2>.  The array will be created if it has not been previously declared.  For an existing array - which should be a one dimensional array - the character strings are copied into the array elements until either all the elements are filled, or all the strings are copied and the length of the array is automatically shortened to the number of elements stored in it.  The ASTORE() function returns the number of character strings copied into the array.  The ASTORE() function is most commonly used in combination with menu commands where multiple selections can be made.
+
The ASTORE() function fills the <array> with character strings from <expC1> which are separated by the character specified in <expC2>.  The array will be created if it has not been previously declared.  For an existing array - which should be a one dimensional array - the character strings are copied into the array elements and the length of the array is automatically resized.  The ASTORE() function returns the number of character strings copied into the array.  The ASTORE() function is most commonly used in combination with menu commands where multiple selections can be made.
  
 
Note that if the <array> specified has the same name as an existing memory variable that is not a one dimensional array, the memory variable will not be overwritten and an error will be returned.
 
Note that if the <array> specified has the same name as an existing memory variable that is not a one dimensional array, the memory variable will not be overwritten and an error will be returned.

Latest revision as of 09:47, 12 October 2020

Purpose

Function to fill an array with character strings that are separated with a specified character

Syntax

ASTORE(<array>, <expC1>, <expC2>)

See Also

AADD(), AAVERAGE(), ACOPY(), ADEL(), ADESC(), ADIR(), AELEMENT(), AFIELDS(), AFILL(), AINS(), ALEN(), ALINES(), AMAX(), AMIN(), APPEND FROM ARRAY, ARRAY(), ASCAN(), ASIZE(), ASORT(), ASTRING(), ASUBSCRIPT(), ASUM(), COPY TO ARRAY, DECLARE, DIMENSION, GATHER, IN_ARRAY(), IS_ARRAY(), LOCAL, PRIVATE, PUBLIC, RELEASE, RESTORE, SAVE, SCATTER

Description

The ASTORE() function fills the <array> with character strings from <expC1> which are separated by the character specified in <expC2>. The array will be created if it has not been previously declared. For an existing array - which should be a one dimensional array - the character strings are copied into the array elements and the length of the array is automatically resized. The ASTORE() function returns the number of character strings copied into the array. The ASTORE() function is most commonly used in combination with menu commands where multiple selections can be made.

Note that if the <array> specified has the same name as an existing memory variable that is not a one dimensional array, the memory variable will not be overwritten and an error will be returned.

Example

declare aNums[10]
? alen(aNums)
        10
nelements = ASTORE(aNums, "one, two, three", ",")
? nelements
         3
? alen(aNums)
         3
// Another Example
menu fields select "+"
declare aMenu[512]
nelements = astore(aMenu, menuitem(), "+")