IVsQueryEditQuerySave2::IsReloadable Method (String^, Int32)

Visual Studio 2015

Returns the SVsQueryEditQuerySave service's understanding of whether this file is reloadable

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

Syntax

int IsReloadable(
	String^ pszMkDocument,
	[OutAttribute] int% pbResult
)

pbResult: Type: System::Int32
[out] If nonzero (true), the file is reloadable. If zero (false), the file is not reloadable.

Type: System::Int32

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

The parameter pbResult will be:

Nonzero (true) if either the DeclareReloadableFile method or nothing has been called on this file.
Zero (false) if the DeclareUnreloadableFile method has been called on this file.

Whether or not the file is reloadable is determined either by using IsDocDataReloadable, if the interface is supported, or by using any calls that have previously been made to DeclareReloadableFile or DeclareUnreloadableFile.

From ivsqueryeditquerysave2.idl

HRESULT IsReloadable(
   [in] LPCOLESTR pszMkDocument,
   [out, retval] BOOL *pbResult
);

The method returns the SVsQueryEditQuerySave service's understanding of whether or not the file is reloadable. This is determined by using IsDocDataReloadable, if the interface is supported by the project, or by using any calls that have previously been made to DeclareReloadableFile method or DeclareUnreloadableFile method.

If no other information is available, then items that are passed to QueryEditFiles, QuerySaveFile, QuerySaveFiles, or OnAfterAttributeChange (RDTA_DocDataIsDirty) are considered to be reloadable only if declared so. An item is also reloadable if the doc object supports IVsPersistDocData or if the parent hierarchy supports IVsPersistHierarchyItem2. It is possible for files to transition from being reloadable to unreloadable during the lifetime of an editor.

Note
By default, a file is assumed to be not reloadable in the absence of IVsPersistDocData or IVsPersistHierarchyItem2.