IVsQueryEditQuerySave2.IsReloadable Method
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
'Declaración
Function IsReloadable ( _
pszMkDocument As String, _
<OutAttribute> ByRef pbResult As Integer _
) As Integer
'Uso
Dim instance As IVsQueryEditQuerySave2
Dim pszMkDocument As String
Dim pbResult As Integer
Dim returnValue As Integer
returnValue = instance.IsReloadable(pszMkDocument, _
pbResult)
int IsReloadable(
string pszMkDocument,
out int pbResult
)
int IsReloadable(
[InAttribute] String^ pszMkDocument,
[OutAttribute] int% pbResult
)
abstract IsReloadable :
pszMkDocument:string *
pbResult:int byref -> int
function IsReloadable(
pszMkDocument : String,
pbResult : int
) : int
Parameters
- pszMkDocument
Type: System.String
[in] Path to the file on the disk.
- pbResult
Type: System.Int32%
[out] If nonzero (true), the file is reloadable. If zero (false), the file is not reloadable.
Return Value
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.
Remarks
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.
COM Signature
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.
Nota
By default, a file is assumed to be not reloadable in the absence of IVsPersistDocData or IVsPersistHierarchyItem2.
.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.
See Also
Reference
IVsQueryEditQuerySave2 Interface