Compartir vía

Función LocalDBGetVersionInfo

  • Artículo

Se aplica a: SQL Server

Devuelve información de la versión de SQL Server Express LocalDB especificada, por ejemplo si existe y el número de versión completo de LocalDB (incluida la compilación y los números de versión).

La información se devuelve en forma de una estructura denominada LocalDBVersionInfo, que tiene la siguiente definición.

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;

Archivo de encabezado: msoledbsql.h

Sintaxis

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

Parámetros

wszVersionName
[Entrada] El nombre de versión de LocalDB.

pVersionInfo
[Output] El búfer en el que se almacena información sobre la versión de LocalDB.

dwVersionInfoSize
[Entrada] Contiene el tamaño del búfer VersionInfo .

Devoluciones

S_OK
La función se ha realizado correctamente.

LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB no está instalado en el equipo.

LOCALDB_ERROR_INVALID_PARAMETER
Uno o más parámetros de entrada especificados no son válidos.

LOCALDB_ERROR_UNKNOWN_VERSION
La versión de LocalDB especificada no existe.

LOCALDB_ERROR_INTERNAL_ERROR
Se ha producido un error inesperado. Vea el registro de eventos para obtener detalles.

Detalles

La justificación detrás de la introducción del argumento de tamaño de estructura (lpVersionInfoSize) es permitir que la API devuelva diferentes versiones de localDBVersionInfostruct, lo que permite de forma eficaz la compatibilidad con versiones anteriores y posteriores.

Si el argumento de tamaño de estructura (lpVersionInfoSize) coincide con el tamaño de una versión conocida de LocalDBVersionInfostruct, se devuelve esa versión del struct. De lo contrario, se devuelve LOCALDB_ERROR_INVALID_PARAMETER.

Un ejemplo típico del uso de la API LocalDBGetVersionInfo tiene este aspecto:

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

Comentarios

Para obtener un ejemplo de código que utilice LocalDB API, vea SQL Server Express LocalDB Reference.

Consulte también

Información de encabezado y versión de SQL Server Express LocalDB