Функция LocalDBFormatMessage

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

Файл заголовка: sqlncli.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.

См. также

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