This
header (macro) contains the structure describing the extended diagnostic
area that is returned when there is a failure in the
z/OS XML parser. It is returned
whenever the caller requests a control operation through the gxlpControl
(GXL1CTL/GXL4CTL) service. The particular area that it is used to
map depends on the control operation performed:
- *XEC_CTL_FIN (finish, and reset the parser) – this header (macro)
maps the area pointed to directly by the ctl_data_p parameter of the
gxlpControl (GXL1CTL/GXL4CTL) service.
- *XEC_CTL_FEAT (reset the parser with different features) – this
header (macro) maps the area pointed to by the XFT_XD_PTR field of
the GXLHXFT (GXLYXFT) structure.
- *XEC_CTL_LOAD_OSR (reset the parser and load an OSR for validation)
– this header (macro) maps the area pointed to by the XOSR_XD_PTR
field of the GXLHXOSR (GXLYXOSR) structure.
This mapping contains several types of key information that are
of use for problem determination. Some of the more useful fields include
the following:
- The address of the main parser anchor block. This is not generally
useful for a caller, but is important for IBM® service purposes.
- The input and output buffer addresses, and the current offsets
into each. This shows which data the z/OS XML parser was processing
at the time of the error.
- The size of the last memory allocation request made by the z/OS XML parser.
- Return and reason codes from the last memory allocation request
made by the z/OS XML parser.
- Return and reason codes from system service exits (if exits are
provided by the caller).
- Return code from the last request to switch to a specialty engine.
- A pointer to an area in the PIMA that is in the format
of an output buffer, that contains enhanced error information for
a validating parse when this information is requested.