IVsObjectList2.ToggleState Method

Tells the requested tree item to toggle its checked state if it has check boxes.

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

Syntax

'Declaration
Function ToggleState ( _
    index As UInteger, _
    <OutAttribute> ByRef ptscr As UInteger _
) As Integer
'Usage
Dim instance As IVsObjectList2 
Dim index As UInteger 
Dim ptscr As UInteger 
Dim returnValue As Integer 

returnValue = instance.ToggleState(index, _
    ptscr)
int ToggleState(
    uint index,
    out uint ptscr
)
int ToggleState(
    [InAttribute] unsigned int index, 
    [OutAttribute] unsigned int% ptscr
)
function ToggleState(
    index : uint, 
    ptscr : uint
) : int

Parameters

  • index
    Type: System.UInt32

    [in] Specifies the index of the tree list item of interest.

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:

HRESULT IVsObjectList2::ToggleState(
   [in] ULONG Index, 
   [out] VSTREESTATECHANGEREFRESH *ptscr
);

This method returns the state of the given tree list item. The item might have more than one state. The states are taken from the _VSTREESTATECHANGEREFRESH enumeration.

.NET Framework Security

See Also

Reference

IVsObjectList2 Interface

IVsObjectList2 Members

Microsoft.VisualStudio.Shell.Interop Namespace