DbiCloseDatabase

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiCloseDatabase

Return to chapter overview

C syntax

DBIResult DBIFN DbiCloseDatabase (phDb);

Delphi syntax

function DbiCloseDatabase (var hDb: hDBIDb): DBIResult stdcall;

Description

DbiCloseDatabase closes a database and all cursors associated with the database handle.

Parameters

phDb

Type: phDBIDb

(Input)

Pointer to the database handle returned by DbiOpenDatabase.

Usage

DbiCloseDatabase releases the provided database handle and any associated cursors.

When closing the standard database handle with DbiCloseDatabase, all dBASE, FoxPro, Access, Paradox, and Text tables previously opened within this database are closed and the associated resources released.

SQL: Each database represents one or more connections to a specific SQL server. Closing the database closes those connections as well as releases other client database resources that have been acquired.

Prerequisites

DbiInit and DbiOpenDatabase must be called before a valid database handle is available.

Completion state

The client handle, phDb, is set to NULL.

DbiResult

Meaning

DBIERR_NONE

The database specified by phDb was closed successfully.

DBIERR_INVALIDHNDL

The specified database handle is invalid or NULL.

See also

DbiOpenDatabase, DbiExit, DbiCloseCursor