IVsSyntheticTextClient::GetErrorText Method (UInt32, IVsSyntheticRegion^, String^)

Visual Studio 2015

Returns error text for hovering.

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

Syntax

C++

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

Parameters

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

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

pbstrText: Type: 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::GetErrorText(
   [in] DWORD dwReason,
   [in] IVsSyntheticRegion *pSynthReg,
   [out] BSTR *pbstrText
);