IVsUIShell.UpdateCommandUI(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.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.

Informs the environment to update the state of the command bars (menus and toolbars).

public:
 int UpdateCommandUI(int fImmediateUpdate);

public:
 int UpdateCommandUI(int fImmediateUpdate);

int UpdateCommandUI(int fImmediateUpdate);

public int UpdateCommandUI (int fImmediateUpdate);

abstract member UpdateCommandUI : int -> int

Public Function UpdateCommandUI (fImmediateUpdate As Integer) As Integer

Parameters

fImmediateUpdate: Int32

[in] true if the update is performed synchronously (immediately). It is strongly recommended to pass false for this parameter.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsUIShell::UpdateCommandUI(  
   [in] BOOL fImmediateUpdate  
);

This method is equivalent to UpdateUI. It causes the environment to re-query by means of IOleCommandTarget the state of all commands. Typically, the update is not performed immediately but rather delayed until idle time.

Applies to