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.
116 lines
5.8 KiB
XML
116 lines
5.8 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="_md_docs_2hash_2hash_remove" xml:lang="en-US">
|
|
<title>hashRemove</title>
|
|
<indexterm><primary>hashRemove</primary></indexterm>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md260">
|
|
<title>autotoc_md260</title>
|
|
<para>title: ArmaRAMDb - Hash Remove icon: mdi:file-text-outline </para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md261">
|
|
<title>excerpt: Remove a field from the current client's hash table.</title></section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md262">
|
|
<title>ramdb_db_fnc_hashRemove</title><section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md263">
|
|
<title>Description</title>
|
|
<para>Removes a specific field from the hash table associated with the current client/player. This function automatically determines the appropriate hash ID based on the caller's identity, making it more convenient than <computeroutput>hashRemoveId</computeroutput> which requires manually specifying an ID. It deletes a single field and its associated value without affecting other fields in the client's hash table.</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md264">
|
|
<title>Syntax</title>
|
|
<para><literallayout><computeroutput>[_keyField] call ramdb_db_fnc_hashRemove
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md265">
|
|
<title>Parameters</title>
|
|
<para><informaltable frame="all">
|
|
<tgroup cols="4" align="left" colsep="1" rowsep="1">
|
|
<colspec colname='c1'/>
|
|
<colspec colname='c2'/>
|
|
<colspec colname='c3'/>
|
|
<colspec colname='c4'/>
|
|
<thead>
|
|
<row class='markdownTableHead'>
|
|
<entry>
|
|
<para>Parameter </para>
|
|
</entry><entry>
|
|
<para>Type </para>
|
|
</entry><entry>
|
|
<para>Description </para>
|
|
</entry><entry>
|
|
<para>Default </para>
|
|
</entry></row>
|
|
</thead><tbody>
|
|
<row class='markdownTableRowOdd'>
|
|
<entry>
|
|
<para><computeroutput>_keyField</computeroutput> </para>
|
|
</entry><entry>
|
|
<para>String </para>
|
|
</entry><entry>
|
|
<para>Name of the field to be removed </para>
|
|
</entry><entry>
|
|
<para>"" </para>
|
|
</entry></row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md266">
|
|
<title>Return Value</title>
|
|
<para>None. The operation runs synchronously to remove the field.</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md267">
|
|
<title>Examples</title><section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md268">
|
|
<title>Remove a specific field:</title>
|
|
<para><literallayout><computeroutput>["loadout"] call ramdb_db_fnc_hashRemove;
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md269">
|
|
<title>Remove a field remotely:</title>
|
|
<para><literallayout><computeroutput>["playerSettings"] remoteExecCall ["ramdb_db_fnc_hashRemove", 2, false];
|
|
</computeroutput></literallayout></para>
|
|
</section>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md270">
|
|
<title>Notes</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para>Only removes a single field from the current client's hash table</para>
|
|
</listitem><listitem>
|
|
<para>Validates that the key field parameter is not empty before proceeding</para>
|
|
</listitem><listitem>
|
|
<para>Does not affect other fields in the hash table</para>
|
|
</listitem><listitem>
|
|
<para>If the field doesn't exist, the operation has no effect</para>
|
|
</listitem><listitem>
|
|
<para>This function automatically determines which hash table to use based on the caller's identity</para>
|
|
</listitem><listitem>
|
|
<para>Use <computeroutput>hashRemoveId</computeroutput> when you need to specify a particular hash table by ID</para>
|
|
</listitem><listitem>
|
|
<para>The operation is executed immediately and synchronously</para>
|
|
</listitem><listitem>
|
|
<para>All operations are logged for debugging purposes</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md271">
|
|
<title>Related Functions</title>
|
|
<para><itemizedlist>
|
|
<listitem>
|
|
<para><computeroutput>ramdb_db_fnc_hashRemoveId</computeroutput>: Removes a specific field from a specific hash table (when you need to specify the ID)</para>
|
|
</listitem><listitem>
|
|
<para><computeroutput>ramdb_db_fnc_hashDelete</computeroutput>: Removes the current client's hash table</para>
|
|
</listitem><listitem>
|
|
<para><computeroutput>ramdb_db_fnc_hashDeleteId</computeroutput>: Removes a specific hash table</para>
|
|
</listitem><listitem>
|
|
<para><computeroutput>ramdb_db_fnc_hashSet</computeroutput>: Sets a field value in the current client's hash table</para>
|
|
</listitem><listitem>
|
|
<para><computeroutput>ramdb_db_fnc_hashGet</computeroutput>: Retrieves a field value from the current client's hash table</para>
|
|
</listitem></itemizedlist>
|
|
</para>
|
|
</section>
|
|
<section xml:id="_md_docs_2hash_2hash_remove_1autotoc_md272">
|
|
<title>Links</title>
|
|
<para><link linkend="_md_docs_2hash_2hash_delete">Hash Delete</link> | <link linkend="_md_docs_2hash_2hash_delete_id">Hash Delete ID</link> | <link linkend="_md_docs_2hash_2hash_get">Hash Get</link> | <link linkend="_md_docs_2hash_2hash_get_all">Hash Get All</link> | <link linkend="_md_docs_2hash_2hash_get_all_id">Hash Get All ID</link> | <link linkend="_md_docs_2hash_2hash_get_id">Hash Get ID</link> | <link linkend="_md_docs_2hash_2hash_remove">Hash Remove</link> | <link linkend="_md_docs_2hash_2hash_remove_id">Hash Remove ID</link> | <link linkend="_md_docs_2hash_2hash_set">Hash Set</link> | <link linkend="_md_docs_2hash_2hash_set_bulk">Hash Set Bulk</link> | <link linkend="_md_docs_2hash_2hash_set_id">Hash Set ID</link> | <link linkend="_md_docs_2hash_2hash_set_id_bulk">Hash Set ID Bulk</link> </para>
|
|
</section>
|
|
</section>
|
|
</section>
|