IVsSimplePreviewChangesList.GetTipTextWithOwnership Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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 GetTipTextWithOwnership(System::UInt32 index, Microsoft::VisualStudio::Shell::Interop::VSTREETOOLTIPTYPE eTipType, [Runtime::InteropServices::Out] System::String ^ % pbstrText);

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

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

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

Public Function GetTipTextWithOwnership (index As UInteger, eTipType As VSTREETOOLTIPTYPE, ByRef pbstrText 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.

pbstrText: String

[out] Returns a string containing the ToolTip text.

Returns

Int32

f the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsSimplePreviewChangesList::GetTipTextWithOwnership(  
   [in]  ULONG               Index,   
   [in]  VSTREETOOLTIPTYPE   eTipType,   
   [out] BSTR               *ppszText  
);

Applies to