Partilhar via

LocalDBFormatMessage function

Applies to:SQL Server

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

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 LocalDB.

dwFlags

[Entrada] Os sinalizadores especificando o comportamento dessa função.

Available flags:

LOCALDB_TRUNCATE_ERR_MESSAGE

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

dwLanguageId

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

wszMessage

[Realização] O buffer para armazenar a mensagem de erro LocalDB.

lpcchMessage

[Input/Output] On input, this option contains the size of the wszMessage buffer in characters. Na saída, se o tamanho do buffer fornecido for muito pequeno, conterá o tamanho do buffer necessário em caracteres, incluindo quaisquer nulos à direita. Se a função for bem-sucedida, essa opção conterá o número de caracteres na mensagem, excluindo quaisquer 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 Ocorreu um erro inesperado. Consulte o log de eventos para obter detalhes.

Remarks

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

Related content

  • Last updated on