Синтаксис функции DbiAddAlias

Delphi , Базы данных , Alias

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

Функция DbiAddAlias используется для добавления алиаса в файл конфигурации, связанный с текущим сеансом.

Вот разбивка синтаксиса и параметров:

• hCfg: Указатель на файл конфигурации. Для BDE 2.5 этот параметр должен быть NULL.
• pszAliasName: Указатель на имя алиаса.
• pszDriverType: Указатель на тип драйвера. Если он установлен в NULL, алиас будет добавлен для стандартной базы данных. В противном случае он может быть установлен в szPARADOX, szDBASE или szASCII для указания предпочтительного типа драйвера.
• pszParams: Указатель на список дополнительных параметров в формате "AliasOption: Option Data[;AliasOption: Option Data][;...]". Параметры определены функцией DbiOpenCfgInfoList.
• bPersistent: Булевое значение, определяющее область действия нового алиаса. Если он установлен в TRUE, он будет сохранен в файле конфигурации для будущих сессий. Если он установлен в FALSE, он будет использоваться только во время текущей сессии.

Функция возвращает значение DBIResult, указывающее успех или неудачу операции:

• DBIERR_INVALIDPARAM: Имя алиаса равно NULL или один из следующих типов pszDriverType: szASCII, szDBASE или szPARADOX.
• DBIERR_NONE: Алиас был успешно добавлен.
• DBIERR_NAMENOTUNIQUE: Дубликат алиаса с тем же именем уже существует (только при bPersistent равном TRUE).
• DBIERR_OBJNOTFOUND: Один или более параметров в pszParams не соответствует типу в файле конфигурации.
• DBIERR_UNKNOWNDRIVER: Имя устройства в файле конфигурации не может быть найдено, соответствующее pszDriverType.

Обратите внимание, что функция DbiAddAlias создает алиас с параметрами по умолчанию, хранящимися в списке драйверов "DB OPEN", если они не overridden параметрами, указанными в pszParams. Вы можете использовать функцию DbiOpenCfgInfoList для изменения значений по умолчанию после добавления алиаса.

До вызова функции DbiAddAlias вам нужно вызвать функцию DbiInit, чтобы инициализировать интерфейс базы данных.

Функция DbiAddAlias добавляет псевдоним в конфигурационный файл, связанный с текущим сеансом, и позволяет настроить параметры для этого псевдонима.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: Alias ::