ホーム › Storage.FileSystem › GetLongPathNameTransactedW

GetLongPathNameTransactedW

関数

トランザクション内で短いパスを長いパス名へ変換する(Unicode版)。

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

シグネチャ

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

DWORD GetLongPathNameTransactedW(
    LPCWSTR lpszShortPath,
    LPWSTR lpszLongPath,   // optional
    DWORD cchBuffer,
    HANDLE hTransaction
);

パラメーター

名前	型	方向	説明
lpszShortPath	LPCWSTR	in	変換するパス。パスはローカルコンピューター上に存在している必要があります。そうでない場合、関数は失敗し、最後のエラーコードに ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE が設定されます。既定では、名前は MAX_PATH 文字に制限されます。この制限を 32,767 ワイド文字まで拡張するには、パスの先頭に "\\?\" を付加します。詳細については、ファイル、パス、および名前空間の名前付けを参照してください。ヒント Windows 10 バージョン 1607 以降では、"\\?\" を付加せずに MAX_PATH の制限を取り除くオプトインが可能です。詳細については、ファイル、パス、および名前空間の名前付けの「Maximum Path Length Limitation」セクションを参照してください。
lpszLongPath	LPWSTR	outoptional	ロングパスを受け取るバッファーへのポインター。 lpszShortPath パラメーターに使用したものと同じバッファーを使用できます。
cchBuffer	DWORD	in	lpszLongPath が指すバッファーのサイズ( TCHAR 単位)。
hTransaction	HANDLE	in	トランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: DWORD

公式ドキュメント

指定したパスを、トランザクション操作としてロング形式に変換します。(Unicode)

戻り値

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

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

ファイルが存在しないなど、その他の理由で関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

多くのファイルシステムでは、短いファイル名にはチルダ (~~) 文字が含まれます。ただし、すべてのファイルシステムがこの規則に従うわけではありません。したがって、パスにチルダ (~~) 文字が含まれていないからといって、 GetLongPathNameTransacted の呼び出しを省略できると想定しないでください。

ロングパスが見つからない場合、この関数は lpszShortPath パラメーターで指定された名前を lpszLongPath パラメーターに返します。

戻り値が cchBuffer で指定した値より大きい場合は、パスを保持するのに十分な大きさのバッファーを使用して、もう一度関数を呼び出すことができます。この場合の例については、 GetFullPathName の Example Code セクションを参照してください。

注意この場合の戻り値は終端の null 文字を含む長さですが、成功時の戻り値はその数に終端の null 文字を含みません。

あるファイルまたはディレクトリにアクセスできても、そのファイルまたはディレクトリの親ディレクトリの一部にアクセスできない場合があります。その結果、 GetLongPathNameTransacted は、あるパスコンポーネントのロング名を判別するためにその親ディレクトリを照会できない場合に失敗することがあります。このチェックは、ファイル拡張子が 3 文字より長い、または合計の長さが 12 文字より長いディレクトリコンポーネントについては省略できます。詳細については、ファイル、パス、および名前空間の名前付けの Short vs. Long Names セクションを参照してください。

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 ヘッダーは、GetLongPathNameTransacted を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーやランタイムエラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetLongPathNameTransactedW(
    LPCWSTR lpszShortPath,
    LPWSTR lpszLongPath,   // optional
    DWORD cchBuffer,
    HANDLE hTransaction
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetLongPathNameTransactedW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszShortPath,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszLongPath,   // LPWSTR optional, out
    uint cchBuffer,   // DWORD
    IntPtr hTransaction   // HANDLE
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetLongPathNameTransactedW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszShortPath As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpszLongPath As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchBuffer As UInteger,   ' DWORD
    hTransaction As IntPtr   ' HANDLE
) As UInteger
End Function

' lpszShortPath : LPCWSTR
' lpszLongPath : LPWSTR optional, out
' cchBuffer : DWORD
' hTransaction : HANDLE
Declare PtrSafe Function GetLongPathNameTransactedW Lib "kernel32" ( _
    ByVal lpszShortPath As LongPtr, _
    ByVal lpszLongPath As LongPtr, _
    ByVal cchBuffer As Long, _
    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

GetLongPathNameTransactedW = ctypes.windll.kernel32.GetLongPathNameTransactedW
GetLongPathNameTransactedW.restype = wintypes.DWORD
GetLongPathNameTransactedW.argtypes = [
    wintypes.LPCWSTR,  # lpszShortPath : LPCWSTR
    wintypes.LPWSTR,  # lpszLongPath : LPWSTR optional, out
    wintypes.DWORD,  # cchBuffer : DWORD
    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')
GetLongPathNameTransactedW = Fiddle::Function.new(
  lib['GetLongPathNameTransactedW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszShortPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpszLongPath : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # cchBuffer : DWORD
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetLongPathNameTransactedW(
        lpszShortPath: *const u16,  // LPCWSTR
        lpszLongPath: *mut u16,  // LPWSTR optional, out
        cchBuffer: u32,  // DWORD
        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 GetLongPathNameTransactedW([MarshalAs(UnmanagedType.LPWStr)] string lpszShortPath, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpszLongPath, uint cchBuffer, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetLongPathNameTransactedW' -Namespace Win32 -PassThru
# $api::GetLongPathNameTransactedW(lpszShortPath, lpszLongPath, cchBuffer, hTransaction)

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

出力引数:

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