LocalDBGetVersionInfo, fonction

Retourne des informations pour la version sql Server Express LocalDB spécifiée, par exemple s’il existe ou non et le numéro de version localDB complet (y compris les numéros de build et de mise en production).

Les informations sont retournées sous la forme d’un structlocalDBVersionInfo nommé, 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] Nom de la version localDB.

pVersionInfo
[Sortie] Mémoire tampon pour stocker les informations relatives à 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 de LocalDB spécifiée 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 raison d’être de l’introduction de l’argument struct de taille (lpVersionInfoSize) consiste à permettre à l’API de retourner différentes versions du localDBVersionInfostruct, ce qui permet une compatibilité descendante et descendante.

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

Un exemple classique d’utilisation de l’API LocalDBGetVersionInfo ressemble à ceci :

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

Remarques

Pour obtenir un exemple de code qui utilise l’API LocalDB, consultez la référence SQL Server Express LocalDB.

Voir aussi

Informations sur l’en-tête et la version SQL Server Express LocalDB