IVsWindowFrameNotify2.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 (in Microsoft.VisualStudio.Shell.Interop.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 vsshell.idl:
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.
.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.