Products Support Documentation Download
TFS Cleanup Functions
Collaboration diagram for TFS Cleanup Functions:

Functions

RDM_RETCODE rdm_tfsDropDatabase (RDM_TFS tfs, const RDM_TCHAR_T *dbNameSpec)
 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 (TFS). Linker option:

    -lrdmtfs

Function Documentation

◆ rdm_tfsDropDatabase()

RDM_RETCODE rdm_tfsDropDatabase ( RDM_TFS  tfs,
const RDM_TCHAR_T dbNameSpec 
)

#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
sOKAYNormal, successful return.
eDBOPENEDOperation not completed because database is open.
See also
rdm_rdmAllocTFS
rdm_tfsSetOptions
rdm_tfsAllocDatabase
rdm_tfsFree
Parameters
[in]tfsA TFS handle
[in]dbNameSpecThe database name specification for the database to be dropped
Examples:
tutorials/HelloWorld/hello_worldTutorial_main.c.

◆ rdm_tfsFree()

RDM_RETCODE rdm_tfsFree ( RDM_TFS  hTFS)

#include <rdmtfsapi.h>

Terminate a TFS service.

Return values
sOKAYNormal, successful return.
See also
rdm_rdmAllocTFS
Parameters
[in]hTFSThe TFS instance
Examples:
tutorials/HelloWorld/hello_worldTutorial_main.c.