diff options
Diffstat (limited to 'docs/html')
-rwxr-xr-x | docs/html/index.html | 8 | ||||
-rwxr-xr-x | docs/html/xbac.html | 13 | ||||
-rwxr-xr-x | docs/html/xbae.html | 6 | ||||
-rwxr-xr-x | docs/html/xbc15.html | 127 | ||||
-rwxr-xr-x | docs/html/xbc16.html | 52 | ||||
-rwxr-xr-x | docs/html/xbc17.html | 219 | ||||
-rwxr-xr-x | docs/html/xbc18.html | 252 |
7 files changed, 627 insertions, 50 deletions
diff --git a/docs/html/index.html b/docs/html/index.html index 098c7ea..0e8db33 100755 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -2,7 +2,7 @@ <HTML><TITLE>Xbase DBMS Documentation Table of Contents</TITLE> <BODY BGCOLOR=#FFFFFF> <H1><p align="center">Xbase DBMS<br> -Last Updated 12/21/22<br>Version 4.0.3</p></H1> +Last Updated 2/11/23<br>Version 4.1.0</p></H1> <h2>Documentation Table Of Contents</h2> <h3>Section 1 - Xbase Concepts</h3> <h4> @@ -20,12 +20,14 @@ Last Updated 12/21/22<br>Version 4.0.3</p></H1> <A HREF="xbc12.html">Chapter 12 - Record and File Locking</A><br> <A HREF="xbc13.html">Chapter 13 - Logfile Support</A><br> <A HREF="xbc14.html">Chapter 14 - SQL Support</A><br> - +<A HREF="xbc15.html">Chapter 15 - Sequential Block Read</A><br> </h4> <h3>Section 2 - Classes and Objects</h3> <h4> -<A HREF="xbc15.html">Chapter 15 - General Class Information</A><br> +<A HREF="xbc16.html">Chapter 16 - General Class Information</A><br> +<A HREF="xbc17.html">Chapter 17 - Class xbSsv - Shared System Values</A><br> +<A HREF="xbc18.html">Chapter 18 - Class xbXBase - The class that links it all together</A><br> </h4> <h3>Section 3 - Appendices</h3> diff --git a/docs/html/xbac.html b/docs/html/xbac.html index 0b0fb0b..e022890 100755 --- a/docs/html/xbac.html +++ b/docs/html/xbac.html @@ -3,7 +3,7 @@ <TITLE>Xbase DBMS Appendix C</TITLE> <BODY BGCOLOR=#FFFFFF> <H2><p align="center">Library Build Compile Options</p></H2> -<p align="center">Chapter Updated 12/09/22</p><hr> +<p align="center">Chapter Updated 2/1/23</p><hr> @@ -26,9 +26,10 @@ <TR><TD>XB_EXPRESSION_SUPPORT</TD><TD>Include Expression support?</TD><TD>Prereq: XB_FUNCTION_SUPPORT<br>and XB_LINKLIST_SUPPORT</TD></TR> <TR><TD>XB_NDX_SUPPORT</TD><TD>Include NDX Index support?</TD><TD>Prereq: XB_EXPRESSION_SUPPORT</TD></TR> <TR><TD>XB_MDX_SUPPORT</TD><TD>Include MDX Index support?</TD><TD>Prereq: XB_EXPRESSION_SUPPORT</TD></TR> -<TR><TD>XB_SQL_SUPPORT</TD><TD>Include SQL support?</TD><TD>Prereq: XB_MEMO_SUPPORT<br>and XB_DBF4_SUPPORT</TR> +<TR><TD>XB_SQL_SUPPORT</TD><TD>Include SQL support?</TD><TD>Prereq: XB_MEMO_SUPPORT<br>and XB_DBF4_SUPPORT<br>and XB_BLOCKREAD_SUPPORT<br>and XB_EXPRESSION_SUPPORT</TR> <TR><TD>XB_INF_SUPPORT</TD><TD>Include INF support (Provides auto open functions for NDX indices)</TD></TR> <TR><TD>XB_FILTER_SUPPORT</TD><TD>Include Filter support</TD><TD>Prereq: XB_EXPRESSION_SUPPORT</TD></TR> +<TR><TD>XB_BLOCKREAD_SUPPORT</TD><TD>Include Block Read support</TD></TR> </TABLE></center> @@ -66,8 +67,10 @@ verify there is a <em>CmakeLists.txt</em> file. That file is the main librbary <br><br><br> <hr><br><br><br> <center><h2>Debug Support <em>(Option: XB_DEBUG_SUPPORT)</em></h2></center> -The following methods are included from the library when the XB_DEBUG_OPTION is turned on. They -are mainly used for library debugging purposes and can be safely left turned off.<br><br> +The following methods are included in the build when the XB_DEBUG_OPTION is turned on and are mainly used for library debugging purposes. +The option can be safely left turned off.<br> +The <em>dump</em> routines print output to sdtout or an open log file.<br><br><br> + <center><table border=1> <TR><TH>Method/Function</TH><TH>Description</TH></TR> <tr><td>xbDate::Dump()</td><td>Dump the xbDate object internals to stdout</td></tr> @@ -77,6 +80,7 @@ are mainly used for library debugging purposes and can be safely left turned off <tr><td>xbExp::DumpTree()</td><td>Dump expression token tree</td></tr> <tr><td>xbExpNode::DumpToken()</td><td>Dump expression node values</td></tr> <tr><td>xbFile::DumpBlockToDisk</td><td>Dump specified block of data to a disk file</td></tr> +<tr><td>xbFile::DumpMemToDisk</td><td>Dump specified memory to a disk file</td></tr> <tr><td>xbIx::DumpNode</td><td>Dump index node header</td></tr> <tr><td>xbIxMdx::DumpBlock</td><td>Dump MDX index block</td></tr> <tr><td>xbIxMdx::DumpFreeBlocks</td><td>Dump MDX free block chain</td></tr> @@ -93,6 +97,7 @@ are mainly used for library debugging purposes and can be safely left turned off <tr><td>xbMemoDbt4::DumpMemoInternals()</td><td>Dump V4 memo file internals</td></tr> <tr><td>xbString::Dump()</td><td>Dump string internals</td></tr> <tr><td>xbString::DumpHex()</td><td>Dump string internals in hex</td></tr> +<tr><td>xbBlockRead::DumpReadBlockInternals</td><td>Dump sequential read block internals</td></tr> </table></center> diff --git a/docs/html/xbae.html b/docs/html/xbae.html index 5f1dce6..e860911 100755 --- a/docs/html/xbae.html +++ b/docs/html/xbae.html @@ -3,7 +3,7 @@ <TITLE>Xbase DBMS Appendix E</TITLE> <BODY BGCOLOR=#FFFFFF> <H2><p align="center">Eror Codes</p></H2> -<p align="center">Chapter Updated 12/09/22</p><hr> +<p align="center">Chapter Updated 1/31/23</p><hr> <h3>Error Codes and Error Processing</h3> @@ -55,11 +55,13 @@ Error codes are defined in the xbretcod.h file.<br><br><br> <TR><TD> XB_BOF </TD><TD> -215 </TD><TD> file </TD></TR> <TR><TD> XB_INVALID_BLOCK_SIZE </TD><TD> -216 </TD><TD> file </TD></TR> <TR><TD> XB_INVALID_BLOCK_NO </TD><TD> -217 </TD><TD> file </TD></TR> -<TR><TD> XB_INVALID_RECORD </TD><TD> -218 </TD><TD> file </TD></TR> +<TR><TD> XB_INVALID_RECORD </TD><TD> -218 </TD><TD> file </TD></TR> <TR><TD> XB_DELETE_FAILED </TD><TD> -219 </TD><TD> file </TD></TR> <TR><TD> XB_INVALID_TABLE_NAME </TD><TD> -220 </TD><TD> file </TD></TR> <TR><TD> XB_EMPTY </TD><TD> -221 </TD><TD> file </TD></TR> <TR><TD> XB_LIMIT_REACHED </TD><TD> -222 </TD><TD> file </TD></TR> +<TR><TD> XB_BLOCKREAD_NOT_ENABLED </TD><TD> -223 </TD><TD> file </TD></TR> +<TR><TD> XB_DIRECTORY_ERROR </TD><TD> -224 </TD><TD file </TD></TR> <TR><TD> XB_INVALID_FIELD_TYPE </TD><TD> -300 </TD><TD> field </TD></TR> <TR><TD> XB_INVALID_FIELD_NO </TD><TD> -301 </TD><TD> field </TD></TR> <TR><TD> XB_INVALID_DATA </TD><TD> -302 </TD><TD> field </TD></TR> diff --git a/docs/html/xbc15.html b/docs/html/xbc15.html index 136724d..fde33b8 100755 --- a/docs/html/xbc15.html +++ b/docs/html/xbc15.html @@ -1,51 +1,96 @@ + <!DOCTYPE HTML PUBLIC> <HTML> <TITLE>Xbase DBMS Chapter 15</TITLE> <BODY BGCOLOR=#FFFFFF> -<H2><p align="center">Class Inventory</p></H2> -<p align="center">Chapter Updated 12/24/22</p><hr> -<br> -<center><h3>Class Descriptions</h3></center> - -<center> -<table border=1> -<tr><th>Class</th><th>Description</th></tr> -<tr><td>xbBcd</td><td>Supports binary coded deciemal data</td></tr> -<tr><td>xbDate</td><td>Support date operations on a given date formatted as YYYYMMDD</td></tr> -<tr><td>xbDbf</td><td>Base class for DBF file handling. If you are adding support for a new file type, <br>derive new file type class from this.</td></tr> -<tr><td>xbDbf3</td><td>Derived from xbDbf, supports DBase V3 files</td></tr> -<tr><td>xbDbf4</td><td>Derived from xbDbf, supports DBase V4 files</td></tr> -<tr><td>xbExp</td><td>Class for supporting expression logic</td></tr> -<tr><td>xbExpNode</td><td>Class definition of a single node, utilized by xbExp</td></tr> -<tr><td>xbFile</td><td>Main file class. If you are porting this library to another platform, start here</td></tr> -<tr><td>xbFilter</td><td>Supports filters</td></tr> -<tr><td>xbIx</td><td>Base class for index file support. If you are adding support for a new index type, <br>derive new index type class from this.</td></tr> -<tr><td>xbIxNdx</td><td>Derived from xbIx, supports NDX style indices.</td></tr> -<tr><td>xbIxMdx</td><td>Derived from xbIx, supports MDX style indices</td></tr> -<tr><td>xbLinkList</td><td>Class supporting linked list functionality</td></tr> -<tr><td>xbLinkListOrd</td><td>Class supporting ordered linked list functionality</td></tr> -<tr><td>xbLinkListNode</td><td>Class defining one node, used by xbLinkList and xbLinkListOrd</td></tr> -<tr><td>xbLog</td><td>Class supporting general log file activity</td></tr> -<tr><td>xbMemo</td><td>Base class for supporting memo (.DBT) files. If you are adding support for a new memo type, <br>derive new memo type class from this.</td></tr> -<tr><td>xbMemoDbt3</td><td>Derived from xbMemo, supports V3 Memo files</td></tr> -<tr><td>xbMemoDbt4</td><td>Derived from xbMemo, supports V3 Memo files</td></tr> -<tr><td>xbSql</td><td>Supports SQL access</td></tr> -<tr><td>xbSsv</td><td>Base class, shared system values</td></tr> -<tr><td>xbString</td><td>String handling class</td></tr> -<tr><td>xbTag</td><td>Class to support index tags</td></tr> -<tr><td>xbTblMgr</td><td>Class used internally in the library for managing multiple open files/tables</td></tr> -<tr><td>xbUda</td><td>Class for supporting fields for the xbSql functions. Stands for User data area</td></tr> -<tr><td>xbXBase</td><td>Class to tie everything together. Every application program starts with one of these</td></tr> -</table> -</center> +<H2><p align="center">Block Read Functionality</p></H2> +<p align="center">Chapter Updated 2/1/23</p><hr> -<hr> -<br><br> -Fix me... -<p><img src="Xbase64ClassDiagram.jpg"><br> +<h3>Block Reads</h3> + +As of release 4.1.1, the Xbase library includes functionality for reading a DBF file in blocks, rather than one record at a time.<br><br> + +This functionality can be used to improve application performance in situations where a data file is being read sequentially. +For situations where records are retrieved randomly from the file, enabling this probably won't help much. In short, this +can be turned on when accessing a file sequentially and should be left off when not processing sequentially.<br><br> + +The logic is all handled internally within the library, all that is needed is to enable it and the library handles the rest.<br><br> + +<h3>One Caveat</h3> +This functionality was originally designed with reporting in mind and doesn't currently have any auto locking associated with it. <br><br> + + +<h3>Sample Code</h3> +See example code below for how to enable and disable the feature. + + +<hr> + +#include "xbase.h"<br> +using namespace xb;<br> +<br> +int main(int ac,char** av)<br> +{<br> + xbXBase x;<br> + xbInt16 iRc;<br> + x.EnableMsgLogging();<br> + x.SetLogSize( 1000000L );<br> +<br> + if (ac <= 1) {<br> + std::cout << "Usage: xb_dumprecs filename..." << std::endl;<br> + return 1;<br> + }<br> +<br> + xbDbf *MyFile = NULL;<br> + if(( iRc = x.OpenHighestVersion( av[1], "", &MyFile )) != XB_NO_ERROR ){<br> + std::cout << "Could not open file iRc = " << iRc << " file = " << av[1] << std::endl;<br> + x.DisplayError( iRc );<br> + return 0;<br> + }<br> +<br> +// std::cout << "Processing file sequentially from beginning..." << std::endl;<br> +<br> +<br> +<b> + // turn on Block Read Processing<br> + #ifdef XB_BLOCKREAD_SUPPORT<br> + MyFile->EnableBlockReadProcessing();<br> + #endif<br> +</b> +<br> + xbUInt32 j = 0;<br> + xbUInt32 ulRecCnt = 0;<br> +<br> + iRc = MyFile->GetRecordCnt( ulRecCnt );<br> +<br> + if( iRc < XB_NO_ERROR )<br> + return iRc;<br> + while( j < ulRecCnt ){<br> + if( j == 0 )<br> + iRc = MyFile->DumpRecord(++j, 2, 2 );<br> + else<br> + iRc = MyFile->DumpRecord(++j, 2, 1 );<br> + if( iRc != XB_NO_ERROR ){<br> + x.DisplayError( iRc );<br> + return 1;<br> + }<br> + }<br> + std::cout << j << " Records processed." << std::endl;<br> +<br> +<br><b> + // optionally turn off Block Read Processing<br> + #ifdef XB_BLOCKREAD_SUPPORT<br> + MyFile->DisableBlockReadProcessing();<br> + #endif<br></b> +<br> + MyFile->Close();<br> + return 0;<br> +}<br> +<br> + <hr> -<p><img src="xbase.jpg"><br><hr> +<p><img src="xbase.jpg"><hr> </BODY> </HTML> diff --git a/docs/html/xbc16.html b/docs/html/xbc16.html new file mode 100755 index 0000000..873264d --- /dev/null +++ b/docs/html/xbc16.html @@ -0,0 +1,52 @@ +<!DOCTYPE HTML PUBLIC> +<HTML> +<TITLE>Xbase DBMS Chapter 16</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H2><p align="center">Class Inventory</p></H2> +<p align="center">Chapter Updated 2/1/23</p><hr> +<br> +<center><h3>Class Descriptions</h3></center> + +<center> +<table border=1> +<tr><th>Class</th><th>Description</th></tr> +<tr><td>xbBcd</td><td>Supports binary coded decimal data</td></tr> +<tr><td>xbBlockRead<td>Supports block read functionality for improved sequential file access performance.</td></tr> +<tr><td>xbDate</td><td>Support date operations on a given date formatted as YYYYMMDD</td></tr> +<tr><td>xbDbf</td><td>Base class for DBF file handling. If you are adding support for a new file type, <br>derive new file type class from this.</td></tr> +<tr><td>xbDbf3</td><td>Derived from xbDbf, supports DBase V3 files</td></tr> +<tr><td>xbDbf4</td><td>Derived from xbDbf, supports DBase V4 files</td></tr> +<tr><td>xbExp</td><td>Class for supporting expression logic</td></tr> +<tr><td>xbExpNode</td><td>Class definition of a single node, utilized by xbExp</td></tr> +<tr><td>xbFile</td><td>Main file class. If you are porting this library to another platform, start here</td></tr> +<tr><td>xbFilter</td><td>Supports filters</td></tr> +<tr><td>xbIx</td><td>Base class for index file support. If you are adding support for a new index type, <br>derive new index type class from this.</td></tr> +<tr><td>xbIxNdx</td><td>Derived from xbIx, supports NDX style indices.</td></tr> +<tr><td>xbIxMdx</td><td>Derived from xbIx, supports MDX style indices</td></tr> +<tr><td>xbLinkList</td><td>Class supporting linked list functionality</td></tr> +<tr><td>xbLinkListOrd</td><td>Class supporting ordered linked list functionality</td></tr> +<tr><td>xbLinkListNode</td><td>Class defining one node, used by xbLinkList and xbLinkListOrd</td></tr> +<tr><td>xbLog</td><td>Class supporting general log file activity</td></tr> +<tr><td>xbMemo</td><td>Base class for supporting memo (.DBT) files. If you are adding support for a new memo type, <br>derive new memo type class from this.</td></tr> +<tr><td>xbMemoDbt3</td><td>Derived from xbMemo, supports V3 Memo files</td></tr> +<tr><td>xbMemoDbt4</td><td>Derived from xbMemo, supports V3 Memo files</td></tr> +<tr><td>xbSql</td><td>Supports SQL access</td></tr> +<tr><td>xbSsv</td><td>Base class, shared system values</td></tr> +<tr><td>xbString</td><td>String handling class</td></tr> +<tr><td>xbTag</td><td>Class to support index tags</td></tr> +<tr><td>xbTblMgr</td><td>Class used internally in the library for managing multiple open files/tables</td></tr> +<tr><td>xbUda</td><td>Class for supporting fields for the xbSql functions. Stands for User data area</td></tr> +<tr><td>xbXBase</td><td>Class to tie everything together. Every application program starts with one of these</td></tr> +</table> +</center> + +<hr> +<br><br> +Fix me... +<p><img src="Xbase64ClassDiagram.jpg"><br> + +<br><br> +<hr> +<p><img src="xbase.jpg"><br><hr> +</BODY> +</HTML> diff --git a/docs/html/xbc17.html b/docs/html/xbc17.html new file mode 100755 index 0000000..c0b2208 --- /dev/null +++ b/docs/html/xbc17.html @@ -0,0 +1,219 @@ +<!DOCTYPE HTML PUBLIC> +<HTML> +<TITLE>Xbase DBMS Chapter 17</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H2><p align="center">Class xbSsv</p></H2> +<p align="center">Chapter Updated 2/7/23</p><hr> + +<h3>Class xbSsv - Shared System Values.</h3> + +Base class xbSsv is used for maintaining static variables used system +wide by the XBase library routines and is a base class that is used by the xbXBase class. +See the diagram in chapter 15 to gain an understanding of where the xbSsv class sits in relation to the +other classes. Accessing the methods in this class are done via the xbXBase class instance.<br><br> +Additionally, there are a few other misc routines contained in this class that are available to all +subordinate classes/objects. +<br><br><br><br> + + +<center> +<table border=1> +<tr><th width=40%>Method</th><th>Description</th></tr> + +<tr><td>void BitDump( unsigned char c ) const<br>void BitDump( char c ) const</td><td>These routines dump the bits for a specified char field to stdout.</td></tr> +<tr><td>xbBool BitSet( unsigned char c, xbInt16 iBitNo ) const</td><td>This routine will set a specified bit in a char field.</td></tr> +<tr><td>void DisplayError( xbInt16 ErrorCode ) const</td><td>This routine prints a description for a specifed error to stdout.</td></tr> + +<tr><td>xbString& GetDataDirectory() const<br>void SetDataDirectory( const xbString &sDataDirectory )</td> + <td>Get and Set the current directory where the library routines expect to find the .DBF, .DBT, .NDX and .MDX files.</td></tr> + +<tr><td>xbString& GetDefaultDateFormat() const<br>void SetDefaultDateFormat( const xbString &sDefaultDateFormat )</td> + <td>Get and Set the current default date format used by the date formatting routines if no format specifier is provided.</td></tr> + +<tr><td>xbInt16 GetEndianType() const</td><td>Returns the current Endian type of the machine the library is operating on.</td></tr> +<tr><td>const char *GetErrorMessage( xbInt16 ErrorCode ) const</td><td>Returns a pointer to an error message for a given error number.</td></tr> + +<tr><td>xbBool GetDefaultAutoCommit() const<br>void SetDefaultAutoCommit( xbBool bDefaultAutoCommit )</td> + <td>Get and Set the default auto commit status. If auto commit is on, the library will automatically post any updates to the database when navigating away from an updated record.</td></tr> + +<tr><td>xbBool GetHomeDir( xbString &sHomeDirOut )</td><td>Get the home directory for the current user.</td></tr> + +<tr><td>xbString& GetLogDirectory() const<br>void SetLogDirectory( const xbString &sLogDirectory )</td> + <td>Get and set the directory location for any system generated logfiles.</td></tr> +<tr><td>xbString& GetLogFileName() const</td><td>Returns the default log file name.</td></tr> + + +<tr><td>xbBool GetMultiUser() const<br>void SetMultiUser( xbBool bMultiUser )</td> + <td>Get and set multi user status. This turns the auto locking on and off. For better performance in single user applications, turn multuser off.</td></tr> + +<tr><td>xbInt16 GetUniqueKeyOpt() const<br>xbInt16 SetUniqueKeyOpt( xbInt16 iUniqueKeyOpt )</td> + <td>Determines library behavior for unique key processing. The original Dbase (tm) product allowed duplicate recrds in the .DBF file when the unique option was specified for a given index tag. + The Xbase library supports either the original DBase behavior (XB_EMULATE_DBASE), or the prevention of duplicate records for duplicate keys (XB_HALT_ON_DUPKEY).</td></tr> + + +<tr><td>xbInt16 GetDefaultLockRetries() const<br>void SetDefaultLockRetries( xbInt16 iRetryCount )</td> + <td>Get and Set the number of times to attempt a lock</td></tr> + +<tr><td>xbInt32 GetDefaultLockWait() const<br>void SetDefaultLockWait( xbInt32 lRetryWait ) + </td><td>Get and Set the wait time between lock attempts.</td></tr> + +<tr><td>xbInt16 GetDefaultLockFlavor() const<br>void SetDefaultLockFlavor( xbInt16 iLockFlavor ) + </td><td>For future use. With current versions, only DBase (TM) locking offsets are supported.</td></tr> + +<tr><td>xbBool GetDefaultAutoLock() const<br>void SetDefaultAutoLock( xbBool bAutoLock )<br>void EnableDefaultAutoLock()<br>void DisableDefaultAutoLock() + </td><td>Set, Get or update Auto Lock Status</td></tr> + + +<tr><td>xbInt16 GetCreateMdxBlockSize() const<br>xbInt16 SetCreateMdxBlockSize( xbInt16 ulBlockSize ) + </td><td>Set or get MDX Index block size. Must be a multiple of 512.</td></tr> + +<tr><td>xbUInt32 GetDefaultBlockReadSize() const<br>void SetDefaultBlockReadSize( xbUInt32 ulDfltBlockReadSize ) + </td><td>Set or Get the default block size for Block Read functionality. Block reading is used to improve sequentential access performance.</td></tr> +</table> + +<br><br> + +<h3>Example program using xbSsv methods</h3> +</center> +<xmp> +/* xb_ex_ssv.cpp +XBase64 Software Library + +Copyright (c) 1997,2003,2014,2021,2022,2023 Gary A Kunkel + +The xb64 software library is covered under the terms of the GPL Version 3, 2007 license. + +Email Contact: + + XDB-devel@lists.sourceforge.net + XDB-users@lists.sourceforge.net + +This program demonstrates using functionality of the xbSsv class (Shared system values) + +*/ + +#include "xbase.h" + +using namespace xb; + +int main( int ac, char ** av ){ + + xbXBase x; // set up xbase for business + xbString sMsg; // a message string + + sMsg.Sprintf( "Program [%s] initializing...", av[0] ); + std::cout << sMsg.Str() << std::endl; + + // example code to set up log file usage + #ifdef XB_LOGGING_SUPPORT + char cSeperator; // is this a unix (/) or windows (\) file system + xbString sLog; // general string for log file activities + sLog = x.GetLogFqFileName().Str(); // get the system default log file name + std::cout << "System default logfile is [" << sLog.Str() << "]" << std::endl; + + cSeperator = sLog.GetPathSeparator(); // get the seperator from + std::cout << "Path seperator = [" << cSeperator << "]" << std::endl; + + sLog.Sprintf( "..%c", cSeperator ); + x.SetLogDirectory( sLog ); + std::cout << "sLog = [" << sLog.Str() << "]\n"; + + sLog = x.GetLogFqFileName().Str(); // get the system default log file name + std::cout << "New logfile is [" << sLog.Str() << "]" << std::endl; + + // turn on logging after file name set + x.EnableMsgLogging(); + #endif // XB_LOGGING_SUPPORT + + // const char *GetErrorMessage( xbInt16 ErrorCode ) const; + // void DisplayError( xbInt16 ErrorCode ) const; + std::cout << "DisplayError( -100 ) - "; + x.DisplayError( -100 ); + // << "]" << std::endl; + + + // void SetDefaultDateFormat( const xbString &sDefaultDateFormat ); + // xbString& GetDefaultDateFormat() const; + std::cout << "GetDefaultDateFormat() - " << x.GetDefaultDateFormat() << std::endl; + + // void SetDataDirectory ( const xbString &sDataDirectory ); + // xbString& GetDataDirectory() const; + std::cout << "GetDataDirectory() - " << x.GetDataDirectory() << std::endl; + + // xbInt16 GetEndianType() const; + if( x.GetEndianType() == 'L' ) + std::cout << "Little Endian Architecture." << std::endl; + else + std::cout << "Bid Endian Architecture." << std::endl; + + //xbBool GetDefaultAutoCommit() const; + //void SetDefaultAutoCommit( xbBool bDefaultAutoCommit ); + if( x.GetDefaultAutoCommit()) + std::cout << "AutoCommit is on." << std::endl; + else + std::cout << "AutoCommit is off." << std::endl; + + //xbBool GetMultiUser () const; + //void SetMultiUser ( xbBool bMultiUser ); + if( x.GetMultiUser()) + std::cout << "Multi user (locking) is enabled." << std::endl; + else + std::cout << "Multi user (locking) not enabled." << std::endl; + + #if defined (XB_NDX_SUPPORT) || defined (XB_MDX_SUPPORT) + // xbInt16 GetUniqueKeyOpt () const; + // xbInt16 SetUniqueKeyOpt ( xbInt16 iUniqueKeyOpt ); + // XB_HALT_ON_DUPKEY + // XB_EMULATE_DBASE + if( x.GetUniqueKeyOpt() == XB_HALT_ON_DUPKEY ) + std::cout << "UniqueKey option - XB_HALT_ON_DUPKEY" << std::endl; + else if( x.GetUniqueKeyOpt() == XB_EMULATE_DBASE ) + std::cout << "UniqueKey option - XB_EMULATE_DBASE" << std::endl; + #endif // (XB_NDX_SUPPORT) || defined (XB_MDX_SUPPORT) + + #ifdef XB_LOCKING_SUPPORT + //xbInt16 GetDefaultLockRetries () const; + //void SetDefaultLockRetries ( xbInt16 iRetryCount ); + //xbInt32 GetDefaultLockWait () const; + //void SetDefaultLockWait ( xbInt32 lRetryWait ); + //xbInt16 GetDefaultLockFlavor () const; + //void SetDefaultLockFlavor ( xbInt16 iLockFlavor ); + //xbBool GetDefaultAutoLock () const; + //void SetDefaultAutoLock ( xbBool bAutoLock ); + //void EnableDefaultAutoLock (); + //void DisableDefaultAutoLock (); + + std::cout << "GetDefaultLockRetries() - " << x.GetDefaultLockRetries() << std::endl; + std::cout << "GetDefaultLockWait() - " << x.GetDefaultLockWait() << std::endl; + std::cout << "GetDefaultAutoLock() - " << x.GetDefaultAutoLock() << std::endl; + #endif // XB_LOCKING_SUPPORT + + #ifdef XB_MDX_SUPPORT + // xbInt16 GetCreateMdxBlockSize() const; + // xbInt16 SetCreateMdxBlockSize( xbInt16 ulBlockSize ); + std::cout << "GetCreateMdxBlockSize() - " << x.GetCreateMdxBlockSize() << std::endl; + #endif // XB_MDX_SUPPORT + + #ifdef XB_BLOCKREAD_SUPPORT + // xbUInt32 GetDefaultBlockReadSize() const; + // void SetDefaultBlockReadSize( xbUInt32 ulDfltBlockReadSize ); + std::cout << "GetDefaultBlockReadSize() - " << x.GetDefaultBlockReadSize() << std::endl; + #endif // XB_BLOCKREAD_SUPPORT + + //xbBool BitSet ( unsigned char c, xbInt16 iBitNo ) const; + //void BitDump ( unsigned char c ) const; + //void BitDump ( char c ) const; + std::cout << "BitDump( 'A' ) - "; + x.BitDump( 'A' ); + + return 0; +} + + +</xmp> + +<br><br> +<hr> +<p><img src="xbase.jpg"><br><hr> +</BODY> +</HTML> diff --git a/docs/html/xbc18.html b/docs/html/xbc18.html new file mode 100755 index 0000000..36f3b50 --- /dev/null +++ b/docs/html/xbc18.html @@ -0,0 +1,252 @@ +<!DOCTYPE HTML PUBLIC> +<HTML> +<TITLE>Xbase DBMS Chapter 18</TITLE> +<BODY BGCOLOR=#FFFFFF> +<H2><p align="center">Class xbXBase</p></H2> +<p align="center">Chapter Updated 2/7/23</p><hr> + +<h3>Class xbXBase - Core Level Class</h3> + + +The xbXBase class is the core class that needs to be in every application program. +Established an instance of class xbXBase before any other Xbase calls are made. + +<i>xbXBase x</i> + +<br><br> +xbXBase is derived from base classes xbTblMgr and xbSsv. +<br><br><br><br> + + + + + +<center> +<table border=1> +<tr><th width=40%>Method</th><th>Description</th><th>Category</th></tr> + +<tr><td>xbInt16 CloseAllTables()</td><td>Close all open tables.</td><td>Table</tr> + +<tr><td>xbInt16 OpenHighestVersion( const xbString &sTableName, const xbString &sAlias, xbDbf &dbf, int dummy )</td><td>Open highest version available for sTableName.</td><td>Table</tr> +<tr><td>xbInt16 OpenHighestVersion( const xbString &sTableName, const xbString &sAlias, xbDbf **dbf )</td><td>Open highest version available for sTableName.</td><td>Table</tr> +<tr><td>xbDbf * Open( const xbString &sTableName, xbInt16 &iRc )</td><td>Open the highest available version of the dbf file. Defaults to XB_READ_WRITE and XB_MULTI_USER mode.</td><td>Table</tr> +<tr><td>xbDbf * Open( const xbString &sTableName, const xbString &sAlias, xbInt16 iOpenMode, xbInt16 iShareMode, xbInt16 iVersion, xbInt16 &iRc )</td><td>Open table.</td><td>Table</tr> + +<tr><td colspan=3><hr></td></tr> +<tr><td>void DisableMsgLogging()</td><td>Disable logging routines.</td><td>Logging</td></tr> +<tr><td>void EnableMsgLogging ()</td><td>Enable logging routines.</td><td>Logging</td></tr> +<tr><td>xbInt16 FlushLog()</td><td>Flush any queued logfile updates to disk.</td><td>Logging</td></tr> +<tr><td>const xbString &GetLogDirectory () const</td><td>Get the current logfile directory.</td><td>Logging</td></tr> +<tr><td>const xbString &GetLogFileName () const</td><td>Get the current logfile name.</td><td>Logging</td></tr> +<tr><td>const xbString &GetLogFqFileName() const</td><td>Get fully qualified logfile name.</td><td>Logging</td></tr> +<tr><td>xbBool GetLogStatus () const</td><td>Get the logging status.</td><td>Logging</td></tr> +<tr><td>void SetLogDirectory( const xbString &sLogFileDirectory )</td><td>Set the log directory. Must be done while logging is off.</td><td>Logging</td></tr> +<tr><td>void SetLogFileName( const xbString &sLogFileName )</td><td>Set the log file name. Must be done while logging is off.</td><td>Logging</td></tr> +<tr><td>void SetLogSize( size_t lSize )</td><td>Set the logfile size. After the size is reached, the log file roll.</td><td>Logging</td></tr> +<tr><td>xbInt16 WriteLogBytes ( xbUInt32 lCnt, const char *p )</td><td>Write lCnt bytes pointed to by pointer p to the logfile.</td><td>Logging</td></tr> +<tr><td>xbInt16 WriteLogMessage( const xbString &sLogMessage, xbInt16 iOutputOpt = 0 )</td><td>Write a string to the logfile.</td><td>Logging</td></tr> + +<tr><td colspan=3><hr></td></tr> +<tr><td>xbInt16 xbXBase::GetCmdLineOpt( xbInt32 lArgc, char **sArgv, xbString &sOptRqst, xbString &sParmOut )<br> +xbXBase::GetCmdLineOpt( xbInt32 lArgc, char **sArgv, const char *sOptRqst, xbString &sParmOut )</td><td>Parse command line values seeking given parameter info.</td><td>Misc</td></tr> + +<tr><td>void xbSleep( xbInt32 lMillisecs )</td><td>Sleep command, used mainly in lock commands for waiting between retries.</td><td>Misc</td></td></tr> + +<tr><td colspan=3><hr></td></tr> +<tr><td>xbInt16 ABS( xbDouble dIn, xbDouble &dOut )</td><td>Dbase ABS function.</td><td>Expression</td></tr> +<tr><td>xbInt16 ALLTRIM( const xbString &sIn, xbString &sOut )</td><td>Dbase ALLTRIM function.</td><td>Expression</td></tr> +<tr><td>xbInt16 ASC( const xbString &s, xbDouble &dAscOut )</td><td>Dbase ASC function.</td><td>Expression</td></tr> +<tr><td>xbInt16 AT( const xbString &sSrchFor, const xbString &sBase, xbDouble &dPos )</td><td>Dbase AT function.</td><td>Expression</td></tr> +<tr><td>xbInt16 CDOW( xbDate &dInDate, xbString &sOutDow )</td><td>Dbase CDOW function.</td><td>Expression</td></tr> +<tr><td>xbInt16 CHR( xbDouble dAsciCd, xbString &sOut )</td><td>Dbase CHR function.</td><td>Expression</td></tr> +<tr><td>xbInt16 CMONTH( xbDate &dInDate, xbString &sOutMonth )</td><td>Dbase CMONTH function.</td><td>Expression</td></tr> +<tr><td>xbInt16 CTOD( const xbString &sInDate, xbDate &dOutDate )</td><td>Dbase CTOD function.</td><td>Expression</td></tr> +<tr><td>xbInt16 DATE( xbDate &dOutDate )</td><td>Dbase DATE function.</td><td>Expression</td></tr> +<tr><td>xbInt16 DAY( const xbDate &dInDate, xbDouble &dOutDay )</td><td>Dbase DAY function.</td><td>Expression</td></tr> +<tr><td>xbInt16 DEL( xbDbf * d, xbString &sOut, xbInt16 iRecBufSw = 0 )</td><td>Dbase DEL function.</td><td>Expression</td></tr> +<tr><td>xbInt16 DELETED( xbDbf * d, xbBool &bOut, xbInt16 iRecBufSw = 0 )</td><td>Dbase DELETED function.</td><td>Expression</td></tr> +<tr><td>xbInt16 DESCEND( const xbString &sIn,xbString &sOut )<br>xbInt16 DESCEND( const xbDate &dInDate, xbDate &dOutDate )<br>xbInt16 DESCEND( const xbDouble dIn, xbDouble &dsOut )</td><td>Dbase DESCEND function.</td><td>Expression</td></tr> +<tr><td>xbInt16 DOW( const xbDate &sInDate, xbDouble &dDowOut )</td><td>Dbase DOW function.</td><td>Expression</td></tr> +<tr><td>xbInt16 DTOC( xbDate &dInDate, xbString &sOutFmtDate )</td><td>Dbase DTOC function.</td><td>Expression</td></tr> +<tr><td>xbInt16 DTOS( xbDate &dInDate, xbString &sOutFmtDate )</td><td>Dbase DTOS function.</td><td>Expression</td></tr> +<tr><td>xbInt16 EXP( xbDouble dIn, xbDouble &dOut )</td><td>Dbase EXP function.</td><td>Expression</td></tr> +<tr><td>xbInt16 IIF( xbBool bResult, const xbString &sTrueResult, const xbString &sFalseResult, xbString &sResult )</td><td>Dbase IIF function.</td><td>Expression</td></tr> +<tr><td>xbInt16 INT( xbDouble dIn, xbDouble &dOut )</td><td>Dbase INT function.</td><td>Expression</td></tr> +<tr><td>xbInt16 ISALPHA( const xbString &s, xbBool &bResult )</td><td>Dbase ISALPHA function.</td><td>Expression</td></tr> +<tr><td>xbInt16 ISLOWER( const xbString &s, xbBool &bResult )</td><td>Dbase ISLOWER function.</td><td>Expression</td></tr> +<tr><td>xbInt16 ISUPPER( const xbString &s, xbBool &bResult )</td><td>Dbase ISUPPER function.</td><td>Expression</td></tr> +<tr><td>xbInt16 LEFT( const xbString &sIn, xbUInt32 lCharCnt, xbString &sOut )</td><td>Dbase LEF function.</td><td>Expression</td></tr> +<tr><td>xbInt16 LEN( const xbString &sIn, xbDouble &dLen )</td><td>Dbase LEN function.</td><td>Expression</td></tr> +<tr><td>xbInt16 LOG( xbDouble dIn, xbDouble &dOut )</td><td>Dbase LOG function.</td><td>Expression</td></tr> +<tr><td>xbInt16 LOWER( const xbString &sIn, xbString &sOut )</td><td>Dbase LOWER function.</td><td>Expression</td></tr> +<tr><td>xbInt16 LTRIM( const xbString &sIn, xbString & sOut )</td><td>Dbase LTRIM function.</td><td>Expression</td></tr> +<tr><td>xbInt16 MAX( xbDouble dIn1, xbDouble dIn2, xbDouble &dOut )</td><td>Dbase MAX function.</td><td>Expression</td></tr> +<tr><td>xbInt16 MIN( xbDouble dIn1, xbDouble dIn2, xbDouble &dOut )</td><td>Dbase MIN function.</td><td>Expression</td></tr> +<tr><td>xbInt16 MONTH( xbDate &dInDate, xbDouble &dMonthOut )</td><td>Dbase MONTH function.</td><td>Expression</td></tr> +<tr><td>xbInt16 RECCOUNT( xbDbf * d, xbDouble &dRecOut )</td><td>Dbase RECCOUNT function.</td><td>Expression</td></tr> +<tr><td>xbInt16 RECNO( xbDbf * d, xbDouble &dRecOut )</td><td>Dbase RECNO function.</td><td>Expression</td></tr> +<tr><td>xbInt16 REPLICATE( const xbString &sIn, xbUInt32 ulRepCnt, xbString &sOut )</td><td>Dbase REPLICATE function.</td><td>Expression</td></tr> +<tr><td>xbInt16 RIGHT( const xbString &sIn, xbUInt32 iCharCnt, xbString &sOut )</td><td>Dbase RIGHT function.</td><td>Expression</td></tr> +<tr><td>xbInt16 RTRIM( const xbString &sIn, xbString &sOut )</td><td>Dbase RTRIM function.</td><td>Expression</td></tr> +<tr><td>xbInt16 SPACE( xbInt32 lCnt, xbString &sOut )</td><td>Dbase SPACE function.</td><td>Expression</td></tr> +<tr><td>xbInt16 SQRT( xbDouble dBase, xbDouble &dSqrRt )</td><td>Dbase SQRT function.</td><td>Expression</td></tr> +<tr><td>xbInt16 STOD( const xbString &sIn, xbDate &sDateOut )</td><td>Dbase STOD function.</td><td>Expression</td></tr> +<tr><td>xbInt16 STR( xbDouble dIn, xbString &sOut )</td><td>Dbase function.</td><td>Expression</td></tr> +<tr><td>xbInt16 STR( xbDouble dIn, xbUInt32 ulLen, xbString &sOut )<br> + xbInt16 STR( xbDouble dIn, xbUInt32 ulLen, xbUInt32 ulDec, xbString &sOut )<br> + xbInt16 STR( xbDouble dIn, xbUInt32 ulLen, xbUInt32 ulDec, xbString &sPadChar, xbString &sOut )</td><td>Dbase STR function.</td><td>Expression</td></tr> +<tr><td>xbInt16 STRZERO( xbDouble dIn, xbUInt32 ulLen, xbUInt32 ulDec, xbString &sOut )</td><td>Dbase STRZERO function.</td><td>Expression</td></tr> +<tr><td>xbInt16 SUBSTR( const xbString &sIn, xbUInt32 ulStartPos, xbUInt32 ulLen, xbString &sOut )</td><td>Dbase SUBSTR function.</td><td>Expression</td></tr> +<tr><td>xbInt16 TRIM( const xbString &sIn, xbString &sOut )</td><td>Dbase TRIM function.</td><td>Expression</td></tr> +<tr><td>xbInt16 UPPER( const xbString &sIn, xbString &sOut )</td><td>Dbase UPPER function.</td><td>Expression</td></tr> +<tr><td>xbInt16 VAL( const xbString &sIn, xbDouble &dOut )</td><td>Dbase VAL function.</td><td>Expression</td></tr> +<tr><td>xbInt16 YEAR( xbDate &dInDate, xbDouble &dOutYear )</td><td>Dbase YEAR function.</td><td>Expression</td></tr> +</table> + +<br><br> +<hr> + +<h3>Example program using xbXbase methods</h3> +</center> +<xmp> +/* xb_ex_ssv.cpp +XBase64 Software Library + +Copyright (c) 1997,2003,2014,2021,2022,2023 Gary A Kunkel + +The xb64 software library is covered under the terms of the GPL Version 3, 2007 license. + +Email Contact: + + XDB-devel@lists.sourceforge.net + XDB-users@lists.sourceforge.net + +This program demonstrates using functionality of the xbSsv class (Shared system values) + +*/ + +#include "xbase.h" + +using namespace xb; + +int main( int ac, char ** av ){ + + xbXBase x; // set up xbase for business + xbString sMsg; // a message string + + sMsg.Sprintf( "Program [%s] initializing...", av[0] ); + std::cout << sMsg.Str() << std::endl; + + // example code to set up log file usage + #ifdef XB_LOGGING_SUPPORT + char cSeperator; // is this a unix (/) or windows (\) file system + xbString sLog; // general string for log file activities + sLog = x.GetLogFqFileName().Str(); // get the system default log file name + std::cout << "System default logfile is [" << sLog.Str() << "]" << std::endl; + + cSeperator = sLog.GetPathSeparator(); // get the seperator from + std::cout << "Path seperator = [" << cSeperator << "]" << std::endl; + + sLog.Sprintf( "..%c", cSeperator ); + x.SetLogDirectory( sLog ); + std::cout << "sLog = [" << sLog.Str() << "]\n"; + + sLog = x.GetLogFqFileName().Str(); // get the system default log file name + std::cout << "New logfile is [" << sLog.Str() << "]" << std::endl; + + // turn on logging after file name set + x.EnableMsgLogging(); + #endif // XB_LOGGING_SUPPORT + + // const char *GetErrorMessage( xbInt16 ErrorCode ) const; + // void DisplayError( xbInt16 ErrorCode ) const; + std::cout << "DisplayError( -100 ) - "; + x.DisplayError( -100 ); + // << "]" << std::endl; + + + // void SetDefaultDateFormat( const xbString &sDefaultDateFormat ); + // xbString& GetDefaultDateFormat() const; + std::cout << "GetDefaultDateFormat() - " << x.GetDefaultDateFormat() << std::endl; + + // void SetDataDirectory ( const xbString &sDataDirectory ); + // xbString& GetDataDirectory() const; + std::cout << "GetDataDirectory() - " << x.GetDataDirectory() << std::endl; + + // xbInt16 GetEndianType() const; + if( x.GetEndianType() == 'L' ) + std::cout << "Little Endian Architecture." << std::endl; + else + std::cout << "Bid Endian Architecture." << std::endl; + + //xbBool GetDefaultAutoCommit() const; + //void SetDefaultAutoCommit( xbBool bDefaultAutoCommit ); + if( x.GetDefaultAutoCommit()) + std::cout << "AutoCommit is on." << std::endl; + else + std::cout << "AutoCommit is off." << std::endl; + + //xbBool GetMultiUser () const; + //void SetMultiUser ( xbBool bMultiUser ); + if( x.GetMultiUser()) + std::cout << "Multi user (locking) is enabled." << std::endl; + else + std::cout << "Multi user (locking) not enabled." << std::endl; + + #if defined (XB_NDX_SUPPORT) || defined (XB_MDX_SUPPORT) + // xbInt16 GetUniqueKeyOpt () const; + // xbInt16 SetUniqueKeyOpt ( xbInt16 iUniqueKeyOpt ); + // XB_HALT_ON_DUPKEY + // XB_EMULATE_DBASE + if( x.GetUniqueKeyOpt() == XB_HALT_ON_DUPKEY ) + std::cout << "UniqueKey option - XB_HALT_ON_DUPKEY" << std::endl; + else if( x.GetUniqueKeyOpt() == XB_EMULATE_DBASE ) + std::cout << "UniqueKey option - XB_EMULATE_DBASE" << std::endl; + #endif // (XB_NDX_SUPPORT) || defined (XB_MDX_SUPPORT) + + #ifdef XB_LOCKING_SUPPORT + //xbInt16 GetDefaultLockRetries () const; + //void SetDefaultLockRetries ( xbInt16 iRetryCount ); + //xbInt32 GetDefaultLockWait () const; + //void SetDefaultLockWait ( xbInt32 lRetryWait ); + //xbInt16 GetDefaultLockFlavor () const; + //void SetDefaultLockFlavor ( xbInt16 iLockFlavor ); + //xbBool GetDefaultAutoLock () const; + //void SetDefaultAutoLock ( xbBool bAutoLock ); + //void EnableDefaultAutoLock (); + //void DisableDefaultAutoLock (); + + std::cout << "GetDefaultLockRetries() - " << x.GetDefaultLockRetries() << std::endl; + std::cout << "GetDefaultLockWait() - " << x.GetDefaultLockWait() << std::endl; + std::cout << "GetDefaultAutoLock() - " << x.GetDefaultAutoLock() << std::endl; + #endif // XB_LOCKING_SUPPORT + + #ifdef XB_MDX_SUPPORT + // xbInt16 GetCreateMdxBlockSize() const; + // xbInt16 SetCreateMdxBlockSize( xbInt16 ulBlockSize ); + std::cout << "GetCreateMdxBlockSize() - " << x.GetCreateMdxBlockSize() << std::endl; + #endif // XB_MDX_SUPPORT + + #ifdef XB_BLOCKREAD_SUPPORT + // xbUInt32 GetDefaultBlockReadSize() const; + // void SetDefaultBlockReadSize( xbUInt32 ulDfltBlockReadSize ); + std::cout << "GetDefaultBlockReadSize() - " << x.GetDefaultBlockReadSize() << std::endl; + #endif // XB_BLOCKREAD_SUPPORT + + //xbBool BitSet ( unsigned char c, xbInt16 iBitNo ) const; + //void BitDump ( unsigned char c ) const; + //void BitDump ( char c ) const; + std::cout << "BitDump( 'A' ) - "; + x.BitDump( 'A' ); + + return 0; +} + + +</xmp> + +<br><br> +<hr> +<p><img src="xbase.jpg"><br><hr> +</BODY> +</HTML> |