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


Функция LocalDBFormatMessage

Область применения: SQL Server

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

Файл заголовка: msoledbsql.h

Синтаксис

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

Параметры

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

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

Доступные флаги:

LOCALDB_TRUNCATE_ERR_MESSAGE
Если размер входного буфера окажется недостаточным, сообщение об ошибке урезается до длины буфера.

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

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

lpcchMessage
[Вход/выход] На входе содержит размер буфера wszMessage в символах. На выходе, если указан недостаточный размер буфера, содержит требуемый размер буфера в символах, включая любые конечные символы NULL. При успешном завершении работы функции содержит количество символов в сообщении без учета конечных символов NULL.

Возвраты

S_OK
Функция выполнена успешно.

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
Размер входного буфера wszMessage недостаточный; усечение не было запрошено.

LOCALDB_ERROR_INTERNAL_ERROR
Произошла непредвиденная ошибка. Подробные сведения см. в журнале событий.

Замечания

Образец кода, использующего API LocalDB, см. в разделе SQL Server Express LocalDB Reference

См. также

Заголовок и сведения о версии SQL Server Express LocalDB