Función MoveFileWithProgressA (winbase.h)

Artículo
06/02/2023

Mueve un archivo o un directorio, incluidos sus elementos secundarios. Puede proporcionar una función de devolución de llamada que reciba notificaciones del progreso.

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

Sintaxis

BOOL MoveFileWithProgressA(
  [in]           LPCSTR             lpExistingFileName,
  [in, optional] LPCSTR             lpNewFileName,
  [in, optional] LPPROGRESS_ROUTINE lpProgressRoutine,
  [in, optional] LPVOID             lpData,
  [in]           DWORD              dwFlags
);

Parámetros

[in] lpExistingFileName

Nombre del archivo o directorio existente en el equipo local.

Si dwFlags especifica MOVEFILE_DELAY_UNTIL_REBOOT, el archivo no puede existir en un recurso compartido remoto porque las operaciones retrasadas se realizan antes de que la red esté disponible.

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.

[in, optional] lpNewFileName

Nuevo nombre del archivo o directorio en el equipo local.

Al mover un archivo, lpNewFileName puede estar en otro sistema de archivos o volumen. Si lpNewFileName está en otra unidad, debe establecer la marca MOVEFILE_COPY_ALLOWED en dwFlags.

Al mover un directorio, lpExistingFileName y lpNewFileName deben estar en la misma unidad.

Si dwFlags especifica MOVEFILE_DELAY_UNTIL_REBOOT y lpNewFileName es NULL, MoveFileWithProgress registra lpExistingFileName que se eliminará cuando se reinicie el sistema. Se produce un error en la función si no puede acceder al Registro para almacenar la información sobre la operación de eliminación. Si lpExistingFileName hace referencia a un directorio, el sistema quita el directorio al reiniciarse solo si el directorio está vacío.

Sugerencia

[in, optional] lpProgressRoutine

Puntero a una función de devolución de llamada CopyProgressRoutine a la que se llama cada vez que se ha movido otra parte del archivo. La función de devolución de llamada puede ser útil si proporciona una interfaz de usuario que muestra el progreso de la operación. Este parámetro puede ser NULL.

[in, optional] lpData

Argumento que se va a pasar a la función de devolución de llamada CopyProgressRoutine . Este parámetro puede ser NULL.

[in] dwFlags

Opciones de movimiento. Este parámetro puede ser uno o más de los siguientes valores.

Valor	Significado
MOVEFILE_COPY_ALLOWED 2 (0x2)	Si el archivo se va a mover a un volumen diferente, la función simula el movimiento mediante las funciones CopyFile y DeleteFile . Si el archivo se copia correctamente en un volumen diferente y el archivo original no se puede eliminar, la función se realiza correctamente dejando intacto el archivo de origen. Este valor no se puede usar con MOVEFILE_DELAY_UNTIL_REBOOT.
MOVEFILE_CREATE_HARDLINK 16 (0x10)	Reservado para uso futuro.
MOVEFILE_DELAY_UNTIL_REBOOT 4 (0x4)	El sistema no mueve el archivo hasta que se reinicia el sistema operativo. El sistema mueve el archivo inmediatamente después de ejecutar AUTOCHK, pero antes de crear los archivos de paginación. Por lo tanto, este parámetro permite que la función elimine los archivos de paginación de las startups anteriores. Este valor solo se puede usar si el proceso está en el contexto de un usuario que pertenece al grupo de administradores o a la cuenta LocalSystem. Este valor no se puede usar con MOVEFILE_COPY_ALLOWED.
MOVEFILE_FAIL_IF_NOT_TRACKABLE 32 (0x20)	Se produce un error en la función si el archivo de origen es un origen de vínculo, pero no se puede realizar el seguimiento del archivo después del traslado. Esta situación puede producirse si el destino es un volumen con formato con el sistema de archivos FAT.
MOVEFILE_REPLACE_EXISTING 1 (0x1)	Si existe un archivo denominado lpNewFileName , la función reemplaza su contenido por el contenido del archivo lpExistingFileName . Este valor no se puede usar si lpNewFileName o lpExistingFileName asigna un nombre a un directorio.
MOVEFILE_WRITE_THROUGH 8 (0x8)	La función no devuelve hasta que el archivo se haya movido realmente en el disco. Si se establece este valor, se garantiza que un movimiento realizado como operación de copia y eliminación se vacía en el disco antes de que la función devuelva. El vaciado se produce al final de la operación de copia. Este valor no tiene ningún efecto si se establece MOVEFILE_DELAY_UNTIL_REBOOT .

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.

Al mover un archivo entre volúmenes, si lpProgressRoutine devuelve PROGRESS_CANCEL debido a que el usuario cancela la operación, MoveFileWithProgress devolverá cero y GetLastError devolverá ERROR_REQUEST_ABORTED. El archivo existente se deja intacto.

Al mover un archivo entre volúmenes, si lpProgressRoutine devuelve PROGRESS_STOP debido a que el usuario detiene la operación, MoveFileWithProgress devolverá cero y GetLastError devolverá ERROR_REQUEST_ABORTED. El archivo existente se deja intacto.

Comentarios

La función MoveFileWithProgress coordina su operación con el servicio de seguimiento de vínculos, por lo que se puede realizar un seguimiento de los orígenes de vínculo a medida que se mueven.

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. Si configura un directorio con todo el acceso excepto eliminar y eliminar secundario y se heredan las ACL de los nuevos archivos, debe poder crear un archivo sin poder eliminarlo. Sin embargo, puede crear un archivo y obtendrá todo el acceso que solicite en el identificador devuelto en el momento en que cree el archivo. Si solicitó el permiso de eliminación en el momento en que creó el archivo, podría eliminar o cambiar el nombre del archivo con ese identificador, pero no con ningún otro.

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

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í

CsvFs realizará la E/S redirigida para los archivos comprimidos.

Nota

El encabezado winbase.h define MoveFileWithProgress 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 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winbase.h (incluya Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll