IVsTextLines::GetLineText Method (Int32, Int32, Int32, Int32, String^)

Visual Studio 2015

Returns the specified span of text in a BSTR.

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

Syntax

C++

int GetLineText(
	int iStartLine,
	int iStartIndex,
	int iEndLine,
	int iEndIndex,
	[OutAttribute] String^% pbstrBuf
)

Parameters

iStartLine: Type: System::Int32
[in] Starting line.

iStartIndex: Type: System::Int32
[in] Starting character index within the line. This value must be less than or equal to the length of the line.

iEndLine: Type: System::Int32
[in] Ending line.

iEndIndex: Type: System::Int32
[in] Ending character index within the line. This value must be less than or equal to the length of the line.

pbstrBuf: Type: System::String^
[out] Text to insert, if any.

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 IVsTextLines::GetLineText(
   [in] long iStartLine,
   [in] CharIndex iStartIndex,
   [in] long iEndLine,
   [in] CharIndex iEndIndex,
   [out] BSTR * pbstrBuf
);

It is the caller's responsibility to free the BSTR.