ホーム › System.Diagnostics.Debug › FindExecutableImageExW

FindExecutableImageExW

関数

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

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

シグネチャ

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

HANDLE FindExecutableImageExW(
    LPCWSTR FileName,
    LPCWSTR SymbolPath,
    LPWSTR ImageFilePath,
    PFIND_EXE_FILE_CALLBACKW Callback,   // optional
    void* CallerData
);

パラメーター

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

戻り値の型: HANDLE

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

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

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 FindExecutableImageExW(
    LPCWSTR FileName,
    LPCWSTR SymbolPath,
    LPWSTR ImageFilePath,
    PFIND_EXE_FILE_CALLBACKW Callback,   // optional
    void* CallerData
);

[DllImport("dbghelp.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr FindExecutableImageExW(
    [MarshalAs(UnmanagedType.LPWStr)] string FileName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string SymbolPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ImageFilePath,   // LPWSTR out
    IntPtr Callback,   // PFIND_EXE_FILE_CALLBACKW optional
    IntPtr CallerData   // void*
);

<DllImport("dbghelp.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FindExecutableImageExW(
    <MarshalAs(UnmanagedType.LPWStr)> FileName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> SymbolPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> ImageFilePath As System.Text.StringBuilder,   ' LPWSTR out
    Callback As IntPtr,   ' PFIND_EXE_FILE_CALLBACKW optional
    CallerData As IntPtr   ' void*
) As IntPtr
End Function

' FileName : LPCWSTR
' SymbolPath : LPCWSTR
' ImageFilePath : LPWSTR out
' Callback : PFIND_EXE_FILE_CALLBACKW optional
' CallerData : void*
Declare PtrSafe Function FindExecutableImageExW Lib "dbghelp" ( _
    ByVal FileName As LongPtr, _
    ByVal SymbolPath 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

FindExecutableImageExW = ctypes.windll.dbghelp.FindExecutableImageExW
FindExecutableImageExW.restype = ctypes.c_void_p
FindExecutableImageExW.argtypes = [
    wintypes.LPCWSTR,  # FileName : LPCWSTR
    wintypes.LPCWSTR,  # SymbolPath : LPCWSTR
    wintypes.LPWSTR,  # ImageFilePath : LPWSTR out
    ctypes.c_void_p,  # Callback : PFIND_EXE_FILE_CALLBACKW optional
    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')
FindExecutableImageExW = Fiddle::Function.new(
  lib['FindExecutableImageExW'],
  [
    Fiddle::TYPE_VOIDP,  # FileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # SymbolPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ImageFilePath : LPWSTR out
    Fiddle::TYPE_VOIDP,  # Callback : PFIND_EXE_FILE_CALLBACKW optional
    Fiddle::TYPE_VOIDP,  # CallerData : void*
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "dbghelp")]
extern "system" {
    fn FindExecutableImageExW(
        FileName: *const u16,  // LPCWSTR
        SymbolPath: *const u16,  // LPCWSTR
        ImageFilePath: *mut u16,  // LPWSTR out
        Callback: *const core::ffi::c_void,  // PFIND_EXE_FILE_CALLBACKW optional
        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 FindExecutableImageExW([MarshalAs(UnmanagedType.LPWStr)] string FileName, [MarshalAs(UnmanagedType.LPWStr)] string SymbolPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ImageFilePath, IntPtr Callback, IntPtr CallerData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dbghelp_FindExecutableImageExW' -Namespace Win32 -PassThru
# $api::FindExecutableImageExW(FileName, SymbolPath, ImageFilePath, Callback, CallerData)

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

出力引数:

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