Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

xbXBase Class Reference

xbXBase class More...

#include <xbase.h>

Inheritance diagram for xbXBase:

xbDate List of all members.

Public Methods

 ~xbXBase ()
 Destructor.

 xbXBase ()
 Constructor.

xbShort AddDbfToDbfList (xbDbf *d, const char *DatabaseName)
 Add dbf to dbf list.

xbDbfGetDbfPtr (const char *Name)
 Get pointer to named dbf.

xbShort DirectoryExistsInName (const char *Name)
 Get offset of last PATH_SEPARATOR in Name.

xbShort GetEndianType (void)
void DisplayError (const xbShort ErrorCode) const
 Display description of error code.

xbDouble GetDouble (const char *p)
 Get a portable double value.

xbLong GetLong (const char *p)
 Get a portable long value.

xbULong GetULong (const char *p)
 Get a portable unsigned long value.

xbShort GetShort (const char *p)
 Get a portable short value.

void PutLong (char *p, const xbLong l)
 Put a portable long value.

void PutShort (char *p, const xbShort s)
 Put a portable short value.

void PutULong (char *p, const xbULong l)
 Put a portable unsigned long value.

void PutUShort (char *p, const xbUShort s)
 Put a portable unsigned short value.

void PutDouble (char *p, const xbDouble d)
 Put a portable double value.

xbShort RemoveDbfFromDbfList (xbDbf *)
 Remove dbf from dbf list.


Static Public Methods

const char * GetErrorMessage (const xbShort ErrorNo)
 Get description of error code.


Protected Attributes

xbDbListDbfList
xbDbListFreeDbfList
xbShort EndianType

Detailed Description

xbXBase class


Constructor & Destructor Documentation

xbXBase::~xbXBase  
 

Destructor.

xbXBase::xbXBase void   
 

Constructor.


Member Function Documentation

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:
d  the xbDbf instance to be added
DatabaseName  name of the database
Returns:
One of the following return codes:

Return CodeDescription
XB_NO_ERRORNo error
XB_NO_MEMORYOut of memory

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:
Name  string to be scanned.
Returns:
offset of last occurance of PATH_SEPARATOR

void xbXBase::DisplayError const xbShort    ErrorNo const
 

Display description of error code.

Displays a text description of an XBase error code.

Parameters:
ErrorNo  error to be displayed

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.

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:
p  pointer to memory containing the portable double value
Returns:
the double value.

xbShort xbXBase::GetEndianType void    [inline]
 

const char * xbXBase::GetErrorMessage const xbShort    ErrorNo [static]
 

Get description of error code.

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

Parameters:
ErrorNo  error number of description to be returned

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:
p  pointer to memory containing the portable long value
Returns:
the long value.

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:
p  pointer to memory containing the portable short value
Returns:
the short value.

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:
p  pointer to memory containing the portable unsigned long value
Returns:
the unsigned long value.

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:
c  pointer to memory to hold converted value
s  value to be converted

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:
c  pointer to memory to hold converted value
s  value to be converted

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:
c  pointer to memory to hold converted value
s  value to be converted

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:
c  pointer to memory to hold converted value
s  value to be converted

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:
c  pointer to memory to hold converted value
s  value to be converted

xbShort xbXBase::RemoveDbfFromDbfList xbDbf   d
 

Remove dbf from dbf list.

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

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

Return CodeDescription
XB_NO_ERRORNo error


Member Data Documentation

xbDbList* xbXBase::DbfList [protected]
 

xbShort xbXBase::EndianType [protected]
 

xbDbList* xbXBase::FreeDbfList [protected]
 


The documentation for this class was generated from the following files:
Generated on Mon Oct 27 00:38:01 2003 for Xbase Class Library by doxygen1.2.18