evtCreateBookmark 函数 (winevt.h)

  • 项目

创建一个书签，用于标识通道中的事件。

语法

EVT_HANDLE EvtCreateBookmark(
  [in, optional] LPCWSTR BookmarkXml
);

参数

[in, optional] BookmarkXml

包含书签的 XML 字符串;如果创建书签，则为 NULL 。

返回值

如果调用成功，则为书签的句柄;否则为 NULL。 如果 为 NULL，则调用 GetLastError 函数以获取错误代码。

注解

若要创建书签，请将 BookmarkXml 参数设置为 NULL。 退出之前，请调用 EvtUpdateBookmark 函数以更新书签。 将书签句柄传递给 EvtRender 函数，以将书签呈现为 XML 字符串。 然后，可以保留该字符串供以后使用。 若要开始使用上次中断的事件，请将 BookmarkXml 设置为保留的 XML 字符串。 对于订阅，请将书签句柄传递给 EvtSubscribe 函数。 对于查询，请将书签句柄传递给 EvtSeek 函数，以查找查询结果中的特定事件。

如果查询针对多个通道，则书签句柄将包含每个通道的书签。 不能为日志文件创建书签。

完成后，必须调用 EvtClose 函数以关闭句柄。

示例

有关演示如何使用此函数的示例，请参阅 为事件添加书签。

要求

要求 值
最低受支持的客户端 Windows Vista [仅限桌面应用]
最低受支持的服务器 Windows Server 2008 [仅限桌面应用]
目标平台 Windows
标头 winevt.h
Library Wevtapi.lib
DLL Wevtapi.dll

另请参阅

EvtUpdateBookmark