Bde.DBTables.TSession.ModifyAlias

From RAD Studio API Documentation
Jump to: navigation, search

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

Delphi

procedure ModifyAlias(Name: string; List: TStrings);

C++

void __fastcall ModifyAlias(System::UnicodeString Name, System::Classes::TStrings* List);

Description

Adds or changes parameters for a Borland Database Engine (BDE) alias.

Call ModifyAlias to change the parameters for a specified BDE alias. Name is the name of the alias to modify. List is a string list object previously populated with parameter values to add or change. An application must create and maintain List.

Populate List with parameter strings before calling ModifyAlias. List needs only to contain the parameters to change. If ModifyAlias passes a parameter for which a value already exists, the new parameter replaces the existing one. New parameters that are not yet defined for the alias are added to the existing parameters. If List is empty, ModifyAlias does not change any existing parameters.

ModifyAlias changes the alias parameters for the session, but does not change them in the BDE configuration file. To modify a driver in the BDE configuration file, follow the call to ModifyAlias with a call to SaveConfigFile.

See Also