SingleTaskIdleManager.IOleComponent.OnEnterState(UInt32, Int32) 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.

Notifies the component when the application enters or exits the specified state.

 virtual void Microsoft.VisualStudio.OLE.Interop.IOleComponent.OnEnterState(System::UInt32 uStateID, int fEnter) = Microsoft::VisualStudio::OLE::Interop::IOleComponent::OnEnterState;

 virtual void Microsoft.VisualStudio.OLE.Interop.IOleComponent.OnEnterState(unsigned int uStateID, int fEnter) = Microsoft::VisualStudio::OLE::Interop::IOleComponent::OnEnterState;

void Microsoft.VisualStudio.OLE.Interop.IOleComponent.OnEnterState(unsigned int uStateID, int fEnter);

void IOleComponent.OnEnterState (uint uStateID, int fEnter);

abstract member Microsoft.VisualStudio.OLE.Interop.IOleComponent.OnEnterState : uint32 * int -> unit
override this.Microsoft.VisualStudio.OLE.Interop.IOleComponent.OnEnterState : uint32 * int -> unit

Sub OnEnterState (uStateID As UInteger, fEnter As Integer) Implements IOleComponent.OnEnterState

Parameters

uStateID: UInt32

The state, from _OLECSTATE.

fEnter: Int32

true if the application is entering the state, false if it is exiting the state.

Implements

OnEnterState(UInt32, Int32)

Remarks

The component should take action depending on value of uStateID.

If a given number of calls are made with true``fEnter, the component should consider the state to be in effect until the same number of calls are made with false``fEnter.

It is possible for this method to be called with false``fEnter more times than it was called with true``fEnter. For example, if you are maintaining a state counter (incremented when this method is called with true``fEnter, decremented when called with false``fEnter), the counter should not be decremented for false``fEnter if it is already at zero.

Applies to