IVsObjectList2::OnClose Method (array<VSTREECLOSEACTIONS>^)

Visual Studio 2015

Notifies the current tree list that it is being closed.

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

Syntax

C++

int OnClose(
	array<VSTREECLOSEACTIONS>^ ptca
)

Parameters

ptca: Type: array<Microsoft.VisualStudio.Shell.Interop::VSTREECLOSEACTIONS>^
[out] Specifies to the tree view the action to take when closing this tree list. Values are taken from the VSTREECLOSEACTIONS enumeration.

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::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.