LGWF gate, WRITE function
Writes a record to the CICS system log.
Input Parameters
- CHAIN_TOKEN
- is a chain token.
- DATA
- The address of a reusable Iliffe vector describing the items of data to be written to the log stream.
- FORCE
Indicates that a force of the data in the buffer has been requested.
This is used to indicate when the statistics field in the journal information, which records the number of flushes, needs incrementing.
- Values for the parameter are:
- NO
- YES
- RAISE_LENGERR
- is a request qualifier. RAISE_LENGERR(YES) indicates that if the data length is too large to fit into the output buffer then an EXCEPTION condition is returned to the caller.
- Values for the parameter are:
- NO
- YES
- SUSPEND
- Supported for compatibility with old EXEC interface. Causes BUFFER_FULL exception to be raised if there is no space rather than waiting for space. The task may still be suspended for many other reasons.
- Values for the parameter are:
- NO
- YES
- MOVE_NEEDED
- Optional Parameter
- Binary value indicating whether existence records are to be moved to the shunt log on each activity keypoint.
- Values for the parameter are:
- NO
- YES
Output Parameters
- REASON
- The values for the parameter are:
- ABEND
- AKP_KICK_OFF
- BUFFER_FULL
- BUFFER_LENGTH_ERROR
- CONNECT_FAILURE
- END_OF_CHAINS
- END_OF_DATA
- INVALID_FORMAT
- INVALID_FUNCTION
- LOG_NOT_DEFINED
- LOOP
- WRITE_FAILURE
- FORCE_TOKEN
- A token to be used on a subsequent FORCE to ensure that a specific records and any prior records have been hardened
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.