DbiCloseSession

C syntax

DBIResult DBIFN DbiCloseSession (hSes);

Delphi syntax

function DbiCloseSession (hSes: hDBISes): DbiResult stdcall;

Description

DbiCloseSession closes the session associated with the given session handle.

Parameters

hSes Type: hDBISes (Input)
Specifies the session handle.

Completion state

When a session is closed, all resources (database handles, cursors, table level locks, and record level locks) attached to the given session are released. Any buffers that BDE has allocated that are specific to the session are also released. If hSes is the session handle of the current session, the client application is set to the default session after DbiCloseSession is completed. The client application cannot close the default session without exiting the client.

DbiResult	Meaning
DBIERR_NONE	The session specified by hSes was closed successfully.
DBIERR_INVALIDSESHANDL	The specified session handle is invalid or NULL, or the session has already been closed.