функция MI_Context_WriteError (mi.h)

Отправляет клиенту код ошибки и сообщение об ошибке.

Синтаксис

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_WriteError(
  [in]  MI_Context    *context,
        MI_Uint32     resultCode,
        const MI_Char *resultType,
        const MI_Char *errorMessage,
  [out] MI_Boolean    *flag
);

Параметры

[in] context

Контекст запроса.

resultCode

Код результата для отправки клиенту.

resultType

Строка, завершающаяся значением NULL, представляющая тип кода результата, который может (но не обязательно) содержать одно из следующих значений:

MI_RESULT_TYPE_MI ("MI")

Тип результата MI.

MI_RESULT_TYPE_HRESULT ("HRESULT")

Тип результата HRESULT (возвращаемый тип COM).

MI_RESULT_TYPE_WIN32 ("WIN32")

Тип результата Win32. См. коды системных ошибок.

errorMessage

Строка, завершающаяся значением NULL, представляющая сообщение об ошибке, сопровождающее код результата. Это сообщение должно быть локализовано на основе запроса языкового стандарта клиента (полученного с помощью функции MI_Context_GetLocale ).

[out] flag

При возврате флаг содержит MI_TRUE , если поставщик должен продолжить выполнение. В противном случае возвращаемое значение будет MI_FALSE.

Возвращаемое значение

Значение перечисления MI_Result , указывающее код возврата функции. Это может быть один из следующих кодов.

Комментарии

Операция не завершается этим вызовом, хотя клиент может указать, что операция должна быть продолжена или отменена.

Если клиент не запрашивает MI_Context_WriteError сообщений, функция даст автоматический ответ.

Требования

См. также раздел

MI_Context

MI_Context_GetLocale

MI_Context_PostError