diff options
Diffstat (limited to 'docs/doxygen/latex/classxb_1_1xbXBase.tex')
| -rw-r--r-- | docs/doxygen/latex/classxb_1_1xbXBase.tex | 663 |
1 files changed, 663 insertions, 0 deletions
diff --git a/docs/doxygen/latex/classxb_1_1xbXBase.tex b/docs/doxygen/latex/classxb_1_1xbXBase.tex new file mode 100644 index 0000000..4cdec63 --- /dev/null +++ b/docs/doxygen/latex/classxb_1_1xbXBase.tex @@ -0,0 +1,663 @@ +\hypertarget{classxb_1_1xbXBase}{}\doxysection{xb\+::xb\+XBase Class Reference} +\label{classxb_1_1xbXBase}\index{xb::xbXBase@{xb::xbXBase}} + + +xb\+Xbase class. + + + + +{\ttfamily \#include $<$xbxbase.\+h$>$} + +Inheritance diagram for xb\+::xb\+XBase\+:\begin{figure}[H] +\begin{center} +\leavevmode +\includegraphics[height=3.000000cm]{classxb_1_1xbXBase} +\end{center} +\end{figure} +\doxysubsection*{Public Member Functions} +\begin{DoxyCompactItemize} +\item +\mbox{\hyperlink{classxb_1_1xbXBase_a6c68588e33946fb5416af3f86fe83224}{xb\+XBase}} () +\begin{DoxyCompactList}\small\item\em Class Constructor. \end{DoxyCompactList}\item +\mbox{\hyperlink{classxb_1_1xbXBase_a204f8634894ac2066d3209117803306d}{$\sim$xb\+XBase}} () +\begin{DoxyCompactList}\small\item\em Class Deconstructor. \end{DoxyCompactList}\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_afccb552ca0daff779c0500ff20d22c2b}{Close\+All\+Tables}} () +\begin{DoxyCompactList}\small\item\em Close all tables / files. \end{DoxyCompactList}\item +void \mbox{\hyperlink{classxb_1_1xbXBase_ae357fac4fdebdf49e46563cf611caf65}{Disable\+Msg\+Logging}} () +\item +void \mbox{\hyperlink{classxb_1_1xbXBase_a470e6eb0ed0be60338f9b40976d3ad48}{Enable\+Msg\+Logging}} () +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_a5a5ecaed9777978344902446c9ae3b8e}{Flush\+Log}} () +\item +const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& \mbox{\hyperlink{classxb_1_1xbXBase_a51d49b4d699740194b28c6ec0d0ee07b}{Get\+Log\+Directory}} () const +\item +const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& \mbox{\hyperlink{classxb_1_1xbXBase_ac0744edf9e4aa959d8cf2daa874376af}{Get\+Log\+File\+Name}} () const +\item +const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& \mbox{\hyperlink{classxb_1_1xbXBase_ab5d63cd7d9137eba8a1d4d9c3df522b7}{Get\+Log\+Fq\+File\+Name}} () const +\item +\mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} \mbox{\hyperlink{classxb_1_1xbXBase_ade34cd72c2a7e70fb55429a8a6f6c028}{Get\+Log\+Status}} () const +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_aa957eb502ecd076e5df89e7415cb094b}{Open\+Highest\+Version}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Alias, \mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} \&dbf, int dummy) +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_afa7bbac08a4601f49cd53b457196ee0e}{Open\+Highest\+Version}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Alias, \mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$$\ast$dbf) +\item +\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$ \mbox{\hyperlink{classxb_1_1xbXBase_aafb1abd6b6124cddf635adaf9f615a4a}{Open}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name, xb\+Int16 \&i\+Rc) +\begin{DoxyCompactList}\small\item\em Open highest qualified class available for dbf file. \end{DoxyCompactList}\item +\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$ \mbox{\hyperlink{classxb_1_1xbXBase_ab35cec5ac8f0fa95f10653ca7ac817f6}{Open}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Alias, xb\+Int16 i\+Open\+Mode, xb\+Int16 i\+Share\+Mode, xb\+Int16 i\+Version, xb\+Int16 \&i\+Rc) +\begin{DoxyCompactList}\small\item\em Open highest qualified class available for dbf file. \end{DoxyCompactList}\item +void \mbox{\hyperlink{classxb_1_1xbXBase_a48d82dbe298c6f4cf68a63ac82dd8292}{Set\+Log\+Directory}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Log\+File\+Directory) +\item +void \mbox{\hyperlink{classxb_1_1xbXBase_a94010b88a309315ef980715eb581336c}{Set\+Log\+File\+Name}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Log\+File\+Name) +\item +void \mbox{\hyperlink{classxb_1_1xbXBase_a666a0cb5b76ec7a9a3677d339e0c6b42}{Set\+Log\+Size}} (size\+\_\+t l\+Size) +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_a9ca5be73abffd0fdd18bdc799877272a}{Write\+Log\+Message}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Log\+Message, xb\+Int16 i\+Output\+Opt=0) +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_a0dff00b9ee3c288841e137ca01168116}{Write\+Log\+Bytes}} (xb\+UInt32 l\+Cnt, const char $\ast$p) +\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) +\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) +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_a5eebffb9e8cc64141e35c2622045cb50}{Display\+Table\+List}} () const +\item +\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$ \mbox{\hyperlink{classxb_1_1xbTblMgr_ad8a5d28a2ee6720a9aa74bcb45662cf5}{Get\+Dbf\+Ptr}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Tbl\+Alias) const +\item +\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$ \mbox{\hyperlink{classxb_1_1xbTblMgr_a801dfecf7fc216954b4197b2c31b25d6}{Get\+Dbf\+Ptr}} (xb\+Int16 s\+Item\+No) const +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_ad0d2d4adabc0dc0e761cfdee63c84069}{Get\+Open\+Table\+Count}} () const +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_ac8eaef41acf08911b90f900aac8e70af}{Remove\+Tbl\+From\+Tbl\+List}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Tbl\+Alias) +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbTblMgr_a3d82b6e73d5c0bc8cac22b9a260389c1}{Remove\+Tbl\+From\+Tbl\+List}} (\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$d) +\item +void \mbox{\hyperlink{classxb_1_1xbSsv_a97dfa59ab9a8e9f17454da0faceb023d}{Display\+Error}} (xb\+Int16 Error\+Code) const +\begin{DoxyCompactList}\small\item\em Display error message on console for a given error number. \end{DoxyCompactList}\item +\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& \mbox{\hyperlink{classxb_1_1xbSsv_a6fbb9c3a550ab0b3378f9586a57791d2}{Get\+Default\+Date\+Format}} () const +\begin{DoxyCompactList}\small\item\em Get the default date format. \end{DoxyCompactList}\item +\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& \mbox{\hyperlink{classxb_1_1xbSsv_a1d803a4bfc8ba0561267a0bf9e51f7d9}{Get\+Data\+Directory}} () const +\begin{DoxyCompactList}\small\item\em Get the current data directory. \end{DoxyCompactList}\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbSsv_a49cd162f066eef2b829ba7c9f6620243}{Get\+Endian\+Type}} () const +\begin{DoxyCompactList}\small\item\em Get the Endian type. \end{DoxyCompactList}\item +const char $\ast$ \mbox{\hyperlink{classxb_1_1xbSsv_a56961d2a67b8e7470098626ac4dac7e4}{Get\+Error\+Message}} (xb\+Int16 Error\+Code) const +\begin{DoxyCompactList}\small\item\em Get an error message. \end{DoxyCompactList}\item +void \mbox{\hyperlink{classxb_1_1xbSsv_a57caaaadfbd089d9a58ecfcb50c88a6c}{Set\+Data\+Directory}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Data\+Directory) +\begin{DoxyCompactList}\small\item\em Set the data directory. \end{DoxyCompactList}\item +void \mbox{\hyperlink{classxb_1_1xbSsv_a5f74db23f8902846d581935c7db73f9c}{Set\+Default\+Date\+Format}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Default\+Date\+Format) +\begin{DoxyCompactList}\small\item\em Set the default date format. \end{DoxyCompactList}\item +\mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} \mbox{\hyperlink{classxb_1_1xbSsv_a62e4fd0a5888665c76bbbad962794e72}{Bit\+Set}} (unsigned char c, xb\+Int16 i\+Bit\+No) const +\begin{DoxyCompactList}\small\item\em Check a bit in a one byte field and see if it is set. \end{DoxyCompactList}\item +\mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} \mbox{\hyperlink{classxb_1_1xbSsv_a6982f973e81587b04916f4509746aaf5}{Get\+Default\+Auto\+Commit}} () const +\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 +\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) +\begin{DoxyCompactList}\small\item\em Get the multi user setting. \end{DoxyCompactList}\end{DoxyCompactItemize} +\doxysubsection*{Static Public Attributes} +\begin{DoxyCompactItemize} +\item +static const char $\ast$ \mbox{\hyperlink{classxb_1_1xbSsv_a6219f1b5e24ea12fe158cd5aea56988e}{Error\+Code\+Text}} \mbox{[}$\,$\mbox{]} +\end{DoxyCompactItemize} +\doxysubsection*{Protected Member Functions} +\begin{DoxyCompactItemize} +\item +xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_ae52e53340593b4253936c1372ec15ee1}{Get\+Function\+Info}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Exp\+Line, char \&c\+Return\+Type, xb\+Int16 \&i\+Return\+Len\+Calc, xb\+Int32 \&l\+Return\+Len\+Val) const +\item +void \mbox{\hyperlink{classxb_1_1xbSsv_a904ec348fd029d4a76e72b8fde636108}{Set\+Endian\+Type}} () +\begin{DoxyCompactList}\small\item\em Set the endian type. \end{DoxyCompactList}\end{DoxyCompactItemize} +\doxysubsection*{Static Protected Member Functions} +\begin{DoxyCompactItemize} +\item +static xb\+Int16 \mbox{\hyperlink{classxb_1_1xbXBase_a1b239c021358476382942522911b5c66}{xb\+Memcmp}} (const unsigned char $\ast$s1, const unsigned char $\ast$s2, size\+\_\+t n) +\begin{DoxyCompactList}\small\item\em Cross memcmp function. \end{DoxyCompactList}\end{DoxyCompactItemize} +\doxysubsection*{Static Protected Attributes} +\begin{DoxyCompactItemize} +\item +static xb\+Int16 \mbox{\hyperlink{classxb_1_1xbSsv_a5849e813f5e8e1cd180f0366637adbf3}{i\+Endian\+Type}} = 0 +\item +static \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \mbox{\hyperlink{classxb_1_1xbSsv_a9dec3164c3b264882df634915ecf21da}{s\+Null\+String}} = \char`\"{}\char`\"{} +\end{DoxyCompactItemize} +\doxysubsection*{Friends} +\begin{DoxyCompactItemize} +\item +class \mbox{\hyperlink{classxb_1_1xbXBase_a86a53ce3efbf910996df0f853f1c0add}{xb\+Bcd}} +\item +class \mbox{\hyperlink{classxb_1_1xbXBase_a3c3e5617be811d732472fe2cc8fb18cc}{xb\+Exp}} +\end{DoxyCompactItemize} + + +\doxysubsection{Detailed Description} +xb\+Xbase class. + +The \mbox{\hyperlink{classxb_1_1xbXBase}{xb\+XBase}} class is the core class that needs to be in every application program. + +\doxysubsection{Constructor \& Destructor Documentation} +\mbox{\Hypertarget{classxb_1_1xbXBase_a6c68588e33946fb5416af3f86fe83224}\label{classxb_1_1xbXBase_a6c68588e33946fb5416af3f86fe83224}} +\index{xb::xbXBase@{xb::xbXBase}!xbXBase@{xbXBase}} +\index{xbXBase@{xbXBase}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{xbXBase()}{xbXBase()}} +{\footnotesize\ttfamily xb\+::xb\+XBase\+::xb\+XBase (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} + + + +Class Constructor. + +\mbox{\Hypertarget{classxb_1_1xbXBase_a204f8634894ac2066d3209117803306d}\label{classxb_1_1xbXBase_a204f8634894ac2066d3209117803306d}} +\index{xb::xbXBase@{xb::xbXBase}!````~xbXBase@{$\sim$xbXBase}} +\index{````~xbXBase@{$\sim$xbXBase}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{$\sim$xbXBase()}{~xbXBase()}} +{\footnotesize\ttfamily xb\+::xb\+XBase\+::$\sim$xb\+XBase (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} + + + +Class Deconstructor. + + + +\doxysubsection{Member Function Documentation} +\mbox{\Hypertarget{classxb_1_1xbTblMgr_a721f69ccc7893842422a043468ffccea}\label{classxb_1_1xbTblMgr_a721f69ccc7893842422a043468ffccea}} +\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]}} + +\mbox{\Hypertarget{classxb_1_1xbTblMgr_a62f6841849dbe5c1768f7e90f1b7e766}\label{classxb_1_1xbTblMgr_a62f6841849dbe5c1768f7e90f1b7e766}} +\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]}} + +\mbox{\Hypertarget{classxb_1_1xbSsv_a62e4fd0a5888665c76bbbad962794e72}\label{classxb_1_1xbSsv_a62e4fd0a5888665c76bbbad962794e72}} +\index{xb::xbXBase@{xb::xbXBase}!BitSet@{BitSet}} +\index{BitSet@{BitSet}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{BitSet()}{BitSet()}} +{\footnotesize\ttfamily \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} xb\+::xb\+Ssv\+::\+Bit\+Set (\begin{DoxyParamCaption}\item[{unsigned char}]{c, }\item[{xb\+Int16}]{i\+Bit\+No }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Check a bit in a one byte field and see if it is set. + + +\begin{DoxyParams}{Parameters} +{\em c} & One byte char field to examine. \\ +\hline +{\em i\+Bit\+No} & which bit to examine. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +xb\+True Bit is set~\newline + xb\+False Bit is not set +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbXBase_afccb552ca0daff779c0500ff20d22c2b}\label{classxb_1_1xbXBase_afccb552ca0daff779c0500ff20d22c2b}} +\index{xb::xbXBase@{xb::xbXBase}!CloseAllTables@{CloseAllTables}} +\index{CloseAllTables@{CloseAllTables}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{CloseAllTables()}{CloseAllTables()}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Close\+All\+Tables (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} + + + +Close all tables / files. + +This closes everything. \begin{DoxyReturn}{Returns} +\href{xbretcod_8h.html}{\texttt{ Return Codes}} +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbXBase_ae357fac4fdebdf49e46563cf611caf65}\label{classxb_1_1xbXBase_ae357fac4fdebdf49e46563cf611caf65}} +\index{xb::xbXBase@{xb::xbXBase}!DisableMsgLogging@{DisableMsgLogging}} +\index{DisableMsgLogging@{DisableMsgLogging}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{DisableMsgLogging()}{DisableMsgLogging()}} +{\footnotesize\ttfamily void xb\+::xb\+XBase\+::\+Disable\+Msg\+Logging (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbSsv_a97dfa59ab9a8e9f17454da0faceb023d}\label{classxb_1_1xbSsv_a97dfa59ab9a8e9f17454da0faceb023d}} +\index{xb::xbXBase@{xb::xbXBase}!DisplayError@{DisplayError}} +\index{DisplayError@{DisplayError}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{DisplayError()}{DisplayError()}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Display\+Error (\begin{DoxyParamCaption}\item[{xb\+Int16}]{i\+Error\+Code }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Display error message on console for a given error number. + + +\begin{DoxyParams}{Parameters} +{\em i\+Error\+Code} & Error number to reference \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classxb_1_1xbTblMgr_a5eebffb9e8cc64141e35c2622045cb50}\label{classxb_1_1xbTblMgr_a5eebffb9e8cc64141e35c2622045cb50}} +\index{xb::xbXBase@{xb::xbXBase}!DisplayTableList@{DisplayTableList}} +\index{DisplayTableList@{DisplayTableList}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{DisplayTableList()}{DisplayTableList()}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Tbl\+Mgr\+::\+Display\+Table\+List (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbXBase_a470e6eb0ed0be60338f9b40976d3ad48}\label{classxb_1_1xbXBase_a470e6eb0ed0be60338f9b40976d3ad48}} +\index{xb::xbXBase@{xb::xbXBase}!EnableMsgLogging@{EnableMsgLogging}} +\index{EnableMsgLogging@{EnableMsgLogging}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{EnableMsgLogging()}{EnableMsgLogging()}} +{\footnotesize\ttfamily void xb\+::xb\+XBase\+::\+Enable\+Msg\+Logging (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbXBase_a5a5ecaed9777978344902446c9ae3b8e}\label{classxb_1_1xbXBase_a5a5ecaed9777978344902446c9ae3b8e}} +\index{xb::xbXBase@{xb::xbXBase}!FlushLog@{FlushLog}} +\index{FlushLog@{FlushLog}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{FlushLog()}{FlushLog()}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Flush\+Log (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} + +\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}} +\doxysubsubsection{\texorpdfstring{GetDataDirectory()}{GetDataDirectory()}} +{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& xb\+::xb\+Ssv\+::\+Get\+Data\+Directory (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Get the current data directory. + +\begin{DoxyReturn}{Returns} +\mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} containing the current data directory where the database files are stored. +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbTblMgr_ad8a5d28a2ee6720a9aa74bcb45662cf5}\label{classxb_1_1xbTblMgr_ad8a5d28a2ee6720a9aa74bcb45662cf5}} +\index{xb::xbXBase@{xb::xbXBase}!GetDbfPtr@{GetDbfPtr}} +\index{GetDbfPtr@{GetDbfPtr}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetDbfPtr()}{GetDbfPtr()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$ xb\+::xb\+Tbl\+Mgr\+::\+Get\+Dbf\+Ptr (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Tbl\+Alias }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbTblMgr_a801dfecf7fc216954b4197b2c31b25d6}\label{classxb_1_1xbTblMgr_a801dfecf7fc216954b4197b2c31b25d6}} +\index{xb::xbXBase@{xb::xbXBase}!GetDbfPtr@{GetDbfPtr}} +\index{GetDbfPtr@{GetDbfPtr}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetDbfPtr()}{GetDbfPtr()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$ xb\+::xb\+Tbl\+Mgr\+::\+Get\+Dbf\+Ptr (\begin{DoxyParamCaption}\item[{xb\+Int16}]{s\+Item\+No }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbSsv_a6982f973e81587b04916f4509746aaf5}\label{classxb_1_1xbSsv_a6982f973e81587b04916f4509746aaf5}} +\index{xb::xbXBase@{xb::xbXBase}!GetDefaultAutoCommit@{GetDefaultAutoCommit}} +\index{GetDefaultAutoCommit@{GetDefaultAutoCommit}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetDefaultAutoCommit()}{GetDefaultAutoCommit()}} +{\footnotesize\ttfamily \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} xb\+::xb\+Ssv\+::\+Get\+Default\+Auto\+Commit (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Get the default auto commit setting. + +When auto commit is enabled, the library will automatically post any updates when moving off an updated record or closing files. If auto commit is disabled, the application program will need to explicitly update the tables using using dbf-\/\texorpdfstring{$>$}{>}Put() and dbf-\/\texorpdfstring{$>$}{>}Append\+Record(). + +\begin{DoxyReturn}{Returns} +xb\+True if auto commit is turned on~\newline + xb\+False is auto commit is turned off +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbSsv_a6fbb9c3a550ab0b3378f9586a57791d2}\label{classxb_1_1xbSsv_a6fbb9c3a550ab0b3378f9586a57791d2}} +\index{xb::xbXBase@{xb::xbXBase}!GetDefaultDateFormat@{GetDefaultDateFormat}} +\index{GetDefaultDateFormat@{GetDefaultDateFormat}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetDefaultDateFormat()}{GetDefaultDateFormat()}} +{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& xb\+::xb\+Ssv\+::\+Get\+Default\+Date\+Format (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + + + +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}} +\doxysubsubsection{\texorpdfstring{GetEndianType()}{GetEndianType()}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Ssv\+::\+Get\+Endian\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Get the Endian type. + +\begin{DoxyReturn}{Returns} +B -\/ Big endian~\newline + L -\/ Little endian~\newline + +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbSsv_a56961d2a67b8e7470098626ac4dac7e4}\label{classxb_1_1xbSsv_a56961d2a67b8e7470098626ac4dac7e4}} +\index{xb::xbXBase@{xb::xbXBase}!GetErrorMessage@{GetErrorMessage}} +\index{GetErrorMessage@{GetErrorMessage}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetErrorMessage()}{GetErrorMessage()}} +{\footnotesize\ttfamily const char $\ast$ xb\+::xb\+Ssv\+::\+Get\+Error\+Message (\begin{DoxyParamCaption}\item[{xb\+Int16}]{i\+Error\+Code }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Get an error message. + + +\begin{DoxyParams}{Parameters} +{\em i\+Error\+Code} & Error\+Code is the error number of description to be returned. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +Returns a pointer to a string containing a text description for the error code. +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbXBase_ae52e53340593b4253936c1372ec15ee1}\label{classxb_1_1xbXBase_ae52e53340593b4253936c1372ec15ee1}} +\index{xb::xbXBase@{xb::xbXBase}!GetFunctionInfo@{GetFunctionInfo}} +\index{GetFunctionInfo@{GetFunctionInfo}!xb::xbXBase@{xb::xbXBase}} +\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_1xbXBase_a51d49b4d699740194b28c6ec0d0ee07b}\label{classxb_1_1xbXBase_a51d49b4d699740194b28c6ec0d0ee07b}} +\index{xb::xbXBase@{xb::xbXBase}!GetLogDirectory@{GetLogDirectory}} +\index{GetLogDirectory@{GetLogDirectory}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetLogDirectory()}{GetLogDirectory()}} +{\footnotesize\ttfamily const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& xb\+::xb\+XBase\+::\+Get\+Log\+Directory (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const} + +\mbox{\Hypertarget{classxb_1_1xbXBase_ac0744edf9e4aa959d8cf2daa874376af}\label{classxb_1_1xbXBase_ac0744edf9e4aa959d8cf2daa874376af}} +\index{xb::xbXBase@{xb::xbXBase}!GetLogFileName@{GetLogFileName}} +\index{GetLogFileName@{GetLogFileName}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetLogFileName()}{GetLogFileName()}} +{\footnotesize\ttfamily const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& xb\+::xb\+XBase\+::\+Get\+Log\+File\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const} + +\mbox{\Hypertarget{classxb_1_1xbXBase_ab5d63cd7d9137eba8a1d4d9c3df522b7}\label{classxb_1_1xbXBase_ab5d63cd7d9137eba8a1d4d9c3df522b7}} +\index{xb::xbXBase@{xb::xbXBase}!GetLogFqFileName@{GetLogFqFileName}} +\index{GetLogFqFileName@{GetLogFqFileName}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetLogFqFileName()}{GetLogFqFileName()}} +{\footnotesize\ttfamily const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \& xb\+::xb\+XBase\+::\+Get\+Log\+Fq\+File\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const} + +\mbox{\Hypertarget{classxb_1_1xbXBase_ade34cd72c2a7e70fb55429a8a6f6c028}\label{classxb_1_1xbXBase_ade34cd72c2a7e70fb55429a8a6f6c028}} +\index{xb::xbXBase@{xb::xbXBase}!GetLogStatus@{GetLogStatus}} +\index{GetLogStatus@{GetLogStatus}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetLogStatus()}{GetLogStatus()}} +{\footnotesize\ttfamily \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} xb\+::xb\+XBase\+::\+Get\+Log\+Status (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const} + +\mbox{\Hypertarget{classxb_1_1xbSsv_abd58031c5f1c3766c24d47a82e6fd9c5}\label{classxb_1_1xbSsv_abd58031c5f1c3766c24d47a82e6fd9c5}} +\index{xb::xbXBase@{xb::xbXBase}!GetMultiUser@{GetMultiUser}} +\index{GetMultiUser@{GetMultiUser}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetMultiUser()}{GetMultiUser()}} +{\footnotesize\ttfamily \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} xb\+::xb\+Ssv\+::\+Get\+Multi\+User (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Get the multi user setting. + +\begin{DoxyReturn}{Returns} +xb\+True -\/ Multi user mode turned on.~\newline + xb\+False -\/ Multi user mode turned off.~\newline + +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbTblMgr_ad0d2d4adabc0dc0e761cfdee63c84069}\label{classxb_1_1xbTblMgr_ad0d2d4adabc0dc0e761cfdee63c84069}} +\index{xb::xbXBase@{xb::xbXBase}!GetOpenTableCount@{GetOpenTableCount}} +\index{GetOpenTableCount@{GetOpenTableCount}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{GetOpenTableCount()}{GetOpenTableCount()}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Tbl\+Mgr\+::\+Get\+Open\+Table\+Count (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbXBase_ab35cec5ac8f0fa95f10653ca7ac817f6}\label{classxb_1_1xbXBase_ab35cec5ac8f0fa95f10653ca7ac817f6}} +\index{xb::xbXBase@{xb::xbXBase}!Open@{Open}} +\index{Open@{Open}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{Open()}{Open()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$ xb\+::xb\+XBase\+::\+Open (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Table\+Name, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Alias, }\item[{xb\+Int16}]{i\+Open\+Mode, }\item[{xb\+Int16}]{i\+Share\+Mode, }\item[{xb\+Int16}]{i\+Request\+Version, }\item[{xb\+Int16 \&}]{i\+Rc }\end{DoxyParamCaption})} + + + +Open highest qualified class available for dbf file. + +This routine can open various versions of the dbf file dependent on the i\+Version field + + +\begin{DoxyParams}{Parameters} +{\em s\+Table\+Name} & -\/ Table name to open. \\ +\hline +{\em s\+Alias} & -\/ Optional alias name. \\ +\hline +{\em i\+Open\+Mode} & -\/ XB\+\_\+\+READ\+\_\+\+WRITE or XB\+\_\+\+READ \\ +\hline +{\em i\+Share\+Mode} & -\/ XB\+\_\+\+SINGLE\+\_\+\+USER or XB\+\_\+\+MULTI\+\_\+\+USER \\ +\hline +{\em i\+Request\+Version} & 0 -\/ Highest available 4 -\/ Version four dbf 3 -\/ Version three dbf \\ +\hline +{\em i\+Rc} & -\/ Return code from open request \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +param dbf -\/ Output pointer to dbf file opened or null if error +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbXBase_aafb1abd6b6124cddf635adaf9f615a4a}\label{classxb_1_1xbXBase_aafb1abd6b6124cddf635adaf9f615a4a}} +\index{xb::xbXBase@{xb::xbXBase}!Open@{Open}} +\index{Open@{Open}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{Open()}{Open()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$ xb\+::xb\+XBase\+::\+Open (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Table\+Name, }\item[{xb\+Int16 \&}]{i\+Rc }\end{DoxyParamCaption})} + + + +Open highest qualified class available for dbf file. + +This routine opens the highest available version of the dbf file. Defaults to XB\+\_\+\+READ\+\_\+\+WRITE and XB\+\_\+\+MULTI\+\_\+\+USER mode. \begin{DoxyReturn}{Returns} +param dbf -\/ Output pointer to dbf file opened or null if error +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbXBase_aa957eb502ecd076e5df89e7415cb094b}\label{classxb_1_1xbXBase_aa957eb502ecd076e5df89e7415cb094b}} +\index{xb::xbXBase@{xb::xbXBase}!OpenHighestVersion@{OpenHighestVersion}} +\index{OpenHighestVersion@{OpenHighestVersion}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{OpenHighestVersion()}{OpenHighestVersion()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Open\+Highest\+Version (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Table\+Name, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Alias, }\item[{\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} \&}]{dbf, }\item[{int}]{dummy }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbXBase_afa7bbac08a4601f49cd53b457196ee0e}\label{classxb_1_1xbXBase_afa7bbac08a4601f49cd53b457196ee0e}} +\index{xb::xbXBase@{xb::xbXBase}!OpenHighestVersion@{OpenHighestVersion}} +\index{OpenHighestVersion@{OpenHighestVersion}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{OpenHighestVersion()}{OpenHighestVersion()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Open\+Highest\+Version (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Table\+Name, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Alias, }\item[{\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$$\ast$}]{dbf }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbTblMgr_ac8eaef41acf08911b90f900aac8e70af}\label{classxb_1_1xbTblMgr_ac8eaef41acf08911b90f900aac8e70af}} +\index{xb::xbXBase@{xb::xbXBase}!RemoveTblFromTblList@{RemoveTblFromTblList}} +\index{RemoveTblFromTblList@{RemoveTblFromTblList}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{RemoveTblFromTblList()}{RemoveTblFromTblList()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Tbl\+Mgr\+::\+Remove\+Tbl\+From\+Tbl\+List (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Tbl\+Alias }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbTblMgr_a3d82b6e73d5c0bc8cac22b9a260389c1}\label{classxb_1_1xbTblMgr_a3d82b6e73d5c0bc8cac22b9a260389c1}} +\index{xb::xbXBase@{xb::xbXBase}!RemoveTblFromTblList@{RemoveTblFromTblList}} +\index{RemoveTblFromTblList@{RemoveTblFromTblList}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{RemoveTblFromTblList()}{RemoveTblFromTblList()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Tbl\+Mgr\+::\+Remove\+Tbl\+From\+Tbl\+List (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{classxb_1_1xbDbf}{xb\+Dbf}} $\ast$}]{d }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbSsv_a57caaaadfbd089d9a58ecfcb50c88a6c}\label{classxb_1_1xbSsv_a57caaaadfbd089d9a58ecfcb50c88a6c}} +\index{xb::xbXBase@{xb::xbXBase}!SetDataDirectory@{SetDataDirectory}} +\index{SetDataDirectory@{SetDataDirectory}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{SetDataDirectory()}{SetDataDirectory()}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Set\+Data\+Directory (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Data\+Directory }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Set the data directory. + + +\begin{DoxyParams}{Parameters} +{\em s\+Data\+Directory} & Set the data direcroty. \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classxb_1_1xbSsv_a25542afadaaf39b4fb5a1772a29cc0bd}\label{classxb_1_1xbSsv_a25542afadaaf39b4fb5a1772a29cc0bd}} +\index{xb::xbXBase@{xb::xbXBase}!SetDefaultAutoCommit@{SetDefaultAutoCommit}} +\index{SetDefaultAutoCommit@{SetDefaultAutoCommit}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{SetDefaultAutoCommit()}{SetDefaultAutoCommit()}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Set\+Default\+Auto\+Commit (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}}}]{b\+Default\+Auto\+Commit }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Set the default auto commit. + +Disabling auto commit requires the application execute explicit updates using dbf-\/\texorpdfstring{$>$}{>}Put() and dbf-\/\texorpdfstring{$>$}{>}Append\+Record(). With auto commit on, the library posts updates automatically when moving off the current record or closing a file. + + +\begin{DoxyParams}{Parameters} +{\em b\+Default\+Auto\+Commit} & xb\+True -\/ Enable default auto commit.~\newline + xb\+False -\/ Disable default auto commit.~\newline + \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classxb_1_1xbSsv_a5f74db23f8902846d581935c7db73f9c}\label{classxb_1_1xbSsv_a5f74db23f8902846d581935c7db73f9c}} +\index{xb::xbXBase@{xb::xbXBase}!SetDefaultDateFormat@{SetDefaultDateFormat}} +\index{SetDefaultDateFormat@{SetDefaultDateFormat}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{SetDefaultDateFormat()}{SetDefaultDateFormat()}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Set\+Default\+Date\+Format (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Default\+Date\+Format }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Set the default date format. + + +\begin{DoxyParams}{Parameters} +{\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}} +\doxysubsubsection{\texorpdfstring{SetEndianType()}{SetEndianType()}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Set\+Endian\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [inherited]}} + + + +Set the endian type. + +This routine determines the Endian-\/ness at run time instead of compile time as some processers (ie; Sparc,ARM) can be switched either way. This routine is called automatically by the library at startup and does not need to be called in an application program. \mbox{\Hypertarget{classxb_1_1xbXBase_a48d82dbe298c6f4cf68a63ac82dd8292}\label{classxb_1_1xbXBase_a48d82dbe298c6f4cf68a63ac82dd8292}} +\index{xb::xbXBase@{xb::xbXBase}!SetLogDirectory@{SetLogDirectory}} +\index{SetLogDirectory@{SetLogDirectory}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{SetLogDirectory()}{SetLogDirectory()}} +{\footnotesize\ttfamily void xb\+::xb\+XBase\+::\+Set\+Log\+Directory (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Log\+File\+Directory }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbXBase_a94010b88a309315ef980715eb581336c}\label{classxb_1_1xbXBase_a94010b88a309315ef980715eb581336c}} +\index{xb::xbXBase@{xb::xbXBase}!SetLogFileName@{SetLogFileName}} +\index{SetLogFileName@{SetLogFileName}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{SetLogFileName()}{SetLogFileName()}} +{\footnotesize\ttfamily void xb\+::xb\+XBase\+::\+Set\+Log\+File\+Name (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Log\+File\+Name }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbXBase_a666a0cb5b76ec7a9a3677d339e0c6b42}\label{classxb_1_1xbXBase_a666a0cb5b76ec7a9a3677d339e0c6b42}} +\index{xb::xbXBase@{xb::xbXBase}!SetLogSize@{SetLogSize}} +\index{SetLogSize@{SetLogSize}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{SetLogSize()}{SetLogSize()}} +{\footnotesize\ttfamily void xb\+::xb\+XBase\+::\+Set\+Log\+Size (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{l\+Size }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbSsv_aba6e59512f7172dd55dcf92059e5928c}\label{classxb_1_1xbSsv_aba6e59512f7172dd55dcf92059e5928c}} +\index{xb::xbXBase@{xb::xbXBase}!SetMultiUser@{SetMultiUser}} +\index{SetMultiUser@{SetMultiUser}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{SetMultiUser()}{SetMultiUser()}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Set\+Multi\+User (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}}}]{b\+Multi\+User }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} + + + +Get the multi user setting. + + +\begin{DoxyParams}{Parameters} +{\em b\+Multi\+User} & xb\+True -\/ Turn on Multi user mode.~\newline + xb\+False -\/ Turn off Multi user mode.~\newline + \\ +\hline +\end{DoxyParams} +\mbox{\Hypertarget{classxb_1_1xbXBase_a0dff00b9ee3c288841e137ca01168116}\label{classxb_1_1xbXBase_a0dff00b9ee3c288841e137ca01168116}} +\index{xb::xbXBase@{xb::xbXBase}!WriteLogBytes@{WriteLogBytes}} +\index{WriteLogBytes@{WriteLogBytes}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{WriteLogBytes()}{WriteLogBytes()}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Write\+Log\+Bytes (\begin{DoxyParamCaption}\item[{xb\+UInt32}]{l\+Cnt, }\item[{const char $\ast$}]{p }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbXBase_a9ca5be73abffd0fdd18bdc799877272a}\label{classxb_1_1xbXBase_a9ca5be73abffd0fdd18bdc799877272a}} +\index{xb::xbXBase@{xb::xbXBase}!WriteLogMessage@{WriteLogMessage}} +\index{WriteLogMessage@{WriteLogMessage}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{WriteLogMessage()}{WriteLogMessage()}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::\+Write\+Log\+Message (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Log\+Message, }\item[{xb\+Int16}]{i\+Output\+Opt = {\ttfamily 0} }\end{DoxyParamCaption})} + +\mbox{\Hypertarget{classxb_1_1xbXBase_a1b239c021358476382942522911b5c66}\label{classxb_1_1xbXBase_a1b239c021358476382942522911b5c66}} +\index{xb::xbXBase@{xb::xbXBase}!xbMemcmp@{xbMemcmp}} +\index{xbMemcmp@{xbMemcmp}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{xbMemcmp()}{xbMemcmp()}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+XBase\+::xb\+Memcmp (\begin{DoxyParamCaption}\item[{const unsigned char $\ast$}]{s1, }\item[{const unsigned char $\ast$}]{s2, }\item[{size\+\_\+t}]{n }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [protected]}} + + + +Cross memcmp function. + + +\begin{DoxyParams}{Parameters} +{\em s1} & Left operand to compare. \\ +\hline +{\em s2} & Right operand to compare. \\ +\hline +{\em n} & Number of bytes to compare. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +1 s1 \texorpdfstring{$>$}{>} s2~\newline + 0 s1 == s2~\newline + -\/1 s1 \texorpdfstring{$<$}{<} s2 +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbXBase_a0915aff7be4b2dd3e881f3c5d0da4baf}\label{classxb_1_1xbXBase_a0915aff7be4b2dd3e881f3c5d0da4baf}} +\index{xb::xbXBase@{xb::xbXBase}!xbSleep@{xbSleep}} +\index{xbSleep@{xbSleep}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{xbSleep()}{xbSleep()}} +{\footnotesize\ttfamily void xb\+::xb\+XBase\+::xb\+Sleep (\begin{DoxyParamCaption}\item[{xb\+Int32}]{l\+Millisecs }\end{DoxyParamCaption})} + + + +Cross platform sleep function. + + +\begin{DoxyParams}{Parameters} +{\em l\+Millisecs} & Milliseconds to sleep. \\ +\hline +\end{DoxyParams} + + +\doxysubsection{Friends And Related Function Documentation} +\mbox{\Hypertarget{classxb_1_1xbXBase_a86a53ce3efbf910996df0f853f1c0add}\label{classxb_1_1xbXBase_a86a53ce3efbf910996df0f853f1c0add}} +\index{xb::xbXBase@{xb::xbXBase}!xbBcd@{xbBcd}} +\index{xbBcd@{xbBcd}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{xbBcd}{xbBcd}} +{\footnotesize\ttfamily friend class xb\+Bcd\hspace{0.3cm}{\ttfamily [friend]}} + +\mbox{\Hypertarget{classxb_1_1xbXBase_a3c3e5617be811d732472fe2cc8fb18cc}\label{classxb_1_1xbXBase_a3c3e5617be811d732472fe2cc8fb18cc}} +\index{xb::xbXBase@{xb::xbXBase}!xbExp@{xbExp}} +\index{xbExp@{xbExp}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{xbExp}{xbExp}} +{\footnotesize\ttfamily friend class xb\+Exp\hspace{0.3cm}{\ttfamily [friend]}} + + + +\doxysubsection{Field Documentation} +\mbox{\Hypertarget{classxb_1_1xbSsv_a6219f1b5e24ea12fe158cd5aea56988e}\label{classxb_1_1xbSsv_a6219f1b5e24ea12fe158cd5aea56988e}} +\index{xb::xbXBase@{xb::xbXBase}!ErrorCodeText@{ErrorCodeText}} +\index{ErrorCodeText@{ErrorCodeText}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{ErrorCodeText}{ErrorCodeText}} +{\footnotesize\ttfamily const char$\ast$ xb\+::xb\+Ssv\+::\+Error\+Code\+Text\mbox{[}$\,$\mbox{]}\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbSsv_a5849e813f5e8e1cd180f0366637adbf3}\label{classxb_1_1xbSsv_a5849e813f5e8e1cd180f0366637adbf3}} +\index{xb::xbXBase@{xb::xbXBase}!iEndianType@{iEndianType}} +\index{iEndianType@{iEndianType}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{iEndianType}{iEndianType}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Ssv\+::i\+Endian\+Type = 0\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [protected]}, {\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbSsv_a9dec3164c3b264882df634915ecf21da}\label{classxb_1_1xbSsv_a9dec3164c3b264882df634915ecf21da}} +\index{xb::xbXBase@{xb::xbXBase}!sNullString@{sNullString}} +\index{sNullString@{sNullString}!xb::xbXBase@{xb::xbXBase}} +\doxysubsubsection{\texorpdfstring{sNullString}{sNullString}} +{\footnotesize\ttfamily \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} xb\+::xb\+Ssv\+::s\+Null\+String = \char`\"{}\char`\"{}\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [protected]}, {\ttfamily [inherited]}} + + + +The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize} +\item +/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+2/src/include/\mbox{\hyperlink{xbxbase_8h}{xbxbase.\+h}}\item +/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+2/src/core/\mbox{\hyperlink{xbxbase_8cpp}{xbxbase.\+cpp}}\end{DoxyCompactItemize} |