Microsoft Speech SDK
SAPI 5.1
ISpRecoGrammar::LoadDictation
ISpRecoGrammar::LoadDictation loads a dictation topic into the SpRecoGrammar object and the SR engine.
See also ISpSREngine::OnCreateGrammar.
HRESULT LoadDictation(
const WCHAR *pszTopicName,
SPLOADOPTIONS Options
);
Parameters
- pszTopicName
- [in, optional, string] The null-terminated string containing the topic name. If NULL, the general dictation is loaded. See Remarks section.
- Options
- [in] Flag of type SPLOADOPTIONS indicating whether the file should be loaded statically or dynamically. This value must be SPLO_STATIC.
Return values
| Value | Description |
|---|---|
| S_OK | Function completed successfully. |
| E_INVALIDARG | pszTopicName is invalid or bad. Alternatively, Options is not SPLO_STATIC. |
| FAILED(hr) | Appropriate error message. |
Remarks
SAPI currently defines one specialized dictation topic: SPTOPIC_SPELLING. SR engines are not required to support specialized dictation topic (including spelling).
See the SR engine vendor for information on what specialized dictation topics if any are supported.
Example
The following code snippet illustrates the use of ISpRecoGrammar::LoadDictation to load a spelling topic and activate it.
HRESULT hr = S_OK;
// create a grammar object
hr = cpRecoContext->CreateGrammar(GRAM_ID, &cpRecoGrammar);
// Check hr
// load the general dictation topic
hr = cpRecoGrammar->LoadDictation(NULL, SPLO_STATIC);
// Check hr
// activate the dictation topic to receive recognitions
hr = cpRecoGrammar->SetDictationState(SPRS_ACTIVE);
// check hr