IVsObjectList.GetTipText Method

Article
03/06/2013

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.

eTipType
Type: Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE
[in] Specifies the type of tool tip text. Values are taken from the VSTREETOOLTIPTYPE enumeration.

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.

Implements

IVsLiteTreeList.GetTipText(UInt32, VSTREETOOLTIPTYPE, String%)

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsObjectList::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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via