Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > main-release > by-pkgid > a00abf5f94bf470fd4cc9e10b2d135e0 > files > 23

lib64db4.8-devel-4.8.26-1mdv2010.1.x86_64.rpm

<?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_KEY_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_NEXT.html" title="DB_MULTIPLE_NEXT" />
    <link rel="next" href="DB_MULTIPLE_RECNO_NEXT.html" title="DB_MULTIPLE_RECNO_NEXT" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">DB_MULTIPLE_KEY_NEXT</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="DB_MULTIPLE_NEXT.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_RECNO_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_KEY_NEXT"></a>DB_MULTIPLE_KEY_NEXT</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db.h&gt;

DB_MULTIPLE_KEY_NEXT(void *pointer, DBT *data,
    void *retkey, size_t retklen, 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-&gt;get()">DB-&gt;get()</a> or 
        <a class="xref" href="dbcget.html" title="DBcursor-&gt;get()">DBcursor-&gt;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. Use this macro with <a class="link" href="dbt.html" title="Chapter 4.  The DBT Handle">DBT</a> 
        structures obtained from a database that uses the Btree or Hash
        access methods.
    </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="id1658314"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="id1658460"></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="id1658444"></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="dbcget.html" title="DBcursor-&gt;get()">DBcursor-&gt;get()</a> with the Btree or Hash
                        access methods for which the 
                        <a class="link" href="dbcget.html#dbcget_DB_MULTIPLE_KEY">DB_MULTIPLE_KEY</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="id1658631"></a>retkey</h4>
              </div>
            </div>
          </div>
          <p>
                        The <span class="bold"><strong>retkey</strong></span> parameter is set
                        to the next key 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="id1658650"></a>retklen</h4>
              </div>
            </div>
          </div>
          <p>
                        The <span class="bold"><strong>retklen</strong></span> parameter is set to
                        the length, in bytes, of the next key element.
                     </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="id1658663"></a>retdata</h4>
              </div>
            </div>
          </div>
          <p>
                        The <span class="bold"><strong>retdata</strong></span> parameter 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="id1658676"></a>retdlen</h4>
              </div>
            </div>
          </div>
          <p>
                        The <span class="bold"><strong>retdlen</strong></span> parameter is set to
                        the length, in bytes, of the next data element.
                     </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="id1658691"></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="id1658633"></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_NEXT.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_RECNO_NEXT.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DB_MULTIPLE_NEXT </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> DB_MULTIPLE_RECNO_NEXT</td>
        </tr>
      </table>
    </div>
  </body>
</html>