IVsObjectList2.GetTipText Method

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function GetTipText ( _
    index As UInteger, _
    eTipType As VSTREETOOLTIPTYPE, _
    <OutAttribute> ByRef ppszText As String _
) As Integer
int GetTipText(
    uint index,
    VSTREETOOLTIPTYPE eTipType,
    out string ppszText
)
int GetTipText(
    [InAttribute] unsigned int index, 
    [InAttribute] VSTREETOOLTIPTYPE eTipType, 
    [OutAttribute] String^% ppszText
)
abstract GetTipText : 
        index:uint32 * 
        eTipType:VSTREETOOLTIPTYPE * 
        ppszText:string byref -> int
function GetTipText(
    index : uint, 
    eTipType : VSTREETOOLTIPTYPE, 
    ppszText : String
) : int

Parameters

  • index
    Type: UInt32

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

  • ppszText
    Type: String%

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

Return Value

Type: 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.

.NET Framework Security

See Also

Reference

IVsObjectList2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace