diff options
Diffstat (limited to 'docs/doxygen/latex/classxb_1_1xbDbf.tex')
| -rw-r--r-- | docs/doxygen/latex/classxb_1_1xbDbf.tex | 255 |
1 files changed, 190 insertions, 65 deletions
diff --git a/docs/doxygen/latex/classxb_1_1xbDbf.tex b/docs/doxygen/latex/classxb_1_1xbDbf.tex index cf0ac0a..479fc79 100644 --- a/docs/doxygen/latex/classxb_1_1xbDbf.tex +++ b/docs/doxygen/latex/classxb_1_1xbDbf.tex @@ -44,16 +44,16 @@ virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a3067fdfa3a7a5c15651f6e89d11 \begin{DoxyCompactList}\small\item\em Delete all records. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_acd8c10579229f3a2e2c5fdb7fcef90db}{Delete\+Record}} () \begin{DoxyCompactList}\small\item\em Delete the current record. \end{DoxyCompactList}\item -virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ab1f4a515533402f872cedcd0322aabd4}{Dump\+Header}} (xb\+Int16 i\+Option) const -\item -virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a3a6a068addffd06fc9a996639d6ca69e}{Dump\+Record}} (xb\+UInt32 ul\+Rec\+No, xb\+Int16 i\+Output\+Dest=0, xb\+Int16 i\+Output\+Fmt=0) -\item +virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a309b5b1fb6a5c048c4bfb404d011ac55}{Dump\+Header}} (xb\+Int16 i\+Option) const +\begin{DoxyCompactList}\small\item\em Dump dbf file header. \end{DoxyCompactList}\item +virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_aba30399f15885a07f87f904c0d0656fa}{Dump\+Record}} (xb\+UInt32 ul\+Rec\+No, xb\+Int16 i\+Output\+Dest=0, xb\+Int16 i\+Output\+Fmt=0) +\begin{DoxyCompactList}\small\item\em Dump record. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_abb9e20c5efacd4fea80f1515abbc6b55}{Get\+Auto\+Commit}} () const \begin{DoxyCompactList}\small\item\em Get auto commit setting. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ae0c00226fd2ea7a67f101e795467ed68}{Get\+Auto\+Commit}} (xb\+Int16 i\+Option) const \begin{DoxyCompactList}\small\item\em Get auto commit setting. \end{DoxyCompactList}\item virtual xb\+UInt32 \mbox{\hyperlink{classxb_1_1xbDbf_a643a80a3792a52760c8e09ba18719503}{Get\+Cur\+Rec\+No}} () const -\begin{DoxyCompactList}\small\item\em Get Auto Lock setting. \end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Get a pointer to the current index object. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ac1110d867ba297a52c8b0e83e88f05e6}{Get\+Dbf\+Status}} () const \begin{DoxyCompactList}\small\item\em Return the current dbf status. \end{DoxyCompactList}\item virtual xb\+Int32 \mbox{\hyperlink{classxb_1_1xbDbf_add27d8ef555a13b336b8c804165dc15e}{Get\+Field\+Cnt}} () const @@ -72,14 +72,14 @@ virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a3191428a7a92d9107d8d4244888 \begin{DoxyCompactList}\small\item\em Get the next record. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a18fdcb4ab15b36cd47fa6f6f7a540d1a}{Get\+Next\+Record}} (xb\+Int16 i\+Option, xb\+UInt32 ul\+Start\+Rec) \begin{DoxyCompactList}\small\item\em Get the next record. \end{DoxyCompactList}\item -virtual xb\+Int32 \mbox{\hyperlink{classxb_1_1xbDbf_a13393704a8a191d4d6555ae31d3c3e92}{Get\+Physical\+Ix\+Cnt}} () const -\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ab3d248e5221b4f0809897cd43af17a1e}{Get\+Prev\+Record}} () \begin{DoxyCompactList}\small\item\em Get the previous record. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a7eadc7b08d73003802b90584f7b33387}{Get\+Prev\+Record}} (xb\+Int16 i\+Option) \begin{DoxyCompactList}\small\item\em Get the previous record. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a26fba086b07caeab95066bf1c8d25161}{Get\+Record}} (xb\+UInt32 ul\+Rec\+No) \begin{DoxyCompactList}\small\item\em Get record for specified record number. \end{DoxyCompactList}\item +virtual xb\+UInt32 \mbox{\hyperlink{classxb_1_1xbDbf_a0aaa06d6028e75efc6b5131f7356ecce}{Get\+Record\+Count}} () +\begin{DoxyCompactList}\small\item\em Get the current number of records in the dbf data file. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ac196ad55335e1f4789d698748434dc89}{Get\+Record\+Cnt}} (xb\+UInt32 \&ul\+Rec\+Cnt) \begin{DoxyCompactList}\small\item\em Get the current number of records in the dbf data file. \end{DoxyCompactList}\item virtual char $\ast$ \mbox{\hyperlink{classxb_1_1xbDbf_aa3e38c4057d726a28a27d07a1610d124}{Get\+Record\+Buf}} (xb\+Int16 i\+Opt=0) const @@ -92,12 +92,12 @@ virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a49212a9eb17f7fa9f303e08d5fc \item virtual \mbox{\hyperlink{classxb_1_1xbXBase}{xb\+XBase}} $\ast$ \mbox{\hyperlink{classxb_1_1xbDbf_ab21ec23c076b0c9affdc0f6672bd133f}{Get\+Xbase\+Ptr}} () const \begin{DoxyCompactList}\small\item\em Get the pointer to the xb\+Xbase structure,. \end{DoxyCompactList}\item -virtual \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} \mbox{\hyperlink{classxb_1_1xbDbf_ac856fc1b110b46aefa1b2f5c0f530aa2}{Memo\+Fields\+Exist}} () const -\item -virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a97366c7362e409d7f09973a6aef8dad0}{Open}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name) -\item -virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ac658818bf9b8f8ff7467d8d80495b324}{Open}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&\mbox{\hyperlink{classxb_1_1xbDbf_a73f9c792d0a769e2e604c1855245a276}{s\+Alias}}) -\item +virtual \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} \mbox{\hyperlink{classxb_1_1xbDbf_a013dc8c51fc1aa988de39cf3da6da950}{Memo\+Fields\+Exist}} () const +\begin{DoxyCompactList}\small\item\em Check for existence of any memo fields. \end{DoxyCompactList}\item +virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a69824d7bafc3f5a15bf7d09f2f511768}{Open}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name) +\begin{DoxyCompactList}\small\item\em Open a table/dbf file. \end{DoxyCompactList}\item +virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ae388c5e02adc86e6e9988e697e061610}{Open}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&\mbox{\hyperlink{classxb_1_1xbDbf_a73f9c792d0a769e2e604c1855245a276}{s\+Alias}}) +\begin{DoxyCompactList}\small\item\em Open a table/dbf file. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a4d018cbf44d8d8b2145c9acab02c8adf}{Open}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Table\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&\mbox{\hyperlink{classxb_1_1xbDbf_a73f9c792d0a769e2e604c1855245a276}{s\+Alias}}, xb\+Int16 i\+Open\+Mode, xb\+Int16 i\+Share\+Mode)=0 \item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a8a52bf3ef2123c0d17e6b1f67bf0dc55}{Pack}} () @@ -112,10 +112,12 @@ virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a060541addb5bb1f0fe12959ed6f \begin{DoxyCompactList}\small\item\em Read dbf file header information. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a94d7d626ba691fd4b740c034673e6fc6}{Record\+Deleted}} (xb\+Int16 i\+Opt=0) const \begin{DoxyCompactList}\small\item\em Return record deletion status. \end{DoxyCompactList}\item +virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_aeeeb2eb5fabcd0f91d457df07b0e0708}{Rename}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} s\+New\+Name)=0 +\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a4cf7f0d423164f3cf074ae41f96f4e90}{Set\+Auto\+Commit}} (xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ab506450954bc86e7bf1d7c4efe681f43}{i\+Auto\+Commit}}) \begin{DoxyCompactList}\small\item\em Set auto commit. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_ae94cb1bf9f75184f39d9e1a80ab49d4a}{Undelete\+All\+Records}} () -\begin{DoxyCompactList}\small\item\em Undelete all records. \end{DoxyCompactList}\item +\begin{DoxyCompactList}\small\item\em Set auto lock. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a255681976a04fc722538bb630507b3a0}{Undelete\+Record}} () \begin{DoxyCompactList}\small\item\em Undelete one record. \end{DoxyCompactList}\item virtual xb\+Int16 \mbox{\hyperlink{classxb_1_1xbDbf_a8ed0693b10b95aaa4e46037758d160ed}{Zap}} () @@ -342,8 +344,6 @@ xb\+Int16 \mbox{\hyperlink{classxb_1_1xbFile_ab3c668a8570433188382d31d7c60bd48}{ \begin{DoxyCompactList}\small\item\em Delete file. \end{DoxyCompactList}\item xb\+Int16 \mbox{\hyperlink{classxb_1_1xbFile_afc8ce113aa72611a278233f9bb170012}{xb\+Rename}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Old\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+New\+Name) \begin{DoxyCompactList}\small\item\em Rename file. \end{DoxyCompactList}\item -xb\+Int16 \mbox{\hyperlink{classxb_1_1xbFile_ab0b2a2c88947921d98ebcb5b5ec34ed9}{xb\+Rename}} (const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+Old\+Name, const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&s\+New\+Name, xb\+Int16 i\+Option) -\begin{DoxyCompactList}\small\item\em Rename file. \end{DoxyCompactList}\item void \mbox{\hyperlink{classxb_1_1xbFile_a7996b6e084665c37c3892faea64b3505}{xb\+Rewind}} () \begin{DoxyCompactList}\small\item\em Xbase wrapper for rewind. \end{DoxyCompactList}\item xb\+Int16 \mbox{\hyperlink{classxb_1_1xbFile_a518bfcbfa3699d883cf89affee383296}{xb\+Truncate}} (xb\+Int64 ll\+Size) @@ -366,6 +366,10 @@ void \mbox{\hyperlink{classxb_1_1xbSsv_a5f74db23f8902846d581935c7db73f9c}{Set\+D \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 +void \mbox{\hyperlink{classxb_1_1xbSsv_a8551b15a3ce4fa2a40d698db01f4a9ae}{Bit\+Dump}} (unsigned char c) const +\item +void \mbox{\hyperlink{classxb_1_1xbSsv_aba1395b8e4c7f28c3614061de6e49190}{Bit\+Dump}} (char c) const +\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) @@ -550,6 +554,18 @@ Note\+: Locking memo files is not needed as the memo file updates are handled ou \begin{DoxyReturn}{Returns} \href{xbretcod_8h.html}{\texttt{ Return Codes}} \end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbSsv_aba1395b8e4c7f28c3614061de6e49190}\label{classxb_1_1xbSsv_aba1395b8e4c7f28c3614061de6e49190}} +\index{xb::xbDbf@{xb::xbDbf}!BitDump@{BitDump}} +\index{BitDump@{BitDump}!xb::xbDbf@{xb::xbDbf}} +\doxysubsubsection{\texorpdfstring{BitDump()}{BitDump()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Bit\+Dump (\begin{DoxyParamCaption}\item[{char}]{c }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + +\mbox{\Hypertarget{classxb_1_1xbSsv_a8551b15a3ce4fa2a40d698db01f4a9ae}\label{classxb_1_1xbSsv_a8551b15a3ce4fa2a40d698db01f4a9ae}} +\index{xb::xbDbf@{xb::xbDbf}!BitDump@{BitDump}} +\index{BitDump@{BitDump}!xb::xbDbf@{xb::xbDbf}} +\doxysubsubsection{\texorpdfstring{BitDump()}{BitDump()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} +{\footnotesize\ttfamily void xb\+::xb\+Ssv\+::\+Bit\+Dump (\begin{DoxyParamCaption}\item[{unsigned char}]{c }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}} + \mbox{\Hypertarget{classxb_1_1xbSsv_a62e4fd0a5888665c76bbbad962794e72}\label{classxb_1_1xbSsv_a62e4fd0a5888665c76bbbad962794e72}} \index{xb::xbDbf@{xb::xbDbf}!BitSet@{BitSet}} \index{BitSet@{BitSet}!xb::xbDbf@{xb::xbDbf}} @@ -845,18 +861,58 @@ Display error message on console for a given error number. {\em i\+Error\+Code} & Error number to reference \\ \hline \end{DoxyParams} -\mbox{\Hypertarget{classxb_1_1xbDbf_ab1f4a515533402f872cedcd0322aabd4}\label{classxb_1_1xbDbf_ab1f4a515533402f872cedcd0322aabd4}} +\mbox{\Hypertarget{classxb_1_1xbDbf_a309b5b1fb6a5c048c4bfb404d011ac55}\label{classxb_1_1xbDbf_a309b5b1fb6a5c048c4bfb404d011ac55}} \index{xb::xbDbf@{xb::xbDbf}!DumpHeader@{DumpHeader}} \index{DumpHeader@{DumpHeader}!xb::xbDbf@{xb::xbDbf}} \doxysubsubsection{\texorpdfstring{DumpHeader()}{DumpHeader()}} -{\footnotesize\ttfamily virtual xb\+Int16 xb\+::xb\+Dbf\+::\+Dump\+Header (\begin{DoxyParamCaption}\item[{xb\+Int16}]{i\+Option }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Dbf\+::\+Dump\+Header (\begin{DoxyParamCaption}\item[{xb\+Int16}]{i\+Option }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}} + + + +Dump dbf file header. -\mbox{\Hypertarget{classxb_1_1xbDbf_a3a6a068addffd06fc9a996639d6ca69e}\label{classxb_1_1xbDbf_a3a6a068addffd06fc9a996639d6ca69e}} +This routine dumps dbf header information to the console. + + +\begin{DoxyParams}{Parameters} +{\em i\+Option} & 1 = Print header only~\newline + 2 = Field data only~\newline + 3 = Header and Field data~\newline + 4 = Header, Field and Memo header data if applicable \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +\href{xbretcod_8h.html}{\texttt{ Return Codes}} +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbDbf_aba30399f15885a07f87f904c0d0656fa}\label{classxb_1_1xbDbf_aba30399f15885a07f87f904c0d0656fa}} \index{xb::xbDbf@{xb::xbDbf}!DumpRecord@{DumpRecord}} \index{DumpRecord@{DumpRecord}!xb::xbDbf@{xb::xbDbf}} \doxysubsubsection{\texorpdfstring{DumpRecord()}{DumpRecord()}} -{\footnotesize\ttfamily virtual xb\+Int16 xb\+::xb\+Dbf\+::\+Dump\+Record (\begin{DoxyParamCaption}\item[{xb\+UInt32}]{ul\+Rec\+No, }\item[{xb\+Int16}]{i\+Output\+Dest = {\ttfamily 0}, }\item[{xb\+Int16}]{i\+Output\+Fmt = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Dbf\+::\+Dump\+Record (\begin{DoxyParamCaption}\item[{xb\+UInt32}]{ul\+Rec\+No, }\item[{xb\+Int16}]{i\+Output\+Dest = {\ttfamily 0}, }\item[{xb\+Int16}]{i\+Output\+Fmt = {\ttfamily 0} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} + + +Dump record. + +Dump the contents of the specified record + + +\begin{DoxyParams}{Parameters} +{\em ul\+Rec\+No} & Record number of record to be dumped. \\ +\hline +{\em i\+Output\+Dest} & 0 = stdout~\newline + 1 = Syslog~\newline + 2 = Both~\newline +\\ +\hline +{\em i\+Output\+Fmt} & 0 = with field names~\newline + 1 = 1 line per rec, no field names~\newline + 2 = 1 line per rec, first line is a list of field names. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +\href{xbretcod_8h.html}{\texttt{ Return Codes}} +\end{DoxyReturn} \mbox{\Hypertarget{classxb_1_1xbFile_ab14e4a11427f5efb81cba1dd32bd1aa1}\label{classxb_1_1xbFile_ab14e4a11427f5efb81cba1dd32bd1aa1}} \index{xb::xbDbf@{xb::xbDbf}!eGetDouble@{eGetDouble}} \index{eGetDouble@{eGetDouble}!xb::xbDbf@{xb::xbDbf}} @@ -1208,12 +1264,7 @@ Block Size -Get Auto Lock setting. - -\begin{DoxyReturn}{Returns} -Auto lock setting. -\end{DoxyReturn} -Get a pointer to the current index object. +Get a pointer to the current index object. \begin{DoxyReturn}{Returns} Pointer to current index. @@ -2385,12 +2436,6 @@ XB\+\_\+\+READ~\newline XB\+\_\+\+WRITE~\newline \end{DoxyReturn} -\mbox{\Hypertarget{classxb_1_1xbDbf_a13393704a8a191d4d6555ae31d3c3e92}\label{classxb_1_1xbDbf_a13393704a8a191d4d6555ae31d3c3e92}} -\index{xb::xbDbf@{xb::xbDbf}!GetPhysicalIxCnt@{GetPhysicalIxCnt}} -\index{GetPhysicalIxCnt@{GetPhysicalIxCnt}!xb::xbDbf@{xb::xbDbf}} -\doxysubsubsection{\texorpdfstring{GetPhysicalIxCnt()}{GetPhysicalIxCnt()}} -{\footnotesize\ttfamily virtual xb\+Int32 xb\+::xb\+Dbf\+::\+Get\+Physical\+Ix\+Cnt (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}} - \mbox{\Hypertarget{classxb_1_1xbDbf_ab3d248e5221b4f0809897cd43af17a1e}\label{classxb_1_1xbDbf_ab3d248e5221b4f0809897cd43af17a1e}} \index{xb::xbDbf@{xb::xbDbf}!GetPrevRecord@{GetPrevRecord}} \index{GetPrevRecord@{GetPrevRecord}!xb::xbDbf@{xb::xbDbf}} @@ -2514,6 +2559,19 @@ Get the current number of records in the dbf data file. \begin{DoxyReturn}{Returns} \href{xbretcod_8h.html}{\texttt{ Return Codes}} \end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbDbf_a0aaa06d6028e75efc6b5131f7356ecce}\label{classxb_1_1xbDbf_a0aaa06d6028e75efc6b5131f7356ecce}} +\index{xb::xbDbf@{xb::xbDbf}!GetRecordCount@{GetRecordCount}} +\index{GetRecordCount@{GetRecordCount}!xb::xbDbf@{xb::xbDbf}} +\doxysubsubsection{\texorpdfstring{GetRecordCount()}{GetRecordCount()}} +{\footnotesize\ttfamily xb\+UInt32 xb\+::xb\+Dbf\+::\+Get\+Record\+Count (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} + + + +Get the current number of records in the dbf data file. + +\begin{DoxyReturn}{Returns} +Record count or \href{xbretcod_8h.html}{\texttt{ Return Codes}} +\end{DoxyReturn} \mbox{\Hypertarget{classxb_1_1xbDbf_ab50d76c6e29e81e347a6feb04c2f62bb}\label{classxb_1_1xbDbf_ab50d76c6e29e81e347a6feb04c2f62bb}} \index{xb::xbDbf@{xb::xbDbf}!GetRecordLen@{GetRecordLen}} \index{GetRecordLen@{GetRecordLen}!xb::xbDbf@{xb::xbDbf}} @@ -2700,12 +2758,20 @@ Pointer to xb\+Xbase structure. \doxysubsubsection{\texorpdfstring{InitVars()}{InitVars()}} {\footnotesize\ttfamily void xb\+::xb\+Dbf\+::\+Init\+Vars (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [protected]}, {\ttfamily [virtual]}} -\mbox{\Hypertarget{classxb_1_1xbDbf_ac856fc1b110b46aefa1b2f5c0f530aa2}\label{classxb_1_1xbDbf_ac856fc1b110b46aefa1b2f5c0f530aa2}} +\mbox{\Hypertarget{classxb_1_1xbDbf_a013dc8c51fc1aa988de39cf3da6da950}\label{classxb_1_1xbDbf_a013dc8c51fc1aa988de39cf3da6da950}} \index{xb::xbDbf@{xb::xbDbf}!MemoFieldsExist@{MemoFieldsExist}} \index{MemoFieldsExist@{MemoFieldsExist}!xb::xbDbf@{xb::xbDbf}} \doxysubsubsection{\texorpdfstring{MemoFieldsExist()}{MemoFieldsExist()}} -{\footnotesize\ttfamily virtual \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} xb\+::xb\+Dbf\+::\+Memo\+Fields\+Exist (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily \mbox{\hyperlink{namespacexb_ab1a750481dd487f0d384aa1d200dff0f}{xb\+Bool}} xb\+::xb\+Dbf\+::\+Memo\+Fields\+Exist (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}} + + +Check for existence of any memo fields. + +\begin{DoxyReturn}{Returns} +xb\+True -\/ Memo fields exist.~\newline +xb\+False -\/ Memo fields don\textquotesingle{}t exist. +\end{DoxyReturn} \mbox{\Hypertarget{classxb_1_1xbFile_a361e3cc318bbf1c4d10f069e0800a24e}\label{classxb_1_1xbFile_a361e3cc318bbf1c4d10f069e0800a24e}} \index{xb::xbDbf@{xb::xbDbf}!NameSuffixMissing@{NameSuffixMissing}} \index{NameSuffixMissing@{NameSuffixMissing}!xb::xbDbf@{xb::xbDbf}} @@ -2734,18 +2800,46 @@ Determines status of file extension. 2 is suffix not found, upper case~\newline \end{DoxyReturn} -\mbox{\Hypertarget{classxb_1_1xbDbf_a97366c7362e409d7f09973a6aef8dad0}\label{classxb_1_1xbDbf_a97366c7362e409d7f09973a6aef8dad0}} +\mbox{\Hypertarget{classxb_1_1xbDbf_a69824d7bafc3f5a15bf7d09f2f511768}\label{classxb_1_1xbDbf_a69824d7bafc3f5a15bf7d09f2f511768}} \index{xb::xbDbf@{xb::xbDbf}!Open@{Open}} \index{Open@{Open}!xb::xbDbf@{xb::xbDbf}} \doxysubsubsection{\texorpdfstring{Open()}{Open()}\hspace{0.1cm}{\footnotesize\ttfamily [1/3]}} -{\footnotesize\ttfamily virtual xb\+Int16 xb\+::xb\+Dbf\+::\+Open (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Table\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Dbf\+::\+Open (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Table\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} + -\mbox{\Hypertarget{classxb_1_1xbDbf_ac658818bf9b8f8ff7467d8d80495b324}\label{classxb_1_1xbDbf_ac658818bf9b8f8ff7467d8d80495b324}} + +Open a table/dbf file. + +This routine sets the alias name to the same as the table name. + + +\begin{DoxyParams}{Parameters} +{\em s\+Table\+Name} & Table name to open, Include the .dbf or .DBF extension. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +\href{xbretcod_8h.html}{\texttt{ Return Codes}} +\end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbDbf_ae388c5e02adc86e6e9988e697e061610}\label{classxb_1_1xbDbf_ae388c5e02adc86e6e9988e697e061610}} \index{xb::xbDbf@{xb::xbDbf}!Open@{Open}} \index{Open@{Open}!xb::xbDbf@{xb::xbDbf}} \doxysubsubsection{\texorpdfstring{Open()}{Open()}\hspace{0.1cm}{\footnotesize\ttfamily [2/3]}} -{\footnotesize\ttfamily virtual xb\+Int16 xb\+::xb\+Dbf\+::\+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 }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} +{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+Dbf\+::\+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 }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} + + +Open a table/dbf file. + + +\begin{DoxyParams}{Parameters} +{\em s\+Table\+Name} & Table name to open, Include the .dbf or .DBF extension. \\ +\hline +{\em s\+Alias} & Alias name to assign to this entry. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +\href{xbretcod_8h.html}{\texttt{ Return Codes}} +\end{DoxyReturn} \mbox{\Hypertarget{classxb_1_1xbDbf_a4d018cbf44d8d8b2145c9acab02c8adf}\label{classxb_1_1xbDbf_a4d018cbf44d8d8b2145c9acab02c8adf}} \index{xb::xbDbf@{xb::xbDbf}!Open@{Open}} \index{Open@{Open}!xb::xbDbf@{xb::xbDbf}} @@ -3323,6 +3417,12 @@ This routine returns the record deletion status. xb\+True -\/ Record deleted.~\newline xb\+False -\/ Record not deleted. \end{DoxyReturn} +\mbox{\Hypertarget{classxb_1_1xbDbf_aeeeb2eb5fabcd0f91d457df07b0e0708}\label{classxb_1_1xbDbf_aeeeb2eb5fabcd0f91d457df07b0e0708}} +\index{xb::xbDbf@{xb::xbDbf}!Rename@{Rename}} +\index{Rename@{Rename}!xb::xbDbf@{xb::xbDbf}} +\doxysubsubsection{\texorpdfstring{Rename()}{Rename()}} +{\footnotesize\ttfamily virtual xb\+Int16 xb\+::xb\+Dbf\+::\+Rename (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}}}]{s\+New\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}} + \mbox{\Hypertarget{classxb_1_1xbDbf_a4cf7f0d423164f3cf074ae41f96f4e90}\label{classxb_1_1xbDbf_a4cf7f0d423164f3cf074ae41f96f4e90}} \index{xb::xbDbf@{xb::xbDbf}!SetAutoCommit@{SetAutoCommit}} \index{SetAutoCommit@{SetAutoCommit}!xb::xbDbf@{xb::xbDbf}} @@ -3500,7 +3600,54 @@ Get the multi user setting. -Undelete all records. +Set auto lock. + +This routine sets the auto lock setting for this table. There is an overall system level auto lock default setting and each table can have it\textquotesingle{}s own autolock setting. This method controls the table level auto lock setting. + + +\begin{DoxyParams}{Parameters} +{\em i\+Auto\+Lock} & 1 -\/ Use auto lock for this table.~\newline + 0 -\/ Don\textquotesingle{}t use auto lock for this table.~\newline + -\/1 -\/ (minus one) Use system default.~\newline + \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +\href{xbretcod_8h.html}{\texttt{ Return Codes}} +\end{DoxyReturn} +Set the header locked status. + + +\begin{DoxyParams}{Parameters} +{\em b\+Header\+Locked} & xb\+True -\/ Locked~\newline +xb\+False -\/ Not locked. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +void +\end{DoxyReturn} +Set lock flavor. + +This routine is for future expansion. +\begin{DoxyParams}{Parameters} +{\em i\+Lock\+Flavor} & 1 -\/ Use Dbase (tm) style locking. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +void +\end{DoxyReturn} +Set table locked status. + + +\begin{DoxyParams}{Parameters} +{\em b\+Table\+Locked} & -\/ xb\+True Table locked.~\newline +xb\+False Table unlocked. \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +void +\end{DoxyReturn} +Undelete all records. This routine will remove the deletion flag on any deleted records in the table. \begin{DoxyReturn}{Returns} \href{xbretcod_8h.html}{\texttt{ Return Codes}} @@ -3968,7 +4115,7 @@ Delete file. \mbox{\Hypertarget{classxb_1_1xbFile_afc8ce113aa72611a278233f9bb170012}\label{classxb_1_1xbFile_afc8ce113aa72611a278233f9bb170012}} \index{xb::xbDbf@{xb::xbDbf}!xbRename@{xbRename}} \index{xbRename@{xbRename}!xb::xbDbf@{xb::xbDbf}} -\doxysubsubsection{\texorpdfstring{xbRename()}{xbRename()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} +\doxysubsubsection{\texorpdfstring{xbRename()}{xbRename()}} {\footnotesize\ttfamily xb\+Int16 xb\+::xb\+File\+::xb\+Rename (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Old\+Name, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+New\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} @@ -3985,28 +4132,6 @@ Rename file. \begin{DoxyReturn}{Returns} \href{xbretcod_8h.html}{\texttt{ Return Codes}} \end{DoxyReturn} -\mbox{\Hypertarget{classxb_1_1xbFile_ab0b2a2c88947921d98ebcb5b5ec34ed9}\label{classxb_1_1xbFile_ab0b2a2c88947921d98ebcb5b5ec34ed9}} -\index{xb::xbDbf@{xb::xbDbf}!xbRename@{xbRename}} -\index{xbRename@{xbRename}!xb::xbDbf@{xb::xbDbf}} -\doxysubsubsection{\texorpdfstring{xbRename()}{xbRename()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} -{\footnotesize\ttfamily xb\+Int16 xb\+::xb\+File\+::xb\+Rename (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+Old\+Name, }\item[{const \mbox{\hyperlink{classxb_1_1xbString}{xb\+String}} \&}]{s\+New\+Name, }\item[{xb\+Int16}]{i\+Option }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}} - - - -Rename file. - - -\begin{DoxyParams}{Parameters} -{\em s\+Old\+Name} & Original file name \\ -\hline -{\em s\+New\+Name} & New file name \\ -\hline -{\em i\+Option} & If Set to 1, assume this is a rename request for a dbf file, and should rename the dbt file also \\ -\hline -\end{DoxyParams} -\begin{DoxyReturn}{Returns} -\href{xbretcod_8h.html}{\texttt{ Return Codes}} -\end{DoxyReturn} \mbox{\Hypertarget{classxb_1_1xbFile_a7996b6e084665c37c3892faea64b3505}\label{classxb_1_1xbFile_a7996b6e084665c37c3892faea64b3505}} \index{xb::xbDbf@{xb::xbDbf}!xbRewind@{xbRewind}} \index{xbRewind@{xbRewind}!xb::xbDbf@{xb::xbDbf}} @@ -4199,6 +4324,6 @@ This routine eliminates everything from the dbf file and dbt memo file. \begin{D 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{xbdbf_8h}{xbdbf.\+h}}\item -/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+2/src/core/\mbox{\hyperlink{xbdbf_8cpp}{xbdbf.\+cpp}}\item -/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+2/src/core/\mbox{\hyperlink{xbfields_8cpp}{xbfields.\+cpp}}\end{DoxyCompactItemize} +/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+3/src/include/\mbox{\hyperlink{xbdbf_8h}{xbdbf.\+h}}\item +/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+3/src/core/\mbox{\hyperlink{xbdbf_8cpp}{xbdbf.\+cpp}}\item +/mnt/1\+Tdata/xbase/xbase64-\/4.\+0.\+3/src/core/\mbox{\hyperlink{xbfields_8cpp}{xbfields.\+cpp}}\end{DoxyCompactItemize} |