ISpSREngine::LoadProprietaryGrammar

Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

ISpSREngine::LoadProprietaryGrammar

ISpSREngine::LoadProprietaryGrammar instructs the engine to load a grammar in an engine-specific format. This is used to load grammars that are not in the standard SAPI CFG format.

HRESULT LoadProprietaryGrammar(
   void          *pvEngineGrammar,
   REFGUID        rguidParam,
   const WCHAR   *pszStringParam,
   const void    *pvDataParam,
   ULONG          ulDataSize.
   SPLOADOPTIONS  Options
);

Parameters

pvEngineGrammar
[in] The engine's grammar pointer, as returned from the OnCreateGrammar method.
rguidParam
[in] Unique identifier for the grammar.
pszStringParam
[in, string] Null-terminated string containing proprietary grammar string data.
pvDataParam
[in] Pointer to grammar image data.
ulDataSize
[in] Size, in bytes, of the grammar image data.
Options
[in] One of the grammar loading options specified in the SPLOADOPTIONS enumeration sequence.

Return values

Value Description
S_OK Function completed successfully.
FAILED (hr) Appropriate error message.

Remarks

The application can supply the engine with either a GUID, string data, or binary data or some combination of these, in order to describe the grammar. SAPI does nothing with this data apart from correctly marshaling it to the SR engine.