Operator Type:
Operator Scope of Action:
Operator Purpose:
Operator First Added:
Operator Altered:
Function [other Function type actions]
Item [operators of similar scope]
Stream parsing [other Stream parsing operators]
9.1.0
Stream.captureWord("targetAttribute")
Stream.captureWord
Finds and stores the next word in the string in the specified targetAttribute, and returns the string that follows this word. Fails if the string is empty or entirely white space.
What constitutes a word
If the targetAttribute is omitted the Stream is advanced to the end so processing ceases.
The attribute given for targetAttribute can be a quoted literal string, e.g. ("Text") for $Text. Or it can be an unquoted variable/loopVariable, e.g. (vString) for a variable 'vString'.