ホーム › System.ProcessStatus › GetMappedFileNameW

GetMappedFileNameW

関数

メモリ領域にマップされたファイル名をUnicodeで取得する。

DLLPSAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetMappedFileNameW(
    HANDLE hProcess,
    void* lpv,
    LPWSTR lpFilename,
    DWORD nSize
);

パラメーター

名前	型	方向	説明
hProcess	HANDLE	in	プロセスへのハンドル。このハンドルには PROCESS_QUERY_INFORMATION アクセス権が必要です。詳細については、Process Security and Access Rights を参照してください。
lpv	void*	in	確認対象のアドレス。
lpFilename	LPWSTR	out	lpv で指定したアドレスが属するメモリマップトファイルの名前を受け取るバッファーへのポインター。
nSize	DWORD	in	lpFilename バッファーのサイズ(文字単位)。

戻り値の型: DWORD

公式ドキュメント

指定したアドレスが、指定したプロセスのアドレス空間内のメモリマップトファイル内にあるかどうかを確認します。該当する場合、関数はそのメモリマップトファイルの名前を返します。(Unicode)

戻り値

関数が成功した場合、戻り値はバッファーにコピーされた文字列の長さ(文字単位、終端の null 文字を含まない)です。バッファーがモジュール名を保持するには小さすぎる場合、文字列は nSize 文字(終端の null 文字を含む)に切り詰められ、関数は nSize を返し、最終エラーは ERROR_INSUFFICIENT_BUFFER に設定されます。

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

解説(Remarks)

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

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

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

Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	はい
SMB 3.0 トランスペアレントフェールオーバー (TFO)	はい
SMB 3.0 とスケールアウトファイル共有 (SO)	はい
クラスター共有ボリュームファイルシステム (CsvFS)	はい
回復性ファイルシステム (ReFS)	はい

例

例については、Obtaining a File Name From a File Handle を参照してください。

メモ

psapi.h ヘッダーは GetMappedFileName を、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)

各言語での呼び出し定義

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

DWORD GetMappedFileNameW(
    HANDLE hProcess,
    void* lpv,
    LPWSTR lpFilename,
    DWORD nSize
);

[DllImport("PSAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetMappedFileNameW(
    IntPtr hProcess,   // HANDLE
    IntPtr lpv,   // void*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFilename,   // LPWSTR out
    uint nSize   // DWORD
);

<DllImport("PSAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetMappedFileNameW(
    hProcess As IntPtr,   ' HANDLE
    lpv As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPWStr)> lpFilename As System.Text.StringBuilder,   ' LPWSTR out
    nSize As UInteger   ' DWORD
) As UInteger
End Function

' hProcess : HANDLE
' lpv : void*
' lpFilename : LPWSTR out
' nSize : DWORD
Declare PtrSafe Function GetMappedFileNameW Lib "psapi" ( _
    ByVal hProcess As LongPtr, _
    ByVal lpv As LongPtr, _
    ByVal lpFilename As LongPtr, _
    ByVal nSize As Long) 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

GetMappedFileNameW = ctypes.windll.psapi.GetMappedFileNameW
GetMappedFileNameW.restype = wintypes.DWORD
GetMappedFileNameW.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(None),  # lpv : void*
    wintypes.LPWSTR,  # lpFilename : LPWSTR out
    wintypes.DWORD,  # nSize : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('PSAPI.dll')
GetMappedFileNameW = Fiddle::Function.new(
  lib['GetMappedFileNameW'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # lpv : void*
    Fiddle::TYPE_VOIDP,  # lpFilename : LPWSTR out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "psapi")]
extern "system" {
    fn GetMappedFileNameW(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        lpv: *mut (),  // void*
        lpFilename: *mut u16,  // LPWSTR out
        nSize: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("PSAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetMappedFileNameW(IntPtr hProcess, IntPtr lpv, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFilename, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PSAPI_GetMappedFileNameW' -Namespace Win32 -PassThru
# $api::GetMappedFileNameW(hProcess, lpv, lpFilename, nSize)

#uselib "PSAPI.dll"
#func global GetMappedFileNameW "GetMappedFileNameW" wptr, wptr, wptr, wptr
; GetMappedFileNameW hProcess, lpv, varptr(lpFilename), nSize   ; 戻り値は stat
; hProcess : HANDLE -> "wptr"
; lpv : void* -> "wptr"
; lpFilename : LPWSTR out -> "wptr"
; nSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "PSAPI.dll"
#cfunc global GetMappedFileNameW "GetMappedFileNameW" sptr, sptr, var, int
; res = GetMappedFileNameW(hProcess, lpv, lpFilename, nSize)
; hProcess : HANDLE -> "sptr"
; lpv : void* -> "sptr"
; lpFilename : LPWSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "PSAPI.dll"
#cfunc global GetMappedFileNameW "GetMappedFileNameW" sptr, sptr, sptr, int
; res = GetMappedFileNameW(hProcess, lpv, varptr(lpFilename), nSize)
; hProcess : HANDLE -> "sptr"
; lpv : void* -> "sptr"
; lpFilename : LPWSTR out -> "sptr"
; nSize : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。