Метод ITextRange::EndOf (tom.h)

Статья
03/03/2024

Перемещает концы этого диапазона в конец последней перекрывающейся единицы в диапазоне.

Синтаксис

HRESULT EndOf(
  long Unit,
  long Extend,
  long *pDelta
);

Параметры

Unit

Тип: long

Используемая единица измерения. Значение по умолчанию: tomWord. Список других значений unit см. в обсуждении в разделе ITextRange.

Extend

Тип: long

Индикатор того, как будет продолжаться сдвиг диапазона. Это может быть один из следующих вариантов.

0 или tomMove	Сворачивает неразрожденный диапазон до конца исходного диапазона путем перемещения точки вставки. Это значение по умолчанию.
1 (или tomExtend)	Перемещает конец в конец перекрывающегося блока. Не перемещает пуск.

pDelta

Тип: long*

Число символов, за которыми перемещен конец. Значение указателя может иметь значение NULL. При возврате значение pDelta — это количество символов, в которых перемещается точка вставки или конец плюс 1, если происходит сворачивание элемента End. Если диапазон включает окончательный cr (возврат каретки) (в конце истории) и Extend = tomMove, то pDelta имеет значение –1, чтобы указать, что сворачивание произошло до конца диапазона (так как точка вставки не может существовать за пределами конечного CR).

Возвращаемое значение

Тип: HRESULT

Метод возвращает значение HRESULT . Если метод завершается успешно, он возвращает S_OK. Если метод завершается ошибкой, он возвращает один из следующих кодов ошибок. Дополнительные сведения о кодах ошибок COM см. в разделе Обработка ошибок в COM.

Код возврата	Описание
E_NOTIMPL	Единица измерения не поддерживается.
S_FALSE	Сбой по какой-либо другой причине.

Для сравнения метод ITextRange::StartOf перемещает конец диапазона в начало первой перекрывающейся единицы измерения в диапазоне. Обратите внимание, что методы ITextRange::StartOf и ITextRange::EndOf отличаются от методов HomeKey и EndKey тем, что последние расширяются от активного конца, в то время как ITextRange::StartOf расширяется с Start, а ITextRange::EndOf расширяется с End. Если диапазон является точкой вставки на границе между единицами, ITextRange::EndOf не изменяет End. В частности, вызов метода ITextRange::EndOf (tomCharacter, *, *) не изменяет значение End, за исключением точки вставки в начале истории.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	tom.h
DLL	Msftedit.dll