CommonMessagePump.IVsCommonMessagePump.SetAllowCancel Method

Determines whether the wait dialog has an enabled cancel button.

Namespace:  Microsoft.VisualStudio.Shell
Assembly:  Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
Private Function SetAllowCancel ( _
    allowCancel As Boolean _
) As Integer Implements IVsCommonMessagePump.SetAllowCancel
int IVsCommonMessagePump.SetAllowCancel(
    bool allowCancel
)
private:
virtual int SetAllowCancel(
    bool allowCancel
) sealed = IVsCommonMessagePump::SetAllowCancel
private abstract SetAllowCancel : 
        allowCancel:bool -> int  
private override SetAllowCancel : 
        allowCancel:bool -> int
JScript does not support explicit interface implementations.

Parameters

  • allowCancel
    Type: Boolean

    true if the wait dialog has an enabled cancel button, otherwise false.

Return Value

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

Implements

IVsCommonMessagePump.SetAllowCancel(Boolean)

Remarks

This may be set before calling ModalWaitForHandles or during one of the callbacks in ModalWaitForHandlesWithClient.

.NET Framework Security

See Also

Reference

CommonMessagePump Class

Microsoft.VisualStudio.Shell Namespace