RemoveDirectoryTransactedA 関数 (winbase.h)

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

トランザクション操作として既存のディレクトリを削除します。

構文

BOOL RemoveDirectoryTransactedA(
  [in] LPCSTR lpPathName,
  [in] HANDLE hTransaction
);

パラメーター

[in] lpPathName

削除するディレクトリのパス。 パスは空のディレクトリを指定する必要があり、呼び出し元のプロセスはディレクトリへの削除アクセス権を持っている必要があります。

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

ヒント

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

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

[in] hTransaction

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

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

RemoveDirectoryTransacted 関数は、終了時に削除するディレクトリをマークします。 したがって、ディレクトリへの最後のハンドルが閉じられるまで、ディレクトリは削除されません。

RemoveDirectory は 、ターゲットの内容が空でない場合でも、ディレクトリ ジャンクションを削除します。関数は、ターゲット オブジェクトの状態に関係なく、ディレクトリ ジャンクションを削除します。

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 バージョンを自動的に選択するエイリアスとして RemoveDirectoryTransacted を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

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

関連項目

CreateDirectoryTransacted

ディレクトリの作成と削除

ディレクトリ管理の関数

トランザクション NTFS