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.
52 lines
3.4 KiB
TeX
52 lines
3.4 KiB
TeX
\doxysection{docs/hash Directory Reference}
|
|
\hypertarget{dir_68588e5a097ce704ed28814d68b1b590}{}\label{dir_68588e5a097ce704ed28814d68b1b590}\index{docs/hash Directory Reference@{docs/hash Directory Reference}}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
This section contains documentation for the hash operations of Arma\+RAMDb that allow for working with hash tables (key-\/value pairs within a namespace).\hypertarget{README.md_autotoc_md344}{}\doxysubsection{\texorpdfstring{Available Functions}{Available Functions}}\label{README.md_autotoc_md344}
|
|
|
|
\begin{DoxyItemize}
|
|
\item \doxysectlink{md_docs_2hash_2hash_delete}{hash\+Delete}{0} -\/ Delete a hash
|
|
\item \doxysectlink{md_docs_2hash_2hash_delete_id}{hash\+Delete\+Id}{0} -\/ Delete a hash for a specific ID
|
|
\item \doxysectlink{md_docs_2hash_2hash_get}{hash\+Get}{0} -\/ Get a field from a hash
|
|
\item \doxysectlink{md_docs_2hash_2hash_get_all}{hash\+Get\+All}{0} -\/ Get all fields from a hash
|
|
\item \doxysectlink{md_docs_2hash_2hash_get_all_id}{hash\+Get\+All\+Id}{0} -\/ Get all fields from a hash for a specific ID
|
|
\item \doxysectlink{md_docs_2hash_2hash_get_id}{hash\+Get\+Id}{0} -\/ Get a field from a hash for a specific ID
|
|
\item \doxysectlink{md_docs_2hash_2hash_remove}{hash\+Remove}{0} -\/ Remove a field from a hash
|
|
\item \doxysectlink{md_docs_2hash_2hash_remove_id}{hash\+Remove\+Id}{0} -\/ Remove a field from a hash for a specific ID
|
|
\item \doxysectlink{md_docs_2hash_2hash_set}{hash\+Set}{0} -\/ Set a field in a hash
|
|
\item \doxysectlink{md_docs_2hash_2hash_set_bulk}{hash\+Set\+Bulk}{0} -\/ Set multiple fields in a hash in one operation
|
|
\item \doxysectlink{md_docs_2hash_2hash_set_id}{hash\+Set\+Id}{0} -\/ Set a field in a hash for a specific ID
|
|
\item \doxysectlink{md_docs_2hash_2hash_set_id_bulk}{hash\+Set\+Id\+Bulk}{0} -\/ Set multiple fields in a hash for a specific ID in one operation
|
|
\end{DoxyItemize}\hypertarget{README.md_autotoc_md345}{}\doxysubsection{\texorpdfstring{Example Usage}{Example Usage}}\label{README.md_autotoc_md345}
|
|
|
|
\begin{DoxyCode}{0}
|
|
\DoxyCodeLine{//\ Context\ mode\ examples}
|
|
\DoxyCodeLine{["{}myField"{},\ [myValue]]\ call\ ramdb\_db\_fnc\_hashSet;}
|
|
\DoxyCodeLine{["{}myField"{},\ "{}myFunction"{}]\ call\ ramdb\_db\_fnc\_hashGet;}
|
|
\DoxyCodeLine{["{}myFunction"{}]\ call\ ramdb\_db\_fnc\_hashGetAll;}
|
|
\DoxyCodeLine{["{}myField"{}]\ call\ ramdb\_db\_fnc\_hashRemove;}
|
|
\DoxyCodeLine{[]\ call\ ramdb\_db\_fnc\_hashDelete;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ Set\ multiple\ hash\ fields\ in\ one\ operation}
|
|
\DoxyCodeLine{[[}
|
|
\DoxyCodeLine{\ \ \ \ "{}loadout"{},\ [getUnitLoadout\ player],}
|
|
\DoxyCodeLine{\ \ \ \ "{}position"{},\ [getPosASL\ player],}
|
|
\DoxyCodeLine{\ \ \ \ "{}direction"{},\ [getDir\ player]}
|
|
\DoxyCodeLine{]]\ call\ ramdb\_db\_fnc\_hashSetBulk;}
|
|
\DoxyCodeLine{}
|
|
\DoxyCodeLine{//\ ID-\/specific\ examples}
|
|
\DoxyCodeLine{["{}myHash"{},\ "{}myField"{},\ [myValue]]\ call\ ramdb\_db\_fnc\_hashSetId;}
|
|
\DoxyCodeLine{["{}myHash"{},\ "{}myField"{},\ "{}myFunction"{}]\ call\ ramdb\_db\_fnc\_hashGetId;}
|
|
\DoxyCodeLine{["{}myHash"{}]\ call\ ramdb\_db\_fnc\_hashGetAllId;}
|
|
\DoxyCodeLine{["{}myHash"{},\ "{}myField"{}]\ call\ ramdb\_db\_fnc\_hashRemoveId;}
|
|
\DoxyCodeLine{["{}myHash"{}]\ call\ ramdb\_db\_fnc\_hashDeleteId;}
|
|
|
|
\end{DoxyCode}
|
|
\hypertarget{README.md_autotoc_md346}{}\doxysubsection{\texorpdfstring{Related Categories}{Related Categories}}\label{README.md_autotoc_md346}
|
|
|
|
\begin{DoxyItemize}
|
|
\item Core Functions
|
|
\item Basic Data Operations
|
|
\item List Operations
|
|
\end{DoxyItemize} |