IVsObjectList2::ToggleState Method (UInt32, UInt32)

Visual Studio 2015

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

C++

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

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.

Remarks

COM Signature

From vsshell80.idl:

[C++]

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.