MI_Context_ShouldProcess function (mi.h)

Article
07/27/2022

Queries the client to determine if an operation should continue.

Syntax

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_ShouldProcess(
  [in]  MI_Context    *context,
        const MI_Char *target,
        const MI_Char *action,
  [out] MI_Boolean    *flag
);

Parameters

[in] context

Request context.

target

A null-terminated string that represents the target of the action that is being processed. The string should be in the user's requested locale (retrieved through the MI_Context_GetLocale function).

action

A null-terminated string that represents the action that is being processed. The string should be in the user's requested locale (retrieved through the MI_Context_GetLocale function).

[out] flag

Boolean response from client indicating if the provider should continue processing. MI_TRUE indicates that the process should continue. MI_FALSE indicates that processing should stop.

Return value

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

Remarks

If the client has an auto-result specified, then the message will be reported, but the function will not wait. If the client is not interested in this function, then the function will return immediately with the default response. Otherwise, the function will not return until after the client has responded.

An example use of this function would be when deleting a file. In such a case, you might specify an action parameter of "deleting file" and a target parameter containing the name of the file to be deleted.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	mi.h
Redistributable	Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2