IVsTextViewFilter.GetDataTipText(TextSpan[], String) Method

Definition

Provides data-tip support by obtaining the string value of the tip text.

public:
 int GetDataTipText(cli::array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> ^ pSpan, [Runtime::InteropServices::Out] System::String ^ % pbstrText);
int GetDataTipText(std::Array <Microsoft::VisualStudio::TextManager::Interop::TextSpan> const & pSpan, [Runtime::InteropServices::Out] std::wstring const & & pbstrText);
public int GetDataTipText (Microsoft.VisualStudio.TextManager.Interop.TextSpan[] pSpan, out string pbstrText);
abstract member GetDataTipText : Microsoft.VisualStudio.TextManager.Interop.TextSpan[] * string -> int
Public Function GetDataTipText (pSpan As TextSpan(), ByRef pbstrText As String) As Integer

Parameters

pSpan
TextSpan[]

[in, out] On input, the parameter specifies the user-selected characters to which the tip should apply. On output, the parameter specifies a pointer to the entire span of text associated with the tip.

pbstrText
String

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

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 IVsTextViewFilter::GetDataTipText(  
   [in, out] TextSpan * pSpan,  
   [out] BSTR * pbstrText  
);  

Use this method to provide a data tip for a variable or other language construct in the core text editor. For example, Visual Basic uses data tips to show the value of a variable as a user steps through code.

Applies to