<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mqseries.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.mqseries-open.php',
    1 => 'mqseries_open',
    2 => 'MQSeries MQOPEN',
  ),
  'up' => 
  array (
    0 => 'ref.mqseries.php',
    1 => 'mqseries Functions',
  ),
  'prev' => 
  array (
    0 => 'function.mqseries-inq.php',
    1 => 'mqseries_inq',
  ),
  'next' => 
  array (
    0 => 'function.mqseries-put.php',
    1 => 'mqseries_put',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/mqseries/functions/mqseries-open.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.mqseries-open" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">mqseries_open</h1>
  <p class="verinfo">(PECL mqseries &gt;= 0.10.0)</p><p class="refpurpose"><span class="refname">mqseries_open</span> &mdash; <span class="dc-title">MQSeries MQOPEN</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.mqseries-open-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>mqseries_open</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$hconn</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter reference">&$objDesc</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$option</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter reference">&$hobj</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter reference">&$compCode</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter reference">&$reason</code></span><br>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="simpara">
   The
   <span class="function"><strong>mqseries_open()</strong></span>
   (MQOPEN) call establishes access to an object.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.mqseries-open-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt>
     <code class="parameter">hConn</code>
    </dt>
    <dd>
     <span class="simpara">Connection handle.</span>
     <span class="simpara">This handle represents the connection to the queue manager.</span>
    </dd>
   
   
    <dt>
     <code class="parameter">objDesc</code>
    </dt>
    <dd>
     <span class="simpara">Object descriptor. (MQOD)</span>
    </dd>
   
   
    <dt>
     <code class="parameter">options</code>
    </dt>
    <dd>
     <span class="simpara">Options that control the action of the function.</span>
    </dd>
   
   
    <dt>
     <code class="parameter">hObj</code>
    </dt>
    <dd>
     <span class="simpara">Object handle.</span>
     <span class="simpara">This handle represents the object to be used.</span>
    </dd>
   
   
    <dt>
     <code class="parameter">compCode</code>
    </dt>
    <dd>
     <span class="simpara">Completion code.</span>
    </dd>
   
   
    <dt>
     <code class="parameter">reason</code>
    </dt>
    <dd>
     <span class="simpara">Reason code qualifying the compCode.</span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.mqseries-open-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">No value is returned.</p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.mqseries-open-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 
    <span class="function"><strong>mqseries_open()</strong></span>
    example
   </strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />    $mqods </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'ObjectName' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'TESTQ'</span><span style="color: #007700">);<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 />                </span><span style="color: #0000BB">$mqods</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 />    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">"open CompCode:%d Reason:%d Text:%s&lt;br&gt;\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 />        exit;<br />    }<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.mqseries-open-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.mqseries-close.php" class="function" rel="rdfs-seeAlso">mqseries_close()</a> - MQSeries MQCLOSE</span></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>