IVsObjectList2.FillDescription Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Asks the list item to provide description text to be used in the object browser.

public:
 int FillDescription(System::UInt32 index, System::UInt32 grfOptions, Microsoft::VisualStudio::Shell::Interop::IVsObjectBrowserDescription2 ^ pobDesc);

public:
 int FillDescription(unsigned int index, unsigned int grfOptions, Microsoft::VisualStudio::Shell::Interop::IVsObjectBrowserDescription2 ^ pobDesc);

int FillDescription(unsigned int index, unsigned int grfOptions, Microsoft::VisualStudio::Shell::Interop::IVsObjectBrowserDescription2 const & pobDesc);

public int FillDescription (uint index, uint grfOptions, Microsoft.VisualStudio.Shell.Interop.IVsObjectBrowserDescription2 pobDesc);

abstract member FillDescription : uint32 * uint32 * Microsoft.VisualStudio.Shell.Interop.IVsObjectBrowserDescription2 -> int

Public Function FillDescription (index As UInteger, grfOptions As UInteger, pobDesc As IVsObjectBrowserDescription2) As Integer

Parameters

index

UInt32

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

grfOptions

UInt32

[in] Specifies description options. Values are taken from the _VSOBJDESCOPTIONS enumeration

pobDesc

IVsObjectBrowserDescription2

[in] Specifies a IVsObjectBrowserDescription2 interface.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

[C++]

HRESULT IVsObjectList2::FillDescription(  
   [in] ULONG Index,   
   [in] VSOBJDESCOPTIONS grfOptions,   
   [in] IVsObjectBrowserDescription2 *pobDesc  
);  

When an object is selected in the Object Browser, a description of the object appears in the lower pane (Description Pane) of the window. The description text is built through a series of calls to AddDescriptionText3. The environment calls FillDescription for the index item of interest. The call passes in an IVsObjectBrowserDescription3 interface. This is similar to an IStream interface in that you repeatedly call AddDescriptionText3 to write your description as a series of elements. The elements are identified with the VSOBDESCRIPTIONSECTION enumeration.

The environment can specify, through grfOptions, that you should return the fully qualified name of the Index item.

This method also used as an alternate means of providing tool tip text on the item's icon in the code browsing tools. In this scenario the environment initially calls GetTipText on the Index item. If you return E_NOTIMPLor fail the call, the environment then calls FillDescription with grfOptions set to ODO_TOOLTIPDESC | ODO_USEFULLNAME.