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

Примечание

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

Извлекает текст (свойства текстового типа) из текущего блока, который должен иметь значение перечисления CHUNKSTATE CHUNK_TEXT.

Синтаксис

SCODE GetText(
  [in, out] ULONG *pcwcBuffer,
  [out]     WCHAR *awcBuffer
);

Параметры

[in, out] pcwcBuffer

При вводе — размер массива awcBuffer в расширенных символах или символах Юникода. При выходе — количество символов Юникода, записанных в awcBuffer.

[out] awcBuffer

Текст, полученный из текущего блока. Не завершайте буфер символом. Используйте строку, завершаемую null. Строка, завершающаяся значением NULL, не должна превышать размер буфера назначения.

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

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

Код возврата Описание
S_OK
Операция успешно завершена.
FILTER_E_NO_TEXT
Элемент flags структуры STAT_CHUNK для текущего блока не имеет значения CHUNK_TEXT.
FILTER_E_NO_MORE_TEXT
Возвращен весь текст в текущем фрагменте. Дополнительные вызовы метода GetText должны возвращать эту ошибку до успешного вызова метода IFilter::GetChunk .
FILTER_S_LAST_TEXT
В качестве оптимизации последний вызов, возвращающий текст, может возвращать FILTER_S_LAST_TEXT, указывая, что следующий вызов метода GetText вернет FILTER_E_NO_MORE_TEXT. Эта оптимизация позволяет сэкономить время, устраняя ненужные вызовы GetText.

Комментарии

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

Требования

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

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

CHUNKSTATE

Ifilter