IVsEnumHierarchyItemsFactory.EnumHierarchyItems Method

Article
2013-03-06

Provides an enumerator for items in a specified project hierarchy.

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

Syntax

'Declaration
Function EnumHierarchyItems ( _
    pHierRoot As IVsHierarchy, _
    grfItems As UInteger, _
    itemidRoot As UInteger, _
    <OutAttribute> ByRef ppenum As IEnumHierarchyItems _
) As Integer

int EnumHierarchyItems(
    IVsHierarchy pHierRoot,
    uint grfItems,
    uint itemidRoot,
    out IEnumHierarchyItems ppenum
)

int EnumHierarchyItems(
    [InAttribute] IVsHierarchy^ pHierRoot, 
    [InAttribute] unsigned int grfItems, 
    [InAttribute] unsigned int itemidRoot, 
    [OutAttribute] IEnumHierarchyItems^% ppenum
)

abstract EnumHierarchyItems : 
        pHierRoot:IVsHierarchy * 
        grfItems:uint32 * 
        itemidRoot:uint32 * 
        ppenum:IEnumHierarchyItems byref -> int

function EnumHierarchyItems(
    pHierRoot : IVsHierarchy, 
    grfItems : uint, 
    itemidRoot : uint, 
    ppenum : IEnumHierarchyItems
) : int

Parameters

pHierRoot
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy
[in] Pointer to the IVsHierarchy interface defining the project hierarchy.

grfItems
Type: System.UInt32
[in] Bit flags determining which hierarchy items to include in the enumeration. Set by combining values from the __VSEHI enumeration.

itemidRoot
Type: System.UInt32
[in] The item ID. Usually VSITEMID_ROOT.

ppenum
Type: Microsoft.VisualStudio.Shell.Interop.IEnumHierarchyItems%
[out] Pointer to the enumerator, a IEnumHierarchyItems instance.

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 IVsEnumHierarchyItemsFactory::EnumHierarchyItems(
   [in] IVsHierarchy * pHierRoot, 
   [in] VSEHI grfItems, 
   [in] VSITEMID itemidRoot
);

.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