Tinderbox v10 Icon

String.captureXML()


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Data Type Returned: 

Operator First Added: 

Operator in Current Baseline: 

Operator Last Altered: 

 Operator  [other Operator type actions]

 Item  [operators of similar scope]

 Stream parsing  [other Stream parsing operators]

 

 v9.1.0

 

 As at baseline


String.captureXML()

String.captureXML

Attempts to parse the string as fully/partially XML and fails if unsuccessful. The parsed XML is saved as the current XML (stream) object.

Essentially, this re-scopes the current stream so that it contains only the contents of the first section of XML detected within the original stream. The focus of the stream parsing is set to the beginning of the extracted XML code.

Only one XML object may be current at any time. If the source stream contains multiple discrete XML code sections, only the first is detected/used.


See also—notes linking to here: