IVsPackage.QueryClose(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.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.

Enables a VSPackage that requires user intervention to abort the shutdown process.

public:
 int QueryClose([Runtime::InteropServices::Out] int % pfCanClose);

int QueryClose([Runtime::InteropServices::Out] int & pfCanClose);

public int QueryClose (out int pfCanClose);

abstract member QueryClose : int -> int

Public Function QueryClose (ByRef pfCanClose As Integer) As Integer

Parameters

pfCanClose: Int32

[out] Flag indicating whether the VSPackage can close. Is set to true if the VSPackage can close.

Returns

Int32

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

Remarks

This method returns true if the VSPackage can close. If false, the environment can then cancel the exit procedure.

This method is called by the IDE only during manual shutdowns. Automated shutdowns, such as when installing critical updates, call the get_CanClose method instead.

COM Signature

From vsshell.idl:

HRESULT IVsPackage::QueryClose(  
   [out] BOOL *pfCanClose  
);

Applies to

Share via