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.
62 lines
2.6 KiB
XML
62 lines
2.6 KiB
XML
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
|
|
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_dir_abd30d11711bae4cb17b258a1e3909ca" xml:lang="en-US">
|
|
<title>docs/list Directory Reference</title>
|
|
<indexterm><primary>docs/list Directory Reference</primary></indexterm>
|
|
<section>
|
|
<title>Detailed Description</title>
|
|
|
|
<para>This section contains documentation for the list operations of ArmaRAMDb that allow for working with ordered collections of items.</para>
|
|
<section xml:id="_README.md_1autotoc_md420">
|
|
<title>Available Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><link linkend="_md_docs_2list_2list_add">listAdd</link> - Add an item to a list</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2list_2list_delete">listDelete</link> - Delete a list</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2list_2list_get">listGet</link> - Get items from a list</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2list_2list_load">listLoad</link> - Load a list from the database</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2list_2list_remove">listRemove</link> - Remove an item from a list</para>
|
|
</listitem><listitem>
|
|
<para><link linkend="_md_docs_2list_2list_set">listSet</link> - Set an item in a list</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md421">
|
|
<title>Example Usage</title>
|
|
<para><literallayout><computeroutput>// Add an item to a list
|
|
["myList", ["myItem"]] call ramdb_db_fnc_listAdd;
|
|
|
|
// Set an item at a specific index
|
|
["myList", 0, [myNewValue]] call ramdb_db_fnc_listSet;
|
|
|
|
// Get an item at a specific index
|
|
["myList", 0, "myFunction"] call ramdb_db_fnc_listGet;
|
|
|
|
// Load all items from a list
|
|
["myList", "myFunction"] call ramdb_db_fnc_listLoad;
|
|
|
|
// Remove an item at a specific index
|
|
["myList", 0] call ramdb_db_fnc_listRemove;
|
|
|
|
// Delete the entire list
|
|
["myList"] call ramdb_db_fnc_listDelete;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_README.md_1autotoc_md422">
|
|
<title>Related Categories</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>Core Functions</para>
|
|
</listitem><listitem>
|
|
<para>Basic Data Operations</para>
|
|
</listitem><listitem>
|
|
<para>Hash Operations </para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
</section>
|
|
</section>
|