IVsSolution2.GetProjectEnum Method

Article
04/29/2015

Returns an enumerator for all the projects in the solution.

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

Syntax

'Declaration
Function GetProjectEnum ( _
    grfEnumFlags As UInteger, _
    ByRef rguidEnumOnlyThisType As Guid, _
    <OutAttribute> ByRef ppenum As IEnumHierarchies _
) As Integer

int GetProjectEnum(
    uint grfEnumFlags,
    ref Guid rguidEnumOnlyThisType,
    out IEnumHierarchies ppenum
)

int GetProjectEnum(
    [InAttribute] unsigned int grfEnumFlags, 
    [InAttribute] Guid% rguidEnumOnlyThisType, 
    [OutAttribute] IEnumHierarchies^% ppenum
)

abstract GetProjectEnum : 
        grfEnumFlags:uint32 * 
        rguidEnumOnlyThisType:Guid byref * 
        ppenum:IEnumHierarchies byref -> int

function GetProjectEnum(
    grfEnumFlags : uint, 
    rguidEnumOnlyThisType : Guid, 
    ppenum : IEnumHierarchies
) : int

Parameters

grfEnumFlags
Type: UInt32

[in] Specifies the projects to enumerate within a solution. For a list of grfEnumFlags values, see __VSENUMPROJFLAGS.

rguidEnumOnlyThisType
Type: Guid%

[in] If the EPF_MATCHTYPE flag is specified, the enumerator iterates projects of this type only. Otherwise, this parameter is ignored.

ppenum
Type: Microsoft.VisualStudio.Shell.Interop.IEnumHierarchies%

[out] Pointer to the project enumerator.

Return Value

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsSolution2::GetProjectEnum(
   [in] VSENUMPROJFLAGS grfEnumFlags, 
   [in] REFGUID rguidEnumOnlyThisType, 
   [out] IEnumHierarchies **ppEnum
);

This method enumerates all projects that are known by the solution, including virtual projects, if specified. The IEnumHierarchies interface contains the following methods in Vtable order:

.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