<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script src="../_static/jquery.js"></script>
- <script src="../_static/underscore.js"></script>
- <script src="../_static/doctools.js"></script>
- <script src="../_static/language_data.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="next" title="Set Hash Function" href="hashkit_function.html" />
- <link rel="prev" title="libhashkit API" href="index.html" />
+ <link rel="prev" title="libhashkit - C/C++ hashing library" href="index.html" />
</head>
<body class="wy-body-for-nav">
- <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul>
+ <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_basics.html">Basics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_data.html">Working with Data</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_errors.html">Messages and Errors</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_advanced.html">Advanced Topics</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/index_deprecated.html">Deprecated Functionality</a></li>
-</ul>
-</li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/configuration.html">Configuration</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/constants.html">Constants</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/examples.html">Examples</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcached/versioning.html">Versioning</a></li>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">libmemcachedutil</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../libmemcachedutil/memcached_pool.html">Working with memcached pools</a></li>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">libhashkit</span></p>
-<ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">libhashkit API</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Creating a hashkit structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="hashkit_function.html">Set Hash Function</a></li>
<li class="toctree-l2"><a class="reference internal" href="hashkit_value.html">Generate hash value</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
</ul>
-<p class="caption"><span class="caption-text">Client Applications</span></p>
<ul>
-<li class="toctree-l1"><a class="reference internal" href="../bin/index.html">Client Applications</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcapable.html">memcapable - Checking a Memcached server capabilities and compatibility</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcat.html">memcat - “cat” data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memcp.html">memcp - Copy data to a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memdump.html">memdump - Dumping your server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memerror.html">memerror - translate an error code to a string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memflush.html">memflush - flush all data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memrm.html">memrm - Remove data from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memslap.html">memslap - Load testing and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memstat.html">memstat - Gather statistics from a server</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memexist.html">memexist - Check for the existence of a key</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memparse.html">memparse - Parse an option string</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memping.html">memping - Test to see if a server is available.</a></li>
-<li class="toctree-l2"><a class="reference internal" href="../bin/memtouch.html">memtouch - Touches a key.</a></li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
</ul>
<li><a href="../index.html">Docs</a> »</li>
- <li><a href="index.html">libhashkit API</a> »</li>
+ <li><a href="index.html">libhashkit - C/C++ hashing library</a> »</li>
<li>Creating a hashkit structure</li>
<li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/libhashkit/hashkit_create.rst" class="fa fa-github"> Edit on GitHub</a>
+
+
</li>
<div class="section" id="creating-a-hashkit-structure">
<h1>Creating a hashkit structure<a class="headerlink" href="#creating-a-hashkit-structure" title="Permalink to this headline">¶</a></h1>
-<p>Create, copy and free a hashkit structure</p>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
-<dl class="simple">
-<dt>#include <libhashkit-1.0/hashkit.h></dt><dd><p>Compile and link with -lhashkit</p>
-</dd>
+<dl class="docutils">
+<dt>#include <libhashkit-1.0/hashkit.h></dt>
+<dd>Compile and link with -lhashkit</dd>
</dl>
<dl class="type">
<dt id="_CPPv410hashkit_st">
-<span id="_CPPv310hashkit_st"></span><span id="_CPPv210hashkit_st"></span><span id="hashkit_st"></span><em class="property">typedef </em><em class="property">struct</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> <code class="
sig-name descname">hashkit_st</code><a class="headerlink" href="#_CPPv410hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
+<span id="_CPPv310hashkit_st"></span><span id="_CPPv210hashkit_st"></span><span id="hashkit_st"></span><em class="property">typedef </em><em class="property">struct</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> <code class="descname">hashkit_st</code><a class="headerlink" href="#_CPPv410hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>
<dl class="function">
<dt id="_CPPv414hashkit_createP10hashkit_st">
-<span id="_CPPv314hashkit_createP10hashkit_st"></span><span id="_CPPv214hashkit_createP10hashkit_st"></span><span id="hashkit_create__hashkit_stP"></span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<code class="sig-name descname">hashkit_create</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414hashkit_createP10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv314hashkit_createP10hashkit_st"></span><span id="_CPPv214hashkit_createP10hashkit_st"></span><span id="hashkit_create__hashkit_stP"></span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<code class="descname">hashkit_create</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414hashkit_createP10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hash</strong> -- memory address of a <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct;
+if a nullptr is passed, the struct will be dynamically allocated by libhashkit</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">pointer to initialized <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> structure</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
<dl class="function">
<dt id="_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st">
-<span id="_CPPv313hashkit_cloneP10hashkit_stPK10hashkit_st"></span><span id="_CPPv213hashkit_cloneP10hashkit_stPK10hashkit_st"></span><span id="hashkit_clone__hashkit_stP.hashkit_stCP"></span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<code class="sig-name descname">hashkit_clone</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>destination</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv313hashkit_cloneP10hashkit_stPK10hashkit_st"></span><span id="_CPPv213hashkit_cloneP10hashkit_stPK10hashkit_st"></span><span id="hashkit_clone__hashkit_stP.hashkit_stCP"></span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<code class="descname">hashkit_clone</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>destination</em>, <em class="property">const</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>destination</strong> -- memory address of a <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct;
+if a nullptr is passed, the struct will be dynamically allocated by libhashkit</li>
+<li><strong>ptr</strong> -- pointer of the <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct to copy</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pointer to a <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> structure (<a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone::destination"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">destination</span></code></a>, if not nullptr), initialized from <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone::ptr"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">ptr</span></code></a></p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
<dl class="function">
<dt id="_CPPv412hashkit_freeP10hashkit_st">
-<span id="_CPPv312hashkit_freeP10hashkit_st"></span><span id="_CPPv212hashkit_freeP10hashkit_st"></span><span id="hashkit_free__hashkit_stP"></span>void <code class="sig-name descname">hashkit_free</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412hashkit_freeP10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv312hashkit_freeP10hashkit_st"></span><span id="_CPPv212hashkit_freeP10hashkit_st"></span><span id="hashkit_free__hashkit_stP"></span>void <code class="descname">hashkit_free</code><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412hashkit_freeP10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hash</strong> -- pointer to an initialized <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
<dl class="function">
<dt id="_CPPv420hashkit_is_allocatedPK10hashkit_st">
-<span id="_CPPv320hashkit_is_allocatedPK10hashkit_st"></span><span id="_CPPv220hashkit_is_allocatedPK10hashkit_st"></span><span id="hashkit_is_allocated__hashkit_stCP"></span>bool <code class="sig-name descname">hashkit_is_allocated</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
-<dd></dd></dl>
+<span id="_CPPv320hashkit_is_allocatedPK10hashkit_st"></span><span id="_CPPv220hashkit_is_allocatedPK10hashkit_st"></span><span id="hashkit_is_allocated__hashkit_stCP"></span>bool <code class="descname">hashkit_is_allocated</code><span class="sig-paren">(</span><em class="property">const</em> <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st">hashkit_st</a> *<em>hash</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="Permalink to this definition">¶</a><br /></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>hash</strong> -- pointer to an initialized <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> struct</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">bool, whether the <a class="reference internal" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="hashkit_is_allocated::hash"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hash</span></code></a> struct was dynamically allocated</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
-<p>The <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> function initializes a hashkit object for use. If
-you pass a NULL argument for hash, then the memory for the object is
-allocated. If you specify a pre-allocated piece of memory, that is
-initialized for use.</p>
-<p>The <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a> function initializes a hashkit object much like
-<a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a>, but instead of using default settings it will use
-the settings of the ptr hashkit object.</p>
-<p>The <a class="reference internal" href="#_CPPv412hashkit_freeP10hashkit_st" title="hashkit_free"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_free()</span></code></a> frees any resources being consumed by the hashkit
-objects that were initialized with <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> or <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a>.</p>
-<p>The <a class="reference internal" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="hashkit_is_allocated"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_is_allocated()</span></code></a> reports where the memory was allocated
-for a hashkit object.</p>
+<p>The <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> function initializes a hashkit object for use. If you pass
+a nullptr argument for hash, then the memory for the object is allocated. If you
+specify a pre-allocated piece of memory, that is initialized for use.</p>
+<p>The <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a> function initializes a hashkit object much like
+<a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a>, but instead of using default settings it will use the settings
+of the ptr hashkit object.</p>
+<p>The <a class="reference internal" href="#_CPPv412hashkit_freeP10hashkit_st" title="hashkit_free"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_free()</span></code></a> frees any resources being consumed by the hashkit objects
+that were initialized with <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> or <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a>.</p>
+<p>The <a class="reference internal" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="hashkit_is_allocated"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_is_allocated()</span></code></a> reports whether the memory was allocated for a hashkit
+object.</p>
</div>
<div class="section" id="return-value">
<h2>RETURN VALUE<a class="headerlink" href="#return-value" title="Permalink to this headline">¶</a></h2>
-<p><a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> and <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a> will return NULL on
-failure or non-NULL on success.</p>
-<p><a class="reference internal" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="hashkit_is_allocated"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_is_allocated()</span></code></a> returns true if the memory for the hashkit
-object was allocated inside of <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> or
-<a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a>, otherwise it is false and was user-supplied memory.</p>
+<p><a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> and <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a> will return nullptr on failure or pointer
+to <a class="reference internal" href="#_CPPv410hashkit_st" title="hashkit_st"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_st</span></code></a> on success.</p>
+<p><a class="reference internal" href="#_CPPv420hashkit_is_allocatedPK10hashkit_st" title="hashkit_is_allocated"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_is_allocated()</span></code></a> returns true if the memory for the hashkit object was
+allocated inside of <a class="reference internal" href="#_CPPv414hashkit_createP10hashkit_st" title="hashkit_create"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_create()</span></code></a> or <a class="reference internal" href="#_CPPv413hashkit_cloneP10hashkit_stPK10hashkit_st" title="hashkit_clone"><code class="xref cpp cpp-any docutils literal notranslate"><span class="pre">hashkit_clone()</span></code></a>, otherwise it is false
+and was user-supplied memory.</p>
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li><p><a class="reference internal" href="../libhashkit.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></p></li>
-<li><p><a class="reference internal" href="hashkit_value.html"><span class="doc">Generate hash value</span></a></p></li>
-<li><p><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></p></li>
+<li><a class="reference internal" href="index.html"><span class="doc">libhashkit - C/C++ hashing library</span></a></li>
+<li><a class="reference internal" href="hashkit_value.html"><span class="doc">Generate hash value</span></a></li>
+<li><a class="reference internal" href="hashkit_function.html"><span class="doc">Set Hash Function</span></a></li>
</ul>
</div>
</div>
<a href="hashkit_function.html" class="btn btn-neutral float-right" title="Set Hash Function" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="index.html" class="btn btn-neutral float-left" title="libhashkit API" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+ <a href="index.html" class="btn btn-neutral float-left" title="libhashkit - C/C++ hashing library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
projects / m6w6 / libmemcached / blobdiff