IVsObjectList2.GetTipText(UInt32, VSTREETOOLTIPTYPE, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns a pointer to the tool tip text for the requested tree list item.

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

Parameters

index

UInt32

[in] Specifies the index of the node of interest.

eTipType

VSTREETOOLTIPTYPE

[in] Specifies the type of tool tip text. Values are taken from the VSTREETOOLTIPTYPE enumeration.

ppszText

String

[out] Pointer to a text string containing the tree list item's tip text.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

[C++]

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

This method returns a pointer to the ToolTip text for the list item. GetTipText is usually not implemented. If you return E_NOTIMPL or E_FAIL to a GetText call, the ToolTip text defaults to the string found in TTO_DISPLAYTEXT.

If you do implement this method, note that the returned string is owned by the IVsObjectList2 implementation and must continue to exist for the life of the instantiation of that interface.