GXLHXEC_CTL_QUERY_MIN_OUTBUF

Description

This indicates that the caller is requesting the control service to return the minimum output buffer size required for subsequent parse to complete without returning an GXLHXRSN_BUFFER_OUTBUF_SMALL reason code. This value is returned in the XD control block.

Syntax

int gxlpControl (void * PIMA,
                 int ctl_operation,
                 void * ctl_data_p,
                 int * rc_p,
                 int * rsn_p);

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.

ctl_operation

Supplied parameter

Type:: int

The name of the parameter containing an integer value initialized to GXLHXEC_CTL_QUERY_MIN_OUTBUF.

ctl_data_p

Supplied and returned parameter

Type:: void *

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 header file gxlhxd.h. The field XD_MIN_OB contains the minimum output buffer size required on the next parse. If some failure other than GXLHXRSN_BUFFER_OUTBUF_SMALL occurred prior to this call, GXLHXRSN_CTL_SEQUENCE_INCORRECT will be returned. The XD area will not be returned.

The diagnostic area resides within the PIMA, and will be overlaid on the next call to the z/OS XML parser.

rc_p

Returned parameter

Type:: int *

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

rsn_p

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.