IVsObjectList.ToggleState Method

Article
2013-03-06

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 (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function ToggleState ( _
    index As UInteger, _
    <OutAttribute> ByRef ptscr As UInteger _
) As Integer

int ToggleState(
    uint index,
    out uint ptscr
)

int ToggleState(
    [InAttribute] unsigned int index, 
    [OutAttribute] unsigned int% ptscr
)

abstract ToggleState : 
        index:uint32 * 
        ptscr:uint32 byref -> int

function ToggleState(
    index : uint, 
    ptscr : uint
) : int

Parameters

index
Type: System.UInt32
[in] Specifies the index of the tree list item of interest.

ptscr
Type: System.UInt32%
[out] Pointer to the _VSTREESTATECHANGEREFRESH value.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IVsLiteTreeList.ToggleState(UInt32, UInt32%)

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsObjectList::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

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