DeleteFileTransactedA 関数 (winbase.h)

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

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

トランザクション操作として既存のファイルを削除します。

構文

BOOL DeleteFileTransactedA(
  [in] LPCSTR lpFileName,
  [in] HANDLE hTransaction
);

パラメーター

[in] lpFileName

削除するファイルの名前。

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

先端

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

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

[in] hTransaction

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

戻り値

関数が成功した場合、戻り値は 0 以外です。

関数が失敗した場合、戻り値は 0 (ゼロ) です。拡張エラー情報を取得するには、GetLastError呼び出します。

備考

アプリケーションが存在しないファイルを削除しようとすると、DeleteFileTransacted 関数は ERROR_FILE_NOT_FOUNDで失敗します。ファイルが読み取り専用ファイルの場合、関数は ERROR_ACCESS_DENIEDで失敗します。

次の一覧では、ファイルの削除、削除、または閉じに関するいくつかのヒントを示します。

読み取り専用ファイルを削除するには、まず読み取り専用属性を削除する必要があります。
ファイルを削除または名前変更するには、ファイルに対する削除アクセス許可を持っているか、親ディレクトリの子アクセス許可を削除する必要があります。
ディレクトリ内のファイルを再帰的に削除するには、SHFileOperation 関数を使用します。
空のディレクトリを削除するには、RemoveDirectoryTransacted 関数使用します。
開いているファイルを閉じるには、CloseHandle 関数を使用します。

削除と削除の子を除くすべてのアクセス権を持つディレクトリを設定し、新しいファイルのアクセス制御リスト (ACL) を継承する場合は、削除せずにファイルを作成できます。ただし、ファイルを作成し、ファイルの作成時に返されるハンドルに対して要求したすべてのアクセス権を取得できます。

ファイルの作成時に削除アクセス許可を要求した場合は、そのハンドルを使用してファイルを削除または名前変更できますが、他のハンドルでは削除できません。詳細については、「ファイルのセキュリティとアクセス権の」を参照してください。

DeleteFileTransacted 関数は、アプリケーションが通常の I/O 用に開いている他のハンドルを持つファイルを削除しようとした場合、またはメモリマップトファイルとして失敗します (他のハンドルが開かれたときにFILE_SHARE_DELETE を指定する必要があります)。

DeleteFileTransacted 関数は、ファイルを閉じると削除対象としてマークします。トランザクションがまだアクティブな場合、ファイルに対する最後のトランザクションライターハンドルが閉じられた後、ファイルは削除されます。ファイルが削除対象としてマークされていて、トランザクションの完了後もトランザクションライターハンドルが開いている場合、ファイルは削除されません。

シンボリックリンク: パスがシンボリックリンクを指している場合、シンボリックリンクは削除され、ターゲットは削除されません。ターゲットを削除するには、CreateFile 呼び出し、FILE_FLAG_DELETE_ON_CLOSEを指定する必要があります。

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

必要条件

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

次の方法で共有

DeleteFileTransactedA 関数 (winbase.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース