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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.mqseries-put" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_put</refname>
<refpurpose>MQSeries MQPUT</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>mqseries_put</methodname>
<methodparam>
<type>resource</type>
<parameter>hConn</parameter>
</methodparam>
<methodparam>
<type>resource</type>
<parameter>hObj</parameter>
</methodparam>
<methodparam>
<type>array</type>
<parameter>md</parameter>
</methodparam>
<methodparam>
<type>array</type>
<parameter>pmo</parameter>
</methodparam>
<methodparam>
<type>string</type>
<parameter>message</parameter>
</methodparam>
<methodparam>
<type>resource</type>
<parameter>compCode</parameter>
</methodparam>
<methodparam>
<type>resource</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
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>
</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>hObj</parameter>
</term>
<listitem>
<para>Object handle.</para>
<para>This handle represents the object to be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>md</parameter>
</term>
<listitem>
<para>Message descriptor (MQMD).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>pmo</parameter>
</term>
<listitem>
<para>Put message options (MQPMO).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>message</parameter>
</term>
<listitem>
<para>The actual message to put onto the queue.</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_put</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
// open connection to the queue manager
mqseries_conn('WMQ1', $conn, $comp_code, $reason);
// $conn now hold the reference to the connection to the queue manager.
// open the connectio to the testq queueu
mqseries_open(
$conn,
array('ObjectName' => 'TESTQ'),
MQSERIES_MQOO_INPUT_AS_Q_DEF | MQSERIES_MQOO_FAIL_IF_QUIESCING | MQSERIES_MQOO_OUTPUT,
$obj,
$comp_code,
$reason);
// $obj now holds the reference to the object (TESTQ)
// setup the message descriptor array. Check MQSeries reference manuals.
$md = array(
'Version' => MQSERIES_MQMD_VERSION_1,
'Expiry' => MQSERIES_MQEI_UNLIMITED,
'Report' => MQSERIES_MQRO_NONE,
'MsgType' => MQSERIES_MQMT_DATAGRAM,
'Format' => MQSERIES_MQFMT_STRING,
'Priority' => 1,
'Persistence' => MQSERIES_MQPER_PERSISTENT);
// setup the put message options.
$pmo = array('Options' => MQSERIES_MQPMO_NEW_MSG_ID|MQSERIES_MQPMO_SYNCPOINT);
// put the message 'Ping' on the queueu.
mqseries_put($conn, $obj, $md, $pmo, 'Ping', $comp_code, $reason);
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("put CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
}
// close the object reference $obj
mqseries_close($conn, $obj, MQSERIES_MQCO_NONE, $comp_code, $reason);
// disconnect from the queue manager.
mqseries_disc($conn, $comp_code, $reason);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mqseries_conn</function></member>
<member><function>mqseries_connx</function></member>
<member><function>mqseries_open</function></member>
<member><function>mqseries_get</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
-->
|