php-doc-en/reference/mqseries/functions/mqseries-begin.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.mqseries-begin" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mqseries_begin</refname>
  <refpurpose>MQseries MQBEGIN</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <methodname>mqseries_begin</methodname>
   <methodparam>
    <type>resource</type>
    <parameter>hconn</parameter>
   </methodparam>
   <methodparam>
    <type>array</type>
    <parameter>beginOptions</parameter>
   </methodparam>
   <methodparam>
    <type>resource</type>
    <parameter>compCode</parameter>
   </methodparam>
   <methodparam>
    <type>resource</type>
    <parameter>reason</parameter>
   </methodparam>
  </methodsynopsis>
  <para>
   The
   <function>mqseries_begin</function>
   (MQBEGIN) call begins a unit of work that is coordinated by the queue
   manager, and that may involve external resource managers.
  </para>
  <para>
   Using
   <function>mqseries_begin</function>
   starts the unit of work. Either
   <function>mqseries_back</function>
   or
   <function>mqseries_cmit</function>
   ends the unit of work.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>hConn</parameter>
     </term>
     <listitem>
      <para>Connection handle.</para>
      <para>This handle represents the connection to the queue manager.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>compCode</parameter>
     </term>
     <listitem>
      <para>Completion code.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>reason</parameter>
     </term>
     <listitem>
      <para>Reason code qualifying the compCode.</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>&return.void;</para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>
     <function>mqseries_begin</function>
     example
    </title>
    <programlisting role="php">
<![CDATA[
<?php
    $mqbo = array();
    mqseries_begin(	$conn, 
                    $mqbo,
                    $comp_code,
                    $reason);
    if ($comp_code !== MQSERIES_MQCC_OK) {
        /* reason code 2121 is a warning for more information see MQSeries reference manual.*/
        if ($reason !== 2121) {
            printf("CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
        }
    }
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>mqseries_begin</function>
    will not function when using MQSeries Client to connect to a Queueu Manager.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mqseries_conn</function></member>
    <member><function>mqseries_connx</function></member>
    <member><function>mqseries_back</function></member>
    <member><function>mqseries_cmit</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
 sgml-omittag:t
 sgml-shorttag:t
 sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
 indent-tabs-mode:nil
 sgml-parent-document:nil
 sgml-default-dtd-file:"../../../../manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
-->