1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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>
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:"~/.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
-->
|