FairCom DB API for C

ctdbFindActiveDatabase

Get the handle of an active/connected database by name.

Declaration

CTHANDLE ctdbFindActiveDatabase(CTHANDLE Handle, pTEXT Name)

Description

ctdbFindActiveDatabase() retrieves the handle of an active/connected database in the session by name.

To get the handle of an active/connected database by the Unique Identifier, use ctdbFindActiveDatabaseByUID(). A database is active if it is connected to the session handle via its database handle.

To get the path of any database in the session dictionary by name, use ctdbFindDatabase().

Handle [in] the session handle.
Name [in] the string with the database name to lookup in the session.

Returns

ctdbFindActiveDatabase() returns the database handle or NULL if the database is not in the session dictionary or is not active/connected.