diff options
Diffstat (limited to 'docs/doxygen/latex/classxb_1_1xbXBase.tex')
| -rw-r--r-- | docs/doxygen/latex/classxb_1_1xbXBase.tex | 114 |
1 files changed, 82 insertions, 32 deletions
diff --git a/docs/doxygen/latex/classxb_1_1xbXBase.tex b/docs/doxygen/latex/classxb_1_1xbXBase.tex index b08ea8c..7159134 100644 --- a/docs/doxygen/latex/classxb_1_1xbXBase.tex +++ b/docs/doxygen/latex/classxb_1_1xbXBase.tex @@ -58,9 +58,13 @@ xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_a0dff00b9ee3c288841e137ca01168116} \item void \mbox{\hyperlink{classxb_1_1xbXBase_a0915aff7be4b2dd3e881f3c5d0da4baf}{xb\+Sleep}} (xb\+Int32 l\+Millisecs) \begin{DoxyCompactList}\small\item\em Cross platform sleep function. \end{DoxyCompactList}\item -xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_a721f69ccc7893842422a043468ffccea}{Add\+Tbl\+To\+Tbl\+List}} (\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$d, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Tbl\+Name) +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_aadecb3ac460d8e94b88b2e809e22f48e}{Get\+Cmd\+Line\+Opt}} (xb\+Int32 l\+Argc, char $\ast$$\ast$argv, const char $\ast$s\+Opt\+Rqst, \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Parm\+Out) +\begin{DoxyCompactList}\small\item\em Parse commmand line options for a given parm request. \end{DoxyCompactList}\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_a8612e0c5334349fbceb9394b47817fd5}{Get\+Cmd\+Line\+Opt}} (xb\+Int32 l\+Argc, char $\ast$$\ast$argv, \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Opt\+Rqst, \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Parm\+Out) +\begin{DoxyCompactList}\small\item\em Parse commmand line options for a given parm request. \end{DoxyCompactList}\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_af16832ff2bfaee09265652e0fc03709a}{Add\+Tbl\+To\+Tbl\+List}} (\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$d, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Fq\+Tbl\+Name) \item -xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_a62f6841849dbe5c1768f7e90f1b7e766}{Add\+Tbl\+To\+Tbl\+List}} (\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$d, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Tbl\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Tbl\+Alias) +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_a2033188e9b08778188a034a6fc90ca85}{Add\+Tbl\+To\+Tbl\+List}} (\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$d, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Fq\+Tbl\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Tbl\+Alias) \item xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_a5eebffb9e8cc64141e35c2622045cb50}{Display\+Table\+List}} () const \item @@ -100,12 +104,8 @@ void \mbox{\hyperlink{classxb_1_1xbSsv_aba1395b8e4c7f28c3614061de6e49190}{Bit\+D \begin{DoxyCompactList}\small\item\em Get the default auto commit setting. \end{DoxyCompactList}\item void \mbox{\hyperlink{classxb_1_1xbSsv_a25542afadaaf39b4fb5a1772a29cc0bd}{Set\+Default\+Auto\+Commit}} (\mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} b\+Default\+Auto\+Commit) \begin{DoxyCompactList}\small\item\em Set the default auto commit. \end{DoxyCompactList}\item -\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& \mbox{\hyperlink{classxb_1_1xbSsv_abf3763faf6a8917a963213cd53af529c}{Get\+Default\+Log\+Directory}} () const -\item -\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& \mbox{\hyperlink{classxb_1_1xbSsv_a43878d4dc041f2a5e2398a118ccfaf79}{Get\+Default\+Log\+File\+Name}} () const -\item -void \mbox{\hyperlink{classxb_1_1xbSsv_a84343b8645790791512d6bc22ee6c8eb}{Set\+Default\+Log\+Directory}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Default\+Log\+Directory) -\item +void \mbox{\hyperlink{classxb_1_1xbSsv_abc9c06c95d71fbad8294e1ae8862cea9}{Get\+Home\+Dir}} (\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Home\+Dir\+Out) +\begin{DoxyCompactList}\small\item\em Get home directory. \end{DoxyCompactList}\item \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} \mbox{\hyperlink{classxb_1_1xbSsv_abd58031c5f1c3766c24d47a82e6fd9c5}{Get\+Multi\+User}} () const \begin{DoxyCompactList}\small\item\em Get the multi user setting. \end{DoxyCompactList}\item void \mbox{\hyperlink{classxb_1_1xbSsv_aba6e59512f7172dd55dcf92059e5928c}{Set\+Multi\+User}} (\mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} b\+Multi\+User) @@ -172,17 +172,17 @@ Class Deconstructor. \doxysubsection{Member Function Documentation} -\mbox{\Hypertarget{classxb_1_1xbTblMgr_a721f69ccc7893842422a043468ffccea}\label{classxb_1_1xbTblMgr_a721f69ccc7893842422a043468ffccea}} +\mbox{\Hypertarget{classxb_1_1xbTblMgr_af16832ff2bfaee09265652e0fc03709a}\label{classxb_1_1xbTblMgr_af16832ff2bfaee09265652e0fc03709a}} \index{xb::xbXBase@{xb::xbXBase}!AddTblToTblList@{AddTblToTblList}} \index{AddTblToTblList@{AddTblToTblList}!xb::xbXBase@{xb::xbXBase}} \doxysubsubsection{\texorpdfstring{AddTblToTblList()}{AddTblToTblList()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} -{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Tbl\+Mgr\+::\+Add\+Tbl\+To\+Tbl\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$}]{d, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Tbl\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Tbl\+Mgr\+::\+Add\+Tbl\+To\+Tbl\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$}]{d, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Fq\+Tbl\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} -\mbox{\Hypertarget{classxb_1_1xbTblMgr_a62f6841849dbe5c1768f7e90f1b7e766}\label{classxb_1_1xbTblMgr_a62f6841849dbe5c1768f7e90f1b7e766}} +\mbox{\Hypertarget{classxb_1_1xbTblMgr_a2033188e9b08778188a034a6fc90ca85}\label{classxb_1_1xbTblMgr_a2033188e9b08778188a034a6fc90ca85}} \index{xb::xbXBase@{xb::xbXBase}!AddTblToTblList@{AddTblToTblList}} \index{AddTblToTblList@{AddTblToTblList}!xb::xbXBase@{xb::xbXBase}} \doxysubsubsection{\texorpdfstring{AddTblToTblList()}{AddTblToTblList()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Tbl\+Mgr\+::\+Add\+Tbl\+To\+Tbl\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$}]{d, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Tbl\+Name, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Tbl\+Alias }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Tbl\+Mgr\+::\+Add\+Tbl\+To\+Tbl\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$}]{d, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Fq\+Tbl\+Name, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Tbl\+Alias }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} \mbox{\Hypertarget{classxb_1_1xbSsv_aba1395b8e4c7f28c3614061de6e49190}\label{classxb_1_1xbSsv_aba1395b8e4c7f28c3614061de6e49190}} \index{xb::xbXBase@{xb::xbXBase}!BitDump@{BitDump}} @@ -269,6 +269,56 @@ Display error message on console for a given error number. \doxysubsubsection{\texorpdfstring{FlushLog()}{FlushLog()}} {\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Flush\+Log (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} +\mbox{\Hypertarget{classxb_1_1xbXBase_aadecb3ac460d8e94b88b2e809e22f48e}\label{classxb_1_1xbXBase_aadecb3ac460d8e94b88b2e809e22f48e}} +\index{xb::xbXBase@{xb::xbXBase}!GetCmdLineOpt@{GetCmdLineOpt}} +\index{GetCmdLineOpt@{GetCmdLineOpt}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetCmdLineOpt()}{GetCmdLineOpt()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Get\+Cmd\+Line\+Opt (\begin{DoxyParamCaption}\item[{xb\+Int32}]{l\+Argc, }\item[{char $\ast$$\ast$}]{s\+Argv, }\item[{const char $\ast$}]{s\+Opt\+Rqst, }\item[{\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Parm\+Out }\end{DoxyParamCaption})} + + + +Parse commmand line options for a given parm request. + + +\begin{DoxyParams}{Parameters} +{\em l\+Argc} & Value passed from main( argc, argv\mbox{[}$\,$\mbox{]} ) \\ +\hline +{\em s\+Argv} & Valued passed from main \\ +\hline +{\em s\+Opt\+Rqst} & Option to search for in the arguments list \\ +\hline +{\em s\+Parm\+Out} & String token immediately to the right of the the option request, if found \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +0 -\/ paramater request not found~\newline + 1 -\/ Parameter found +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbXBase_a8612e0c5334349fbceb9394b47817fd5}\label{classxb_1_1xbXBase_a8612e0c5334349fbceb9394b47817fd5}} +\index{xb::xbXBase@{xb::xbXBase}!GetCmdLineOpt@{GetCmdLineOpt}} +\index{GetCmdLineOpt@{GetCmdLineOpt}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetCmdLineOpt()}{GetCmdLineOpt()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Get\+Cmd\+Line\+Opt (\begin{DoxyParamCaption}\item[{xb\+Int32}]{l\+Argc, }\item[{char $\ast$$\ast$}]{s\+Argv, }\item[{\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Opt\+Rqst, }\item[{\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Parm\+Out }\end{DoxyParamCaption})} + + + +Parse commmand line options for a given parm request. + + +\begin{DoxyParams}{Parameters} +{\em l\+Argc} & Value passed from main( argc, argv\mbox{[}$\,$\mbox{]} ) \\ +\hline +{\em s\+Argv} & Valued passed from main \\ +\hline +{\em s\+Opt\+Rqst} & Option to search for in the arguments list \\ +\hline +{\em s\+Parm\+Out} & String token immediately to the right of the the option request, if found \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +0 -\/ paramater request not found~\newline + 1 -\/ Parameter found +\end{DoxyReturn} \mbox{\Hypertarget{classxb_1_1xbSsv_a1d803a4bfc8ba0561267a0bf9e51f7d9}\label{classxb_1_1xbSsv_a1d803a4bfc8ba0561267a0bf9e51f7d9}} \index{xb::xbXBase@{xb::xbXBase}!GetDataDirectory@{GetDataDirectory}} \index{GetDataDirectory@{GetDataDirectory}!xb::xbXBase@{xb::xbXBase}} @@ -323,18 +373,6 @@ Get the default date format. \begin{DoxyReturn}{Returns} \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} containing the default date format. \end{DoxyReturn} -\mbox{\Hypertarget{classxb_1_1xbSsv_abf3763faf6a8917a963213cd53af529c}\label{classxb_1_1xbSsv_abf3763faf6a8917a963213cd53af529c}} -\index{xb::xbXBase@{xb::xbXBase}!GetDefaultLogDirectory@{GetDefaultLogDirectory}} -\index{GetDefaultLogDirectory@{GetDefaultLogDirectory}!xb::xbXBase@{xb::xbXBase}} -\doxysubsubsection{\texorpdfstring{GetDefaultLogDirectory()}{GetDefaultLogDirectory()}} -{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& xb\+::xb\+Ssv\+::\+Get\+Default\+Log\+Directory (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} - -\mbox{\Hypertarget{classxb_1_1xbSsv_a43878d4dc041f2a5e2398a118ccfaf79}\label{classxb_1_1xbSsv_a43878d4dc041f2a5e2398a118ccfaf79}} -\index{xb::xbXBase@{xb::xbXBase}!GetDefaultLogFileName@{GetDefaultLogFileName}} -\index{GetDefaultLogFileName@{GetDefaultLogFileName}!xb::xbXBase@{xb::xbXBase}} -\doxysubsubsection{\texorpdfstring{GetDefaultLogFileName()}{GetDefaultLogFileName()}} -{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& xb\+::xb\+Ssv\+::\+Get\+Default\+Log\+File\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} - \mbox{\Hypertarget{classxb_1_1xbSsv_a49cd162f066eef2b829ba7c9f6620243}\label{classxb_1_1xbSsv_a49cd162f066eef2b829ba7c9f6620243}} \index{xb::xbXBase@{xb::xbXBase}!GetEndianType@{GetEndianType}} \index{GetEndianType@{GetEndianType}!xb::xbXBase@{xb::xbXBase}} @@ -374,6 +412,24 @@ Returns a pointer to a string containing a text description for the error code. \doxysubsubsection{\texorpdfstring{GetFunctionInfo()}{GetFunctionInfo()}} {\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Get\+Function\+Info (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Exp\+Line, }\item[{char \&}]{c\+Return\+Type, }\item[{xb\+Int16 \&}]{i\+Return\+Len\+Calc, }\item[{xb\+Int32 \&}]{l\+Return\+Len\+Val }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [protected]}} +\mbox{\Hypertarget{classxb_1_1xbSsv_abc9c06c95d71fbad8294e1ae8862cea9}\label{classxb_1_1xbSsv_abc9c06c95d71fbad8294e1ae8862cea9}} +\index{xb::xbXBase@{xb::xbXBase}!GetHomeDir@{GetHomeDir}} +\index{GetHomeDir@{GetHomeDir}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetHomeDir()}{GetHomeDir()}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Get\+Home\+Dir (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Home\+Dir\+Out }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Get home directory. + + +\begin{DoxyParams}{Parameters} +{\em s\+Home\+Dir\+Out} & -\/ Output home directory for current user. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +void +\end{DoxyReturn} \mbox{\Hypertarget{classxb_1_1xbXBase_a51d49b4d699740194b28c6ec0d0ee07b}\label{classxb_1_1xbXBase_a51d49b4d699740194b28c6ec0d0ee07b}} \index{xb::xbXBase@{xb::xbXBase}!GetLogDirectory@{GetLogDirectory}} \index{GetLogDirectory@{GetLogDirectory}!xb::xbXBase@{xb::xbXBase}} @@ -541,12 +597,6 @@ Set the default date format. {\em s\+Default\+Date\+Format} & Set the default date format. \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classxb_1_1xbSsv_a84343b8645790791512d6bc22ee6c8eb}\label{classxb_1_1xbSsv_a84343b8645790791512d6bc22ee6c8eb}} -\index{xb::xbXBase@{xb::xbXBase}!SetDefaultLogDirectory@{SetDefaultLogDirectory}} -\index{SetDefaultLogDirectory@{SetDefaultLogDirectory}!xb::xbXBase@{xb::xbXBase}} -\doxysubsubsection{\texorpdfstring{SetDefaultLogDirectory()}{SetDefaultLogDirectory()}} -{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Set\+Default\+Log\+Directory (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Default\+Log\+Directory }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} - \mbox{\Hypertarget{classxb_1_1xbSsv_a904ec348fd029d4a76e72b8fde636108}\label{classxb_1_1xbSsv_a904ec348fd029d4a76e72b8fde636108}} \index{xb::xbXBase@{xb::xbXBase}!SetEndianType@{SetEndianType}} \index{SetEndianType@{SetEndianType}!xb::xbXBase@{xb::xbXBase}} @@ -683,5 +733,5 @@ Cross platform sleep function. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} \item -/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+3/src/include/\mbox{\hyperlink{xbxbase_8h}{xbxbase.\+h}}\item -/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+3/src/core/\mbox{\hyperlink{xbxbase_8cpp}{xbxbase.\+cpp}}\end{DoxyCompactItemize} +/mnt/1\+Tdata/xbase/xbase64-\/4.\+1.\+0/src/include/\mbox{\hyperlink{xbxbase_8h}{xbxbase.\+h}}\item +/mnt/1\+Tdata/xbase/xbase64-\/4.\+1.\+0/src/core/\mbox{\hyperlink{xbxbase_8cpp}{xbxbase.\+cpp}}\end{DoxyCompactItemize} |