Функция LocalDBGetVersionsInfo

Возвращает сведения для указанной версии SQL Server Express LocalDB — факт ее существования и полный номер версии LocalDB (включая номер сборки и номер выпуска).

Сведения возвращаются в структуре struct с именем LocalDBInstanceInfo и следующим определением.

typedef struct _LocalDBVersionInfo
{
      // Contains the size of the LocalDBVersionInfo struct
      DWORD  cbLocalDBVersionInfoSize;

      // Holds the version name
      TLocalDBVersionwszVersion;

      // TRUE if the instance files exist on disk, FALSE otherwise
      BOOL   bExists;

      // Holds the LocalDB version for the instance in the format: major.minor.build.revision
      DWORD  dwMajor;
      DWORD  dwMinor;
      DWORD  dwBuild;
      DWORD  dwRevision;
} LocalDBVersionInfo;

Файл заголовка: sqlncli.h

Синтаксис

HRESULT LocalDBGetVersionInfo(
           PCWSTR wszVersionName,
           PLocalDBVersionInfo pVersionInfo,
           DWORD dwVersionInfoSize
);

Параметры

• wszVersionName
  [Вход] Имя версии LocalDB.

• pVersionInfo
  [Выход] Буфер для хранения сведений о версии LocalDB.

• dwVersionInfoSize
  [Вход] Содержит размер буфера VersionInfo.

Возвращаемые значения

• S_OK
  Функция выполнена успешно.

• LOCALDB_ERROR_NOT_INSTALLED
  Компонент SQL Server Express LocalDB не установлен на компьютере.

• LOCALDB_ERROR_INVALID_PARAMETER
  Один или несколько указанных входных параметров недопустимы.

• LOCALDB_ERROR_UNKNOWN_VERSION
  Указанная версия LocalDB не существует.

• LOCALDB_ERROR_INTERNAL_ERROR
  Произошла непредвиденная ошибка. Подробные сведения см. в журнале событий.

Сведения

Аргумент размера структуры struct (lpVersionInfoSize) был введен для того, чтобы API-вызов мог возвращать различные версии структуры LocalDBInstanceInfo struct, обеспечивая тем самым совместимость с предыдущими и следующими версиями.

Если аргумент размера структуры struct (lpVersionInfoSize) соответствует размеру известной версии LocalDBVersionInfo struct, то возвращается эта версия struct. В противном случае возвращается значение LOCALDB_ERROR_INVALID_PARAMETER.

Типичный пример использования функции API-вызова LocalDBGetInstanceInfo выглядит следующим образом:

LocalDBVersionInfo vi;
LocalDBVersionInfo(L”11.0”, &vi, sizeof(LocalDBVersionInfo));

Замечания

Образец кода, использующего API LocalDB, см. в разделе Справочник по SQL Server Express LocalDB

См. также

Основные понятия

Заголовок и сведения о версии SQL Server Express LocalDB