RemoveTable

RemoveTable removes a selected table from the ObjectDatabase++ control file.
unsigned int RemoveTable (
   unsigned int tableID,
   bool deleteFiles = true
);

Parameters

tableIDthe table ID defining the table's handle.
deleteFilesIf this variable is set to true, RemoveTable deletes the *.odt, *.odi and *.odm files associated with the selected table from the disk, otherwise this method just removes the table entry from the control file.

Return Values

If the method succeeds, the return value is zero else see error codes for more details.

Remarks

  • RemoveTable does not delete the table or any of its indexes if deleteFiles is set to false.
  • RemoveTable is not part of the a transaction and can not be aborted, however the database does need to be in exclusive mode.
  • You can use the AddTable method to add back a table after it has been removed.
Example Use
CODBPP database;
char16_t *message;
if((error = database.OpenDatabase(TEXT("YourDatabase"))) == NO_ERROR
&& (error = database.BeginTransaction(CODBPP::EXCLUSIVE)) == NO_ERROR){
   error = database.RemoveTable(1);
}
if(error && database.GetErrorMessage(&message) == NO_ERROR)
   MessageBox(message);
database.CloseDatabase();

Also See

AddTable, CloseTable, CreateTable, OpenTable
Comments (0)Listen All
Characters left: 2500
 
Ekky Software Homepage Ekky Software Homepage ObjectDatabase++ TScript Ekky Software Homepage Ekky Software Homepage ObjectDatabase++ TScript