Output parameters for the encode function

Attention: This topic contains Product-sensitive Programming Interface and Associated Guidance Information.
The encode function can provide the following outputs:
  • A response code (optionally qualified by a reason):
    • If the encode function returns a response code of URP_OK, an HTTP response is sent to the Web client.
    • If the encode function returns a response code of URP_OK_LOOP, processing continues with the decode function. See Calling more than one CICS application program for more information.
    • If the encode function returns any other value, the HTTP request is rejected. For details of the HTTP server response, see Default status codes and error responses.
  • If the response code is URP_OK, the address of a buffer containing the HTTP response to be sent to the Web client, and the length of the HTTP response. The first word of the buffer must contain the length of the data (that is, the length of the HTTP response plus 4).
  • An eight byte user token, used to share information between the analyzer and converter programs. See Sharing data between analyzer and converter programs.