IVsLibrary.GetList Method

Article
03/06/2013

Returns the requested list of symbols as an IVsObjectList interface.

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

Syntax

'Declaration
Function GetList ( _
    ListType As UInteger, _
    flags As UInteger, _
    pobSrch As VSOBSEARCHCRITERIA(), _
    <OutAttribute> ByRef pplist As IVsObjectList _
) As Integer

int GetList(
    uint ListType,
    uint flags,
    VSOBSEARCHCRITERIA[] pobSrch,
    out IVsObjectList pplist
)

int GetList(
    [InAttribute] unsigned int ListType, 
    [InAttribute] unsigned int flags, 
    [InAttribute] array<VSOBSEARCHCRITERIA>^ pobSrch, 
    [OutAttribute] IVsObjectList^% pplist
)

abstract GetList : 
        ListType:uint32 * 
        flags:uint32 * 
        pobSrch:VSOBSEARCHCRITERIA[] * 
        pplist:IVsObjectList byref -> int

function GetList(
    ListType : uint, 
    flags : uint, 
    pobSrch : VSOBSEARCHCRITERIA[], 
    pplist : IVsObjectList
) : int

Parameters

ListType
Type: System.UInt32
[in] Specifies list type. Values are taken from the _LIB_LISTTYPE enumeration.

flags
Type: System.UInt32
[in] Specifies flags. Values are taken from the _LIB_LISTFLAGS enumeration.

pobSrch
Type: array<Microsoft.VisualStudio.Shell.Interop.VSOBSEARCHCRITERIA[]
[in] Specifies a pointer to a VSOBSEARCHCRITERIA structure.

pplist
Type: Microsoft.VisualStudio.Shell.Interop.IVsObjectList%
[out] Pointer to an IVsObjectList interface.

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 IVsLibrary::GetList(
   [in] LIB_LISTTYPE ListType,
   [in] LIB_LISTFLAGS Flags,
   [in] VSOBSEARCHCRITERIA *pobSrch,
   [out, retval] IVsObjectList **ppList
);

This method returns an IVsObjectList interface. The type of object list to return is specified in ListType with enumerators from _LIB_LISTTYPE. Attributes of the object list are specified in flags with enumerators from _LIB_LISTFLAGS. Members of the VSOBSEARCHCRITERIA structure, ppList, specify the criteria for finding the object list.

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