ITextRange::GetEnd method (tom.h)

Article
02/22/2024

Gets the end character position of the range.

Syntax

HRESULT GetEnd(
  long *pcpLim
);

Parameters

pcpLim

Type: long*

The end character position.

Return value

Type: HRESULT

The method returns an HRESULT value. If the method succeeds, it returns S_OK. If pcpLim is null, the method fails and it returns E_INVALIDARG.

Remarks

Although a pointer to a range remains valid when the text is edited, this is not the case for the character position. A character position is volatile; that is, it becomes invalid as soon as text is inserted or deleted before the character position. Be careful about using methods that return character position values, especially if the values are to be stored for any duration.

This method is similar to the ITextRange::GetStart method which gets the start character position of the range.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll