reference/mysqli/mysqli/reap-async-query.xml
63b99082ef83eade08151f8cb528246fded81db9
...
...
@@ -10,19 +10,23 @@
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<para>&style.oop;</para>
13
-
<methodsynopsis role="oop">
14
-
<modifier>public</modifier> <type>mysqli_result</type><methodname>mysqli::reap_async_query</methodname>
15
-
<void />
13
+
<methodsynopsis role="mysqli">
14
+
<modifier>public</modifier> <type class="union"><type>mysqli_result</type><type>bool</type></type><methodname>mysqli::reap_async_query</methodname>
15
+
<void/>
16
16
</methodsynopsis>
17
17
<para>&style.procedural;</para>
18
18
<methodsynopsis>
19
-
<type>mysqli_result</type><methodname>mysqli_reap_async_query</methodname>
20
-
<methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
19
+
<type class="union"><type>mysqli_result</type><type>bool</type></type><methodname>mysqli_reap_async_query</methodname>
20
+
<methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
21
21
</methodsynopsis>
22
22
<para>
23
23
Get result from async query.
24
-
&mysqli.available.mysqlnd;
25
24
</para>
25
+
<note>
26
+
<para>
27
+
&mysqli.available.mysqlnd;
28
+
</para>
29
+
</note>
26
30
</refsect1>
27
31

28
32
<refsect1 role="parameters">
...
...
@@ -37,10 +41,18 @@
37
41
<refsect1 role="returnvalues">
38
42
&reftitle.returnvalues;
39
43
<para>
40
-
Returns <classname>mysqli_result</classname> in success, &false; otherwise.
44
+
Returns &false; on failure. For successful queries which produce a result set, such as <literal>SELECT, SHOW, DESCRIBE</literal> or
45
+
<literal>EXPLAIN</literal>, <function>mysqli_reap_async_query</function> will return
46
+
a <classname>mysqli_result</classname> object. For other successful queries, <function>mysqli_reap_async_query</function> will
47
+
return &true;.
41
48
</para>
42
49
</refsect1>
43
50

51
+
<refsect1 role="errors">
52
+
&reftitle.errors;
53
+
&mysqli.conditionalexception;
54
+
</refsect1>
55
+

44
56
<refsect1 role="seealso">
45
57
&reftitle.seealso;
46
58
<para>
...
...
@@ -51,7 +63,6 @@
51
63
</refsect1>
52
64

53
65
</refentry>
54
-

55
66
<!-- Keep this comment at the end of the file
56
67
Local variables:
57
68
mode: sgml
58
69