IVsPreviewChangesList.GetTipText Method

Article
2013-03-06

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

'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

eTipType
Type: Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE
[in] A value from the VSTREETOOLTIPTYPE enumeration specifying the kind of ToolTip text to return.

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

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