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

IVsTrackProjectDocumentsEvents2.OnQueryRenameDirectories Method

This method notifies the client when a project has requested to rename directories.

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

int OnQueryRenameDirectories (
	[InAttribute] IVsProject pProject,
	[InAttribute] int cDirs,
	[InAttribute] string[] rgszMkOldNames,
	[InAttribute] string[] rgszMkNewNames,
	[InAttribute] VSQUERYRENAMEDIRECTORYFLAGS[] rgFlags,
	[OutAttribute] VSQUERYRENAMEDIRECTORYRESULTS[] pSummaryResult,
	[OutAttribute] VSQUERYRENAMEDIRECTORYRESULTS[] rgResults
)
int OnQueryRenameDirectories (
	/** @attribute InAttribute() */ IVsProject pProject, 
	/** @attribute InAttribute() */ int cDirs, 
	/** @attribute InAttribute() */ String[] rgszMkOldNames, 
	/** @attribute InAttribute() */ String[] rgszMkNewNames, 
	/** @attribute InAttribute() */ VSQUERYRENAMEDIRECTORYFLAGS[] rgFlags, 
	/** @attribute OutAttribute() */ VSQUERYRENAMEDIRECTORYRESULTS[] pSummaryResult, 
	/** @attribute OutAttribute() */ VSQUERYRENAMEDIRECTORYRESULTS[] rgResults
)
function OnQueryRenameDirectories (
	pProject : IVsProject, 
	cDirs : int, 
	rgszMkOldNames : String[], 
	rgszMkNewNames : String[], 
	rgFlags : VSQUERYRENAMEDIRECTORYFLAGS[], 
	pSummaryResult : VSQUERYRENAMEDIRECTORYRESULTS[], 
	rgResults : VSQUERYRENAMEDIRECTORYRESULTS[]
) : int

Parameters

pProject

[in] Project requesting to rename directories.

cDirs

[in] Number of directories to rename.

rgszMkOldNames

[in] Array of paths for the old directory names.

rgszMkNewNames

[in] Array of paths for the new directory names.

rgFlags

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

pSummaryResult

[out] Summary result object. This object is a summation of the yes and no results for the array of directories passed in rgszMkOldNames. If the result for a single directory is no, then pSummaryResult is equal to VSQUERYRENAMEDIRECTORYRESULTS_RenameNotOK; if the results for all files are yes, then pSummaryResult is equal to VSQUERYRENAMEDIRECTORYRESULTS_RenameOK. For a list of pSummaryResult values, see VSQUERYRENAMEDIRECTORYRESULTS.

rgResults

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

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::OnQueryRenameDirectories(
   [in] IVsProject *pProject,
   [in] int cDirs, [in, size_is(cDirs)] const LPCOLESTR rgszMkOldNames[],
   [in, size_is(cDirs)] const LPCOLESTR rgszMkNewNames[],
   [in, size_is(cDirs)] const VSQUERYRENAMEDIRECTORYFLAGS rgflags[],
   [out] VSQUERYRENAMEDIRECTORYRESULTS *pSummaryResult,
   [out, size_is(cDirs)] VSQUERYRENAMEDIRECTORYRESULTS rgResults[]
);

Use IVsTrackProjectDocumentsEvents2.OnQueryRenameDirectories to indicate whether specified directories can be renamed in the project. Deny a query only if allowing the operation would compromise your stable state. For example, source control denies rename queries if the new name conflicts with an existing directory already under source control.

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.