IVsLanguageDebugInfo.GetProximityExpressions Method

Article
11/19/2013

Generates proximity expressions.

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

Syntax

'Declaration
Function GetProximityExpressions ( _
    pBuffer As IVsTextBuffer, _
    iLine As Integer, _
    iCol As Integer, _
    cLines As Integer, _
    <OutAttribute> ByRef ppEnum As IVsEnumBSTR _
) As Integer

int GetProximityExpressions(
    IVsTextBuffer pBuffer,
    int iLine,
    int iCol,
    int cLines,
    out IVsEnumBSTR ppEnum
)

int GetProximityExpressions(
    [InAttribute] IVsTextBuffer^ pBuffer, 
    [InAttribute] int iLine, 
    [InAttribute] int iCol, 
    [InAttribute] int cLines, 
    [OutAttribute] IVsEnumBSTR^% ppEnum
)

abstract GetProximityExpressions : 
        pBuffer:IVsTextBuffer * 
        iLine:int * 
        iCol:int * 
        cLines:int * 
        ppEnum:IVsEnumBSTR byref -> int

function GetProximityExpressions(
    pBuffer : IVsTextBuffer, 
    iLine : int, 
    iCol : int, 
    cLines : int, 
    ppEnum : IVsEnumBSTR
) : int

Parameters

pBuffer
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextBuffer

[in] The IVsTextBuffer interface for the text buffer containing the expression.

iLine
Type: System.Int32

[in] Number of the line containing the start of the expression.

iCol
Type: System.Int32

[in] Column position within the line.

cLines
Type: System.Int32

[in] Number of lines within the expression.

ppEnum
Type: Microsoft.VisualStudio.TextManager.Interop.IVsEnumBSTR%

[out] Returns an IVsEnumBSTR object that is used to enumerate BSTRs.

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 IVsLanguageDebugInfo::GetProximityExpressions(
   [in] IVsTextBuffer *pBuffer, 
   [in] long iLine, 
   [in] long iCol, 
   [in] long cLines, 
   [out] IVsEnumBSTR **ppEnum
);

This method is implemented by a language service to provide information needed to populate the Autos debugging window. When the debugger calls this method, the debugger is requesting the names of any parameters and variables in a span of lines beginning with the starting position identified by the iLine and iCol parameters in the specified text buffer. The extent of lines beyond this point is specified by the cLines parameter.

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

Share via