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
|
<?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_clone">
<info>
<link type="guide" xref="mongoc_cursor_t" group="function"/>
</info>
<title>mongoc_cursor_clone()</title>
<section id="synopsis">
<title>Synopsis</title>
<synopsis><code mime="text/x-csrc"><![CDATA[mongoc_cursor_t *
mongoc_cursor_clone (const mongoc_cursor_t *cursor)
BSON_GNUC_WARN_UNUSED_RESULT;
]]></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>
</table>
</section>
<section id="description">
<title>Description</title>
<p>This function shall create a copy of a <code xref="mongoc_cursor_t">mongoc_cursor_t</code>. The cloned cursor will be reset to the beginning of the query, and therefore the query will be re-executed on the MongoDB server when <code xref="mongoc_cursor_next">mongoc_cursor_next()</code> is called.</p>
</section>
<section id="return">
<title>Returns</title>
<p>A newly allocated <code xref="mongoc_cursor_t">mongoc_cursor_t</code> that should be freed with <code xref="mongoc_cursor_destroy">mongoc_cursor_destroy()</code> when no longer in use.</p>
<note style="warning"><p>Failure to handle the result of this function is a programming error.</p></note>
</section>
</page>
|
