DeleteFile 関数 (winbase.h)
既存のファイルを削除します。
この操作をトランザクション操作として実行するには、 DeleteFileTransacted 関数を使用します。
構文
BOOL DeleteFile(
[in] LPCTSTR lpFileName
);
パラメーター
[in] lpFileName
削除するファイルの名前。
既定では、名前はMAX_PATH文字に制限されています。 この制限を 32,767 文字のワイド文字に拡張するには、パスの先頭に "\\?\" を付加します。 詳細については、「ファイル、パス、および名前空間の名前付け」を参照してください。
ヒント
Windows 10 バージョン 1607 以降では、"\\?\" を前に置かずに、MAX_PATHの制限を削除するようにオプトインできます。 詳細については、「 ファイル、パス、および名前空間の名前付け 」の「最大パス長の制限」セクションを参照してください。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
存在しないファイルをアプリケーションが削除しようとすると、 DeleteFile 関数は ERROR_FILE_NOT_FOUNDで失敗します。 ファイルが読み取り専用ファイルの場合、関数は ERROR_ACCESS_DENIED で失敗します。
次の一覧では、ファイルの削除、削除、または終了に関するいくつかのヒントを示します。
- 読み取り専用ファイルを削除するには、まず読み取り専用属性を削除する必要があります。
- ファイルを削除または名前変更するには、ファイルに対する削除アクセス許可を持っているか、親ディレクトリの子アクセス許可を削除する必要があります。
- ディレクトリ内のファイルを再帰的に削除するには、 SHFileOperation 関数を使用します。
- 空のディレクトリを削除するには、 RemoveDirectory 関数を使用します。
- 開いているファイルを閉じるには、 CloseHandle 関数を使用します。
ファイルの作成時に削除アクセス許可を要求した場合は、そのハンドルを使用してファイルを削除または名前変更できますが、他のハンドルでは削除できません。 詳細については、「 ファイル のセキュリティとアクセス権」を参照してください。
アプリケーションが通常の I/O 用に開いている他のハンドルがあるファイルを削除しようとした場合、またはメモリ マップト ファイルとして削除しようとすると、 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 Transparent Failover (TFO) | はい |
| スケールアウト ファイル共有 (SO) を使う SMB 3.0 | はい |
| クラスターの共有ボリューム ファイル システム (CsvFS) | はい |
| Resilient File System (ReFS) | はい |
例
例については、「 ファイル内のバイト範囲のロックとロック解除」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winbase.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |