Função LocalDBGetVersionInfo

2017-03-08

Retorna informações para a versão especificada do SQL Server Express LocalDB, como se ela existe e o número de versão completo do LocalDB (incluindo números de build e versão).

As informações são retornadas na forma de um structLocalDBVersionInfo nomeado, que tem a definição a seguir.

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;

Arquivo de cabeçalho: sqlncli.h

Sintaxe

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

Parâmetros

wszVersionName
[Entrada] O nome da versão do LocalDB.

pVersionInfo
[Saída] O buffer para armazenar as informações sobre a versão do LocalDB.

dwVersionInfoSize
[Entrada] Contém o tamanho do buffer VersionInfo .

Devoluções

S_OK
A função foi bem-sucedida.

LOCALDB_ERROR_NOT_INSTALLED
O SQL Server Express LocalDB não está instalado no computador.

LOCALDB_ERROR_INVALID_PARAMETER
Um ou mais parâmetros de entrada especificados são inválidos.

LOCALDB_ERROR_UNKNOWN_VERSION
A versão do LocalDB especificada não existe.

LOCALDB_ERROR_INTERNAL_ERROR
Ocorreu um erro inesperado. Consulte o log de eventos para obter detalhes.

Detalhes

A lógica por trás da introdução do argumento de struct tamanho (lpVersionInfoSize) é permitir que a API retorne diferentes versões do LocalDBVersionInfostruct, habilitando efetivamente a compatibilidade para frente e para trás.

Se o struct argumento de tamanho (lpVersionInfoSize) corresponder ao tamanho de uma versão conhecida do LocalDBVersionInfostruct, essa versão será struct retornada. Caso contrário, LOCALDB_ERROR_INVALID_PARAMETER será retornado.

Um exemplo típico de uso da API LocalDBGetVersionInfo tem esta aparência:

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

Observações

Para obter um exemplo de código que usa a API localdb, consulte a Referência do SQL Server Express LocalDB.

Consulte Também

Informações de cabeçalho e versão do SQL Server Express LocalDB

Partilhar via