ホーム › System.Diagnostics.Debug › FindExecutableImage

FindExecutableImage

関数

シンボルパスから実行イメージファイルを検索する。

DLLdbghelp.dll呼出規約winapiSetLastErrorあり

シグネチャ

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

HANDLE FindExecutableImage(
    LPCSTR FileName,
    LPCSTR SymbolPath,
    LPSTR ImageFilePath
);

パラメーター

名前	型	方向	説明
FileName	LPCSTR	in	場所を特定するシンボルファイルの名前。このパラメーターには部分的なパスを指定できます。
SymbolPath	LPCSTR	in	シンボルファイルが配置されているパス。セミコロンで区切って複数のパスを指定できます。シンボルパスを取得するには、 SymGetSearchPath 関数を使用します。
ImageFilePath	LPSTR	out	実行可能ファイルのフルパスを受け取るバッファーへのポインター。このバッファーは少なくとも MAX_PATH+1 文字分の大きさが必要です。

戻り値の型: HANDLE

公式ドキュメント

実行可能ファイルの場所を特定します。

戻り値

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

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

解説(Remarks)

FindExecutableImage 関数は、1 回の関数呼び出しで複数の異なるディレクトリから実行可能ファイルの場所を特定できるように用意されています。SymbolPath パラメーターには複数のパスを指定でき、各パスはセミコロン (;) で区切ります。複数のパスを指定した場合、関数は各ディレクトリツリーを順に検索して実行可能ファイルを探します。ファイルが見つかると検索は停止します。したがって、SymbolPath にはパスを正しい順序で指定してください。

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

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

各言語での呼び出し定義

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

HANDLE FindExecutableImage(
    LPCSTR FileName,
    LPCSTR SymbolPath,
    LPSTR ImageFilePath
);

[DllImport("dbghelp.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindExecutableImage(
    [MarshalAs(UnmanagedType.LPStr)] string FileName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string SymbolPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ImageFilePath   // LPSTR out
);

<DllImport("dbghelp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindExecutableImage(
    <MarshalAs(UnmanagedType.LPStr)> FileName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> SymbolPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> ImageFilePath As System.Text.StringBuilder   ' LPSTR out
) As IntPtr
End Function

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

import ctypes
from ctypes import wintypes

FindExecutableImage = ctypes.windll.dbghelp.FindExecutableImage
FindExecutableImage.restype = ctypes.c_void_p
FindExecutableImage.argtypes = [
    wintypes.LPCSTR,  # FileName : LPCSTR
    wintypes.LPCSTR,  # SymbolPath : LPCSTR
    wintypes.LPSTR,  # ImageFilePath : LPSTR out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dbghelp.dll')
FindExecutableImage = Fiddle::Function.new(
  lib['FindExecutableImage'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCSTR
    Fiddle::TYPE_VOIDP,  # SymbolPath : LPCSTR
    Fiddle::TYPE_VOIDP,  # ImageFilePath : LPSTR out
  ],
  Fiddle::TYPE_VOIDP)

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

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

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

出力引数:

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