LocalDBGetVersionInfo-Funktion

Gibt Informationen für die angegebene SQL Server Express LocalDB-Version zurück, z. B. ob sie vorhanden ist, und die vollständige LocalDB-Versionsnummer (einschließlich Build- und Releasenummern).

Die Informationen werden in Form einer struct benannten LocalDBVersionInfo zurückgegeben, die die folgende Definition aufweist.

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);  

Die Parameter

wszVersionName
[Eingabe] Der Name der LocalDB-Version.

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

dwVersionInfoSize
[Eingabe] Enthält die Größe des VersionInfo-Puffers .

Rückkehr

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. Details finden Sie im Ereignisprotokoll.

Einzelheiten

Der Grund für die Einführung des struct Size-Arguments (lpVersionInfoSize) besteht darin, die API zu ermöglichen, verschiedene Versionen der LocalDBVersionInfostruct zurückzugeben, wodurch die Vorwärts- und Abwärtskompatibilität effektiv ermöglicht wird.

Wenn das struct Size-Argument (lpVersionInfoSize) mit der Größe einer bekannten Version der LocalDBVersionInfostruct übereinstimmt, wird diese Version der struct Zurückgegeben. Andernfalls wird LOCALDB_ERROR_INVALID_PARAMETER zurückgegeben.

Ein typisches Beispiel für die Verwendung der LocalDBGetVersionInfo-API sieht wie folgt aus:

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

Bemerkungen

Ein Codebeispiel, das die LocalDB-API verwendet, finden Sie in der SQL Server Express LocalDB-Referenz.

Siehe auch

SQL Server Express LocalDB-Header und Versionsinformationen