LocalDBGetVersionInfo function

Applies to:SQL Server

Vrátí informace pro zadanou verzi místní databáze SQL Serveru Express, například informace o tom, jestli existuje, a úplné číslo verze LocalDB (včetně čísel buildu a verze).

Informace jsou vráceny ve formě pojmenovaného structLocalDBVersionInfo, který má následující definici.

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

[Vstup] Název verze LocalDB.

pVersionInfo

[Výstup] Vyrovnávací paměť pro uložení informací o verzi LocalDB.

dwVersionInfoSize

[Input] Holds the size of the VersionInfo buffer.

Returns

S_OK: Funkce byla úspěšná.

Error	Description
LOCALDB_ERROR_NOT_INSTALLED	SQL Server Express LocalDB není v počítači nainstalovaný.
LOCALDB_ERROR_INVALID_PARAMETER	Jeden nebo více zadaných vstupních parametrů je neplatný.
LOCALDB_ERROR_UNKNOWN_VERSION	Zadaná verze LocalDB neexistuje.
LOCALDB_ERROR_INTERNAL_ERROR	Došlo k neočekávané chybě. Podrobnosti najdete v protokolu událostí.

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. V opačném případě se vrátí LOCALDB_ERROR_INVALID_PARAMETER.

Typický příklad LocalDBGetVersionInfo použití rozhraní API vypadá takto:

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

Remarks

Ukázku kódu, která používá rozhraní LocalDB API, najdete v referenčních informacích k SQL Serveru Express LocalDB.

Related content

• Informace o hlavičce a verzi SQL Serveru Express LocalDB