File: mqseries-put1.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (135 lines) | stat: -rw-r--r-- 4,062 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mqseries-put1" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mqseries_put1</refname>
  <refpurpose>MQSeries MQPUT1</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>mqseries_put1</methodname>
   <methodparam><type>resource</type><parameter>hconn</parameter></methodparam>
   <methodparam><type>resource</type><parameter role="reference">objDesc</parameter></methodparam>
   <methodparam><type>resource</type><parameter role="reference">msgDesc</parameter></methodparam>
   <methodparam><type>resource</type><parameter role="reference">pmo</parameter></methodparam>
   <methodparam><type>string</type><parameter>buffer</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_put1</function>
   (MQPUT1) call puts one message on a queue. The queue need not be open.
  </para>
  <para>
   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>
 </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>objDesc</parameter>
     </term>
     <listitem>
      <para>Object descriptor. (MQOD)</para>
      <para>
       This is a structure which identifies the queue to which the message is
       added.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>msgDesc</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>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="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:"~/.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
-->