IVsSyntheticTextClient::GetTipText Method (IVsSyntheticRegion^, array<String^>^)

Visual Studio 2015

Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Visual Studio 2005

Returns the tip text for hovering.

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

C++

int GetTipText(
	IVsSyntheticRegion^ pSynthReg,
	array<String^>^ pbstrText
)

Parameters

pSynthReg: Type: Microsoft.VisualStudio.TextManager.Interop::IVsSyntheticRegion^
[in] The synthetic region of interest.

pbstrText: Type: array<System::String^>^
[out] The text to display.

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 textmgr.idl:

C++

HRESULT IVsSyntheticTextClient::GetTipText(
   [in] IVsSyntheticRegion *pSynthReg,
   [out, optional] BSTR *pbstrText
);