Win32 API 日本語リファレンス
ホームSystem.LibraryLoader › GetModuleHandleExA

GetModuleHandleExA

関数
フラグ指定でモジュールハンドルをANSI名で取得する。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL GetModuleHandleExA(
    DWORD dwFlags,
    LPCSTR lpModuleName,   // optional
    HMODULE* phModule
);

パラメーター

名前方向説明
dwFlagsDWORDin

このパラメーターには 0、または次の値のうち 1 つ以上を指定できます。モジュールの参照カウントがインクリメントされた場合、呼び出し元はモジュールハンドルが不要になった時点で FreeLibrary 関数を使用して参照カウントをデクリメントする必要があります。

GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS (0x00000004)

lpModuleName パラメーターはモジュール内のアドレスです。

GET_MODULE_HANDLE_EX_FLAG_PIN (0x00000001)

FreeLibrary が何回呼び出されても、モジュールはプロセスが終了するまで読み込まれたままになります。

このオプションは GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT と併用できません。

GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT (0x00000002)

モジュールの参照カウントはインクリメントされません。このオプションは GetModuleHandle の動作と同等です。取得したモジュールハンドルを FreeLibrary 関数に渡さないでください。渡すと DLL が早期にマップ解除される可能性があります。詳細については「解説」を参照してください。

このオプションは GET_MODULE_HANDLE_EX_FLAG_PIN と併用できません。

lpModuleNameLPCSTRinoptional

読み込まれたモジュール (.dll または .exe ファイル) の名前、または (dwFlagsGET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS の場合) モジュール内のアドレスです。

モジュール名を指定する場合、ファイル名の拡張子を省略すると、既定のライブラリ拡張子 .dll が付加されます。モジュール名に拡張子がないことを示すには、ファイル名文字列の末尾にピリオド文字 (.) を含めることができます。文字列でパスを指定する必要はありません。パスを指定する場合は、スラッシュ (/) ではなくバックスラッシュ (\) を使用してください。この名前は、呼び出し元プロセスのアドレス空間に現在マップされているモジュールの名前と (大文字小文字を区別せずに) 比較されます。

このパラメーターが NULL の場合、関数は呼び出し元プロセスの作成に使用されたファイル (.exe ファイル) へのハンドルを返します。

phModuleHMODULE*out

指定したモジュールへのハンドルです。関数が失敗した場合、このパラメーターは NULL になります。

GetModuleHandleEx 関数は、LOAD_LIBRARY_AS_DATAFILE フラグを使用して読み込まれたモジュールのハンドルは取得しません。詳細については LoadLibraryEx を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定したモジュールのモジュールハンドルを取得し、GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT が指定されていない限り、そのモジュールの参照カウントをインクリメントします。モジュールは呼び出し元プロセスによって読み込まれている必要があります。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには GetLastError を参照してください。

解説(Remarks)

返されるハンドルはグローバルでも継承可能でもありません。複製したり、他のプロセスで使用したりすることはできません。

lpModuleName にパスが含まれておらず、同じベース名と拡張子を持つ読み込み済みモジュールが複数存在する場合、どのモジュールハンドルが返されるかは予測できません。この問題を回避するには、パスを指定する、side-by-side アセンブリ を使用する、または lpModuleName パラメーターに DLL 名ではなくメモリ位置を指定します。

dwFlagsGET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT が含まれている場合、GetModuleHandleEx 関数は参照カウントをインクリメントせずにマップ済みモジュールへのハンドルを返します。ただし、このハンドルを FreeLibrary 関数に渡すと、マップ済みモジュールの参照カウントがデクリメントされます。したがって、GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT を指定した GetModuleHandleEx が返したハンドルを FreeLibrary 関数に渡さないでください。渡すと、DLL モジュールが早期にマップ解除される可能性があります。

dwFlagsGET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT が含まれている場合、この関数はマルチスレッドアプリケーションでは慎重に使用する必要があります。この関数がハンドルを返してから実際に使用されるまでの間、モジュールハンドルが有効なままである保証はありません。たとえば、あるスレッドがモジュールハンドルを取得し、それを使用する前に別のスレッドがそのモジュールを解放したとします。システムが別のモジュールを読み込むと、最近解放されたモジュールハンドルが再利用される可能性があります。その結果、最初のスレッドは意図したものとは異なるモジュールのハンドルを持つことになります。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0501 以降として定義します。詳細については Using the Windows Headers を参照してください。

メモ

libloaderapi.h ヘッダーは GetModuleHandleEx をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング中立なエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

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

BOOL GetModuleHandleExA(
    DWORD dwFlags,
    LPCSTR lpModuleName,   // optional
    HMODULE* phModule
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetModuleHandleExA(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string lpModuleName,   // LPCSTR optional
    IntPtr phModule   // HMODULE* out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetModuleHandleExA(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpModuleName As String,   ' LPCSTR optional
    phModule As IntPtr   ' HMODULE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwFlags : DWORD
' lpModuleName : LPCSTR optional
' phModule : HMODULE* out
Declare PtrSafe Function GetModuleHandleExA Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal lpModuleName As String, _
    ByVal phModule As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetModuleHandleExA = ctypes.windll.kernel32.GetModuleHandleExA
GetModuleHandleExA.restype = wintypes.BOOL
GetModuleHandleExA.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCSTR,  # lpModuleName : LPCSTR optional
    ctypes.c_void_p,  # phModule : HMODULE* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetModuleHandleExA = kernel32.NewProc("GetModuleHandleExA")
)

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

extern "kernel32" fn GetModuleHandleExA(
    dwFlags: u32, // DWORD
    lpModuleName: [*c]const u8, // LPCSTR optional
    phModule: ?*anyopaque // HMODULE* out
) callconv(std.os.windows.WINAPI) i32;
proc GetModuleHandleExA(
    dwFlags: uint32,  # DWORD
    lpModuleName: cstring,  # LPCSTR optional
    phModule: pointer  # HMODULE* out
): int32 {.importc: "GetModuleHandleExA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int GetModuleHandleExA(
    uint dwFlags,   // DWORD
    const(char)* lpModuleName,   // LPCSTR optional
    void* phModule   // HMODULE* out
);
ccall((:GetModuleHandleExA, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, Cstring, Ptr{Cvoid}),
      dwFlags, lpModuleName, phModule)
# dwFlags : DWORD -> UInt32
# lpModuleName : LPCSTR optional -> Cstring
# phModule : HMODULE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetModuleHandleExA(
    uint32_t dwFlags,
    const char* lpModuleName,
    void* phModule);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetModuleHandleExA(dwFlags, lpModuleName, phModule)
-- dwFlags : DWORD
-- lpModuleName : LPCSTR optional
-- phModule : HMODULE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetModuleHandleExA = lib.func('__stdcall', 'GetModuleHandleExA', 'int32_t', ['uint32_t', 'str', 'void *']);
// GetModuleHandleExA(dwFlags, lpModuleName, phModule)
// dwFlags : DWORD -> 'uint32_t'
// lpModuleName : LPCSTR optional -> 'str'
// phModule : HMODULE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetModuleHandleExA: { parameters: ["u32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.GetModuleHandleExA(dwFlags, lpModuleName, phModule)
// dwFlags : DWORD -> "u32"
// lpModuleName : LPCSTR optional -> "buffer"
// phModule : HMODULE* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetModuleHandleExA(
    uint32_t dwFlags,
    const char* lpModuleName,
    void* phModule);
C, "KERNEL32.dll");
// $ffi->GetModuleHandleExA(dwFlags, lpModuleName, phModule);
// dwFlags : DWORD
// lpModuleName : LPCSTR optional
// phModule : HMODULE* out
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.ASCII_OPTIONS);
    boolean GetModuleHandleExA(
        int dwFlags,   // DWORD
        String lpModuleName,   // LPCSTR optional
        Pointer phModule   // HMODULE* out
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GetModuleHandleExA = GetModuleHandleExA(
    dwFlags : UInt32,   # DWORD
    lpModuleName : UInt8*,   # LPCSTR optional
    phModule : Void*   # HMODULE* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetModuleHandleExANative = Int32 Function(Uint32, Pointer<Utf8>, Pointer<Void>);
typedef GetModuleHandleExADart = int Function(int, Pointer<Utf8>, Pointer<Void>);
final GetModuleHandleExA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetModuleHandleExANative, GetModuleHandleExADart>('GetModuleHandleExA');
// dwFlags : DWORD -> Uint32
// lpModuleName : LPCSTR optional -> Pointer<Utf8>
// phModule : HMODULE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetModuleHandleExA(
  dwFlags: DWORD;   // DWORD
  lpModuleName: PAnsiChar;   // LPCSTR optional
  phModule: Pointer   // HMODULE* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetModuleHandleExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetModuleHandleExA"
  c_GetModuleHandleExA :: Word32 -> CString -> Ptr () -> IO CInt
-- dwFlags : DWORD -> Word32
-- lpModuleName : LPCSTR optional -> CString
-- phModule : HMODULE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getmodulehandleexa =
  foreign "GetModuleHandleExA"
    (uint32_t @-> string @-> (ptr void) @-> returning int32_t)
(* dwFlags : DWORD -> uint32_t *)
(* lpModuleName : LPCSTR optional -> string *)
(* phModule : HMODULE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetModuleHandleExA" get-module-handle-ex-a :convention :stdcall) :int32
  (dw-flags :uint32)   ; DWORD
  (lp-module-name :string)   ; LPCSTR optional
  (ph-module :pointer))   ; HMODULE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetModuleHandleExA = Win32::API::More->new('KERNEL32',
    'BOOL GetModuleHandleExA(DWORD dwFlags, LPCSTR lpModuleName, HANDLE phModule)');
# my $ret = $GetModuleHandleExA->Call($dwFlags, $lpModuleName, $phModule);
# dwFlags : DWORD -> DWORD
# lpModuleName : LPCSTR optional -> LPCSTR
# phModule : HMODULE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
公式の関連項目