ホーム › System.EventLog › EvtCreateBookmark
EvtCreateBookmark
関数イベント位置を示すブックマークを作成する。
シグネチャ
// wevtapi.dll
#include <windows.h>
EVT_HANDLE EvtCreateBookmark(
LPCWSTR BookmarkXml // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| BookmarkXml | LPCWSTR | inoptional | ブックマークを含む XML 文字列。新しいブックマークを作成する場合は NULL を指定します。 |
戻り値の型: EVT_HANDLE
公式ドキュメント
チャネル内のイベントを識別するブックマークを作成します。
戻り値
呼び出しが成功した場合はブックマークへのハンドル。失敗した場合は NULL です。NULL の場合は、GetLastError 関数を呼び出してエラーコードを取得してください。
解説(Remarks)
ブックマークを作成するには、BookmarkXml パラメーターを NULL に設定します。終了する前に、EvtUpdateBookmark 関数を呼び出してブックマークを更新します。ブックマークハンドルを EvtRender 関数に渡すと、ブックマークを XML 文字列としてレンダリングできます。その文字列を保存しておけば、後で利用できます。前回の続きからイベントの消費を再開するには、保存しておいた XML 文字列を BookmarkXml に設定します。サブスクリプションの場合は、ブックマークハンドルを EvtSubscribe 関数に渡します。クエリの場合は、ブックマークハンドルを EvtSeek 関数に渡して、クエリ結果内の特定のイベントへシークします。
クエリが複数のチャネルを対象とする場合、ブックマークハンドルには各チャネルのブックマークが含まれます。ログファイルに対するブックマークは作成できません。
処理が完了したら、EvtClose 関数を呼び出してハンドルを閉じる必要があります。
例
この関数の使用方法を示す例については、Bookmarking Events を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// wevtapi.dll
#include <windows.h>
EVT_HANDLE EvtCreateBookmark(
LPCWSTR BookmarkXml // optional
);[DllImport("wevtapi.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr EvtCreateBookmark(
[MarshalAs(UnmanagedType.LPWStr)] string BookmarkXml // LPCWSTR optional
);<DllImport("wevtapi.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EvtCreateBookmark(
<MarshalAs(UnmanagedType.LPWStr)> BookmarkXml As String ' LPCWSTR optional
) As IntPtr
End Function' BookmarkXml : LPCWSTR optional
Declare PtrSafe Function EvtCreateBookmark Lib "wevtapi" ( _
ByVal BookmarkXml As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
EvtCreateBookmark = ctypes.windll.wevtapi.EvtCreateBookmark
EvtCreateBookmark.restype = ctypes.c_ssize_t
EvtCreateBookmark.argtypes = [
wintypes.LPCWSTR, # BookmarkXml : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('wevtapi.dll')
EvtCreateBookmark = Fiddle::Function.new(
lib['EvtCreateBookmark'],
[
Fiddle::TYPE_VOIDP, # BookmarkXml : LPCWSTR optional
],
Fiddle::TYPE_INTPTR_T)#[link(name = "wevtapi")]
extern "system" {
fn EvtCreateBookmark(
BookmarkXml: *const u16 // LPCWSTR optional
) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("wevtapi.dll", SetLastError = true)]
public static extern IntPtr EvtCreateBookmark([MarshalAs(UnmanagedType.LPWStr)] string BookmarkXml);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtCreateBookmark' -Namespace Win32 -PassThru
# $api::EvtCreateBookmark(BookmarkXml)#uselib "wevtapi.dll"
#func global EvtCreateBookmark "EvtCreateBookmark" sptr
; EvtCreateBookmark BookmarkXml ; 戻り値は stat
; BookmarkXml : LPCWSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "wevtapi.dll"
#cfunc global EvtCreateBookmark "EvtCreateBookmark" wstr
; res = EvtCreateBookmark(BookmarkXml)
; BookmarkXml : LPCWSTR optional -> "wstr"; EVT_HANDLE EvtCreateBookmark(LPCWSTR BookmarkXml)
#uselib "wevtapi.dll"
#cfunc global EvtCreateBookmark "EvtCreateBookmark" wstr
; res = EvtCreateBookmark(BookmarkXml)
; BookmarkXml : LPCWSTR optional -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
procEvtCreateBookmark = wevtapi.NewProc("EvtCreateBookmark")
)
// BookmarkXml (LPCWSTR optional)
r1, _, err := procEvtCreateBookmark.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(BookmarkXml))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // EVT_HANDLEfunction EvtCreateBookmark(
BookmarkXml: PWideChar // LPCWSTR optional
): NativeInt; stdcall;
external 'wevtapi.dll' name 'EvtCreateBookmark';result := DllCall("wevtapi\EvtCreateBookmark"
, "WStr", BookmarkXml ; LPCWSTR optional
, "Ptr") ; return: EVT_HANDLE●EvtCreateBookmark(BookmarkXml) = DLL("wevtapi.dll", "int EvtCreateBookmark(char*)")
# 呼び出し: EvtCreateBookmark(BookmarkXml)
# BookmarkXml : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "wevtapi" fn EvtCreateBookmark(
BookmarkXml: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) isize;proc EvtCreateBookmark(
BookmarkXml: WideCString # LPCWSTR optional
): int {.importc: "EvtCreateBookmark", stdcall, dynlib: "wevtapi.dll".}pragma(lib, "wevtapi");
extern(Windows)
ptrdiff_t EvtCreateBookmark(
const(wchar)* BookmarkXml // LPCWSTR optional
);ccall((:EvtCreateBookmark, "wevtapi.dll"), stdcall, Int,
(Cwstring,),
BookmarkXml)
# BookmarkXml : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
intptr_t EvtCreateBookmark(
const uint16_t* BookmarkXml);
]]
local wevtapi = ffi.load("wevtapi")
-- wevtapi.EvtCreateBookmark(BookmarkXml)
-- BookmarkXml : LPCWSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('wevtapi.dll');
const EvtCreateBookmark = lib.func('__stdcall', 'EvtCreateBookmark', 'intptr_t', ['str16']);
// EvtCreateBookmark(BookmarkXml)
// BookmarkXml : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("wevtapi.dll", {
EvtCreateBookmark: { parameters: ["buffer"], result: "isize" },
});
// lib.symbols.EvtCreateBookmark(BookmarkXml)
// BookmarkXml : LPCWSTR optional -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
intptr_t EvtCreateBookmark(
const uint16_t* BookmarkXml);
C, "wevtapi.dll");
// $ffi->EvtCreateBookmark(BookmarkXml);
// BookmarkXml : LPCWSTR optional
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Wevtapi extends StdCallLibrary {
Wevtapi INSTANCE = Native.load("wevtapi", Wevtapi.class);
long EvtCreateBookmark(
WString BookmarkXml // LPCWSTR optional
);
}@[Link("wevtapi")]
lib Libwevtapi
fun EvtCreateBookmark = EvtCreateBookmark(
BookmarkXml : UInt16* # LPCWSTR optional
) : LibC::SSizeT
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef EvtCreateBookmarkNative = IntPtr Function(Pointer<Utf16>);
typedef EvtCreateBookmarkDart = int Function(Pointer<Utf16>);
final EvtCreateBookmark = DynamicLibrary.open('wevtapi.dll')
.lookupFunction<EvtCreateBookmarkNative, EvtCreateBookmarkDart>('EvtCreateBookmark');
// BookmarkXml : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function EvtCreateBookmark(
BookmarkXml: PWideChar // LPCWSTR optional
): NativeInt; stdcall;
external 'wevtapi.dll' name 'EvtCreateBookmark';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "EvtCreateBookmark"
c_EvtCreateBookmark :: CWString -> IO CIntPtr
-- BookmarkXml : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let evtcreatebookmark =
foreign "EvtCreateBookmark"
((ptr uint16_t) @-> returning intptr_t)
(* BookmarkXml : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library wevtapi (t "wevtapi.dll"))
(cffi:use-foreign-library wevtapi)
(cffi:defcfun ("EvtCreateBookmark" evt-create-bookmark :convention :stdcall) :int64
(bookmark-xml (:string :encoding :utf-16le))) ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $EvtCreateBookmark = Win32::API::More->new('wevtapi',
'LPARAM EvtCreateBookmark(LPCWSTR BookmarkXml)');
# my $ret = $EvtCreateBookmark->Call($BookmarkXml);
# BookmarkXml : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f EvtUpdateBookmark — ブックマークを指定イベントの位置に更新する。