LocalDBGetVersionInfo-Funktion

Gibt Informationen zur angegebenen SQL Server Express-LocalDB-Version zurück, z. B., ob sie vorhanden ist sowie die vollständige LocalDB-Versionsnummer (inklusive Build- und Releasenummer).

Die Informationen werden in Form des struct LocalDBVersionInfo mit folgender Definition zurückgegeben.

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;

Headerdatei: sqlncli.h

Syntax

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

Parameter

• wszVersionName
  [Eingabe] Der Name der LocalDB-Version.

• pVersionInfo
  [Ausgabe] Der Puffer zum Speichern der Informationen zur LocalDB-Version.

• dwVersionInfoSize
  [Eingabe] Speichert die Größe des VersionInfo-Puffers.

Rückgabewerte

• S_OK
  Die Funktion wurde erfolgreich ausgeführt.

• LOCALDB_ERROR_NOT_INSTALLED
  SQL Server Express LocalDB ist nicht auf dem Computer installiert.

• LOCALDB_ERROR_INVALID_PARAMETER
  Mindestens ein angegebener Eingabeparameter ist ungültig.

• LOCALDB_ERROR_UNKNOWN_VERSION
  Die angegebene LocalDB-Version ist nicht vorhanden.

• LOCALDB_ERROR_INTERNAL_ERROR
  Ein unerwarteter Fehler ist aufgetreten. Weitere Informationen finden Sie im Ereignisprotokoll.

Details

Der Grund für die Einführung des struct-Größenarguments (lpVersionInfoSize) ist es, der API zu ermöglichen, verschiedene Versionen von LocalDBVersionInfo struct zurückzugeben und damit Aufwärts- und Abwärtskompatibilität effektiv zu unterstützen.

Falls das struct-Größenargument (lpVersionInfoSize) mit der Größe einer bekannten Version von LocalDBVersionInfo struct übereinstimmt, wird diese Version von struct zurückgegeben. Andernfalls wird LOCALDB_ERROR_INVALID_PARAMETER zurückgegeben.

Ein typisches Beispiel der LocalDBGetVersionInfo-API-Verwendung sieht folgendermaßen aus:

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

Hinweise

Ein Codebeispiel, in dem die LocalDB-API verwendet wird, finden Sie unter SQL Server Express LocalDB-Verweis.

Siehe auch

Konzepte

SQL Server Express LocalDB-Header und Versionsinformationen