IVsPreviewChangesList.GetTipText(UInt32, VSTREETOOLTIPTYPE, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int GetTipText(System::UInt32 index, Microsoft::VisualStudio::Shell::Interop::VSTREETOOLTIPTYPE eTipType, [Runtime::InteropServices::Out] System::String ^ % ppszText);

int GetTipText(unsigned int index, Microsoft::VisualStudio::Shell::Interop::VSTREETOOLTIPTYPE eTipType, [Runtime::InteropServices::Out] std::wstring const & & ppszText);

public int GetTipText (uint index, Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE eTipType, out string ppszText);

abstract member GetTipText : uint32 * Microsoft.VisualStudio.Shell.Interop.VSTREETOOLTIPTYPE * string -> int

Public Function GetTipText (index As UInteger, eTipType As VSTREETOOLTIPTYPE, ByRef ppszText As String) As Integer

Parameters

index: UInt32

[in] The index of the item for which to get the ToolTip text.

eTipType: VSTREETOOLTIPTYPE

[in] A value from the VSTREETOOLTIPTYPE enumeration specifying the kind of ToolTip text to return.

ppszText: String

[out] Returns a string containing the ToolTip text.

Returns

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.

Applies to

Partager via