IVsCompletionSet.GetDisplayText(Int32, String, Int32[]) Metoda

Definice

Vrátí text položky sady dokončení, jak je zobrazen v seznamu sad dokončení.Returns the text of a completion set item as it appears in the completion set list.

int GetDisplayText(int iIndex, [Runtime::InteropServices::Out] std::wstring const & & ppszText, std::Array <int> const & piGlyph);
public int GetDisplayText (int iIndex, out string ppszText, int[] piGlyph);
abstract member GetDisplayText : int * string * int[] -> int
Public Function GetDisplayText (iIndex As Integer, ByRef ppszText As String, Optional piGlyph As Integer()) As Integer

Parametry

iIndex
Int32

pro Index položky sady dokončení, pro kterou se má vrátit zobrazený text[in] Index of completion set item to return display text for.

ppszText
String

mimo Vrátí řetězec obsahující text zobrazení.[out] Returns a string containing the display text.

piGlyph
Int32[]

mimo Vrátí celé číslo identifikující glyf, který se zobrazí vedle položky dokončení.[out] Returns an integer identifying the glyph to display next to the completion item.

Návraty

Int32

Pokud je metoda úspěšná, vrátí S_OK .If the method succeeds, it returns S_OK. Pokud dojde k chybě, vrátí kód chyby.If it fails, it returns an error code.

Poznámky

Podpis COMCOM Signature

Z textmgr. idl:From textmgr.idl:

HRESULT IVsCompletionSet::GetDisplayText(  
   [in] long iIndex,  
   [out] WCHAR **ppszText,  
   [out, optional] long *piGlyph  
);  

Vrácený řetězec by měl být udržován objektem sady dokončování a řetězec by měl zůstat platný až do finální verze nebo dokud nebude aktualizován voláním UpdateCompletionStatus .The string returned should be maintained by the completion set object, and the string should remain valid until final release, or until updated by calling UpdateCompletionStatus. GetImageList se používá v zobrazení k určení seznamu imagí přidružených k sadě dokončení.GetImageList is used by the view to determine the list of images associated with a completion set.

Poznámka

Řetězec je obvykle vytvořen objektem sady dokončování a řetězec musí být uchován po dobu života tohoto objektu nebo dokud Dismiss není volána metoda.The string is typically created by the completion set object and the string must persist for the life of that object or until the Dismiss method is called.

Pokud implementujete Toto rozhraní ve spravovaném kódu a potřebujete, aby byl řetězec vyřazen volajícím, implementujte IVsCoTaskMemFreeMyStrings rozhraní.If you are implementing this interface in managed code and you need to have the string disposed of by the caller, implement the IVsCoTaskMemFreeMyStrings interface.

Platí pro