IVsTrackProjectDocuments3.OnQueryAddFilesEx Method

Article
02/04/2013

This method is an extended version of the OnQueryAddFiles method and is used when a project will be moving files to a new location in the project directory.

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

Syntax

'Declaration
Function OnQueryAddFilesEx ( _
    pProject As IVsProject, _
    cFiles As Integer, _
    rgpszNewMkDocuments As String(), _
    rgpszSrcMkDocuments As String(), _
    rgFlags As VSQUERYADDFILEFLAGS(), _
    <OutAttribute> pSummaryResult As VSQUERYADDFILERESULTS(), _
    <OutAttribute> rgResults As VSQUERYADDFILERESULTS() _
) As Integer

int OnQueryAddFilesEx(
    IVsProject pProject,
    int cFiles,
    string[] rgpszNewMkDocuments,
    string[] rgpszSrcMkDocuments,
    VSQUERYADDFILEFLAGS[] rgFlags,
    VSQUERYADDFILERESULTS[] pSummaryResult,
    VSQUERYADDFILERESULTS[] rgResults
)

int OnQueryAddFilesEx(
    [InAttribute] IVsProject^ pProject, 
    [InAttribute] int cFiles, 
    [InAttribute] array<String^>^ rgpszNewMkDocuments, 
    [InAttribute] array<String^>^ rgpszSrcMkDocuments, 
    [InAttribute] array<VSQUERYADDFILEFLAGS>^ rgFlags, 
    [OutAttribute] array<VSQUERYADDFILERESULTS>^ pSummaryResult, 
    [OutAttribute] array<VSQUERYADDFILERESULTS>^ rgResults
)

abstract OnQueryAddFilesEx : 
        pProject:IVsProject * 
        cFiles:int * 
        rgpszNewMkDocuments:string[] * 
        rgpszSrcMkDocuments:string[] * 
        rgFlags:VSQUERYADDFILEFLAGS[] * 
        pSummaryResult:VSQUERYADDFILERESULTS[] byref * 
        rgResults:VSQUERYADDFILERESULTS[] byref -> int

function OnQueryAddFilesEx(
    pProject : IVsProject, 
    cFiles : int, 
    rgpszNewMkDocuments : String[], 
    rgpszSrcMkDocuments : String[], 
    rgFlags : VSQUERYADDFILEFLAGS[], 
    pSummaryResult : VSQUERYADDFILERESULTS[], 
    rgResults : VSQUERYADDFILERESULTS[]
) : int

Parameters

pProject
Type: Microsoft.VisualStudio.Shell.Interop.IVsProject
[in] Project making the request about adding files.

cFiles
Type: System.Int32
[in] The number of files represented in the rgpszNewMkDocuments, rgpszSrcMkDocuments, rgFlags, and rgResults arrays.

rgpszNewMkDocuments
Type: array<System.String[]
[in] An array of file names that indicate the files' final destination.

rgpszSrcMkDocuments
Type: array<System.String[]
[in] An array of file names specifying the source location of the files.

rgFlags
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILEFLAGS[]
[in] An array of values, one element for each file, from the VSQUERYADDFILEFLAGS enumeration.

pSummaryResult
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILERESULTS[]
[out] Returns an overall status for all files as a value from the VSQUERYADDFILERESULTS enumeration.

rgResults
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYADDFILERESULTS[]
[in, out] An array that is filled in with the status of each file. Each status is a value from the VSQUERYADDFILERESULTS enumeration.

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 ivstrackprojectdocumentsevents80.idl

HRESULT OnQueryAddFilesEx(
   [in] IVsProject *pProject,
   [in] int cFiles,
   [in, size_is(cFiles)] const LPCOLESTR rgpszNewMkDocuments[],
   [in, size_is(cFiles)] const LPCOLESTR rgpszSrcMkDocuments[],
   [in, size_is(cFiles)] const VSQUERYADDFILEFLAGS rgFlags[],
   [out] VSQUERYADDFILERESULTS *pSummaryResult,
   [out, size_is(cFiles)] VSQUERYADDFILERESULTS rgResults[]
);

This method is used by directory-based projects that move files after extraction from source control, so the final location of the files may be different.

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

Share via