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

SymFindExecutableImageW

関数
コールバックを用いて実行イメージファイルを検索する。
DLLdbghelp.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

HANDLE SymFindExecutableImageW(
    HANDLE hProcess,
    LPCWSTR FileName,
    LPWSTR ImageFilePath,
    PFIND_EXE_FILE_CALLBACKW Callback,
    void* CallerData
);

パラメーター

名前方向説明
hProcessHANDLEin元々 SymInitialize 関数に渡したプロセスのハンドル。
FileNameLPCWSTRin実行可能ファイルの名前。部分パスを使用できます。
ImageFilePathLPWSTRout実行可能ファイルの完全修飾パス。このバッファーは少なくとも MAX_PATH+1 文字必要です。
CallbackPFIND_EXE_FILE_CALLBACKWin

正しい実行可能ファイルが見つかったかどうか、または関数が検索を続行すべきかどうかを確認する、アプリケーション定義のコールバック関数。詳細については、 FindExecutableImageProc を参照してください。

このパラメーターには NULL を指定できます。

CallerDatavoid*inユーザー定義の値または NULL。この値は単にコールバック関数へ渡されます。このパラメーターは通常、コールバック関数にコンテキストを提供するデータ構造へのポインターをアプリケーションが渡すために使用します。

戻り値の型: HANDLE

公式ドキュメント

SymFindExecutableImageW (Unicode) 関数は、プロセスの検索パスから実行可能ファイルを探します。

戻り値

関数が成功すると、戻り値は実行可能ファイルへのオープン ハンドルになります。

関数が失敗すると、戻り値は NULL になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

この関数は、 SymInitialize 関数または SymSetSearchPath 関数で設定された検索パスを使用します。

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

この関数の Unicode バージョンを呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義してください。

メモ

dbghelp.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして SymFindExecutableImage を定義しています。エンコードに依存しないエイリアスの使用を、エンコードに依存しないわけではないコードと混在させると、不一致が生じてコンパイル エラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

HANDLE SymFindExecutableImageW(
    HANDLE hProcess,
    LPCWSTR FileName,
    LPWSTR ImageFilePath,
    PFIND_EXE_FILE_CALLBACKW Callback,
    void* CallerData
);
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SymFindExecutableImageW(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string FileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ImageFilePath,   // LPWSTR out
    IntPtr Callback,   // PFIND_EXE_FILE_CALLBACKW
    IntPtr CallerData   // void*
);
<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SymFindExecutableImageW(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> FileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> ImageFilePath As System.Text.StringBuilder,   ' LPWSTR out
    Callback As IntPtr,   ' PFIND_EXE_FILE_CALLBACKW
    CallerData As IntPtr   ' void*
) As IntPtr
End Function
' hProcess : HANDLE
' FileName : LPCWSTR
' ImageFilePath : LPWSTR out
' Callback : PFIND_EXE_FILE_CALLBACKW
' CallerData : void*
Declare PtrSafe Function SymFindExecutableImageW Lib "dbghelp" ( _
    ByVal hProcess As LongPtr, _
    ByVal FileName As LongPtr, _
    ByVal ImageFilePath As LongPtr, _
    ByVal Callback As LongPtr, _
    ByVal CallerData As LongPtr) As LongPtr
' 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

SymFindExecutableImageW = ctypes.windll.dbghelp.SymFindExecutableImageW
SymFindExecutableImageW.restype = ctypes.c_void_p
SymFindExecutableImageW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPCWSTR,  # FileName : LPCWSTR
    wintypes.LPWSTR,  # ImageFilePath : LPWSTR out
    ctypes.c_void_p,  # Callback : PFIND_EXE_FILE_CALLBACKW
    ctypes.POINTER(None),  # CallerData : void*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
SymFindExecutableImageW = Fiddle::Function.new(
  lib['SymFindExecutableImageW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # FileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ImageFilePath : LPWSTR out
    Fiddle::TYPE_VOIDP,  # Callback : PFIND_EXE_FILE_CALLBACKW
    Fiddle::TYPE_VOIDP,  # CallerData : void*
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dbghelp")]
extern "system" {
    fn SymFindExecutableImageW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        FileName: *const u16,  // LPCWSTR
        ImageFilePath: *mut u16,  // LPWSTR out
        Callback: *const core::ffi::c_void,  // PFIND_EXE_FILE_CALLBACKW
        CallerData: *mut ()  // void*
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr SymFindExecutableImageW(IntPtr hProcess, [MarshalAs(UnmanagedType.LPWStr)] string FileName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ImageFilePath, IntPtr Callback, IntPtr CallerData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_SymFindExecutableImageW' -Namespace Win32 -PassThru
# $api::SymFindExecutableImageW(hProcess, FileName, ImageFilePath, Callback, CallerData)
#uselib "dbghelp.dll"
#func global SymFindExecutableImageW "SymFindExecutableImageW" wptr, wptr, wptr, wptr, wptr
; SymFindExecutableImageW hProcess, FileName, varptr(ImageFilePath), Callback, CallerData   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; FileName : LPCWSTR -> "wptr"
; ImageFilePath : LPWSTR out -> "wptr"
; Callback : PFIND_EXE_FILE_CALLBACKW -> "wptr"
; CallerData : void* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dbghelp.dll"
#cfunc global SymFindExecutableImageW "SymFindExecutableImageW" sptr, wstr, var, sptr, sptr
; res = SymFindExecutableImageW(hProcess, FileName, ImageFilePath, Callback, CallerData)
; hProcess : HANDLE -> "sptr"
; FileName : LPCWSTR -> "wstr"
; ImageFilePath : LPWSTR out -> "var"
; Callback : PFIND_EXE_FILE_CALLBACKW -> "sptr"
; CallerData : void* -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HANDLE SymFindExecutableImageW(HANDLE hProcess, LPCWSTR FileName, LPWSTR ImageFilePath, PFIND_EXE_FILE_CALLBACKW Callback, void* CallerData)
#uselib "dbghelp.dll"
#cfunc global SymFindExecutableImageW "SymFindExecutableImageW" intptr, wstr, var, intptr, intptr
; res = SymFindExecutableImageW(hProcess, FileName, ImageFilePath, Callback, CallerData)
; hProcess : HANDLE -> "intptr"
; FileName : LPCWSTR -> "wstr"
; ImageFilePath : LPWSTR out -> "var"
; Callback : PFIND_EXE_FILE_CALLBACKW -> "intptr"
; CallerData : void* -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dbghelp = windows.NewLazySystemDLL("dbghelp.dll")
	procSymFindExecutableImageW = dbghelp.NewProc("SymFindExecutableImageW")
)

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

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

typedef SymFindExecutableImageWNative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef SymFindExecutableImageWDart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final SymFindExecutableImageW = DynamicLibrary.open('dbghelp.dll')
    .lookupFunction<SymFindExecutableImageWNative, SymFindExecutableImageWDart>('SymFindExecutableImageW');
// hProcess : HANDLE -> Pointer<Void>
// FileName : LPCWSTR -> Pointer<Utf16>
// ImageFilePath : LPWSTR out -> Pointer<Utf16>
// Callback : PFIND_EXE_FILE_CALLBACKW -> Pointer<Void>
// CallerData : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SymFindExecutableImageW(
  hProcess: THandle;   // HANDLE
  FileName: PWideChar;   // LPCWSTR
  ImageFilePath: PWideChar;   // LPWSTR out
  Callback: Pointer;   // PFIND_EXE_FILE_CALLBACKW
  CallerData: Pointer   // void*
): THandle; stdcall;
  external 'dbghelp.dll' name 'SymFindExecutableImageW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SymFindExecutableImageW"
  c_SymFindExecutableImageW :: Ptr () -> CWString -> CWString -> Ptr () -> Ptr () -> IO (Ptr ())
-- hProcess : HANDLE -> Ptr ()
-- FileName : LPCWSTR -> CWString
-- ImageFilePath : LPWSTR out -> CWString
-- Callback : PFIND_EXE_FILE_CALLBACKW -> Ptr ()
-- CallerData : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let symfindexecutableimagew =
  foreign "SymFindExecutableImageW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning (ptr void))
(* hProcess : HANDLE -> (ptr void) *)
(* FileName : LPCWSTR -> (ptr uint16_t) *)
(* ImageFilePath : LPWSTR out -> (ptr uint16_t) *)
(* Callback : PFIND_EXE_FILE_CALLBACKW -> (ptr void) *)
(* CallerData : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dbghelp (t "dbghelp.dll"))
(cffi:use-foreign-library dbghelp)

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

関連項目

使用する型