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

Извлекает индекс истории параметра Unit в указанной позиции начального символа диапазона. Первая единица в истории имеет значение индекса 1. Индекс единицы измерения одинаков для всех позиций символов, начиная с непосредственного предшествующего единице, до последнего символа в единице.

Синтаксис

HRESULT GetIndex(
  long Unit,
  long *pIndex
);

Параметры

Unit

Тип: long

Индексируется единица измерения. Список возможных значений unit см. в разделе ITextRange.

pIndex

Тип: long*

Значение индекса. Значение равно нулю, если unit не существует.

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

Тип: HRESULT

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

Комментарии

Метод ITextRange::GetIndex извлекает индекс истории слова, строки, предложения, абзаца и т. д. в начальном диапазоне. Единица измерения указывает, какой тип сущности индексировать, например слова (tomWord), строки (tomLine), предложения (tomSentence) или абзацы (tomParagraph). Например, ITextRange::GetIndex задает значение pIndex , равное номеру первой строки в диапазоне. Для диапазона в конце истории ITextRange::GetIndex возвращает количество единицв истории. Таким образом, вы можете получить количество слов, строк, объектов и т. д. в рассказе.

Значение индекса, возвращаемое методом ITextRange::GetIndex , недопустимо при последующем изменении текста. Таким образом, пользователи должны быть осторожны при использовании методов, возвращающих значения индекса, особенно если значения должны храниться в течение какого-либо времени. Это отличается от указателя на диапазон, который остается действительным при редактировании текста.

Требования

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

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

ITextRange

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

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