IVsWindowFrame::CloseFrame Method (UInt32)

Visual Studio 2015

Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Visual Studio 2005

Closes a window.

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

Syntax

C++

int CloseFrame(
	unsigned int grfSaveOptions
)

Parameters

grfSaveOptions: Type: System::UInt32
[in] Save options whose values are taken from the __FRAMECLOSE.

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

C++

HRESULT IVsWindowFrame::CloseFrame(
   FRAMECLOSE grfSaveOptions
);

If the frame being closed sites a document window, the user is prompted by the UI to save changes and then close the window. If the frame sites a tool window, the tool window is hidden without saving any data or prompting the user.