Operator Type:
Operator Scope of Action:
Operator Purpose:
Operator First Added:
Operator Last Altered:
Operator Has Optional Arguments:
Function [other Function type actions]
Item [operators of similar scope]
Stream parsing [other Stream parsing operators]
Baseline
As at baseline
Syntax note: Operators without any defined mandatory arguments may omit their empty closing parentheses
String.captureLine(targetAttributeStr)
String.captureLine()
String.captureLine
Optionally stores the rest of the line (paragraph) in the specified targetAttributeStr, a quoted name of an attribute, and returns the string that follows this line and the String moves forwards to the end of the current line.
If the targetAttributeStr is omitted the String is advanced to the next line without any data being saved.
The value given for targetAttributeSt can be:
- a quoted literal string, e.g.
("Text")for $Text. - an unquoted variable/loopVariable, e.g.
(vString)for a variable 'vString'.
For example, if the stream is "Goodbye cruel world.\nHello again.":
vString = $Text.captureWord("SomeAttribute").captureLine();
results in attribute $SomeAttribute holding the value "Hello" and the variable vText holding the value " cruel world.".