IVsPreviewChangesList.GetTipText Method

Returns the ToolTip text for the specified item in the preview list.

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

Syntax

‘선언
Function GetTipText ( _
    index As UInteger, _
    eTipType As VSTREETOOLTIPTYPE, _
    <OutAttribute> ByRef ppszText As String _
) As Integer
‘사용 방법
Dim instance As IVsPreviewChangesList
Dim index As UInteger
Dim eTipType As VSTREETOOLTIPTYPE
Dim ppszText As String
Dim returnValue As Integer

returnValue = instance.GetTipText(index, _
    eTipType, ppszText)
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

  • ppszText
    Type: System.String%
    [out] Returns a string containing the ToolTip 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 IVsPreviewChangesList::GetTipText(
   [in]  ULONG               Index, 
   [in]  VSTREETOOLTIPTYPE   eTipType, 
   [out] const WCHAR       **ppszText
);

Note that, for performance reasons, the returned string must persist for the life of the IVsPreviewChangesList object or until the next call to this method.

.NET Framework Security

See Also

Reference

IVsPreviewChangesList Interface

IVsPreviewChangesList Members

Microsoft.VisualStudio.Shell.Interop Namespace