LogMessage (Industry 8.1)
7/8/2014
Review the use, syntax, parameters, and return values of the LogMessage method of the IObjectFilterEx API in Windows Embedded 8.1 Industry (Industry 8.1).
This method logs a Dialog Filter message to the Windows Event Log.
Syntax
HRESULT LogMessage(
[in] MessageType type,
IObjectInfo* pObjectInfo,
[in] BSTR szData
);
Parameters
type
[in] An enumeration representing the type of message to log. Enumeration values include the following:Value
Description
lmWarning = 1
Logs a warning under Admin.
lmError = 2
Logs an error message under Admin.
lmHideWindow = 3
Logs a message under Operational with information about a window that was obscured.
lmIgnoreWindow = 4
Logs a message under Operational about a window that was ignored.
lmActionPerformed = 5
Logs a message under Operational with information on the window and action performed.
Note
Warnings and errors can be called from the Dialog Filter service or implementation. ImHideWindow, ImIgnoreWindow, and ImActionPerformed are called only from custom filters that need to define instructions (as text) on how to manage the window. The default filter generates XML to be added to the configuration in the szData field. Custom filters can specify whatever is appropriate.
- pObjectInfo
A pointer to an instance of the IObjectInfo interface.
- szData
[in] Specifies instructions in XML format to add to a configuration file.
Return Value
Returns the following:
Return value |
Description |
|---|---|
ERROR_SUCCESS |
The operation completed successfully. |
ERROR_INVALID_PARAMETER |
A parameter is NULL or of the wrong type. |
Remarks
Implementations can implement logging using any method or use the default logging, which is sent to the Windows Event Log (under Applications and Services\Microsoft\Windows\DialogFilter).