XEC_CTL_FIN

Description

This indicates that the caller wishes to end the current parse at the current position in the XML document. The PIMA is re-initialized to allow it to be used on a new parse request. To free up all resources associated with the parse instance, the caller should use the termination service. If the caller issues this control operation after document fragment parsing is enabled, then this control operation will disable document fragment parsing and re-initialize the PIMA for a new parse request. The loaded fragment context will remain in storage and become active when fragment mode is enabled.

Syntax

call gxl1ctl,(PIMA,
              ctl_option,
              ctl_data,
              return_code,
              reason_code);

Parameters

PIMA

Supplied parameter

Type:: Character string
Length:: Variable

The name of the Parse Instance Memory Area (PIMA which has been previously initialized with a call to GXL1INI (GXL4INI)).

ctl_option

Supplied parameter

Type:: Integer
Length:: Fullword

The name of a fullword that contains an integer value initialized to XEC_CTL_FRAGMENT_PARSE.

ctl_data

Supplied and returned parameter

Type:: Address
Length:: Fullword (Doubleword)

This parameter must contain the address of a fullword (doubleword) where the service will store the address of the diagnostic area, which is mapped by macro GXLYXD. This provides additional information that can be used to debug problems in data passed to the z/OS XML parser. The diagnostic area resides within the PIMA, and will be overlaid on the next call to the z/OS XML parser.

return_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword where the service stores the return code.

reason_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of a fullword where the service stores the reason code. The reason code is only relevant if the return code is not XRC_SUCCESS

All parameters in the parameter list are required.