Remove Reserved Mail Message Identifier (QzmfRmvRsvMailMsgId) API
Required Parameter Group:
| 1 | Reserved mail message identifier | Input | Char(32) |
| 2 | Format name | Input | Char(8) |
| 3 | Error code | I/O | Char(*) |
Service Program: QZMFASRV
Threadsafe: No
The Remove Reserved Mail Message Identifier (QzmfRmvRsvMailMsgId) API can be used to remove an identifier for an electronic mail message that has been reserved using the Reserve Mail Message (QzmfRsvMailMsgId) API but that has not been created. If the message has been created, the Creation Sequence Complete (QzmfCrtCmpMailMsg) API must be used to release the reserved message identifier. After the Remove Reserved Mail Message Identifier (QzmfRmvRsvMailMsgId) API completes successfully, the message identifier reserved earlier is no longer available to be used in message creation.
Authorities and Locks
None.
Required Parameter Group
- Reserved mail message identifier
- INPUT; CHAR(32)
The variable containing the unique message identifier to be removed from reserved status. After this API has completed running, the message identifier can no longer be used with the Create Mail Message (QzmfCrtMailMsg) API to pass information that defines the message. The reserved message identifier is composed of characters A through Z and 0 through 9 only.
- Format name
- INPUT; CHAR(8)
The variable containing the format identifier of the parameter list being passed. This field must be set to RMVF0100.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFAF82 E | Error occurred during running of MSF API. |
| CPFAF83 E | Parameter error on call to MSF API. Reason code &1. |
| CPFAF8B E | Reserved mail message identifier is not valid. |
| CPFAF8D E | Reserved mail message identifier already used. |
API introduced: V3R1
[ Back to top | Office APIs | APIs by category ]