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

Метод IAnchor::Shift (textstor.h)

  • Статья

Метод IAnchor::Shift сдвигает привязку вперед или назад в текстовом потоке.

Синтаксис

HRESULT Shift(
  [in]  DWORD   dwFlags,
  [in]  LONG    cchReq,
  [out] LONG    *pcch,
  [in]  IAnchor *paHaltAnchor
);

Параметры

[in] dwFlags

Битовые поля, используемые для предотвращения размещения привязки.

Значение Значение
TS_SHIFT_COUNT_ONLY
 Привязка не смещена. Если флаг не задан (dwFlags = 0), привязка будет смещена в соответствии с другими параметрами параметров.

[in] cchReq

Количество символов для перемещения привязки в текстовом потоке.

[out] pcch

Фактическое количество символов, перемещаемых в текстовом потоке. В случае сбоя метод установит значение pcch равным нулю.

[in] paHaltAnchor

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

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

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

Значение Описание
S_OK
 Метод выполнен успешно.
E_FAIL
 Сбой смены.
E_INVALIDARG
 Недопустимое значение входного параметра.
E_NOTIMPL
 Значение параметра dwFlags не реализовано в этом методе.

Комментарии

Параметры cchReq и pcch могут быть отрицательными, т. е. сдвиг назад в текстовом потоке, или положительными, т. е. сдвиг вперед. Фактическое число смещенных символов может быть меньше cchReq , если обнаруживается начало или конец документа, обнаружена граница области или если paHaltAnchor получает привязку, которая блокирует сдвиг.

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

Например, если привязка, на которую ссылается paHaltAnchor , находится на 8 символов перед привязкой в потоке, а клиент вызывает shift (0, 10, pcch, paHaltAnchor), то при выходе привязка переместится только на 8 символов. Если привязка, на которую ссылается paHaltAnchor , равна текущей перемещаемой привязке, то shift будет успешно возвращена без перемещения привязки вообще. В этом случае pcch будет иметь значение 0.

Сдвиг привязки всегда блокируется границами области, как если бы были обнаружены начало или конец документа. Это будет указано на выходе фактическим числом сдвига pcch меньше в абсолютном значении, чем запрошенный shift cchReq. В этом случае клиенты могут использовать IAnchor::ShiftRegion для перемещения привязки в смежную область.

Требования

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

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

IAnchor

IAnchor::ShiftRegion