Expand Minimize

MI_Context_PromptUser function

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

Syntax


 MI_INLINE MI_Result MI_Context_PromptUser(
  _In_   MI_Context *context,
  _In_   const MI_Char *message,
  MI_PromptType promptType,
  _Out_  MI_Boolean *flag
);

Parameters

context [in]

Request context.

message [in]

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).

flag [out]

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.

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

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

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

MI_Context
MI_PromptType
MI_Context_GetLocale
MI_Context_ShouldContinue
MI_Context_ShouldProcess

 

 

Show:
© 2014 Microsoft