IVsMethodData.GetContextStream(Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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 context stream for the tip.

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] Integer identifying the stream position in the text buffer.

piLength: Int32

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

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

Applies to