OleComponent.IOleComponent.OnEnterState(UInt32, Int32) Method

Definition

Namespace:

Microsoft.VisualStudio.PlatformUI.OleComponentSupport

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.12.40392

Notify component when app enters or exits the state given in uStateID. Simply calls through to OnChangeStateCore(UInt32, Int32).

 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 being entered or exited, maps directly to ComponentState

fEnter

Int32

If the value is TRUE (1) then we are entering the state described by uStateID otherwise we are exiting it.

Implements

OnEnterState(UInt32, Int32)

Remarks

If n calls are made with TRUE (1) fEnter, component should consider the state to be in effect until n calls are made with FALSE (0) fEnter

Components should be aware that it is possible for this method to be called with FALSE (0) fEnter more times than it was called with TRUE (1) fEnter (so, for example, if component is maintaining a state counter (incremented when this method is called with TRUE (1) fEnter, decremented when called with FALSE (0) fEnter), the counter should not be decremented for FALSE (0) fEnter if it is already at zero.)