swirl
Guide to OmniMark 7   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Syntax   Related Concepts   Other Library Functions  
function  

mq-get-function-status

 
 

Library: Interfaces, MQSeries access (OMMQI)
Include: ommqi.xin

Declaration

  define external function mq-get-function-status
           modifiable     integer     result-codes

Argument definitions

result-codes
is an integer shelf in which the CompCode and Reason for the last error will be put.


Purpose

Use mq-get-function-status to retrieve the IBM MQSeries error code when the "MQI0000" external exception is received.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "ommqi.xin"

Usage Notes

When an OmniMark program receives the "MQI0000" external exception, that indicates that a single IBM MQSeries error occurred during the ommqi function which was just called. mq-get-function-status can be called to retrieve the CompCode and Reason returned by the IBM MQSeries client.

The result-codes integer shelf is cleared, and then two values are placed onto it with the keys "CompCode" and "Reason".

The error codes are cleared upon the next ommqi call.

See OMMQI Error Handling for an example of how this function is used.

    Related Syntax
   mq-get-entire-return-status
 
Related Concepts
   ommqi Error Handling
 
Other Library Functions
   mq-backout
   mq-close
   mq-commit
   mq-connect
   mq-connection
   mq-connectx
   mq-disconnect
   mq-get
   mq-get-entire-return-status
   mq-get-function-status
   mq-get-logging-level
   mq-get-throw-on-warnings
   mq-inquire
   mq-inquire-names
   mq-object
   mq-open
   mq-put
   mq-put1message
   mq-set
   mq-set-logging-level
   mq-set-throw-on-warnings
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]

OmniMark 7.1.2 Documentation Generated: June 28, 2005 at 5:45:31 pm
If you have any comments about this section of the documentation, send email to [email protected]

Copyright © Stilo Corporation, 1988-2005.