IVsObjectList2.ToggleState(UInt32, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int ToggleState(System::UInt32 index, [Runtime::InteropServices::Out] System::UInt32 % ptscr);

int ToggleState(unsigned int index, [Runtime::InteropServices::Out] unsigned int & ptscr);

public int ToggleState (uint index, out uint ptscr);

abstract member ToggleState : uint32 * uint32 -> int

Public Function ToggleState (index As UInteger, ByRef ptscr As UInteger) As Integer

Parameters

index: UInt32

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

ptscr: UInt32

[out] Pointer to the _VSTREESTATECHANGEREFRESH value.

Returns

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.

Applies to