IVsPreviewChangesList::GetTipText Method (UInt32, VSTREETOOLTIPTYPE, String^)

Visual Studio 2015

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

C++

int GetTipText(
	unsigned int index,
	VSTREETOOLTIPTYPE eTipType,
	[OutAttribute] String^% ppszText
)

Parameters

index: Type: System::UInt32
[in] The index of the item for which to get the ToolTip text.

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:

C++

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.