Метод ITfReadOnlyProperty::EnumRanges (msctf.h)

Статья
08/24/2023

Получает перечисление диапазонов, содержащих уникальные значения свойства в заданном диапазоне.

Синтаксис

HRESULT EnumRanges(
  [in]  TfEditCookie  ec,
  [out] IEnumTfRanges **ppEnum,
  [in]  ITfRange      *pTargetRange
);

Параметры

[in] ec

Содержит файл cookie редактирования, определяющий контекст редактирования. Он получен из ITfDocumentMgr::CreateContext или ITfEditSession::D oEditSession.

[out] ppEnum

Указатель на указатель интерфейса IEnumTfRanges , который получает объект перечислителя. Вызывающий объект должен освободить этот объект, когда он больше не требуется.

[in] pTargetRange

Указатель на интерфейс ITfRange , указывающий диапазон для сканирования на наличие уникальных значений свойств. Этот параметр является необязательным и может иметь значение NULL. Дополнительные сведения см. в разделе «Примечания».

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

Этот метод может возвращать одно из этих значений.

Значение	Описание
S_OK	Метод выполнен успешно.
E_INVALIDARG	Один или несколько параметров недопустимы.
E_OUTOFMEMORY	Произошел сбой выделения памяти.
E_FAIL	Произошла неизвестная ошибка. Примечание Если приложение не реализует ITextStoreACP::FindNextAttrTransition, ITfReadOnlyProperty::EnumRanges завершается сбоем с E_FAIL.
TF_E_NOLOCK	Контекст редактирования, определенный ec , не имеет блокировки только для чтения или чтения и записи.

Перечислитель, полученный этим методом, будет содержать диапазон для каждого уникального значения, включая пустые значения, указанного свойства. Например, гипотетическое свойство цвета можно применить к следующему тексту, помеченном вверх:


COLOR:      RR      GGGGGGGG
TEXT:  this is some colored text

При вызове ITfReadOnlyProperty::EnumRanges с параметром pTargetRange, равным этому диапазону, перечислитель будет содержать пять диапазонов.

Индекс диапазона	Значение свойства Color	Текст диапазона
0	<empty>	"this"
1	R	"is"
2	<empty>	" some "
3	G	"colored"
4	<empty>	"text"

Если pTargetRange имеет значение NULL, перечислитель начинается и заканчивается первым и последним диапазоном, содержащим непустое значение свойства в контексте. Указание NULL для pTargetRange в приведенном выше примере приведет к созданию перечислителя с тремя диапазонами.

Индекс диапазона	Значение свойства Color	Текст в диапазоне
0	R	"is"
1	<empty>	" some "
2	G	"colored"

Перечисленные диапазоны начинаются и заканчиваются начальными и конечными привязками pTargetRange, даже если любая из привязок находится в середине свойства .

Требования


Минимальная версия клиента	Windows 2000 Профессиональная [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows 2000 Server [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	msctf.h
DLL	Msctf.dll
Распространяемые компоненты	TSF 1.0 в Windows 2000 Professional