Метод ITextStoreAnchor::GetText (texttor.h)
Метод ITextStoreAnchor::GetText возвращает сведения о тексте в указанной позиции привязки. Этот метод возвращает видимый и скрытый текст и указывает, присоединены ли внедренные данные к тексту.
Синтаксис
HRESULT GetText(
[in] DWORD dwFlags,
[in] IAnchor *paStart,
[in] IAnchor *paEnd,
[out] WCHAR *pchText,
[in] ULONG cchReq,
[out] ULONG *pcch,
[in] BOOL fUpdateAnchor
);
Параметры
[in] dwFlags
Не используется; значение должно быть равно нулю.
[in] paStart
Указывает начальную позицию привязки.
[in] paEnd
Указывает конечную позицию привязки. Если значение РАВНО NULL, он обрабатывается как привязка, расположенная в самом конце текстового потока.
[out] pchText
Указывает буфер для получения текста. Может иметь значение NULL , только если cchReq = 0.
[in] cchReq
Задает размер буфера pchText в символах.
[out] pcch
Получает количество символов, скопированных в буфер pchText .
[in] fUpdateAnchor
Если задано значение TRUE, расположение paStart будет изменено только после последнего скопированного символа в pchText.
Возвращаемое значение
Этот метод может возвращать одно из этих значений.
| Значение | Описание |
|---|---|
|
Метод завершился успешно. |
|
Методу не удалось получить допустимый указатель интерфейса на paStart и (или) paEnd. |
|
Привязки paStart или paEnd находятся за пределами текста документа. |
|
Вызывающий объект не имеет блокировки только для чтения в документе. |
Комментарии
Вызывающие стороны, использующие этот метод, должны иметь блокировку только для чтения для документа путем вызова метода ITextStoreAnchor::RequestLock . Без блокировки только для чтения метод завершается сбоем и возвращает TF_E_NOLOCK.
Приложения могут усечь возвращаемые значения метода по внутренним причинам.
Чтобы быстро сканировать текст с помощью нескольких вызовов GetText , вызывающий объект будет использовать fUpdateAnchor = TRUE.
Фактическое число скопированных символов может быть меньше cchReq, если число символов между paStart и paEnd меньше cchReq.
На поведение GetText не влияют границы областей, на которые распространяется возвращаемый текст.
Требования
| Минимальная версия клиента | Windows 2000 Профессиональная [классические приложения | Приложения UWP] |
| Минимальная версия сервера | Windows 2000 Server [классические приложения | Приложения UWP] |
| Целевая платформа | Windows |
| Header | textstor.h |
| DLL | Msctf.dll |
| Распространяемые компоненты | TSF 1.0 в Windows 2000 Профессиональная |