DocData.QueryEditFile Method (String, tagVSQueryEditFlags)

Alerts listeners that a document is about to be edited. Listeners can vote against the edit.

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
Public Overridable Function QueryEditFile ( _
    fileName As String, _
    vsQueryEditFlags As tagVSQueryEditFlags _
) As QueryEditResult

public virtual QueryEditResult QueryEditFile(
    string fileName,
    tagVSQueryEditFlags vsQueryEditFlags
)

public:
virtual QueryEditResult QueryEditFile(
    String^ fileName, 
    tagVSQueryEditFlags vsQueryEditFlags
)

abstract QueryEditFile : 
        fileName:string * 
        vsQueryEditFlags:tagVSQueryEditFlags -> QueryEditResult  
override QueryEditFile : 
        fileName:string * 
        vsQueryEditFlags:tagVSQueryEditFlags -> QueryEditResult

public function QueryEditFile(
    fileName : String, 
    vsQueryEditFlags : tagVSQueryEditFlags
) : QueryEditResult

Parameters

• fileName
  Type: System.String

  The file name of the document.

• vsQueryEditFlags
  Type: Microsoft.VisualStudio.Shell.Interop.tagVSQueryEditFlags

  The flags that control how files are to be edited in memory. The default value is 0. For a list of flags, see the tagVSQueryEditFlags enumeration.

Return Value

Type: Microsoft.VisualStudio.Modeling.Shell.QueryEditResult
The QueryEditResult object.

Remarks

This method invokes the IVsQueryEditQuerySave2 interface.

This method performs a QueryEditFiles call on the document.

This method queries subordinate files also. For more information about subordinate files, see SubordinateFileHelper.

.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

DocData Class

QueryEditFile Overload

Microsoft.VisualStudio.Modeling.Shell Namespace