Freigeben über


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)

Syntax

'Declaration
Function OnQueryRemoveFiles ( _
    pProject As IVsProject, _
    cFiles As Integer, _
    rgpszMkDocuments As String(), _
    rgFlags As VSQUERYREMOVEFILEFLAGS(), _
    <OutAttribute> pSummaryResult As VSQUERYREMOVEFILERESULTS(), _
    <OutAttribute> rgResults As VSQUERYREMOVEFILERESULTS() _
) As Integer
int OnQueryRemoveFiles(
    IVsProject pProject,
    int cFiles,
    string[] rgpszMkDocuments,
    VSQUERYREMOVEFILEFLAGS[] rgFlags,
    VSQUERYREMOVEFILERESULTS[] pSummaryResult,
    VSQUERYREMOVEFILERESULTS[] rgResults
)
int OnQueryRemoveFiles(
    [InAttribute] IVsProject^ pProject, 
    [InAttribute] int cFiles, 
    [InAttribute] array<String^>^ rgpszMkDocuments, 
    [InAttribute] array<VSQUERYREMOVEFILEFLAGS>^ rgFlags, 
    [OutAttribute] array<VSQUERYREMOVEFILERESULTS>^ pSummaryResult, 
    [OutAttribute] array<VSQUERYREMOVEFILERESULTS>^ rgResults
)
abstract OnQueryRemoveFiles : 
        pProject:IVsProject * 
        cFiles:int * 
        rgpszMkDocuments:string[] * 
        rgFlags:VSQUERYREMOVEFILEFLAGS[] * 
        pSummaryResult:VSQUERYREMOVEFILERESULTS[] byref * 
        rgResults:VSQUERYREMOVEFILERESULTS[] byref -> int
function OnQueryRemoveFiles(
    pProject : IVsProject, 
    cFiles : int, 
    rgpszMkDocuments : String[], 
    rgFlags : VSQUERYREMOVEFILEFLAGS[], 
    pSummaryResult : VSQUERYREMOVEFILERESULTS[], 
    rgResults : VSQUERYREMOVEFILERESULTS[]
) : int

Parameters

  • cFiles
    Type: Int32

    [in] Number of files to remove.

  • rgpszMkDocuments
    Type: array<String[]

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

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::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.

.NET Framework Security

See Also

Reference

IVsTrackProjectDocumentsEvents2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace