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

GetModuleHandleW

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

シグネチャ

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

HMODULE GetModuleHandleW(
    LPCWSTR lpModuleName   // optional
);

パラメーター

名前方向説明
lpModuleNameLPCWSTRinoptional

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

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

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

戻り値の型: HMODULE

公式ドキュメント

指定されたモジュールのモジュールハンドルを取得します。モジュールは、呼び出し元のプロセスによって既に読み込まれている必要があります。(Unicode)

戻り値

関数が成功すると、戻り値は指定されたモジュールへのハンドルです。

関数が失敗すると、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

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

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

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

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

例については、 Using Brushes を参照してください。

メモ

libloaderapi.h ヘッダーは GetModuleHandle を、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  (Unicode / -W)
#include <windows.h>

HMODULE GetModuleHandleW(
    LPCWSTR lpModuleName   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr GetModuleHandleW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpModuleName   // LPCWSTR optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetModuleHandleW(
    <MarshalAs(UnmanagedType.LPWStr)> lpModuleName As String   ' LPCWSTR optional
) As IntPtr
End Function
' lpModuleName : LPCWSTR optional
Declare PtrSafe Function GetModuleHandleW Lib "kernel32" ( _
    ByVal lpModuleName 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

GetModuleHandleW = ctypes.windll.kernel32.GetModuleHandleW
GetModuleHandleW.restype = ctypes.c_void_p
GetModuleHandleW.argtypes = [
    wintypes.LPCWSTR,  # lpModuleName : LPCWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetModuleHandleW = Fiddle::Function.new(
  lib['GetModuleHandleW'],
  [
    Fiddle::TYPE_VOIDP,  # lpModuleName : LPCWSTR optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetModuleHandleW(
        lpModuleName: *const u16  // LPCWSTR optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr GetModuleHandleW([MarshalAs(UnmanagedType.LPWStr)] string lpModuleName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetModuleHandleW' -Namespace Win32 -PassThru
# $api::GetModuleHandleW(lpModuleName)
#uselib "KERNEL32.dll"
#func global GetModuleHandleW "GetModuleHandleW" wptr
; GetModuleHandleW lpModuleName   ; 戻り値は stat
; lpModuleName : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global GetModuleHandleW "GetModuleHandleW" wstr
; res = GetModuleHandleW(lpModuleName)
; lpModuleName : LPCWSTR optional -> "wstr"
; HMODULE GetModuleHandleW(LPCWSTR lpModuleName)
#uselib "KERNEL32.dll"
#cfunc global GetModuleHandleW "GetModuleHandleW" wstr
; res = GetModuleHandleW(lpModuleName)
; lpModuleName : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetModuleHandleW = kernel32.NewProc("GetModuleHandleW")
)

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

extern "kernel32" fn GetModuleHandleW(
    lpModuleName: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetModuleHandleW(
    lpModuleName: WideCString  # LPCWSTR optional
): pointer {.importc: "GetModuleHandleW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
void* GetModuleHandleW(
    const(wchar)* lpModuleName   // LPCWSTR optional
);
ccall((:GetModuleHandleW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Cwstring,),
      lpModuleName)
# lpModuleName : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* GetModuleHandleW(
    const uint16_t* lpModuleName);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GetModuleHandleW(lpModuleName)
-- lpModuleName : LPCWSTR optional
-- 構造体/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 GetModuleHandleW = lib.func('__stdcall', 'GetModuleHandleW', 'void *', ['str16']);
// GetModuleHandleW(lpModuleName)
// lpModuleName : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GetModuleHandleW: { parameters: ["buffer"], result: "pointer" },
});
// lib.symbols.GetModuleHandleW(lpModuleName)
// lpModuleName : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* GetModuleHandleW(
    const uint16_t* lpModuleName);
C, "KERNEL32.dll");
// $ffi->GetModuleHandleW(lpModuleName);
// lpModuleName : LPCWSTR 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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
    Pointer GetModuleHandleW(
        WString lpModuleName   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun GetModuleHandleW = GetModuleHandleW(
    lpModuleName : UInt16*   # LPCWSTR optional
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetModuleHandleWNative = Pointer<Void> Function(Pointer<Utf16>);
typedef GetModuleHandleWDart = Pointer<Void> Function(Pointer<Utf16>);
final GetModuleHandleW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetModuleHandleWNative, GetModuleHandleWDart>('GetModuleHandleW');
// lpModuleName : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetModuleHandleW(
  lpModuleName: PWideChar   // LPCWSTR optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'GetModuleHandleW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetModuleHandleW"
  c_GetModuleHandleW :: CWString -> IO (Ptr ())
-- lpModuleName : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getmodulehandlew =
  foreign "GetModuleHandleW"
    ((ptr uint16_t) @-> returning (ptr void))
(* lpModuleName : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetModuleHandleW" get-module-handle-w :convention :stdcall) :pointer
  (lp-module-name (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetModuleHandleW = Win32::API::More->new('KERNEL32',
    'HANDLE GetModuleHandleW(LPCWSTR lpModuleName)');
# my $ret = $GetModuleHandleW->Call($lpModuleName);
# lpModuleName : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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