IVsObjectList2.GetList2 Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns a child IVsObjectList2 for the specified category.

public:
 int GetList2(System::UInt32 index, System::UInt32 ListType, System::UInt32 flags, cli::array <Microsoft::VisualStudio::Shell::Interop::VSOBSEARCHCRITERIA2> ^ pobSrch, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsObjectList2 ^ % ppIVsObjectList2);

int GetList2(unsigned int index, unsigned int ListType, unsigned int flags, std::Array <Microsoft::VisualStudio::Shell::Interop::VSOBSEARCHCRITERIA2> const & pobSrch, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsObjectList2 const & & ppIVsObjectList2);

public int GetList2 (uint index, uint ListType, uint flags, Microsoft.VisualStudio.Shell.Interop.VSOBSEARCHCRITERIA2[] pobSrch, out Microsoft.VisualStudio.Shell.Interop.IVsObjectList2 ppIVsObjectList2);

abstract member GetList2 : uint32 * uint32 * uint32 * Microsoft.VisualStudio.Shell.Interop.VSOBSEARCHCRITERIA2[] * IVsObjectList2 -> int

Public Function GetList2 (index As UInteger, ListType As UInteger, flags As UInteger, pobSrch As VSOBSEARCHCRITERIA2(), ByRef ppIVsObjectList2 As IVsObjectList2) As Integer

Parameters

index

UInt32

[in] Specifies the index of the list item of interest.

ListType

UInt32

[in] Specifies the type of list being requested. Values are taken from the _LIB_LISTTYPE enumeration.

flags

UInt32

[in] Specifies the flags that control the request for object list information. Values are taken from the _LIB_LISTFLAGS enumeration.

pobSrch

VSOBSEARCHCRITERIA2[]

[in] Unused. Should be ignored.

ppIVsObjectList2

IVsObjectList2

[out] Pointer to the IVsObjectList2 interface of the returned child list.

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl:

[C++]

HRESULT IVsObjectList2::GetList2(  
   [in] ULONG Index,   
   [in] LIB_LISTTYPE2 ListType,   
   [in] LIB_LISTFLAGS Flags,   
   [in] VSOBSEARCHCRITERIA2 *pobSrch,   
   [out, retval] IVsObjectList2 **ppIVsObjectList2  
);  

When the user expands a list node, the object manager asks the list what child lists it supports under that list item by calling GetCategoryField2 (index, LC_LISTTYPE). Then it calls IVsObjectList2::GetList with each of the list types returned as supported.

Under an LC_PHYSICALCONTAINERS list a library would typically support LLT_NAMESPACES, LLT_CLASSES, and LLT_MEMBERS lists. Under LLT_NAMESPACES list, support LLT_NAMESPACES (for nested namespaces), and LLT_MEMBERS. Under LLT_CLASSES list, support LLT_CLASSES (for nested classes), and LLT_MEMBERS lists. LLT_HIERARCHY lists can appear anywhere to provide auxiliary information nodes such as Bases and Interfaces nodes, a Derived Classes node, and so on.

When GetList2 is called, your library should create (or reuse existing) an IVsObjectList2 based on the specified category for the specified tool (as per the flags). Any TTO_SORTTEXT strings allocated for the items that are obtained by the object manager through subsequent calls to GetText must be kept valid until the list's final release.