ISpellChecker::add_SpellCheckerChanged method (spellcheck.h)

Adds an event handler (ISpellCheckerChangedEventHandler) for the SpellCheckerChanged event.

Syntax

HRESULT add_SpellCheckerChanged(
  [in]          ISpellCheckerChangedEventHandler *handler,
  [out, retval] DWORD                            *eventCookie
);

Parameters

[in] handler

The handler to invoke when the spell checker changes.

[out, retval] eventCookie

An event cookie that uniquely identifies the added handler. This cookie must be passed to remove_SpellCheckerChanged to stop this handler from being invoked by spell checker changes.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The SpellCheckerChanged event fires whenever the state of the spell checker changes in a way such that any text that has been checked should be rechecked. This should happen when the contents of a word list changes, when an option changes, or when the default spell checker changes.

Requirements

See also

ISpellChecker

ISpellCheckerChangedEventHandler

remove_SpellCheckerChanged