Product Documentation

c-treeDB API for C++ - Developers Guide

Previous Topic

Next Topic

CTSession::FindDatabase

Syntax

CTBOOL FindDatabase(const CTString& Name, CTString& Path)

CTBOOL FindDatabase(const CTString& Name, CTString& Path, ULONG& uid)

CTBOOL FindDatabase(ULONG uid, CTString& Name, CTString& Path)

Parameters

  • Name [in or out] the database name
  • Path [out] the database path
  • uid [in or out] the database uid

Description

Locates a database in a session. If the prototype FindDatabase(CTString& Name, CTString& Path) is used, Name is an input, and the method returns the database path in Path. If the prototype FindDatabase(const CTString& Name, CTString& Path, ULONG& uid) is used, Name is an input, and the method returns the database path, and uid, in Path and uid, respectively. If the prototype FindDatabase(ULONG uid, CTString& Name, CTString& Path) is used, uid is an input, and the method returns the database name, and path in Name and Path respectively.

Return

FindDatabase() returns YES if the database is found, NO otherwise.

See also

FirstDatabase(), NextDatabase(), GetDatabase()

TOCIndex