gxlhqxd.h (GXLYQXD) - mapping of the output from the query XML declaration service

This header (macro) contains the structure that describes the information returned from the Query XML Declaration (QXD) service. It also contains constants that enumerate the allowable values for certain fields of the structure. The types of data returned in this area include the following:

• The type of encoding that the service was able to auto-detect. This is not a CCSID, but an indication as to whether the document is in UCS, UTF, or EBCDIC form. It also gives an indication of whether the document is big-endian or little-endian for certain encoding types.
• The CCSID of the document that the service was able to auto-detect. This value is suitable to pass to the z/OS XML parser initialization service to let the z/OS XML parser know the encoding of the document.
  Note: The QXD service is capable of detecting CCSIDs that are not supported by the z/OS XML parser.
• The version and release number from the "version" keyword value in the XML declaration.
• The CCSID from the "encoding" keyword value in the XML declaration. It may be the case that the detected encoding does not match the CCSID from the XML declaration. This could happen if the document has been transcoded from the original encoding to the detected encoding. If this is the case, the auto-detected value is the CCSID that should be used when initializing the parser.
• Flags indicating which keyword values in the XML declaration were actually present.
• A flag to indicate how the auto-detected encoding value was determined. In certain cases, it's not possible to actually detect the encoding based on the bytes examined. In this case, the XML spec requires a parser to treat the document as if it were UTF-8 encoded, and this is what the QXD service will provide in the auto-detect value. A flag will be set in the flags field to indicate that the encoding was actually undetected, and that the encoding returned is the default UTF-8 value.
• The overall length of the XML declaration.

See gxlpQuery — query an XML document or GXL1QXD (GXL4QXD) — query an XML document for more details about how to acquire and use this data area.