IVsObjectList.GetBrowseObject(UInt32, Object) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

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

public:
 int GetBrowseObject(System::UInt32 index, [Runtime::InteropServices::Out] System::Object ^ % ppdispBrowseObj);
int GetBrowseObject(unsigned int index, [Runtime::InteropServices::Out] winrt::Windows::Foundation::IInspectable const & & ppdispBrowseObj);
public int GetBrowseObject (uint index, out object ppdispBrowseObj);
abstract member GetBrowseObject : uint32 * obj -> int
Public Function GetBrowseObject (index As UInteger, ByRef ppdispBrowseObj As Object) As Integer

Parameters

index
UInt32

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

ppdispBrowseObj
Object

[out] Pointer to an IDispatch object that is used to populate the Properties window.

Returns

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.

Applies to