IVsWindowFrameNotify3.OnClose(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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 VSPackage that a window frame is closing and tells the environment what action to take.

public:
 int OnClose([Runtime::InteropServices::Out] System::UInt32 % pgrfSaveOptions);

int OnClose([Runtime::InteropServices::Out] unsigned int & pgrfSaveOptions);

public int OnClose (out uint pgrfSaveOptions);

abstract member OnClose : uint32 -> int

Public Function OnClose (ByRef pgrfSaveOptions As UInteger) As Integer

Parameters

pgrfSaveOptions: UInt32

[in, out] Specifies options for saving window content. Values are taken from the __FRAMECLOSE enumeration.

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsWindowFrameNotify3::OnClose(  
   [in, out] FRAMECLOSE *pgrfSaveOptions  
);

Notes to Implementers

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

Applies to

Share via