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.
37 lines
1.9 KiB
TeX
37 lines
1.9 KiB
TeX
\doxysection{docs/basic Directory Reference}
|
|
\hypertarget{dir_2d423acf5473bc48906ca316d2995d8f}{}\label{dir_2d423acf5473bc48906ca316d2995d8f}\index{docs/basic Directory Reference@{docs/basic Directory Reference}}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This section contains documentation for the basic data operations of Arma\+RAMDb that allow for simple key-\/value storage and retrieval.\hypertarget{README.md_autotoc_md50}{}\doxysubsection{\texorpdfstring{Available Functions}{Available Functions}}\label{README.md_autotoc_md50}
|
|
|
|
\begin{DoxyItemize}
|
|
\item \doxysectlink{md_docs_2basic_2delete}{delete}{0} -\/ Delete a value from the database
|
|
\item \doxysectlink{md_docs_2basic_2fetch}{fetch}{0} -\/ Fetch a value from the database
|
|
\item \doxysectlink{md_docs_2basic_2get}{get}{0} -\/ Get a value from the database
|
|
\item \doxysectlink{md_docs_2basic_2load}{load}{0} -\/ Load the database from disk
|
|
\item \doxysectlink{md_docs_2basic_2save}{save}{0} -\/ Save the database to disk
|
|
\item \doxysectlink{md_docs_2basic_2set}{set}{0} -\/ Set a value in the database
|
|
\end{DoxyItemize}\hypertarget{README.md_autotoc_md51}{}\doxysubsection{\texorpdfstring{Example Usage}{Example Usage}}\label{README.md_autotoc_md51}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{//\ Set\ a\ value}
|
|
\DoxyCodeLine{["{}myKey"{},\ [myValue]]\ call\ ramdb\_db\_fnc\_set;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Get\ a\ value}
|
|
\DoxyCodeLine{["{}myKey"{},\ "{}myFunction"{}]\ call\ ramdb\_db\_fnc\_get;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Delete\ a\ key}
|
|
\DoxyCodeLine{["{}myKey"{}]\ call\ ramdb\_db\_fnc\_delete;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Save\ database\ to\ disk}
|
|
\DoxyCodeLine{[]\ call\ ramdb\_db\_fnc\_save;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{README.md_autotoc_md52}{}\doxysubsection{\texorpdfstring{Related Categories}{Related Categories}}\label{README.md_autotoc_md52}
|
|
|
|
\begin{DoxyItemize}
|
|
\item Core Functions
|
|
\item Hash Operations
|
|
\item List Operations
|
|
\end{DoxyItemize} |