IVsThreadedWaitDialog.StartWaitDialog Method

Definition

Starts the Wait dialog.

public:
 int StartWaitDialog(System::String ^ bstrWaitCaption, System::String ^ bstrWaitMessage, System::String ^ bstrIfTruncateAppend, System::UInt32 dwFlags, System::Object ^ varStatusBmpAnim, System::String ^ bstrStatusBarText);
public:
 int StartWaitDialog(Platform::String ^ bstrWaitCaption, Platform::String ^ bstrWaitMessage, Platform::String ^ bstrIfTruncateAppend, unsigned int dwFlags, Platform::Object ^ varStatusBmpAnim, Platform::String ^ bstrStatusBarText);
int StartWaitDialog(std::wstring const & bstrWaitCaption, std::wstring const & bstrWaitMessage, std::wstring const & bstrIfTruncateAppend, unsigned int dwFlags, winrt::Windows::Foundation::IInspectable const & varStatusBmpAnim, std::wstring const & bstrStatusBarText);
public int StartWaitDialog (string bstrWaitCaption, string bstrWaitMessage, string bstrIfTruncateAppend, uint dwFlags, object varStatusBmpAnim, string bstrStatusBarText);
abstract member StartWaitDialog : string * string * string * uint32 * obj * string -> int
Public Function StartWaitDialog (bstrWaitCaption As String, bstrWaitMessage As String, bstrIfTruncateAppend As String, dwFlags As UInteger, varStatusBmpAnim As Object, bstrStatusBarText As String) As Integer

Parameters

bstrWaitCaption
String

[in] Caption text of the wait message box.

bstrWaitMessage
String

[in] Message text of the wait message box.

bstrIfTruncateAppend
String

[in] Can be null.

dwFlags
UInt32

[in] Display the Cancel button

varStatusBmpAnim
Object

[in] Optional. Should be a VT_INT_PTR containing a valid BMP, or VT_NULL.

bstrStatusBarText
String

[in] Can be null.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

This method is safe to access from any thread.

Applies to