Función CopyFileTransactedW (winbase.h)

Artículo
03/13/2024

[Microsoft recomienda encarecidamente que los desarrolladores usen medios alternativos para lograr las necesidades de la aplicación. Muchos escenarios para los que se desarrolló TxF se pueden lograr mediante técnicas más sencillas y disponibles. Además, es posible que TxF no esté disponible en versiones futuras de Microsoft Windows. Para más información y alternativas a TxF, consulte Alternativas al uso de NTFS transaccional].

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

Sintaxis

BOOL CopyFileTransactedW(
  [in]           LPCWSTR            lpExistingFileName,
  [in]           LPCWSTR            lpNewFileName,
  [in, optional] LPPROGRESS_ROUTINE lpProgressRoutine,
  [in, optional] LPVOID             lpData,
  [in, optional] LPBOOL             pbCancel,
  [in]           DWORD              dwCopyFlags,
  [in]           HANDLE             hTransaction
);

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 CopyFileTransacted y la función GetLastError devuelve ERROR_FILE_NOT_FOUND.

El archivo debe residir en el equipo local; de lo contrario, se produce un error en la función y el último código de error se establece en ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE.

[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 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 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 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 valores siguientes.

Value	Significado
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.
COPY_FILE_FAIL_IF_EXISTS 0x00000001	La operación de copia produce un error inmediatamente si el archivo de destino ya existe.
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.

[in] hTransaction

Identificador de la transacción. La función CreateTransaction devuelve este identificador.

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, CopyFileTransacted 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, CopyFileTransacted devolverá cero y GetLastError devolverá ERROR_REQUEST_ABORTED. En este caso, el archivo de destino copiado parcialmente se deja intacto.

Si intenta llamar a esta función con un identificador a una transacción que ya se ha revertido, CopyFileTransacted devolverá ERROR_TRANSACTION_NOT_ACTIVE o ERROR_INVALID_TRANSACTION.

Comentarios

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

Windows 7, Windows Server 2008 R2, Windows Server 2008 y Windows Vista: 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.

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

TxF no admite archivos cifrados.

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.

TxF no admite el seguimiento de vínculos.

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	No
Conmutación por error transparente (TFO) de SMB 3.0	No
SMB 3.0 con recursos compartidos de archivos de escalabilidad horizontal (SO)	No
Sistema de archivos de Volumen compartido de clúster (CsvFS)	No
Sistema de archivos resistente a errores (ReFS)	No

Tenga en cuenta que SMB 3.0 no admite TxF.

Nota

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