IVsLiteTreeList.GetTipText(UInt32, VSTREETOOLTIPTYPE, String) Methode

Definition

Gibt einen Zeiger auf den QuickInfo-Text für das angeforderte Strukturlistenelement zurück.

public:
 int GetTipText(System::UInt32 index, Microsoft::VisualStudio::Shell::Interop::VSTREETOOLTIPTYPE eTipType, [Runtime::InteropServices::Out] System::String ^ % ppszText);
int GetTipText(unsigned int index, Microsoft::VisualStudio::Shell::Interop::VSTREETOOLTIPTYPE eTipType, [Runtime::InteropServices::Out] std::wstring const & & ppszText);
public int GetTipText (uint index, Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE eTipType, out string ppszText);
abstract member GetTipText : uint32 * Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE * string -> int
Public Function GetTipText (index As UInteger, eTipType As VSTREETOOLTIPTYPE, ByRef ppszText As String) As Integer

Parameter

index
UInt32

[in] Gibt den Index des relevanten Knotens an.

eTipType
VSTREETOOLTIPTYPE

[in] Gibt den Typ des QuickInfo-Texts an. Die Werte werden der VSTREETOOLTIPTYPE-Enumeration entnommen.

ppszText
String

[out] Zeiger auf eine Zeichenfolge, die den QuickInfo-Text des Strukturlistenelements enthält.

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 vsshell. idl:

HRESULT IVsLiteTreeList::GetTipText(  
   [in] ULONG Index,  
   [in] VSTREETOOLTIPTYPE eTipType,  
   [out] const WCHAR **ppszText  
);  

Diese Methode gibt einen Zeiger auf den QuickInfo-Text für das Listenelement zurück. GetTipText ist in der Regel nicht implementiert. Wenn Sie oder an einen-Befehl zurückgeben E_NOTIMPL E_FAIL GetText , wird für Tip Text standardmäßig verwendet TTO_DISPLAYTEXT .

Hinweis

Der Text Puffer wird vom IVsLiteTreeList -Objekt erstellt, und der Puffer muss für die Lebensdauer des-Objekts beibehalten werden IVsLiteTreeList .

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

Gilt für