IVsObjectList.FillDescription – metoda (UInt32, UInt32, IVsObjectBrowserDescription2)

Článek
10/12/2015

Zobrazí položky seznamu poskytnout popis k použití v prohlížeči objektů.

Obor názvů: Microsoft.VisualStudio.Shell.Interop
Sestavení: Microsoft.VisualStudio.Shell.Interop (v Microsoft.VisualStudio.Shell.Interop.dll)

Syntaxe

int FillDescription(
    uint index,
    uint grfOptions,
    IVsObjectBrowserDescription2 pobDesc
)

int FillDescription(
    unsigned int index,
    unsigned int grfOptions,
    IVsObjectBrowserDescription2^ pobDesc
)

abstract FillDescription : 
        index:uint32 *
        grfOptions:uint32 *
        pobDesc:IVsObjectBrowserDescription2 -> int

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

Parametry

index
[v] Určuje index položky seznamu zájmu.

grfOptions
[v] Určuje popis možnosti.Hodnoty jsou převzaty z _VSOBJDESCOPTIONS výčtu

pobDesc
[v] Určuje, IVsObjectBrowserDescription3 rozhraní.

Vrácená hodnota

Type: System.Int32

Pokud metoda uspěje, vrací S_OK.Pokud se nezdaří, vrátí kód chyby.

Poznámky

Podpis COM

Z vsshell.idl:

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

Když je vybraný objekt v Prohlížeč objektů, v dolním podokně se zobrazí popis objektu (Podokně popis) okna.Text popisu je sestaven pomocí série volání AddDescriptionText3.Prostředí bude volat FillDescription pro index zboží zájem.Volání předává v IVsObjectBrowserDescription3 rozhraní.Je to podobné jako IStream , opakovaně volají rozhraní AddDescriptionText3 zapsat popis jako řadu prvků.Prvky jsou označeny VSOBDESCRIPTIONSECTION výčtu.

Prostředí můžete určit, prostřednictvím grfOptions, že by mělo vrátit plně kvalifikovaný název položky rejstříku.

Tato metoda také použita jako alternativní prostředek pro poskytování text tipu nástroje na ikonu nástroje procházení kód položky.V tomto případě bude zpočátku volání prostředí GetTipText na položku rejstříku.Pokud vrátíte E_NOTIMPL nebo selhání volání, pak zavolá prostředí FillDescription s grfOptions nastavena naODO_TOOLTIPDESC | ODO_USEFULLNAME.

Viz také

IVsObjectList – rozhraní
Microsoft.VisualStudio.Shell.Interop – obor názvů

Zpátky na začátek

Sdílet prostřednictvím