您所在位置：主题：在VC++程序中自定义Vista事件日志
逍肖11
[专家分：50] 发布于 2008-01-14 10:54:00
在VC++程序中自定义Vista事件日志
就Windows开发者及系统管理员来说，Windows Vista日志相比以前，无疑有了一个很大的提高。对开发者来说，Vista的日志记录对多种事件与日志选项，都表现出统一一致性；而对网络管理员及IT专家，它提供了丰富的人机界面用于管理事件。新的日志记录方式，也只能通过Windows SDK中新的本机函数来实现，下面就来看看怎样在程序中实现新的记录方式。
创建并编译清单文件
如果程序中使用了新的API，且要把事件记录到日志中，就需要创建一个清单文件（这里补充一点，如果未使用新的API，或仅是使用托管程序，日志记录还是继续使用原来的ReportEvent* API）。清单文件是程序中所有事件基于XML格式的表现形式，我们可使用命令行的消息编译器（MC.exe），利用清单文件来生成一个头文件（*.h）及一个资源文件（*.rc）——仅限于用在C++工程中。（有关事件日志清单文件的详细说明，请查阅MSDN联机文档，在本文中只提及了其中的一小部分。）
在清单文件中，最重要的元素就是指明了哪个“通道”（channel）可以被写入，“通道”是Vista事件日志中一个新的概念，它根据接收者及卷，为事件提供了单独的输出。示例程序中使用了两个通道：操作性（Operational）通道及调试（Debug）通道，以下的XML指定了程序将使用这两种通道来引发事件：
<channels>
<importChannel chid="C1" name="Application"/>
<channel chid="MyOpChannel"
name="DotNetPerformance-TechalWriting-EventLogSample/ Operational"
type="Operational"
symbol="DOTNETPERFORMANCE"
isolation="Application" enabled="true"/>
<channel chid="MyDebugChannel"
name="DotNetPerformance-TechalWriting-EventLogSample/ Debug"
type="Debug"
symbol="DOTNETPERFORMANCE"
isolation="Application"
enabled="true"/>
在定义好通道之后，下一步就是定义一个模板以指定要引发事件的基本形态。与原来的事件日志API类似，Vista事件日志也支持使用%1这样的通配符，以便可替换为本地化语言的文本，这样，消息文本的所有内容都可在运行时才提供：
<template tid="SimpleEvent" message="$(string.SimpleMessage)">
<data name="Message" inType="win:UnicodeString"/>
<UserData>
<SimpleEvent xmlns="http://manifests.microsoft.com/win/2004/ 08/windows/simpleevent">
<ExceptionMessage>%1</ExceptionMessage>
</SimpleEvent>
</UserData>
</template>
最后，还需要把应用程序实际将引发的事件添加到清单文件中，为简单起见，对每个通道只定义了一个事件，且都使用同一个模板：
<event value="1"
level="win:Informational"
template="SimpleEvent"
opcode="win:Info"
channel="MyOpChannel"
symbol=" DNP_OP_EVENT"
message="$(string.SimpleMessage)"/>
<event value="2"
level="win:Informational"
template="SimpleEvent"
opcode="win:Info"
channel="MyDebugChannel"
symbol=" DNP_DEBUG_EVENT"
message="$(string.SimpleMessage)"/>
现在，消息编译器（mc.exe）就可以把这个清单文件编译为头文件及资源文件了。
引发事件
实际上，在程序中引发事件是相当地简单（至少与定义清单文件相比是这样的），正如前面所提到的，消息编译器生成了包含有事件及事件发布者定义的头文件，这些信息都可传递给SDK函数，对上面的清单文件而言，头文件将会包含以下定义：
EXTERN_C __declspec(selectany) const
GUID DOTNETPERFORMANCE_TECHNICALWRITING_PUBLISHER = {
0x9cde86c9, 0xdfb9, 0x463f, {0xb2, 0xc5,0x71,0xee,0xc2,0x32, 0xa6,0x9c}};
#define DOTNETPERFORMANCEOP 0x10
#define DOTNETPERFORMANCEDEBUG 0x0
EXTERN_C __declspec(selectany) const EVENT_DESCRIPTOR OP_EVENT = {
0x1, 0x0, 0x10, 0x4, 0x0, 0x0, 0x8000000000000000};
#define DNP_OP_EVENT_value 0x1
EXTERN_C __declspec(selectany) const EVENT_DESCRIPTOR DEBUG_EVENT =
{0x2, 0x0, 0x0, 0x4, 0x0, 0x0, 0x4000000000000000};
#define DNP_DEBUG_EVENT_value 0x2 #define MSG_SimpleMessage 0xB0000001L
接下来，要在代码中包含以下头文件：windows.h（如果为控制台程序）、evntprov.h（其包含了所有的Windows事件跟踪）、winevt.h（其包含了所有新的Vista日志声明）；另外，可通过调用EventRegister来注册事件发布者：
REGHANDLE hPub = NULL;
EventRegister(
&DOTNETPERFORMANCE_TECHNICALWRITING_PUBLISHER, NULL, NULL, &hPub);
实际上，引发一个事件非常之简单：创建一个事件描述符并把它传递给EventWrite函数就可以了：
EVENT_DATA_DESCRIPTOR opEventDesc;
PWSTR pwsOp = L"My Operational Event";
EventDataDescCreate(&opEventDesc, pwsOp,
((ULONG)wcslen(pwsOp)+1)*sizeof(WCHAR));
EventWrite(hPub, &DNP_OP_EVENT, 1, &opEventDesc);
代码中的宏EventDataDescCreate定义在头文件evntprov.h中，它只是提供了一种更短的语法用于设置变量EVENT_DATA_DESCRIPTOR的成员。
如果不再需要为特定发布者写入事件，可取消注册：
EventUnregister(hPub)
部署及使用
在部署程序之前，还需要使用以下命令来注册清单文件：
wevtutil install-manifest 清单文件名.xml
Windows Vista自带的wevtutil工具，将会解析清单文件并添加所需的设置到Vista日志记录中；如果未运行wevtutil，事件仍可被成功引发，但在事件日志中将不可见。
如果一切正常，事件就会如期出现在日志记录中，如下图。
更多在； www.evget.com
[em20]
就Windows开发者及系统管理员来说，Windows Vista日志相比以前，无疑有了一个很大的提高。对开发者来说，Vista的日志记录对多种事件与日志选项，都表现出统一一致性；而对网络管理员及IT专家，它提供了丰富的人机界面用于管理事件。新的日志记录方式，也只能通过Windows SDK中新的本机函数来实现，下面就来看看怎样在程序中实现新的记录方式。
创建并编译清单文件
如果程序中使用了新的API，且要把事件记录到日志中，就需要创建一个清单文件（这里补充一点，如果未使用新的API，或仅是使用托管程序，日志记录还是继续使用原来的ReportEvent* API）。清单文件是程序中所有事件基于XML格式的表现形式，我们可使用命令行的消息编译器（MC.exe），利用清单文件来生成一个头文件（*.h）及一个资源文件（*.rc）——仅限于用在C++工程中。（有关事件日志清单文件的详细说明，请查阅MSDN联机文档，在本文中只提及了其中的一小部分。）
在清单文件中，最重要的元素就是指明了哪个“通道”（channel）可以被写入，“通道”是Vista事件日志中一个新的概念，它根据接收者及卷，为事件提供了单独的输出。示例程序中使用了两个通道：操作性（Operational）通道及调试（Debug）通道，以下的XML指定了程序将使用这两种通道来引发事件：
<channels>
<importChannel chid="C1" name="Application"/>
<channel chid="MyOpChannel"
name="DotNetPerformance-TechalWriting-EventLogSample/ Operational"
type="Operational"
symbol="DOTNETPERFORMANCE"
isolation="Application" enabled="true"/>
<channel chid="MyDebugChannel"
name="DotNetPerformance-TechalWriting-EventLogSample/ Debug"
type="Debug"
symbol="DOTNETPERFORMANCE"
isolation="Application"
enabled="true"/>
在定义好通道之后，下一步就是定义一个模板以指定要引发事件的基本形态。与原来的事件日志API类似，Vista事件日志也支持使用%1这样的通配符，以便可替换为本地化语言的文本，这样，消息文本的所有内容都可在运行时才提供：
<template tid="SimpleEvent" message="$(string.SimpleMessage)">
<data name="Message" inType="win:UnicodeString"/>
<UserData>
<SimpleEvent xmlns="http://manifests.microsoft.com/win/2004/ 08/windows/simpleevent">
<ExceptionMessage>%1</ExceptionMessage>
</SimpleEvent>
</UserData>
</template>
最后，还需要把应用程序实际将引发的事件添加到清单文件中，为简单起见，对每个通道只定义了一个事件，且都使用同一个模板：
<event value="1"
level="win:Informational"
template="SimpleEvent"
opcode="win:Info"
channel="MyOpChannel"
symbol=" DNP_OP_EVENT"
message="$(string.SimpleMessage)"/>
<event value="2"
level="win:Informational"
template="SimpleEvent"
opcode="win:Info"
channel="MyDebugChannel"
symbol=" DNP_DEBUG_EVENT"
message="$(string.SimpleMessage)"/>
现在，消息编译器（mc.exe）就可以把这个清单文件编译为头文件及资源文件了。
引发事件
实际上，在程序中引发事件是相当地简单（至少与定义清单文件相比是这样的），正如前面所提到的，消息编译器生成了包含有事件及事件发布者定义的头文件，这些信息都可传递给SDK函数，对上面的清单文件而言，头文件将会包含以下定义：
EXTERN_C __declspec(selectany) const
GUID DOTNETPERFORMANCE_TECHNICALWRITING_PUBLISHER = {
0x9cde86c9, 0xdfb9, 0x463f, {0xb2, 0xc5,0x71,0xee,0xc2,0x32, 0xa6,0x9c}};
#define DOTNETPERFORMANCEOP 0x10
#define DOTNETPERFORMANCEDEBUG 0x0
EXTERN_C __declspec(selectany) const EVENT_DESCRIPTOR OP_EVENT = {
0x1, 0x0, 0x10, 0x4, 0x0, 0x0, 0x8000000000000000};
#define DNP_OP_EVENT_value 0x1
EXTERN_C __declspec(selectany) const EVENT_DESCRIPTOR DEBUG_EVENT =
{0x2, 0x0, 0x0, 0x4, 0x0, 0x0, 0x4000000000000000};
#define DNP_DEBUG_EVENT_value 0x2 #define MSG_SimpleMessage 0xB0000001L
接下来，要在代码中包含以下头文件：windows.h（如果为控制台程序）、evntprov.h（其包含了所有的Windows事件跟踪）、winevt.h（其包含了所有新的Vista日志声明）；另外，可通过调用EventRegister来注册事件发布者：
REGHANDLE hPub = NULL;
EventRegister(
&DOTNETPERFORMANCE_TECHNICALWRITING_PUBLISHER, NULL, NULL, &hPub);
实际上，引发一个事件非常之简单：创建一个事件描述符并把它传递给EventWrite函数就可以了：
EVENT_DATA_DESCRIPTOR opEventDesc;
PWSTR pwsOp = L"My Operational Event";
EventDataDescCreate(&opEventDesc, pwsOp,
((ULONG)wcslen(pwsOp)+1)*sizeof(WCHAR));
EventWrite(hPub, &DNP_OP_EVENT, 1, &opEventDesc);
代码中的宏EventDataDescCreate定义在头文件evntprov.h中，它只是提供了一种更短的语法用于设置变量EVENT_DATA_DESCRIPTOR的成员。
如果不再需要为特定发布者写入事件，可取消注册：
EventUnregister(hPub)
部署及使用
在部署程序之前，还需要使用以下命令来注册清单文件：
wevtutil install-manifest 清单文件名.xml
Windows Vista自带的wevtutil工具，将会解析清单文件并添加所需的设置到Vista日志记录中；如果未运行wevtutil，事件仍可被成功引发，但在事件日志中将不可见。
如果一切正常，事件就会如期出现在日志记录中，如下图。
更多在； www.evget.com
[em20]