Метод ITextStoreAnchor::AdviseSink (texttor.h)

  • Статья

Метод ITextStoreAnchor::AdviseSink устанавливает новый приемник рекомендаций из интерфейса ITextStoreAnchorSink или изменяет существующий приемник рекомендаций.

Синтаксис

HRESULT AdviseSink(
  [in] REFIID   riid,
  [in] IUnknown *punk,
  [in] DWORD    dwMask
);

Параметры

[in] riid

Указывает интерфейс приемника. Единственное поддерживаемое значение — IID_ITextStoreAnchorSink.

[in] punk

Указатель на интерфейс приемника для рекомендаций. Не может иметь значение NULL.

[in] dwMask

Указывает события, уведомляющие приемник рекомендаций. Дополнительные сведения о возможных значениях параметров см. в разделе Константы TS_AS_*.

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

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

Значение Описание
S_OK
 Метод выполнен успешно.
E_FAIL
 Не удалось получить указанный riid интерфейса приемника.
E_INVALIDARG
 Указанный интерфейс приемника не поддерживается.
E_UNEXPECTED
 Не удалось получить указанный объект приемника.

Комментарии

Последующие вызовы с тем же интерфейсом, представленным параметром punk , обрабатываются как запросы на обновление параметра dwMask . Серверы не должны вызывать метод AddRef в приемнике в ответ на такой запрос.

Серверы поддерживают только одну точку подключения. Попытки рекомендовать второй объект приемника завершаются сбоем, пока исходный объект приемника не будет удален. Приложения должны использовать метод ITextStoreAnchor::UnadviseSink для отмены регистрации объекта приемника, если уведомления не требуются.

Требования

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

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

ITextStoreAnchor

ITextStoreAnchor::UnadviseSink

константы TS_AS_*