File: mqseries-inq.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (216 lines) | stat: -rw-r--r-- 5,156 bytes parent folder | download
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
212
213
214
215
216
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.mqseries-inq" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mqseries_inq</refname>
  <refpurpose>MQSeries MQINQ</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <methodname>mqseries_inq</methodname>
   <methodparam>
    <type>resource</type>
    <parameter>hconn</parameter>
   </methodparam>
   <methodparam>
    <type>resource</type>
    <parameter>hobj</parameter>
   </methodparam>
   <methodparam>
    <type>int</type>
    <parameter>selectorCount</parameter>
   </methodparam>
   <methodparam>
    <type>array</type>
    <parameter>selectors</parameter>
   </methodparam>
   <methodparam>
    <type>int</type>
    <parameter>intAttrCount</parameter>
   </methodparam>
   <methodparam>
    <type>resource</type>
    <parameter>intAttr</parameter>
   </methodparam>
   <methodparam>
    <type>int</type>
    <parameter>charAttrLength</parameter>
   </methodparam>
   <methodparam>
    <type>resource</type>
    <parameter>charAttr</parameter>
   </methodparam>
   <methodparam>
    <type>resource</type>
    <parameter>compCode</parameter>
   </methodparam>
   <methodparam>
    <type>resource</type>
    <parameter>reason</parameter>
   </methodparam>
  </methodsynopsis>
  <para>
   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>
 </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>selectorCount</parameter>
     </term>
     <listitem>
      <para>Count of selectors.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>selectors</parameter>
     </term>
     <listitem>
      <para>Array of attribute selectors.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>intAttrLength</parameter>
     </term>
     <listitem>
      <para>Count of integer attributes.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>intAttr</parameter>
     </term>
     <listitem>
      <para>Array of integer attributes.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>charAttrLength</parameter>
     </term>
     <listitem>
      <para>Length of character attributes buffer.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>
      <parameter>charAttr</parameter>
     </term>
     <listitem>
      <para>Character attributes.</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_inq</function>
     example
    </title>
    <programlisting role="php">
<![CDATA[
<?php
    $int_attr = array();
    $char_attr = "";
    
    mqseries_inq($conn, $obj, 1, array(MQSERIES_MQCA_Q_MGR_NAME), 0, $int_attr, 48, $char_attr, $comp_code, $reason);
    
    if ($comp_code !== MQSERIES_MQCC_OK) {
        printf("INQ CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
    } else {
        echo "INQ QManager name result ".$char_attr."<br>\n";
    }
?>
]]>
    </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>
   </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
-->