TFS Cleanup Functions
The TFS cleanup API. The functions here are located in Transactional File Server Interface Library. Linker option: More...
Collaboration diagram for TFS Cleanup Functions:
Functions |
|
| RDM_RETCODE | rdm_tfsDropDatabase (RDM_TFS tfs, const RDM_TCHAR_T *db_namespec) |
| Drop the specified database. More... | |
| RDM_RETCODE | rdm_tfsFree (RDM_TFS hTFS) |
| Terminate a TFS service. More... | |
Detailed Description
The TFS cleanup API. The functions here are located in Transactional File Server Interface Library. Linker option:
-lrdmtfsFunction Documentation
rdm_tfsDropDatabase()
| RDM_RETCODE rdm_tfsDropDatabase | ( | RDM_TFS | tfs, |
| const RDM_TCHAR_T * | db_namespec | ||
| ) |
#include <rdmtfsapi.h>
Drop the specified database.
This function drops the entire contents of the database, including
- The database content files
- The database schema files
- The database log files
- All SQL related files
- The database directory
It will fail if the database is open by any other users. This operation is not transactional and cannot be undone or rolled back.
This function is primarily used to maintain temporary or working databases that exist only for the duration of the application program.
- Return values
-
sOKAY Normal, successful return. eDBOPENED Operation not completed because database is open.
- See also
- rdm_rdmAllocTFS
- rdm_tfsSetOptions
- rdm_tfsAllocDatabase
- rdm_tfsFree
- Database Name Specification (db_namespec)
- Parameters
-
[in] tfs [in] A TFS handle [in] db_namespec [in] The database name specification for the database to be dropped
rdm_tfsFree()
| RDM_RETCODE rdm_tfsFree | ( | RDM_TFS | hTFS | ) |
#include <rdmtfsapi.h>
Terminate a TFS service.
- Return values
-
sOKAY Normal, successful return.
- See also
- rdm_rdmAllocTFS
- Parameters
-
[in] hTFS [in] The TFS instance