Функция LocalDBGetVersionsInfo

Статья
08/21/2023

Область применения: SQL Server

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

Сведения возвращаются в виде структуры с именем LocalDBVersionInfo, которая содержит следующее определение.

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;

Файл заголовка: msoledbsql.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
Произошла непредвиденная ошибка. Подробные сведения см. в журнале событий.

Сведения

Обоснование внедрения аргумента размера структуры (lpVersionInfoSize) заключается в том, чтобы API мог возвращать различные версии структуры LocalDBVersionInfoinfo, эффективно обеспечивая обратную и обратную совместимость.

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

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

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

Замечания

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

См. также

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

Поделиться через