mqseries-begin.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: takagi Status: ready -->
<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>
   <type>void</type><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 role="reference">compCode</parameter></methodparam>
   <methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>mqseries_begin</function>
   (MQBEGIN) をコールすると、作業ユニットを開始します。
   これはキューマネージャが扱うものですが、外部のリソースマネージャを使用することもあります。
  </para>
  <para>
   <function>mqseries_begin</function>
   は作業ユニットを開始します。作業ユニットを終了させるには
   <function>mqseries_back</function>
   あるいは
   <function>mqseries_cmit</function>
   を使用します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term>
      <parameter>hConn</parameter>
     </term>
     <listitem>
      <para>接続ハンドル。</para>
      <para>このハンドルは、キューマネージャへの接続を表します。</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>compCode</parameter>
     </term>
     <listitem>
      <para>完了コード。</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>reason</parameter>
     </term>
     <listitem>
      <para>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>
     の例
    </title>
    <programlisting role="php">
<![CDATA[
<?php
    $mqbo = array();
    mqseries_begin( $conn, 
                    $mqbo,
                    $comp_code,
                    $reason);
    if ($comp_code !== MQSERIES_MQCC_OK) {
        /* コード 2121 は警告を表します。詳細は MQSeries のリファレンスマニュアルを参照ください */
        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>
    は、MQSeries Client を使用して 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:"~/.phpdoc/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
-->