IVsSolution.GetProjectEnum Method

Article
04/22/2008

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

'Déclaration
Function GetProjectEnum ( _
    grfEnumFlags As UInteger, _
    ByRef rguidEnumOnlyThisType As Guid, _
    <OutAttribute> ByRef ppenum As IEnumHierarchies _
) As Integer
'Utilisation
Dim instance As IVsSolution
Dim grfEnumFlags As UInteger
Dim rguidEnumOnlyThisType As Guid
Dim ppenum As IEnumHierarchies
Dim returnValue As Integer

returnValue = instance.GetProjectEnum(grfEnumFlags, _
    rguidEnumOnlyThisType, ppenum)

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

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

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

Parameters

grfEnumFlags
Type: System.UInt32

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

rguidEnumOnlyThisType
Type: System.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: System.Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsSolution::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:

Permissions

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.

Partager via