IVsTipWindow::GetContextStream Method (Int32, Int32)

Visual Studio 2015

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

C++

int GetContextStream(
	[OutAttribute] int% piPos,
	[OutAttribute] int% piLength
)

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:

C++

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.