Win32 API 日本語リファレンス
ホームSystem.Diagnostics.Debug › DbgHelpCreateUserDumpW

DbgHelpCreateUserDumpW

関数
プロセスのユーザーモードダンプファイルを作成する(Unicode版)。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL DbgHelpCreateUserDumpW(
    LPCWSTR FileName,   // optional
    PDBGHELP_CREATE_USER_DUMP_CALLBACK Callback,
    void* UserData   // optional
);

パラメーター

名前方向説明
FileNameLPCWSTRinoptional作成するユーザーダンプファイルのパスを指すUnicode文字列。
CallbackPDBGHELP_CREATE_USER_DUMP_CALLBACKinダンプ生成の進行状況を受け取るコールバック関数へのポインタ。NULL可。
UserDatavoid*inoptionalコールバックへそのまま渡される任意のユーザーデータポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

// dbghelp.dll  (Unicode / -W)
#include <windows.h>

BOOL DbgHelpCreateUserDumpW(
    LPCWSTR FileName,   // optional
    PDBGHELP_CREATE_USER_DUMP_CALLBACK Callback,
    void* UserData   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool DbgHelpCreateUserDumpW(
    [MarshalAs(UnmanagedType.LPWStr)] string FileName,   // LPCWSTR optional
    IntPtr Callback,   // PDBGHELP_CREATE_USER_DUMP_CALLBACK
    IntPtr UserData   // void* optional
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DbgHelpCreateUserDumpW(
    <MarshalAs(UnmanagedType.LPWStr)> FileName As String,   ' LPCWSTR optional
    Callback As IntPtr,   ' PDBGHELP_CREATE_USER_DUMP_CALLBACK
    UserData As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FileName : LPCWSTR optional
' Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK
' UserData : void* optional
Declare PtrSafe Function DbgHelpCreateUserDumpW Lib "dbghelp" ( _
    ByVal FileName As LongPtr, _
    ByVal Callback As LongPtr, _
    ByVal UserData As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DbgHelpCreateUserDumpW = ctypes.windll.dbghelp.DbgHelpCreateUserDumpW
DbgHelpCreateUserDumpW.restype = wintypes.BOOL
DbgHelpCreateUserDumpW.argtypes = [
    wintypes.LPCWSTR,  # FileName : LPCWSTR optional
    ctypes.c_void_p,  # Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK
    ctypes.POINTER(None),  # UserData : void* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
DbgHelpCreateUserDumpW = Fiddle::Function.new(
  lib['DbgHelpCreateUserDumpW'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK
    Fiddle::TYPE_VOIDP,  # UserData : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn DbgHelpCreateUserDumpW(
        FileName: *const u16,  // LPCWSTR optional
        Callback: *const core::ffi::c_void,  // PDBGHELP_CREATE_USER_DUMP_CALLBACK
        UserData: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode)]
public static extern bool DbgHelpCreateUserDumpW([MarshalAs(UnmanagedType.LPWStr)] string FileName, IntPtr Callback, IntPtr UserData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_DbgHelpCreateUserDumpW' -Namespace Win32 -PassThru
# $api::DbgHelpCreateUserDumpW(FileName, Callback, UserData)
#uselib "dbghelp.dll"
#func global DbgHelpCreateUserDumpW "DbgHelpCreateUserDumpW" wptr, wptr, wptr
; DbgHelpCreateUserDumpW FileName, Callback, UserData   ; 戻り値は stat
; FileName : LPCWSTR optional -> "wptr"
; Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> "wptr"
; UserData : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global DbgHelpCreateUserDumpW "DbgHelpCreateUserDumpW" wstr, sptr, sptr
; res = DbgHelpCreateUserDumpW(FileName, Callback, UserData)
; FileName : LPCWSTR optional -> "wstr"
; Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> "sptr"
; UserData : void* optional -> "sptr"
; BOOL DbgHelpCreateUserDumpW(LPCWSTR FileName, PDBGHELP_CREATE_USER_DUMP_CALLBACK Callback, void* UserData)
#uselib "dbghelp.dll"
#cfunc global DbgHelpCreateUserDumpW "DbgHelpCreateUserDumpW" wstr, intptr, intptr
; res = DbgHelpCreateUserDumpW(FileName, Callback, UserData)
; FileName : LPCWSTR optional -> "wstr"
; Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> "intptr"
; UserData : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procDbgHelpCreateUserDumpW = dbghelp.NewProc("DbgHelpCreateUserDumpW")
)

// FileName (LPCWSTR optional), Callback (PDBGHELP_CREATE_USER_DUMP_CALLBACK), UserData (void* optional)
r1, _, err := procDbgHelpCreateUserDumpW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(FileName))),
	uintptr(Callback),
	uintptr(UserData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function DbgHelpCreateUserDumpW(
  FileName: PWideChar;   // LPCWSTR optional
  Callback: Pointer;   // PDBGHELP_CREATE_USER_DUMP_CALLBACK
  UserData: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'DbgHelpCreateUserDumpW';
result := DllCall("dbghelp\DbgHelpCreateUserDumpW"
    , "WStr", FileName   ; LPCWSTR optional
    , "Ptr", Callback   ; PDBGHELP_CREATE_USER_DUMP_CALLBACK
    , "Ptr", UserData   ; void* optional
    , "Int")   ; return: BOOL
●DbgHelpCreateUserDumpW(FileName, Callback, UserData) = DLL("dbghelp.dll", "bool DbgHelpCreateUserDumpW(char*, void*, void*)")
# 呼び出し: DbgHelpCreateUserDumpW(FileName, Callback, UserData)
# FileName : LPCWSTR optional -> "char*"
# Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> "void*"
# UserData : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "dbghelp" fn DbgHelpCreateUserDumpW(
    FileName: [*c]const u16, // LPCWSTR optional
    Callback: ?*anyopaque, // PDBGHELP_CREATE_USER_DUMP_CALLBACK
    UserData: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DbgHelpCreateUserDumpW(
    FileName: WideCString,  # LPCWSTR optional
    Callback: pointer,  # PDBGHELP_CREATE_USER_DUMP_CALLBACK
    UserData: pointer  # void* optional
): int32 {.importc: "DbgHelpCreateUserDumpW", stdcall, dynlib: "dbghelp.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dbghelp");
extern(Windows)
int DbgHelpCreateUserDumpW(
    const(wchar)* FileName,   // LPCWSTR optional
    void* Callback,   // PDBGHELP_CREATE_USER_DUMP_CALLBACK
    void* UserData   // void* optional
);
ccall((:DbgHelpCreateUserDumpW, "dbghelp.dll"), stdcall, Int32,
      (Cwstring, Ptr{Cvoid}, Ptr{Cvoid}),
      FileName, Callback, UserData)
# FileName : LPCWSTR optional -> Cwstring
# Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> Ptr{Cvoid}
# UserData : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t DbgHelpCreateUserDumpW(
    const uint16_t* FileName,
    void* Callback,
    void* UserData);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.DbgHelpCreateUserDumpW(FileName, Callback, UserData)
-- FileName : LPCWSTR optional
-- Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK
-- UserData : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const DbgHelpCreateUserDumpW = lib.func('__stdcall', 'DbgHelpCreateUserDumpW', 'int32_t', ['str16', 'void *', 'void *']);
// DbgHelpCreateUserDumpW(FileName, Callback, UserData)
// FileName : LPCWSTR optional -> 'str16'
// Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> 'void *'
// UserData : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("dbghelp.dll", {
  DbgHelpCreateUserDumpW: { parameters: ["buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.DbgHelpCreateUserDumpW(FileName, Callback, UserData)
// FileName : LPCWSTR optional -> "buffer"
// Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> "pointer"
// UserData : void* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DbgHelpCreateUserDumpW(
    const uint16_t* FileName,
    void* Callback,
    void* UserData);
C, "dbghelp.dll");
// $ffi->DbgHelpCreateUserDumpW(FileName, Callback, UserData);
// FileName : LPCWSTR optional
// Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK
// UserData : void* 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 Dbghelp extends StdCallLibrary {
    Dbghelp INSTANCE = Native.load("dbghelp", Dbghelp.class, W32APIOptions.UNICODE_OPTIONS);
    boolean DbgHelpCreateUserDumpW(
        WString FileName,   // LPCWSTR optional
        Callback Callback,   // PDBGHELP_CREATE_USER_DUMP_CALLBACK
        Pointer UserData   // void* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dbghelp")]
lib Libdbghelp
  fun DbgHelpCreateUserDumpW = DbgHelpCreateUserDumpW(
    FileName : UInt16*,   # LPCWSTR optional
    Callback : Void*,   # PDBGHELP_CREATE_USER_DUMP_CALLBACK
    UserData : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DbgHelpCreateUserDumpWNative = Int32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef DbgHelpCreateUserDumpWDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final DbgHelpCreateUserDumpW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<DbgHelpCreateUserDumpWNative, DbgHelpCreateUserDumpWDart>('DbgHelpCreateUserDumpW');
// FileName : LPCWSTR optional -> Pointer<Utf16>
// Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> Pointer<Void>
// UserData : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DbgHelpCreateUserDumpW(
  FileName: PWideChar;   // LPCWSTR optional
  Callback: Pointer;   // PDBGHELP_CREATE_USER_DUMP_CALLBACK
  UserData: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'DbgHelpCreateUserDumpW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DbgHelpCreateUserDumpW"
  c_DbgHelpCreateUserDumpW :: CWString -> Ptr () -> Ptr () -> IO CInt
-- FileName : LPCWSTR optional -> CWString
-- Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> Ptr ()
-- UserData : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dbghelpcreateuserdumpw =
  foreign "DbgHelpCreateUserDumpW"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* FileName : LPCWSTR optional -> (ptr uint16_t) *)
(* Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> (ptr void) *)
(* UserData : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("DbgHelpCreateUserDumpW" dbg-help-create-user-dump-w :convention :stdcall) :int32
  (file-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (callback :pointer)   ; PDBGHELP_CREATE_USER_DUMP_CALLBACK
  (user-data :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DbgHelpCreateUserDumpW = Win32::API::More->new('dbghelp',
    'BOOL DbgHelpCreateUserDumpW(LPCWSTR FileName, LPVOID Callback, LPVOID UserData)');
# my $ret = $DbgHelpCreateUserDumpW->Call($FileName, $Callback, $UserData);
# FileName : LPCWSTR optional -> LPCWSTR
# Callback : PDBGHELP_CREATE_USER_DUMP_CALLBACK -> LPVOID
# UserData : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

使用する型