IVsObjectList.GetText(UInt32, VSTREETEXTOPTIONS, String) 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.
Gibt einen Zeiger auf die Textdarstellungen für das angeforderte Strukturlistenelement zurück.
public:
int GetText(System::UInt32 index, Microsoft::VisualStudio::Shell::Interop::VSTREETEXTOPTIONS tto, [Runtime::InteropServices::Out] System::String ^ % ppszText);
int GetText(unsigned int index, Microsoft::VisualStudio::Shell::Interop::VSTREETEXTOPTIONS tto, [Runtime::InteropServices::Out] std::wstring const & & ppszText);
public int GetText (uint index, Microsoft.VisualStudio.Shell.Interop.VSTREETEXTOPTIONS tto, out string ppszText);
abstract member GetText : uint32 * Microsoft.VisualStudio.Shell.Interop.VSTREETEXTOPTIONS * string -> int
Public Function GetText (index As UInteger, tto As VSTREETEXTOPTIONS, ByRef ppszText As String) As Integer
Parameter
- index
- UInt32
[in] Gibt den nullbasierten Index des relevanten Elements an.
[in] Gibt den Texttyp an, der angefordert wird. Die Werte werden der VSTREETEXTOPTIONS-Enumeration entnommen.
- ppszText
- String
[out] Zeiger auf eine Textzeichenfolge aus dem angegebenen Strukturlistenelement. Implementierungen müssen, entsprechend der Hinweise unten, diese Zeichenfolge zuordnen und die Gültigkeit des Zeiger beibehalten.
Gibt zurück
Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Bei einem Fehler wird ein Fehlercode zurückgegeben.
Implementiert
Hinweise
COM-Signatur
Aus vsshell. idl:
HRESULT IVsObjectList::GetText(
[in] ULONG Index,
[in] VSTREETEXTOPTIONS tto,
[out] const WCHAR **ppszText
);
Diese Methode gibt einen Zeiger auf eine Zeichenfolge zurück, die verschiedene Textelemente für das Struktur Listenelement enthält. Die für zurückgegebenen Zeichen folgen Zeiger TTO_SORTTEXT müssen für die Lebensdauer der Liste gültig und unverändert bleiben, da Sie zum kontinuierlichen sortieren und zum Fortfahren der Liste verwendet werden. Zeichen folgen Zeiger für andere VSTREETEXTOPTIONS Enumerationswerte müssen bis zum nächsten Aufruf unverändert bleiben GetText . zu diesem Zeitpunkt können Sie verworfen oder wieder verwendet werden.
Wenn Sie die IVsObjectList -Schnittstelle in verwaltetem Code implementieren und die Zeichenfolge vom Aufrufer verworfen werden muss, implementieren Sie die-Schnittstelle in IVsCoTaskMemFreeMyStrings der- IVsObjectList Schnittstelle.