Delete Field ID Definition (QsnDltFldId) API
Required Parameter:
1 | Field ID | Input | Binary(4) |
Omissible Parameter:
2 | Error code | I/O | Char(*) |
Returned Value:
Return code | Output | Binary(4) |
Default Public Authority: *USE
Service Program: QSNAPI
Threadsafe: No
The Delete Field ID Definition (QsnDltFldId) API deletes a field ID definition. The screen appearance, including the fields defined on the screen, are not affected by this command.
Authorities and Locks
None.
Required Parameter
- Field ID
- INPUT; BINARY(4)
The ID for the field definition to be deleted. Subsequent references to this field ID result in a CPFA33C error. This parameter must be specified with a nonzero valid field value.
Omissible Parameter
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.
Returned Value
- Return code
- OUTPUT; BINARY(4)
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.
Error Messages
Message ID | Error Message Text |
---|---|
CPF24B4 E | Severe error while addressing parameter list. |
CPF3CF1 E | Error code parameter not valid. |
CPF3CF2 E | Error(s) occurred during running of &1 API. |
CPFA33C E | Undefined field ID &1. |
API introduced: V2R3
[ Back to top | Dynamic Screen Manager APIs | APIs by category ]