IVsTextLines::CanReplaceLines Method (Int32, Int32, Int32, Int32, Int32)

Visual Studio 2015

Tests whether a given editing operation such as copy or cut can succeed.

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

Syntax

C++

int CanReplaceLines(
	int iStartLine,
	int iStartIndex,
	int iEndLine,
	int iEndIndex,
	int iNewLen
)

Parameters

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

iStartIndex: Type: System::Int32
[in] Starting character index within the line. 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. Must be less than or equal to the length of the line.

iNewLen: Type: System::Int32
[in] Length of the newly inserted 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:

C++

HRESULT IVsTextLines::CanReplaceLines(
   [in] long iStartLine,
   [in] CharIndex iStartIndex,
   [in] long iEndLine,
   [in] CharIndex iEndIndex,
   [in] long iNewLen
);

In the text buffer, every change is modeled as a replace operation, regardless of whether text is inserted, replaced, or deleted within the line. As such, this method contains a starting index position and an ending index position, although in an insert operation these points would be the same.

This method is used to test whether editing operations such as cut or copy can succeed. Potential causes for failure include attempting to replace text in a read-only buffer (that is, the file is under source control), or attempting to replace text in a read-only region within the buffer.