1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00

mqseries : fix XML by converting para to simpara tags via script

This commit is contained in:
Gina Peter Banyard
2026-01-25 15:52:28 +00:00
parent 4b18961236
commit b5efbef2d3
18 changed files with 183 additions and 188 deletions

View File

@@ -1,8 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- State: experimental -->
<book xml:id="book.mqseries" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.mqseries">
<?phpdoc extension-membership="pecl" ?>
<title>mqseries</title>
@@ -10,10 +9,10 @@
<preface xml:id="intro.mqseries">
&reftitle.intro;
&warn.experimental;
<para>
<simpara>
This extension aims to provide an interface for communicating with IBMs
WebSphere MQ series Queue managers.
</para>
</simpara>
<simpara>
The interface mimics the C-API client interface of WebSphere MQ Series as
close as possible. Using the same naming conventions and possibilities of the
@@ -33,7 +32,6 @@
&reference.mqseries.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -54,4 +52,3 @@
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

View File

@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="mqseries.configure" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="mqseries.configure">
&reftitle.install;
<para>
<simpara>
&pecl.moved;
</para>
<para>
</simpara>
<simpara>
&pecl.info; <link xlink:href="&url.pecl.package;mqseries">&url.pecl.package;mqseries</link>.
</para>
</simpara>
<note>
<simpara>
The official name of this extension is <emphasis>mqseries</emphasis>.
@@ -17,21 +17,20 @@
There are two ways to connect to a queue manager. These depend on the way the extension is compiled and linked.
<itemizedlist>
<listitem>
<para>
<simpara>
First one and also the default one is using the mqic libraries. Compiling and linking the
extension against these IBM WebSphere MQSeries libraries allows the extension to connect to the
Queue manager using the client interface. Remote connections are possible this way.
</para>
</listitem>
</simpara>
</listitem>
<listitem>
<para>The other way is to compile and link against the mqm libraries. Using these libraries it is
possible to make use of the transaction management of a queue manager.</para>
<simpara>The other way is to compile and link against the mqm libraries. Using these libraries it is
possible to make use of the transaction management of a queue manager.</simpara>
</listitem>
</itemizedlist>
</para>
<para>Currently selecting the libraries to use is done by changing the <filename>config.m4</filename> file.</para>
<simpara>Currently selecting the libraries to use is done by changing the <filename>config.m4</filename> file.</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

View File

@@ -2,15 +2,15 @@
<!-- $Revision$ -->
<appendix xmlns="http://docbook.org/ns/docbook" xml:id="mqseries.constants">
&reftitle.constants;
<para>
<simpara>
For each WebSphere MQ Constant there is a mqseries counterpart.
</para>
<para>For definitions and usage see the WebSphere MQ Application Programming Guide and WebSphere MQ
</simpara>
<simpara>For definitions and usage see the WebSphere MQ Application Programming Guide and WebSphere MQ
Application Programming Reference red books.
</para>
<para>The name of the mqseries counterpart is made by appending the WebSphere MQ constant with MQSERIES_,
</simpara>
<simpara>The name of the mqseries counterpart is made by appending the WebSphere MQ constant with MQSERIES_,
for example the CompletionCode constants are:
</para>
</simpara>
<table>
<title>mqseries constants</title>
<tgroup cols="2">

View File

@@ -14,22 +14,22 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
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>
</simpara>
<simpara>
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>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -40,8 +40,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -49,7 +49,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -57,7 +57,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -65,7 +65,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">
@@ -92,10 +92,10 @@
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
<function>mqseries_back</function>
will not function when using MQSeries Client to connect to a Queueu Manager.
</para>
</simpara>
</note>
</refsect1>

View File

@@ -15,13 +15,13 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
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>
</simpara>
<simpara>
Using
<function>mqseries_begin</function>
starts the unit of work. Either
@@ -29,7 +29,7 @@
or
<function>mqseries_cmit</function>
ends the unit of work.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -40,8 +40,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -49,7 +49,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -57,7 +57,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -65,7 +65,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">
@@ -98,10 +98,10 @@
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
<function>mqseries_begin</function>
will not function when using MQSeries Client to connect to a Queueu Manager.
</para>
</simpara>
</note>
</refsect1>

View File

@@ -16,13 +16,13 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_close</function>
(MQCLOSE) call relinquishes access to an object, and is the inverse of the
<function>mqseries_open</function>
(MQOPEN) call.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,8 +33,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -42,8 +42,8 @@
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
<simpara>Object handle.</simpara>
<simpara>This handle represents the object to be used.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -51,7 +51,7 @@
<parameter>options</parameter>
</term>
<listitem>
<para/>
<simpara/>
</listitem>
</varlistentry>
<varlistentry>
@@ -59,7 +59,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -67,7 +67,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -75,7 +75,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -14,7 +14,7 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_cmit</function>
(MQCMIT) call indicates to the queue manager that the application has reached
@@ -22,7 +22,7 @@
since the last syncpoint are to be made permanent. Messages put as part of a
unit of work are made available to other applications; messages retrieved as
part of a unit of work are deleted.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -33,8 +33,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -42,7 +42,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -50,7 +50,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -58,7 +58,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">
@@ -84,10 +84,10 @@
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
<function>mqseries_back</function>
will not function when using MQSeries Client to connect to a Queueu Manager.
</para>
</simpara>
</note>
</refsect1>

View File

@@ -15,13 +15,13 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_conn</function>
(MQCONN) call connects an application program to a queue manager. It provides
a queue manager connection handle, which is used by the application on
subsequent message queuing calls.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,8 +32,8 @@
<parameter>qManagerName</parameter>
</term>
<listitem>
<para>Name of queue manager.</para>
<para>Name of the queue manager the application wishes to connect.</para>
<simpara>Name of queue manager.</simpara>
<simpara>Name of the queue manager the application wishes to connect.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -41,8 +41,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -50,7 +50,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -58,7 +58,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -66,7 +66,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -16,18 +16,18 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_connx</function>
(MQCONNX) call connects an application program to a queue manager. It
provides a queue manager connection handle, which is used by the application
on subsequent MQ calls.
</para>
<para>
</simpara>
<simpara>
The <function>mqseries_connx</function> call is like the
<function>mqseries_conn</function> (MQCONN) call, except that MQCONNX
allows options to be specified to control the way that the call works.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -38,8 +38,8 @@
<parameter>qManagerName</parameter>
</term>
<listitem>
<para>Name of queue manager.</para>
<para>Name of the queue manager the application wishes to connect.</para>
<simpara>Name of queue manager.</simpara>
<simpara>Name of the queue manager the application wishes to connect.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -47,8 +47,8 @@
<parameter>connOps</parameter>
</term>
<listitem>
<para>Options that control the action of function</para>
<para>See also the MQCNO structure.</para>
<simpara>Options that control the action of function</simpara>
<simpara>See also the MQCNO structure.</simpara>
</listitem>
</varlistentry>
@@ -57,8 +57,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -66,7 +66,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -74,7 +74,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -82,7 +82,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -14,7 +14,7 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_disc</function>
(MQDISC) call breaks the connection between the queue manager and the
@@ -23,7 +23,7 @@
(MQCONN) or
<function>mqseries_connx</function>
(MQCONNX) call.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,8 +34,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -43,7 +43,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -51,7 +51,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -59,7 +59,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -20,14 +20,14 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_get</function>
(MQGET) call retrieves a message from a local queue that has been opened
using the
<function>mqseries_open</function>
(MQOPEN) call
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -38,8 +38,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -47,8 +47,8 @@
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
<simpara>Object handle.</simpara>
<simpara>This handle represents the object to be used.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -56,7 +56,7 @@
<parameter>md</parameter>
</term>
<listitem>
<para>Message descriptor (MQMD).</para>
<simpara>Message descriptor (MQMD).</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -64,7 +64,7 @@
<parameter>gmo</parameter>
</term>
<listitem>
<para>Get message options (MQGMO).</para>
<simpara>Get message options (MQGMO).</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -72,7 +72,7 @@
<parameter>bufferLength</parameter>
</term>
<listitem>
<para>Expected length of the result buffer</para>
<simpara>Expected length of the result buffer</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -80,9 +80,9 @@
<parameter>msg</parameter>
</term>
<listitem>
<para>
<simpara>
Buffer holding the message that was retrieved from the object.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -90,7 +90,7 @@
<parameter>data_length</parameter>
</term>
<listitem>
<para>Actual buffer length</para>
<simpara>Actual buffer length</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -98,7 +98,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -106,7 +106,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -114,7 +114,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -21,12 +21,12 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_inq</function>
(MQINQ) call returns an array of integers and a set of character strings
containing the attributes of an object.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -37,8 +37,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -46,8 +46,8 @@
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
<simpara>Object handle.</simpara>
<simpara>This handle represents the object to be used.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -55,7 +55,7 @@
<parameter>selectorCount</parameter>
</term>
<listitem>
<para>Count of selectors.</para>
<simpara>Count of selectors.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -63,7 +63,7 @@
<parameter>selectors</parameter>
</term>
<listitem>
<para>Array of attribute selectors.</para>
<simpara>Array of attribute selectors.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -71,7 +71,7 @@
<parameter>intAttrLength</parameter>
</term>
<listitem>
<para>Count of integer attributes.</para>
<simpara>Count of integer attributes.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -79,7 +79,7 @@
<parameter>intAttr</parameter>
</term>
<listitem>
<para>Array of integer attributes.</para>
<simpara>Array of integer attributes.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -87,7 +87,7 @@
<parameter>charAttrLength</parameter>
</term>
<listitem>
<para>Length of character attributes buffer.</para>
<simpara>Length of character attributes buffer.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -95,7 +95,7 @@
<parameter>charAttr</parameter>
</term>
<listitem>
<para>Character attributes.</para>
<simpara>Character attributes.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -103,7 +103,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -111,7 +111,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -119,7 +119,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -17,11 +17,11 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_open</function>
(MQOPEN) call establishes access to an object.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,8 +32,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -41,7 +41,7 @@
<parameter>objDesc</parameter>
</term>
<listitem>
<para>Object descriptor. (MQOD)</para>
<simpara>Object descriptor. (MQOD)</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -49,7 +49,7 @@
<parameter>options</parameter>
</term>
<listitem>
<para>Options that control the action of the function.</para>
<simpara>Options that control the action of the function.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -57,8 +57,8 @@
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
<simpara>Object handle.</simpara>
<simpara>This handle represents the object to be used.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -66,7 +66,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -74,7 +74,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -82,7 +82,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -18,12 +18,12 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_put</function>
(MQPUT) call puts a message on a queue or distribution list. The queue or
distribution list must already be open.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,8 +34,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -43,8 +43,8 @@
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
<simpara>Object handle.</simpara>
<simpara>This handle represents the object to be used.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -52,7 +52,7 @@
<parameter>md</parameter>
</term>
<listitem>
<para>Message descriptor (MQMD).</para>
<simpara>Message descriptor (MQMD).</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -60,7 +60,7 @@
<parameter>pmo</parameter>
</term>
<listitem>
<para>Put message options (MQPMO).</para>
<simpara>Put message options (MQPMO).</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -68,7 +68,7 @@
<parameter>message</parameter>
</term>
<listitem>
<para>The actual message to put onto the queue.</para>
<simpara>The actual message to put onto the queue.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -76,7 +76,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -84,7 +84,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -92,7 +92,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -18,19 +18,19 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The
<function>mqseries_put1</function>
(MQPUT1) call puts one message on a queue. The queue need not be open.
</para>
<para>
</simpara>
<simpara>
You can use both the <function>mqseries_put</function> and <function>mqseries_put1</function>
calls to put messages on a queue; which call to use depends on the circumstances.
Use the <function>mqseries_put</function> (MQPUT) call to place multiple messages on the same queue.
Use the <function>mqseries_put1</function> (MQPUT1) call to put only one message on a queue.
This call encapsulates the MQOPEN, MQPUT, and MQCLOSE calls into a single call, minimizing the
number of calls that must be issued.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -41,8 +41,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -50,11 +50,11 @@
<parameter>objDesc</parameter>
</term>
<listitem>
<para>Object descriptor. (MQOD)</para>
<para>
<simpara>Object descriptor. (MQOD)</simpara>
<simpara>
This is a structure which identifies the queue to which the message is
added.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -62,7 +62,7 @@
<parameter>msgDesc</parameter>
</term>
<listitem>
<para>Message descriptor (MQMD).</para>
<simpara>Message descriptor (MQMD).</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,7 +70,7 @@
<parameter>pmo</parameter>
</term>
<listitem>
<para>Put message options (MQPMO).</para>
<simpara>Put message options (MQPMO).</simpara>
</listitem>
</varlistentry>
@@ -79,7 +79,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -87,7 +87,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -95,7 +95,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="seealso">

View File

@@ -21,11 +21,11 @@
<methodparam><type>resource</type><parameter role="reference">compCode</parameter></methodparam>
<methodparam><type>resource</type><parameter role="reference">reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The <function>mqseries_set</function>
(MQSET) call is used to change the attributes of an object represented by a
handle. The object must be a queue.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -36,8 +36,8 @@
<parameter>hConn</parameter>
</term>
<listitem>
<para>Connection handle.</para>
<para>This handle represents the connection to the queue manager.</para>
<simpara>Connection handle.</simpara>
<simpara>This handle represents the connection to the queue manager.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -45,8 +45,8 @@
<parameter>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
<simpara>Object handle.</simpara>
<simpara>This handle represents the object to be used.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -54,7 +54,7 @@
<parameter>selectorCount</parameter>
</term>
<listitem>
<para>Count of selectors.</para>
<simpara>Count of selectors.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -62,7 +62,7 @@
<parameter>selectors</parameter>
</term>
<listitem>
<para>Array of attribute selectors.</para>
<simpara>Array of attribute selectors.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -70,7 +70,7 @@
<parameter>intAttrCount</parameter>
</term>
<listitem>
<para>Count of integer attributes.</para>
<simpara>Count of integer attributes.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -78,7 +78,7 @@
<parameter>intAttrs</parameter>
</term>
<listitem>
<para>Array of integer attributes.</para>
<simpara>Array of integer attributes.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -86,7 +86,7 @@
<parameter>charAttrLength</parameter>
</term>
<listitem>
<para>Length of character attributes buffer.</para>
<simpara>Length of character attributes buffer.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -94,7 +94,7 @@
<parameter>charAttrs</parameter>
</term>
<listitem>
<para>Character attributes.</para>
<simpara>Character attributes.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -102,7 +102,7 @@
<parameter>compCode</parameter>
</term>
<listitem>
<para>Completion code.</para>
<simpara>Completion code.</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -110,7 +110,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -118,7 +118,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>&return.void;</para>
<simpara>&return.void;</simpara>
</refsect1>
<refsect1 role="seealso">

View File

@@ -12,10 +12,10 @@
<type>string</type><methodname>mqseries_strerror</methodname>
<methodparam><type>int</type><parameter>reason</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>mqseries_strerror</function>
returns the message that correspond to the reason result code.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,7 +26,7 @@
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
<simpara>Reason code qualifying the compCode.</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>string representation of the reason code message.</para>
<simpara>string representation of the reason code message.</simpara>
</refsect1>
<refsect1 role="examples">

View File

@@ -1,19 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="mqseries.resources" xmlns="http://docbook.org/ns/docbook">
<section xmlns="http://docbook.org/ns/docbook" xml:id="mqseries.resources">
&reftitle.resources;
<para>
<simpara>
This extension defines a connection and object_handle resources.
</para>
<para>
</simpara>
<simpara>
The <function>mqseries_conn</function> and <function>mqseries_connx</function> define the
connectionn handles.
</para>
<para>
</simpara>
<simpara>
The <function>mqseries_open</function> defines the object handle.
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml