GetModuleFileNameExA 関数 (psapi.h)

[アーティクル]
04/06/2023

指定したモジュールを含むファイルの完全修飾パスを取得します。

構文

DWORD GetModuleFileNameExA(
  [in]           HANDLE  hProcess,
  [in, optional] HMODULE hModule,
  [out]          LPSTR   lpFilename,
  [in]           DWORD   nSize
);

パラメーター

[in] hProcess

モジュールを含むプロセスのハンドル。

ハンドルには、PROCESS_QUERY_INFORMATIONと PROCESS_VM_READ アクセス権が必要です。詳細については、「セキュリティとアクセス権の処理」を参照してください。

Windows 10 以降、Windows Server 2016以降: hModule パラメーターが NULL の場合、ハンドルにはPROCESS_QUERY_LIMITED_INFORMATIONアクセス権のみが必要です。

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

[in, optional] hModule

モジュールへのハンドル。このパラメーターが NULL の場合、 GetModuleFileNameEx は hProcess で指定されたプロセスの実行可能ファイルのパスを返します。

[out] lpFilename

モジュールへの完全修飾パスを受け取るバッファーへのポインター。ファイル名のサイズが nSize パラメーターの値より大きい場合、関数は成功しますが、ファイル名は切り捨てられ、null で終了します。

[in] nSize

lpFilename バッファーのサイズ (文字数)。

戻り値

関数が成功した場合、戻り値はバッファーにコピーされる文字列の長さを指定します。

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

GetModuleFileNameEx 関数は、主に、別のプロセスからモジュール情報を抽出する必要があるデバッガーや同様のアプリケーションで使用するように設計されています。ターゲットプロセスのモジュールリストが破損しているか、まだ初期化されていない場合、または DLL の読み込みまたはアンロードの結果として関数呼び出し中にモジュールリストが変更された場合、 GetModuleFileNameEx が失敗したり、正しくない情報が返されたりする可能性があります。

現在のプロセスでモジュールの名前を取得するには、 GetModuleFileName 関数を使用します。これは、現在のプロセスへのハンドルを使用 して GetModuleFileNameEx を 呼び出すよりも効率的で信頼性が高くなります。

リモートプロセスのメイン実行可能モジュールの名前を取得するには、GetProcessImageFileName または QueryFullProcessImageName 関数を使用します。これは、NULL モジュールハンドルを使用して GetModuleFileNameEx 関数を呼び出すよりも効率的で信頼性が高くなります。

Windows 7 および Windows Server 2008 R2 以降、Psapi.h は PSAPI 関数のバージョン番号を確立します。 PSAPI バージョン番号は、関数の呼び出しに使用される名前と、プログラムが読み込む必要があるライブラリに影響します。

PSAPI_VERSION が 2 以上の場合、この関数は Psapi.h で K32GetModuleFileNameEx として定義され、Kernel32.lib および Kernel32.dll でエクスポートされます。 PSAPI_VERSION が 1 の場合、この関数は Psapi.h で GetModuleFileNameEx として定義され、Psapi.lib でエクスポートされ、K32GetModuleFileNameEx を呼び出すラッパーとして Psapi.dll されます。

以前のバージョンの Windows および Windows 7 以降のバージョンで実行する必要があるプログラムは、常に この関数を GetModuleFileNameEx として呼び出す必要があります。シンボルを正しく解決するには、PSapi.lib を TARGETLIBS マクロに追加し、 -DPSAPI_VERSION=1 でプログラムをコンパイルします。実行時の動的リンクを使用するには、Psapi.dll を読み込みます。

例

例については、「プロセスのすべてのモジュールの列挙」を参照してください。

注意

psapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetModuleFileNameEx を定義します。エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows XP [デスクトップアプリ \| UWP アプリ]
サポートされている最小のサーバー	Windows Server 2003 [デスクトップアプリのみ \| UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	psapi.h
Library	Windows 7 および Windows Server 2008 R2 の Kernel32.lib。Windows 7 および Windows Server 2008 R2 の Psapi.lib (PSAPI_VERSION=1 の場合)。Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP の Psapi.lib
[DLL]	Windows 7 および Windows Server 2008 R2 で Kernel32.dll。Windows 7 および Windows Server 2008 R2 で Psapi.dll (PSAPI_VERSION=1 の場合)。Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP の Psapi.dll