ITfPreservedKeyNotifySink::OnUpdated method

Syntax

HRESULT OnUpdated(
  [in] const TF_PRESERVEDKEY *pprekey
);

Parameters

pprekey [in]

Pointer to a TF_PRESERVEDKEY structure that contains data about the key.

Return value

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

Remarks

To determine if the key is unpreserved, call ITfKeystrokeMgr::IsPreservedKey, passing pprekey. If the key is not found, it is unpreserved. If the key is found, it is either preserved or the description has changed. Unless you keep track of the current key description and compare the previous description with the current description in response to this notification, there is no way to determine if this notification is in response to a key preserved or the description changed.

Requirements

See also

ITfPreservedKeyNotifySink

ITfKeystrokeMgr::PreserveKey

ITfKeystrokeMgr::SetPreservedKeyDescription

ITfKeystrokeMgr::UnpreserveKey

TF_PRESERVEDKEY