Синтаксис функции DbiAddAlias
DbiAddAlias (пропущено в BDE.HLP & Руководстве пользователя)
Синтаксис:
DBIResult DbiAddAlias( [hCfg], pszAliasName, pszDriverType, pszParams, bPersistent );
Описание:
DbiAddAlias добавляет псевдоним в конфигурационный файл, связанный с текущим сеансом.
Параметры:
hCfg Type: hDBICfg (Входящий) Для BDE 2.5 данный параметр должен быть NULL. Указывает, что конфигурация действует в течение текущего сеанса. Другие значения для BDE 2.5 не поддерживаются.
pszAliasName Type: pCHAR (Входящий) Указатель на имя псевдонима. Это имя нового псевдонима, который должен быть добавлен.
pszDriverType Type: pCHAR (Входящий) Указатель на тип устройства. Это тип устройства для добавляемого псевдонима. Если данный параметр NULL, псевдоним будет добавлен для базы данных STANDARD. Если указан szPARADOX, szDBASE или szASCII, будет добавлена запись в генератор псевдонимов базы данных STANDARD для указания того, что данный тип будет предпочтительным типом устройства. Если указано имя устройства, то оно должно существовать в измененном файле конфигурации.
pszParams Type: pCHAR (Входящий) Указатель на список дополнительных параметров. Данный список определяется следующим образом: "AliasOption: Option Data[;AliasOption: Option Data][;...]". AliasOption должен соответствовать одному из значений, возвращаемому DbiOpenCfgInfoList. Для псевдонимов базы данных STANDARD, единственно необходимый параметр - PATH, остальные игнорируются (без ошибок).
Пример 1: Чтобы установить путь для использования базы данных STANDARD: "PATH:c:\mydata"
Пример 2: Чтобы установить имя сервера и имя пользователя для использования драйвера SQL: "SERVER NAME: server:/path/database;USER NAME: myname"
bPersistent Type: BOOL (Входящий) Определяет область действия нового псевдонима. TRUE Сохраняется в файле конфигурации для будующих сеансов. FALSE Для использования только в течение текущего сеанса. Псевдоним удаляется в конце сеанса (или при выходе из программы).
Использование: Созданный данной функцией псевдоним будет иметь параметры по умолчанию, хранимые в списке параметров драйверов "DB OPEN", если только оне не перекрыты в параметре pszParams. Вы можете использовать DbiOpenCfgInfoList, чтобы изменить значение по умолчанию после добавления псевдонима с помощью DbiAddAlias.
Для псевдонимов стандартной базы данных все параметры pszParams за исключением PATH игнорируются.
Предварительные условия: DbiInit должен вызываться до вызова DbiAddAlias.
Возвращаемые значения DBIResult: DBIERR_INVALIDPARAM Имя псевдонима Null или один из следующих типов pszDriverType: szASCII, szDBASE, szPARADOX. В последнем случае используйте NULL pszDriverType для указания на базу данных STANDARD.
DBIERR_NONE Псевдоним был успешно добавлен.
DBIERR_NAMENOTUNIQUE Существует другой псевдоним с тем же именем (работает когда bPersistent равен TRUE).
DBIERR_OBJNOTFOUND Один (или более) из дополнительных параметров, указанных в pszParams не соответствуют правильным типам в секции драйверов конфигурационного файла.
DBIERR_UNKNOWNDRIVER Имя устройства в конфигурационном файле при сопоставлении с pszDriverType не найдено. Смотри также: DbiInit, DbiOpenCfgInfoList [000714]
