IVsTrackProjectDocumentsEvents2.OnQueryRenameDirectories Method

Article
04/29/2015

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)

Syntax

'Declaration
Function OnQueryRenameDirectories ( _
    pProject As IVsProject, _
    cDirs As Integer, _
    rgszMkOldNames As String(), _
    rgszMkNewNames As String(), _
    rgFlags As VSQUERYRENAMEDIRECTORYFLAGS(), _
    <OutAttribute> pSummaryResult As VSQUERYRENAMEDIRECTORYRESULTS(), _
    <OutAttribute> rgResults As VSQUERYRENAMEDIRECTORYRESULTS() _
) As Integer

int OnQueryRenameDirectories(
    IVsProject pProject,
    int cDirs,
    string[] rgszMkOldNames,
    string[] rgszMkNewNames,
    VSQUERYRENAMEDIRECTORYFLAGS[] rgFlags,
    VSQUERYRENAMEDIRECTORYRESULTS[] pSummaryResult,
    VSQUERYRENAMEDIRECTORYRESULTS[] rgResults
)

int OnQueryRenameDirectories(
    [InAttribute] IVsProject^ pProject, 
    [InAttribute] int cDirs, 
    [InAttribute] array<String^>^ rgszMkOldNames, 
    [InAttribute] array<String^>^ rgszMkNewNames, 
    [InAttribute] array<VSQUERYRENAMEDIRECTORYFLAGS>^ rgFlags, 
    [OutAttribute] array<VSQUERYRENAMEDIRECTORYRESULTS>^ pSummaryResult, 
    [OutAttribute] array<VSQUERYRENAMEDIRECTORYRESULTS>^ rgResults
)

abstract OnQueryRenameDirectories : 
        pProject:IVsProject * 
        cDirs:int * 
        rgszMkOldNames:string[] * 
        rgszMkNewNames:string[] * 
        rgFlags:VSQUERYRENAMEDIRECTORYFLAGS[] * 
        pSummaryResult:VSQUERYRENAMEDIRECTORYRESULTS[] byref * 
        rgResults:VSQUERYRENAMEDIRECTORYRESULTS[] byref -> int

function OnQueryRenameDirectories(
    pProject : IVsProject, 
    cDirs : int, 
    rgszMkOldNames : String[], 
    rgszMkNewNames : String[], 
    rgFlags : VSQUERYRENAMEDIRECTORYFLAGS[], 
    pSummaryResult : VSQUERYRENAMEDIRECTORYRESULTS[], 
    rgResults : VSQUERYRENAMEDIRECTORYRESULTS[]
) : int

Parameters

pProject
Type: Microsoft.VisualStudio.Shell.Interop.IVsProject

[in] Project requesting to rename directories.

cDirs
Type: Int32

[in] Number of directories to rename.

rgszMkOldNames
Type: array<String[]

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

rgszMkNewNames
Type: array<String[]

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

rgFlags
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEDIRECTORYFLAGS[]

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

pSummaryResult
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEDIRECTORYRESULTS[]

[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
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYRENAMEDIRECTORYRESULTS[]

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

Return Value

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

Remarks

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via