IVsSimpleObjectList2.GetTipTextWithOwnership Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns the tool tip text for the requested tree list item.

public:
 int GetTipTextWithOwnership(System::UInt32 index, Microsoft::VisualStudio::Shell::Interop::VSTREETOOLTIPTYPE eTipType, [Runtime::InteropServices::Out] System::String ^ % pbstrText);

int GetTipTextWithOwnership(unsigned int index, Microsoft::VisualStudio::Shell::Interop::VSTREETOOLTIPTYPE eTipType, [Runtime::InteropServices::Out] std::wstring const & & pbstrText);

public int GetTipTextWithOwnership (uint index, Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE eTipType, out string pbstrText);

abstract member GetTipTextWithOwnership : uint32 * Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE * string -> int

Public Function GetTipTextWithOwnership (index As UInteger, eTipType As VSTREETOOLTIPTYPE, ByRef pbstrText 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.

pbstrText

String

[out] Returns a 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:

HRESULT IVsSimpleObjectList2::GetTipTextWithOwnership(  
   [in]  ULONG              Index,   
   [in]  VSTREETOOLTIPTYPE  eTipType,   
   [out] BSTR              *ppszText  
);  

This method returns 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.