IVsLiteTreeList.OnClose(VSTREECLOSEACTIONS[]) Method

Definition

Notifies the current tree list that it is being closed.

C++/CX
public:
 int OnClose(Platform::Array <Microsoft::VisualStudio::Shell::Interop::VSTREECLOSEACTIONS> ^ ptca);

Parameters

ptca
VSTREECLOSEACTIONS[]

[out] Specifies to the tree view the action to take when closing this tree list. Values are taken from the VSTREECLOSEACTIONS enumeration.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

cpp#
HRESULT IVsLiteTreeList::OnClose(  
   [out] VSTREECLOSEACTIONS *ptca  
);  

OnClose is called when the user collapses the tree list. Set ptca to the appropriate enumeration value from VSTREECLOSEACTIONS to indicate what action the tree view should take.

Applies to

Product Versions
Visual Studio SDK 2015, 2017, 2019, 2022