Win32 API 日本語リファレンス
ホーム › System.ErrorReporting › WerRegisterFile

WerRegisterFile

関数
クラッシュ時に収集するファイルをWERに登録する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

HRESULT WerRegisterFile(
    LPCWSTR pwzFile,
    WER_REGISTER_FILE_TYPE regFileType,
    WER_FILE dwFlags
);

パラメーター

名前型方向説明
pwzFileLPCWSTRinファイルへの完全パス。このパスの最大長は MAX_PATH 文字です。
regFileTypeWER_REGISTER_FILE_TYPEin

ファイルの種類。このパラメーターには、WER_REGISTER_FILE_TYPE 列挙型の次の値のいずれかを指定できます。

値 意味
WerRegFileTypeMax
3 WER_REGISTER_FILE_TYPE 列挙型の最大値。
WerRegFileTypeOther
2 その他の種類のファイル。
WerRegFileTypeUserDocument
1 イベント発生時にアプリケーションが使用していたドキュメント。このドキュメントは、Watson サーバーが要求した場合にのみ収集されます。
dwFlagsWER_FILEin

このパラメーターには、次の値の 1 つ以上を指定できます。

値 意味
WER_FILE_ANONYMOUS_DATA このファイルには、ユーザーを特定したり連絡したりするために使用できる個人情報は含まれていません。
WER_FILE_DELETE_WHEN_DONE ファイルがレポートに追加された後、そのファイルを自動的に削除します。

戻り値の型: HRESULT

公式ドキュメント

Windows エラー報告 (WER) がエラー レポートを作成する際に収集されるファイルを登録します。

戻り値

この関数は、成功した場合は S_OK を返し、失敗した場合は次のエラー コードを含むエラー コードを返します。

戻り値 説明
WER_E_INVALID_STATE プロセスの状態が有効ではありません。たとえば、プロセスがアプリケーション回復モードになっている場合です。
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) 登録されたメモリ ブロックとファイルの数が上限を超えています。

解説(Remarks)

登録されたファイルは、サーバーから追加データが要求された場合にのみレポートに追加されます。

クラッシュや応答なしの状態については、オペレーティング システムが自動的にエラー報告を行います (アプリケーションにエラー報告用のコードを記述する必要はありません)。この関数を使用してファイルを登録すると、オペレーティング システムは、クラッシュまたは応答なしの時点で作成されるエラー レポートにそのファイルを追加します (このファイルは、オペレーティング システムが既に収集しているファイルに加えて追加されます)。

汎用イベントの報告では、アプリケーションは代わりに WerReportAddFile 関数を使用する必要があります。あるいは、WER_SUBMIT_ADD_REGISTERED_DATA フラグを指定して WerReportSubmit 関数を呼び出すと、WerRegisterFile 関数が追加したファイルが含められます。

一覧からファイルを削除するには、WerUnregisterFile 関数を呼び出します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

HRESULT WerRegisterFile(
    LPCWSTR pwzFile,
    WER_REGISTER_FILE_TYPE regFileType,
    WER_FILE dwFlags
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern int WerRegisterFile(
    [MarshalAs(UnmanagedType.LPWStr)] string pwzFile,   // LPCWSTR
    int regFileType,   // WER_REGISTER_FILE_TYPE
    uint dwFlags   // WER_FILE
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function WerRegisterFile(
    <MarshalAs(UnmanagedType.LPWStr)> pwzFile As String,   ' LPCWSTR
    regFileType As Integer,   ' WER_REGISTER_FILE_TYPE
    dwFlags As UInteger   ' WER_FILE
) As Integer
End Function
' pwzFile : LPCWSTR
' regFileType : WER_REGISTER_FILE_TYPE
' dwFlags : WER_FILE
Declare PtrSafe Function WerRegisterFile Lib "kernel32" ( _
    ByVal pwzFile As LongPtr, _
    ByVal regFileType As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WerRegisterFile = ctypes.windll.kernel32.WerRegisterFile
WerRegisterFile.restype = ctypes.c_int
WerRegisterFile.argtypes = [
    wintypes.LPCWSTR,  # pwzFile : LPCWSTR
    ctypes.c_int,  # regFileType : WER_REGISTER_FILE_TYPE
    wintypes.DWORD,  # dwFlags : WER_FILE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
WerRegisterFile = Fiddle::Function.new(
  lib['WerRegisterFile'],
  [
    Fiddle::TYPE_VOIDP,  # pwzFile : LPCWSTR
    Fiddle::TYPE_INT,  # regFileType : WER_REGISTER_FILE_TYPE
    -Fiddle::TYPE_INT,  # dwFlags : WER_FILE
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn WerRegisterFile(
        pwzFile: *const u16,  // LPCWSTR
        regFileType: i32,  // WER_REGISTER_FILE_TYPE
        dwFlags: u32  // WER_FILE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern int WerRegisterFile([MarshalAs(UnmanagedType.LPWStr)] string pwzFile, int regFileType, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_WerRegisterFile' -Namespace Win32 -PassThru
# $api::WerRegisterFile(pwzFile, regFileType, dwFlags)
#uselib "KERNEL32.dll"
#func global WerRegisterFile "WerRegisterFile" sptr, sptr, sptr
; WerRegisterFile pwzFile, regFileType, dwFlags   ; 戻り値は stat
; pwzFile : LPCWSTR -> "sptr"
; regFileType : WER_REGISTER_FILE_TYPE -> "sptr"
; dwFlags : WER_FILE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global WerRegisterFile "WerRegisterFile" wstr, int, int
; res = WerRegisterFile(pwzFile, regFileType, dwFlags)
; pwzFile : LPCWSTR -> "wstr"
; regFileType : WER_REGISTER_FILE_TYPE -> "int"
; dwFlags : WER_FILE -> "int"
; HRESULT WerRegisterFile(LPCWSTR pwzFile, WER_REGISTER_FILE_TYPE regFileType, WER_FILE dwFlags)
#uselib "KERNEL32.dll"
#cfunc global WerRegisterFile "WerRegisterFile" wstr, int, int
; res = WerRegisterFile(pwzFile, regFileType, dwFlags)
; pwzFile : LPCWSTR -> "wstr"
; regFileType : WER_REGISTER_FILE_TYPE -> "int"
; dwFlags : WER_FILE -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWerRegisterFile = kernel32.NewProc("WerRegisterFile")
)

// pwzFile (LPCWSTR), regFileType (WER_REGISTER_FILE_TYPE), dwFlags (WER_FILE)
r1, _, err := procWerRegisterFile.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwzFile))),
	uintptr(regFileType),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function WerRegisterFile(
  pwzFile: PWideChar;   // LPCWSTR
  regFileType: Integer;   // WER_REGISTER_FILE_TYPE
  dwFlags: DWORD   // WER_FILE
): Integer; stdcall;
  external 'KERNEL32.dll' name 'WerRegisterFile';
result := DllCall("KERNEL32\WerRegisterFile"
    , "WStr", pwzFile   ; LPCWSTR
    , "Int", regFileType   ; WER_REGISTER_FILE_TYPE
    , "UInt", dwFlags   ; WER_FILE
    , "Int")   ; return: HRESULT
●WerRegisterFile(pwzFile, regFileType, dwFlags) = DLL("KERNEL32.dll", "int WerRegisterFile(char*, int, dword)")
# 呼び出し: WerRegisterFile(pwzFile, regFileType, dwFlags)
# pwzFile : LPCWSTR -> "char*"
# regFileType : WER_REGISTER_FILE_TYPE -> "int"
# dwFlags : WER_FILE -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn WerRegisterFile(
    pwzFile: [*c]const u16, // LPCWSTR
    regFileType: i32, // WER_REGISTER_FILE_TYPE
    dwFlags: u32 // WER_FILE
) callconv(std.os.windows.WINAPI) i32;
proc WerRegisterFile(
    pwzFile: WideCString,  # LPCWSTR
    regFileType: int32,  # WER_REGISTER_FILE_TYPE
    dwFlags: uint32  # WER_FILE
): int32 {.importc: "WerRegisterFile", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int WerRegisterFile(
    const(wchar)* pwzFile,   // LPCWSTR
    int regFileType,   // WER_REGISTER_FILE_TYPE
    uint dwFlags   // WER_FILE
);
ccall((:WerRegisterFile, "KERNEL32.dll"), stdcall, Int32,
      (Cwstring, Int32, UInt32),
      pwzFile, regFileType, dwFlags)
# pwzFile : LPCWSTR -> Cwstring
# regFileType : WER_REGISTER_FILE_TYPE -> Int32
# dwFlags : WER_FILE -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WerRegisterFile(
    const uint16_t* pwzFile,
    int32_t regFileType,
    uint32_t dwFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.WerRegisterFile(pwzFile, regFileType, dwFlags)
-- pwzFile : LPCWSTR
-- regFileType : WER_REGISTER_FILE_TYPE
-- dwFlags : WER_FILE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const WerRegisterFile = lib.func('__stdcall', 'WerRegisterFile', 'int32_t', ['str16', 'int32_t', 'uint32_t']);
// WerRegisterFile(pwzFile, regFileType, dwFlags)
// pwzFile : LPCWSTR -> 'str16'
// regFileType : WER_REGISTER_FILE_TYPE -> 'int32_t'
// dwFlags : WER_FILE -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  WerRegisterFile: { parameters: ["buffer", "i32", "u32"], result: "i32" },
});
// lib.symbols.WerRegisterFile(pwzFile, regFileType, dwFlags)
// pwzFile : LPCWSTR -> "buffer"
// regFileType : WER_REGISTER_FILE_TYPE -> "i32"
// dwFlags : WER_FILE -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WerRegisterFile(
    const uint16_t* pwzFile,
    int32_t regFileType,
    uint32_t dwFlags);
C, "KERNEL32.dll");
// $ffi->WerRegisterFile(pwzFile, regFileType, dwFlags);
// pwzFile : LPCWSTR
// regFileType : WER_REGISTER_FILE_TYPE
// dwFlags : WER_FILE
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    int WerRegisterFile(
        WString pwzFile,   // LPCWSTR
        int regFileType,   // WER_REGISTER_FILE_TYPE
        int dwFlags   // WER_FILE
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun WerRegisterFile = WerRegisterFile(
    pwzFile : UInt16*,   # LPCWSTR
    regFileType : Int32,   # WER_REGISTER_FILE_TYPE
    dwFlags : UInt32   # WER_FILE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WerRegisterFileNative = Int32 Function(Pointer<Utf16>, Int32, Uint32);
typedef WerRegisterFileDart = int Function(Pointer<Utf16>, int, int);
final WerRegisterFile = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<WerRegisterFileNative, WerRegisterFileDart>('WerRegisterFile');
// pwzFile : LPCWSTR -> Pointer<Utf16>
// regFileType : WER_REGISTER_FILE_TYPE -> Int32
// dwFlags : WER_FILE -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WerRegisterFile(
  pwzFile: PWideChar;   // LPCWSTR
  regFileType: Integer;   // WER_REGISTER_FILE_TYPE
  dwFlags: DWORD   // WER_FILE
): Integer; stdcall;
  external 'KERNEL32.dll' name 'WerRegisterFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WerRegisterFile"
  c_WerRegisterFile :: CWString -> Int32 -> Word32 -> IO Int32
-- pwzFile : LPCWSTR -> CWString
-- regFileType : WER_REGISTER_FILE_TYPE -> Int32
-- dwFlags : WER_FILE -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let werregisterfile =
  foreign "WerRegisterFile"
    ((ptr uint16_t) @-> int32_t @-> uint32_t @-> returning int32_t)
(* pwzFile : LPCWSTR -> (ptr uint16_t) *)
(* regFileType : WER_REGISTER_FILE_TYPE -> int32_t *)
(* dwFlags : WER_FILE -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("WerRegisterFile" wer-register-file :convention :stdcall) :int32
  (pwz-file (:string :encoding :utf-16le))   ; LPCWSTR
  (reg-file-type :int32)   ; WER_REGISTER_FILE_TYPE
  (dw-flags :uint32))   ; WER_FILE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WerRegisterFile = Win32::API::More->new('KERNEL32',
    'int WerRegisterFile(LPCWSTR pwzFile, int regFileType, DWORD dwFlags)');
# my $ret = $WerRegisterFile->Call($pwzFile, $regFileType, $dwFlags);
# pwzFile : LPCWSTR -> LPCWSTR
# regFileType : WER_REGISTER_FILE_TYPE -> int
# dwFlags : WER_FILE -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型