Win32 API 日本語リファレンス
ホームStorage.FileSystem › GetFinalPathNameByHandleW

GetFinalPathNameByHandleW

関数
ファイルハンドルから最終的なパス名を取得する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

DWORD GetFinalPathNameByHandleW(
    HANDLE hFile,
    LPWSTR lpszFilePath,
    DWORD cchFilePath,
    GETFINALPATHNAMEBYHANDLE_FLAGS dwFlags
);

パラメーター

名前方向
hFileHANDLEin
lpszFilePathLPWSTRout
cchFilePathDWORDin
dwFlagsGETFINALPATHNAMEBYHANDLE_FLAGSin

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetFinalPathNameByHandleW(
    HANDLE hFile,
    LPWSTR lpszFilePath,
    DWORD cchFilePath,
    GETFINALPATHNAMEBYHANDLE_FLAGS dwFlags
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetFinalPathNameByHandleW(
    IntPtr hFile,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszFilePath,   // LPWSTR out
    uint cchFilePath,   // DWORD
    uint dwFlags   // GETFINALPATHNAMEBYHANDLE_FLAGS
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFinalPathNameByHandleW(
    hFile As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpszFilePath As System.Text.StringBuilder,   ' LPWSTR out
    cchFilePath As UInteger,   ' DWORD
    dwFlags As UInteger   ' GETFINALPATHNAMEBYHANDLE_FLAGS
) As UInteger
End Function
' hFile : HANDLE
' lpszFilePath : LPWSTR out
' cchFilePath : DWORD
' dwFlags : GETFINALPATHNAMEBYHANDLE_FLAGS
Declare PtrSafe Function GetFinalPathNameByHandleW Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal lpszFilePath As LongPtr, _
    ByVal cchFilePath As Long, _
    ByVal dwFlags 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

GetFinalPathNameByHandleW = ctypes.windll.kernel32.GetFinalPathNameByHandleW
GetFinalPathNameByHandleW.restype = wintypes.DWORD
GetFinalPathNameByHandleW.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.LPWSTR,  # lpszFilePath : LPWSTR out
    wintypes.DWORD,  # cchFilePath : DWORD
    wintypes.DWORD,  # dwFlags : GETFINALPATHNAMEBYHANDLE_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetFinalPathNameByHandleW = Fiddle::Function.new(
  lib['GetFinalPathNameByHandleW'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # lpszFilePath : LPWSTR out
    -Fiddle::TYPE_INT,  # cchFilePath : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : GETFINALPATHNAMEBYHANDLE_FLAGS
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn GetFinalPathNameByHandleW(
        hFile: *mut core::ffi::c_void,  // HANDLE
        lpszFilePath: *mut u16,  // LPWSTR out
        cchFilePath: u32,  // DWORD
        dwFlags: u32  // GETFINALPATHNAMEBYHANDLE_FLAGS
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetFinalPathNameByHandleW(IntPtr hFile, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszFilePath, uint cchFilePath, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetFinalPathNameByHandleW' -Namespace Win32 -PassThru
# $api::GetFinalPathNameByHandleW(hFile, lpszFilePath, cchFilePath, dwFlags)
#uselib "KERNEL32.dll"
#func global GetFinalPathNameByHandleW "GetFinalPathNameByHandleW" wptr, wptr, wptr, wptr
; GetFinalPathNameByHandleW hFile, varptr(lpszFilePath), cchFilePath, dwFlags   ; 戻り値は stat
; hFile : HANDLE -> "wptr"
; lpszFilePath : LPWSTR out -> "wptr"
; cchFilePath : DWORD -> "wptr"
; dwFlags : GETFINALPATHNAMEBYHANDLE_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetFinalPathNameByHandleW "GetFinalPathNameByHandleW" sptr, var, int, int
; res = GetFinalPathNameByHandleW(hFile, lpszFilePath, cchFilePath, dwFlags)
; hFile : HANDLE -> "sptr"
; lpszFilePath : LPWSTR out -> "var"
; cchFilePath : DWORD -> "int"
; dwFlags : GETFINALPATHNAMEBYHANDLE_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetFinalPathNameByHandleW(HANDLE hFile, LPWSTR lpszFilePath, DWORD cchFilePath, GETFINALPATHNAMEBYHANDLE_FLAGS dwFlags)
#uselib "KERNEL32.dll"
#cfunc global GetFinalPathNameByHandleW "GetFinalPathNameByHandleW" intptr, var, int, int
; res = GetFinalPathNameByHandleW(hFile, lpszFilePath, cchFilePath, dwFlags)
; hFile : HANDLE -> "intptr"
; lpszFilePath : LPWSTR out -> "var"
; cchFilePath : DWORD -> "int"
; dwFlags : GETFINALPATHNAMEBYHANDLE_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetFinalPathNameByHandleW = kernel32.NewProc("GetFinalPathNameByHandleW")
)

// hFile (HANDLE), lpszFilePath (LPWSTR out), cchFilePath (DWORD), dwFlags (GETFINALPATHNAMEBYHANDLE_FLAGS)
r1, _, err := procGetFinalPathNameByHandleW.Call(
	uintptr(hFile),
	uintptr(lpszFilePath),
	uintptr(cchFilePath),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetFinalPathNameByHandleW(
  hFile: THandle;   // HANDLE
  lpszFilePath: PWideChar;   // LPWSTR out
  cchFilePath: DWORD;   // DWORD
  dwFlags: DWORD   // GETFINALPATHNAMEBYHANDLE_FLAGS
): DWORD; stdcall;
  external 'KERNEL32.dll' name 'GetFinalPathNameByHandleW';
result := DllCall("KERNEL32\GetFinalPathNameByHandleW"
    , "Ptr", hFile   ; HANDLE
    , "Ptr", lpszFilePath   ; LPWSTR out
    , "UInt", cchFilePath   ; DWORD
    , "UInt", dwFlags   ; GETFINALPATHNAMEBYHANDLE_FLAGS
    , "UInt")   ; return: DWORD
●GetFinalPathNameByHandleW(hFile, lpszFilePath, cchFilePath, dwFlags) = DLL("KERNEL32.dll", "dword GetFinalPathNameByHandleW(void*, char*, dword, dword)")
# 呼び出し: GetFinalPathNameByHandleW(hFile, lpszFilePath, cchFilePath, dwFlags)
# hFile : HANDLE -> "void*"
# lpszFilePath : LPWSTR out -> "char*"
# cchFilePath : DWORD -> "dword"
# dwFlags : GETFINALPATHNAMEBYHANDLE_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。