LocalDBGetVersionInfo function

Applies to:SQL Server

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

Сведения возвращаются в виде именованного structLocalDBVersionInfo, имеющего следующее определение.

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;

Header file:msoledbsql.h

Syntax

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

Arguments

wszVersionName

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

pVersionInfo

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

dwVersionInfoSize

[Input] Holds the size of the VersionInfo buffer.

Returns

S_OK: функция завершилась успешно.

Error	Description
LOCALDB_ERROR_NOT_INSTALLED	SQL Server Express LocalDB не установлен на компьютере.
LOCALDB_ERROR_INVALID_PARAMETER	Один или несколько указанных входных параметров недопустимы.
LOCALDB_ERROR_UNKNOWN_VERSION	Указанная версия LocalDB не существует.
LOCALDB_ERROR_INTERNAL_ERROR	Произошла непредвиденная ошибка. Подробные сведения см. в журнале событий.

Details

The rationale behind the introduction of the struct size argument (lpVersionInfoSize) is to enable the API to return different versions of the LocalDBVersionInfostruct, effectively enabling forward and backward compatibility.

If the struct size argument (lpVersionInfoSize) matches the size of a known version of the LocalDBVersionInfostruct, that version of the struct is returned. В противном случае возвращается LOCALDB_ERROR_INVALID_PARAMETER.

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

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

Remarks

Пример кода, использующий API LocalDB, см. в справочнике по SQL Server Express LocalDB.

Related content

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