IVsTipWindow.GetContextStream Method

Article
08/01/2012

Returns the position of the text the ToolTip should not obscure and over which the cursor can be held before the ToolTip is closed.

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

Syntax

'Déclaration
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] Starting position of the context stream.

piLength
Type: System.Int32%
[out] Length of the context stream from the starting position (piPos).

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

The context stream is the position and length of text in the buffer that should not be obscured by the ToolTip window, but to which the content of the tip is related. This same region is also used to control how far the mouse cursor can be moved before the ToolTip window is dismissed or closed.

.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