IVsTrackProjectDocumentsEvents2.OnQueryRemoveDirectories Method

Artikel
02/04/2013

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function OnQueryRemoveDirectories ( _
    pProject As IVsProject, _
    cDirectories As Integer, _
    rgpszMkDocuments As String(), _
    rgFlags As VSQUERYREMOVEDIRECTORYFLAGS(), _
    <OutAttribute> pSummaryResult As VSQUERYREMOVEDIRECTORYRESULTS(), _
    <OutAttribute> rgResults As VSQUERYREMOVEDIRECTORYRESULTS() _
) As Integer

int OnQueryRemoveDirectories(
    IVsProject pProject,
    int cDirectories,
    string[] rgpszMkDocuments,
    VSQUERYREMOVEDIRECTORYFLAGS[] rgFlags,
    VSQUERYREMOVEDIRECTORYRESULTS[] pSummaryResult,
    VSQUERYREMOVEDIRECTORYRESULTS[] rgResults
)

int OnQueryRemoveDirectories(
    [InAttribute] IVsProject^ pProject, 
    [InAttribute] int cDirectories, 
    [InAttribute] array<String^>^ rgpszMkDocuments, 
    [InAttribute] array<VSQUERYREMOVEDIRECTORYFLAGS>^ rgFlags, 
    [OutAttribute] array<VSQUERYREMOVEDIRECTORYRESULTS>^ pSummaryResult, 
    [OutAttribute] array<VSQUERYREMOVEDIRECTORYRESULTS>^ rgResults
)

abstract OnQueryRemoveDirectories : 
        pProject:IVsProject * 
        cDirectories:int * 
        rgpszMkDocuments:string[] * 
        rgFlags:VSQUERYREMOVEDIRECTORYFLAGS[] * 
        pSummaryResult:VSQUERYREMOVEDIRECTORYRESULTS[] byref * 
        rgResults:VSQUERYREMOVEDIRECTORYRESULTS[] byref -> int

function OnQueryRemoveDirectories(
    pProject : IVsProject, 
    cDirectories : int, 
    rgpszMkDocuments : String[], 
    rgFlags : VSQUERYREMOVEDIRECTORYFLAGS[], 
    pSummaryResult : VSQUERYREMOVEDIRECTORYRESULTS[], 
    rgResults : VSQUERYREMOVEDIRECTORYRESULTS[]
) : int

Parameters

pProject
Type: Microsoft.VisualStudio.Shell.Interop.IVsProject
[in] Project from which the directories will be removed.

cDirectories
Type: System.Int32
[in] Number of directories to remove.

rgpszMkDocuments
Type: array<System.String[]
[in] Array of paths for the directories to remove.

rgFlags
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYFLAGS[]
[in] Array of flags. For a list of rgFlags values, see VSQUERYREMOVEDIRECTORYFLAGS.

pSummaryResult
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYRESULTS[]
[out] Summary result object. This object is a summation of the yes and no results for the array of directories passed in rgpszMkDocuments. If the result for a single directory 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: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYREMOVEDIRECTORYRESULTS[]
[out] Array of results. For a list of rgResults values, see VSQUERYREMOVEDIRECTORYRESULTS.

Return Value

Type: System.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::OnQueryRemoveDirectories(
   [in] IVsProject *pProject,
   [in] int cDirectories,
   [in, size_is(cDirectories)] const LPCOLESTR rgpszMkDocuments[],
   [in, size_is(cDirectories)] const VSQUERYREMOVEDIRECTORYFLAGS rgFlags[],
   [out] VSQUERYREMOVEDIRECTORYRESULTS *pSummaryResult,
   [out, size_is(cDirectories)] VSQUERYREMOVEDIRECTORYRESULTS rgResults[]
);

Use IVsTrackProjectDocumentsEvents2.OnQueryRemoveDirectories to indicate whether specified directories can be removed from the project. Deny a query only if allowing the operation would compromise your stable state. For example, source control may deny remove queries if a directory contains files currently checked out of 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.

Bagikan melalui