IOleInPlaceComponentUIManager.UpdateUI(UInt32, Int32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Informs the environment that the state of an in-place VSPackage object's visible user interface has changed.

public:
 int UpdateUI(System::UInt32 dwCompRole, int fImmediateUpdate, System::UInt32 dwReserved);

public:
 int UpdateUI(unsigned int dwCompRole, int fImmediateUpdate, unsigned int dwReserved);

int UpdateUI(unsigned int dwCompRole, int fImmediateUpdate, unsigned int dwReserved);

public int UpdateUI (uint dwCompRole, int fImmediateUpdate, uint dwReserved);

abstract member UpdateUI : uint32 * int * uint32 -> int

Public Function UpdateUI (dwCompRole As UInteger, fImmediateUpdate As Integer, dwReserved As UInteger) As Integer

Parameters

dwCompRole: UInt32

[in] Role of the affected in-place object. For a list of valid dwCompRole values, see OLEROLE.

fImmediateUpdate: Int32

[in] Flag indicating whether or not an immediate synchronous update should occur. If set to true, the update is synchronous. If set to false, the update occurs at idle time.

dwReserved: UInt32

[in] Reserved for future use. Must be set to 0.

Returns

Int32

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

Remarks

COM Signature

From oleipc.idl:

HRESULT IOleInPlaceComponentUIManager::UpdateUI(  
   [in] DWORD dwCompRole,  
   [in] BOOL fImmediateUpdate,  
   [in] DWORD dwReserved  
);

UpdateUI can be called by either the innermost UI active object or by objects that serve as containers to this innermost object. Typically, the update of the user interface occurs at idle time rather than immediately. However, if the fImmediateUpdate parameter is set to true, the update is performed immediately (synchronously).

Applies to