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.
53 lines
4.2 KiB
TeX
53 lines
4.2 KiB
TeX
\chapter{delete}
|
|
\hypertarget{md_docs_2basic_2delete}{}\label{md_docs_2basic_2delete}\index{delete@{delete}}
|
|
\hypertarget{md_docs_2basic_2delete_autotoc_md0}{}\doxysubsection{\texorpdfstring{autotoc\+\_\+md0}{autotoc\+\_\+md0}}\label{md_docs_2basic_2delete_autotoc_md0}
|
|
title\+: Arma\+RAMDb -\/ Delete Key icon\+: mdi\+:file-\/text-\/outline \hypertarget{md_docs_2basic_2delete_autotoc_md1}{}\doxysubsection{\texorpdfstring{excerpt\+: Remove the specified key from RAMDb.}{excerpt\+: Remove the specified key from RAMDb.}}\label{md_docs_2basic_2delete_autotoc_md1}
|
|
\hypertarget{md_docs_2basic_2delete_autotoc_md2}{}\doxysection{\texorpdfstring{ramdb\+\_\+db\+\_\+fnc\+\_\+delete}{ramdb\+\_\+db\+\_\+fnc\+\_\+delete}}\label{md_docs_2basic_2delete_autotoc_md2}
|
|
\hypertarget{md_docs_2basic_2delete_autotoc_md3}{}\doxysubsection{\texorpdfstring{Description}{Description}}\label{md_docs_2basic_2delete_autotoc_md3}
|
|
Removes the specified key from the database. This function deletes the key-\/value pair completely from storage.\hypertarget{md_docs_2basic_2delete_autotoc_md4}{}\doxysubsection{\texorpdfstring{Syntax}{Syntax}}\label{md_docs_2basic_2delete_autotoc_md4}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{[\_key]\ call\ ramdb\_db\_fnc\_delete}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2basic_2delete_autotoc_md5}{}\doxysubsection{\texorpdfstring{Parameters}{Parameters}}\label{md_docs_2basic_2delete_autotoc_md5}
|
|
\tabulinesep=1mm
|
|
\begin{longtabu}spread 0pt [c]{*{3}{|X[-1]}|}
|
|
\hline
|
|
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Parameter }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Type }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Description }\\\cline{1-3}
|
|
\endfirsthead
|
|
\hline
|
|
\endfoot
|
|
\hline
|
|
\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Parameter }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Type }&\PBS\centering \cellcolor{\tableheadbgcolor}\textbf{ Description }\\\cline{1-3}
|
|
\endhead
|
|
{\ttfamily \+\_\+key} &String &Name of the key to delete from the database \\\cline{1-3}
|
|
\end{longtabu}
|
|
\hypertarget{md_docs_2basic_2delete_autotoc_md6}{}\doxysubsection{\texorpdfstring{Return Value}{Return Value}}\label{md_docs_2basic_2delete_autotoc_md6}
|
|
None. The operation runs asynchronously.\hypertarget{md_docs_2basic_2delete_autotoc_md7}{}\doxysubsection{\texorpdfstring{Examples}{Examples}}\label{md_docs_2basic_2delete_autotoc_md7}
|
|
\hypertarget{md_docs_2basic_2delete_autotoc_md8}{}\doxysubsubsection{\texorpdfstring{Delete a key in singleplayer or on the server\+:}{Delete a key in singleplayer or on the server\+:}}\label{md_docs_2basic_2delete_autotoc_md8}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{["{}playerData"{}]\ call\ ramdb\_db\_fnc\_delete;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2basic_2delete_autotoc_md9}{}\doxysubsubsection{\texorpdfstring{Delete a key on the server from a client\+:}{Delete a key on the server from a client\+:}}\label{md_docs_2basic_2delete_autotoc_md9}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{["{}playerData"{}]\ remoteExecCall\ ["{}ramdb\_db\_fnc\_delete"{},\ 2,\ false];}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{md_docs_2basic_2delete_autotoc_md10}{}\doxysubsection{\texorpdfstring{Notes}{Notes}}\label{md_docs_2basic_2delete_autotoc_md10}
|
|
|
|
\begin{DoxyItemize}
|
|
\item This operation is permanent and cannot be undone
|
|
\item If the key doesn\textquotesingle{}t exist, the operation will have no effect
|
|
\item This function only affects specific keys, not hash tables or lists
|
|
\end{DoxyItemize}\hypertarget{md_docs_2basic_2delete_autotoc_md11}{}\doxysubsection{\texorpdfstring{Related Functions}{Related Functions}}\label{md_docs_2basic_2delete_autotoc_md11}
|
|
|
|
\begin{DoxyItemize}
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+get}\+: Retrieves a value by key
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+set}\+: Stores a value by key
|
|
\item {\ttfamily ramdb\+\_\+db\+\_\+fnc\+\_\+scheduler}\+: Processes the callback response
|
|
\end{DoxyItemize}\hypertarget{md_docs_2basic_2delete_autotoc_md12}{}\doxysubsection{\texorpdfstring{Links}{Links}}\label{md_docs_2basic_2delete_autotoc_md12}
|
|
\doxysectlink{md_docs_2basic_2delete}{Delete Key}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2basic_2get}{Get Key}{0} \texorpdfstring{$\vert$}{|} \doxysectlink{md_docs_2basic_2set}{Set Key}{0} |