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.
43 lines
2.3 KiB
TeX
43 lines
2.3 KiB
TeX
\doxysection{docs/list Directory Reference}
|
|
\hypertarget{dir_abd30d11711bae4cb17b258a1e3909ca}{}\label{dir_abd30d11711bae4cb17b258a1e3909ca}\index{docs/list Directory Reference@{docs/list Directory Reference}}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This section contains documentation for the list operations of Arma\+RAMDb that allow for working with ordered collections of items.\hypertarget{README.md_autotoc_md420}{}\doxysubsection{\texorpdfstring{Available Functions}{Available Functions}}\label{README.md_autotoc_md420}
|
|
|
|
\begin{DoxyItemize}
|
|
\item \doxysectlink{md_docs_2list_2list_add}{list\+Add}{0} -\/ Add an item to a list
|
|
\item \doxysectlink{md_docs_2list_2list_delete}{list\+Delete}{0} -\/ Delete a list
|
|
\item \doxysectlink{md_docs_2list_2list_get}{list\+Get}{0} -\/ Get items from a list
|
|
\item \doxysectlink{md_docs_2list_2list_load}{list\+Load}{0} -\/ Load a list from the database
|
|
\item \doxysectlink{md_docs_2list_2list_remove}{list\+Remove}{0} -\/ Remove an item from a list
|
|
\item \doxysectlink{md_docs_2list_2list_set}{list\+Set}{0} -\/ Set an item in a list
|
|
\end{DoxyItemize}\hypertarget{README.md_autotoc_md421}{}\doxysubsection{\texorpdfstring{Example Usage}{Example Usage}}\label{README.md_autotoc_md421}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{//\ Add\ an\ item\ to\ a\ list}
|
|
\DoxyCodeLine{["{}myList"{},\ ["{}myItem"{}]]\ call\ ramdb\_db\_fnc\_listAdd;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Set\ an\ item\ at\ a\ specific\ index}
|
|
\DoxyCodeLine{["{}myList"{},\ 0,\ [myNewValue]]\ call\ ramdb\_db\_fnc\_listSet;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Get\ an\ item\ at\ a\ specific\ index}
|
|
\DoxyCodeLine{["{}myList"{},\ 0,\ "{}myFunction"{}]\ call\ ramdb\_db\_fnc\_listGet;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Load\ all\ items\ from\ a\ list}
|
|
\DoxyCodeLine{["{}myList"{},\ "{}myFunction"{}]\ call\ ramdb\_db\_fnc\_listLoad;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Remove\ an\ item\ at\ a\ specific\ index}
|
|
\DoxyCodeLine{["{}myList"{},\ 0]\ call\ ramdb\_db\_fnc\_listRemove;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Delete\ the\ entire\ list}
|
|
\DoxyCodeLine{["{}myList"{}]\ call\ ramdb\_db\_fnc\_listDelete;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{README.md_autotoc_md422}{}\doxysubsection{\texorpdfstring{Related Categories}{Related Categories}}\label{README.md_autotoc_md422}
|
|
|
|
\begin{DoxyItemize}
|
|
\item Core Functions
|
|
\item Basic Data Operations
|
|
\item Hash Operations
|
|
\end{DoxyItemize} |