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

SymInitialize

関数
プロセスのシンボルハンドラを初期化する。
DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

BOOL SymInitialize(
    HANDLE hProcess,
    LPCSTR UserSearchPath,   // optional
    BOOL fInvadeProcess
);

パラメーター

名前型方向説明
hProcessHANDLEin

呼び出し元を識別するハンドル。この値は一意かつ 0 以外である必要がありますが、プロセスハンドルである必要はありません。ただし、プロセスハンドルを使用する場合は、正しいハンドルを使用してください。アプリケーションがデバッガーである場合は、デバッグ対象プロセスのプロセスハンドルを使用します。GetCurrentProcess が返すハンドルは使用しないでください。使用するハンドルは、他のコンポーネントとセッションを共有しないよう一意でなければなりません。複数のコンポーネントが dbghelp を使用して現在のプロセスを検査しようとしている場合、GetCurrentProcess を使用すると予期しない結果になることがあります。別のプロセスをデバッグする際に GetCurrentProcess を使用すると、SymLoadModuleEx のような関数でも予期しない結果が生じます。

このパラメーターを NULL にすることはできません。

UserSearchPathLPCSTRinoptional

シンボルファイルの検索に使用するパス、またはセミコロン (;) で区切った一連のパス。このパラメーターが NULL の場合、ライブラリは以下のソースからシンボルパスの構成を試みます。

  • アプリケーションの現在の作業ディレクトリ
  • _NT_SYMBOL_PATH 環境変数
  • _NT_ALTERNATE_SYMBOL_PATH 環境変数
検索パスは SymSetSearchPath 関数を使用して設定することもできます。
fInvadeProcessBOOLinこの値が TRUE の場合、プロセスのロード済みモジュールを列挙し、各モジュールに対して実質的に SymLoadModule64 関数を呼び出します。

戻り値の型: BOOL

公式ドキュメント

SymInitialize 関数 (dbghelp.h) は、プロセスのシンボルハンドラーを初期化します。

戻り値

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

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

解説(Remarks)

SymInitialize 関数は、プロセスのシンボルハンドラーを初期化するために使用します。シンボルハンドラーのコンテキストでは、プロセスはシンボル情報を収集する際に使用すると便利なオブジェクトです。通常、シンボルハンドラーは、デバッグ対象プロセスのシンボルをロードする必要があるデバッガーやその他のツールによって使用されます。

SymInitialize に渡すハンドルは、そのプロセスが呼び出す他のすべてのシンボルハンドラー関数に渡す値と同じでなければなりません。関数はこのハンドルを使用して呼び出し元を識別し、正しいシンボル情報を特定します。シンボル情報の使用を終えたら、SymCleanup 関数を呼び出して、シンボルがロードされたプロセスに関連付けられたすべてのリソースを解放します。

シンボルファイルの検索は、UserSearchPath パラメーターで指定されたすべてのパスに対して再帰的に実行されます。したがって、検索でルートディレクトリを指定すると、ドライブ全体が検索され、相当な時間がかかることがあります。なお、プロセスの実行可能ファイルを含むディレクトリは、自動的には検索パスに含まれません。このディレクトリを検索パスに含めるには、GetModuleFileNameEx 関数を呼び出し、返されたパスを UserSearchPath に追加します。

SymInitialize を呼び出したプロセスは、先に SymCleanup を呼び出さない限り、再度 SymInitialize を呼び出すべきではありません。SymInitialize の呼び出しで fInvadeProcess を TRUE に設定しており、単にモジュールリストを再ロードする必要がある場合は、SymRefreshModuleList 関数を使用します。

この関数を含むすべての DbgHelp 関数はシングルスレッドです。したがって、複数のスレッドからこの関数を呼び出すと、予期しない動作やメモリ破損が発生する可能性があります。これを回避するため、SymInitialize はプロセスの開始時にのみ呼び出し、SymCleanup はプロセスの終了時にのみ呼び出してください。プロセス内の各スレッドがこれらの関数を呼び出す必要はありません。

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

例

例については、Initializing the Symbol Handler を参照してください。

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

各言語での呼び出し定義

// dbghelp.dll  (ANSI / -A)
#include <windows.h>

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

SymInitialize = ctypes.windll.dbghelp.SymInitialize
SymInitialize.restype = wintypes.BOOL
SymInitialize.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCSTR,  # UserSearchPath : LPCSTR optional
    wintypes.BOOL,  # fInvadeProcess : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymInitialize = dbghelp.NewProc("SymInitialize")
)

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

extern "dbghelp" fn SymInitialize(
    hProcess: ?*anyopaque, // HANDLE
    UserSearchPath: [*c]const u8, // LPCSTR optional
    fInvadeProcess: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc SymInitialize(
    hProcess: pointer,  # HANDLE
    UserSearchPath: cstring,  # LPCSTR optional
    fInvadeProcess: int32  # BOOL
): int32 {.importc: "SymInitialize", stdcall, dynlib: "dbghelp.dll".}
pragma(lib, "dbghelp");
extern(Windows)
int SymInitialize(
    void* hProcess,   // HANDLE
    const(char)* UserSearchPath,   // LPCSTR optional
    int fInvadeProcess   // BOOL
);
ccall((:SymInitialize, "dbghelp.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Int32),
      hProcess, UserSearchPath, fInvadeProcess)
# hProcess : HANDLE -> Ptr{Cvoid}
# UserSearchPath : LPCSTR optional -> Cstring
# fInvadeProcess : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SymInitialize(
    void* hProcess,
    const char* UserSearchPath,
    int32_t fInvadeProcess);
]]
local dbghelp = ffi.load("dbghelp")
-- dbghelp.SymInitialize(hProcess, UserSearchPath, fInvadeProcess)
-- hProcess : HANDLE
-- UserSearchPath : LPCSTR optional
-- fInvadeProcess : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dbghelp.dll');
const SymInitialize = lib.func('__stdcall', 'SymInitialize', 'int32_t', ['void *', 'str', 'int32_t']);
// SymInitialize(hProcess, UserSearchPath, fInvadeProcess)
// hProcess : HANDLE -> 'void *'
// UserSearchPath : LPCSTR optional -> 'str'
// fInvadeProcess : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dbghelp.dll", {
  SymInitialize: { parameters: ["pointer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.SymInitialize(hProcess, UserSearchPath, fInvadeProcess)
// hProcess : HANDLE -> "pointer"
// UserSearchPath : LPCSTR optional -> "buffer"
// fInvadeProcess : BOOL -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SymInitialize(
    void* hProcess,
    const char* UserSearchPath,
    int32_t fInvadeProcess);
C, "dbghelp.dll");
// $ffi->SymInitialize(hProcess, UserSearchPath, fInvadeProcess);
// hProcess : HANDLE
// UserSearchPath : LPCSTR optional
// fInvadeProcess : BOOL
// 構造体/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.ASCII_OPTIONS);
    boolean SymInitialize(
        Pointer hProcess,   // HANDLE
        String UserSearchPath,   // LPCSTR optional
        boolean fInvadeProcess   // BOOL
    );
}
@[Link("dbghelp")]
lib Libdbghelp
  fun SymInitialize = SymInitialize(
    hProcess : Void*,   # HANDLE
    UserSearchPath : UInt8*,   # LPCSTR optional
    fInvadeProcess : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SymInitializeNative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Int32);
typedef SymInitializeDart = int Function(Pointer<Void>, Pointer<Utf8>, int);
final SymInitialize = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymInitializeNative, SymInitializeDart>('SymInitialize');
// hProcess : HANDLE -> Pointer<Void>
// UserSearchPath : LPCSTR optional -> Pointer<Utf8>
// fInvadeProcess : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymInitialize(
  hProcess: THandle;   // HANDLE
  UserSearchPath: PAnsiChar;   // LPCSTR optional
  fInvadeProcess: BOOL   // BOOL
): BOOL; stdcall;
  external 'dbghelp.dll' name 'SymInitialize';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymInitialize"
  c_SymInitialize :: Ptr () -> CString -> CInt -> IO CInt
-- hProcess : HANDLE -> Ptr ()
-- UserSearchPath : LPCSTR optional -> CString
-- fInvadeProcess : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let syminitialize =
  foreign "SymInitialize"
    ((ptr void) @-> string @-> int32_t @-> returning int32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* UserSearchPath : LPCSTR optional -> string *)
(* fInvadeProcess : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

(cffi:defcfun ("SymInitialize" sym-initialize :convention :stdcall) :int32
  (h-process :pointer)   ; HANDLE
  (user-search-path :string)   ; LPCSTR optional
  (f-invade-process :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SymInitialize = Win32::API::More->new('dbghelp',
    'BOOL SymInitialize(HANDLE hProcess, LPCSTR UserSearchPath, BOOL fInvadeProcess)');
# my $ret = $SymInitialize->Call($hProcess, $UserSearchPath, $fInvadeProcess);
# hProcess : HANDLE -> HANDLE
# UserSearchPath : LPCSTR optional -> LPCSTR
# fInvadeProcess : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目