Share via


IVsSyntheticTextClient.GetTipText(IVsSyntheticRegion, String[]) Method

Definition

Returns the tip text for hovering.

int GetTipText(Microsoft::VisualStudio::TextManager::Interop::IVsSyntheticRegion const & pSynthReg, std::Array <std::wstring const &> const & pbstrText);
public int GetTipText (Microsoft.VisualStudio.TextManager.Interop.IVsSyntheticRegion pSynthReg, string[] pbstrText);
abstract member GetTipText : Microsoft.VisualStudio.TextManager.Interop.IVsSyntheticRegion * string[] -> int
Public Function GetTipText (pSynthReg As IVsSyntheticRegion, Optional pbstrText As String()) As Integer

Parameters

pSynthReg
IVsSyntheticRegion

[in] The synthetic region of interest.

pbstrText
String[]

[out] The text to display.

Returns

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

Remarks

COM Signature

From textmgr.idl:

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

Applies to