EPAS gate, FORMAT_EVENT function

FORMAT_EVENT formats a CICS event object, in the form passed to an EP adapter by the EP dispatcher, into the required EP event_format. The formatted event is returned to the caller in one container (or more than one container in the case of CCE events) in the out_pool container provided by the caller.

Input Parameters

event_format
The parameter which controls how the event is formatted.
The values of this parameter are:
  • CBE
  • CBER
  • CCE
  • CFE
  • Start of changeDSIEEnd of change
  • WBE
in_pool_token
a container pool containing the CICS Event Object
out_pool_token
a container pool to contain the formatted event
container_name
The name of the data container, if applicable, in the formatted event container pool. This is not set for CCE events where the container pool IS the formatted event.

Output Parameters

REASON
The following value is returned when RESPONSE is DISASTER:
  • ABEND
The following values are returned when RESPONSE is EXCEPTION:
  • DATA_ERROR
The following values are returned when RESPONSE is INVALID:
  • INVALID_EVENT_FORMAT
  • INVALID_FORMAT
  • INVALID_FUNCTION
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


dfhs3_epasformat_event.html | Timestamp icon Last updated: Monday, 5 June 2017