IDSolutions/ramdb
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 19 Wiki Activity
ramdb/api/html/d7/d91/md_docs_2hash_2hash_delete.html
Jacob Schmidt ee1dd91b7f
All checks were successful
Build / Build (push) Successful in 40s
Details
feat: Add documentation for fetch function 
This commit adds documentation for the `ramdb_db_fnc_fetch` function. The documentation explains the function's purpose, which is to handle data chunks received from the database extension when data is too large to be returned in a single callback. The documentation includes a title, icon, and excerpt for better readability and understanding.
2025-03-30 17:16:31 -05:00

167 lines
8.5 KiB
HTML
Raw Permalink 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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ArmaRAMDb: hashDelete</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="../../resize.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</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="projectalign">
<div id="projectname">ArmaRAMDb
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
</script>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d7/d91/md_docs_2hash_2hash_delete.html','../../'); initResizable(true); });
/* @license-end */
</script>
<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><div class="header">
<div class="headertitle"><div class="title">hashDelete</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h2><a class="anchor" id="autotoc_md177"></a>
autotoc_md177</h2>
<p>title: ArmaRAMDb - Hash Delete icon: mdi:file-text-outline </p>
<h2><a class="anchor" id="autotoc_md178"></a>
excerpt: Remove the current client's hash table from database.</h2>
<h1><a class="anchor" id="autotoc_md179"></a>
ramdb_db_fnc_hashDelete</h1>
<h2><a class="anchor" id="autotoc_md180"></a>
Description</h2>
<p>Removes the hash table associated with the current client/player from the database. Unlike <code>hashDeleteId</code>, this function automatically retrieves the appropriate hash ID based on the caller's identity, making it more convenient for removing the current client's hash data. This is useful for cleanup operations when a player disconnects or when resetting a client's stored data.</p>
<h2><a class="anchor" id="autotoc_md181"></a>
Syntax</h2>
<div class="fragment"><div class="line">[] call ramdb_db_fnc_hashDelete</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md182"></a>
Parameters</h2>
<p>None. This function automatically determines the hash ID based on the calling client.</p>
<h2><a class="anchor" id="autotoc_md183"></a>
Return Value</h2>
<p>None. The operation runs synchronously to delete the hash table for the current client.</p>
<h2><a class="anchor" id="autotoc_md184"></a>
Examples</h2>
<h3><a class="anchor" id="autotoc_md185"></a>
Delete the current client's hash table:</h3>
<div class="fragment"><div class="line">[] call ramdb_db_fnc_hashDelete;</div>
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md186"></a>
Delete a client's hash table from the server:</h3>
<div class="fragment"><div class="line">[] remoteExecCall [&quot;ramdb_db_fnc_hashDelete&quot;, 2, false];</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md187"></a>
Notes</h2>
<ul>
<li>This function only removes the hash table for the current client/player, not all hash tables</li>
<li>It's similar to <code>hashDeleteId</code> but automatically determines the appropriate ID</li>
<li>Cannot be undone unless you have a backup</li>
<li>Should be used during player disconnection or when resetting a player's data</li>
<li>Useful for cleanup operations to prevent data buildup from disconnected players</li>
<li>More convenient than <code>hashDeleteId</code> when you want to remove the calling client's data</li>
<li>All operations are logged for debugging purposes</li>
</ul>
<h2><a class="anchor" id="autotoc_md188"></a>
Related Functions</h2>
<ul>
<li><code>ramdb_db_fnc_hashDeleteId</code>: Removes a specific hash ID (when you need to specify the ID)</li>
<li><code>ramdb_db_fnc_hashSet</code>: Sets a value in the hash table</li>
<li><code>ramdb_db_fnc_hashGet</code>: Retrieves a value from the hash table</li>
</ul>
<h2><a class="anchor" id="autotoc_md189"></a>
Links</h2>
<p><a class="el" href="../../d7/d91/md_docs_2hash_2hash_delete.html">Hash Delete</a> | <a class="el" href="../../dc/d95/md_docs_2hash_2hash_delete_id.html">Hash Delete ID</a> | <a class="el" href="../../dc/dae/md_docs_2hash_2hash_get.html">Hash Get</a> | <a class="el" href="../../d8/d96/md_docs_2hash_2hash_get_all.html">Hash Get All</a> | <a class="el" href="../../d3/d33/md_docs_2hash_2hash_get_all_id.html">Hash Get All ID</a> | <a class="el" href="../../d5/d27/md_docs_2hash_2hash_get_id.html">Hash Get ID</a> | <a class="el" href="../../d9/d12/md_docs_2hash_2hash_remove.html">Hash Remove</a> | <a class="el" href="../../d9/dae/md_docs_2hash_2hash_remove_id.html">Hash Remove ID</a> | <a class="el" href="../../d0/d68/md_docs_2hash_2hash_set.html">Hash Set</a> | <a class="el" href="../../d9/dc1/md_docs_2hash_2hash_set_bulk.html">Hash Set Bulk</a> | <a class="el" href="../../dc/db9/md_docs_2hash_2hash_set_id.html">Hash Set ID</a> | <a class="el" href="../../d2/d02/md_docs_2hash_2hash_set_id_bulk.html">Hash Set ID Bulk</a> </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink