Functions
TFS Cleanup Functions
RDM C/C++ API Reference » RDM TFS APIs
Collaboration diagram for TFS Cleanup Functions:

Functions
RDM_RETCODE rdm_tfsDropDatabase (RDM_TFS tfs, const char *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. Linker option:

    -lrdmtfs

Function Documentation

rdm_tfsDropDatabase()

RDM_RETCODE rdm_tfsDropDatabase ( RDM_TFS tfs,
const char * 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
sOKAY Normal, successful return.
eDBOPENED Operation not completed because database is open.
sNODB Database does not exist.
See also
rdm_rdmAllocTFS
rdm_tfsSetOptions
rdm_tfsAllocDatabase
rdm_tfsFree
Parameters
[in] tfs A TFS handle
[in] dbNameSpec The database name specification for the database to be dropped
Examples
core01Example_main.c, core36Example_main.c, core37Example_main.c, core38Example_main.c, cpp50Example_main.cpp, and cpp55Example_main.cpp.

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 The TFS instance
Examples
core01Example_main.c, core08Example_main.c, core09Example_main.c, core12Example_main.c, core15Example_main.c, core16Example_main.c, core17Example_main.c, core18Example_main.c, core19Example_main.c, core31Example_main.c, core32Example_main.c, core33Example_main.c, core34Example_main.c, core35Example_main.c, core36Example_main.c, core37Example_main.c, core38Example_main.c, cpp50Example_main.cpp, cpp55Example_main.cpp, cpp70Example_main.cpp, learn/bookStore_client.c, learn/bookStore_embed.c, learn/bookStore_vxWorks7.c, odbc01Example_main.c, tfs/rdmAllocTFS.c, tfsrdbc/rdbcTfsAlloc.c, and tfsrdbc/rdbcTfsAllocDefault.c.