IVsLiteTreeList.GetTipText(UInt32, VSTREETOOLTIPTYPE, String) Метод

Определение

Возвращает указатель на текст подсказки для запрошенного элемента списка дерева.

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

Параметры

index
UInt32

[in] Определяет индекс узла, представляющего интерес.

eTipType
VSTREETOOLTIPTYPE

[in] Определяет тип текста подсказки. Значения берутся из перечисления VSTREETOOLTIPTYPE.

ppszText
String

[out] Указатель на текстовую строку, содержащую текст подсказки для элемента списка дерева.

Возвращаемое значение

Int32

Если метод завершается успешно, возвращает значение S_OK. В противном случае функция возвращает код ошибки.

Комментарии

Подпись COM

Из всшелл. IDL:

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

Этот метод возвращает указатель на текст подсказки для элемента списка. GetTipText обычно не реализуется. Если вы возвращаете E_NOTIMPL или E_FAIL к GetText вызову, текст подсказки будет по умолчанию иметь значение TTO_DISPLAYTEXT .

Примечание

Текстовый буфер создается IVsLiteTreeList объектом, и буфер должен сохраняться в течение всего времени существования IVsLiteTreeList объекта.

Если вы реализуете этот интерфейс в управляемом коде и вам нужна строка, удаленная вызывающим объектом, реализуйте IVsCoTaskMemFreeMyStrings интерфейс в IVsLiteTreeList интерфейсе.

Применяется к