ISpLexicon::GetWords (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3


ISpLexicon::GetWords gets a list of all words in the lexicon.

   DWORD         dwFlags,
   DWORD        *pdwGeneration,
   DWORD        *pdwCookie,
   SPWORDLIST   *pWordList


[in] Bitwise flags of type SPLEXICONTYPE from which words are to be retrieved.
[out] The current generation ID of the custom lexicon.
[in, out] Cookie passed back by this call. It should subsequently be passed back in to get more data. If the call returns S_FALSE, data is remaining and GetWords should be called again. The initial value of the cookie passed in must be zero or pdwCookie will be a NULL pointer. NULL pdwCookie indicates the method should return all words contained in the lexicon at once. If it cannot, SP_LEX_REQUIRES_COOKIE is returned instead.
[in, out] The buffer containing the word list and its related information. If pWordList is successfully returned, CoTaskMemFree must be used to free the list (pWordList->pvBuffer) when no longer needed.

Return values

S_OKFunction completed successfully.
S_FALSEAdditional words are left in the lexicon(s) to process.
SPERR_LEX_REQUIRES_COOKIEA complete list of words cannot be returned at once from the container lexicon. pdwCookie must not be NULL.
E_POINTERAt least one of pdwGeneration, pdwCookie, pWordList is not valid. Alternatively, the block of memory is too small or is not writable.
E_INVALIDARGAt least one of the parameters is not valid.
E_OUTOFMEMORYExceeded available memory.
SPERR_UNINITIALIZEDInterface not initialized.
FAILED(hr)Appropriate error message.


This method is called repeatedly with the cookie (set to zero before the first time) until S_OK is returned. S_FALSE is returned indicating additional information is left. Optionally, the cookie pointer passed in may be NULL, which specifies the application wants all of the words at once. However, the lexicon is not required to support this and may return the error SP_LEX_REQUIRES_COOKIE. The SpLexicon object (container lexicon) requires a cookie currently.


The following is an example of using GetWords.

// Declare local identifiers:
HRESULT                      hr = S_OK;
CComPtr<ISpLexicon>          cpLexicon;
SPWORDLIST                   spwordlist;
SPWORDPRONUNCIATION          *pwordpron;
SPWORD                       *pword;
DWORD                        dwCookie = 0;
DWORD                        dwGeneration;

memset(pwordpronlist, 0, sizeof(pwordpronlist));

while (SUCCEEDED(hr = cpLexicon->GetWords(eLEXTYPE_USER | eLEXTYPE_APP, &dwGeneration;, &dwCookie;, &spwordlist;)))
   for (pword = spwordlist.pFirstWord;
      pword != NULL;
      pword = pword->pNextWord)
      for (pwordpron = pword->pFirstWordPronunciation;
         pwordpron != NULL;
         pwordpron = pwordpron->pNextWordPronunciation)
         // Do something with the SPWORDPRONUNCIATION structure's
         // members (for example, ePartOfSpeech and szPronunciation).

   if (SUCCEEDED (hr))
      // Nothing more to retrieve.


// Free all the buffers.