Função LocalDBFormatMessage

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

Arquivo de cabeçalho: sqlncli.h

Sintaxe

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

Parâmetros

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

dwFlags
[Entrada] Os sinalizadores que especificam o comportamento dessa 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 da linguagem Win32 FormatMessage é usada.

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

lpcchMessage
[Entrada/Saída] Na entrada contém o tamanho do buffer wszMessage em caracteres . Na saída, se o tamanho do buffer fornecido for muito pequeno, conterá o tamanho do buffer necessário em caracteres, incluindo todos os nulos à direita. Se a função for bem-sucedida, conterá o número de caracteres na mensagem, excluindo todos os nulos à direita.

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_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 é solicitado.

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

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