IVsObjectList.FillDescription(UInt32, UInt32, IVsObjectBrowserDescription2) Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Fordert das Listenelement auf, den im Objektkatalog zu verwendenden Beschreibungstext bereitzustellen.
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
Parameter
- index
- UInt32
[in] Gibt den Index des relevanten Listenelements an.
- grfOptions
- UInt32
[in] Gibt Beschreibungsoptionen an. Die Werte werden der _VSOBJDESCOPTIONS-Enumeration entnommen.
- pobDesc
- IVsObjectBrowserDescription2
[in] Gibt eine IVsObjectBrowserDescription3-Schnittstelle an.
Gibt zurück
Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Bei einem Fehler wird ein Fehlercode zurückgegeben.
Hinweise
COM-Signatur
Aus vsshell. idl:
HRESULT IVsObjectList::FillDescription(
[in] ULONG Index,
[in] VSOBJDESCOPTIONS grfOptions,
[in] IVsObjectBrowserDescription2 *pobDesc
);
Wenn ein Objekt im Objektkatalog ausgewählt wird, wird im unteren Bereich (Beschreibungs Bereich) des Fensters eine Beschreibung des Objekts angezeigt. Der Beschreibungstext wird durch eine Reihe von Aufrufen von erstellt AddDescriptionText3 . Die Umgebung ruft FillDescription für das relevante index Element auf. Der-Rückruf übergibt eine- IVsObjectBrowserDescription3 Schnittstelle. Dies ähnelt einer IStream Schnittstelle in, die Sie wiederholt aufzurufen AddDescriptionText3 , um die Beschreibung als eine Reihe von Elementen zu schreiben. Die-Elemente werden mit der- VSOBDESCRIPTIONSECTION Enumeration identifiziert.
In der Umgebung kann durch angegeben werden, grfOptions dass der voll qualifizierte Name des Index Elements zurückgegeben werden soll.
Diese Methode wird auch als alternative Methode zum Bereitstellen von QuickInfo-Text auf dem Element Symbol in den Tools zum Durchsuchen von Code verwendet. In diesem Szenario Ruft die Umgebung anfänglich GetTipText für das Index Element auf. Wenn Sie E_NOTIMPL den Aufruf zurückgeben oder fehlschlagen, ruft die Umgebung FillDescription auf, wobei grfOptions auf | festgelegt ist ODO_TOOLTIPDESC ODO_USEFULLNAME .