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 透過的フェールオーバー (TFO) | いいえ |
SMB 3.0 とスケールアウト ファイル共有 (SO) | いいえ |
クラスター共有ボリューム ファイル システム (CsvFS) | いいえ |
回復性のあるファイル システム (ReFS) | いいえ |
SMB 3.0 は TxF をサポートしていません。
手記
winbase.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして RemoveDirectoryTransacted を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows Vista [デスクトップ アプリのみ] |
サポートされる最小サーバー | Windows Server 2008 [デスクトップ アプリのみ] |
ターゲット プラットフォーム の |
ウィンドウズ |
ヘッダー | winbase.h (Windows.h を含む) |
ライブラリ | Kernel32.lib |
DLL | Kernel32.dll |
関連項目
CreateDirectoryTransacted の
トランザクション NTFS の