Метод IFilter::GetChunk (filter.h)

Статья
08/23/2023

Примечание

Служба индексирования больше не поддерживается в Windows XP и недоступна для использования в Windows 8. Вместо этого используйте Windows Search для поиска на стороне клиента и Microsoft Search Server Express для поиска на стороне сервера.

Помещает фильтр в начало следующего блока или в первый блок, если это первый вызов метода GetChunk , и возвращает описание текущего блока.

Синтаксис

SCODE GetChunk(
  [out] STAT_CHUNK *pStat
);

Параметры

[out] pStat

Указатель на структуру STAT_CHUNK , содержащую описание текущего блока.

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

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

Код возврата	Описание
S_OK	Операция была успешно завершена.
FILTER_E_END_OF_CHUNKS	Предыдущий фрагмент является последним.
FILTER_E_EMBEDDING_UNAVAILABLE	Следующий блок — это внедрение, и фильтр содержимого недоступен.
FILTER_E_LINK_UNAVAILABLE	Следующий блок — это ссылка, и фильтр содержимого недоступен.
FILTER_E_PASSWORD	Пароль или другой сбой доступа, связанный с безопасностью.
FILTER_E_ACCESS	Общий сбой доступа.

Если при возврате pStat указывает на структуру STAT_CHUNK с элементом breakType , равным CHUNK_NO_BREAK, новое значение идентификатора блока (ID) будет обновлено только для элемента idChunk . Остальные элементы структуры STAT_CHUNK остаются неизменными.

Внутренние свойства типа значений (блоки со значением перечисления CHUNKSTATE CHUNK_VALUE) не могут быть сцеплены с помощью CHUNK_NO_BREAK. Одно слово не может охватывать более двух склеенных блоков.

Недопустим ноль идентификатора блока.

Перед первым вызовом метода GetChunk текущий фрагмент отсутствует. После ошибки возвращает код, отличный от FILTER_E_END_OF_CHUNKS следующий вызов метода GetChunk , тем не менее, извлекает следующий блок после недоступного.

Примечания к вызывающим абонентам

После завершения работы метода GetChunk фрагмент, описанный в разделе *pStat , является текущим фрагментом. Дескриптор блока принадлежит подпрограмме, вызывающей метод GetChunk , но указатель имени свойства, который можно задать в спецификации свойства, принадлежит методу GetChunk и не должен освобождаться.

Примечания для разработчиков

Если вызов метода GetChunk фильтра содержимого связанного или внедренного объекта возвращает FILTER_E_END_OF_CHUNKS, реализация должна вернуть следующий блок объекта связывания или внедрения. Например, если документ содержит два внедренных объекта и первый вернул FILTER_E_END_OF_CHUNKS, то фильтр внешнего содержимого должен вызвать метод GetChunk фильтра содержимого для внедренного объекта.

Прежде чем возвращать результаты вызова метода GetChunk для внедренного или связанного объекта, проверка, чтобы убедиться, что идентификатор блока уникален. В противном случае разработчик должен изменить нумерацию блока и сохранить сопоставление нового идентификатора блока.

Требования


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	filter.h

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

Ifilter

STAT_CHUNK

Поделиться через