Input parameters for converter program decode function

Attention: This topic contains Product-sensitive Programming Interface and Associated Guidance Information.

Input parameters are passed to the decode function in a parameter list.

The parameters include:
  • The IP address of the web client.
  • A pointer to the HTTP version of the web client's request.
  • A pointer to the request method.
  • A pointer to the path component of the URL.
  • A pointer to the HTTP headers for the request.
  • A pointer to the entity body of the request message.
  • The name of the CICS® application program that provides data for the request (as set by the analyzer program, or specified in the URIMAP definition).
  • An eight byte user token, used to share information between the analyzer and converter programs. See Sharing data between analyzer and converter programs.
  • An iteration counter which records the number of times the decode function has been entered for each HTTP request. The counter is set to 1 before the decode function is called for the first time, and is incremented before it is called on each subsequent occasion.
  • An indication of whether the address of the entity body can be the target of a FREEMAIN command.

The analyzer program can change the values of any of these parameters before passing the parameter list to the converter program. If you want to examine the original request from the web client, use the EXEC CICS WEB API commands in the converter program.