IVsTrackProjectDocumentsEvents2.OnQueryRemoveFiles Method (IVsProject, Int32, String[], VSQUERYREMOVEFILEFLAGS[], VSQUERYREMOVEFILERESULTS[], VSQUERYREMOVEFILERESULTS[])
This method notifies the client when a project has requested to remove files.
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
int OnQueryRemoveFiles( IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYREMOVEFILEFLAGS[] rgFlags, VSQUERYREMOVEFILERESULTS[] pSummaryResult, VSQUERYREMOVEFILERESULTS[] rgResults )
Parameters
- pProject
-
Type:
Microsoft.VisualStudio.Shell.Interop.IVsProject
[in] Project from which the files will be removed.
- cFiles
-
Type:
System.Int32
[in] Number of files to remove.
- rgpszMkDocuments
-
Type:
System.String[]
[in] Array of paths for the files to be removed.
- rgFlags
-
Type:
Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILEFLAGS[]
[in] Array of flags. For a list of rgFlags values, see VSQUERYREMOVEFILEFLAGS.
- pSummaryResult
-
Type:
Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILERESULTS[]
[out] Summary result object. This object is a summation of the yes and no results for the array of files passed in rgpszMkDocuments. If the result for a single file is no, then pSummaryResult is equal to VSQUERYREMOVEFILERESULTS_RemoveNotOK; if the results for all files are yes, then pSummaryResult is equal to VSQUERYREMOVEFILERESULTS_RemoveOK. For a list of pSummaryResult values, see VSQUERYREMOVEFILERESULTS.
- rgResults
-
Type:
Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEFILERESULTS[]
[out] Array of results[].For a list of rgResults values, see VSQUERYREMOVEFILERESULTS.
Return Value
Type: System.Int32If the method succeeds, it returns S_OK. If it fails, it returns an error code.
From IVsTrackProjectDocumentsEvents2.idl
HRESULT IVsTrackProjectDocumentsEvents2::OnQueryRemoveFiles( [in] IVsProject *pProject, [in] int cFiles, [in, size_is(cFiles)] const LPCOLESTR rgpszMkDocuments[], [in, size_is(cFiles)] const VSQUERYREMOVEFILEFLAGS rgFlags[], [out] VSQUERYREMOVEFILERESULTS *pSummaryResult, [out, size_is(cFiles)] VSQUERYREMOVEFILERESULTS rgResults[] );
Use IVsTrackProjectDocumentsEvents2.OnQueryRemoveFiles to indicate whether specified files can be removed from the project. Only deny a query if allowing the operation would compromise your stable state. For example, source control may deny remove queries if a file being removed is currently checked out.