mqInquireBag

The mqInquireBag call inquires the value of a bag handle that is present in the bag. The data item can be a user item or a system item.


Syntax for mqInquireBag

    mqInquireBag (Bag, Selector, ItemIndex, ItemValue, CompCode, Reason)


Parameters for mqInquireBag

    Bag (MQHBAG) - input
    Bag handle to be inquired. The bag can be a user bag or a system bag.

    Selector (MQLONG) - input
    Selector identifying the item to be inquired.

    If the selector is less than zero (that is, a system selector), the selector must be one that is supported by the MQAI; MQRC_SELECTOR_NOT_SUPPORTED results if it is not.

    The specified selector must be present in the bag; MQRC_SELECTOR_NOT_PRESENT results if it is not.

    The data type of the item must agree with the data type implied by the call; MQRC_SELECTOR_WRONG_TYPE results if it is not.

    The following special values can be specified for Selector:

      MQSEL_ANY_SELECTOR
      The item to be inquired is a user or system item identified by the ItemIndex parameter.

      MQSEL_ANY_USER_SELECTOR
      The item to be inquired is a user item identified by the ItemIndex parameter.

      MQSEL_ANY_SYSTEM_SELECTOR
      The item to be inquired is a system item identified by the ItemIndex parameter.

    ItemIndex (MQLONG) - input
    Index of the data item to be inquired.

    The value must be zero or greater, or the special value MQIND_NONE. If the value is less than zero and not MQIND_NONE, MQRC_INDEX_ERROR results. If the item is not already present in the bag, MQRC_INDEX_NOT_PRESENT results.

    The following special value can be specified:

      MQIND_NONE
      This specifies that there must be one occurrence only of the selector in the bag. If there is more than one occurrence, MQRC_SELECTOR_NOT_UNIQUE results.

      If MQSEL_ANY_SELECTOR is specified for the Selector parameter, the ItemIndex parameter is the index relative to the set of items that contains both user items and system items, and must be zero or greater.

      If MQSEL_ANY_USER_SELECTOR is specified for the Selector parameter, the ItemIndex parameter is the index relative to the set of system items, and must be zero or greater.

      If MQSEL_ANY_SYSTEM_SELECTOR is specified for the Selector parameter, the ItemIndex parameter is the index relative to the set of system items, and must be zero or greater.

      If an explicit selector value is specified, the ItemIndex parameter is the index relative to the set of items that have that selector value and can be MQIND_NONE, zero, or greater.

    ItemValue (MQHBAG) - output
    Value of the item in the bag.

    CompCode (MQLONG) - output
    Completion code.

    Reason (MQLONG) - output
    Reason code qualifying CompCode. The following reason codes indicating error conditions can be returned from the mqInquireBag call:

      MQRC_HBAG_ERROR
      Bag handle not valid.

      MQRC_INDEX_ERROR
      Index not valid (index negative and not MQIND_NONE, or MQIND_NONE specified with one of the MQSEL_ANY_xxx_SELECTOR values).

      MQRC_INDEX_NOT_PRESENT
      No item with the specified index is present within the bag for the selector given.

      MQRC_ITEM_VALUE_ERROR
      The ItemValue parameter is not valid (invalid parameter address).

      MQRC_SELECTOR_NOT_PRESENT
      No item with the specified selector is present within the bag.

      MQRC_SELECTOR_NOT_SUPPORTED
      Specified system selector not supported by the MQAI.

      MQRC_SELECTOR_NOT_UNIQUE
      MQIND_NONE specified when more than one occurrence of the specified selector is present within the bag.

      MQRC_SELECTOR_OUT_OF_RANGE
      Selector not within valid range for call.

      MQRC_SELECTOR_WRONG_TYPE
      Data item has wrong data type for call.

      MQRC_STORAGE_NOT_AVAILABLE
      Insufficient storage available.


C language invocation for mqInquireBag

mqInquireBag (Bag, Selector, ItemIndex, &ItemValue, &CompCode, &Reason);
Declare the parameters as follows: 
MQHBAG   Bag;           /* Bag handle */
MQLONG   Selector;      /* Selector */
MQLONG   ItemIndex;     /* Index of the data item to be inquired */
MQHBAG   ItemValue;     /* Value of item in the bag */
MQLONG   CompCode;      /* Completion code */
MQLONG   Reason;        /* Reason code qualifying CompCode */


Visual Basic invocation for mqInquireBag

(Supported on Windows only.) 

mqInquireBag (Bag, Selector, ItemIndex, ItemValue, CompCode, Reason
Declare the parameters as follows: 
Dim Bag       As Long 'Bag handle'
Dim Selector  As Long 'Selector'
Dim ItemIndex As Long 'Index of the data item to be inquired'
Dim ItemValue As Long 'Value of item in the bag'
Dim CompCode  As Long 'Completion code'
Dim Reason    As Long 'Reason code qualifying CompCode'
Parent topic: MQAI calls