Index Methods
Chapter Updated 2/12/99
| Method | Description | 
|---|---|
| CheckIndxIntegrity | Checks an index file for integrity | 
| CloseIndex | Optional, closes an index. Closing the DBF file will close any open indexes. | 
| CreateIndex | Create an index | 
| FindKey | Find a key in an index file | 
| GetFirstKey | Get the first key in an index | 
| GetLastKey | Get the last key in an index | 
| GetNextKey | Get the next key in an index | 
| GetPrevKey | Get the previous key in an index | 
| KeyExists | Determine if a key exists w/o positioning DBF file | 
| OpenIndex | Open an index | 
| ReIndex | Rebuilds an index | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| XB_LOCK_FAILED | Read lock not successfull | 
| XB_NOT_OPEN | File not open | 
| XB_INVALID_RECORD | Invalid record number | 
| XB_SEEK_ERROR | Seek routine error | 
| XB_WRITE_ERROR | Write routine error | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| XB_NO_MEMORY | Memory error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_INVALID_KEY_EXPRESSION | Bad index key expression | 
| XB_NOT_OPEN | The database was not open | 
| XB_SEEK_ERROR | Seek error encountered | 
| XB_READ_ERROR | Read error encountered | 
| Expression | Description | 
|---|---|
| "LASTNAME" | Index on LASTNAME only. | 
| "LASTNAME+FIRSTNAME" | Index on LASTNAME and FIRSTNAME | 
| "LASTNAME-FIRSTNAME" | Index on LASTNAME and FIRSTNAME, all spaces between the two fields removed. | 
| "LASTNAME-','FIRSTNAME" | Index on LASTNAME and FIRSTNAME, insert a comma between the two values, remove spaces between the two fields. | 
| Operator | Key Type | Description | 
|---|---|---|
| + | Character | Concatonate string fields | 
| - | Character | Concatonate string fields, remove trailing spaces | 
| 'literal' | Character | include literal value | 
| "literal" | Character | include literal value | 
| + | Numeric | Add two numeric fields togethor | 
| - | Numeric | Subtract one numeric field from another | 
| * | Numeric | Mulitply two numeric fields togethor | 
| / | Numeric | Divide one numeric field into another | 
| ** | Numeric | Exponential | 
| Return Code | Description | 
|---|---|
| XB_FOUND | The key was found | 
| XB_NOT_FOUND | The key was not found | 
| XB_NO_MEMORY | Memory error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_SEEK_ERROR | Seek error encountered | 
| XB_READ_ERROR | Read error encountered | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| XB_NO_MEMORY | Memory error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_SEEK_ERROR | Seek error encountered | 
| XB_READ_ERROR | Read error encountered | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| XB_NO_MEMORY | Memory error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_SEEK_ERROR | Seek error encountered | 
| XB_READ_ERROR | Read error encountered | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| XB_NO_MEMORY | Memory error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_SEEK_ERROR | Seek error encountered | 
| XB_READ_ERROR | Read error encountered | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| XB_NO_MEMORY | Memory error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_SEEK_ERROR | Seek error encountered | 
| XB_READ_ERROR | Read error encountered | 
| Return Code | Description | 
|---|---|
| XB_FOUND | The key was found | 
| XB_NOT_FOUND | The key was not found | 
| XB_NO_MEMORY | Memory error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_SEEK_ERROR | Seek error encountered | 
| XB_READ_ERROR | Read error encountered | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| XB_NO_MEMORY | Memory error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_INVALID_KEY_EXPRESSION | Bad key in index | 
| XB_NOT_OPEN | The database was not open | 
| XB_SEEK_ERROR | Seek error encountered | 
| XB_READ_ERROR | Read error encountered | 
| Return Code | Description | 
|---|---|
| XB_NO_ERROR | If there is no error | 
| XB_OPEN_ERROR | Could not open index file | 
| XB_WRITE_ERROR | Error writing data | 
| XB_CLOSE_ERROR | Error closing work file | 
(c)1997 StarTech
