ISRResBasic::PhraseGet

HRESULT PhraseGet(DWORD dwRank, PSRPHRASE pSRPhrase,

DWORD dwPhraseSize, DWORD *pdwPhraseNeeded);

Retrieves the specified phrase from the list of most likely phrases provided by the speech-recognition engine for a recognition. The phrases are specific to the grammar and do not show alternatives for other grammars.

· Returns NOERROR if successful, or one of these error values:

E_INVALIDARG
E_OUTOFMEMORY
SRERR_NOTENOUGHDATA
SRERR_VALUEOUTOFRANGE

dwRank

[in] Value that specifies the alternative phrase to get from the alternatives provided by the engine, starting with dwRank = 0 for the strongest alternative. If dwRank is greater than the number of alternatives, PhraseGet returns an error.

pSRPhrase

[out] Address of an SRPHRASE structure to receive the phrase.

dwPhraseSize

[in] Number of bytes available in the structure specified by pSRPhrase. If the number is too small, PhraseGet returns SRERR_NOTENOUGHDATA and fills in pdwPhraseNeeded with the number of bytes needed.

pdwPhraseNeeded

[out] Address of a variable that receives the number of bytes needed for the phrase data.