Função LocalDBGetVersionInfo

Artigo
03/20/2013

Retorna informações sobre a versão de LocalDB do SQL Server Express especificada, como se existe ou não, e o número da versão total do LocalDB (incluindo números de versão e compilação).

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

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 de versão de LocalDB.
pVersionInfo
[Saída] O buffer para armazenar as informações sobre a versão de LocalDB.
dwVersionInfoSize
[Entrada] Mantém tamanho do buffer VersionInfo.

Retorna

S_OK
A função foi bem-sucedida.
LOCALDB_ERROR_NOT_INSTALLED
O LocalDB do SQL Server Express 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 de LocalDB especificada não existe.
LOCALDB_ERROR_INTERNAL_ERROR
Erro inesperado. Consulte o log de eventos para obter detalhes.

Detalhes

A razão por trás da introdução do argumento de tamanho struct (lpVersionInfoSize) é permitir que a API retorne versões diferentes do LocalDBVersionInfo struct, habilitando compatibilidade com versões anteriores e posteriores.

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

Um exemplo típico de uso de API de LocalDBGetVersionInfo é semelhante a:

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

Comentários

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

Consulte também

Conceitos

Cabeçalho e informações de versão de LocalDB do SQL Server Express

Compartilhar via