CommonMessagePump.IVsCommonMessagePump.SetAllowCancel(Boolean) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Controls if the wait dialog has an enabled cancel button.

 virtual int Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePump.SetAllowCancel(bool allowCancel) = Microsoft::VisualStudio::Shell::Interop::IVsCommonMessagePump::SetAllowCancel;

 virtual int Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePump.SetAllowCancel(bool allowCancel) = Microsoft::VisualStudio::Shell::Interop::IVsCommonMessagePump::SetAllowCancel;

int Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePump.SetAllowCancel(bool allowCancel);

int IVsCommonMessagePump.SetAllowCancel (bool allowCancel);

abstract member Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePump.SetAllowCancel : bool -> int
override this.Microsoft.VisualStudio.Shell.Interop.IVsCommonMessagePump.SetAllowCancel : bool -> int

Function SetAllowCancel (allowCancel As Boolean) As Integer Implements IVsCommonMessagePump.SetAllowCancel

Parameters

allowCancel: Boolean

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

Returns

Int32

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

Implements

SetAllowCancel(Boolean)

Remarks

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

Applies to