Share via


IVsHiddenTextClient.GetTipText(IVsHiddenRegion, String[]) Method

Definition

Signals that the user has hovered the mouse over a collapsed hidden text region.

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

Parameters

pHidReg
IVsHiddenRegion

[in] Pointer to a hidden region object, IVsHiddenRegion for which tip text is required.

pbstrText
String[]

[out] Pointer to a string containing the tip text.

Returns

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

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsHiddenTextClient::GetTipText(  
   [in] IVsHiddenRegion *pHidReg,   
   [out, optional] BSTR *pbstrText  
);  

Provides tip text for the collapsed outline region in response to this method being called. For example, in Visual C#, this method is used to provide the text of comments when they are collapsed and the user hovers over the banner for the collapsed region (that is, "/**/").

Applies to