IVsObjectList.FillDescription(UInt32, UInt32, IVsObjectBrowserDescription2) Метод

Определение

Запрашивает элемент списка для предоставления текста описания, используемого в обозревателе объектов.

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

Параметры

index
UInt32

[in] Определяет индекс представляющего интерес элемента списка.

grfOptions
UInt32

[in] Определяет параметры описания. Значения берутся из перечисления _VSOBJDESCOPTIONS

pobDesc
IVsObjectBrowserDescription2

[in] Указывает интерфейс IVsObjectBrowserDescription3.

Возвращаемое значение

Int32

Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.

Комментарии

Подпись COM

Из всшелл. IDL:

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

При выборе объекта в обозревателе объектов описание объекта отображается в нижней области (область описания) окна. Текст описания создается с помощью серии вызовов AddDescriptionText3 . Среда будет вызывать FillDescription index интересующий элемент. Вызов передается в IVsObjectBrowserDescription3 интерфейсе. Это похоже на IStream интерфейс, в котором вы многократно вызываете функцию AddDescriptionText3 для записи описания в виде последовательности элементов. Элементы определяются с помощью VSOBDESCRIPTIONSECTION перечисления.

Среда может указывать, grfOptions что следует возвращать полное имя элемента индекса.

Этот метод также используется в качестве альтернативного способа предоставления текста подсказки для значка элемента в средствах обзора кода. В этом сценарии среда будет изначально вызывать GetTipText элемент индекса. Если вы возвращаете E_NOTIMPL или завершаете вызов, среда затем вызывает метод с параметром, равным FillDescription grfOptions ODO_TOOLTIPDESC | ODO_USEFULLNAME .

Применяется к