EXTCOLS

The EXTCOLS function extracts specified columns from each line of a multiline text value. The function returns a multiline text value that includes only the extracted columns.

Columns refer to the character positions in each line of a multiline text value. The first character in each line is in column one, the second is in column two, and so on.

Return Value

TEXT or NTEXT

Syntax

EXTCOLS(text-expression [start [numcols]])

Arguments

text-expression

The text expression from which the specified columns should be extracted. When text-expression is a multiline text value, the characters in the specified columns are extracted from each one of its lines.

When you specify a TEXT expression, the return value is TEXT. When you specify an NTEXT expression, the return value is NTEXT.

start

AnINTEGER, between 1 and 4000, that represents the column position at which to begin extracting. The column position of the first character in each line of text-expression is 1.

numcols

An INTEGER that represents the number of columns to be extracted. When you do not specify numcols, EXTCOLS extracts all the characters from the starting column to the end of each line.

Notes

EXTCOLS always returns a text value that has the same number of lines as text-expression, though some of the lines may be empty.

When you specify a starting column that is to the right of the last character in a given line in text expression, the corresponding line in the return value will be empty.

When you specify a length that exceeds the number of characters that follow the starting position in a given line in text expression, the corresponding line in the return value will include only existing characters. EXTCOLS does not return spaces at the end of the line to fill in the missing columns.

Examples

DEFINE citylist VARIABLE TEXT
citylist = 'Boston\nHouston\nChicago'