GetLongPathNameTransactedA 関数 (winbase.h)

[アーティクル]
11/20/2024

[Microsoft では、開発者がアプリケーションのニーズを達成するために代替手段を利用することを強くお勧めします。 TxF が開発された多くのシナリオは、よりシンプルで簡単に利用できる手法によって実現できます。さらに、将来のバージョンの Microsoft Windows では TxF を使用できない可能性があります。詳細と TxF の代替方法については、「トランザクション NTFSを使用するの代替方法」を参照してください。

指定したパスを、トランザクション操作として長い形式に変換します。

トランザクションなしでこの操作を実行するには、GetLongPathName 関数を使用します。

ファイル名とパス名の詳細については、「名前付けファイル、パス、および名前空間を参照してください。

構文

DWORD GetLongPathNameTransactedA(
  [in]  LPCSTR lpszShortPath,
  [out] LPSTR  lpszLongPath,
  [in]  DWORD  cchBuffer,
  [in]  HANDLE hTransaction
);

パラメーター

[in] lpszShortPath

変換するパス。

既定では、名前はMAX_PATH文字に制限されています。この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付けます。詳細については、「ファイル、パス、および名前空間の名前付けする」を参照してください。

先端

Windows 10 バージョン 1607 以降では、事前に "\\?\" なしでMAX_PATHの制限を削除することをオプトインできます。詳細については、「名前付けファイル、パス、および名前空間の」の「パスの最大長制限」セクションを参照してください。

パスはローカルコンピューター上に存在する必要があります。それ以外の場合、関数は失敗し、最後のエラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTEに設定されます。

[out] lpszLongPath

長いパスを受け取るバッファーへのポインター。

lpszShortPath パラメーターに使用したのと同じバッファーを使用できます。

[in] cchBuffer

lpszLongPath バッファーのサイズは、TCHAR単位ポイントします。

[in] hTransaction

トランザクションのハンドル。このハンドルは、CreateTransaction 関数によって返されます。

戻り値

関数が成功した場合、戻り値は、終了する null 文字を含まない、lpszLongPathにコピーされた文字列の長さ (TCHARs) です。

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

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

備考

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

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

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

注意この場合の戻り値は終端の null 文字を含む長さですが、成功した場合の戻り値にはカウント内の終端の null 文字は含まれません。

ファイルまたはディレクトリにアクセスすることはできますが、そのファイルまたはディレクトリの親ディレクトリの一部にはアクセスできません。その結果、GetLongPathNameTransacted 、パスコンポーネントの親ディレクトリに対してクエリを実行して、そのコンポーネントの長い名前を確認できない場合に失敗する可能性があります。このチェックは、ファイル拡張子が 3 文字より長いディレクトリコンポーネント、または 12 文字を超える合計長のディレクトリコンポーネントではスキップできます。詳細については、「名前付けファイル、パス、および名前空間の短い名前と長い名前の」セクションを参照してください。

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

テクノロジー	サポート
サーバーメッセージブロック (SMB) 3.0 プロトコル	いいえ
SMB 3.0 透過的フェールオーバー (TFO)	いいえ
SMB 3.0 とスケールアウトファイル共有 (SO)	いいえ
クラスター共有ボリュームファイルシステム (CsvFS)	いいえ
回復性のあるファイルシステム (ReFS)	いいえ

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

手記

winbase.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetLongPathNameTransacted を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows Vista [デスクトップアプリのみ]
サポートされる最小サーバー	Windows Server 2008 [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	winbase.h (Windows.h を含む)
ライブラリ	Kernel32.lib
DLL	Kernel32.dll

次の方法で共有

GetLongPathNameTransactedA 関数 (winbase.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース