Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IVsTrackProjectDocumentsEvents2.OnQueryRemoveFiles Method

This method notifies the client when a project has requested to remove files.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int OnQueryRemoveFiles (
	[InAttribute] IVsProject pProject,
	[InAttribute] int cFiles,
	[InAttribute] string[] rgpszMkDocuments,
	[InAttribute] VSQUERYREMOVEFILEFLAGS[] rgFlags,
	[OutAttribute] VSQUERYREMOVEFILERESULTS[] pSummaryResult,
	[OutAttribute] VSQUERYREMOVEFILERESULTS[] rgResults
)
int OnQueryRemoveFiles (
	/** @attribute InAttribute() */ IVsProject pProject, 
	/** @attribute InAttribute() */ int cFiles, 
	/** @attribute InAttribute() */ String[] rgpszMkDocuments, 
	/** @attribute InAttribute() */ VSQUERYREMOVEFILEFLAGS[] rgFlags, 
	/** @attribute OutAttribute() */ VSQUERYREMOVEFILERESULTS[] pSummaryResult, 
	/** @attribute OutAttribute() */ VSQUERYREMOVEFILERESULTS[] rgResults
)
function OnQueryRemoveFiles (
	pProject : IVsProject, 
	cFiles : int, 
	rgpszMkDocuments : String[], 
	rgFlags : VSQUERYREMOVEFILEFLAGS[], 
	pSummaryResult : VSQUERYREMOVEFILERESULTS[], 
	rgResults : VSQUERYREMOVEFILERESULTS[]
) : int

Parameters

pProject

[in] Project from which the files will be removed.

cFiles

[in] Number of files to remove.

rgpszMkDocuments

[in] Array of paths for the files to be removed.

rgFlags

[in] Array of flags. For a list of rgFlags values, see VSQUERYREMOVEFILEFLAGS.

pSummaryResult

[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

[out] Array of results[].For a list of rgResults values, see VSQUERYREMOVEFILERESULTS.

Return Value

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

COM Signature

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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.