IVsObjectList.GetExpandable2 Method

  • Article

Returns a flag indicating whether the given list item is expandable.

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

Syntax

'Declaration
Function GetExpandable2 ( _
    index As UInteger, _
    ListTypeExcluded As UInteger, _
    <OutAttribute> ByRef pfExpandable As Integer _
) As Integer

int GetExpandable2(
    uint index,
    uint ListTypeExcluded,
    out int pfExpandable
)

int GetExpandable2(
    [InAttribute] unsigned int index, 
    [InAttribute] unsigned int ListTypeExcluded, 
    [OutAttribute] int% pfExpandable
)

abstract GetExpandable2 : 
        index:uint32 * 
        ListTypeExcluded:uint32 * 
        pfExpandable:int byref -> int 

function GetExpandable2(
    index : uint, 
    ListTypeExcluded : uint, 
    pfExpandable : int
) : int

Parameters

  • index
    Type: System.UInt32
    [in] Specifies the index of the list item of interest.
  • ListTypeExcluded
    Type: System.UInt32
    [in] Specifies the list types to be excluded. Values are taken from the _LIB_LISTTYPE enumeration. This is primarily to remove LLT_MEMBERS from consideration in object browser, where they are shown in a separate pane.
  • pfExpandable
    Type: System.Int32%
    [out] Pointer to a flag indicating expandability.

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 IVsObjectList::GetExpandable2(
   [in] ULONG Index,
   [in] LIB_LISTTYPE ListTypeExcluded,
   [out] BOOL *pfExpandable
);

The environment's object manager will call this method to determine if an object list node has child lists. The environment may also indicate a list type to exclude from the expandable check by assigning an enumerator of _LIB_LISTTYPE to the ListTypeExcluded parameter. Use of ListTypeExcluded results primarily from an Object Browser query where members are listed in the right pane. If you choose to implement GetCategoryField instead of GetExpandable2, return E_NOTIMPL from GetExpandable2. The environment will then call GetCategoryField to obtain expandability information.

.NET Framework Security

See Also

Reference

IVsObjectList Interface

Microsoft.VisualStudio.Shell.Interop Namespace