GXL1TRM (GXL4TRM) — terminate a parse instance

Description

The GXL1TRM callable service releases all resources obtained (including storage) by the z/OS XML parser and resets the PIMA so that it can be re-initialized or freed.

Performance Implications

There are no performance implications.

Syntax

call gxl1trm,(PIMA,
             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)).

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.

Return and Reason Codes:

On return from a call to this service, register 15 will contain the return code. The return and reason code are both also set as output parameters. The value of the reason code is undefined when the return code has no associated reasons. Return and reason codes are defined in macro GXLYXR. For reason code descriptions, also see Reason codes listed by value.

Example

For an AMODE 31 example using this callable service, see GXL1TRM example. For an AMODE 64 example using this callable service, see GXL4TRM example.

Usage notes

Termination can be requested any time the caller gets control back from the z/OS XML parser. This service does not free the Parse Instance Memory Area (PIMA) as a part of termination. If the caller's recovery gets control while a parse is still in progress, the caller should invoke this termination service to clean up resources.