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

Изменяет этот диапазон на указанную единицу истории.

Синтаксис

HRESULT SetIndex(
  [in] long Unit,
  [in] long Index,
  [in] long Extend
);

Параметры

[in] Unit

Тип: long

Единица измерения, используемая для индексирования диапазона. Список значений единиц см. в разделе ITextRange.

[in] Index

Тип: long

Индекс для единицы измерения. Этот диапазон перемещается в единицу с этим номером индекса. Если положительный результат, нумерация единицначинается в начале истории и продолжается. Если значение отрицательное, нумерирование начинается в конце истории и продолжается назад. Начало истории соответствует индексу 1 для всех существующих единиц, а последняя единица в истории соответствует индексу -1.

[in] Extend

Тип: long

Флаг, указывающий экстент диапазона. Если значение равно нулю (значение по умолчанию), диапазон сворачивается до точки вставки в начальной позиции указанной единицы измерения. Если значение не равно нулям, диапазону присваивается вся единица измерения.

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

Тип: HRESULT

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

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

Комментарии

Этот метод позволяет приложению удобно работать с текстом, ориентированным на строки, например с программами. Например, SetIndex(tomLine, 10, 0) преобразует диапазон в точку вставки в начале десятой строки.

Требования

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

См. также раздел

Основные понятия

ITextRange

Справочные материалы

Текстовая объектная модель