ホーム › System.Diagnostics.Debug › FindExecutableImageEx

FindExecutableImageEx

関数

コールバック付きで実行イメージファイルを検索する拡張版である。

DLLdbghelp.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

HANDLE FindExecutableImageEx(
    LPCSTR FileName,
    LPCSTR SymbolPath,
    LPSTR ImageFilePath,
    PFIND_EXE_FILE_CALLBACK Callback,   // optional
    void* CallerData   // optional
);

パラメーター

名前	型	方向	説明
FileName	LPCSTR	in	検索対象のシンボルファイルの名前。このパラメーターには部分的なパスを指定できます。
SymbolPath	LPCSTR	in	シンボルファイルが格納されているパス。この文字列にはセミコロンで区切って複数のパスを含めることができます。シンボルパスを取得するには、 SymGetSearchPath 関数を使用します。
ImageFilePath	LPSTR	out	実行可能ファイルの完全パスを受け取るバッファーへのポインター。このバッファーは少なくとも MAX_PATH+1 文字分の大きさが必要です。
Callback	PFIND_EXE_FILE_CALLBACK	inoptional	正しい実行可能ファイルが見つかったかどうか、または関数が検索を続行すべきかどうかを検証する、アプリケーション定義のコールバック関数。詳細については、 FindExecutableImageProc を参照してください。このパラメーターは NULL にできます。
CallerData	void*	inoptional	コールバック関数に渡す、オプションのユーザー定義データ。このパラメーターは NULL にできます。

戻り値の型: HANDLE

公式ドキュメント

FindExecutableImageEx 関数 (dbghelp.h) は、指定された実行可能ファイルを検索します。

戻り値

関数が成功した場合、戻り値は実行可能ファイルへのオープンされたハンドルです。

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

解説(Remarks)

FindExecutableImageEx 関数は、1 回の関数呼び出しで複数の異なるディレクトリから実行可能ファイルを検索できるように用意されています。SymbolPath パラメーターに複数のパスが含まれている場合、関数は指定された各ディレクトリツリーを順に検索して実行可能ファイルを探します。ファイルが見つかると検索は停止します。そのため、SymbolPath にはパスを正しい順序で指定してください。

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

この関数の Unicode 版を呼び出すには、DBGHELP_TRANSLATE_TCHAR を定義します。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

HANDLE FindExecutableImageEx(
    LPCSTR FileName,
    LPCSTR SymbolPath,
    LPSTR ImageFilePath,
    PFIND_EXE_FILE_CALLBACK Callback,   // optional
    void* CallerData   // optional
);

[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindExecutableImageEx(
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string SymbolPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ImageFilePath,   // LPSTR out
    IntPtr Callback,   // PFIND_EXE_FILE_CALLBACK optional
    IntPtr CallerData   // void* optional
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindExecutableImageEx(
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> SymbolPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> ImageFilePath As System.Text.StringBuilder,   ' LPSTR out
    Callback As IntPtr,   ' PFIND_EXE_FILE_CALLBACK optional
    CallerData As IntPtr   ' void* optional
) As IntPtr
End Function

' FileName : LPCSTR
' SymbolPath : LPCSTR
' ImageFilePath : LPSTR out
' Callback : PFIND_EXE_FILE_CALLBACK optional
' CallerData : void* optional
Declare PtrSafe Function FindExecutableImageEx Lib "dbghelp" ( _
    ByVal FileName As String, _
    ByVal SymbolPath As String, _
    ByVal ImageFilePath As String, _
    ByVal Callback As LongPtr, _
    ByVal CallerData As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FindExecutableImageEx = ctypes.windll.dbghelp.FindExecutableImageEx
FindExecutableImageEx.restype = ctypes.c_void_p
FindExecutableImageEx.argtypes = [
    wintypes.LPCSTR,  # FileName : LPCSTR
    wintypes.LPCSTR,  # SymbolPath : LPCSTR
    wintypes.LPSTR,  # ImageFilePath : LPSTR out
    ctypes.c_void_p,  # Callback : PFIND_EXE_FILE_CALLBACK optional
    ctypes.POINTER(None),  # CallerData : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
FindExecutableImageEx = Fiddle::Function.new(
  lib['FindExecutableImageEx'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # SymbolPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # ImageFilePath : LPSTR out
    Fiddle::TYPE_VOIDP,  # Callback : PFIND_EXE_FILE_CALLBACK optional
    Fiddle::TYPE_VOIDP,  # CallerData : void* optional
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "dbghelp")]
extern "system" {
    fn FindExecutableImageEx(
        FileName: *const u8,  // LPCSTR
        SymbolPath: *const u8,  // LPCSTR
        ImageFilePath: *mut u8,  // LPSTR out
        Callback: *const core::ffi::c_void,  // PFIND_EXE_FILE_CALLBACK optional
        CallerData: *mut ()  // void* optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dbghelp.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr FindExecutableImageEx([MarshalAs(UnmanagedType.LPStr)] string FileName, [MarshalAs(UnmanagedType.LPStr)] string SymbolPath, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ImageFilePath, IntPtr Callback, IntPtr CallerData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_FindExecutableImageEx' -Namespace Win32 -PassThru
# $api::FindExecutableImageEx(FileName, SymbolPath, ImageFilePath, Callback, CallerData)

#uselib "dbghelp.dll"
#func global FindExecutableImageEx "FindExecutableImageEx" sptr, sptr, sptr, sptr, sptr
; FindExecutableImageEx FileName, SymbolPath, varptr(ImageFilePath), Callback, CallerData   ; 戻り値は stat
; FileName : LPCSTR -> "sptr"
; SymbolPath : LPCSTR -> "sptr"
; ImageFilePath : LPSTR out -> "sptr"
; Callback : PFIND_EXE_FILE_CALLBACK optional -> "sptr"
; CallerData : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dbghelp.dll"
#cfunc global FindExecutableImageEx "FindExecutableImageEx" str, str, var, sptr, sptr
; res = FindExecutableImageEx(FileName, SymbolPath, ImageFilePath, Callback, CallerData)
; FileName : LPCSTR -> "str"
; SymbolPath : LPCSTR -> "str"
; ImageFilePath : LPSTR out -> "var"
; Callback : PFIND_EXE_FILE_CALLBACK optional -> "sptr"
; CallerData : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dbghelp.dll"
#cfunc global FindExecutableImageEx "FindExecutableImageEx" str, str, sptr, sptr, sptr
; res = FindExecutableImageEx(FileName, SymbolPath, varptr(ImageFilePath), Callback, CallerData)
; FileName : LPCSTR -> "str"
; SymbolPath : LPCSTR -> "str"
; ImageFilePath : LPSTR out -> "sptr"
; Callback : PFIND_EXE_FILE_CALLBACK optional -> "sptr"
; CallerData : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。