DeleteFile2W 関数 (fileapi.h)

既存のファイルを削除します。

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

構文

BOOL DeleteFile2W(
  LPCWSTR lpFileName,
  DWORD   Flags
);

パラメーター

lpFileName

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

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

ヒント

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

Flags

削除されるファイルの処理方法を指定するフラグ。 このパラメーターには、次の値のいずれかを組み合わせて使用できます。

価値 意味
FILE_FLAG_DISALLOW_PATH_REDIRECTS
0x00010000		 lpFileName が再解析ポイントまたはシンボリック リンクによってリダイレクトされないようにします。

戻り値

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

関数が失敗した場合、戻り値は 0 (0) です。 拡張エラー情報を取得するには、GetLastError呼び出します。 考えられるエラーは次のとおりです。

リターン コード 説明
ERROR_PATH_REDIRECTED lpFileName は、再解析ポイントまたはシンボリック リンクによってリダイレクトされました。

注釈

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

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

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

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

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

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

DeleteFile2 関数は、ファイルを閉じると削除対象としてマークします。 したがって、ファイルの最後のハンドルが閉じられるまで、ファイルの削除は行われません。 ファイルを開く CreateFile、 CreateFile2、または CreateFile3 の後続の呼び出しは 、ERROR_ACCESS_DENIEDで失敗します。

POSIX 削除を使用すると、ハンドルが開いたままでファイルが削除されます。 ファイルを開く CreateFile の後続の呼び出しは 、ERROR_FILE_NOT_FOUNDで失敗します。

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

この関数は、次のテクノロジでサポートされています。

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

注

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

例示

例については、「 ファイル内のバイト範囲のロックとロック解除」を参照してください。

必要条件

要件 価値
サポートされる最小クライアント Windows 11 24H2 [デスクトップ アプリ |UWP アプリ]
サポートされる最小サーバー Windows Server 2025 [デスクトップ アプリ |UWP アプリ]
ヘッダー fileapi.h (Windows.h を含む)
図書館 Kernel32.lib
DLL Kernel32.dll

こちらもご覧ください

CreateDirectory2

CreateFile3

RemoveDirectory2

  • Last updated on