abdelrahman/how-to-vulkan
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
13fa90a0e94b17ef2c88ac895a9d2368241a6eab
how-to-vulkan/ktx/build/docs/html/libktx/classktxHashList.html
T
abdelrahman 13fa90a0e9 Add ktx
2026-06-14 19:09:18 +01:00

708 lines
42 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libktx Reference: ktxHashList Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="ktx_logo_200.png"/></td>
<td id="projectalign">
<div id="projectname">libktx Reference<span id="projectnumber">&#160;0.0.0</span>
</div>
<div id="projectbrief">Libraries and tools to create and read KTX image texture files.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('classktxHashList.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">ktxHashList Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Opaque handle to a <a class="el" href="classktxHashList.html" title="Opaque handle to a ktxHashList.">ktxHashList</a>.
<a href="#details">More...</a></p>
<p><code>#include &lt;ktx.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-methods" class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aaab69a1ef86c52707d0a33dcba316c60" id="r_aaab69a1ef86c52707d0a33dcba316c60"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#aaab69a1ef86c52707d0a33dcba316c60">ktxHashList_Construct</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead)</td></tr>
<tr class="memdesc:aaab69a1ef86c52707d0a33dcba316c60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an empty hash list for storing key-value pairs. <br /></td></tr>
<tr class="memitem:a11f1a2ff9f574cd803803b77ec758966" id="r_a11f1a2ff9f574cd803803b77ec758966"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a11f1a2ff9f574cd803803b77ec758966">ktxHashList_ConstructCopy</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead, <a class="el" href="classktxHashList.html">ktxHashList</a> orig)</td></tr>
<tr class="memdesc:a11f1a2ff9f574cd803803b77ec758966"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a hash list by copying another. <br /></td></tr>
<tr class="memitem:a0e3349a7b71be7aaa4f8766fc8a0d437" id="r_a0e3349a7b71be7aaa4f8766fc8a0d437"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#a0e3349a7b71be7aaa4f8766fc8a0d437">ktxHashList_Destruct</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead)</td></tr>
<tr class="memdesc:a0e3349a7b71be7aaa4f8766fc8a0d437"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destruct a hash list. <br /></td></tr>
<tr class="memitem:a13c991ecb452345d4ac2f9ca4ff71b80" id="r_a13c991ecb452345d4ac2f9ca4ff71b80"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a13c991ecb452345d4ac2f9ca4ff71b80">ktxHashList_Create</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> **ppHl)</td></tr>
<tr class="memdesc:a13c991ecb452345d4ac2f9ca4ff71b80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an empty hash list for storing key-value pairs. <br /></td></tr>
<tr class="memitem:a50f608b84f671b23849be13254cc511e" id="r_a50f608b84f671b23849be13254cc511e"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a50f608b84f671b23849be13254cc511e">ktxHashList_CreateCopy</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> **ppHl, <a class="el" href="classktxHashList.html">ktxHashList</a> orig)</td></tr>
<tr class="memdesc:a50f608b84f671b23849be13254cc511e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a copy of a hash list. <br /></td></tr>
<tr class="memitem:aa84d4269b0efd2fb9fb2508a371fa0ca" id="r_aa84d4269b0efd2fb9fb2508a371fa0ca"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#aa84d4269b0efd2fb9fb2508a371fa0ca">ktxHashList_Destroy</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead)</td></tr>
<tr class="memdesc:aa84d4269b0efd2fb9fb2508a371fa0ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy a hash list. <br /></td></tr>
<tr class="memitem:ad013c9dd666f3b57e3b0a717e0186277" id="r_ad013c9dd666f3b57e3b0a717e0186277"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#ad013c9dd666f3b57e3b0a717e0186277">ktxHashList_AddKVPair</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead, const char *key, unsigned int valueLen, const void *value)</td></tr>
<tr class="memdesc:ad013c9dd666f3b57e3b0a717e0186277"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a key value pair to a hash list. <br /></td></tr>
<tr class="memitem:a71475476ba962532003472278dbe33a3" id="r_a71475476ba962532003472278dbe33a3"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a71475476ba962532003472278dbe33a3">ktxHashList_DeleteKVPair</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead, const char *key)</td></tr>
<tr class="memdesc:a71475476ba962532003472278dbe33a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a key value pair in a hash list. <br /></td></tr>
<tr class="memitem:a21e5f3318a192082258792f7f9d55400" id="r_a21e5f3318a192082258792f7f9d55400"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a21e5f3318a192082258792f7f9d55400">ktxHashList_DeleteEntry</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead, <a class="el" href="classktxHashListEntry.html">ktxHashListEntry</a> *pEntry)</td></tr>
<tr class="memdesc:a21e5f3318a192082258792f7f9d55400"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete an entry from a hash list. <br /></td></tr>
<tr class="memitem:a2d5939ac234d292854de5afeb786b6ae" id="r_a2d5939ac234d292854de5afeb786b6ae"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a2d5939ac234d292854de5afeb786b6ae">ktxHashList_FindEntry</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead, const char *key, <a class="el" href="classktxHashListEntry.html">ktxHashListEntry</a> **ppEntry)</td></tr>
<tr class="memdesc:a2d5939ac234d292854de5afeb786b6ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up a key in a hash list and returns the entry. <br /></td></tr>
<tr class="memitem:ab3625f19223436b718d9267f0b9a663a" id="r_ab3625f19223436b718d9267f0b9a663a"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#ab3625f19223436b718d9267f0b9a663a">ktxHashList_FindValue</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead, const char *key, unsigned int *pValueLen, void **ppValue)</td></tr>
<tr class="memdesc:ab3625f19223436b718d9267f0b9a663a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks up a key in a hash list and returns the value. <br /></td></tr>
<tr class="memitem:ad432c8d5ba733c69df496e7925e3a158" id="r_ad432c8d5ba733c69df496e7925e3a158"><td class="memItemLeft"><a class="el" href="classktxHashListEntry.html">ktxHashListEntry</a> *&#160;</td><td class="memItemRight"><a class="el" href="#ad432c8d5ba733c69df496e7925e3a158">ktxHashList_Next</a> (<a class="el" href="classktxHashListEntry.html">ktxHashListEntry</a> *entry)</td></tr>
<tr class="memdesc:ad432c8d5ba733c69df496e7925e3a158"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the next entry in a <a class="el" href="classktxHashList.html" title="Opaque handle to a ktxHashList.">ktxHashList</a>. <br /></td></tr>
<tr class="memitem:a97ca46f361614d6cdfb59a42643f9fc2" id="r_a97ca46f361614d6cdfb59a42643f9fc2"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a97ca46f361614d6cdfb59a42643f9fc2">ktxHashList_Serialize</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead, unsigned int *pKvdLen, unsigned char **ppKvd)</td></tr>
<tr class="memdesc:a97ca46f361614d6cdfb59a42643f9fc2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serialize a hash list to a block of data suitable for writing to a file. <br /></td></tr>
<tr class="memitem:aee36331d742259c1bb3f42e2c82e38ba" id="r_aee36331d742259c1bb3f42e2c82e38ba"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#aee36331d742259c1bb3f42e2c82e38ba">ktxHashList_Sort</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead)</td></tr>
<tr class="memdesc:aee36331d742259c1bb3f42e2c82e38ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sort a hash list in order of the UTF8 codepoints. <br /></td></tr>
<tr class="memitem:a3c05bb134c42ad852a4e68b6ebe057b1" id="r_a3c05bb134c42ad852a4e68b6ebe057b1"><td class="memItemLeft"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a>&#160;</td><td class="memItemRight"><a class="el" href="#a3c05bb134c42ad852a4e68b6ebe057b1">ktxHashList_Deserialize</a> (<a class="el" href="classktxHashList.html">ktxHashList</a> *pHead, unsigned int kvdLen, void *pKvd)</td></tr>
<tr class="memdesc:a3c05bb134c42ad852a4e68b6ebe057b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a hash list from a block of serialized key-value data read from a file. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Opaque handle to a <a class="el" href="classktxHashList.html" title="Opaque handle to a ktxHashList.">ktxHashList</a>. </p>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Member Function Documentation</h2>
<a id="ad013c9dd666f3b57e3b0a717e0186277" name="ad013c9dd666f3b57e3b0a717e0186277"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad013c9dd666f3b57e3b0a717e0186277">&#9670;&#160;</a></span>ktxHashList_AddKVPair()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_AddKVPair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>valueLen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>value</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a key value pair to a hash list. </p>
<p>The value can be empty, i.e, its length can be 0.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the head of the target hash list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>pointer to the UTF8 NUL-terminated string to be used as the key. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">valueLen</td><td>the number of bytes of data in <code class="param">value</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>pointer to the bytes of data constituting the value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>if <code class="param">pHead</code>, <code class="param">key</code> or <code class="param">value</code> are NULL, <code class="param">key</code> is an empty string or <code class="param">valueLen</code> == 0. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aaab69a1ef86c52707d0a33dcba316c60" name="aaab69a1ef86c52707d0a33dcba316c60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaab69a1ef86c52707d0a33dcba316c60">&#9670;&#160;</a></span>ktxHashList_Construct()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ktxHashList_Construct </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct an empty hash list for storing key-value pairs. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the location to write the list head. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a11f1a2ff9f574cd803803b77ec758966" name="a11f1a2ff9f574cd803803b77ec758966"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11f1a2ff9f574cd803803b77ec758966">&#9670;&#160;</a></span>ktxHashList_ConstructCopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ktxHashList_ConstructCopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a></td> <td class="paramname"><span class="paramname"><em>orig</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a hash list by copying another. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to head of the list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">orig</td><td>head of the original hash list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a13c991ecb452345d4ac2f9ca4ff71b80" name="a13c991ecb452345d4ac2f9ca4ff71b80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13c991ecb452345d4ac2f9ca4ff71b80">&#9670;&#160;</a></span>ktxHashList_Create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_Create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> **</td> <td class="paramname"><span class="paramname"><em>ppHl</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an empty hash list for storing key-value pairs. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppHl</td><td>address of a variable in which to set a pointer to the newly created hash list.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>if not enough memory. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a50f608b84f671b23849be13254cc511e" name="a50f608b84f671b23849be13254cc511e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50f608b84f671b23849be13254cc511e">&#9670;&#160;</a></span>ktxHashList_CreateCopy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_CreateCopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> **</td> <td class="paramname"><span class="paramname"><em>ppHl</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a></td> <td class="paramname"><span class="paramname"><em>orig</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a copy of a hash list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppHl</td><td>address of a variable in which to set a pointer to the newly created hash list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">orig</td><td>head of the <a class="el" href="classktxHashList.html" title="Opaque handle to a ktxHashList.">ktxHashList</a> to copy.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>if not enough memory. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a21e5f3318a192082258792f7f9d55400" name="a21e5f3318a192082258792f7f9d55400"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21e5f3318a192082258792f7f9d55400">&#9670;&#160;</a></span>ktxHashList_DeleteEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_DeleteEntry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classktxHashListEntry.html">ktxHashListEntry</a> *</td> <td class="paramname"><span class="paramname"><em>pEntry</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete an entry from a hash list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the head of the target hash list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pEntry</td><td>pointer to the <a class="el" href="classktxHashListEntry.html" title="Opaque handle to an entry in a ktxHashList.">ktxHashListEntry</a> to delete.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>if <code class="param">pHead</code> is NULL or <code class="param">key</code> is an empty string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a71475476ba962532003472278dbe33a3" name="a71475476ba962532003472278dbe33a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71475476ba962532003472278dbe33a3">&#9670;&#160;</a></span>ktxHashList_DeleteKVPair()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_DeleteKVPair </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>key</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a key value pair in a hash list. </p>
<p>Is a nop if the key is not in the hash.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the head of the target hash list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>pointer to the UTF8 NUL-terminated string to be used as the key.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>if <code class="param">pHead</code> is NULL or <code class="param">key</code> is an empty string. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3c05bb134c42ad852a4e68b6ebe057b1" name="a3c05bb134c42ad852a4e68b6ebe057b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c05bb134c42ad852a4e68b6ebe057b1">&#9670;&#160;</a></span>ktxHashList_Deserialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_Deserialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int</td> <td class="paramname"><span class="paramname"><em>kvdLen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>pKvd</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a hash list from a block of serialized key-value data read from a file. </p>
<dl class="section note"><dt>Note</dt><dd>The bytes of the 32-bit key-value lengths within the serialized data are expected to be in native endianness.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the head of the target hash list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">kvdLen</td><td>the length of the serialized key-value data. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pKvd</td><td>pointer to the serialized key-value data. table.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116caf20c350e21ca603f3ffb2bc46235369a">KTX_INVALID_OPERATION</a></td><td>if <code class="param">pHead</code> does not point to an empty list. </td></tr>
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>if <code class="param">pKvd</code> or <code class="param">pHt</code> is NULL or kvdLen == 0. </td></tr>
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>there was not enough memory to create the hash table. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa84d4269b0efd2fb9fb2508a371fa0ca" name="aa84d4269b0efd2fb9fb2508a371fa0ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa84d4269b0efd2fb9fb2508a371fa0ca">&#9670;&#160;</a></span>ktxHashList_Destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ktxHashList_Destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a hash list. </p>
<p>All memory associated with the hash list's keys and values is freed. The hash list is also freed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the hash list to be destroyed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0e3349a7b71be7aaa4f8766fc8a0d437" name="a0e3349a7b71be7aaa4f8766fc8a0d437"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e3349a7b71be7aaa4f8766fc8a0d437">&#9670;&#160;</a></span>ktxHashList_Destruct()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ktxHashList_Destruct </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destruct a hash list. </p>
<p>All memory associated with the hash list's keys and values is freed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the hash list to be destroyed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2d5939ac234d292854de5afeb786b6ae" name="a2d5939ac234d292854de5afeb786b6ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d5939ac234d292854de5afeb786b6ae">&#9670;&#160;</a></span>ktxHashList_FindEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_FindEntry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classktxHashListEntry.html">ktxHashListEntry</a> **</td> <td class="paramname"><span class="paramname"><em>ppEntry</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks up a key in a hash list and returns the entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the head of the target hash list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>pointer to a UTF8 NUL-terminated string to find. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppEntry</td><td><code class="param">*ppEntry</code> is set to the point at the <a class="el" href="classktxHashListEntry.html" title="Opaque handle to an entry in a ktxHashList.">ktxHashListEntry</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>if <code class="param">This</code>, <code class="param">key</code> or <code class="param">pValueLen</code> or <code class="param">ppValue</code> is NULL. </td></tr>
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116cac9008e8d20f60f4fb67d735f287be470">KTX_NOT_FOUND</a></td><td>an entry matching <code class="param">key</code> was not found. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab3625f19223436b718d9267f0b9a663a" name="ab3625f19223436b718d9267f0b9a663a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3625f19223436b718d9267f0b9a663a">&#9670;&#160;</a></span>ktxHashList_FindValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_FindValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int *</td> <td class="paramname"><span class="paramname"><em>pValueLen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>ppValue</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Looks up a key in a hash list and returns the value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the head of the target hash list. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>pointer to a UTF8 NUL-terminated string to find. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">pValueLen</td><td><code class="param">*pValueLen</code> is set to the number of bytes of data in the returned value. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppValue</td><td><code class="param">*ppValue</code> is set to the point to the value for <code class="param">key</code>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>if <code class="param">This</code>, <code class="param">key</code> or <code class="param">pValueLen</code> or <code class="param">ppValue</code> is NULL. </td></tr>
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116cac9008e8d20f60f4fb67d735f287be470">KTX_NOT_FOUND</a></td><td>an entry matching <code class="param">key</code> was not found. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad432c8d5ba733c69df496e7925e3a158" name="ad432c8d5ba733c69df496e7925e3a158"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad432c8d5ba733c69df496e7925e3a158">&#9670;&#160;</a></span>ktxHashList_Next()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classktxHashListEntry.html">ktxHashListEntry</a> * ktxHashList_Next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashListEntry.html">ktxHashListEntry</a> *</td> <td class="paramname"><span class="paramname"><em>entry</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the next entry in a <a class="el" href="classktxHashList.html" title="Opaque handle to a ktxHashList.">ktxHashList</a>. </p>
<p>Use for iterating through the list: </p><div class="fragment"><div class="line"><a class="code hl_class" href="classktxHashListEntry.html">ktxHashListEntry</a>* entry;</div>
<div class="line"><span class="keywordflow">for</span> (entry = listHead; entry != NULL; entry = <a class="code hl_function" href="#ad432c8d5ba733c69df496e7925e3a158">ktxHashList_Next</a>(entry)) {</div>
<div class="line"> ...</div>
<div class="line">};</div>
<div class="ttc" id="aclassktxHashListEntry_html"><div class="ttname"><a href="classktxHashListEntry.html">ktxHashListEntry</a></div><div class="ttdoc">Opaque handle to an entry in a ktxHashList.</div></div>
<div class="ttc" id="aclassktxHashList_html_ad432c8d5ba733c69df496e7925e3a158"><div class="ttname"><a href="#ad432c8d5ba733c69df496e7925e3a158">ktxHashList::ktxHashList_Next</a></div><div class="ttdeci">ktxHashListEntry * ktxHashList_Next(ktxHashListEntry *entry)</div><div class="ttdoc">Returns the next entry in a ktxHashList.</div><div class="ttdef"><b>Definition</b> hashlist.c:381</div></div>
</div><!-- fragment --><p>Note</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">entry</td><td>pointer to a hash list entry. Note that a ktxHashList*, i.e. the list head, is also a pointer to an entry so can be passed to this function.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the next entry or NULL. </dd></dl>
</div>
</div>
<a id="a97ca46f361614d6cdfb59a42643f9fc2" name="a97ca46f361614d6cdfb59a42643f9fc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97ca46f361614d6cdfb59a42643f9fc2">&#9670;&#160;</a></span>ktxHashList_Serialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_Serialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int *</td> <td class="paramname"><span class="paramname"><em>pKvdLen</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char **</td> <td class="paramname"><span class="paramname"><em>ppKvd</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Serialize a hash list to a block of data suitable for writing to a file. </p>
<p>The caller is responsible for freeing the data block returned by this function.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the head of the target hash list. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">pKvdLen</td><td><code class="param">*pKvdLen</code> is set to the number of bytes of data in the returned data block. </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">ppKvd</td><td><code class="param">*ppKvd</code> is set to the point to the block of memory containing the serialized data or NULL. if the hash list is empty.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>if <code class="param">This</code>, <code class="param">pKvdLen</code> or <code class="param">ppKvd</code> is NULL. </td></tr>
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca87728a1745ea6333b6fbe041c03036f2">KTX_OUT_OF_MEMORY</a></td><td>there was not enough memory to serialize the data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aee36331d742259c1bb3f42e2c82e38ba" name="aee36331d742259c1bb3f42e2c82e38ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee36331d742259c1bb3f42e2c82e38ba">&#9670;&#160;</a></span>ktxHashList_Sort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="ktx_8h.html#ad2efa40e38ebae48371375db92d34eaa">KTX_error_code</a> ktxHashList_Sort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classktxHashList.html">ktxHashList</a> *</td> <td class="paramname"><span class="paramname"><em>pHead</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sort a hash list in order of the UTF8 codepoints. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pHead</td><td>pointer to the head of the target hash list.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>KTX_SUCCESS or one of the following error codes.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="ktx_8h.html#a7780d97ec4de6aa30c4726fb71e3116ca7da41bb3195d6cc93a513ac18bc91e4f">KTX_INVALID_VALUE</a></td><td>if <code class="param">This</code> is NULL. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="classktxHashList.html">ktxHashList</a></li>
<li class="footer">Generated on <span class="timestamp"></span> for libktx Reference by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink