IVsObjectList2.GetExpandable3 Method

Article
04/22/2008

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

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

Syntax

'Déclaration
Function GetExpandable3 ( _
    index As UInteger, _
    ListTypeExcluded As UInteger, _
    <OutAttribute> ByRef pfExpandable As Integer _
) As Integer
'Utilisation
Dim instance As IVsObjectList2
Dim index As UInteger
Dim ListTypeExcluded As UInteger
Dim pfExpandable As Integer
Dim returnValue As Integer

returnValue = instance.GetExpandable3(index, _
    ListTypeExcluded, pfExpandable)

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

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

function GetExpandable3(
    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 vsshell80.idl:

HRESULT IVsObjectList2::GetExpandable3(
   [in] ULONG Index, 
   [in] LIB_LISTTYPE2 ListTypeExcluded, 
   [out] BOOL *pfExpandable
);

The environment's object manager calls 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 a value from the _LIB_LISTTYPE enumeration 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 GetCategoryField2 instead of GetExpandable3, return E_NOTIMPL from GetExpandable3. The environment then calls GetCategoryField2 to obtain expandability information.

Permissions

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.

Partager via