Skip to main content
Version: 20 R7 BETA

SAX Get XML node

SAX Get XML node ( document ) : Integer

ParameterTypeDescription
documentTimeReference of open document
Function resultIntegerEvent returned by function

Description

The SAX Get XML node command returns a long integer that indicates the type of SAX event returned while the XML document referenced in document is parsed.

Events that can be returned are available as “XML” theme constants:

ConstantTypeValue
XML CDATAInteger7
XML CommentInteger2
XML DATAInteger6
XML End DocumentInteger9
XML End ElementInteger5
XML EntityInteger8
XML Processing InstructionInteger3
XML Start DocumentInteger1
XML Start ElementInteger4

Example

The following example processes an event:

 DocRef:=Open document("";"xml";Read Mode)
 If(OK=1)
    Repeat
       MyEvent:=SAX Get XML node(DocRef)
       Case of
          :(MyEvent=XML Start Document)
             DoSomething
          :(MyEvent=XML Comment)
             DoSomethingElse
       End case
    Until(MyEvent=XML End Document)
    CLOSE DOCUMENT(DocRef)
 End if

System variables and sets

If the command has been executed correctly, the system variable OK is set to 1. Otherwise, it is set to 0 and an error is generated.

Properties

Command number860
Thread safe
Modifies variablesOK, error