Bde.DBTables.TSessionList.FindSession

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
Bde.DBTables.pas
Bde.DBTables.hpp
Unit: Bde.DBTables
Parent: TSessionList

Delphi

function FindSession(const SessionName: string): TSession;

C++

TSession* __fastcall FindSession(const System::UnicodeString SessionName);

Description

Searches the list of sessions for a specified session.

Call FindSession to determine whether or not a specified session exists. SessionName specifies the session to search for.

FindSession compares the SessionName parameter to the SessionName property for each session component in the session list. If a match is found, FindSession returns a pointer to the session component. If an application passes an empty string in SessionName, FindSession returns the default session, Session. If a match is not found, FindSession returns nil (Delphi) or NULL (C++).

See Also