IVsObjectList.OnClose(VSTREECLOSEACTIONS[]) Method
Definition
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.
Notifies the current tree list that it is being closed.
public:
int OnClose(cli::array <Microsoft::VisualStudio::Shell::Interop::VSTREECLOSEACTIONS> ^ ptca);
public:
int OnClose(Platform::Array <Microsoft::VisualStudio::Shell::Interop::VSTREECLOSEACTIONS> ^ ptca);
int OnClose(std::Array <Microsoft::VisualStudio::Shell::Interop::VSTREECLOSEACTIONS> const & ptca);
public int OnClose (Microsoft.VisualStudio.Shell.Interop.VSTREECLOSEACTIONS[] ptca);
abstract member OnClose : Microsoft.VisualStudio.Shell.Interop.VSTREECLOSEACTIONS[] -> int
Public Function OnClose (ptca As VSTREECLOSEACTIONS()) As Integer
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.
Implements
Remarks
COM Signature
From vsshell.idl:
HRESULT IVsObjectList::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.