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

GetModuleHandleExW

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

シグネチャ

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

BOOL GetModuleHandleExW(
    DWORD dwFlags,
    LPCWSTR lpModuleName,   // optional
    HMODULE* phModule
);

パラメーター

名前方向説明
dwFlagsDWORDin

このパラメーターには、ゼロ、または次の値のうち 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 と併用できません。

lpModuleNameLPCWSTRinoptional

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

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

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

phModuleHMODULE*out

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

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

- dwFlags.GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS (0x00000004)

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

- dwFlags.GET_MODULE_HANDLE_EX_FLAG_PIN (0x00000001)

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

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

- dwFlags.GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT (0x00000002)

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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 以降として定義します。詳細については Windows ヘッダーの使用を参照してください。

メモ

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

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

各言語での呼び出し定義

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

BOOL GetModuleHandleExW(
    DWORD dwFlags,
    LPCWSTR lpModuleName,   // optional
    HMODULE* phModule
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetModuleHandleExW(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpModuleName,   // LPCWSTR optional
    IntPtr phModule   // HMODULE* out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetModuleHandleExW(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpModuleName As String,   ' LPCWSTR optional
    phModule As IntPtr   ' HMODULE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' dwFlags : DWORD
' lpModuleName : LPCWSTR optional
' phModule : HMODULE* out
Declare PtrSafe Function GetModuleHandleExW Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal lpModuleName As LongPtr, _
    ByVal phModule As LongPtr) As Long
' 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

GetModuleHandleExW = ctypes.windll.kernel32.GetModuleHandleExW
GetModuleHandleExW.restype = wintypes.BOOL
GetModuleHandleExW.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # lpModuleName : LPCWSTR 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')
GetModuleHandleExW = Fiddle::Function.new(
  lib['GetModuleHandleExW'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpModuleName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # phModule : HMODULE* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetModuleHandleExW(
        dwFlags: u32,  // DWORD
        lpModuleName: *const u16,  // LPCWSTR 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.Unicode, SetLastError = true)]
public static extern bool GetModuleHandleExW(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpModuleName, IntPtr phModule);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetModuleHandleExW' -Namespace Win32 -PassThru
# $api::GetModuleHandleExW(dwFlags, lpModuleName, phModule)
#uselib "KERNEL32.dll"
#func global GetModuleHandleExW "GetModuleHandleExW" wptr, wptr, wptr
; GetModuleHandleExW dwFlags, lpModuleName, phModule   ; 戻り値は stat
; dwFlags : DWORD -> "wptr"
; lpModuleName : LPCWSTR optional -> "wptr"
; phModule : HMODULE* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetModuleHandleExW "GetModuleHandleExW" int, wstr, sptr
; res = GetModuleHandleExW(dwFlags, lpModuleName, phModule)
; dwFlags : DWORD -> "int"
; lpModuleName : LPCWSTR optional -> "wstr"
; phModule : HMODULE* out -> "sptr"
; BOOL GetModuleHandleExW(DWORD dwFlags, LPCWSTR lpModuleName, HMODULE* phModule)
#uselib "KERNEL32.dll"
#cfunc global GetModuleHandleExW "GetModuleHandleExW" int, wstr, intptr
; res = GetModuleHandleExW(dwFlags, lpModuleName, phModule)
; dwFlags : DWORD -> "int"
; lpModuleName : LPCWSTR optional -> "wstr"
; phModule : HMODULE* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetModuleHandleExW = kernel32.NewProc("GetModuleHandleExW")
)

// dwFlags (DWORD), lpModuleName (LPCWSTR optional), phModule (HMODULE* out)
r1, _, err := procGetModuleHandleExW.Call(
	uintptr(dwFlags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpModuleName))),
	uintptr(phModule),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetModuleHandleExW(
  dwFlags: DWORD;   // DWORD
  lpModuleName: PWideChar;   // LPCWSTR optional
  phModule: Pointer   // HMODULE* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetModuleHandleExW';
result := DllCall("KERNEL32\GetModuleHandleExW"
    , "UInt", dwFlags   ; DWORD
    , "WStr", lpModuleName   ; LPCWSTR optional
    , "Ptr", phModule   ; HMODULE* out
    , "Int")   ; return: BOOL
●GetModuleHandleExW(dwFlags, lpModuleName, phModule) = DLL("KERNEL32.dll", "bool GetModuleHandleExW(dword, char*, void*)")
# 呼び出し: GetModuleHandleExW(dwFlags, lpModuleName, phModule)
# dwFlags : DWORD -> "dword"
# lpModuleName : LPCWSTR optional -> "char*"
# phModule : HMODULE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn GetModuleHandleExW(
    dwFlags: u32, // DWORD
    lpModuleName: [*c]const u16, // LPCWSTR optional
    phModule: ?*anyopaque // HMODULE* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetModuleHandleExW(
    dwFlags: uint32,  # DWORD
    lpModuleName: WideCString,  # LPCWSTR optional
    phModule: pointer  # HMODULE* out
): int32 {.importc: "GetModuleHandleExW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
int GetModuleHandleExW(
    uint dwFlags,   // DWORD
    const(wchar)* lpModuleName,   // LPCWSTR optional
    void* phModule   // HMODULE* out
);
ccall((:GetModuleHandleExW, "KERNEL32.dll"), stdcall, Int32,
      (UInt32, Cwstring, Ptr{Cvoid}),
      dwFlags, lpModuleName, phModule)
# dwFlags : DWORD -> UInt32
# lpModuleName : LPCWSTR optional -> Cwstring
# phModule : HMODULE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetModuleHandleExW(
    uint32_t dwFlags,
    const uint16_t* lpModuleName,
    void* phModule);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetModuleHandleExW(dwFlags, lpModuleName, phModule)
-- dwFlags : DWORD
-- lpModuleName : LPCWSTR optional
-- phModule : HMODULE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GetModuleHandleExW = lib.func('__stdcall', 'GetModuleHandleExW', 'int32_t', ['uint32_t', 'str16', 'void *']);
// GetModuleHandleExW(dwFlags, lpModuleName, phModule)
// dwFlags : DWORD -> 'uint32_t'
// lpModuleName : LPCWSTR optional -> 'str16'
// phModule : HMODULE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetModuleHandleExW: { parameters: ["u32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.GetModuleHandleExW(dwFlags, lpModuleName, phModule)
// dwFlags : DWORD -> "u32"
// lpModuleName : LPCWSTR optional -> "buffer"
// phModule : HMODULE* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetModuleHandleExW(
    uint32_t dwFlags,
    const uint16_t* lpModuleName,
    void* phModule);
C, "KERNEL32.dll");
// $ffi->GetModuleHandleExW(dwFlags, lpModuleName, phModule);
// dwFlags : DWORD
// lpModuleName : LPCWSTR 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.UNICODE_OPTIONS);
    boolean GetModuleHandleExW(
        int dwFlags,   // DWORD
        WString lpModuleName,   // LPCWSTR optional
        Pointer phModule   // HMODULE* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetModuleHandleExW = GetModuleHandleExW(
    dwFlags : UInt32,   # DWORD
    lpModuleName : UInt16*,   # LPCWSTR 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 GetModuleHandleExWNative = Int32 Function(Uint32, Pointer<Utf16>, Pointer<Void>);
typedef GetModuleHandleExWDart = int Function(int, Pointer<Utf16>, Pointer<Void>);
final GetModuleHandleExW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetModuleHandleExWNative, GetModuleHandleExWDart>('GetModuleHandleExW');
// dwFlags : DWORD -> Uint32
// lpModuleName : LPCWSTR optional -> Pointer<Utf16>
// phModule : HMODULE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetModuleHandleExW(
  dwFlags: DWORD;   // DWORD
  lpModuleName: PWideChar;   // LPCWSTR optional
  phModule: Pointer   // HMODULE* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetModuleHandleExW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let getmodulehandleexw =
  foreign "GetModuleHandleExW"
    (uint32_t @-> (ptr uint16_t) @-> (ptr void) @-> returning int32_t)
(* dwFlags : DWORD -> uint32_t *)
(* lpModuleName : LPCWSTR optional -> (ptr uint16_t) *)
(* 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 ("GetModuleHandleExW" get-module-handle-ex-w :convention :stdcall) :int32
  (dw-flags :uint32)   ; DWORD
  (lp-module-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (ph-module :pointer))   ; HMODULE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetModuleHandleExW = Win32::API::More->new('KERNEL32',
    'BOOL GetModuleHandleExW(DWORD dwFlags, LPCWSTR lpModuleName, HANDLE phModule)');
# my $ret = $GetModuleHandleExW->Call($dwFlags, $lpModuleName, $phModule);
# dwFlags : DWORD -> DWORD
# lpModuleName : LPCWSTR optional -> LPCWSTR
# phModule : HMODULE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API