IVsMethodData.GetContextStream Method

Returns the context stream for the tip.

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

Syntax

'Declaration
Function GetContextStream ( _
    <OutAttribute> ByRef piPos As Integer, _
    <OutAttribute> ByRef piLength As Integer _
) As Integer
int GetContextStream(
    out int piPos,
    out int piLength
)
int GetContextStream(
    [OutAttribute] int% piPos, 
    [OutAttribute] int% piLength
)
abstract GetContextStream : 
        piPos:int byref * 
        piLength:int byref -> int
function GetContextStream(
    piPos : int, 
    piLength : int
) : int

Parameters

  • piPos
    Type: System.Int32%

    [out] Integer identifying the stream position in the text buffer.

  • piLength
    Type: System.Int32%

    [out] Integer identifying the length of text in the stream past piPos that should not be obscured with the method tip window.

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 IVsMethodData::GetContextStream(
   [out] long *piPos, 
   [out] long *piLength
);

The context stream is the position and length of the text in the buffer that should not be obscured by the tip window, but to which the content of the tip is applied. Use this method to specify the context stream. If you do not implement this method, then the view determines where to place the method tip window.

.NET Framework Security

See Also

Reference

IVsMethodData Interface

Microsoft.VisualStudio.TextManager.Interop Namespace