ホーム › Storage.FileSystem › GetFullPathNameTransactedW

GetFullPathNameTransactedW

関数

トランザクション内でファイルの完全パス名を取得する(Unicode版)。

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

シグネチャ

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

DWORD GetFullPathNameTransactedW(
    LPCWSTR lpFileName,
    DWORD nBufferLength,
    LPWSTR lpBuffer,   // optional
    LPWSTR* lpFilePart,   // optional
    HANDLE hTransaction
);

パラメーター

名前	型	方向	説明
lpFileName	LPCWSTR	in	ファイルの名前です。この文字列には、短い名前 (8.3 形式) と長いファイル名のいずれも使用できます。また、共有名やボリューム名を指定することもできます。ファイルはローカルコンピューター上に存在する必要があります。そうでない場合、関数は失敗し、最終エラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE に設定されます。
nBufferLength	DWORD	in	ドライブとパスの null 終端文字列を受け取るバッファーのサイズを、 TCHARs 単位で指定します。
lpBuffer	LPWSTR	outoptional	ドライブとパスの null 終端文字列を受け取るバッファーへのポインターです。
lpFilePart	LPWSTR*	outoptional	パス内の最後のファイル名コンポーネントのアドレス (lpBuffer 内) を受け取るバッファーへのポインターです。この情報が不要な場合は NULL を指定します。 lpBuffer がファイルではなくディレクトリを指している場合、 lpFilePart は 0 (ゼロ) を受け取ります。
hTransaction	HANDLE	in	トランザクションへのハンドルです。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: DWORD

公式ドキュメント

指定したファイルのフルパスとファイル名を、トランザクション操作として取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は lpBuffer にコピーされた文字列の長さ (TCHARs 単位) で、終端の null 文字は含まれません。

lpBuffer バッファーがパスを格納するには小さすぎる場合、戻り値はパスと終端の null 文字を格納するために必要なバッファーのサイズ (TCHARs 単位) になります。

その他の理由で関数が失敗した場合、戻り値はゼロになります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

GetFullPathNameTransacted は、現在のドライブおよびディレクトリの名前と指定されたファイル名を結合して、指定したファイルのフルパスとファイル名を求めます。また、フルパスとファイル名のうちファイル名部分のアドレスも計算します。この関数は、結果として得られるパスとファイル名が有効であるか、または関連するボリューム上に既存のファイルを参照しているかを検証しません。

共有名およびボリューム名は lpFileName の有効な入力です。たとえば、次のリストは、test-2 がリモートコンピューターで、U: がネットワークマップされたドライブである場合に返されるパスとファイル名を示しています。

"\\test-2\q$\lh" を指定した場合、返されるパスは "\\test-2\q$\lh" です。
"\\?\UNC\test-2\q$\lh" を指定した場合、返されるパスは "\\?\UNC\test-2\q$\lh" です。
"U:" を指定した場合、返されるパスは "U:\" です。

GetFullPathNameTransacted は、指定されたファイル名 lpFileName を変換しません。指定したファイル名が存在する場合、 GetLongPathNameTransacted、 GetLongPathName、または GetShortPathName を使用して、それぞれ長い形式または短い形式のパス名に変換できます。

戻り値が nBufferLength で指定した値より大きい場合、パスを格納するのに十分な大きさのバッファーを用意して、関数を再度呼び出すことができます。このケースの例、および動的割り当てのために長さゼロのバッファーを使用する例については、サンプルコードのセクションを参照してください。

注このケースでの戻り値は終端の null 文字を含む長さですが、成功時の戻り値はカウントに終端の null 文字を含みません。

Windows 8 および 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)	いいえ

SMB 3.0 は TxF をサポートしていません。

メモ

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

各言語での呼び出し定義

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

DWORD GetFullPathNameTransactedW(
    LPCWSTR lpFileName,
    DWORD nBufferLength,
    LPWSTR lpBuffer,   // optional
    LPWSTR* lpFilePart,   // optional
    HANDLE hTransaction
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetFullPathNameTransactedW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    uint nBufferLength,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer,   // LPWSTR optional, out
    IntPtr lpFilePart,   // LPWSTR* optional, out
    IntPtr hTransaction   // HANDLE
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetFullPathNameTransactedW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    nBufferLength As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    lpFilePart As IntPtr,   ' LPWSTR* optional, out
    hTransaction As IntPtr   ' HANDLE
) As UInteger
End Function

' lpFileName : LPCWSTR
' nBufferLength : DWORD
' lpBuffer : LPWSTR optional, out
' lpFilePart : LPWSTR* optional, out
' hTransaction : HANDLE
Declare PtrSafe Function GetFullPathNameTransactedW Lib "kernel32" ( _
    ByVal lpFileName As LongPtr, _
    ByVal nBufferLength As Long, _
    ByVal lpBuffer As LongPtr, _
    ByVal lpFilePart As LongPtr, _
    ByVal hTransaction As LongPtr) 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

GetFullPathNameTransactedW = ctypes.windll.kernel32.GetFullPathNameTransactedW
GetFullPathNameTransactedW.restype = wintypes.DWORD
GetFullPathNameTransactedW.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    wintypes.DWORD,  # nBufferLength : DWORD
    wintypes.LPWSTR,  # lpBuffer : LPWSTR optional, out
    ctypes.c_void_p,  # lpFilePart : LPWSTR* optional, out
    wintypes.HANDLE,  # hTransaction : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetFullPathNameTransactedW = Fiddle::Function.new(
  lib['GetFullPathNameTransactedW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    -Fiddle::TYPE_INT,  # nBufferLength : DWORD
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpFilePart : LPWSTR* optional, out
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetFullPathNameTransactedW(
        lpFileName: *const u16,  // LPCWSTR
        nBufferLength: u32,  // DWORD
        lpBuffer: *mut u16,  // LPWSTR optional, out
        lpFilePart: *mut *mut u16,  // LPWSTR* optional, out
        hTransaction: *mut core::ffi::c_void  // HANDLE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetFullPathNameTransactedW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, uint nBufferLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpBuffer, IntPtr lpFilePart, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetFullPathNameTransactedW' -Namespace Win32 -PassThru
# $api::GetFullPathNameTransactedW(lpFileName, nBufferLength, lpBuffer, lpFilePart, hTransaction)

#uselib "KERNEL32.dll"
#func global GetFullPathNameTransactedW "GetFullPathNameTransactedW" wptr, wptr, wptr, wptr, wptr
; GetFullPathNameTransactedW lpFileName, nBufferLength, varptr(lpBuffer), varptr(lpFilePart), hTransaction   ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; nBufferLength : DWORD -> "wptr"
; lpBuffer : LPWSTR optional, out -> "wptr"
; lpFilePart : LPWSTR* optional, out -> "wptr"
; hTransaction : HANDLE -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetFullPathNameTransactedW "GetFullPathNameTransactedW" wstr, int, var, var, sptr
; res = GetFullPathNameTransactedW(lpFileName, nBufferLength, lpBuffer, lpFilePart, hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; nBufferLength : DWORD -> "int"
; lpBuffer : LPWSTR optional, out -> "var"
; lpFilePart : LPWSTR* optional, out -> "var"
; hTransaction : HANDLE -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetFullPathNameTransactedW "GetFullPathNameTransactedW" wstr, int, sptr, sptr, sptr
; res = GetFullPathNameTransactedW(lpFileName, nBufferLength, varptr(lpBuffer), varptr(lpFilePart), hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; nBufferLength : DWORD -> "int"
; lpBuffer : LPWSTR optional, out -> "sptr"
; lpFilePart : LPWSTR* optional, out -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。