Previous Topic: PurposeNext Topic: Return Code


Arguments

The following table gives a brief description of each of the arguments.

Name

I/O

Description

statementType

Input

This character represents which of the supported asynchronous action statements was being processed at the time of the flow failure. Valid Values are:

E: USE ASYNC: Response Type Notify

P: USE ASYNC: Response Type Poll

N: USE ASYNC: Response Type No Response

G: GET ASYNC RESPONSE: non blocking, WHEN PENDING clause has not been coded

B: GET ASYNC RESPONSE: blocking, WHEN PENDING clause has been coded

C: CHECK ASYNC RESPONSE

I: IGNORE ASYNC RESPONSE

requestId

Input

A long value containing a unique request identifier contained within the ASYNC REQUEST View corresponding to the IDENTIFIED BY clause of the statement currently being executed. This value is returned from the supporting runtime using the flow initiating USE ASYNC statement execution.

*viewLabel

Input

A character pointer to the label attribute of the CA Gen action diagram statement has associated Async Request View.

responseScope

Input

The response scope as defined within a USE ASYNC statement. Only valid if the current action diagram statement is a USE ASYNC. Valid values are:

"G"—the response scope is global to the client executable.

"P"—the response scope is limited to the executing procedure step.

failureType

Input

An integer value describing the source of the failure. The value can be one of the following:

"CFBUILD" is an error in the construction or parsing of a client/server flow message or response.

"XFAL" identifies an error during the server procedures action block execution.

"XERR" identifies a communications error occurring somewhere between construction of a message or response, and the deciphering of that message by the partner in this flow.

"XASY," if a USE ASYNC statement is being processed, identifies a communications error occurring somewhere between construction of a message or response, and the deciphering of that message by the partner in this flow. If a GET ASYNC RESPONSE, CHECK ASYNC RESPONSE, or IGNORE ASYNC RESPONSE is being processed, this fail type indicates the Request Id within the view identified by the "viewLabel" is invalid.

*failureCommand

Output

A character array, containing a maximum of 9 characters including the terminating NULL. This array can be populated with a command used to reinvoke the failing procedure step. This command is only used when returning from the exit with a FailAction of "serverFailedRestart." It will be ignored for any other FailAction.

errorList

Input/Output

An array of characters representing message strings constructed by and normally displayed using the ErrorReport dialog to describe the failure. Each message string is null terminated. Newline characters for formatting are also present as required. The complete list is terminated by more-than-one contiguous null character. On a "serverFailedDisplay" return, errorList, as modified in this exit, will be displayed in the ErrorReport dialog. errorList has a maximum length of 2048 bytes.

errorToken

Input

An array of characters, errorToken is only used with XFAL messages. errorToken can contain a token constructed by the Error Logging exit (TIRELOG) linked with the server load module describing the server action block failure. errorToken has a maximum length of 4097 bytes.