mqseries_get

MQSeries MQGET

&reftitle.description; `void` `mqseries_get` `resource` `hConn` `resource` `hObj` `array` `md` `array` `gmo` `int` `bufferLength` `string` `msg` `int` `data_length` `resource` `compCode` `resource` `reason`

The `mqseries_get` (MQGET) call retrieves a message from a local queue that has been opened using the `mqseries_open` (MQOPEN) call

&reftitle.parameters;

`hConn`

- Connection handle.

  This handle represents the connection to the queue manager.

`hObj`

- Object handle.

  This handle represents the object to be used.

`md`

- Message descriptor (MQMD).

`gmo`

- Get message options (MQGMO).

`bufferLength`

- Expected length of the result buffer

`msg`

- Buffer holding the message that was retrieved from the object.

`data_length`

- Actual buffer length

`compCode`

- Completion code.

`reason`

- Reason code qualifying the compCode.

&reftitle.returnvalues;

&return.void;

&reftitle.examples;

### `mqseries_get` example

    <?php
    // open connection to the queue manager
        mqseries_conn('WMQ1', $conn, $comp_code, $reason);
    // $conn now hold the reference to the connection to the queue manager.

    // open the connection to the testq queue
        mqseries_open(
                    $conn,
                    array('ObjectName' => 'TESTQ'),
                    MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT,
                    $obj,
                    $comp_code,
                    $reason);
    // $obj now holds the reference to the object (TESTQ)

    // setup empty message descriptor.
        $mdg = array();
    // setup get message options
        $gmo = array('Options' => MQSERIES_MQGMO_FAIL_IF_QUIESCING | MQSERIES_MQGMO_WAIT, 'WaitInterval' => 3000);

    // get the message from the queue
        mqseries_get($conn, $obj, $mdg, $gmo, 255, $msg, $data_length, $comp_code, $reason);
        if ($comp_code !== MQSERIES_MQCC_OK) {
            printf("GET CompCode:%d Reason:%d Text:%s<br>", $comp_code, $reason, mqseries_strerror($reason));
        }

    // close the object reference $obj
        mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason);

    // disconnect from the queue manager.
        mqseries_disc($conn, $comp_code, $reason);

    ?>

&reftitle.seealso;

- `mqseries_conn`
- `mqseries_connx`
- `mqseries_open`
- `mqseries_put`