Función CopyFileExA (winbase.h)
Copia un archivo existente en un nuevo archivo, notificando a la aplicación su progreso a través de una función de devolución de llamada.
Para realizar esta operación como una operación de transacción, use la función
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 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 Archivos de nomenclatura, rutas de acceso y espacios de nombres.
Propina
A partir de Windows 10, versión 1607, puedes optar por quitar la limitación del MAX_PATH sin tener que prepending "\\?\". Consulte la sección "Limitación máxima de longitud de ruta de acceso" de Archivos de nomenclatura, rutas de acceso y espacios de nombres para obtener más información.
Si lpExistingFileName no existe, la función copyFileEx produce un error y la función GetLastError devuelve ERROR_FILE_NOT_FOUND.
[in] lpNewFileName
Nombre del nuevo archivo.
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 Archivos de nomenclatura, rutas de acceso y espacios de nombres.
Propina
A partir de Windows 10, versión 1607, puedes optar por quitar la limitación del MAX_PATH sin tener que prepending "\\?\". Consulte la sección "Limitación máxima de longitud de ruta de acceso" de Archivos de nomenclatura, rutas de acceso y espacios de nombres para obtener más información.
[in, optional] lpProgressRoutine
Dirección de una función de devolución de llamada de tipo LPPROGRESS_ROUTINE a la 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
[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 continuará completando.
[in] dwCopyFlags
Marcas que especifican cómo se va a copiar el archivo. Este parámetro puede ser una combinación de los siguientes valores.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es distinto de cero.
Si se produce un error en la función, el valor devuelto es cero. Para obtener la llamada de información de error extendida 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 copiado parcialmente.
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 copiado parcialmente se deja intacto.
Observaciones
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: Atributos de recursos de seguridad (ATTRIBUTE_SECURITY_INFORMATION) para el 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 de para el archivo existente no se copian en el nuevo archivo hasta 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 atributo establecido.
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 con un código de error ERROR_ENCRYPTION_FAILED. Si desea
Si se especifica COPY_FILE_COPY_SYMLINK, se aplican las reglas siguientes:
- Si el archivo de origen es un vínculo simbólico, se copia el vínculo simbólico, no el archivo de destino.
- Si el archivo de origen no es un vínculo simbólico, no hay ningún cambio en el comportamiento.
- Si el archivo de destino es un vínculo simbólico existente, el vínculo simbólico se sobrescribe, 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 produce un error en la operación en todos los casos.
- Si también se especifica COPY_FILE_FAIL_IF_EXISTS y el archivo de destino es un vínculo simbólico existente, la operación produce un error solo si existe el destino del vínculo simbólico.
- Si no se especifica COPY_FILE_FAIL_IF_EXISTS, no hay 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 de 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 siguientes tecnologías.
| Tecnología | Soportado |
|---|---|
| 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 (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 Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| cliente mínimo admitido | Windows XP [aplicaciones de escritorio | Aplicaciones para UWP] |
| servidor mínimo admitido | Windows Server 2003 [aplicaciones de escritorio | Aplicaciones para UWP] |
| de la plataforma de destino de |
Windows |
| encabezado de |
winbase.h (incluya Windows.h) |
| biblioteca de |
Kernel32.lib |
| DLL de |
Kernel32.dll |
Consulte también
constantes de atributo de archivo de