Función RemoveDirectoryA (fileapi.h)
Elimina un directorio vacío.
Para realizar esta operación como una operación de transacción, use la función RemoveDirectoryTransact.
Sintaxis
BOOL RemoveDirectoryA(
[in] LPCSTR lpPathName
);
Parámetros
[in] lpPathName
Ruta de acceso del directorio que se va a quitar. Esta ruta de acceso debe especificar un directorio vacío y el proceso de llamada debe tener acceso de eliminación al directorio.
De forma predeterminada, el nombre se limita 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. Para obtener información de error extendida, llame a GetLastError.
Comentarios
La función RemoveDirectory marca un directorio para su eliminación al cerrar. Por lo tanto, el directorio no se quita hasta que se cierra el último identificador del directorio.
Para eliminar de forma recursiva los archivos de un directorio, use la función SHFileOperation .
RemoveDirectory se puede usar para quitar una unión de directorios. Dado que el directorio de destino y su contenido seguirán siendo accesibles a través de su ruta de acceso canónica, el propio directorio de destino no se ve afectado quitando una unión que tenga como destino. Por este motivo, cuando lpPathName hace referencia a una unión de directorios, RemoveDirectory quitará el vínculo especificado independientemente de si el directorio de destino está vacío o no. Para obtener más información sobre las uniones, vea Vínculos duros y uniones.
El uso de la eliminación POSIX hace que el directorio se elimine mientras los identificadores permanecen abiertos. Las llamadas posteriores a CreateDirectory para abrir el directorio producen un error con ERROR_FILE_NOT_FOUND.
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í |
Nota
El encabezado fileapi.h define RemoveDirectory como 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 |
Vea también
Creación y eliminación de directorios