function

mq-close

Declaration

define external function mq-close
  object                value       mq-object     object
  options              value       integer          options

Argument definitions

object: is an open mq-object.

options: is the option to be used while closing the object.

Purpose

Use mq-close to close a connection to an IBM MQSeries object.

Requirements

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

  include "ommqi.xin"

The object must be open (else external exception OMMQI0013).

Usage Notes

This function corresponds to the MQCLOSE function in the MQSeries API.

The CompCode and Reason parameters of MQCLOSE are integrated into the OMMQI error handling.

This function is implicitly called when a mq-object variable goes out of scope.

Example

Close an opened queue.

  include "ommqi.xin"
  
  process
     local mq-connection     a-connection
     local mq-object             a-object
     local stream               od-fields    variable
     local mq-object-descriptor a-mqod
  
     ; Connect to queue manager QM_desthost
     set a-connection to mq-connect to "QM_desthost"
  
     ; Set up MQOD structure
     set new od-fields {"ObjectName"} to "default"
     mq-set-object-descriptor a-mqod to od-fields
  
     ; Open queue
     set a-object to mq-open connection a-connection
            object-descriptor a-mqod
            options (MQOO_OUTPUT union MQOO_INPUT_AS_Q_DEF)
  
     ; Perform some operations on the queue
     ; ...
  
     ; Close the queue
     mq-close object a-object options MQCO_NONE

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 9.1.0 Documentation Generated: September 2, 2010 at 1:38:10 pm
If you have any comments about this section of the documentation, please use this form.