Xbase64 Class Library  3.1.2
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
xbXBase Class Reference

xbXBase class More...

#include <xbase64.h>

Public Member Functions

 ~xbXBase ()
 Destructor. More...
 
 xbXBase ()
 Constructor. More...
 
xbShort AddDbfToDbfList (xbDbf *d, const char *DatabaseName)
 Add dbf to dbf list. More...
 
xbDbfGetDbfPtr (const char *Name)
 Get pointer to named dbf. More...
 
xbShort DirectoryExistsInName (const char *Name)
 Get offset of last PATH_SEPARATOR in Name. More...
 
xbShort GetEndianType ()
 
void DisplayError (xbShort ErrorCode) const
 Display description of error code. More...
 
xbStringGetDefaultDateFormat ()
 
void SetDefaultDateFormat (const xbString &f)
 
xbDouble GetDouble (const char *p)
 Get a portable double value. More...
 
xbLong GetLong (const char *p)
 Get a portable long value. More...
 
xbULong GetULong (const char *p)
 Get a portable unsigned long value. More...
 
xbShort GetShort (const char *p)
 Get a portable short value. More...
 
xbULong GetHBFULong (const char *p)
 Get a high byte first unsigned long value. More...
 
xbShort GetHBFShort (const char *p)
 Get a high byte first short value. More...
 
void PutLong (char *p, const xbLong l)
 Put a portable long value. More...
 
void PutShort (char *p, const xbShort s)
 Put a portable short value. More...
 
void PutULong (char *p, const xbULong l)
 Put a portable unsigned long value. More...
 
void PutUShort (char *p, const xbUShort s)
 Put a portable unsigned short value. More...
 
void PutDouble (char *p, const xbDouble d)
 Put a portable double value. More...
 
xbShort RemoveDbfFromDbfList (xbDbf *)
 Remove dbf from dbf list. More...
 

Static Public Member Functions

static const char * GetErrorMessage (xbShort ErrorCode)
 Get description of error code. More...
 

Protected Attributes

xbDbListDbfList
 
xbDbListFreeDbfList
 
xbShort EndianType
 

Detailed Description

xbXBase class

Constructor & Destructor Documentation

◆ ~xbXBase()

xbXBase::~xbXBase ( )

Destructor.

◆ xbXBase()

xbXBase::xbXBase ( )

Constructor.

Member Function Documentation

◆ AddDbfToDbfList()

xbShort xbXBase::AddDbfToDbfList ( xbDbf d,
const char *  DatabaseName 
)

Add dbf to dbf list.

Adds an xbDbf class instance to the list of dbf's.

Parameters
dthe xbDbf instance to be added
DatabaseNamename of the database
Returns
One of the following return codes:

Return CodeDescription
XB_NO_ERRORNo error
XB_NO_MEMORYOut of memory

◆ DirectoryExistsInName()

xbShort xbXBase::DirectoryExistsInName ( const char *  Name)

Get offset of last PATH_SEPARATOR in Name.

Scans the specified Name for the last occurance of PATH_SEPARATOR.

Parameters
Namestring to be scanned.
Returns
offset of last occurance of PATH_SEPARATOR

◆ DisplayError()

void xbXBase::DisplayError ( xbShort  ErrorCode) const

Display description of error code.

Displays a text description of an XBase error code.

Parameters
ErrorCodeerror to be displayed

◆ GetDbfPtr()

xbDbf * xbXBase::GetDbfPtr ( const char *  Name)

Get pointer to named dbf.

Looks up an open DBF file by Name.

Parameters
Name
Returns
A pointer to the xbDbf class instance if found or NULL if not found.

◆ GetDefaultDateFormat()

xbString& xbXBase::GetDefaultDateFormat ( )
inline

◆ GetDouble()

xbDouble xbXBase::GetDouble ( const char *  p)

Get a portable double value.

Converts a double (64 bit floating point) value stored at p from a portable format to the machine format.

Parameters
ppointer to memory containing the portable double value
Returns
the double value.

◆ GetEndianType()

xbShort xbXBase::GetEndianType ( )
inline

◆ GetErrorMessage()

const char * xbXBase::GetErrorMessage ( xbShort  ErrorCode)
static

Get description of error code.

Returns a pointer to string containing a text description of an error code.

Parameters
ErrorCodeerror number of description to be returned

◆ GetHBFShort()

xbShort xbXBase::GetHBFShort ( const char *  p)

Get a high byte first short value.

Converts a short (16 bit integer) value stored at p from a high byte first format to the machine format.

Parameters
ppointer to memory containing the high byte first short value
Returns
the short value.

◆ GetHBFULong()

xbULong xbXBase::GetHBFULong ( const char *  p)

Get a high byte first unsigned long value.

Converts an unsigned long (32 bit integer) value stored at p from a high byte first format to the machine format.

Parameters
ppointer to memory containing the high byte first unsigned long value
Returns
the unsigned long value.

◆ GetLong()

xbLong xbXBase::GetLong ( const char *  p)

Get a portable long value.

Converts a long (32 bit integer) value stored at p from a portable format to the machine format.

Parameters
ppointer to memory containing the portable long value
Returns
the long value.

◆ GetShort()

xbShort xbXBase::GetShort ( const char *  p)

Get a portable short value.

Converts a short (16 bit integer) value stored at p from a portable format to the machine format.

Parameters
ppointer to memory containing the portable short value
Returns
the short value.

◆ GetULong()

xbULong xbXBase::GetULong ( const char *  p)

Get a portable unsigned long value.

Converts an unsigned long (32 bit integer) value stored at p from a portable format to the machine format.

Parameters
ppointer to memory containing the portable unsigned long value
Returns
the unsigned long value.

◆ PutDouble()

void xbXBase::PutDouble ( char *  c,
const xbDouble  d 
)

Put a portable double value.

Converts a double (64 floating point) value from machine format to a portable format and stores the converted value in the memory referenced by c.

Parameters
cpointer to memory to hold converted value
dvalue to be converted

◆ PutLong()

void xbXBase::PutLong ( char *  c,
const xbLong  l 
)

Put a portable long value.

Converts a long (32 bit integer) value from machine format to a portable format and stores the converted value in the memory referenced by c.

Parameters
cpointer to memory to hold converted value
lvalue to be converted

◆ PutShort()

void xbXBase::PutShort ( char *  c,
const xbShort  s 
)

Put a portable short value.

Converts a short (16 bit integer) value from machine format to a portable format and stores the converted value in the memory referenced by c.

Parameters
cpointer to memory to hold converted value
svalue to be converted

◆ PutULong()

void xbXBase::PutULong ( char *  c,
const xbULong  l 
)

Put a portable unsigned long value.

Converts an unsigned long (32 bit integer) value from machine format to a portable format and stores the converted value in the memory referenced by c.

Parameters
cpointer to memory to hold converted value
lvalue to be converted

◆ PutUShort()

void xbXBase::PutUShort ( char *  c,
const xbUShort  s 
)

Put a portable unsigned short value.

Converts an unsigned long (16 bit integer) value from machine format to a portable format and stores the converted value in the memory referenced by c.

Parameters
cpointer to memory to hold converted value
svalue to be converted

◆ RemoveDbfFromDbfList()

xbShort xbXBase::RemoveDbfFromDbfList ( xbDbf d)

Remove dbf from dbf list.

Removes the specified xbDbf class instance from the list of dbf's.

Parameters
dxbDbf to be removed
Returns
One of the following return codes:

Return CodeDescription
XB_NO_ERRORNo error

◆ SetDefaultDateFormat()

void xbXBase::SetDefaultDateFormat ( const xbString f)
inline

Member Data Documentation

◆ DbfList

xbDbList* xbXBase::DbfList
protected

◆ EndianType

xbShort xbXBase::EndianType
protected

◆ FreeDbfList

xbDbList* xbXBase::FreeDbfList
protected

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