<?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>move_to</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++ Standard Template Library API Reference" /> <link rel="up" href="db_map_base_iterator.html" title="Chapter 15. Db_map_base_iterator" /> <link rel="prev" href="stldb_map_base_iteratorclose_cursor.html" title="close_cursor" /> <link rel="next" href="stldb_map_base_iteratorset_bulk_buffer.html" title="set_bulk_buffer" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center"> move_to </th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="stldb_map_base_iteratorclose_cursor.html">Prev</a> </td> <th width="60%" align="center">Chapter 15. Db_map_base_iterator </th> <td width="20%" align="right"> <a accesskey="n" href="stldb_map_base_iteratorset_bulk_buffer.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="stldb_map_base_iteratormove_to"></a> move_to </h2> </div> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="func_details"></a> Function Details</h3> </div> </div> </div> <pre class="programlisting"> int move_to(const kdt &k, int flag=DB_SET) const </pre> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"></div> <p>Iterator movement function. </p> <p>Move this iterator to the specified key k, by default moves exactly to k, and update cached data element, you can also specify DB_SET_RANGE, to move to the biggest key smaller than k. The btree/hash key comparison routine determines which key is bigger. When the iterator is on a multiple container, move_to will move itself to the first key/data pair of the identical keys. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1563940"></a> Parameters</h4> </div> </div> </div> <div class="sect4" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h5 class="title"><a id="id1564039"></a> k </h5> </div> </div> </div> <p>The target key value to move to. </p> </div> <div class="sect4" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h5 class="title"><a id="id1564008"></a> flag </h5> </div> </div> </div> <p>Flags available: DB_SET(default) or DB_SET_RANGE. DB_SET will move this iterator exactly at k; DB_SET_RANGE moves this iterator to k or the smallest key greater than k. If fail to find such a key, this iterator will become invalid. </p> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1563955"></a> Return Value</h4> </div> </div> </div> <p>0 if succeed; non-0 otherwise, and this iterator becomes invalid. Call db_strerror with the return value to get the error message. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1563582"></a> Class</h3> </div> </div> </div> <p> <a class="link" href="db_map_base_iterator.html" title="Chapter 15. Db_map_base_iterator"> db_map_base_iterator</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="stldb_map_base_iteratorclose_cursor.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="db_map_base_iterator.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="stldb_map_base_iteratorset_bulk_buffer.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top"> close_cursor </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> set_bulk_buffer </td> </tr> </table> </div> </body> </html>