gxlpTerminate — terminate a parse instance

Description

The gxlpTerminate 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

int gxlpTerminate (void * PIMA,
                   int * rc,
                   int * rsn);

Parameters

PIMA

Supplied parameter

Type:: void *

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

rc

Returned parameter

Type:: int *

The name of the area where the service stores the return code.

rsn

Returned parameter

Type:: int *

The name of the area 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 the header file gxlhxr.h (see gxlhxr.h (GXLYXR) - defines the return codes and reason codes). For reason code descriptions, also see Reason codes listed by value.

Example

void * PIMA;

int rc, rsn;

gxlpTerminate (PIMA, &rc, &rsn);

Usage notes

This callable service is a direct map to GXL1TRM (GXL4TRM). Refer to Usage notes of GXL1TRM (GXL4TRM) for usage information.