CommonMessagePump Class
CommonMessagePump allows callers to block the current thread until a handle or handles have been signaled.
This API is not CLS-compliant.
Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.10.0 (in Microsoft.VisualStudio.Shell.10.0.dll)
Syntax
'Déclaration
<CLSCompliantAttribute(False)> _
Public Class CommonMessagePump _
Implements IVsCommonMessagePump, IOleComponent2Private, IOleComponent
'Utilisation
Dim instance As CommonMessagePump
[CLSCompliantAttribute(false)]
public class CommonMessagePump : IVsCommonMessagePump,
IOleComponent2Private, IOleComponent
[CLSCompliantAttribute(false)]
public ref class CommonMessagePump : IVsCommonMessagePump,
IOleComponent2Private, IOleComponent
[<CLSCompliantAttribute(false)>]
type CommonMessagePump =
class
interface IVsCommonMessagePump
interface IOleComponent2Private
interface IOleComponent
end
public class CommonMessagePump implements IVsCommonMessagePump, IOleComponent2Private, IOleComponent
Remarks
During the wait the IDE will be placed in a modal state to prevent reentrancy. If the wait takes more than 2 secs a wait dialog is presented to the user which can be canceled (by default). Callers can call the default behavior which will show default text in the wait dialog or they can provide custom values for things like the dialog text, status bar text, timeout values etc.
Callers can also provide a custom implementation of IVsCommonMessagePumpClientEvents which allows the client to run code when certain events occur such as messages being processed, timeout or a handle being signaled. This interface can also be used to detemine if the wait should continue or return.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Shell.CommonMessagePump
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.