IVsObjectList2.FillDescription 方法

  • 参考

定义

命名空间:
Microsoft.VisualStudio.Shell.Interop
程序集:
Microsoft.VisualStudio.Shell.Interop.8.0.dll
程序集:

要求列表项提供要在对象浏览器中使用的说明文本。

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

中指定感兴趣的列表项的索引。

grfOptions
UInt32

中指定说明选项。 值取自 _VSOBJDESCOPTIONS 枚举

pobDesc
IVsObjectBrowserDescription2

中指定 IVsObjectBrowserDescription2 接口。

返回

Int32

如果该方法成功，则它会返回 S_OK。 如果该方法失败，则会返回错误代码。

注解

COM 签名

从 vsshell80：

[C++]

HRESULT IVsObjectList2::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 。

适用于