ALINES( ) Function

Example   See Also

Copies each line in a character expression or memo field to a corresponding row in an array.

Syntax

ALINES(ArrayName, cExpression [, lTrim])

Returns

Numeric

Arguments

ArrayName

Specifies the name of the array to which the lines in the character expression or memo field are copied. If the array you specify doesn't exist, Visual FoxPro automatically creates the array. If the array exists and isn't large enough to contain all the lines in the memo field, Visual FoxPro automatically increases the size of the array. If the array is larger than necessary, Visual FoxPro truncates the array.

cExpression

Specifies the character expression or memo field containing the lines copied to the array. If cExpression is the empty string or the null value, an array with a single row is created and the row contains the empty string.

lTrim

Specifies that leading and trailing blanks are removed from the lines copied to the array. If lTrim is true (.T.), leading and trailing blanks are removed from the lines. If lTrim is false (.F.) or is omitted, leading and trailing blanks are not removed.

Remarks

ALINES( ) returns the number of rows in the array (or, identically, the number of lines in the character expression or memo field). The first line of the character expression or memo field is copied to the first row of the array, the second line of the character expression or memo field is copied to the second row of the array, and so on.

A line feed (CHR(10)) or carriage return (CHR(13)) character denotes the end of a line. The end of the line can also be denoted with either combination of these two characters (CHR(10) + CHR(13) or CHR(13) + CHR(10)).

ALINES( ) provides an easy way to parse lines in a character expression or memo field. While MLINES( ) can also be used to parse a character expression or memo field, ALINES( ) is faster and requires less programming. Also, ALINES( ) is not affected by the value of SET MEMOWIDTH.

You must have sufficient memory to copy the lines in a large memo field to an array. Visual FoxPro generates an error message if you lack sufficient memory.