IVsDebugger.GetDataTipValue Method

Article
03/06/2013

Retrieves debugger data tip text for a selected section of text.

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

Syntax

'Declaration
Function GetDataTipValue ( _
    pTextBuf As IVsTextLines, _
    pTS As TextSpan(), _
    pszExpression As String, _
    <OutAttribute> ByRef pbstrValue As String _
) As Integer

int GetDataTipValue(
    IVsTextLines pTextBuf,
    TextSpan[] pTS,
    string pszExpression,
    out string pbstrValue
)

int GetDataTipValue(
    [InAttribute] IVsTextLines^ pTextBuf, 
    [InAttribute] array<TextSpan>^ pTS, 
    [InAttribute] String^ pszExpression, 
    [OutAttribute] String^% pbstrValue
)

abstract GetDataTipValue : 
        pTextBuf:IVsTextLines * 
        pTS:TextSpan[] * 
        pszExpression:string * 
        pbstrValue:string byref -> int

function GetDataTipValue(
    pTextBuf : IVsTextLines, 
    pTS : TextSpan[], 
    pszExpression : String, 
    pbstrValue : String
) : int

Parameters

pTextBuf
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextLines
[in] Pointer to a IVsTextLines interface to the text buffer

pTS
Type: array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[]
[in] Pointer to a TextSpan structure describing the text location within the buffer. May be nulla null reference (Nothing in Visual Basic) when using the pszExpression argument.

pszExpression
Type: System.String
[in] Text of the expression for which to retrieve the data tip text. May be nulla null reference (Nothing in Visual Basic) when using the pTS argument.

pbstrValue
Type: System.String%
[out] Pointer to a string containing the data tip text.

Return Value

Type: System.Int32
If the method succeeds, it returns TIP_S_NODEFAULTTIP. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsDebugger::GetDataTipValue(
   [in] IVsTextLines *pTextBuf,
   [in] const TextSpan *pTS,
   [in] WCHAR *pszExpression,
   [out] BSTR *pbstrValue
);

.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.