IVsObjectList.GetBrowseObject Method

  • Article

Returns a pointer to the property browse IDispatch for the given list item.

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

Syntax

'Declaration
Function GetBrowseObject ( _
    index As UInteger, _
    <OutAttribute> ByRef ppdispBrowseObj As Object _
) As Integer

int GetBrowseObject(
    uint index,
    out Object ppdispBrowseObj
)

int GetBrowseObject(
    [InAttribute] unsigned int index, 
    [OutAttribute] Object^% ppdispBrowseObj
)

abstract GetBrowseObject : 
        index:uint32 * 
        ppdispBrowseObj:Object byref -> int 

function GetBrowseObject(
    index : uint, 
    ppdispBrowseObj : Object
) : int

Parameters

  • index
    Type: System.UInt32
    [in] Specifies the index of the list item of interest.
  • ppdispBrowseObj
    Type: System.Object%
    [out] Pointer to an IDispatch object that is used to populate the Properties window.

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::GetBrowseObject(
   [in] ULONG Index,
   [out] IDispatch **ppdispBrowseObj
);

This method is called on the list when the list item is selected in the tool UI. This applies to both the Class View and Object Browser tools. Many implementations, such as C++, simply reuse the CodeModel automation objects as the property browse objects.

You may return E_NOTIMPL if you don't support symbol level property browsing.

.NET Framework Security

See Also

Reference

IVsObjectList Interface

Microsoft.VisualStudio.Shell.Interop Namespace