MI_Context_PromptUser function (mi.h)

Sends a prompt message to the client querying whether to continue the operation or cancel it.

Syntax

MI_INLINE MI_Result MI_INLINE_CALL MI_Context_PromptUser(
  [in]  MI_Context    *context,
  [in]  const MI_Char *message,
        MI_PromptType promptType,
  [out] MI_Boolean    *flag
);

Parameters

[in] context

Request context.

[in] message

A null-terminated string that represents the prompt message for the client.

promptType

Prompt type as defined by MI_PromptType. The provider should try to use the locale that the client has specified (retrieved through the MI_Context_GetLocale function).

[out] flag

Return value from the client. MI_TRUE indicates that the process should continue. MI_FALSE indicates that the process should stop, and the provider should post some final error to say that the operation was cancelled.

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 to the prompt.

Requirements

See also

MI_Context

MI_Context_GetLocale

MI_Context_ShouldContinue

MI_Context_ShouldProcess

MI_PromptType