Xbase64 4.0.1
C++ Library for handling Xbase (DBF) format type files
Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Attributes
xb::xbTblMgr Class Reference

#include <xbtblmgr.h>

Inheritance diagram for xb::xbTblMgr:
xb::xbSsv xb::xbXBase

Public Member Functions

 xbTblMgr ()
 
 ~xbTblMgr ()
 
xbInt16 AddTblToTblList (xbDbf *d, const xbString &sTblName)
 
xbInt16 AddTblToTblList (xbDbf *d, const xbString &sTblName, const xbString &sTblAlias)
 
xbInt16 DisplayTableList () const
 
xbDbfGetDbfPtr (const xbString &sTblAlias) const
 
xbDbfGetDbfPtr (xbInt16 sItemNo) const
 
xbInt16 GetOpenTableCount () const
 
xbInt16 RemoveTblFromTblList (const xbString &sTblAlias)
 
xbInt16 RemoveTblFromTblList (xbDbf *d)
 
void DisplayError (xbInt16 ErrorCode) const
 Display error message on console for a given error number. More...
 
xbStringGetDefaultDateFormat () const
 Get the default date format. More...
 
xbStringGetDataDirectory () 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...
 
xbStringGetDefaultLogDirectory () const
 
xbStringGetDefaultLogFileName () 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 = ""
 

Constructor & Destructor Documentation

◆ xbTblMgr()

xb::xbTblMgr::xbTblMgr ( )

◆ ~xbTblMgr()

xb::xbTblMgr::~xbTblMgr ( )

Member Function Documentation

◆ AddTblToTblList() [1/2]

xbInt16 xb::xbTblMgr::AddTblToTblList ( xbDbf d,
const xbString sTblName 
)

◆ AddTblToTblList() [2/2]

xbInt16 xb::xbTblMgr::AddTblToTblList ( xbDbf d,
const xbString sTblName,
const xbString sTblAlias 
)

◆ BitSet()

xbBool xb::xbSsv::BitSet ( unsigned char  c,
xbInt16  iBitNo 
) const
inherited

Check a bit in a one byte field and see if it is set.

Parameters
cOne byte char field to examine.
iBitNowhich bit to examine.
Returns
xbTrue Bit is set
xbFalse Bit is not set

◆ DisplayError()

void xb::xbSsv::DisplayError ( xbInt16  iErrorCode) const
inherited

Display error message on console for a given error number.

Parameters
iErrorCodeError number to reference

◆ DisplayTableList()

xbInt16 xb::xbTblMgr::DisplayTableList ( ) const

◆ GetDataDirectory()

xbString & xb::xbSsv::GetDataDirectory ( ) const
inherited

Get the current data directory.

Returns
xbString containing the current data directory where the database files are stored.

◆ GetDbfPtr() [1/2]

xbDbf * xb::xbTblMgr::GetDbfPtr ( const xbString sTblAlias) const

◆ GetDbfPtr() [2/2]

xbDbf * xb::xbTblMgr::GetDbfPtr ( xbInt16  sItemNo) const

◆ GetDefaultAutoCommit()

xbBool xb::xbSsv::GetDefaultAutoCommit ( ) const
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->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
inherited

Get the default date format.

Returns
xbString containing the default date format.

◆ GetDefaultLogDirectory()

xbString & xb::xbSsv::GetDefaultLogDirectory ( ) const
inherited

◆ GetDefaultLogFileName()

xbString & xb::xbSsv::GetDefaultLogFileName ( ) const
inherited

◆ GetEndianType()

xbInt16 xb::xbSsv::GetEndianType ( ) const
inherited

Get the Endian type.

Returns
B - Big endian
L - Little endian

◆ GetErrorMessage()

const char * xb::xbSsv::GetErrorMessage ( xbInt16  iErrorCode) const
inherited

Get an error message.

Parameters
iErrorCodeErrorCode 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
inherited

Get the multi user setting.

Returns
xbTrue - Multi user mode turned on.
xbFalse - Multi user mode turned off.

◆ GetOpenTableCount()

xbInt16 xb::xbTblMgr::GetOpenTableCount ( ) const

◆ RemoveTblFromTblList() [1/2]

xbInt16 xb::xbTblMgr::RemoveTblFromTblList ( const xbString sTblAlias)

◆ RemoveTblFromTblList() [2/2]

xbInt16 xb::xbTblMgr::RemoveTblFromTblList ( xbDbf d)

◆ SetDataDirectory()

void xb::xbSsv::SetDataDirectory ( const xbString sDataDirectory)
inherited

Set the data directory.

Parameters
sDataDirectorySet the data direcroty.

◆ SetDefaultAutoCommit()

void xb::xbSsv::SetDefaultAutoCommit ( xbBool  bDefaultAutoCommit)
inherited

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
bDefaultAutoCommitxbTrue - Enable default auto commit.
xbFalse - Disable default auto commit.

◆ SetDefaultDateFormat()

void xb::xbSsv::SetDefaultDateFormat ( const xbString sDefaultDateFormat)
inherited

Set the default date format.

Parameters
sDefaultDateFormatSet the default date format.

◆ SetDefaultLogDirectory()

void xb::xbSsv::SetDefaultLogDirectory ( const xbString sDefaultLogDirectory)
inherited

◆ SetEndianType()

void xb::xbSsv::SetEndianType ( )
protectedinherited

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)
inherited

Get the multi user setting.

Parameters
bMultiUserxbTrue - Turn on Multi user mode.
xbFalse - Turn off Multi user mode.

Field Documentation

◆ ErrorCodeText

const char* xb::xbSsv::ErrorCodeText[]
staticinherited

◆ iEndianType

xbInt16 xb::xbSsv::iEndianType = 0
staticprotectedinherited

◆ sNullString

xbString xb::xbSsv::sNullString = ""
staticprotectedinherited

The documentation for this class was generated from the following files: