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

SymRegisterCallback

関数
シンボル処理のコールバック関数を登録する。
DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SymRegisterCallback(
    HANDLE hProcess,
    PSYMBOL_REGISTERED_CALLBACK CallbackFunction,
    void* UserContext   // optional
);

パラメーター

名前方向説明
hProcessHANDLEin元々 SymInitialize 関数に渡されたプロセスのハンドル。
CallbackFunctionPSYMBOL_REGISTERED_CALLBACKinSymRegisterCallbackProc64 コールバック関数。
UserContextvoid*inoptionalユーザー定義の値または NULL。この値はコールバック関数にそのまま渡されます。通常、このパラメーターは、コールバック関数が何らかのコンテキストを確立できるようにするデータ構造へのポインターをアプリケーションが渡すために使用されます。

戻り値の型: BOOL

公式ドキュメント

シンボルハンドラーが使用するコールバック関数を登録します。(SymRegisterCallback)

戻り値

関数が成功した場合、戻り値は TRUE です。

関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

SymRegisterCallback64 関数を使用すると、アプリケーションはシンボルハンドラーが使用するコールバック関数を登録できます。シンボルハンドラーは、アプリケーション向けのステータスまたは進捗情報があるときに、登録されたコールバック関数を呼び出します。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。したがって、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するには、複数のスレッドからのこの関数への同時呼び出しをすべて同期する必要があります。

この関数の Unicode 版を呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。SymRegisterCallbackW64 は Dbghelp.h 内で次のように定義されています。

BOOL
IMAGEAPI
SymRegisterCallbackW64(
    __in HANDLE hProcess,
    __in PSYMBOL_REGISTERED_CALLBACK64 CallbackFunction,
    __in ULONG64 UserContext
    );

#ifdef DBGHELP_TRANSLATE_TCHAR
#define SymRegisterCallback64   SymRegisterCallbackW64
#endif

この関数は SymRegisterCallback 関数に取って代わるものです。詳細については、 Updated Platform Support を参照してください。SymRegisterCallback は Dbghelp.h 内で次のように定義されています。

#if !defined(_IMAGEHLP_SOURCE_) && defined(_IMAGEHLP64)
#define SymRegisterCallback SymRegisterCallback64
#else
BOOL
IMAGEAPI
SymRegisterCallback(
    __in HANDLE hProcess,
    __in PSYMBOL_REGISTERED_CALLBACK CallbackFunction,
    __in_opt PVOID UserContext
    );
#endif

より詳細な例については、Getting Notifications を参照してください。

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

各言語での呼び出し定義

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

BOOL SymRegisterCallback(
    HANDLE hProcess,
    PSYMBOL_REGISTERED_CALLBACK CallbackFunction,
    void* UserContext   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SymRegisterCallback(
    IntPtr hProcess,   // HANDLE
    IntPtr CallbackFunction,   // PSYMBOL_REGISTERED_CALLBACK
    IntPtr UserContext   // void* optional
);
<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymRegisterCallback(
    hProcess As IntPtr,   ' HANDLE
    CallbackFunction As IntPtr,   ' PSYMBOL_REGISTERED_CALLBACK
    UserContext As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hProcess : HANDLE
' CallbackFunction : PSYMBOL_REGISTERED_CALLBACK
' UserContext : void* optional
Declare PtrSafe Function SymRegisterCallback Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal CallbackFunction As LongPtr, _
    ByVal UserContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SymRegisterCallback = ctypes.windll.dbghelp.SymRegisterCallback
SymRegisterCallback.restype = wintypes.BOOL
SymRegisterCallback.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.c_void_p,  # CallbackFunction : PSYMBOL_REGISTERED_CALLBACK
    ctypes.POINTER(None),  # UserContext : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymRegisterCallback = Fiddle::Function.new(
  lib['SymRegisterCallback'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # CallbackFunction : PSYMBOL_REGISTERED_CALLBACK
    Fiddle::TYPE_VOIDP,  # UserContext : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "dbghelp")]
extern "system" {
    fn SymRegisterCallback(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        CallbackFunction: *const core::ffi::c_void,  // PSYMBOL_REGISTERED_CALLBACK
        UserContext: *mut ()  // void* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dbghelp.dll", SetLastError = true)]
public static extern bool SymRegisterCallback(IntPtr hProcess, IntPtr CallbackFunction, IntPtr UserContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymRegisterCallback' -Namespace Win32 -PassThru
# $api::SymRegisterCallback(hProcess, CallbackFunction, UserContext)
#uselib "dbghelp.dll"
#func global SymRegisterCallback "SymRegisterCallback" sptr, sptr, sptr
; SymRegisterCallback hProcess, CallbackFunction, UserContext   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> "sptr"
; UserContext : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "dbghelp.dll"
#cfunc global SymRegisterCallback "SymRegisterCallback" sptr, sptr, sptr
; res = SymRegisterCallback(hProcess, CallbackFunction, UserContext)
; hProcess : HANDLE -> "sptr"
; CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> "sptr"
; UserContext : void* optional -> "sptr"
; BOOL SymRegisterCallback(HANDLE hProcess, PSYMBOL_REGISTERED_CALLBACK CallbackFunction, void* UserContext)
#uselib "dbghelp.dll"
#cfunc global SymRegisterCallback "SymRegisterCallback" intptr, intptr, intptr
; res = SymRegisterCallback(hProcess, CallbackFunction, UserContext)
; hProcess : HANDLE -> "intptr"
; CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> "intptr"
; UserContext : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymRegisterCallback = dbghelp.NewProc("SymRegisterCallback")
)

// hProcess (HANDLE), CallbackFunction (PSYMBOL_REGISTERED_CALLBACK), UserContext (void* optional)
r1, _, err := procSymRegisterCallback.Call(
	uintptr(hProcess),
	uintptr(CallbackFunction),
	uintptr(UserContext),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SymRegisterCallback(
  hProcess: THandle;   // HANDLE
  CallbackFunction: Pointer;   // PSYMBOL_REGISTERED_CALLBACK
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymRegisterCallback';
result := DllCall("dbghelp\SymRegisterCallback"
    , "Ptr", hProcess   ; HANDLE
    , "Ptr", CallbackFunction   ; PSYMBOL_REGISTERED_CALLBACK
    , "Ptr", UserContext   ; void* optional
    , "Int")   ; return: BOOL
●SymRegisterCallback(hProcess, CallbackFunction, UserContext) = DLL("dbghelp.dll", "bool SymRegisterCallback(void*, void*, void*)")
# 呼び出し: SymRegisterCallback(hProcess, CallbackFunction, UserContext)
# hProcess : HANDLE -> "void*"
# CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> "void*"
# UserContext : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dbghelp" fn SymRegisterCallback(
    hProcess: ?*anyopaque, // HANDLE
    CallbackFunction: ?*anyopaque, // PSYMBOL_REGISTERED_CALLBACK
    UserContext: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc SymRegisterCallback(
    hProcess: pointer,  # HANDLE
    CallbackFunction: pointer,  # PSYMBOL_REGISTERED_CALLBACK
    UserContext: pointer  # void* optional
): int32 {.importc: "SymRegisterCallback", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymRegisterCallback(
    void* hProcess,   // HANDLE
    void* CallbackFunction,   // PSYMBOL_REGISTERED_CALLBACK
    void* UserContext   // void* optional
);
ccall((:SymRegisterCallback, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{Cvoid}),
      hProcess, CallbackFunction, UserContext)
# hProcess : HANDLE -> Ptr{Cvoid}
# CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> Ptr{Cvoid}
# UserContext : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymRegisterCallback(
    void* hProcess,
    void* CallbackFunction,
    void* UserContext);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymRegisterCallback(hProcess, CallbackFunction, UserContext)
-- hProcess : HANDLE
-- CallbackFunction : PSYMBOL_REGISTERED_CALLBACK
-- UserContext : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymRegisterCallback = lib.func('__stdcall', 'SymRegisterCallback', 'int32_t', ['void *', 'void *', 'void *']);
// SymRegisterCallback(hProcess, CallbackFunction, UserContext)
// hProcess : HANDLE -> 'void *'
// CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> 'void *'
// UserContext : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("dbghelp.dll", {
  SymRegisterCallback: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SymRegisterCallback(hProcess, CallbackFunction, UserContext)
// hProcess : HANDLE -> "pointer"
// CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> "pointer"
// UserContext : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymRegisterCallback(
    void* hProcess,
    void* CallbackFunction,
    void* UserContext);
C, "dbghelp.dll");
// $ffi->SymRegisterCallback(hProcess, CallbackFunction, UserContext);
// hProcess : HANDLE
// CallbackFunction : PSYMBOL_REGISTERED_CALLBACK
// UserContext : 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);
    boolean SymRegisterCallback(
        Pointer hProcess,   // HANDLE
        Callback CallbackFunction,   // PSYMBOL_REGISTERED_CALLBACK
        Pointer UserContext   // void* optional
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymRegisterCallback = SymRegisterCallback(
    hProcess : Void*,   # HANDLE
    CallbackFunction : Void*,   # PSYMBOL_REGISTERED_CALLBACK
    UserContext : 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 SymRegisterCallbackNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef SymRegisterCallbackDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final SymRegisterCallback = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymRegisterCallbackNative, SymRegisterCallbackDart>('SymRegisterCallback');
// hProcess : HANDLE -> Pointer<Void>
// CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> Pointer<Void>
// UserContext : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymRegisterCallback(
  hProcess: THandle;   // HANDLE
  CallbackFunction: Pointer;   // PSYMBOL_REGISTERED_CALLBACK
  UserContext: Pointer   // void* optional
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymRegisterCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymRegisterCallback"
  c_SymRegisterCallback :: Ptr () -> Ptr () -> Ptr () -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> Ptr ()
-- UserContext : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symregistercallback =
  foreign "SymRegisterCallback"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> (ptr void) *)
(* UserContext : 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 ("SymRegisterCallback" sym-register-callback :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (callback-function :pointer)   ; PSYMBOL_REGISTERED_CALLBACK
  (user-context :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymRegisterCallback = Win32::API::More->new('dbghelp',
    'BOOL SymRegisterCallback(HANDLE hProcess, LPVOID CallbackFunction, LPVOID UserContext)');
# my $ret = $SymRegisterCallback->Call($hProcess, $CallbackFunction, $UserContext);
# hProcess : HANDLE -> HANDLE
# CallbackFunction : PSYMBOL_REGISTERED_CALLBACK -> LPVOID
# UserContext : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

類似 API
公式の関連項目
使用する型