<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>MQSeries MQGET</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.mqseries-disc.html">mqseries_disc</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.mqseries-inq.html">mqseries_inq</a></div> <div class="up"><a href="ref.mqseries.html">mqseries Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.mqseries-get" class="refentry"> <div class="refnamediv"> <h1 class="refname">mqseries_get</h1> <p class="verinfo">(PECL mqseries >= 0.10.0)</p><p class="refpurpose"><span class="refname">mqseries_get</span> — <span class="dc-title">MQSeries MQGET</span></p> </div> <div class="refsect1 description" id="refsect1-function.mqseries-get-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>mqseries_get</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$hConn</code></span> , <span class="methodparam"><span class="type">resource</span> <code class="parameter">$hObj</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$md</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$gmo</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$bufferLength</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$msg</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$data_length</code></span> , <span class="methodparam"><span class="type">resource</span> <code class="parameter reference">&$compCode</code></span> , <span class="methodparam"><span class="type">resource</span> <code class="parameter reference">&$reason</code></span> )</div> <p class="para rdfs-comment"> The <span class="function"><strong>mqseries_get()</strong></span> (MQGET) call retrieves a message from a local queue that has been opened using the <span class="function"><a href="function.mqseries-open.html" class="function">mqseries_open()</a></span> (MQOPEN) call </p> </div> <div class="refsect1 parameters" id="refsect1-function.mqseries-get-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"> <em><code class="parameter">hConn</code></em> </span> <dd> <p class="para">Connection handle.</p> <p class="para">This handle represents the connection to the queue manager.</p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">hObj</code></em> </span> <dd> <p class="para">Object handle.</p> <p class="para">This handle represents the object to be used.</p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">md</code></em> </span> <dd> <p class="para">Message descriptor (MQMD).</p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">gmo</code></em> </span> <dd> <p class="para">Get message options (MQGMO).</p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">bufferLength</code></em> </span> <dd> <p class="para">Expected length of the result buffer</p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">msg</code></em> </span> <dd> <p class="para"> Buffer holding the message that was retrieved from the object. </p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">data_length</code></em> </span> <dd> <p class="para">Actual buffer length</p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">compCode</code></em> </span> <dd> <p class="para">Completion code.</p> </dd> </dt> <dt> <span class="term"> <em><code class="parameter">reason</code></em> </span> <dd> <p class="para">Reason code qualifying the compCode.</p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.mqseries-get-returnvalues"> <h3 class="title">Return Values</h3> <p class="para">No value is returned.</p> </div> <div class="refsect1 examples" id="refsect1-function.mqseries-get-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4465"> <p><strong>Example #1 <span class="function"><strong>mqseries_get()</strong></span> example </strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// open connection to the queue manager<br /> </span><span style="color: #0000BB">mqseries_conn</span><span style="color: #007700">(</span><span style="color: #DD0000">'WMQ1'</span><span style="color: #007700">, </span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$comp_code</span><span style="color: #007700">, </span><span style="color: #0000BB">$reason</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// $conn now hold the reference to the connection to the queue manager.<br /><br />// open the connection to the testq queue<br /> </span><span style="color: #0000BB">mqseries_open</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$conn</span><span style="color: #007700">,<br /> array(</span><span style="color: #DD0000">'ObjectName' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'TESTQ'</span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">MQSERIES_MQOO_INPUT_AS_Q_DEF </span><span style="color: #007700">| </span><span style="color: #0000BB">MQSERIES_MQOO_FAIL_IF_QUIESCING </span><span style="color: #007700">| </span><span style="color: #0000BB">MQSERIES_MQOO_OUTPUT</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$obj</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$comp_code</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$reason</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// $obj now holds the reference to the object (TESTQ)<br /><br />// setup empty message descriptor.<br /> </span><span style="color: #0000BB">$mdg </span><span style="color: #007700">= array();<br /></span><span style="color: #FF8000">// setup get message options <br /> </span><span style="color: #0000BB">$gmo </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'Options' </span><span style="color: #007700">=> </span><span style="color: #0000BB">MQSERIES_MQGMO_FAIL_IF_QUIESCING </span><span style="color: #007700">| </span><span style="color: #0000BB">MQSERIES_MQGMO_WAIT</span><span style="color: #007700">, </span><span style="color: #DD0000">'WaitInterval' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3000</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// get the message from the queueu <br /> </span><span style="color: #0000BB">mqseries_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$obj</span><span style="color: #007700">, </span><span style="color: #0000BB">$mdg</span><span style="color: #007700">, </span><span style="color: #0000BB">$gmo</span><span style="color: #007700">, </span><span style="color: #0000BB">255</span><span style="color: #007700">, </span><span style="color: #0000BB">$msg</span><span style="color: #007700">, </span><span style="color: #0000BB">$data_length</span><span style="color: #007700">, </span><span style="color: #0000BB">$comp_code</span><span style="color: #007700">, </span><span style="color: #0000BB">$reason</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$comp_code </span><span style="color: #007700">!== </span><span style="color: #0000BB">MQSERIES_MQCC_OK</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"GET CompCode:%d Reason:%d Text:%s<br>"</span><span style="color: #007700">, </span><span style="color: #0000BB">$comp_code</span><span style="color: #007700">, </span><span style="color: #0000BB">$reason</span><span style="color: #007700">, </span><span style="color: #0000BB">mqseries_strerror</span><span style="color: #007700">(</span><span style="color: #0000BB">$reason</span><span style="color: #007700">));<br /> }<br /> <br /> </span><span style="color: #FF8000">// open connection to the queue manager<br /> </span><span style="color: #0000BB">mqseries_conn</span><span style="color: #007700">(</span><span style="color: #DD0000">'WMQ1'</span><span style="color: #007700">, </span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">$comp_code</span><span style="color: #007700">, </span><span style="color: #0000BB">$reason</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// $conn now hold the reference to the connection to the queue manager.<br /><br />// open the connection to the testq queue<br /> </span><span style="color: #0000BB">mqseries_open</span><span style="color: #007700">(<br /> </span><span style="color: #0000BB">$conn</span><span style="color: #007700">,<br /> array(</span><span style="color: #DD0000">'ObjectName' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'TESTQ'</span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">MQSERIES_MQOO_INPUT_AS_Q_DEF </span><span style="color: #007700">| </span><span style="color: #0000BB">MQSERIES_MQOO_FAIL_IF_QUIESCING </span><span style="color: #007700">| </span><span style="color: #0000BB">MQSERIES_MQOO_OUTPUT</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$obj</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$comp_code</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">$reason</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// $obj now holds the reference to the object (TESTQ)<br /> <br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.mqseries-get-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.mqseries-conn.html" class="function" rel="rdfs-seeAlso">mqseries_conn()</a> - MQSeries MQCONN</span></li> <li class="member"> <span class="function"><a href="function.mqseries-connx.html" class="function" rel="rdfs-seeAlso">mqseries_connx()</a> - MQSeries MQCONNX</span></li> <li class="member"> <span class="function"><a href="function.mqseries-open.html" class="function" rel="rdfs-seeAlso">mqseries_open()</a> - MQSeries MQOPEN</span></li> <li class="member"> <span class="function"><a href="function.mqseries-put.html" class="function" rel="rdfs-seeAlso">mqseries_put()</a> - MQSeries MQPUT</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.mqseries-disc.html">mqseries_disc</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.mqseries-inq.html">mqseries_inq</a></div> <div class="up"><a href="ref.mqseries.html">mqseries Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>