IVsTipWindow.GetContextStream(Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int GetContextStream([Runtime::InteropServices::Out] int % piPos, [Runtime::InteropServices::Out] int % piLength);

int GetContextStream([Runtime::InteropServices::Out] int & piPos, [Runtime::InteropServices::Out] int & piLength);

public int GetContextStream (out int piPos, out int piLength);

abstract member GetContextStream : int * int -> int

Public Function GetContextStream (ByRef piPos As Integer, ByRef piLength As Integer) As Integer

Parameters

piPos: Int32

[out] Starting position of the context stream.

piLength: Int32

[out] Length of the context stream from the starting position (piPos).

Returns

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.

Applies to

Compartilhar via