IVsLiteTreeList.GetTipText Method

  • Article

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.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: System.UInt32
    [in] Specifies the index of the node of interest.
  • ppszText
    Type: System.String%
    [out] Pointer to a text string containing the tree list item's tip text.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

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

This method returns a pointer to the tip text for the list item. GetTipText is usually not implemented. If you return E_NOTIMPL or E_FAIL to a GetText call, tip text will default to TTO_DISPLAYTEXT.

Note

The text buffer is created by the IVsLiteTreeList object and the buffer must persist for the life of the IVsLiteTreeList object.

If you are implementing this interface in managed code and you need to have the string disposed of by the caller, implement the IVsCoTaskMemFreeMyStrings interface on the IVsLiteTreeList interface.

.NET Framework Security

See Also

Reference

IVsLiteTreeList Interface

Microsoft.VisualStudio.Shell.Interop Namespace