IVsQueryEditQuerySave2::DeclareReloadableFile Method (String^, UInt32, array<VSQEQS_FILE_ATTRIBUTE_DATA>^)

Visual Studio 2015

States that a file will be reloaded if it changes on disk.

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

Syntax

C++

int DeclareReloadableFile(
	String^ pszMkDocument,
	unsigned int rgf,
	array<VSQEQS_FILE_ATTRIBUTE_DATA>^ pFileInfo
)

Parameters

pszMkDocument: Type: System::String^
[in] Path to the file on the disk.

rgf: Type: System::UInt32
[in] Flags whose values for valid file attributes are taken from the tagVSQEQSFlags enumeration. The default value is zero.

pFileInfo: Type: array<Microsoft.VisualStudio.Shell.Interop::VSQEQS_FILE_ATTRIBUTE_DATA>^
[in] Can be null. This parameter is ignored if rgf is 0. Values are taken from the VSQEQS_FILE_ATTRIBUTE_DATA structure.

Return Value

Type: System::Int32

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

Remarks

Used only in special cases.

COM Signature

From ivsqueryeditquerysave2.idl

C++

HRESULT DeclareReloadableFile(
   [in] LPCOLESTR pszMkDocument,
   [in] VSQEQSFlags rgf,
   [in] const VSQEQS_FILE_ATTRIBUTE_DATA* pFileInfo
);

The environment automatically calls this service method on behalf of a project for its root node, and for solution .sln files. It is also called in the following circumstances:

So the project or editor can ensure that the service knows the file is reloadable.
-or-
When IsDocDataReloadable specifies it by returning true. (This is the recommended case.)

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.