IVsWindowFrame.CloseFrame(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Closes a window.

public:
 int CloseFrame(System::UInt32 grfSaveOptions);

public:
 int CloseFrame(unsigned int grfSaveOptions);

int CloseFrame(unsigned int grfSaveOptions);

public int CloseFrame (uint grfSaveOptions);

abstract member CloseFrame : uint32 -> int

Public Function CloseFrame (grfSaveOptions As UInteger) As Integer

Parameters

grfSaveOptions: UInt32

[in] Save options whose values are taken from the __FRAMECLOSE.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

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.

Applies to