Difference between revisions of "ALINES()"

From Recital Documentation Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{YLM to do}}
 
{{YLM to do}}
Currently only supports 1 parsing string
+
Currently only supports 1 parsing string - check and add example
 
==Purpose==
 
==Purpose==
 
Function to fill an array with character strings that are separated with a newline or other specified parsing string
 
Function to fill an array with character strings that are separated with a newline or other specified parsing string
Line 43: Line 43:
 
nVar = alines(aVar, cVar)
 
nVar = alines(aVar, cVar)
 
echo "Program has " + ltrim(str(nVar)) + " lines\n"
 
echo "Program has " + ltrim(str(nVar)) + " lines\n"
 
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(), "+")
 
 
</code>
 
</code>
  

Revision as of 16:49, 27 November 2009

Template:YLM to do Currently only supports 1 parsing string - check and add example

Purpose

Function to fill an array with character strings that are separated with a newline or other specified parsing string


Syntax

ALINES(<array>, <expC1> [<expN> [, <expC2>]])


See Also

AADD(), AAVERAGE(), ABROWSE(), ACHOICE(), ACOL(), ACOPY(), ADEL(), ADESC(), ADIR(), AELEMENT(), AFIELDS(), AFILL(), AINS(), ALEN(), AMAX(), AMIN(), APPEND FROM ARRAY, AROW(), ARRAY(), ASCAN(), ASIZE(), ASORT(), ASTORE(), ASTRING(), ASUBSCRIPT(), ASUM(), COPY TO ARRAY, DBEDIT(), DECLARE, DIMENSION, FILETOSTR(), GATHER, IN_ARRAY(), LOCAL, MENU AT, MENU BROWSE, MENU FIELDS, MENU FILES, MENU FROM, MENUITEM(), PRIVATE, PUBLIC, RELEASE, RESTORE, SAVE, SCATTER


Description

The ALINES() function fills the <array> with character strings from <expC1> which are separated by a newline. If the optional <expC2> is included, it specifies an alternative parsing string. This string of one or more characters is used to signify where the line should be broken instead of the newline character.

If the <array> does not already exist it will be created. The character strings are copied into the array elements until all the strings are copied. If the <array> is pre-declared, it will be automatically shortened to the number of elements stored in it. The ALINES() function returns the number of character strings copied into the array.

The <expN> is the sum of the required flags:


Bit Value (additive) Description
0 1 Removes leading and trailing spaces from lines, or for memos and BLOBs, removes trailing zeroes (0) instead of spaces. This is the default.
1 2 Include the last element in the array even if the element is empty.
2 4 Do not include empty elements in the array.
3 8 Case-insensitive parsing.
4 16 Include the parsing characters.


Example

// ali.prg - 4 lines
cVar=filetostr("ali.prg")
nVar = alines(aVar, cVar)
echo "Program has " + ltrim(str(nVar)) + " lines\n"


Products

Recital, Recital Server