IVsSimpleObjectList2.GetTipTextWithOwnership Method

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

声明
Function GetTipTextWithOwnership ( _
    index As UInteger, _
    eTipType As VSTREETOOLTIPTYPE, _
    <OutAttribute> ByRef pbstrText As String _
) As Integer
用法
Dim instance As IVsSimpleObjectList2
Dim index As UInteger
Dim eTipType As VSTREETOOLTIPTYPE
Dim pbstrText As String
Dim returnValue As Integer

returnValue = instance.GetTipTextWithOwnership(index, _
    eTipType, pbstrText)
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.
  • 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

See Also

Reference

IVsSimpleObjectList2 Interface

IVsSimpleObjectList2 Members

Microsoft.VisualStudio.Shell.Interop Namespace