Export (0) Print
Expand All
Expand Minimize

MI_Context_Canceled function

Determines whether the operation has been canceled. This function is reserved; instead, use the MI_Context_RegisterCancel function.

Syntax


 MI_INLINE MI_Result MI_Context_Canceled(
  _In_   const MI_Context *context,
  _Out_  MI_Boolean *flag
);

Parameters

context [in]

A pointer to the request context that was passed to the provider method.

flag [out]

A pointer to a flag that holds the deletion result. Upon return, this flag will be MI_TRUE if the operation has been successfully canceled; otherwise, it will be MI_FALSE.

Return value

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 canceled operation on the client does not always signal to the server that the operation should be canceled. It depends on both the type of operation and the support from the underlying protocol handler.

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

 

 

Show:
© 2014 Microsoft