`XML GET STATUS-TEXT`

This statement has no parameters.

Description

A non-successful termination of an XML statement may cause one or more lines of descriptive text to be placed in a queue. The XML GET STATUS-TEXT statement fetches the next line of descriptive text into XML-StatusText of XML-data-group.

The statement is always successful (that is, does not set XML-Status of XML-data-group), but returns an indicator of whether there are additional lines of descriptive text available. The following condition-name on the indicator is also described in the copy file lixmldef.cpy:

XML-NoMore. There are no further lines of descriptive text available.

An example of processing the status information in this item is found below and in the copy file lixmldsp.cpy.

Example

Display-Status.
    If Not XML-IsSuccess
        Perform With Test After Until XML-NoMore
            XML GET STATUS-TEXT
            Display XML-StatusText
        End-Perform
    End-If.

Note: In the lixmldef.cpy copy file, the definition of the XML-StatusText field may be changed from the default of PIC X(80) to change the size of the buffer used to contain XML status information One way to accomplish this is to use the phrase REPLACING ==XML-StatusText PIC X(80)== BY ==XML-StatusText PIC X(320)== in the COPY statement that copies lixmlall.cpy to set the returned status text line to 320, for example. A less desirable method to change the buffer size is to edit the copy file directly.