OnClose Method
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

IVsObjectList2.OnClose Method

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)

int OnClose (
	[OutAttribute] VSTREECLOSEACTIONS[] ptca
)
int OnClose (
	/** @attribute OutAttribute() */ VSTREECLOSEACTIONS[] ptca
)
function OnClose (
	ptca : VSTREECLOSEACTIONS[]
) : int

Parameters

ptca

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

Return Value

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

COM Signature

From vsshell80.idl:

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.

Show:
© 2016 Microsoft