IVsLiteTree.EnumOrderedListItems Method

Article
03/06/2013

Enumerate the complete tree list a sub-tree at a time.

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

Syntax

'Declaration
Function EnumOrderedListItems ( _
    <OutAttribute> ByRef pNextStartIndex As UInteger, _
    <OutAttribute> ByRef pptl As IVsLiteTreeList, _
    <OutAttribute> ByRef pFirstRelIndex As UInteger, _
    <OutAttribute> ByRef pLastRelIndex As UInteger, _
    <OutAttribute> ByRef pLevel As UInteger _
) As Integer

int EnumOrderedListItems(
    out uint pNextStartIndex,
    out IVsLiteTreeList pptl,
    out uint pFirstRelIndex,
    out uint pLastRelIndex,
    out uint pLevel
)

int EnumOrderedListItems(
    [InAttribute] [OutAttribute] unsigned int% pNextStartIndex, 
    [OutAttribute] IVsLiteTreeList^% pptl, 
    [OutAttribute] unsigned int% pFirstRelIndex, 
    [OutAttribute] unsigned int% pLastRelIndex, 
    [OutAttribute] unsigned int% pLevel
)

abstract EnumOrderedListItems : 
        pNextStartIndex:uint32 byref * 
        pptl:IVsLiteTreeList byref * 
        pFirstRelIndex:uint32 byref * 
        pLastRelIndex:uint32 byref * 
        pLevel:uint32 byref -> int

function EnumOrderedListItems(
    pNextStartIndex : uint, 
    pptl : IVsLiteTreeList, 
    pFirstRelIndex : uint, 
    pLastRelIndex : uint, 
    pLevel : uint
) : int

Parameters

pNextStartIndex
Type: System.UInt32%
[in, out] Pointer to the index of the first item in the list. On return, index of the next item in the list.

pptl
Type: Microsoft.VisualStudio.Shell.Interop.IVsLiteTreeList%
[out] Pointer to the IVsLiteTreeList for this segment of the tree.

pFirstRelIndex
Type: System.UInt32%
[out] Pointer to the relative index of the first item in the list.

pLastRelIndex
Type: System.UInt32%
[Out] Pointer to the relative index of the last item in the list.

pLevel
Type: System.UInt32%
[Out] Pointer to the current level within the tree.

Return Value

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

Remarks

For more information about enumerating tree lists and their structure, see IVsLiteTreeList.

COM Signature

[C++]

From vsshell.idl:

HRESULT IVsLiteTree::EnumOrderedListItems(
   [in,out] ULONG *pNextStartIndex, 
   [out] IVsLiteTreeList **pptl, 
   [out] ULONG *pFirstRelIndex, 
   [out] ULONG *pLastRelIndex, 
   [out] ULONG *pLevel
);

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