ホーム › System.ProcessStatus › GetMappedFileNameA

GetMappedFileNameA

関数

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

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

シグネチャ

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

DWORD GetMappedFileNameA(
    HANDLE hProcess,
    void* lpv,
    LPSTR lpFilename,
    DWORD nSize
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

関数が成功すると、戻り値はバッファーにコピーされた文字列の長さ(文字単位)を表します。

関数が失敗すると、戻り値は 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 として呼び出してください。シンボルが正しく解決されるようにするには、Psapi.lib を TARGETLIBS マクロに追加し、-DPSAPI_VERSION=1 を指定してプログラムをコンパイルします。実行時の動的リンクを使用するには、Psapi.dll を読み込みます。

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

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	はい
SMB 3.0 Transparent Failover (TFO)	はい
SMB 3.0 with Scale-out File Shares (SO)	はい
Cluster Shared Volume File System (CsvFS)	はい
Resilient File System (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  (ANSI / -A)
#include <windows.h>

DWORD GetMappedFileNameA(
    HANDLE hProcess,
    void* lpv,
    LPSTR lpFilename,
    DWORD nSize
);

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

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

' hProcess : HANDLE
' lpv : void*
' lpFilename : LPSTR out
' nSize : DWORD
Declare PtrSafe Function GetMappedFileNameA Lib "psapi" ( _
    ByVal hProcess As LongPtr, _
    ByVal lpv As LongPtr, _
    ByVal lpFilename As String, _
    ByVal nSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetMappedFileNameA = ctypes.windll.psapi.GetMappedFileNameA
GetMappedFileNameA.restype = wintypes.DWORD
GetMappedFileNameA.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    ctypes.POINTER(None),  # lpv : void*
    wintypes.LPSTR,  # lpFilename : LPSTR 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')
GetMappedFileNameA = Fiddle::Function.new(
  lib['GetMappedFileNameA'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # lpv : void*
    Fiddle::TYPE_VOIDP,  # lpFilename : LPSTR out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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