Поделиться через


LocalDBFormatMessage function

Applies to:SQL Server

Возвращает локализованное текстовое описание для указанной ошибки SQL Server Express LocalDB.

Header file:msoledbsql.h

Syntax

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

Arguments

hrLocalDB

[Вход] Код ошибки LocalDB.

dwFlags

[Вход] Флаги, задающие поведение этой функции.

Available flags:

LOCALDB_TRUNCATE_ERR_MESSAGE

Если входной буфер слишком короткий, сообщение об ошибке усечено для соответствия буферу.

dwLanguageId

[Вход] Требуемый язык (LANGID) или значение 0. В последнем случае используется порядок языков Win32 FormatMessage.

wszMessage

[Выход] Буфер для сохранения сообщения об ошибке LocalDB.

lpcchMessage

[Input/Output] On input, this option contains the size of the wszMessage buffer in characters. На выходе, если указан недостаточный размер буфера, содержит требуемый размер буфера в символах, включая любые конечные символы NULL. Если функция завершается успешно, этот параметр содержит количество символов в сообщении, за исключением всех конечных значений NULL.

Returns

S_OK: функция завершилась успешно.

Error Description
LOCALDB_ERROR_NOT_INSTALLED SQL Server Express LocalDB не установлен на компьютере.
LOCALDB_ERROR_INVALID_PARAMETER Один или несколько указанных входных параметров недопустимы.
LOCALDB_ERROR_UNKNOWN_ERROR_CODE Запрошенное сообщение не существует.
LOCALDB_ERROR_UNKNOWN_LANGUAGE_ID Сообщение недоступно на запрошенном языке.
LOCALDB_ERROR_INSUFFICIENT_BUFFER The input buffer wszMessage is too short, and truncation isn't requested.
LOCALDB_ERROR_INTERNAL_ERROR Произошла непредвиденная ошибка. Подробные сведения см. в журнале событий.

Remarks

Пример кода, использующий API LocalDB, см. в справочнике по SQL Server Express LocalDB.