Share via


IVsThreadedWaitDialog3.StartWaitDialogWithCallback Method

Displays an instance of a wait dialog with a callback that can be used to cancel the wait dialog.

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

Syntax

'Declaration
Sub StartWaitDialogWithCallback ( _
    szWaitCaption As String, _
    szWaitMessage As String, _
    szProgressText As String, _
    varStatusBmpAnim As Object, _
    szStatusBarText As String, _
    fIsCancelable As Boolean, _
    iDelayToShowDialog As Integer, _
    fShowProgress As Boolean, _
    iTotalSteps As Integer, _
    iCurrentStep As Integer, _
    pCallback As IVsThreadedWaitDialogCallback _
)
void StartWaitDialogWithCallback(
    string szWaitCaption,
    string szWaitMessage,
    string szProgressText,
    Object varStatusBmpAnim,
    string szStatusBarText,
    bool fIsCancelable,
    int iDelayToShowDialog,
    bool fShowProgress,
    int iTotalSteps,
    int iCurrentStep,
    IVsThreadedWaitDialogCallback pCallback
)
void StartWaitDialogWithCallback(
    [InAttribute] String^ szWaitCaption, 
    [InAttribute] String^ szWaitMessage, 
    [InAttribute] String^ szProgressText, 
    [InAttribute] Object^ varStatusBmpAnim, 
    [InAttribute] String^ szStatusBarText, 
    [InAttribute] bool fIsCancelable, 
    [InAttribute] int iDelayToShowDialog, 
    [InAttribute] bool fShowProgress, 
    [InAttribute] int iTotalSteps, 
    [InAttribute] int iCurrentStep, 
    [InAttribute] IVsThreadedWaitDialogCallback^ pCallback
)
abstract StartWaitDialogWithCallback : 
        szWaitCaption:string * 
        szWaitMessage:string * 
        szProgressText:string * 
        varStatusBmpAnim:Object * 
        szStatusBarText:string * 
        fIsCancelable:bool * 
        iDelayToShowDialog:int * 
        fShowProgress:bool * 
        iTotalSteps:int * 
        iCurrentStep:int * 
        pCallback:IVsThreadedWaitDialogCallback -> unit
function StartWaitDialogWithCallback(
    szWaitCaption : String, 
    szWaitMessage : String, 
    szProgressText : String, 
    varStatusBmpAnim : Object, 
    szStatusBarText : String, 
    fIsCancelable : boolean, 
    iDelayToShowDialog : int, 
    fShowProgress : boolean, 
    iTotalSteps : int, 
    iCurrentStep : int, 
    pCallback : IVsThreadedWaitDialogCallback
)

Parameters

  • szWaitCaption
    Type: System.String

    [in, unique] The dialog caption.

  • szProgressText
    Type: System.String

    [in, unique] The text that accompanies the progress bar. Can be a null reference.

  • varStatusBmpAnim
    Type: System.Object

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

  • szStatusBarText
    Type: System.String

    [in, unique] The text on the status bar. Can be a null reference.

  • fIsCancelable
    Type: System.Boolean

    [in] true if there should be a Cancel button on the dialog, otherwise false.

  • iDelayToShowDialog
    Type: System.Int32

    [in] Number of seconds to delay showing the dialog.

  • fShowProgress
    Type: System.Boolean

    [in] true if there should be a visible marquee-style progress bar on the dialog, otherwise false.

  • iTotalSteps
    Type: System.Int32

    [in] Specifies how many steps equals 100% complete. Specify zero (0) or negative for marquee progress.

  • iCurrentStep
    Type: System.Int32

    [in] Specifies how many steps have been completed so far.

.NET Framework Security

See Also

Reference

IVsThreadedWaitDialog3 Interface

Microsoft.VisualStudio.Shell.Interop Namespace