IVsSyntheticTextClient.GetTipText Method

Returns the tip text for hovering.

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

Syntax

'Declaration
Function GetTipText ( _
    pSynthReg As IVsSyntheticRegion, _
    <OutAttribute> pbstrText As String() _
) As Integer
'Usage
Dim instance As IVsSyntheticTextClient
Dim pSynthReg As IVsSyntheticRegion
Dim pbstrText As String()
Dim returnValue As Integer

returnValue = instance.GetTipText(pSynthReg, _
    pbstrText)

int GetTipText(
    IVsSyntheticRegion pSynthReg,
    string[] pbstrText
)

int GetTipText(
    [InAttribute] IVsSyntheticRegion^ pSynthReg, 
    [OutAttribute] array<String^>^ pbstrText
)

abstract GetTipText : 
        pSynthReg:IVsSyntheticRegion * 
        pbstrText:string[] byref -> int

function GetTipText(
    pSynthReg : IVsSyntheticRegion, 
    pbstrText : String[]
) : int

Parameters

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

pbstrText
Type: array<System.String[]
[out] A BSTR that contains 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:

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.