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
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DB_MULTIPLE_NEXT</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C API Reference" />
<link rel="up" href="dbt.html" title="Chapter 4. The DBT Handle" />
<link rel="prev" href="DB_MULTIPLE_INIT.html" title="DB_MULTIPLE_INIT" />
<link rel="next" href="DB_MULTIPLE_KEY_NEXT.html" title="DB_MULTIPLE_KEY_NEXT" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_MULTIPLE_NEXT</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="DB_MULTIPLE_INIT.html">Prev</a> </td>
<th width="60%" align="center">Chapter 4.
The DBT Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="DB_MULTIPLE_KEY_NEXT.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="DB_MULTIPLE_NEXT"></a>DB_MULTIPLE_NEXT</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
DB_MULTIPLE_NEXT(void *pointer, DBT *data, void *retdata,
size_t retdlen); </pre>
<p>
If either of the
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE">DB_MULTIPLE</a>
or
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE_KEY">DB_MULTIPLE_KEY</a>
flags were specified to the <a class="xref" href="dbget.html" title="DB->get()">DB->get()</a> or
<a class="xref" href="dbcget.html" title="DBcursor->get()">DBcursor->get()</a> methods, the data
<a class="link" href="dbt.html" title="Chapter 4. The DBT Handle">DBT</a> returned by those interfaces will
refer to a buffer that is filled with data. Access to that data is through the
DB_MULTIPLE_* macros.
</p>
<p>
Returns the next <a class="link" href="dbt.html" title="Chapter 4. The DBT Handle">DBT</a> in the bulk
retrieval set.
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp51184824"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp51185016"></a>pointer</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>pointer</strong></span> parameter is a variable
that must have been initialized by a call to
<a class="xref" href="DB_MULTIPLE_INIT.html" title="DB_MULTIPLE_INIT">DB_MULTIPLE_INIT</a>.
</p>
<p>
This parameter is set to NULL if there are no more key/data pairs in
the returned set.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp51160536"></a>data</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>data</strong></span> parameter is a
<a class="link" href="dbt.html" title="Chapter 4. The DBT Handle">DBT</a> structure returned from a
successful call to <a class="xref" href="dbget.html" title="DB->get()">DB->get()</a> or
<a class="xref" href="dbcget.html" title="DBcursor->get()">DBcursor->get()</a> for which he
<a class="link" href="dbcget.html#dbcget_DB_MULTIPLE">DB_MULTIPLE</a>
flag was specified.
</p>
<p>
The <span class="bold"><strong>data</strong></span> parameter must have been initialized by
a call to <a class="xref" href="DB_MULTIPLE_INIT.html" title="DB_MULTIPLE_INIT">DB_MULTIPLE_INIT</a>.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp51012264"></a>retdata</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>retdata</strong></span> is set
to the next data element in the returned set.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp51135936"></a>retdlen</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>retdlen</strong></span> parameter is set to
the length, in bytes, of that data element. When used with the Queue and
Recno access methods, <span class="bold"><strong>retdata</strong></span> parameter
will be set to NULL for deleted records.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp51223768"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="dbt.html" title="Chapter 4. The DBT Handle">DBT</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp51224848"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="dbt.html#dbtlist" title="DBT and Bulk Operations">DBT and Bulk Operations</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="DB_MULTIPLE_INIT.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="dbt.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="DB_MULTIPLE_KEY_NEXT.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_MULTIPLE_INIT </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_MULTIPLE_KEY_NEXT</td>
</tr>
</table>
</div>
</body>
</html>
|