IVsSyntheticTextClient.GetErrorText Method

Returns tip text for hovering.

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

Syntax

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

returnValue = instance.GetErrorText(dwReason, _
    pSynthReg, pbstrText)

int GetErrorText(
    uint dwReason,
    IVsSyntheticRegion pSynthReg,
    out string pbstrText
)

int GetErrorText(
    [InAttribute] unsigned int dwReason, 
    [InAttribute] IVsSyntheticRegion^ pSynthReg, 
    [OutAttribute] String^% pbstrText
)

abstract GetErrorText : 
        dwReason:uint32 * 
        pSynthReg:IVsSyntheticRegion * 
        pbstrText:string byref -> int

function GetErrorText(
    dwReason : uint, 
    pSynthReg : IVsSyntheticRegion, 
    pbstrText : String
) : int

Parameters

dwReason
Type: System.UInt32
[in] Reason for the call.

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

pbstrText
Type: System.String%
[out] A BSTR containing 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::GetErrorText(
   [in] DWORD dwReason,
   [in] IVsSyntheticRegion *pSynthReg,
   [out] 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.