XEC_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 XRSN_BUFFER_OUTBUF_SMALL reason code. This value is returned in the XD control block.

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 the initialization service.

ctl_option

Supplied parameter

Type:: Integer
Length:: Fullword

The name of a fullword containing an integer value initialized to XEC_CTL_QUERY_MIN_OUTBUF.

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. The field XD_MIN_OB contains the minimum output buffer size required on the next parse. If some failure other than XRSN_BUFFER_OUTBUF_SMALL occurred prior to this call, XRSN_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.

return_code

Returned parameter

Type:: Integer
Length:: Fullword

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

reason_code

Returned parameter

Type:: Integer
Length:: Fullword

The name of the 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.