php-doc-en/reference/mqseries/functions/mqseries-back.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

137 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mqseries-back" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_back</refname>
<refpurpose>MQSeries MQBACK</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>mqseries_back</methodname>
<methodparam><type>resource</type><parameter>hconn</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_back</function>
(MQBACK) call indicates to the queue manager that all the message gets and
puts that have occurred since the last syncpoint are to be backed out.
Messages put as part of a unit of work are deleted; messages retrieved as
part of a unit of work are reinstated on the queue.
</para>
<para>
Using
<function>mqseries_back</function>
only works in conjunction with
<function>mqseries_begin</function>
and only function when connecting directly to a Queueu manager. Not via the
mqclient interface.
</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_back</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
mqseries_back($conn, $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
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_back</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_begin</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
-->