Retrieve a Global Message Handle Number - OMRTVGMH
Retrieve a Global Message Handle Number (OMRTVGMH) RI
Required Parameter Group:
| 1 | Global Forward Message Number | Input | Packed(11,0) |
| 2 | Return Status | Output | Char(1) |
| 3 | Global Message Handle | Output | Packed(9,0) |
API Overview:
The Retrieve a Global Message Handle Number API (OMRTVGMH) will retrieve the global message handle (GMH) associated with the known global forward message number (GFMN) associated with a transmitted forward message.
The primary function of this utility is to enable other Omni products and external applications to retrieve the global message handle of a transmitted forward message.
Required Parameter Group Details:
(1) Global Forward Message Number
INPUT; PACKED(11,0)
The global forward message number of a transmitted forward message.
(2) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:
| 0 | Success, global message handle is returned |
| 1 | Failure, global forward message number does not exist and no information is returned |
| 2 | Failure, invalid global message handle and no information is returned |
| A | Failure, API failed when called remotely |
(3) Global Message Handle
OUTPUT; PACKED(9,0)
Successfully retrieved global message handle.