Função LocalDBFormatMessage

Aplica-se a: SQL Server

Retorna a descrição textual localizada para o erro de LocalDB do SQL Server Express especificado.

Arquivo de cabeçalho: msoledbsql.h

Sintaxe

HRESULT LocalDBFormatMessage(  
           HRESULT hrLocalDB,  
           DWORD dwFlags,   
           DWORD dwLanguageId,   
           LPWSTR wszMessage,   
           LPDWORD lpcchMessage   
);  

Parâmetros

hrLocalDB
[Entrada] O código de erro de LocalDB.

dwFlags
[Entrada] Os sinalizadores que especificam o comportamento desta função.

Sinalizadores disponíveis:

LOCALDB_TRUNCATE_ERR_MESSAGE
Se o buffer de entrada for muito curto, a mensagem de erro será truncada para ajustar o buffer.

dwLanguageId
[Entrada] O idioma desejado (LANGID) ou 0, nesse caso, a ordem do idioma de Win32 FormatMessage é usada.

wszMessage
[Saída] O buffer para armazenar a mensagem de erro de LocalDB.

lpcchMensagem
[Entrada/Saída] Na entrada contém o tamanho do buffer wszMessage em caracteres. Na saída, se o tamanho de buffer especificado for muito pequeno, conterá o tamanho de buffer necessário em caracteres, incluindo quaisquer caracteres nulos à esquerda. Se a função tiver sucesso, ela conterá o número de caracteres na mensagem, excluindo os caracteres nulos à direita.

Devoluções

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_ERROR_CODE
A mensagem solicitada não existe.

LOCALDB_ERROR_UNKNOWN_LANGUAGE_ID
A mensagem não está disponível no idioma solicitado.

LOCALDB_ERROR_INSUFFICIENT_BUFFER
O buffer de entrada wszMessage é muito curto e o truncamento não foi solicitado.

LOCALDB_ERROR_INTERNAL_ERROR
Erro inesperado. Consulte o log de eventos para obter detalhes.

Comentários

Para obter uma amostra do código que usa a API LocalDB, consulte SQL Server Express LocalDB Reference.

Confira também

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