ISpShortcut::GetGenerationChange (Microsoft Speech Platform)

Microsoft Speech Platform SDK 11

Microsoft Speech Platform

ISpShortcut::GetGenerationChange

ISpShortcut::GetGenerationChange gets the list of changes that have happened in a user shortcut since a specific generation.

HRESULT GetGenerationChange(
   DWORD         dwFlags,
   DWORD        *pdwGeneration,
   SPWORDLIST   *pWordList
);

Parameters

dwFlags
[in] A bitfield of SPLEXICONTYPE. It only takes the value of eLEXTYPE_USER_SHORTCUT.
pdwGeneration
[in, out] Used to pass in the generation ID. Changes that occurred between this generation and the current generation will be returned. Upon return, pdwGeneration will contain the current generation ID.
pWordList
[in, out] The linked list of shortcut pairs that are new since the specified generation.

Return values

Value Description
S_OK Function completed successfully.
SP_LEX_NOTHING_TO_SYNC Nothing changed since the passed in generation ID.
SPERR_LEX_VERY_OUT_OF_SYNC There are too many changes since the passed in generation ID, so that a change history is not available. It could also be returned after installation/uninstallation of an application lexicon. Use ISpLexicon::GetWords if GetGenerationChange returns SPERR_LEX_VERY_OUT_OF_SYNC to regenerate an entire list of words based on the current generation.
E_POINTER pdwGeneration or pWordList is not a valid write pointer.
E_INVALIDARG dwFlags is invalid.
SPERR_UNINITIALIZED Interface has not been initialized.
E_OUTOFMEMORY Exceeded available memory.
FAILED(hr) Appropriate error message.