Export (0) Print
Expand All
Expand Minimize

MI_Context_WriteCimError function

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

Syntax


 MI_INLINE MI_Result MI_Context_WriteCimError(
  _In_   MI_Context *context,
  _In_   const MI_Instance *error,
  _Out_  MI_Boolean *flag
);

Parameters

context [in]

Request context.

error [in]

An instance of a CIM_Error class.

flag [out]

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.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error 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

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

CIM_Error
MI_Context
MI_Instance
MI_Context_PostCimError

 

 

Show:
© 2014 Microsoft