Метод ITextStoreACP::GetText (texttor.h)

Статья
08/26/2023

Метод ITextStoreACP::GetText возвращает сведения о тексте в указанной позиции символа. Этот метод возвращает видимый и скрытый текст и указывает, присоединены ли внедренные данные к тексту.

Синтаксис

HRESULT GetText(
  [in]  LONG       acpStart,
  [in]  LONG       acpEnd,
  [out] WCHAR      *pchPlain,
  [in]  ULONG      cchPlainReq,
  [out] ULONG      *pcchPlainRet,
  [out] TS_RUNINFO *prgRunInfo,
  [in]  ULONG      cRunInfoReq,
  [out] ULONG      *pcRunInfoRet,
  [out] LONG       *pacpNext
);

Параметры

[in] acpStart

Задает начальную позицию символа.

[in] acpEnd

Указывает конечную позицию символа. Если этот параметр равен -1, возвращается весь текст в текстовом хранилище.

[out] pchPlain

Указывает буфер для получения данных обычного текста. Если этот параметр имеет значение NULL, параметр cchPlainReq должен иметь значение 0.

[in] cchPlainReq

Указывает количество символов обычного текста, передаваемых методу .

[out] pcchPlainRet

Получает количество символов, скопированных в буфер обычного текста. Этот параметр не может иметь значение NULL. Используйте параметр , если значения не требуются.

[out] prgRunInfo

Получает массив TS_RUNINFO структур. Может иметь значение NULL , только если cRunInfoReq = 0.

[in] cRunInfoReq

Указывает размер буфера выполнения текста (в символах).

[out] pcRunInfoRet

Получает количество TS_RUNINFO структур, записанных в буфер выполнения текста. Этот параметр не может иметь значение NULL.

[out] pacpNext

Получает позицию следующего непрочитанных символов. Не может иметь значение NULL.

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

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

Значение	Описание
S_OK	Метод выполнен успешно.
TF_E_INVALIDPOS	Параметры acpStart или acpEnd находятся за пределами текста документа.
TF_E_NOLOCK	Вызывающий объект не имеет блокировки только для чтения в документе.

Вызывающие устройства, использующие этот метод, должны иметь блокировку только для чтения для документа путем вызова метода ITextStoreACP::RequestLock . Без блокировки только для чтения метод завершается сбоем и возвращает TF_E_NOLOCK.

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

Вызывающий объект может запрашивать только обычный текст, задав для параметра cRunInfoReq значение 0, а для параметра prgRunInfo — значение NULL. Вызывающий объект может запрашивать только данные выполнения текста, задав для параметра cchPlainReq значение 0, а для параметра pchPlain — значение NULL. Однако вызывающий объект по-прежнему должен предоставлять допустимые значения, отличные от NULL , для pcchPlainRet, даже если этот параметр не используется.

Если acpEnd имеет значение -1, то он должен обрабатываться так, как если бы он был задан в конце потока. В противном случае он будет больше или равен нулю.

При выходе для параметра pacpNext должно быть задано положение символа следующего символа в потоке, на который не ссылаются возвращаемые значения. Вызывающий объект будет использовать его для быстрого сканирования текста с помощью нескольких вызовов ITextStoreACP::GetText.

Требования

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

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

ITextStoreACP

ITextStoreACP::RequestLock

Возвращаемые значения диспетчером

TS_RUNINFO

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