Tinderbox v9 Icon

Stream.captureWord[(targetAttributeStr)]


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

 [More on optional operator arguments]


Stream.captureWord(targetAttributeStr)

Stream.captureWord

Finds and stores the next word in the string in the specified targetAttributeStr, a quoted name of an attribute, and returns the string that follows this word. Fails if the string is empty or entirely white space.

What constitutes a word

If the targetAttributeStr is omitted the Stream is advanced to the end so processing ceases.

The attribute given for targetAttributeStr 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'.



A Tinderbox Reference File : Automating Tinderbox : Coding : Action Code : Operators : Full Operator List : Stream.captureWord[(targetAttributeStr)]