IVsTextView.GetTextStream Method

Article
03/11/2013

Returns a specified stream of text in a string.

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

Syntax

'Declaration
Function GetTextStream ( _
    iTopLine As Integer, _
    iTopCol As Integer, _
    iBottomLine As Integer, _
    iBottomCol As Integer, _
    <OutAttribute> ByRef pbstrText As String _
) As Integer

int GetTextStream(
    int iTopLine,
    int iTopCol,
    int iBottomLine,
    int iBottomCol,
    out string pbstrText
)

int GetTextStream(
    [InAttribute] int iTopLine, 
    [InAttribute] int iTopCol, 
    [InAttribute] int iBottomLine, 
    [InAttribute] int iBottomCol, 
    [OutAttribute] String^% pbstrText
)

abstract GetTextStream : 
        iTopLine:int * 
        iTopCol:int * 
        iBottomLine:int * 
        iBottomCol:int * 
        pbstrText:string byref -> int

function GetTextStream(
    iTopLine : int, 
    iTopCol : int, 
    iBottomLine : int, 
    iBottomCol : int, 
    pbstrText : String
) : int

Parameters

iTopLine
Type: System.Int32
[in] Top line index defining the text stream.

iTopCol
Type: System.Int32
[in]Top line column defining the text stream. Viewcol coordinates may include virtual space.

iBottomLine
Type: System.Int32
[in] Bottom line index defining the text stream.

iBottomCol
Type: System.Int32
[in] Bottom line column defining the text stream. Viewcol coordinates may include virtual space.

pbstrText
Type: System.String%
[out] Pointer to a string containing the text.

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 IVsTextView::GetTextStream(
   [in] long iTopLine,
   [in] ViewCol iTopCol,
   [in] long iBottomLine,
   [in] ViewCol iBottomCol,
   [out] BSTR * pbstrText
);

.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