IVsTrackProjectDocuments2.OnQueryRemoveFiles Method (IVsProject, Int32, String[], VSQUERYREMOVEFILEFLAGS[], VSQUERYREMOVEFILERESULTS[], VSQUERYREMOVEFILERESULTS[])

 

This method is called by a project to determine whether files can be removed from the project.

Namespace:   Microsoft.VisualStudio.Shell.Interop
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 containing the files to remove.

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.

Note   If you pass in null for this parameter, then only the summary result will be returned (pSummaryResult).

Return Value

Type: System.Int32

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

From IVsTrackProjectDocuments2.idl

HRESULT IVsTrackProjectDocuments2::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[]
);

Call this method when you want to remove files from the project. This method must be called before the files are removed. The environment will return a flag indicating which files can be removed. After you have received authorization to remove the files and you have removed them, call OnAfterRemoveFiles to confirm that the files have been removed.

Return to top
Show: