IVsWindowFrame.CloseFrame Method

Closes a window.

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

Syntax

'Declaration
Function CloseFrame ( _
    grfSaveOptions As UInteger _
) As Integer
'Usage
Dim instance As IVsWindowFrame
Dim grfSaveOptions As UInteger
Dim returnValue As Integer

returnValue = instance.CloseFrame(grfSaveOptions)

int CloseFrame(
    uint grfSaveOptions
)

int CloseFrame(
    unsigned int grfSaveOptions
)

abstract CloseFrame : 
        grfSaveOptions:uint32 -> int

function CloseFrame(
    grfSaveOptions : uint
) : int

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:

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.