Fonction LocalDBGetVersionInfo

Article
03/08/2017

Retourne des informations pour la version spécifiée de SQL Server Express LocalDB, notamment si elle existe, ainsi que le numéro de version complet de LocalDB (avec les numéros de build et de version).

Les informations sont retournées sous la forme d’un struct local nommé LocalDBVersionInfo, qui a la définition suivante.

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;

Fichier d'en-tête : sqlncli.h

Syntaxe

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

Paramètres

wszVersionName
[Entrée] Le nom de version de LocalDB.

pVersionInfo
[Sortie] La mémoire tampon pour stocker des informations sur la version de LocalDB.

dwVersionInfoSize
[Entrée] Contient la taille de la mémoire tampon VersionInfo .

Retours

S_OK
La fonction a réussi.

LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB n'est pas installé sur l'ordinateur.

LOCALDB_ERROR_INVALID_PARAMETER
Un ou plusieurs paramètres d'entrée spécifiés ne sont pas valides.

LOCALDB_ERROR_UNKNOWN_VERSION
La version spécifiée de LocalDB n'existe pas.

LOCALDB_ERROR_INTERNAL_ERROR
Une erreur inattendue s’est produite. Pour plus d'informations, consultez le journal des événements.

Détails

La logique derrière l’introduction de l’argument struct size (lpVersionInfoSize) est de permettre à l’API de retourner différentes versions de LocalDBVersionInfostruct, ce qui permet efficacement la compatibilité avant et descendante.

Si l’argument struct size (lpVersionInfoSize) correspond à la taille d’une version connue de LocalDBVersionInfostruct, cette version de struct est retournée. Sinon, LOCALDB_ERROR_INVALID_PARAMETER est retourné.

Voici un exemple classique d’utilisation de l’API LocalDBGetVersionInfo :

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

Notes

Pour un exemple de code qui utilise l'API LocalDB, consultez SQL Server Express LocalDB Reference.

Voir aussi

En-tête et informations de version SQL Server Express LocalDB

Partager via