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

傳回時，如果提供者應該繼續執行，則 flag 會包含 MI_TRUE 。 否則，傳回的值將會 MI_FALSE。

傳回值

指定函式傳回碼的 MI_Result 列舉值。 這可以是下列其中一個程序代碼。

備註

此呼叫不會終止作業，不過用戶端可以選擇指示應該繼續或取消作業。

如果客戶端沒有要求 MI_Context_WriteError 訊息，函式會提供自動回應。

規格需求

另請參閱

MI_Context

MI_Context_GetLocale

MI_Context_PostError