DeleteFile 関数 (winbase.h)

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

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

構文

BOOL DeleteFile(
  [in] LPCTSTR lpFileName
);

[in] lpFileName

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

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

Tip

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

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

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

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

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

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

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

DeleteFile 関数は、アプリケーションが、FILE_SHARE_DELETEなしで開かれた、またはメモリマップされた他の開いているハンドルを持つファイルを削除しようとすると失敗します。

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

シンボリックリンクの動作—

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

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

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

Requirement	価値
サポートされる最小クライアント	Windows XP [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2003 [デスクトップアプリ \|UWP アプリ]
ターゲットプラットフォームの	Windows
ヘッダー	winbase.h (Windows.h を含む)
ライブラリ	Kernel32.lib
DLL	Kernel32.dll