IVsObjectList2.UpdateCounter Method

Article
2013-03-06

Returns the current change counter for the tree list, and is used to indicate that the list contents have changed.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function UpdateCounter ( _
    <OutAttribute> ByRef pCurUpdate As UInteger, _
    <OutAttribute> ByRef pgrfChanges As UInteger _
) As Integer

int UpdateCounter(
    out uint pCurUpdate,
    out uint pgrfChanges
)

int UpdateCounter(
    [OutAttribute] unsigned int% pCurUpdate, 
    [OutAttribute] unsigned int% pgrfChanges
)

abstract UpdateCounter : 
        pCurUpdate:uint32 byref * 
        pgrfChanges:uint32 byref -> int

function UpdateCounter(
    pCurUpdate : uint, 
    pgrfChanges : uint
) : int

Parameters

pCurUpdate
Type: System.UInt32%
[out] Pointer to the update counter of the current tree list.

pgrfChanges
Type: System.UInt32%
[out] Specifies changes that have occurred. Values are taken from the _VSTREEITEMCHANGESMASK enumeration.

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 vsshell80.idl:

[C++]

HRESULT IVsObjectList2::UpdateCounter(
   [out] ULONG *pCurUpdate, 
   out] VSTREEITEMCHANGESMASK *pgrfChanges
);

Returning an update counter greater than the last one cached by a given tree forces calls to GetItemCountand LocateExpandedList as needed. The pgrfChanges parameter contains values from the _VSTREEITEMCHANGESMASK enumeration. This enumeration is for future support of dynamic tree list modification. The capability is not currently enabled. While you can assign a value to pgrfChanges, the caller ignores the parameter.

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

Share via