GetLongPathNameTransactedA 関数 (winbase.h)

  • [アーティクル]

[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 Transparent Failover (TFO) いいえ
スケールアウト ファイル共有 (SO) を使う SMB 3.0 いいえ
クラスターの共有ボリューム ファイル システム (CsvFS) いいえ
Resilient File System (ReFS) いいえ
 

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

注意

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

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winbase.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

File Management 関数

GetFullPathNameTransacted

GetShortPathName

ファイル、パス、名前空間の名前付け

トランザクション NTFS