IVsThreadedWaitDialog.StartWaitDialog Method (String, String, String, UInt32, Object, String)

 

Starts the Wait dialog.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

int StartWaitDialog(
	string bstrWaitCaption,
	string bstrWaitMessage,
	string bstrIfTruncateAppend,
	uint dwFlags,
	object varStatusBmpAnim,
	string bstrStatusBarText
)

Parameters

bstrWaitCaption
Type: System.String

[in] Caption text of the wait message box.

bstrWaitMessage
Type: System.String

[in] Message text of the wait message box.

bstrIfTruncateAppend
Type: System.String

[in] Can be null.

dwFlags
Type: System.UInt32

[in] Display the Cancel button

varStatusBmpAnim
Type: System.Object

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

bstrStatusBarText
Type: System.String

[in] Can be null.

Return Value

Type: System.Int32

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

From vsshell80.idl:

HRESULT IVsThreadedWaitDialog::StartWaitDialog(
   [in] BSTR bstrWaitCaption, 
   [in] BSTR bstrWaitMessage, 
   [in] BSTR bstrIfTruncateAppend, 
   [in] BOOL fCancellable, 
   [in] VARIANT varStatusBmpAnim, 
   [in] BSTR bstrStatusBarText
);
Return to top
Show: