MI_Context_WriteCimError function (mi.h)

Sends a CIM (informative) error instance to the client.

Syntax

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_WriteCimError(
  [in]  MI_Context        *context,
  [in]  const MI_Instance *error,
  [out] MI_Boolean        *flag
);

Parameters

[in] context

Request context.

[in] error

An instance of a CIM_Error class.

[out] flag

MI_TRUE on return if the provider should continue execution. Otherwise, MI_FALSE.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Remarks

A provider calls this function to send a CIM error instance to the client. This does not cancel the operation. Rather, this indicates the error to the client and gives the client the opportunity to determine if the operation should be continued or cancelled. It is then up to the provider to react accordingly.

Requirements

See also

CIM_Error

MI_Context

MI_Context_PostCimError

MI_Instance