IVsSimpleObjectList2.GetTipTextWithOwnership Method

Article
2013-03-06

Returns 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 GetTipTextWithOwnership ( _
    index As UInteger, _
    eTipType As VSTREETOOLTIPTYPE, _
    <OutAttribute> ByRef pbstrText As String _
) As Integer

int GetTipTextWithOwnership(
    uint index,
    VSTREETOOLTIPTYPE eTipType,
    out string pbstrText
)

int GetTipTextWithOwnership(
    [InAttribute] unsigned int index, 
    [InAttribute] VSTREETOOLTIPTYPE eTipType, 
    [OutAttribute] String^% pbstrText
)

abstract GetTipTextWithOwnership : 
        index:uint32 * 
        eTipType:VSTREETOOLTIPTYPE * 
        pbstrText:string byref -> int

function GetTipTextWithOwnership(
    index : uint, 
    eTipType : VSTREETOOLTIPTYPE, 
    pbstrText : 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.

pbstrText
Type: System.String%
[out] Returns a 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 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.

.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