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

GetProcessImageFileNameA

関数
指定プロセスの実行イメージのパスをANSIで取得する。
DLLPSAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD GetProcessImageFileNameA(
    HANDLE hProcess,
    LPSTR lpImageFileName,
    DWORD nSize
);

パラメーター

名前方向説明
hProcessHANDLEin

プロセスへのハンドル。このハンドルには PROCESS_QUERY_INFORMATION または PROCESS_QUERY_LIMITED_INFORMATION アクセス権が必要です。詳細については、Process Security and Access Rights を参照してください。

Windows Server 2003 および Windows XP: このハンドルには PROCESS_QUERY_INFORMATION アクセス権が必要です。

lpImageFileNameLPSTRout実行可能ファイルのフルパスを受け取るバッファーへのポインター。
nSizeDWORDinlpImageFileName バッファーのサイズ(文字数単位)。

戻り値の型: DWORD

公式ドキュメント

指定したプロセスの実行可能ファイルの名前を取得します。(ANSI)

戻り値

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

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

解説(Remarks)

ファイル Psapi.dll は %windir%\System32 ディレクトリにインストールされます。この DLL の別のコピーがコンピューター上に存在する場合、アプリケーションの実行時に次のエラーが発生することがあります。「プロシージャ エントリ ポイント GetProcessImageFileName がダイナミック リンク ライブラリ PSAPI.DLL から見つかりませんでした。」 この問題を回避するには、%windir%\System32 ディレクトリにないバージョンを探し出して削除または名前変更し、その後再起動してください。

GetProcessImageFileName 関数は、ドライブ文字ではなくデバイス形式でパスを返します。たとえば、ファイル名 C:\Windows\System32\Ctype.nls はデバイス形式では次のようになります。

\Device\Harddisk0\Partition1\Windows\System32\Ctype.nls

現在のプロセスのモジュール名を取得するには、NULL モジュール ハンドルを指定して GetModuleFileName 関数を使用してください。これは、現在のプロセスのハンドルを指定して GetProcessImageFileName 関数を呼び出すよりも効率的です。

リモート プロセスのメイン実行可能モジュールの名前を win32 パス形式で取得するには、QueryFullProcessImageName 関数を使用してください。

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

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

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

メモ

psapi.h ヘッダーは、GetProcessImageFileName を、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 GetProcessImageFileNameA(
    HANDLE hProcess,
    LPSTR lpImageFileName,
    DWORD nSize
);
[DllImport("PSAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern uint GetProcessImageFileNameA(
    IntPtr hProcess,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpImageFileName,   // LPSTR out
    uint nSize   // DWORD
);
<DllImport("PSAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetProcessImageFileNameA(
    hProcess As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> lpImageFileName As System.Text.StringBuilder,   ' LPSTR out
    nSize As UInteger   ' DWORD
) As UInteger
End Function
' hProcess : HANDLE
' lpImageFileName : LPSTR out
' nSize : DWORD
Declare PtrSafe Function GetProcessImageFileNameA Lib "psapi" ( _
    ByVal hProcess As LongPtr, _
    ByVal lpImageFileName 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

GetProcessImageFileNameA = ctypes.windll.psapi.GetProcessImageFileNameA
GetProcessImageFileNameA.restype = wintypes.DWORD
GetProcessImageFileNameA.argtypes = [
    wintypes.HANDLE,  # hProcess : HANDLE
    wintypes.LPSTR,  # lpImageFileName : 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')
GetProcessImageFileNameA = Fiddle::Function.new(
  lib['GetProcessImageFileNameA'],
  [
    Fiddle::TYPE_VOIDP,  # hProcess : HANDLE
    Fiddle::TYPE_VOIDP,  # lpImageFileName : LPSTR out
    -Fiddle::TYPE_INT,  # nSize : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "psapi")]
extern "system" {
    fn GetProcessImageFileNameA(
        hProcess: *mut core::ffi::c_void,  // HANDLE
        lpImageFileName: *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 GetProcessImageFileNameA(IntPtr hProcess, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpImageFileName, uint nSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'PSAPI_GetProcessImageFileNameA' -Namespace Win32 -PassThru
# $api::GetProcessImageFileNameA(hProcess, lpImageFileName, nSize)
#uselib "PSAPI.dll"
#func global GetProcessImageFileNameA "GetProcessImageFileNameA" sptr, sptr, sptr
; GetProcessImageFileNameA hProcess, varptr(lpImageFileName), nSize   ; 戻り値は stat
; hProcess : HANDLE -> "sptr"
; lpImageFileName : LPSTR out -> "sptr"
; nSize : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "PSAPI.dll"
#cfunc global GetProcessImageFileNameA "GetProcessImageFileNameA" sptr, var, int
; res = GetProcessImageFileNameA(hProcess, lpImageFileName, nSize)
; hProcess : HANDLE -> "sptr"
; lpImageFileName : LPSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetProcessImageFileNameA(HANDLE hProcess, LPSTR lpImageFileName, DWORD nSize)
#uselib "PSAPI.dll"
#cfunc global GetProcessImageFileNameA "GetProcessImageFileNameA" intptr, var, int
; res = GetProcessImageFileNameA(hProcess, lpImageFileName, nSize)
; hProcess : HANDLE -> "intptr"
; lpImageFileName : LPSTR out -> "var"
; nSize : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	psapi = windows.NewLazySystemDLL("PSAPI.dll")
	procGetProcessImageFileNameA = psapi.NewProc("GetProcessImageFileNameA")
)

// hProcess (HANDLE), lpImageFileName (LPSTR out), nSize (DWORD)
r1, _, err := procGetProcessImageFileNameA.Call(
	uintptr(hProcess),
	uintptr(lpImageFileName),
	uintptr(nSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetProcessImageFileNameA(
  hProcess: THandle;   // HANDLE
  lpImageFileName: PAnsiChar;   // LPSTR out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'PSAPI.dll' name 'GetProcessImageFileNameA';
result := DllCall("PSAPI\GetProcessImageFileNameA"
    , "Ptr", hProcess   ; HANDLE
    , "Ptr", lpImageFileName   ; LPSTR out
    , "UInt", nSize   ; DWORD
    , "UInt")   ; return: DWORD
●GetProcessImageFileNameA(hProcess, lpImageFileName, nSize) = DLL("PSAPI.dll", "dword GetProcessImageFileNameA(void*, char*, dword)")
# 呼び出し: GetProcessImageFileNameA(hProcess, lpImageFileName, nSize)
# hProcess : HANDLE -> "void*"
# lpImageFileName : LPSTR out -> "char*"
# nSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetProcessImageFileNameANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Uint32);
typedef GetProcessImageFileNameADart = int Function(Pointer<Void>, Pointer<Utf8>, int);
final GetProcessImageFileNameA = DynamicLibrary.open('PSAPI.dll')
    .lookupFunction<GetProcessImageFileNameANative, GetProcessImageFileNameADart>('GetProcessImageFileNameA');
// hProcess : HANDLE -> Pointer<Void>
// lpImageFileName : LPSTR out -> Pointer<Utf8>
// nSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetProcessImageFileNameA(
  hProcess: THandle;   // HANDLE
  lpImageFileName: PAnsiChar;   // LPSTR out
  nSize: DWORD   // DWORD
): DWORD; stdcall;
  external 'PSAPI.dll' name 'GetProcessImageFileNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetProcessImageFileNameA"
  c_GetProcessImageFileNameA :: Ptr () -> CString -> Word32 -> IO Word32
-- hProcess : HANDLE -> Ptr ()
-- lpImageFileName : LPSTR out -> CString
-- nSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getprocessimagefilenamea =
  foreign "GetProcessImageFileNameA"
    ((ptr void) @-> string @-> uint32_t @-> returning uint32_t)
(* hProcess : HANDLE -> (ptr void) *)
(* lpImageFileName : LPSTR out -> string *)
(* nSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library psapi (t "PSAPI.dll"))
(cffi:use-foreign-library psapi)

(cffi:defcfun ("GetProcessImageFileNameA" get-process-image-file-name-a :convention :stdcall) :uint32
  (h-process :pointer)   ; HANDLE
  (lp-image-file-name :pointer)   ; LPSTR out
  (n-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetProcessImageFileNameA = Win32::API::More->new('PSAPI',
    'DWORD GetProcessImageFileNameA(HANDLE hProcess, LPSTR lpImageFileName, DWORD nSize)');
# my $ret = $GetProcessImageFileNameA->Call($hProcess, $lpImageFileName, $nSize);
# hProcess : HANDLE -> HANDLE
# lpImageFileName : LPSTR out -> LPSTR
# nSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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