ISpErrorLog::AddError
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 adds a compilation error message to the log file. It is called by ISpGrammarCompiler::CompileStream when an error occurs. This method is application-defined.
Syntax
HRESULT AddError(
const long lLineNumber,
HRESULT hr,
const WCHAR* pszDescription,
const WCHAR* pszHelpFile,
DWORD dwHelpContext
);
Parameters
- lLineNumber
[in] Line number of the compilation error message in the XML grammar file.
- hr
[in] Error code (type HRESULT) to log.
- pszDescription
[in] Pointer to a text description of the error message.
- pszHelpFile
[in] Pointer to the file to contain the log.
- dwHelpContext
[in] Flags providing additional information for the log.
Return Value
The following table shows the possible return values. Because this method is application-defined, the return values can change. See specific vendor documentation for details.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. |
FAILED(hr) |
Appropriate error message. |
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |