CALL FUNCTION statement
The following table gives the format for CALL FUNCTION statements, including the column number, function, code, and description.
This is the preferred format when you are not working with column-specific SSAs.
Column | Function | Code | Description |
---|---|---|---|
1 | Identifies control statement | L | Issues an IMS™ call. |
2 | Reserved | b | |
3 | SSA level | b | SSA level (optional). |
n | Range of hexadecimal characters allowed is 1-F. | ||
4 | Reserved | b | |
5-8 | Repeat count | b | If blank, repeat count defaults to 1. |
nnnn | 'nnnn' is the number of times to repeat this call. Range is 1 to 9999, right-justified, with or without leading zeros. | ||
9 | Reserved | b | |
10-13 | Identifies DL/I call function | b | If blank, use function from previous CALL statement. |
xxxx | 'xxxx' is a DL/I call function. | ||
Continue SSA | CONT | Continuation indicator for SSAs too long for a single CALL FUNCTION statement. Column 72 of the preceding CALL FUNCTION statement must have an entry. The next CALL statement should have CONT in columns 10 - 13 and the SSA should continue in column 16. | |
14-15 | Reserved | b | |
16-23 or | SSA name | xxxxxxxx | Must be left-justified. |
16-23 or | Token | xxxxxxxx | Token name (SETS/ROLS). |
16-23 or | MOD name | xxxxxxxx | Modname (PURG+ISRT). |
16-23 or | Subfunction | xxxxxxxx | nulls, DBQUERY, FIND, ENVIRON, PROGRAM (INQY). |
16-19 and | Statistics type | xxxx | DBAS/DBES-OSAM or VBAS/VBES-VSAM (STAT).2 |
20 or | Statistics format | x | F - Formatted U- Unformatted S - Summary. |
16–19 | SETO ID1 | SETx | Where x is 1, 2, or 3. Specified on SETO and CHNG calls as defined in Note. |
21-24 | SETO IOAREA SIZE | nnnn | Value of 0000 to 8192. If a value greater than 8192 is specified, it defaults to 8192. If no value is specified, the call is made with no SETO size specified. |
24–71 | Remainder of SSA | Unqualified SSAs must be blank. Qualified search arguments should have either an '*' or a '(' in column 24 and follow IMS SSA coding conventions. | |
72 | Continuation column | b | No continuations for this statement. |
x | Alone, it indicates multiple SSAs each beginning in column 16 of successive statements. With CONT in columns 10-13 of the next statement, indicates a single SSA that is continued beginning in column 16 of the following statement. | ||
73-80 | Sequence indication | nnnnnnnn | For SYSIN2 statement override. |
25-32 | OTMA descriptor name | xxxxxxxx | 8–byte character field (ICAL). |
34-39 | The wait time for the synchronous call to be processed | nnnnnn | 6–byte character field with a range from 1 to 999999 (ICAL). |
41-45 | The input message length | nnnnn | The length of the input data in the request area (ICAL). |
47-51 | The response area length | nnnnn | The length of the response area for the output message (ICAL). |
Note:
|
This information applies to different types of continuations:
- Column 3, the SSA level, is usually blank. If it is blank, the first CALL FUNCTION statement fills SSA 1, and each following CALL FUNCTION statement fills the next lower SSA. If column 3 is not blank, the statement fills the SSA at that level, and the following CALL FUNCTION statement fills the next lower one.
- Columns 5 through 8 are usually blank, but if used, must be right justified. The same call is repeated as specified by the repeat call function.
- Columns 10 through 13 contain the DL/I call function. The call function is required only for the first CALL FUNCTION statement when multiple SSAs are in a call. If left blank, the call function from the previous CALL FUNCTION statement is used.
- Columns 16 through 23 contain the segment name if the call uses a SSA.
- If the DL/I call contains multiple SSAs, the statement must have
a nonblank character in column 72, and the next SSA must start in
column 16 of the next statement. The data in columns 1 and 10 through
13 are blank for the second through last SSAs.Restriction: On ISRT calls, the last SSA can have only the segment name with no qualification or continuation.
- If a field value extends past column 71, put a nonblank character in column 72. (This character is not read as part of the field value, only as a continuation character.) In the next statement insert the keyword CONT in columns 10 through 13 and continue the field value starting at column 16.
- Maximum length for the field value is 256 bytes, maximum size for a SSA is 290 bytes, and the maximum number of SSAs for this program is 15, which is the same as the IMS limit.
- If columns 5 through 8 in the CALL FUNCTION statement contain a repeat count for the call, the call will terminate when reaching that count, unless it first encounters a GB status code.