IVsWindowFrameNotify2::OnClose Method (UInt32)

Visual Studio 2015

Notifies the VSPackage that a window frame is closing and tells the environment what action to take.

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

Syntax

C++

int OnClose(
	unsigned int% pgrfSaveOptions
)

Parameters

pgrfSaveOptions: Type: System::UInt32
[in, out] Specifies options for saving window content. Values are taken from the __FRAMECLOSE enumeration.

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 IVsWindowFrameNotify2::OnClose(
   [in, out] FRAMECLOSE *pgrfSaveOptions
);

Implementers should develop code to notify users and prompt for save and close and relay those decisions to the environment through IVsWindowFrameNotify2.