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

BindImageEx

関数
コールバック付きでイメージのインポート参照を束縛する拡張版である。
DLLimagehlp.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL BindImageEx(
    DWORD Flags,
    LPCSTR ImageName,
    LPCSTR DllPath,
    LPCSTR SymbolPath,
    PIMAGEHLP_STATUS_ROUTINE StatusRoutine   // optional
);

パラメーター

名前方向説明
FlagsDWORDin

バインドオプション。このパラメーターには、次の値の組み合わせを指定できます。

意味
BIND_ALL_IMAGES
0x00000004
このファイルの呼び出しツリー内のすべてのイメージをバインドします。
BIND_CACHE_IMPORT_DLLS
0x00000008
呼び出し間でキャッシュ内の DLL 情報を破棄しません。これにより、多数のイメージをバインドする際のパフォーマンスが向上します。
BIND_NO_BOUND_IMPORTS
0x00000001
新しいインポートアドレステーブルを生成しません。
BIND_NO_UPDATE
0x00000002
ファイルに変更を加えません。
ImageNameLPCSTRinバインドするファイルの名前。この値には、ファイル名、部分パス、または完全パスを指定できます。
DllPathLPCSTRinImageName パラメーターで指定したファイルを開けない場合に使用する検索パスのルート。
SymbolPathLPCSTRinファイルに対応するシンボルファイルを検索するパスのルート。
StatusRoutinePIMAGEHLP_STATUS_ROUTINEinoptionalステータスルーチンへのポインター。ステータスルーチンは、イメージのバインドの進行中に呼び出されます。詳細については、 StatusRoutine を参照してください。

戻り値の型: BOOL

公式ドキュメント

インポートされる各関数の仮想アドレスを計算します。

戻り値

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

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

解説(Remarks)

イメージのバインドの処理は、インポートされた各関数の仮想アドレスを計算することで構成されます。計算された仮想アドレスは、インポート元イメージのインポートアドレステーブル (IAT) に保存されます。その結果、システムローダーはインポートされた各関数のアドレスを計算する必要がなくなるため、特に多数の DLL を使用する場合に、イメージの読み込みが大幅に高速化されます。

対応するシンボルファイルが見つかった場合は、そのタイムスタンプとチェックサムが更新されます。

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

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

各言語での呼び出し定義

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

BOOL BindImageEx(
    DWORD Flags,
    LPCSTR ImageName,
    LPCSTR DllPath,
    LPCSTR SymbolPath,
    PIMAGEHLP_STATUS_ROUTINE StatusRoutine   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("imagehlp.dll", SetLastError = true, ExactSpelling = true)]
static extern bool BindImageEx(
    uint Flags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string ImageName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string DllPath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string SymbolPath,   // LPCSTR
    IntPtr StatusRoutine   // PIMAGEHLP_STATUS_ROUTINE optional
);
<DllImport("imagehlp.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BindImageEx(
    Flags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> ImageName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> DllPath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> SymbolPath As String,   ' LPCSTR
    StatusRoutine As IntPtr   ' PIMAGEHLP_STATUS_ROUTINE optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Flags : DWORD
' ImageName : LPCSTR
' DllPath : LPCSTR
' SymbolPath : LPCSTR
' StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional
Declare PtrSafe Function BindImageEx Lib "imagehlp" ( _
    ByVal Flags As Long, _
    ByVal ImageName As String, _
    ByVal DllPath As String, _
    ByVal SymbolPath As String, _
    ByVal StatusRoutine As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BindImageEx = ctypes.windll.imagehlp.BindImageEx
BindImageEx.restype = wintypes.BOOL
BindImageEx.argtypes = [
    wintypes.DWORD,  # Flags : DWORD
    wintypes.LPCSTR,  # ImageName : LPCSTR
    wintypes.LPCSTR,  # DllPath : LPCSTR
    wintypes.LPCSTR,  # SymbolPath : LPCSTR
    ctypes.c_void_p,  # StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	imagehlp = windows.NewLazySystemDLL("imagehlp.dll")
	procBindImageEx = imagehlp.NewProc("BindImageEx")
)

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

extern "imagehlp" fn BindImageEx(
    Flags: u32, // DWORD
    ImageName: [*c]const u8, // LPCSTR
    DllPath: [*c]const u8, // LPCSTR
    SymbolPath: [*c]const u8, // LPCSTR
    StatusRoutine: ?*anyopaque // PIMAGEHLP_STATUS_ROUTINE optional
) callconv(std.os.windows.WINAPI) i32;
proc BindImageEx(
    Flags: uint32,  # DWORD
    ImageName: cstring,  # LPCSTR
    DllPath: cstring,  # LPCSTR
    SymbolPath: cstring,  # LPCSTR
    StatusRoutine: pointer  # PIMAGEHLP_STATUS_ROUTINE optional
): int32 {.importc: "BindImageEx", stdcall, dynlib: "imagehlp.dll".}
pragma(lib, "imagehlp");
extern(Windows)
int BindImageEx(
    uint Flags,   // DWORD
    const(char)* ImageName,   // LPCSTR
    const(char)* DllPath,   // LPCSTR
    const(char)* SymbolPath,   // LPCSTR
    void* StatusRoutine   // PIMAGEHLP_STATUS_ROUTINE optional
);
ccall((:BindImageEx, "imagehlp.dll"), stdcall, Int32,
      (UInt32, Cstring, Cstring, Cstring, Ptr{Cvoid}),
      Flags, ImageName, DllPath, SymbolPath, StatusRoutine)
# Flags : DWORD -> UInt32
# ImageName : LPCSTR -> Cstring
# DllPath : LPCSTR -> Cstring
# SymbolPath : LPCSTR -> Cstring
# StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BindImageEx(
    uint32_t Flags,
    const char* ImageName,
    const char* DllPath,
    const char* SymbolPath,
    void* StatusRoutine);
]]
local imagehlp = ffi.load("imagehlp")
-- imagehlp.BindImageEx(Flags, ImageName, DllPath, SymbolPath, StatusRoutine)
-- Flags : DWORD
-- ImageName : LPCSTR
-- DllPath : LPCSTR
-- SymbolPath : LPCSTR
-- StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('imagehlp.dll');
const BindImageEx = lib.func('__stdcall', 'BindImageEx', 'int32_t', ['uint32_t', 'str', 'str', 'str', 'void *']);
// BindImageEx(Flags, ImageName, DllPath, SymbolPath, StatusRoutine)
// Flags : DWORD -> 'uint32_t'
// ImageName : LPCSTR -> 'str'
// DllPath : LPCSTR -> 'str'
// SymbolPath : LPCSTR -> 'str'
// StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("imagehlp.dll", {
  BindImageEx: { parameters: ["u32", "buffer", "buffer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.BindImageEx(Flags, ImageName, DllPath, SymbolPath, StatusRoutine)
// Flags : DWORD -> "u32"
// ImageName : LPCSTR -> "buffer"
// DllPath : LPCSTR -> "buffer"
// SymbolPath : LPCSTR -> "buffer"
// StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BindImageEx(
    uint32_t Flags,
    const char* ImageName,
    const char* DllPath,
    const char* SymbolPath,
    void* StatusRoutine);
C, "imagehlp.dll");
// $ffi->BindImageEx(Flags, ImageName, DllPath, SymbolPath, StatusRoutine);
// Flags : DWORD
// ImageName : LPCSTR
// DllPath : LPCSTR
// SymbolPath : LPCSTR
// StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional
// 構造体/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 Imagehlp extends StdCallLibrary {
    Imagehlp INSTANCE = Native.load("imagehlp", Imagehlp.class);
    boolean BindImageEx(
        int Flags,   // DWORD
        String ImageName,   // LPCSTR
        String DllPath,   // LPCSTR
        String SymbolPath,   // LPCSTR
        Callback StatusRoutine   // PIMAGEHLP_STATUS_ROUTINE optional
    );
}
@[Link("imagehlp")]
lib Libimagehlp
  fun BindImageEx = BindImageEx(
    Flags : UInt32,   # DWORD
    ImageName : UInt8*,   # LPCSTR
    DllPath : UInt8*,   # LPCSTR
    SymbolPath : UInt8*,   # LPCSTR
    StatusRoutine : Void*   # PIMAGEHLP_STATUS_ROUTINE optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef BindImageExNative = Int32 Function(Uint32, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
typedef BindImageExDart = int Function(int, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>);
final BindImageEx = DynamicLibrary.open('imagehlp.dll')
    .lookupFunction<BindImageExNative, BindImageExDart>('BindImageEx');
// Flags : DWORD -> Uint32
// ImageName : LPCSTR -> Pointer<Utf8>
// DllPath : LPCSTR -> Pointer<Utf8>
// SymbolPath : LPCSTR -> Pointer<Utf8>
// StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BindImageEx(
  Flags: DWORD;   // DWORD
  ImageName: PAnsiChar;   // LPCSTR
  DllPath: PAnsiChar;   // LPCSTR
  SymbolPath: PAnsiChar;   // LPCSTR
  StatusRoutine: Pointer   // PIMAGEHLP_STATUS_ROUTINE optional
): BOOL; stdcall;
  external 'imagehlp.dll' name 'BindImageEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BindImageEx"
  c_BindImageEx :: Word32 -> CString -> CString -> CString -> Ptr () -> IO CInt
-- Flags : DWORD -> Word32
-- ImageName : LPCSTR -> CString
-- DllPath : LPCSTR -> CString
-- SymbolPath : LPCSTR -> CString
-- StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bindimageex =
  foreign "BindImageEx"
    (uint32_t @-> string @-> string @-> string @-> (ptr void) @-> returning int32_t)
(* Flags : DWORD -> uint32_t *)
(* ImageName : LPCSTR -> string *)
(* DllPath : LPCSTR -> string *)
(* SymbolPath : LPCSTR -> string *)
(* StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library imagehlp (t "imagehlp.dll"))
(cffi:use-foreign-library imagehlp)

(cffi:defcfun ("BindImageEx" bind-image-ex :convention :stdcall) :int32
  (flags :uint32)   ; DWORD
  (image-name :string)   ; LPCSTR
  (dll-path :string)   ; LPCSTR
  (symbol-path :string)   ; LPCSTR
  (status-routine :pointer))   ; PIMAGEHLP_STATUS_ROUTINE optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BindImageEx = Win32::API::More->new('imagehlp',
    'BOOL BindImageEx(DWORD Flags, LPCSTR ImageName, LPCSTR DllPath, LPCSTR SymbolPath, LPVOID StatusRoutine)');
# my $ret = $BindImageEx->Call($Flags, $ImageName, $DllPath, $SymbolPath, $StatusRoutine);
# Flags : DWORD -> DWORD
# ImageName : LPCSTR -> LPCSTR
# DllPath : LPCSTR -> LPCSTR
# SymbolPath : LPCSTR -> LPCSTR
# StatusRoutine : PIMAGEHLP_STATUS_ROUTINE optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

類似 API
使用する型