php man page for mqseries_get

MQSERIES_GET(3) 							 1							   MQSERIES_GET(3)

mqseries_get - MQSeries MQGET

SYNOPSIS
       void  mqseries_get  (resource   $hConn, resource  $hObj, array  &$md, array  &$gmo, int	&$bufferLength, string	&$msg, int  &$data_length,
       resource  &$compCode, resource  &$reason)

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

PARAMETERS
	      o $hConn
		-Connection handle.This handle represents the connection to the queue manager.

	      o $hObj
		-Object handle.This handle represents the object to be used.

	      o $md
		-Message descriptor (MQMD).

	      o $gmo
		-Get message options (MQGMO).

	      o $bufferLength
		-Expected length of the result buffer

	      o $msg
		- Buffer holding the message that was retrieved from the object.

	      o $data_length
		-Actual buffer length

	      o $compCode
		-Completion code.

	      o $reason
		-Reason code qualifying the compCode.

RETURN VALUES
       No value is returned.

EXAMPLES
       Example #1

	      mqseries_get(3) 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 queueu
		  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));
		  }

	       // 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)

	      ?>

SEE ALSO
       mqseries_conn(3), mqseries_connx(3), mqseries_open(3), mqseries_put(3).

PHP Documentation Group 													   MQSERIES_GET(3)