vdkxdb 2.4.0
|
Provides a xbDbf wrapper. More...
#include <vdkxtable.h>
Inherits xbDbf.
Public Member Functions | |
void | SetOrder (char *name) |
VDKXTable (VDKXDatabase *owner, char *name) | |
virtual | ~VDKXTable () |
Destructor. | |
VDKString | Name () |
Returns table name. | |
xbShort | Create (VDKXRecordTemplate *tpl, bool overwrite=false) |
xbShort | Open (void) |
xbShort | Close (void) |
bool | RemoveIndex (char *name) |
VDKXTableIndex * | Index (char *name) |
VDKXTableIndex * | Index (xbShort order) |
xbShort | First () |
xbShort | Last () |
xbShort | Next () |
xbShort | Prev () |
IndexList * | NdxList () |
/internal | |
bool | IsOpen () |
return if table is open or not | |
Public Attributes | |
VDKReadOnlyValueProp < VDKXTable, xbLong > | Size |
table size in records | |
VDKReadWriteValueProp < VDKXTable, xbShort > | Order |
VDKReadWriteValueProp < VDKXTable, bool > | ShowDeleted |
Protected Attributes | |
VDKString | name |
table name | |
IndexList | iList |
indexes list | |
Provides a xbDbf wrapper.
Since it is a derived class of xbDbf, most behaviours are inherited. Refer to xdb reference for further informations.
VDKXTable::VDKXTable | ( | VDKXDatabase * | owner, |
char * | name | ||
) |
Constructor
owner | owner xdb |
name | table name can be either with or without .dbf extension |
xbShort VDKXTable::Close | ( | void | ) |
Close table and all associated indexes. Returns:
xbShort VDKXTable::Create | ( | VDKXRecordTemplate * | tpl, |
bool | overwrite = false |
||
) |
Creates a table
tpl | a VDKXRecordTemplate |
overwrite | if true and table exist will be truncated and overwritten. Returns:
|
xbShort VDKXTable::First | ( | ) |
Moves database pointer to first logical record. If there is no active index moves on first phisical record If ShowDeleted property is fale (default)moves to first logical/phisical undeleted record. Returns:
VDKXTableIndex * VDKXTable::Index | ( | char * | name | ) |
Returns an index given a name
name | index name Returns (VDKXTableIndex*) NULL on failure |
VDKXTableIndex * VDKXTable::Index | ( | xbShort | order | ) |
Returns an index given an ordinal position
order | index ordinal position Returns (VDKXTableIndex*) NULL on failure |
xbShort VDKXTable::Last | ( | ) |
Moves database pointer to last logical record If there is no active index moves on last phisical record If ShowDeleted property is fale (default)moves to last logical/phisical undeleted record. Returns:
xbShort VDKXTable::Next | ( | ) |
Moves database pointer to next logical record If there is no active index moves on next phisical record If ShowDeleted property is fale (default)moves to next logical/phisical undeleted record. Returns:
xbShort VDKXTable::Open | ( | void | ) |
Opens table. Returns:
xbShort VDKXTable::Prev | ( | ) |
Moves database pointer to previous logical record If there is no active index moves on previous phisical record If ShowDeleted property is fale (default)moves to previous logical/phisical undeleted record. Returns:
bool VDKXTable::RemoveIndex | ( | char * | name | ) |
Removes an index from table
name | index name. Returns true on success |
void VDKXTable::SetOrder | ( | char * | name | ) |
sets/gets active index Setting Order to NULL no active index will be used.
name | index file name |
VDKReadWriteValueProp<VDKXTable,xbShort> VDKXTable::Order |
sets/gets active index ordinal position. Setting Order to -1 no active index will be used.
VDKReadWriteValueProp<VDKXTable,bool> VDKXTable::ShowDeleted |
If false all record marked for deletion will be ignored on common table operations.