Class for handling shared system variables. More...
#include <xbssv.h>
Public Member Functions | |
| xbSsv () | |
| Class Constructor. More... | |
| void | DisplayError (xbInt16 ErrorCode) const |
| Display error message on console for a given error number. More... | |
| xbString & | GetDefaultDateFormat () const |
| Get the default date format. More... | |
| xbString & | GetDataDirectory () const |
| Get the current data directory. More... | |
| xbInt16 | GetEndianType () const |
| Get the Endian type. More... | |
| const char * | GetErrorMessage (xbInt16 ErrorCode) const |
| Get an error message. More... | |
| void | SetDataDirectory (const xbString &sDataDirectory) |
| Set the data directory. More... | |
| void | SetDefaultDateFormat (const xbString &sDefaultDateFormat) |
| Set the default date format. More... | |
| xbBool | BitSet (unsigned char c, xbInt16 iBitNo) const |
| Check a bit in a one byte field and see if it is set. More... | |
| xbBool | GetDefaultAutoCommit () const |
| Get the default auto commit setting. More... | |
| void | SetDefaultAutoCommit (xbBool bDefaultAutoCommit) |
| Set the default auto commit. More... | |
| xbString & | GetDefaultLogDirectory () const |
| xbString & | GetDefaultLogFileName () const |
| void | SetDefaultLogDirectory (const xbString &sDefaultLogDirectory) |
| xbBool | GetMultiUser () const |
| Get the multi user setting. More... | |
| void | SetMultiUser (xbBool bMultiUser) |
| Get the multi user setting. More... | |
Static Public Attributes | |
| static const char * | ErrorCodeText [] |
Protected Member Functions | |
| void | SetEndianType () |
| Set the endian type. More... | |
Static Protected Attributes | |
| static xbInt16 | iEndianType = 0 |
| static xbString | sNullString = "" |
Detailed Description
Class for handling shared system variables.
This class defines static variables which are referenced across class instances.
This class is designed to have the variables set when the xbXBase class constructor is called (xbXBase is a derived class). The xbXbase class is designed to be called first in an application programs, and it is only called once. The static values in this class are typically initialized at program startup and don't require additional updates.
Constructor & Destructor Documentation
◆ xbSsv()
| xb::xbSsv::xbSsv | ( | ) |
Class Constructor.
Member Function Documentation
◆ BitSet()
| xbBool xb::xbSsv::BitSet | ( | unsigned char | c, |
| xbInt16 | iBitNo | ||
| ) | const |
Check a bit in a one byte field and see if it is set.
- Parameters
-
c One byte char field to examine. iBitNo which bit to examine.
- Returns
- xbTrue Bit is set
xbFalse Bit is not set
◆ DisplayError()
| void xb::xbSsv::DisplayError | ( | xbInt16 | iErrorCode | ) | const |
Display error message on console for a given error number.
- Parameters
-
iErrorCode Error number to reference
◆ GetDataDirectory()
| xbString & xb::xbSsv::GetDataDirectory | ( | ) | const |
Get the current data directory.
- Returns
- xbString containing the current data directory where the database files are stored.
◆ GetDefaultAutoCommit()
| xbBool xb::xbSsv::GetDefaultAutoCommit | ( | ) | const |
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->Put() and dbf->AppendRecord().
- Returns
- xbTrue if auto commit is turned on
xbFalse is auto commit is turned off
◆ GetDefaultDateFormat()
| xbString & xb::xbSsv::GetDefaultDateFormat | ( | ) | const |
Get the default date format.
- Returns
- xbString containing the default date format.
◆ GetDefaultLogDirectory()
| xbString & xb::xbSsv::GetDefaultLogDirectory | ( | ) | const |
◆ GetDefaultLogFileName()
| xbString & xb::xbSsv::GetDefaultLogFileName | ( | ) | const |
◆ GetEndianType()
| xbInt16 xb::xbSsv::GetEndianType | ( | ) | const |
Get the Endian type.
- Returns
- B - Big endian
L - Little endian
◆ GetErrorMessage()
| const char * xb::xbSsv::GetErrorMessage | ( | xbInt16 | iErrorCode | ) | const |
Get an error message.
- Parameters
-
iErrorCode ErrorCode is the error number of description to be returned.
- Returns
- Returns a pointer to a string containing a text description for the error code.
◆ GetMultiUser()
| xbBool xb::xbSsv::GetMultiUser | ( | ) | const |
Get the multi user setting.
- Returns
- xbTrue - Multi user mode turned on.
xbFalse - Multi user mode turned off.
◆ SetDataDirectory()
| void xb::xbSsv::SetDataDirectory | ( | const xbString & | sDataDirectory | ) |
Set the data directory.
- Parameters
-
sDataDirectory Set the data direcroty.
◆ SetDefaultAutoCommit()
| void xb::xbSsv::SetDefaultAutoCommit | ( | xbBool | bDefaultAutoCommit | ) |
Set the default auto commit.
Disabling auto commit requires the application execute explicit updates using dbf->Put() and dbf->AppendRecord(). With auto commit on, the library posts updates automatically when moving off the current record or closing a file.
- Parameters
-
bDefaultAutoCommit xbTrue - Enable default auto commit.
xbFalse - Disable default auto commit.
◆ SetDefaultDateFormat()
| void xb::xbSsv::SetDefaultDateFormat | ( | const xbString & | sDefaultDateFormat | ) |
Set the default date format.
- Parameters
-
sDefaultDateFormat Set the default date format.
◆ SetDefaultLogDirectory()
| void xb::xbSsv::SetDefaultLogDirectory | ( | const xbString & | sDefaultLogDirectory | ) |
◆ SetEndianType()
|
protected |
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.
◆ SetMultiUser()
| void xb::xbSsv::SetMultiUser | ( | xbBool | bMultiUser | ) |
Get the multi user setting.
- Parameters
-
bMultiUser xbTrue - Turn on Multi user mode.
xbFalse - Turn off Multi user mode.
Field Documentation
◆ ErrorCodeText
|
static |
◆ iEndianType
|
staticprotected |
◆ sNullString
|
staticprotected |
The documentation for this class was generated from the following files:
