IOleInPlaceComponentUIManager.UpdateUI Method

Article
05/06/2010

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)

Syntax

'Déclaration
Function UpdateUI ( _
    dwCompRole As UInteger, _
    fImmediateUpdate As Integer, _
    dwReserved As UInteger _
) As Integer
'Utilisation
Dim instance As IOleInPlaceComponentUIManager
Dim dwCompRole As UInteger
Dim fImmediateUpdate As Integer
Dim dwReserved As UInteger
Dim returnValue As Integer

returnValue = instance.UpdateUI(dwCompRole, _
    fImmediateUpdate, dwReserved)

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

int UpdateUI(
    [InAttribute] unsigned int dwCompRole, 
    [InAttribute] int fImmediateUpdate, 
    [InAttribute] unsigned int dwReserved
)

abstract UpdateUI : 
        dwCompRole:uint32 * 
        fImmediateUpdate:int * 
        dwReserved:uint32 -> int

function UpdateUI(
    dwCompRole : uint, 
    fImmediateUpdate : int, 
    dwReserved : uint
) : int

Parameters

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

fImmediateUpdate
Type: System.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
Type: System.UInt32
[in] Reserved for future use. Must be set to 0.

Return Value

Type: System.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).

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via