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

Definition

Gibt den Text eines Vervollständigungssatz-Elements zurück, das in der festgelegten Liste der Vervollständigung angezeigt wird.

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

Parameter

iIndex
Int32

[in] Index des Elements im Vervollständigungssatz, für das Anzeigentext zurückgegeben werden soll.

ppszText
String

[out] Gibt eine Zeichenfolge zurück, die den Text enthält.

piGlyph
Int32[]

[out] Gibt eine ganze Zahl zurück, die das Symbol identifiziert, das neben dem Abschlusselement angezeigt werden soll.

Gibt zurück

Int32

Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Bei einem Fehler wird ein Fehlercode zurückgegeben.

Hinweise

COM-Signatur

Aus textmgr. idl:

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

Die zurückgegebene Zeichenfolge sollte durch das Vervollständigungs Satz Objekt verwaltet werden, und die Zeichenfolge sollte bis zum endgültigen Release gültig bleiben, oder bis zum Aktualisieren, indem aufgerufen wird UpdateCompletionStatus . GetImageList wird von der Ansicht verwendet, um die Liste der Images zu ermitteln, die einem Vervollständigungs Satz zugeordnet sind.

Hinweis

Die Zeichenfolge wird in der Regel vom Vervollständigungs Satz Objekt erstellt, und die Zeichenfolge muss für die Lebensdauer des Objekts oder bis zum Aufrufen der-Methode beibehalten werden Dismiss .

Wenn Sie diese Schnittstelle in verwaltetem Code implementieren und die Zeichenfolge vom Aufrufer verworfen werden muss, implementieren Sie die- IVsCoTaskMemFreeMyStrings Schnittstelle.

Gilt für