<!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 MQBEGIN</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.mqseries-back.html">mqseries_back</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mqseries-close.html">mqseries_close</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-begin" class="refentry">
<div class="refnamediv">
<h1 class="refname">mqseries_begin</h1>
<p class="verinfo">(PECL mqseries >= 0.10.0)</p><p class="refpurpose"><span class="refname">mqseries_begin</span> — <span class="dc-title">MQseries MQBEGIN</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.mqseries-begin-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_begin</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$hconn</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$beginOptions</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_begin()</strong></span>
(MQBEGIN) call begins a unit of work that is coordinated by the queue
manager, and that may involve external resource managers.
</p>
<p class="para">
Using
<span class="function"><strong>mqseries_begin()</strong></span>
starts the unit of work. Either
<span class="function"><a href="function.mqseries-back.html" class="function">mqseries_back()</a></span>
or
<span class="function"><a href="function.mqseries-cmit.html" class="function">mqseries_cmit()</a></span>
ends the unit of work.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.mqseries-begin-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">hConn</code>
</dt>
<dd>
<p class="para">Connection handle.</p>
<p class="para">This handle represents the connection to the queue manager.</p>
</dd>
<dt>
<code class="parameter">compCode</code>
</dt>
<dd>
<p class="para">Completion code.</p>
</dd>
<dt>
<code class="parameter">reason</code>
</dt>
<dd>
<p class="para">Reason code qualifying the compCode.</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.mqseries-begin-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">No value is returned.</p>
</div>
<div class="refsect1 examples" id="refsect1-function.mqseries-begin-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5594">
<p><strong>Example #1
<span class="function"><strong>mqseries_begin()</strong></span>
example
</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $mqbo </span><span style="color: #007700">= array();<br /> </span><span style="color: #0000BB">mqseries_begin</span><span style="color: #007700">( </span><span style="color: #0000BB">$conn</span><span style="color: #007700">, <br /> </span><span style="color: #0000BB">$mqbo</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 /> 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: #FF8000">/* reason code 2121 is a warning for more information see MQSeries reference manual.*/<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">$reason </span><span style="color: #007700">!== </span><span style="color: #0000BB">2121</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"CompCode:%d Reason:%d Text:%s<br>\n"</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: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.mqseries-begin-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
<span class="function"><strong>mqseries_begin()</strong></span>
will not function when using MQSeries Client to connect to a Queueu Manager.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.mqseries-begin-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-back.html" class="function" rel="rdfs-seeAlso">mqseries_back()</a> - MQSeries MQBACK</span></li>
<li class="member"><span class="function"><a href="function.mqseries-cmit.html" class="function" rel="rdfs-seeAlso">mqseries_cmit()</a> - MQSeries MQCMIT</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-back.html">mqseries_back</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.mqseries-close.html">mqseries_close</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>
