CICS_EpiEventData_t

Purpose

The CICS_EpiEventData_t structure holds details of a terminal-related event. Not all fields are valid for all events, and fields that are not valid are set to nulls. This structure is an output from CICS_EpiGetEvent.

Fields

TermIndex
The terminal index for the terminal resource against which this event occurred.
Event
The event indicator; that is, one of the event codes listed in EPI events.
EndReason
The reason for termination, if the event is a CICS_EPI_EVENT_END_TERM or CICS_EPI_EVENT_END_TRAN event.
TransId
A string specifying a transaction name. If the name is shorter than CICS_EPI_TRANSID_MAX characters, it is padded with spaces to this length, followed by a single null character.
Reserved1
A reserved field.

Prior to CICS® Transaction Gateway Version 3.1, this field was called AbendCode.

Data
A pointer to a buffer that is updated with any terminal data stream associated with the event.

On input the Data parameter should be set to point to a CICS_EpiDetails_t structure on the first invocation of CICS_EpiGetEvent for a terminal being added asynchronously. The details structure is updated on return from CICS_EpiGetEvent.

Size
The maximum size of the buffer addressed by Data. On return from the CICS_EpiGetEvent call, this contains the actual length of data returned.
EndReturnCode
A string containing the CICS_EPI_returncode.
MapName
A string specifying the name of the map that was most recently referenced in the MAP option of a SEND MAP command processed for the terminal resource, if the event is a CICS_EPI_EVENT_SEND or a CICS_EPI_EVENT_CONVERSE event. If the terminal resource is not supported by BMS, or the server has no record of any map being sent, the value returned is spaces. If the name is shorter than CICS_EPI_MAPNAME_MAX characters, it is padded with spaces to this length, followed by a single null character.
MapSetName
A string specifying the name of the mapset that was most recently referenced in the MAPSET option of a SEND MAP command processed for the terminal resource, if the event is a CICS_EPI_EVENT_SEND or a CICS_EPI_EVENT_CONVERSE event. If the MAPSET option was not specified on the most recent request, BMS used the map name as the mapset name. In both cases, the mapset name used may have been suffixed by a terminal suffix. If the terminal resource is not supported by BMS, or the server has no record of any mapset being sent, the value returned is spaces. If the name is shorter than CICS_EPI_MAPSETNAME_MAX characters, it is padded with spaces to this length, followed by a single null character.
Note: The Data and Size fields should be set before the call to CICS_EpiGetEvent is made.