IVsTextLines.CanReplaceLines(Int32, Int32, Int32, 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.

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

public:
 int CanReplaceLines(int iStartLine, int iStartIndex, int iEndLine, int iEndIndex, int iNewLen);

public:
 int CanReplaceLines(int iStartLine, int iStartIndex, int iEndLine, int iEndIndex, int iNewLen);

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

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

abstract member CanReplaceLines : int * int * int * int * int -> int

Public Function CanReplaceLines (iStartLine As Integer, iStartIndex As Integer, iEndLine As Integer, iEndIndex As Integer, iNewLen As Integer) As Integer

Parameters

iStartLine: Int32

[in] Starting line.

iStartIndex: Int32

[in] Starting character index within the line. Must be less than or equal to the length of the line.

iEndLine: Int32

[in] Ending line.

iEndIndex: Int32

[in] Ending character index within the line. Must be less than or equal to the length of the line.

iNewLen: Int32

[in] Length of the newly inserted text.

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

Applies to