ABORT

Purpose

Terminates the execution of the current task.

Syntax

►►─── ABORT ─────┬────────┬─────┬─────────────────────────────────┬───────────►◄
                 └─ SNAP ─┘     └─┬─ MESSage ─┬─ message-options ─┘
                                  └─ MSG ─────┘

Expansion of message-options

►►────┬─ TEXT ─────┬──────┬────────── message-text ───────────────────────────►
      │            ├─ IS ─┤
      │            └─ =  ─┘
      └─ CODE ─────┬──────┬────────── message-code ───────────────────────────
                   ├─ IS ─┤
                   └─ =  ─┘

 ►────────────────────────────────────────────────────────────────────────────►
  ────┬───────────────────────────────────────────────┬───────────────────────
      │                         ┌──────────────┐      │
      └─ PARMS ────┬─────┬─── (─▼── parameter ─┴─ ) ──┘
                   └─ = ─┘

 ►────────────────────────────────────────────────────┬───────────────────────►◄
  ────┬────────────────────────────────────────┬──────┘
      └─ PREFIX ───┬──────┬─────── prefix ─────┘
                   ├─ IS ─┤
                   └─ =  ─┘

Expansion of message-options

►►────┬─ TEXT ─────┬──────┬────────── message-text ───────────────────────────►
      │            ├─ IS ─┤
      │            └─ =  ─┘
      └─ CODE ─────┬──────┬────────── message-code ───────────────────────────
                   ├─ IS ─┤
                   └─ =  ─┘

 ►────────────────────────────────────────────────────────────────────────────►
  ────┬───────────────────────────────────────────────┬───────────────────────
      │                         ┌──────────────┐      │
      └─ PARMS ────┬─────┬─── (─▼── parameter ─┴─ ) ──┘
                   └─ = ─┘

 ►────────────────────────────────────────────────────┬───────────────────────►◄
  ────┬────────────────────────────────────────┬──────┘
      └─ PREFIX ───┬──────┬─────── prefix ─────┘
                   ├─ IS ─┤
                   └─ =  ─┘

Parameters

SNAP

Writes a formatted snap dump to the CA IDMS/DC or DC/UCF (DC/UCF) log. Snap dumps can be printed by means of the PRINT LOG utility.

Note: For more information about PRINT LOG, see the CA IDMS Utilities Guide.

MESSage

Specifies a message to be displayed on the Dialog Abort Information screen and written to the system log. If a MESSAGE clause is not specified, system message DC174020 is used (text of this message can be changed by using IDD):

ADS/ON-LINE ABORT. USER SPECIFIED ABORT WITH NO MESSAGE CODE/TEXT

MSG can be used in place of MESSAGE.

Note: For more information about altering message text using IDD, see the CA IDMS IDD Quick Reference Guide, under the MESSAGE command.

TEXT IS message-text

Specifies the text of a message to be sent to the system log or, if batch, sent to the console and batch log file.

This can be either the name of a variable data field containing the message text or the text string itself, enclosed in single quotation marks.

The text string can contain up to 240 displayable characters.

CODE IS message-code

Specifies the message dictionary code of a message to be displayed in an online map's message field or sent to the log file in a batch application.

This can be either the name of a variable data field that contains the message code or the 6-digit code itself, expressed as a numeric literal.

In a batch application, the message is also sent to the operator, if directed by the destination specified in the dictionary.

PARMS = parameter

Introduces a replacement parameter for each variable field in the stored message identified by message-code. The parameter can be either the name of an EBCDIC or unsigned zoned decimal variable data field that contains the parameter value or the actual parameter value, enclosed in single quotation marks.

Up to nine replacement parameters can be specified for a message. Multiple parameters must be specified in the order in which they are numbered and separated by blanks or commas.

The parameter value must contain displayable characters. At run time, each variable data field in a stored message expands or contracts to accommodate the size of its replacement parameter. A replacement parameter can be a maximum of 240 bytes.

PREFIX IS prefix

Overrides the default prefix of a dialog and a map. Prefix specifies an EBCDIC or unsigned zoned decimal variable data field that contains a 2-character prefix or the 2-character prefix itself, enclosed in single quotation marks

Usage

Considerations

When a dialog issues an ABORT command, CA ADS abnormally terminates the current task and returns control to DC/UCF. A snap dump of all memory areas maintained for the current CA ADS runtime session at the time of the abort can be requested.
The CA ADS runtime system provides a diagnostic screen that displays information about an abnormally terminated dialog. The diagnostic screen is enabled for an installation by means of the DIAGNOSTIC SCREEN clause of the system generation ADSO statement.
Note: For more information about the ADSO statement, see the CA IDMS System Generation Guide.

If the diagnostic screen is not enabled when an ABORT command is issued, a system error message (DC466019) is displayed. If a message code is specified in the ABORT command and the dictionary message specifies a destination of log, the message is also sent to the system log.
Up to nine replacement parameters can be specified for a message.
Multiple message parameters must be separated by blanks or commas.
Message parameters must be specified in the order in which they occur in the stored message.
Within the message definition in the dictionary, symbolic parameters are identified by an ampersand (&) followed by a two-digit numeric identifier. These identifiers can appear in any order. The position of the replacement values in the PARMS parameter must correspond directly to the two-digit numeric identifiers in the message; the first value corresponds to &01, the second to &02, and so forth. For example, assume that the stored message text is as follows:
```
THIS IS TEXT &01 AND &03 OR &02
```
The PARMS parameter reads PARMS=('A','B','C'). The resulting text would read as follows:
```
THIS IS TEXT A AND C OR B
```

Example

The following example illustrates the use of the ABORT command:

ADD ACC-BAL TO TOT-BAL.
ADD 1 TO CONTROL-CTR.
IF CONTROL-CTR < 100
THEN
    INVOKE 'CEXDR008'.
ELSE
    ABORT SNAP MSG TEXT CUST-NUM.

More information:

CA ADS Runtime System