com.HTTPResponse.beginXmlResponse

Starts a streaming HTTP response.

Syntax

beginXmlResponse()
  RETURNING writer xml.StaxWriter
  1. writer is the xml.StaxWriter to be used to write the HTTP request.

Usage

The beginXmlResponse() method the streaming HTTP response and returns a xml.StaxReader object ready to read XML from the server.

The Content-Type header must be of the form */xml or */*+xml. For example: application/xhtml+xml.

In case of error, the method throws an exception and sets the STATUS variable. Depending on the error, a human-readable description of the problem is available in the SQLCA.SQLERRM register. See Error handling in GWS calls (STATUS).

The INT_FLAG variable is checked during GWS API call to handle program interruptions, for more details, see Interruption handling in GWS calls (INT_FLAG)