ee1dd91b7f
All checks were successful
Build / Build (push) Successful in 40s
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.
163 lines
6.9 KiB
HTML
163 lines
6.9 KiB
HTML
<!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: load</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&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()"> </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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('da/d36/md_docs_2basic_2load.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">load</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><h2><a class="anchor" id="autotoc_md36"></a>
|
|
autotoc_md36</h2>
|
|
<p>title: ArmaRAMDb - Load DB icon: mdi:file-text-outline </p>
|
|
<h2><a class="anchor" id="autotoc_md37"></a>
|
|
excerpt: Load DB from disc.</h2>
|
|
<h1><a class="anchor" id="autotoc_md38"></a>
|
|
ramdb_db_fnc_load</h1>
|
|
<h2><a class="anchor" id="autotoc_md39"></a>
|
|
Description</h2>
|
|
<p>Loads the database from disk storage. This function restores all data (key-value pairs, hash tables, and lists) from the previously saved database file.</p>
|
|
<h2><a class="anchor" id="autotoc_md40"></a>
|
|
Syntax</h2>
|
|
<div class="fragment"><div class="line">[] call ramdb_db_fnc_load</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md41"></a>
|
|
Parameters</h2>
|
|
<p>None. This function does not require any parameters.</p>
|
|
<h2><a class="anchor" id="autotoc_md42"></a>
|
|
Return Value</h2>
|
|
<p>None. The operation runs synchronously and loads the database immediately.</p>
|
|
<h2><a class="anchor" id="autotoc_md43"></a>
|
|
Examples</h2>
|
|
<h3><a class="anchor" id="autotoc_md44"></a>
|
|
Load the database on the server:</h3>
|
|
<div class="fragment"><div class="line">[] call ramdb_db_fnc_load;</div>
|
|
</div><!-- fragment --><h3><a class="anchor" id="autotoc_md45"></a>
|
|
Call the load function remotely from a client:</h3>
|
|
<div class="fragment"><div class="line">[] remoteExecCall ["ramdb_db_fnc_load", 2, false];</div>
|
|
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md46"></a>
|
|
Notes</h2>
|
|
<ul>
|
|
<li>This function should typically be called during server initialization</li>
|
|
<li>Any existing data in memory will be overwritten with the data from disk</li>
|
|
<li>If no database file exists, nothing will happen</li>
|
|
<li>Loading does not affect ongoing operations, but might replace values in memory</li>
|
|
<li>For safety, it's recommended to call this function only when necessary</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md47"></a>
|
|
Related Functions</h2>
|
|
<ul>
|
|
<li><code>ramdb_db_fnc_save</code>: Saves the database to disk</li>
|
|
</ul>
|
|
<h2><a class="anchor" id="autotoc_md48"></a>
|
|
Links</h2>
|
|
<p><a class="el" href="../../d8/d12/md_docs_2basic_2save.html">Save DB</a> | <a class="el" href="../../da/d36/md_docs_2basic_2load.html">Load DB</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>
|