IVsTrackProjectDocuments2.OnQueryAddDirectories Method

Article
07/12/2014

This method is called by a project to determine whether directories can be added to the project.

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

Syntax

'Declaration
Function OnQueryAddDirectories ( _
    pProject As IVsProject, _
    cDirectories As Integer, _
    rgpszMkDocuments As String(), _
    rgFlags As VSQUERYADDDIRECTORYFLAGS(), _
    <OutAttribute> pSummaryResult As VSQUERYADDDIRECTORYRESULTS(), _
    <OutAttribute> rgResults As VSQUERYADDDIRECTORYRESULTS() _
) As Integer

int OnQueryAddDirectories(
    IVsProject pProject,
    int cDirectories,
    string[] rgpszMkDocuments,
    VSQUERYADDDIRECTORYFLAGS[] rgFlags,
    VSQUERYADDDIRECTORYRESULTS[] pSummaryResult,
    VSQUERYADDDIRECTORYRESULTS[] rgResults
)

int OnQueryAddDirectories(
    [InAttribute] IVsProject^ pProject, 
    [InAttribute] int cDirectories, 
    [InAttribute] array<String^>^ rgpszMkDocuments, 
    [InAttribute] array<VSQUERYADDDIRECTORYFLAGS>^ rgFlags, 
    [OutAttribute] array<VSQUERYADDDIRECTORYRESULTS>^ pSummaryResult, 
    [OutAttribute] array<VSQUERYADDDIRECTORYRESULTS>^ rgResults
)

abstract OnQueryAddDirectories : 
        pProject:IVsProject * 
        cDirectories:int * 
        rgpszMkDocuments:string[] * 
        rgFlags:VSQUERYADDDIRECTORYFLAGS[] * 
        pSummaryResult:VSQUERYADDDIRECTORYRESULTS[] byref * 
        rgResults:VSQUERYADDDIRECTORYRESULTS[] byref -> int

function OnQueryAddDirectories(
    pProject : IVsProject, 
    cDirectories : int, 
    rgpszMkDocuments : String[], 
    rgFlags : VSQUERYADDDIRECTORYFLAGS[], 
    pSummaryResult : VSQUERYADDDIRECTORYRESULTS[], 
    rgResults : VSQUERYADDDIRECTORYRESULTS[]
) : int

Parameters

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

[in] Project containing the renamed directories.

cDirectories
Type: System.Int32

[in] Number of directories to be added.

rgpszMkDocuments
Type: array<System.String[]

[in] Array of paths for the directories to add.

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

[in] Flags identifying information about each directory. For a list of rgFlags values, see VSQUERYADDDIRECTORYFLAGS.

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

[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 VSQUERYADDDIRECTORYRESULTS_AddNotOK; if the results for all directories are yes, then pSummaryResult is equal to VSQUERYADDDIRECTORYRESULTS_AddOK. For a list of pSummaryResult values, see VSQUERYADDDIRECTORYRESULTS.

rgResults
Type: array<Microsoft.VisualStudio.Shell.Interop.VSQUERYADDDIRECTORYRESULTS[]

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

Note If you pass in nulla null reference (Nothing in Visual Basic) for this parameter, then only the summary result will be returned (pSummaryResult).

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

HRESULT IVsTrackProjectDocuments2::OnQueryAddDirectories(
   [in] IVsProject *pProject,
   [in] int cDirectories,
   [in, size_is(cDirectories)] const LPCOLESTR rgpszMkDocuments[],
   [in, size_is(cDirectories)] const VSQUERYADDDIRECTORYFLAGS rgFlags[],
   [out] VSQUERYADDDIRECTORYRESULTS *pSummaryResult,
   [out, size_is(cDirectories)] VSQUERYADDDIRECTORYRESULTS rgResults[]
);

Call this method when you want to add directories to the project. This method must be called before the directories are added. The environment will return a flag indicating which directories can be added. After you have received authorization to add the directories and you have added them, call OnAfterAddDirectories to confirm that the directories have been added.

Note

All directory calls are optional. However, if you call one of the OnQuery* directory methods, then you are required to call the corresponding OnAfter* directory method if the OnQuery* call was successful.

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