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
|
<?xml version="1.0"?>
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
style="function"
xmlns:api="http://projectmallard.org/experimental/api/"
xmlns:ui="http://projectmallard.org/experimental/ui/"
id="mongoc_cursor_error">
<info>
<link type="guide" xref="mongoc_cursor_t" group="function"/>
</info>
<title>mongoc_cursor_error()</title>
<section id="synopsis">
<title>Synopsis</title>
<synopsis><code mime="text/x-csrc"><![CDATA[bool
mongoc_cursor_error (mongoc_cursor_t *cursor,
bson_error_t *error);
]]></code></synopsis>
</section>
<section id="parameters">
<title>Parameters</title>
<table>
<tr><td><p>cursor</p></td><td><p>A <code xref="mongoc_cursor_t">mongoc_cursor_t</code>.</p></td></tr>
<tr><td><p>error</p></td><td><p>An optional location for a <code xref="errors">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
</table>
</section>
<section id="description">
<title>Description</title>
<p>This function checks to see if an error has occurred while iterating the cursor.</p>
</section>
<section id="errors">
<title>Errors</title>
<p>Errors are propagated via the <code>error</code> parameter.</p>
</section>
<section id="return">
<title>Returns</title>
<p>false if no error has occurred, otherwise true and error is set.</p>
</section>
</page>
|
