IVsTrackProjectDocumentsEvents2.OnQueryAddFiles Method (IVsProject, Int32, String[], VSQUERYADDFILEFLAGS[], VSQUERYADDFILERESULTS[], VSQUERYADDFILERESULTS[])
This method notifies the client when a project has requested to add files.
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
int OnQueryAddFiles( IVsProject pProject, int cFiles, string[] rgpszMkDocuments, VSQUERYADDFILEFLAGS[] rgFlags, VSQUERYADDFILERESULTS[] pSummaryResult, VSQUERYADDFILERESULTS[] rgResults )
Parameters
- pProject
-
Type:
Microsoft.VisualStudio.Shell.Interop.IVsProject
[in] Project requesting to add files.
- cFiles
-
Type:
System.Int32
[in] Number of files to add.
- rgpszMkDocuments
-
Type:
System.String[]
[in] Array of files to add to the project.
- rgFlags
-
Type:
Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILEFLAGS[]
[in] Array of flags associated with each file. For a list of rgFlags values, see VSQUERYADDFILEFLAGS.
- pSummaryResult
-
Type:
Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILERESULTS[]
[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 in the array is no, then pSummaryResult is equal to VSQUERYADDFILERESULTS_AddNotOK; if the results for all files are yes, then pSummaryResult is equal to VSQUERYADDFILERESULTS_AddOK. For a list of pSummaryResult values, see VSQUERYADDFILERESULTS.
- rgResults
-
Type:
Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILERESULTS[]
[out] Array of results for each individual file. For a list of rgResults values, see VSQUERYADDFILERESULTS.
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::OnQueryAddFiles( [in] IVsProject *pProject, [in] int cFiles, [in, size_is(cFiles)] const LPCOLESTR rgpszMkDocuments[], [in, size_is(cFiles)] const VSQUERYADDFILEFLAGS rgFlags[], [out] VSQUERYADDFILERESULTS *pSummaryResult, [out, size_is(cFiles)] VSQUERYADDFILERESULTS rgResults[] );
Use IVsTrackProjectDocumentEvents2.OnQueryAddFiles to indicate whether specified files can be added to the project. Only deny a query if allowing the operation would compromise your stable state. For example, source control denies add queries if a file being added conflicts with an existing file already under source control.