1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>begin</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" /> 10 <link rel="up" href="db_map.html" title="Chapter 5. Db_map" /> 11 <link rel="prev" href="stldb_mapinsert.html" title="insert" /> 12 <link rel="next" href="stldb_mapend.html" title="end" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center"> 19begin 20</th> 21 </tr> 22 <tr> 23 <td width="20%" align="left"><a accesskey="p" href="stldb_mapinsert.html">Prev</a> </td> 24 <th width="60%" align="center">Chapter 5. 25 Db_map </th> 26 <td width="20%" align="right"> <a accesskey="n" href="stldb_mapend.html">Next</a></td> 27 </tr> 28 </table> 29 <hr /> 30 </div> 31 <div class="sect1" lang="en" xml:lang="en"> 32 <div class="titlepage"> 33 <div> 34 <div> 35 <h2 class="title" style="clear: both"><a id="stldb_mapbegin"></a> 36begin 37</h2> 38 </div> 39 </div> 40 </div> 41 <div class="sect2" lang="en" xml:lang="en"> 42 <div class="titlepage"> 43 <div> 44 <div> 45 <h3 class="title"><a id="func_details"></a> 46Function Details</h3> 47 </div> 48 </div> 49 </div> 50 <pre class="programlisting"> 51iterator begin(ReadModifyWriteOption rmw= 52 ReadModifyWriteOption::no_read_modify_write(), bool readonly=false, 53 BulkRetrievalOption bulkretrieval=BulkRetrievalOption::no_bulk_retrieval(), 54 bool directdb_get=true) 55 </pre> 56 <div class="sect3" lang="en" xml:lang="en"> 57 <div class="titlepage"></div> 58 <p>Begin a read-write or readonly iterator which sits on the first key/data pair of the database. </p> 59 <p></p> 60 </div> 61 <div class="sect3" lang="en" xml:lang="en"> 62 <div class="titlepage"> 63 <div> 64 <div> 65 <h4 class="title"><a id="id1550940"></a> 66Parameters</h4> 67 </div> 68 </div> 69 </div> 70 <div class="sect4" lang="en" xml:lang="en"> 71 <div class="titlepage"> 72 <div> 73 <div> 74 <h5 class="title"><a id="id1550954"></a> 75 directdb_get </h5> 76 </div> 77 </div> 78 </div> 79 <p>Same as that of db_vector::begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </p> 80 </div> 81 <div class="sect4" lang="en" xml:lang="en"> 82 <div class="titlepage"> 83 <div> 84 <div> 85 <h5 class="title"><a id="id1551128"></a> 86 readonly </h5> 87 </div> 88 </div> 89 </div> 90 <p>Same as that of db_vector::begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </p> 91 </div> 92 <div class="sect4" lang="en" xml:lang="en"> 93 <div class="titlepage"> 94 <div> 95 <div> 96 <h5 class="title"><a id="id1551121"></a> 97 rmw </h5> 98 </div> 99 </div> 100 </div> 101 <p>Same as that of db_vector::begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </p> 102 </div> 103 <div class="sect4" lang="en" xml:lang="en"> 104 <div class="titlepage"> 105 <div> 106 <div> 107 <h5 class="title"><a id="id1551051"></a> 108 bulkretrieval </h5> 109 </div> 110 </div> 111 </div> 112 <p>Same as that of db_vector::begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </p> 113 </div> 114 </div> 115 <div class="sect3" lang="en" xml:lang="en"> 116 <div class="titlepage"> 117 <div> 118 <div> 119 <h4 class="title"><a id="id1551104"></a> 120Return Value</h4> 121 </div> 122 </div> 123 </div> 124 <p>The created iterator. </p> 125 </div> 126 <div class="sect3" lang="en" xml:lang="en"> 127 <div class="titlepage"> 128 <div> 129 <div> 130 <h4 class="title"><a id="id1551116"></a> 131See Also</h4> 132 </div> 133 </div> 134 </div> 135 <p> 136 </p> 137 <p><a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::begin</a> 138(<a class="link" href="ReadModifyWriteOption.html" title="Chapter 28. ReadModifyWriteOption">ReadModifyWriteOption</a> 139, bool, <a class="link" href="BulkRetrievalOption.html" title="Chapter 27. BulkRetrievalOption">BulkRetrievalOption</a> 140, bool) </p> 141 <p> </p> 142 </div> 143 <pre class="programlisting"> 144const_iterator begin(BulkRetrievalOption bulkretrieval= 145 BulkRetrievalOption::no_bulk_retrieval(), 146 bool directdb_get=true) const 147 </pre> 148 <div class="sect3" lang="en" xml:lang="en"> 149 <div class="titlepage"></div> 150 <p>Begin a read-only iterator. </p> 151 <p></p> 152 </div> 153 <div class="sect3" lang="en" xml:lang="en"> 154 <div class="titlepage"> 155 <div> 156 <div> 157 <h4 class="title"><a id="id1550956"></a> 158Parameters</h4> 159 </div> 160 </div> 161 </div> 162 <div class="sect4" lang="en" xml:lang="en"> 163 <div class="titlepage"> 164 <div> 165 <div> 166 <h5 class="title"><a id="id1551151"></a> 167 directdb_get </h5> 168 </div> 169 </div> 170 </div> 171 <p>Same as that of begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </p> 172 </div> 173 <div class="sect4" lang="en" xml:lang="en"> 174 <div class="titlepage"> 175 <div> 176 <div> 177 <h5 class="title"><a id="id1551175"></a> 178 bulkretrieval </h5> 179 </div> 180 </div> 181 </div> 182 <p>Same as that of begin(ReadModifyWrite, bool, BulkRetrievalOption, bool); </p> 183 </div> 184 </div> 185 <div class="sect3" lang="en" xml:lang="en"> 186 <div class="titlepage"> 187 <div> 188 <div> 189 <h4 class="title"><a id="id1551192"></a> 190Return Value</h4> 191 </div> 192 </div> 193 </div> 194 <p>The created const iterator. </p> 195 </div> 196 <div class="sect3" lang="en" xml:lang="en"> 197 <div class="titlepage"> 198 <div> 199 <div> 200 <h4 class="title"><a id="id1551184"></a> 201See Also</h4> 202 </div> 203 </div> 204 </div> 205 <p> 206 </p> 207 <p><a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::begin</a> 208(ReadModifyWrite, bool, <a class="link" href="BulkRetrievalOption.html" title="Chapter 27. BulkRetrievalOption">BulkRetrievalOption</a> 209, bool); </p> 210 <p> </p> 211 </div> 212 </div> 213 <div class="sect2" lang="en" xml:lang="en"> 214 <div class="titlepage"> 215 <div> 216 <div> 217 <h3 class="title"><a id="id1550899"></a> 218Group: Iterator Functions</h3> 219 </div> 220 </div> 221 </div> 222 <p>The parameters in begin functions of this group have identical meaning to thoes in <a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::begin</a> 223, refer to those functions for details.</p> 224 <div class="simplesect" lang="en" xml:lang="en"> 225 <div class="titlepage"></div> 226 <p><a class="link" href="db_vector.html#stldb_vectorbegin" title="begin">db_vector::begin()</a> 227 </p> 228 </div> 229 <p> 230</p> 231 </div> 232 <div class="sect2" lang="en" xml:lang="en"> 233 <div class="titlepage"> 234 <div> 235 <div> 236 <h3 class="title"><a id="id1550902"></a> 237Class</h3> 238 </div> 239 </div> 240 </div> 241 <p> 242 <a class="link" href="db_map.html" title="Chapter 5. Db_map"> 243 db_map</a> 244 </p> 245 </div> 246 </div> 247 <div class="navfooter"> 248 <hr /> 249 <table width="100%" summary="Navigation footer"> 250 <tr> 251 <td width="40%" align="left"><a accesskey="p" href="stldb_mapinsert.html">Prev</a> </td> 252 <td width="20%" align="center"> 253 <a accesskey="u" href="db_map.html">Up</a> 254 </td> 255 <td width="40%" align="right"> <a accesskey="n" href="stldb_mapend.html">Next</a></td> 256 </tr> 257 <tr> 258 <td width="40%" align="left" valign="top"> 259insert 260 </td> 261 <td width="20%" align="center"> 262 <a accesskey="h" href="index.html">Home</a> 263 </td> 264 <td width="40%" align="right" valign="top"> 265end 266</td> 267 </tr> 268 </table> 269 </div> 270 </body> 271</html> 272