DbiGetSesInfo

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

DbiGetSesInfo

Return to chapter overview

C syntax

DBIResult DBIFN DbiGetSesInfo (psesInfo);

Delphi syntax

function DbiGetSesInfo (var sesInfo: SESInfo): DbiResult stdcall;

Description

DbiGetSesInfo retrieves the environment settings for the current session.

Parameters

psesInfo                Type: pSESInfo                (Output)
Pointer to the client-allocated SESInfo structure.

Usage

This function provides the client with information about the resources attached to the current session, including the number of database handles and open cursors (when the session is closed, these resources are released). This function also returns the session ID and name, the current private directory, and the lock retry time for repeated attempts to lock a table. The lock retry time is specified by DbiSetLockRetry.

Completion state

The session information is returned in the specified SESInfo structure.

DbiResult

Meaning

DBIERR_NONE

The session information was returned successfully.

DBIERR_INVALIDHNDL

psesInfo is NULL.

See also

DbiSetLockRetry, DbiStartSession, DbiCloseSession, DbiGetCurrSession, DbiSetCurrSession