ISpShortcut::GetGenerationChange (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3


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


[in] A bitfield of SPLEXICONTYPE. It only takes the value of eLEXTYPE_USER_SHORTCUT.
[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.
[in, out] The linked list of shortcut pairs that are new since the specified generation.

Return values

S_OKFunction completed successfully.
SP_LEX_NOTHING_TO_SYNCNothing changed since the passed in generation ID.
SPERR_LEX_VERY_OUT_OF_SYNCThere 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_POINTERpdwGeneration or pWordList is not a valid write pointer.
E_INVALIDARGdwFlags is invalid.
SPERR_UNINITIALIZEDInterface has not been initialized.
E_OUTOFMEMORYExceeded available memory.
FAILED(hr)Appropriate error message.