Share via


IVsWindowFrameNotify3.OnClose Method

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.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function OnClose ( _
    <OutAttribute> ByRef pgrfSaveOptions As UInteger _
) As Integer
int OnClose(
    out uint pgrfSaveOptions
)
int OnClose(
    [InAttribute] [OutAttribute] unsigned int% pgrfSaveOptions
)
abstract OnClose : 
        pgrfSaveOptions:uint32 byref -> int
function OnClose(
    pgrfSaveOptions : uint
) : int

Parameters

  • pgrfSaveOptions
    Type: UInt32%

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

Return Value

Type: 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.

.NET Framework Security

See Also

Reference

IVsWindowFrameNotify3 Interface

Microsoft.VisualStudio.Shell.Interop Namespace