Test for Omitted Argument (CEETSTA) API
Required Parameter Group:
1 | presence_flag | Output | INT4 |
2 | arg_num | Input | INT4 |
Omissible Parameter:
3 | fc | Output | FEEDBACK |
Service Program Name: QLEAWI
Default Public Authority: *USE
Threadsafe: Yes
The Test for Omitted Argument (CEETSTA) API is used to test for the presence or absence of an omissible argument.
Authorities and Locks
None.
Required Parameter Group
- presence_flag (output)
- The presence or absence of the argument tested. A value of 1 indicates that
the argument is present; a value of 0 indicates that the argument was
omitted.
- arg_num (input)
- The argument number to be tested (in the argument list of the procedure that called the procedure where the CEETSTA call is coded), counting the first argument as 1.
Omissible Parameter
- fc (output)
- A 12-byte feedback code.
Feedback Codes and Conditions
CEE0000 | The API completed successfully |
Severity: 00 | |
CEE0503 | The argument number is not valid
Note: ILE does not check the condition where the argument number is greater than the number of arguments in the list. |
Severity: 30 | |
CEE3005 | The argument being tested is not an address |
Severity: 30 |
Usage Notes
-
It is an error to use CEETSTA to test an argument that is not a reference argument or that is preceded in the argument list by other arguments that are not reference arguments.
Note: This error may not be diagnosed.
-
CEETSTA is implemented as a builtin and therefore cannot have its address taken or be called through a procedure pointer.
API introduced: V2R3
[ Back to top | ILE CEE APIs | APIs by category ]