Función DeleteFileA (fileapi.h)

Artículo
12/15/2023

Elimina un archivo existente.

Para realizar esta operación como una operación de transacción, use la función DeleteFileTransact.

Sintaxis

BOOL DeleteFileA(
  [in] LPCSTR lpFileName
);

Parámetros

[in] lpFileName

Nombre del archivo que se va a eliminar.

De forma predeterminada, el nombre está limitado a MAX_PATH caracteres. Para ampliar este límite a 32 767 caracteres anchos, anteponga "\\?\" a la ruta de acceso. Para obtener más información, vea Nomenclatura de archivos, rutas de acceso y espacios de nombres.

Sugerencia

A partir de Windows 10, versión 1607, puede optar por quitar la limitación de MAX_PATH sin prepending "\\?\". Consulte la sección "Limitación máxima de longitud de ruta de acceso" de Nombres de archivos, rutas de acceso y espacios de nombres para obtener más información.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero (0). Para obtener información de error extendida, llame a GetLastError.

Comentarios

Si una aplicación intenta eliminar un archivo que no existe, se produce un error en la función DeleteFile con ERROR_FILE_NOT_FOUND. Si el archivo es un archivo de solo lectura, se produce un error en la función con ERROR_ACCESS_DENIED.

En la lista siguiente se identifican algunas sugerencias para eliminar, quitar o cerrar archivos:

Para eliminar un archivo de solo lectura, primero debe quitar el atributo de solo lectura.
Para eliminar o cambiar el nombre de un archivo, debe tener el permiso delete en el archivo o eliminar el permiso secundario en el directorio primario.
Para eliminar de forma recursiva los archivos de un directorio, use la función SHFileOperation .
Para quitar un directorio vacío, use la función RemoveDirectory .
Para cerrar un archivo abierto, use la función CloseHandle .

Si configura un directorio con todo el acceso excepto eliminar y eliminar secundario, y las listas de control de acceso (ACL) de los nuevos archivos se heredan, puede crear un archivo sin poder eliminarlo. Sin embargo, puede crear un archivo y, a continuación, obtener todo el acceso que solicite en el identificador que se le devuelve en el momento en que cree el archivo.

Si solicita permiso de eliminación en el momento de crear un archivo, puede eliminar o cambiar el nombre del archivo con ese identificador, pero no con ningún otro identificador. Para obtener más información, vea Seguridad de archivos y derechos de acceso.

Se produce un error en la función DeleteFile si una aplicación intenta eliminar un archivo que tiene otros identificadores abiertos para E/S normales o como un archivo asignado a memoria (FILE_SHARE_DELETE debe haberse especificado cuando se abren otros identificadores).

La función DeleteFile marca un archivo para su eliminación al cerrarse. Por lo tanto, la eliminación del archivo no se produce hasta que se cierra el último identificador del archivo. Las llamadas posteriores a CreateFile para abrir el archivo producen un error con ERROR_ACCESS_DENIED.

El uso de la eliminación POSIX hace que el archivo se elimine mientras los identificadores permanecen abiertos. Las llamadas posteriores a CreateFile para abrir el archivo producen un error con ERROR_FILE_NOT_FOUND.

Comportamiento simbólico del vínculo:

Si la ruta de acceso apunta a un vínculo simbólico, se eliminará el vínculo simbólico, no el destino. Para eliminar un destino, debe llamar a CreateFile y especificar FILE_FLAG_DELETE_ON_CLOSE.

En Windows 8 y Windows Server 2012, esta función es compatible con las siguientes tecnologías:

Tecnología	Compatible
Protocolo Bloque de mensajes del servidor (SMB) 3.0	Sí
Conmutación por error transparente (TFO) de SMB 3.0	Sí
SMB 3.0 con recursos compartidos de archivos de escalabilidad horizontal (SO)	Sí
Sistema de archivos de Volumen compartido de clúster (CsvFS)	Sí
Sistema de archivos resistente a errores (ReFS)	Sí

Ejemplos

Para obtener un ejemplo, consulte Bloqueo y desbloqueo de intervalos de bytes en archivos.

Nota

El encabezado fileapi.h define DeleteFile como un alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP [aplicaciones de escritorio \| aplicaciones para UWP]
Servidor mínimo compatible	Windows Server 2003 [aplicaciones de escritorio \| aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	fileapi.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll