DHTX - Document Handler Template EXITPGM interface

  
  Licensed Materials - Property of IBM
  
  5655-Y04
  
  (C) Copyright IBM Corp. 1998, 2016 All Rights Reserved.
  
  
  DFHDHTX COPY
  
  This copybook contains the interface definition for the
  user-replaceable program specified in an EXITPGM type of template.
  
  The following input parameters are passed to the user program in a
  standard CICS commarea:
  
  dhtx_length
  The halfword binary length of the entire parameter list.
  dhtx_eyecatcher
  A 13-character eyecatcher, set to '>DFHDHTXPARMS'.
  dhtx_version
  A one-byte character version number of the parameter list,
  currently set to '0'.
  dhtx_buffer_ptr
  The address of a CICS-provided buffer in which the EXITPGM must
  return the data that is to become the template.
  dhtx_buffer_len
  The fullword binary length of the buffer addressed by
  dhtx_buffer_ptr .
  dhtx_template_name_ptr
  The address of the 48-character name of the template for which
  this EXITPGM is being executed.
  dhtx_append_crlf
  A one-byte character field that indicates whether the APPENDCRLF
  option was specified for this template. It is set to '1' if the
  option was specified, and to '0' otherwise.
  
  The following output parameters must be set by the EXITPGM:
  
  dhtx_template_len
  The fullword binary length of the template being returned in the
  buffer addressed by dhtx_buffer_ptr . This value should be the
  size actually required for the template, even if it exceeds
  dhtx_buffer_len (although the data moved into the buffer must
  not exceed that length). If dhtx_template_len exceeds
  dhtx_buffer_len , the EXITPGM will be re-driven with a larger
  buffer.
  dhtx_return_code
  A fullword binary return code that indicates whether the EXITPGM
  was successful. It should be one of:
  
  0 Indicates successful completion. A valid template, or a
  template truncated to fit the supplied buffer, has been
  returned.
  8 Indicates failure. No valid template has been returned.
  
  dhtx_cache_response
  Optionally, a one-byte character field that indicates whether
  CICS should save the returned template in its cache storage. It
  should be set to '1' if the contents returned are the same each
  time the exit is called, but should be left as '0' if the
  contents may be different each time. If the value is set to '1',
  the exit should not be called again unless a SET DOCTEMPLATE
  NEWCOPY is performed. (In practice, the exit may be called three
  times, first to set this flag, second to obtain the size of
  cache buffer to use, and finally to save the result into the
  cache buffer.)
  dhtx_message_ptr
  Optionally, the address of a message that explains why the
  EXITPGM was unsuccessful. CICS writes this message to the CSDH
  transient data destination.
  dhtx_message_len
  The fullword binary length of the message addressed by
  dhtx_message_ptr , if one is provided.
  
  --------------------------------------------------------------------