IVsSyntheticTextClient.GetErrorText Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns error text for hovering.

public:
 int GetErrorText(System::UInt32 dwReason, Microsoft::VisualStudio::TextManager::Interop::IVsSyntheticRegion ^ pSynthReg, [Runtime::InteropServices::Out] System::String ^ % pbstrText);

int GetErrorText(unsigned int dwReason, Microsoft::VisualStudio::TextManager::Interop::IVsSyntheticRegion const & pSynthReg, [Runtime::InteropServices::Out] std::wstring const & & pbstrText);

public int GetErrorText (uint dwReason, Microsoft.VisualStudio.TextManager.Interop.IVsSyntheticRegion pSynthReg, out string pbstrText);

abstract member GetErrorText : uint32 * Microsoft.VisualStudio.TextManager.Interop.IVsSyntheticRegion * string -> int

Public Function GetErrorText (dwReason As UInteger, pSynthReg As IVsSyntheticRegion, ByRef pbstrText As String) As Integer

Parameters

dwReason: UInt32

[in] The reason for the call.

pSynthReg: IVsSyntheticRegion

[in] The synthetic region of interest.

pbstrText: String

[out] The text to display.

Returns

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  
);

Applies to