LocalDBFormatMessage function

Applies to:SQL Server

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

Header file:msoledbsql.h

Syntax

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

Arguments

hrLocalDB

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

dwFlags

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

Available flags:

LOCALDB_TRUNCATE_ERR_MESSAGE

Se o buffer de entrada for muito curto, a mensagem de erro será truncada para se ajustar ao 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.

lpcchMessage

[Input/Output] On input, this option contains the size of the wszMessage buffer in characters. 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 for bem-sucedida, essa opção conterá o número de caracteres na mensagem, excluindo todos os nulos à direita.

Returns

S_OK: a função foi bem-sucedida.

Error	Description
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	The input buffer wszMessage is too short, and truncation isn't requested.
LOCALDB_ERROR_INTERNAL_ERROR	Erro inesperado. Consulte o log de eventos para obter detalhes.

Remarks

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

Related content

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