Función CopyFileExA (winbase.h)

Artículo
03/03/2024

Copia un archivo existente en un nuevo archivo y notifica a la aplicación su progreso mediante una función de devolución de llamada.

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

Sintaxis

BOOL CopyFileExA(
  [in]           LPCSTR             lpExistingFileName,
  [in]           LPCSTR             lpNewFileName,
  [in, optional] LPPROGRESS_ROUTINE lpProgressRoutine,
  [in, optional] LPVOID             lpData,
  [in, optional] LPBOOL             pbCancel,
  [in]           DWORD              dwCopyFlags
);

Parámetros

[in] lpExistingFileName

Nombre de un archivo existente.

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.

Si lpExistingFileName no existe, se produce un error en la función CopyFileEx y la función GetLastError devuelve ERROR_FILE_NOT_FOUND.

[in] lpNewFileName

Nombre del nuevo archivo.

Sugerencia

[in, optional] lpProgressRoutine

Dirección de una función de devolución de llamada de tipo LPPROGRESS_ROUTINE que se llama cada vez que se ha copiado otra parte del archivo. Este parámetro puede ser NULL. Para obtener más información sobre la función de devolución de llamada de progreso, consulte la función CopyProgressRoutine .

[in, optional] lpData

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

[in, optional] pbCancel

Si esta marca se establece en TRUE durante la operación de copia, se cancela la operación. De lo contrario, la operación de copia seguirá completando.

[in] dwCopyFlags

Marcas que especifican cómo se va a copiar el archivo. Este parámetro puede ser una combinación de los valores siguientes.

Value	Significado
COPY_FILE_ALLOW_DECRYPTED_DESTINATION 0x00000008	Un intento de copiar un archivo cifrado se realizará correctamente incluso si la copia de destino no se puede cifrar.
COPY_FILE_COPY_SYMLINK 0x00000800	Si el archivo de origen es un vínculo simbólico, el archivo de destino también es un vínculo simbólico que apunta al mismo archivo al que apunta el vínculo simbólico de origen. Windows Server 2003 y Windows XP: Este valor no se admite.
COPY_FILE_FAIL_IF_EXISTS 0x00000001	La operación de copia produce un error inmediatamente si el archivo de destino ya existe.
COPY_FILE_NO_BUFFERING 0x00001000	La operación de copia se realiza mediante E/S sin búfer, pasando los recursos de caché de E/S del sistema. Recomendado para transferencias de archivos muy grandes. Windows Server 2003 y Windows XP: Este valor no se admite.
COPY_FILE_OPEN_SOURCE_FOR_WRITE 0x00000004	El archivo se copia y el archivo original se abre para el acceso de escritura.
COPY_FILE_RESTARTABLE 0x00000002	Se realiza un seguimiento del progreso de la copia en el archivo de destino en caso de que se produzca un error en la copia. La copia con errores se puede reiniciar más adelante especificando los mismos valores para lpExistingFileName y lpNewFileName como los usados en la llamada que produjo un error. Esto puede ralentizar significativamente la operación de copia, ya que el nuevo archivo se puede vaciar varias veces durante la operación de copia.
COPY_FILE_REQUEST_COMPRESSED_TRAFFIC 0x10000000	Solicite al canal de transferencia subyacente comprimir los datos durante la operación de copia. Es posible que la solicitud no se admita para todos los medios, en cuyo caso se omite. Los atributos y parámetros de compresión (complejidad computacional, uso de memoria) no se pueden configurar a través de esta API y están sujetos a cambios entre diferentes versiones del sistema operativo. Esta marca se introdujo en Windows 10, versión 1903 y Windows Server 2022. En Windows 10, la marca es compatible con los archivos que residen en recursos compartidos SMB, donde la versión negociada del protocolo SMB es SMB v3.1.1 o superior.

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.

Si lpProgressRoutine devuelve PROGRESS_CANCEL debido a que el usuario cancela la operación, CopyFileEx devolverá cero y GetLastError devolverá ERROR_REQUEST_ABORTED. En este caso, se elimina el archivo de destino parcialmente copiado.

Si lpProgressRoutine devuelve PROGRESS_STOP debido a que el usuario detiene la operación, CopyFileEx devolverá cero y GetLastError devolverá ERROR_REQUEST_ABORTED. En este caso, el archivo de destino parcialmente copiado se deja intacto.

Comentarios

Esta función conserva atributos extendidos, almacenamiento estructurado OLE, flujos de datos alternativos del sistema de archivos NTFS, atributos de recursos de seguridad y atributos de archivo.

Windows 7, Windows Server 2008 R2, Windows Server 2008, Windows Vista, Windows Server 2003 y Windows XP: Los atributos de recursos de seguridad (ATTRIBUTE_SECURITY_INFORMATION) del archivo existente no se copian en el nuevo archivo hasta Windows 8 y Windows Server 2012.

Las propiedades del recurso de seguridad (ATTRIBUTE_SECURITY_INFORMATION) del archivo existente se copian en el nuevo archivo.

Windows 7, Windows Server 2008 R2, Windows Server 2008, Windows Vista, Windows Server 2003 y Windows XP: Las propiedades de recursos de seguridad del archivo existente no se copian en el nuevo archivo hasta que Windows 8 y Windows Server 2012.

Esta función produce un error con ERROR_ACCESS_DENIED si el archivo de destino ya existe y tiene el FILE_ATTRIBUTE_HIDDEN o FILE_ATTRIBUTE_READONLY conjunto de atributos.

Cuando los archivos cifrados se copian mediante CopyFileEx, la función intenta cifrar el archivo de destino con las claves usadas en el cifrado del archivo de origen. Si esto no se puede hacer, esta función intenta cifrar el archivo de destino con claves predeterminadas. Si no se pueden realizar ambos métodos, CopyFileEx produce un error ERROR_ENCRYPTION_FAILED código de error. Si desea que CopyFileEx complete la operación de copia incluso si no se puede cifrar el archivo de destino, incluya el COPY_FILE_ALLOW_DECRYPTED_DESTINATION como valor del parámetro dwCopyFlags en la llamada a CopyFileEx.

Si se especifica COPY_FILE_COPY_SYMLINK , se aplican las reglas siguientes:

El archivo de origen es un vínculo simbólico, se copiará el vínculo simbólico, no el archivo de destino.
El archivo de origen no es un vínculo simbólico, no habrá ningún cambio en el comportamiento.
El archivo de destino es un vínculo simbólico existente, el vínculo simbólico se sobrescribirá, y no el archivo de destino.
Si también se especifica COPY_FILE_FAIL_IF_EXISTS y el archivo de destino es un vínculo simbólico existente, se producirá un error en la operación en todos los casos.

Si no se especifica COPY_FILE_COPY_SYMLINK, se aplican las reglas siguientes:

También se especifica COPY_FILE_FAIL_IF_EXISTS y el archivo de destino es un vínculo simbólico existente, se producirá un error solo si el destino del vínculo simbólico existe.
Si no se especifica COPY_FILE_FAIL_IF_EXISTS, no habrá ningún cambio en el comportamiento.

Windows 7, Windows Server 2008 R2, Windows Server 2008, Windows Vista, Windows Server 2003 y Windows XP: Si está escribiendo una aplicación que optimiza las operaciones de copia de archivos en una LAN, considere la posibilidad de usar la función TransmitFile de Windows Sockets (Winsock). TransmitFile admite transferencias de red de alto rendimiento y proporciona una interfaz sencilla para enviar el contenido de un archivo a un equipo remoto. Para usar TransmitFile, debe escribir una aplicación cliente winsock que envíe el archivo desde el equipo de origen, así como una aplicación de servidor winsock que use otras funciones de Winsock para recibir el archivo en el equipo remoto.

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í

Nota

El encabezado winbase.h define CopyFileEx 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o 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	winbase.h (incluye Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll