<!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/xhtml;charset=UTF-8"/>
<title>Kyoto Cabinet: kyotocabinet::TinyHashMap::Iterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacekyotocabinet.html">kyotocabinet</a>::<a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a>::<a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html">Iterator</a>
</div>
</div>
<div class="contents">
<h1>kyotocabinet::TinyHashMap::Iterator Class Reference</h1><!-- doxytag: class="kyotocabinet::TinyHashMap::Iterator" -->
<p><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html" title="Iterator of records.">Iterator</a> of records.
<a href="#_details">More...</a></p>
<p><code>#include <kcmap.h></code></p>
<p><a href="classkyotocabinet_1_1TinyHashMap_1_1Iterator-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a43ebcee59269ef2094c530061a280f5d">Iterator</a> (<a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a> *map)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a43ebcee59269ef2094c530061a280f5d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a06fcdca617233a75ad9e1268ce48fa87">~Iterator</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a06fcdca617233a75ad9e1268ce48fa87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a46b1f3627cfd5fc7baa3c5d8e6dec47f">get_key</a> (size_t *sp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the key of the current record. <a href="#a46b1f3627cfd5fc7baa3c5d8e6dec47f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a44d2e387ee466f4a40e5af033452110c">get_value</a> (size_t *sp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the current record. <a href="#a44d2e387ee466f4a40e5af033452110c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#a380323d0d6ef7b6768b11fcf10407790">get</a> (size_t *ksp, const char **vbp, size_t *vsp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pair of the key and the value of the current record. <a href="#a380323d0d6ef7b6768b11fcf10407790"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html#abbc96f3a51b8dfbd596a9b69b69f4b53">step</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Step the cursor to the next record. <a href="#abbc96f3a51b8dfbd596a9b69b69f4b53"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa0031e3ce6b9954988a99feb8ba24ea"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::TinyHashMap" ref="afa0031e3ce6b9954988a99feb8ba24ea" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>TinyHashMap</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classkyotocabinet_1_1TinyHashMap_1_1Iterator.html" title="Iterator of records.">Iterator</a> of records. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a43ebcee59269ef2094c530061a280f5d"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::Iterator" ref="a43ebcee59269ef2094c530061a280f5d" args="(TinyHashMap *map)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::TinyHashMap::Iterator::Iterator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkyotocabinet_1_1TinyHashMap.html">TinyHashMap</a> * </td>
<td class="paramname"> <em>map</em></td>
<td> ) </td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>map</em> </td><td>the container. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a06fcdca617233a75ad9e1268ce48fa87"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::~Iterator" ref="a06fcdca617233a75ad9e1268ce48fa87" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kyotocabinet::TinyHashMap::Iterator::~Iterator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a46b1f3627cfd5fc7baa3c5d8e6dec47f"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::get_key" ref="a46b1f3627cfd5fc7baa3c5d8e6dec47f" args="(size_t *sp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* kyotocabinet::TinyHashMap::Iterator::get_key </td>
<td>(</td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>sp</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the key of the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the key region of the current record, or NULL on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a44d2e387ee466f4a40e5af033452110c"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::get_value" ref="a44d2e387ee466f4a40e5af033452110c" args="(size_t *sp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* kyotocabinet::TinyHashMap::Iterator::get_value </td>
<td>(</td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>sp</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the value of the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the value region of the current record, or NULL on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a380323d0d6ef7b6768b11fcf10407790"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::get" ref="a380323d0d6ef7b6768b11fcf10407790" args="(size_t *ksp, const char **vbp, size_t *vsp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* kyotocabinet::TinyHashMap::Iterator::get </td>
<td>(</td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>ksp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>vbp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>vsp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pair of the key and the value of the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ksp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbp</em> </td><td>the pointer to the variable into which the pointer to the value region is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsp</em> </td><td>the pointer to the variable into which the size of the value region is assigned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the key region, or NULL on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="abbc96f3a51b8dfbd596a9b69b69f4b53"></a><!-- doxytag: member="kyotocabinet::TinyHashMap::Iterator::step" ref="abbc96f3a51b8dfbd596a9b69b69f4b53" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kyotocabinet::TinyHashMap::Iterator::step </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Step the cursor to the next record. </p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Dec 11 01:50:27 2010 for Kyoto Cabinet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
c07f89287b8745f052fcf9bc1067c5c0
>
files
>
151
