libdb/docs/api_reference/STL/BulkRetrievalOption.html

168 lines
5.9 KiB
HTML
Raw Normal View History

2011-09-13 17:44:24 +00:00
<?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>Chapter 27.  BulkRetrievalOption</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="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
<link rel="prev" href="stlDbstlElemTraitsDbstlElemTraits.html" title="DbstlElemTraits" />
<link rel="next" href="stlBulkRetrievalOptionoperator_eq.html" title="operator==" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Chapter 27. 
BulkRetrievalOption </th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="stlDbstlElemTraitsDbstlElemTraits.html">Prev</a> </td>
<th width="60%" align="center"> </th>
<td width="20%" align="right"> <a accesskey="n" href="stlBulkRetrievalOptionoperator_eq.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="chapter" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="BulkRetrievalOption"></a>Chapter 27. 
BulkRetrievalOption </h2>
</div>
</div>
</div>
<p>Bulk retrieval configuration helper class. </p>
<p>Used by the begin() function of a container. </p>
<h4><a id="id3540390"></a> Public Members </h4>
<div class="informaltable">
<table border="1" width="80%">
<colgroup>
<col />
<col />
</colgroup>
<thead>
<tr>
<th>Member</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="BulkRetrievalOption.html#stlBulkRetrievalOptionBulkRetrievalOption" title="BulkRetrievalOption">BulkRetrievalOption</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlBulkRetrievalOptionoperator_eq.html" title="operator==">operator==</a>
</td>
<td>
<p>Equality comparison. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stlBulkRetrievalOptionoperator_assign.html" title="operator=">operator=</a>
</td>
<td>
<p>Assignment operator. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stlBulkRetrievalOptionbulk_buf_size.html" title="bulk_buf_size">
bulk_buf_size
</a>
</td>
<td>
<p>Return the buffer size set to this object. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stlBulkRetrievalOptionbulk_retrieval.html" title="bulk_retrieval">
bulk_retrieval
</a>
</td>
<td>
<p>This function indicates that you need a bulk retrieval iterator, and it can be also used to optionally set the bulk read buffer size. </p> </td>
</tr>
<tr>
<td>
<a class="xref" href="stlBulkRetrievalOptionno_bulk_retrieval.html" title="no_bulk_retrieval">no_bulk_retrieval</a>
</td>
<td>
<p>This function indicates that you do not need a bulk retrieval iterator. </p> </td>
</tr>
</tbody>
</table>
</div>
<h4><a id="id3540395"></a>
Group</h4>
<p>
<a class="xref" href="dbstl_helper_classes.html" title="Chapter 21.  Dbstl Helper Classes">
Dbstl Helper Classes </a>
</p>
<p>
</p>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="stlBulkRetrievalOptionBulkRetrievalOption"></a>BulkRetrievalOption</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stlBulkRetrievalOptionBulkRetrievalOption_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
BulkRetrievalOption(Option bulk_retrieve1,
u_int32_t bulk_buf_sz=DBSTL_BULK_BUF_SIZE)
</pre>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3543339"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="BulkRetrievalOption.html" title="Chapter 27.  BulkRetrievalOption">BulkRetrievalOption</a>
</p>
</div>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="stlDbstlElemTraitsDbstlElemTraits.html">Prev</a> </td>
<td width="20%" align="center"> </td>
<td width="40%" align="right"> <a accesskey="n" href="stlBulkRetrievalOptionoperator_eq.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbstlElemTraits </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> operator==</td>
</tr>
</table>
</div>
</body>
</html>