This documentation is archived and is not being maintained.

IOleInPlaceComponentUIManager.UpdateUI Method

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int UpdateUI (
	[InAttribute] uint dwCompRole,
	[InAttribute] int fImmediateUpdate,
	[InAttribute] uint dwReserved
)
int UpdateUI (
	/** @attribute InAttribute() */ UInt32 dwCompRole, 
	/** @attribute InAttribute() */ int fImmediateUpdate, 
	/** @attribute InAttribute() */ UInt32 dwReserved
)
function UpdateUI (
	dwCompRole : uint, 
	fImmediateUpdate : int, 
	dwReserved : uint
) : int

Parameters

dwCompRole

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

fImmediateUpdate

[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

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

Return Value

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

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).

Show: