ISpGrammarCompiler::CompileStream
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method compiles the specified SAPI 5.0 text grammar stream and writes the output. It can optionally generate C/C++ header information from the XML <DEFINE> <ID> tags.
Syntax
HRESULT CompileStream(
IStream* pSource,
IStream* pDest,
IStream* pHeader,
IUnknown* pReserved,
ISpErrorLog* pErrorLog,
DWORD dwFlags
);
Parameters
- pSource
[in] Pointer to a stream object identifying the source of the XML grammar text.
- pDest
[in] Pointer to a stream object identifying the destination for the binary grammar.
- pHeader
[in] Pointer to a stream object identifying C/C++ header information to write. This information is taken from the <DEFINE> tags, to form header data, for example, #define myterm 3.
- pReserved
[in] Reserved. Do not use.
- pErrorLog
[in] Pointer to an object implementing ISpErrorLog that receives compilation error message information.
- dwFlags
[in] Not currently used. Must be zero.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
E_INVALIDARG |
One of the parameters is bad or invalid. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |