Freigeben über


IVsCompletionSet.GetDisplayText-Methode

Gibt den Text eines festgelegten Elements des Abschlusses zurück, wie sie in der festgelegten Liste der Vervollständigung angezeigt wird.

Namespace:  Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaration
Function GetDisplayText ( _
    iIndex As Integer, _
    <OutAttribute> ByRef ppszText As String, _
    <OutAttribute> piGlyph As Integer() _
) As Integer
int GetDisplayText(
    int iIndex,
    out string ppszText,
    int[] piGlyph
)
int GetDisplayText(
    [InAttribute] int iIndex, 
    [OutAttribute] String^% ppszText, 
    [OutAttribute] array<int>^ piGlyph
)
abstract GetDisplayText : 
        iIndex:int * 
        ppszText:string byref * 
        piGlyph:int[] byref -> int
function GetDisplayText(
    iIndex : int, 
    ppszText : String, 
    piGlyph : int[]
) : int

Parameter

  • iIndex
    Typ: Int32

    [in] Index des Elements festlegen, um das Anzeigen des Abschlusses Linktext zurückgegeben werden soll.

  • ppszText
    Typ: String%

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

  • piGlyph
    Typ: array<Int32[]

    [out] Gibt eine ganze Zahl zurück, die das Symbol identifiziert, das neben dem Abschluss Element anzuzeigen.

Rückgabewert

Typ: Int32
Wenn die Methode erfolgreich ausgeführt, gibt sie S_OKzurück.Bei einem Fehler wird ein Fehlercode zurückgegeben.

Hinweise

COM-Signatur

Von textmgr.idl:

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

Die zurückgegebene Zeichenfolge ist durch das Festlegen des Abschlusses Objekt beibehalten werden soll und die Zeichenfolge gültig bleiben bis endgültige Version aktualisiert werden oder durch Aufrufen von UpdateCompletionStatus. GetImageList wird von der Ansicht verwendet, um die Liste der Bilder bestimmt, die mit einem Vervollständigungssatz zugeordnet sind.

Hinweis

Die Zeichenfolge wird in der Regel durch das Objekt des Abschlusses erstellt und die Zeichenfolge muss für die Lebensdauer des Objekts beibehalten werden, oder bis Dismiss wird die Methode aufgerufen.

Wenn Sie diese Schnittstelle implementieren und in verwaltetem Code vom Aufrufer Sie die Zeichenfolge selbst löschen können, müssen Sie die IVsCoTaskMemFreeMyStrings-Schnittstelle implementieren.

.NET Framework-Sicherheit

Siehe auch

Referenz

IVsCompletionSet Schnittstelle

Microsoft.VisualStudio.TextManager.Interop-Namespace