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

GetModuleHandleA

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

シグネチャ

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

HMODULE GetModuleHandleA(
    LPCSTR lpModuleName   // optional
);

パラメーター

名前方向説明
lpModuleNameLPCSTRinoptional

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

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

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

戻り値の型: HMODULE

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は指定したモジュールへのハンドルです。

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

解説(Remarks)

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

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

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

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

Examples

例については、 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  (ANSI / -A)
#include <windows.h>

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetModuleHandleA = kernel32.NewProc("GetModuleHandleA")
)

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

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

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

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

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

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

関連項目

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