ApiExitLocal stanza of the qm.ini file
For a server, use the Exits
queue manager properties page from the
IBM® MQ Explorer, or the ApiExitLocal stanza of the
qm.ini file to identify API exit routines for a queue manager. For a client,
modify the ApiExitLocal stanza in the mqclient.ini file to identify API exit routines for a queue
manager.
On Windows systems, you can also use the amqmdain command to change the entries for API exits. (To identify API exit routines for all queue managers, you use the ApiExitCommon and ApiExitTemplate stanzas, as described in ApiExitCommon and ApiExitTemplate stanzas of the mqs.ini file.)
Note, that for the API exit to work correctly, the message from the server must be sent to the client unconverted. After the API exit has processed the message, the message must then be converted on the client. This, therefore, requires that you have installed all conversion exits on the client.
For more information about using these attributes, see Configuring API exits.
- Name=ApiExit_name
- The descriptive name of the API exit passed to it in the ExitInfoName field of the MQAXP structure.
- Function=function_name
- The name of the function entry point into the module containing the API exit code. This entry point is the MQ_INIT_EXIT function.
- Module=module_name
- The module containing the API exit code.
- Data=data_name
- Data to be passed to the API exit in the ExitData field of the MQAXP structure.
- Sequence=sequence_number
- The sequence in which this API exit is called relative to other API exits. An exit with a low sequence number is called before an exit with a higher sequence number. There is no need for the sequence numbering of exits to be contiguous. A sequence of 1, 2, 3 has the same result as a sequence of 7, 42, 1096. If two exits have the same sequence number, the queue manager decides which one to call first. You can tell which was called after the event by putting the time or a marker in ExitChainArea indicated by the ExitChainAreaPtr in MQAXP or by writing your own log file.