ホーム › System.EventLog › EvtGetExtendedStatus
EvtGetExtendedStatus
関数直近の操作の拡張エラー状態を取得する。
シグネチャ
// wevtapi.dll
#include <windows.h>
DWORD EvtGetExtendedStatus(
DWORD BufferSize,
LPWSTR Buffer, // optional
DWORD* BufferUsed
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| BufferSize | DWORD | in | Buffer バッファのサイズ(文字数)。 |
| Buffer | LPWSTR | outoptional | 拡張エラー情報を受け取る、呼び出し側で割り当てた文字列バッファ。このパラメーターに NULL を設定すると、必要なバッファサイズを確認できます。 |
| BufferUsed | DWORD* | out | 関数が使用した、呼び出し側で割り当てたバッファのサイズ(文字数)。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、必要なバッファサイズ。 |
戻り値の型: DWORD
公式ドキュメント
現在のエラーに関する拡張エラー情報を含むテキストメッセージを取得します。
戻り値
呼び出しが成功した場合、戻り値は ERROR_SUCCESS です。それ以外の場合は Win32 エラーコードです。
解説(Remarks)
この関数は、エラーを生成したスレッド上で、かつ他の Windows Event Log 関数を呼び出す前に呼び出す必要があります。
EvtQuery 関数および EvtSubscribe 関数は、指定された XPath に問題がある場合に拡張エラー情報を提供できます。たとえば、エラー情報によって、XPath 内で解析エラーが発生した文字を特定できます。不正な形式の XPath に関する拡張エラー情報を受け取るには、EvtQuery または EvtSubscribe を呼び出す際に EvtQueryTolerateQueryErrors フラグを指定してはいけません。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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>
DWORD EvtGetExtendedStatus(
DWORD BufferSize,
LPWSTR Buffer, // optional
DWORD* BufferUsed
);[DllImport("wevtapi.dll", ExactSpelling = true)]
static extern uint EvtGetExtendedStatus(
uint BufferSize, // DWORD
[MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer, // LPWSTR optional, out
out uint BufferUsed // DWORD* out
);<DllImport("wevtapi.dll", ExactSpelling:=True)>
Public Shared Function EvtGetExtendedStatus(
BufferSize As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPWStr)> Buffer As System.Text.StringBuilder, ' LPWSTR optional, out
<Out> ByRef BufferUsed As UInteger ' DWORD* out
) As UInteger
End Function' BufferSize : DWORD
' Buffer : LPWSTR optional, out
' BufferUsed : DWORD* out
Declare PtrSafe Function EvtGetExtendedStatus Lib "wevtapi" ( _
ByVal BufferSize As Long, _
ByVal Buffer As LongPtr, _
ByRef BufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
EvtGetExtendedStatus = ctypes.windll.wevtapi.EvtGetExtendedStatus
EvtGetExtendedStatus.restype = wintypes.DWORD
EvtGetExtendedStatus.argtypes = [
wintypes.DWORD, # BufferSize : DWORD
wintypes.LPWSTR, # Buffer : LPWSTR optional, out
ctypes.POINTER(wintypes.DWORD), # BufferUsed : DWORD* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('wevtapi.dll')
EvtGetExtendedStatus = Fiddle::Function.new(
lib['EvtGetExtendedStatus'],
[
-Fiddle::TYPE_INT, # BufferSize : DWORD
Fiddle::TYPE_VOIDP, # Buffer : LPWSTR optional, out
Fiddle::TYPE_VOIDP, # BufferUsed : DWORD* out
],
-Fiddle::TYPE_INT)#[link(name = "wevtapi")]
extern "system" {
fn EvtGetExtendedStatus(
BufferSize: u32, // DWORD
Buffer: *mut u16, // LPWSTR optional, out
BufferUsed: *mut u32 // DWORD* out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("wevtapi.dll")]
public static extern uint EvtGetExtendedStatus(uint BufferSize, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder Buffer, out uint BufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wevtapi_EvtGetExtendedStatus' -Namespace Win32 -PassThru
# $api::EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed)#uselib "wevtapi.dll"
#func global EvtGetExtendedStatus "EvtGetExtendedStatus" sptr, sptr, sptr
; EvtGetExtendedStatus BufferSize, varptr(Buffer), varptr(BufferUsed) ; 戻り値は stat
; BufferSize : DWORD -> "sptr"
; Buffer : LPWSTR optional, out -> "sptr"
; BufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "wevtapi.dll" #cfunc global EvtGetExtendedStatus "EvtGetExtendedStatus" int, var, var ; res = EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed) ; BufferSize : DWORD -> "int" ; Buffer : LPWSTR optional, out -> "var" ; BufferUsed : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wevtapi.dll" #cfunc global EvtGetExtendedStatus "EvtGetExtendedStatus" int, sptr, sptr ; res = EvtGetExtendedStatus(BufferSize, varptr(Buffer), varptr(BufferUsed)) ; BufferSize : DWORD -> "int" ; Buffer : LPWSTR optional, out -> "sptr" ; BufferUsed : DWORD* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD EvtGetExtendedStatus(DWORD BufferSize, LPWSTR Buffer, DWORD* BufferUsed) #uselib "wevtapi.dll" #cfunc global EvtGetExtendedStatus "EvtGetExtendedStatus" int, var, var ; res = EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed) ; BufferSize : DWORD -> "int" ; Buffer : LPWSTR optional, out -> "var" ; BufferUsed : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD EvtGetExtendedStatus(DWORD BufferSize, LPWSTR Buffer, DWORD* BufferUsed) #uselib "wevtapi.dll" #cfunc global EvtGetExtendedStatus "EvtGetExtendedStatus" int, intptr, intptr ; res = EvtGetExtendedStatus(BufferSize, varptr(Buffer), varptr(BufferUsed)) ; BufferSize : DWORD -> "int" ; Buffer : LPWSTR optional, out -> "intptr" ; BufferUsed : DWORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
wevtapi = windows.NewLazySystemDLL("wevtapi.dll")
procEvtGetExtendedStatus = wevtapi.NewProc("EvtGetExtendedStatus")
)
// BufferSize (DWORD), Buffer (LPWSTR optional, out), BufferUsed (DWORD* out)
r1, _, err := procEvtGetExtendedStatus.Call(
uintptr(BufferSize),
uintptr(Buffer),
uintptr(BufferUsed),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction EvtGetExtendedStatus(
BufferSize: DWORD; // DWORD
Buffer: PWideChar; // LPWSTR optional, out
BufferUsed: Pointer // DWORD* out
): DWORD; stdcall;
external 'wevtapi.dll' name 'EvtGetExtendedStatus';result := DllCall("wevtapi\EvtGetExtendedStatus"
, "UInt", BufferSize ; DWORD
, "Ptr", Buffer ; LPWSTR optional, out
, "Ptr", BufferUsed ; DWORD* out
, "UInt") ; return: DWORD●EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed) = DLL("wevtapi.dll", "dword EvtGetExtendedStatus(dword, char*, void*)")
# 呼び出し: EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed)
# BufferSize : DWORD -> "dword"
# Buffer : LPWSTR optional, out -> "char*"
# BufferUsed : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "wevtapi" fn EvtGetExtendedStatus(
BufferSize: u32, // DWORD
Buffer: [*c]u16, // LPWSTR optional, out
BufferUsed: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;proc EvtGetExtendedStatus(
BufferSize: uint32, # DWORD
Buffer: ptr uint16, # LPWSTR optional, out
BufferUsed: ptr uint32 # DWORD* out
): uint32 {.importc: "EvtGetExtendedStatus", stdcall, dynlib: "wevtapi.dll".}pragma(lib, "wevtapi");
extern(Windows)
uint EvtGetExtendedStatus(
uint BufferSize, // DWORD
wchar* Buffer, // LPWSTR optional, out
uint* BufferUsed // DWORD* out
);ccall((:EvtGetExtendedStatus, "wevtapi.dll"), stdcall, UInt32,
(UInt32, Ptr{UInt16}, Ptr{UInt32}),
BufferSize, Buffer, BufferUsed)
# BufferSize : DWORD -> UInt32
# Buffer : LPWSTR optional, out -> Ptr{UInt16}
# BufferUsed : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t EvtGetExtendedStatus(
uint32_t BufferSize,
uint16_t* Buffer,
uint32_t* BufferUsed);
]]
local wevtapi = ffi.load("wevtapi")
-- wevtapi.EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed)
-- BufferSize : DWORD
-- Buffer : LPWSTR optional, out
-- BufferUsed : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('wevtapi.dll');
const EvtGetExtendedStatus = lib.func('__stdcall', 'EvtGetExtendedStatus', 'uint32_t', ['uint32_t', 'uint16_t *', 'uint32_t *']);
// EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed)
// BufferSize : DWORD -> 'uint32_t'
// Buffer : LPWSTR optional, out -> 'uint16_t *'
// BufferUsed : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("wevtapi.dll", {
EvtGetExtendedStatus: { parameters: ["u32", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed)
// BufferSize : DWORD -> "u32"
// Buffer : LPWSTR optional, out -> "buffer"
// BufferUsed : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t EvtGetExtendedStatus(
uint32_t BufferSize,
uint16_t* Buffer,
uint32_t* BufferUsed);
C, "wevtapi.dll");
// $ffi->EvtGetExtendedStatus(BufferSize, Buffer, BufferUsed);
// BufferSize : DWORD
// Buffer : LPWSTR optional, out
// BufferUsed : DWORD* out
// 構造体/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);
int EvtGetExtendedStatus(
int BufferSize, // DWORD
char[] Buffer, // LPWSTR optional, out
IntByReference BufferUsed // DWORD* out
);
}@[Link("wevtapi")]
lib Libwevtapi
fun EvtGetExtendedStatus = EvtGetExtendedStatus(
BufferSize : UInt32, # DWORD
Buffer : UInt16*, # LPWSTR optional, out
BufferUsed : UInt32* # DWORD* out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef EvtGetExtendedStatusNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef EvtGetExtendedStatusDart = int Function(int, Pointer<Utf16>, Pointer<Uint32>);
final EvtGetExtendedStatus = DynamicLibrary.open('wevtapi.dll')
.lookupFunction<EvtGetExtendedStatusNative, EvtGetExtendedStatusDart>('EvtGetExtendedStatus');
// BufferSize : DWORD -> Uint32
// Buffer : LPWSTR optional, out -> Pointer<Utf16>
// BufferUsed : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function EvtGetExtendedStatus(
BufferSize: DWORD; // DWORD
Buffer: PWideChar; // LPWSTR optional, out
BufferUsed: Pointer // DWORD* out
): DWORD; stdcall;
external 'wevtapi.dll' name 'EvtGetExtendedStatus';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "EvtGetExtendedStatus"
c_EvtGetExtendedStatus :: Word32 -> CWString -> Ptr Word32 -> IO Word32
-- BufferSize : DWORD -> Word32
-- Buffer : LPWSTR optional, out -> CWString
-- BufferUsed : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let evtgetextendedstatus =
foreign "EvtGetExtendedStatus"
(uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* BufferSize : DWORD -> uint32_t *)
(* Buffer : LPWSTR optional, out -> (ptr uint16_t) *)
(* BufferUsed : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library wevtapi (t "wevtapi.dll"))
(cffi:use-foreign-library wevtapi)
(cffi:defcfun ("EvtGetExtendedStatus" evt-get-extended-status :convention :stdcall) :uint32
(buffer-size :uint32) ; DWORD
(buffer :pointer) ; LPWSTR optional, out
(buffer-used :pointer)) ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $EvtGetExtendedStatus = Win32::API::More->new('wevtapi',
'DWORD EvtGetExtendedStatus(DWORD BufferSize, LPWSTR Buffer, LPVOID BufferUsed)');
# my $ret = $EvtGetExtendedStatus->Call($BufferSize, $Buffer, $BufferUsed);
# BufferSize : DWORD -> DWORD
# Buffer : LPWSTR optional, out -> LPWSTR
# BufferUsed : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。