VDKXTable Class Reference
Provides a xbDbf wrapper.
More...
#include <vdkxtable.h>
List of all members.
Public Member Functions
Public Attributes
Protected Attributes
-
VDKString name
- table name
-
IndexList iList
- indexes list
Detailed Description
Provides a xbDbf wrapper.
Since it is a derived class of xbDbf, most behaviours are inherited. Refer to xdb reference for further informations.
Constructor & Destructor Documentation
Constructor
- Parameters:
-
| owner | owner xdb |
| name | table name can be either with or without .dbf extension |
Member Function Documentation
xbShort VDKXTable::Close |
( |
void |
|
) |
|
Close table and all associated indexes. Returns:
- XB_NO_ERROR no errors
- XB_NOT_OPEN file wasn't opened
xbShort VDKXTable::Create |
( |
VDKXRecordTemplate * |
tpl, |
|
|
bool |
overwrite = false | |
|
) |
| | |
Creates a table
- Parameters:
-
| tpl | a VDKXRecordTemplate |
| overwrite | if true and table exist will be truncated and overwritten. Returns:
- XB_NO_ERROR no errors
- XB_FILE_EXISTS file exist and overwrite flag = false
- XB_OPEN_ERROR couldn't open file
- XB_NO_MEMORY mem allocation error
- XB_WRITE_ERROR couldn't write on device
|
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:
- XB_NO_ERROR no errors
- XB_INVALID_RECORD invalid record number
- XB_LOCK_FAILED couldn't lock file
- XB_NOT_OPEN file not open
- XB_SEEK_ERROR seek routine error
- XB_WRITE_ERROR couldn't write
Returns an index given an ordinal position
- Parameters:
-
| order | index ordinal position Returns (VDKXTableIndex*) NULL on failure |
Returns an index given a name
- Parameters:
-
| name | index name 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:
- XB_NO_ERROR no errors
- XB_INVALID_RECORD invalid record number
- XB_LOCK_FAILED couldn't lock file
- XB_NOT_OPEN file not open
- XB_SEEK_ERROR seek routine error
- XB_WRITE_ERROR couldn't write
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:
- XB_NO_ERROR no errors
- XB_INVALID_RECORD invalid record number
- XB_LOCK_FAILED couldn't lock file
- XB_NOT_OPEN file not open
- XB_SEEK_ERROR seek routine error
- XB_WRITE_ERROR couldn't write
xbShort VDKXTable::Open |
( |
void |
|
) |
|
Opens table. Returns:
- XB_NO_ERROR no errors
- XB_OPEN_ERROR couldn't open file
- XB_NO_MEMORY mem allocation error
- XB_WRITE_ERROR couldn't write on device
- XB_NOT_XBASE not an xdb file type
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:
- XB_NO_ERROR no errors
- XB_INVALID_RECORD invalid record number
- XB_LOCK_FAILED couldn't lock file
- XB_NOT_OPEN file not open
- XB_SEEK_ERROR seek routine error
- XB_WRITE_ERROR couldn't write
bool VDKXTable::RemoveIndex |
( |
char * |
name |
) |
|
Removes an index from table
- Parameters:
-
| 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.
- Parameters:
-
Member Data Documentation
sets/gets active index ordinal position. Setting Order to -1 no active index will be used.
If false all record marked for deletion will be ignored on common table operations.
The documentation for this class was generated from the following files: