IVsThreadedWaitDialog.StartWaitDialog Method

Article
07/12/2014

Starts the Wait dialog.

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

Syntax

'Declaration
Function StartWaitDialog ( _
    bstrWaitCaption As String, _
    bstrWaitMessage As String, _
    bstrIfTruncateAppend As String, _
    dwFlags As UInteger, _
    varStatusBmpAnim As Object, _
    bstrStatusBarText As String _
) As Integer

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

int StartWaitDialog(
    [InAttribute] String^ bstrWaitCaption, 
    [InAttribute] String^ bstrWaitMessage, 
    [InAttribute] String^ bstrIfTruncateAppend, 
    [InAttribute] unsigned int dwFlags, 
    [InAttribute] Object^ varStatusBmpAnim, 
    [InAttribute] String^ bstrStatusBarText
)

abstract StartWaitDialog : 
        bstrWaitCaption:string * 
        bstrWaitMessage:string * 
        bstrIfTruncateAppend:string * 
        dwFlags:uint32 * 
        varStatusBmpAnim:Object * 
        bstrStatusBarText:string -> int

function StartWaitDialog(
    bstrWaitCaption : String, 
    bstrWaitMessage : String, 
    bstrIfTruncateAppend : String, 
    dwFlags : uint, 
    varStatusBmpAnim : Object, 
    bstrStatusBarText : String
) : int

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 nulla null reference (Nothing in Visual Basic).

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 nulla null reference (Nothing in Visual Basic).

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.