Función SetFileAttributesTransactedA (winbase.h)

Artículo
06/02/2023

[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].

Establece los atributos de un archivo o directorio como una operación de transacción.

Sintaxis

BOOL SetFileAttributesTransactedA(
  [in] LPCSTR lpFileName,
  [in] DWORD  dwFileAttributes,
  [in] HANDLE hTransaction
);

Parámetros

[in] lpFileName

Nombre del archivo cuyos atributos se van a establecer.

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.

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] dwFileAttributes

Atributos de archivo que se van a establecer para el archivo.

Para obtener una lista de los valores de atributo de archivo y sus descripciones, vea Constantes de atributo de archivo. Este parámetro puede ser uno o varios valores, combinados mediante el operador OR bit a bit. Sin embargo, todos los demás valores invalidan FILE_ATTRIBUTE_NORMAL.

Esta función no admite todos los atributos. Para obtener más información, vea la sección Comentarios.

A continuación se muestra una lista de valores de atributo admitidos.

FILE_ATTRIBUTE_ARCHIVE (32 (0x20))

FILE_ATTRIBUTE_HIDDEN (2 (0x2))

FILE_ATTRIBUTE_NORMAL (128 (0x80))

FILE_ATTRIBUTE_NOT_CONTENT_INDEXED (8192 (0x2000))

FILE_ATTRIBUTE_OFFLINE (4096 (0x1000))

FILE_ATTRIBUTE_READONLY (1 (0x1))

FILE_ATTRIBUTE_SYSTEM (4 (0x4))

FILE_ATTRIBUTE_TEMPORARY (256 (0x100))

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

Comentarios

En la tabla siguiente se describe cómo establecer los atributos que no se pueden establecer mediante SetFileAttributesTransacted. Tenga en cuenta que estas no son operaciones de transacción.

Atributo	Cómo establecer
FILE_ATTRIBUTE_COMPRESSED 0x800	Para establecer el estado de compresión de un archivo, use la función DeviceIoControl con la operación FSCTL_SET_COMPRESSION .
FILE_ATTRIBUTE_DEVICE 0x40	Reservado; no usar.
FILE_ATTRIBUTE_DIRECTORY 0x10	Los archivos no se pueden convertir en directorios. Para crear un directorio, use la función CreateDirectory o CreateDirectoryEx .
FILE_ATTRIBUTE_ENCRYPTED 0x4000	Para crear un archivo cifrado, use la función CreateFile con el atributo FILE_ATTRIBUTE_ENCRYPTED . Para convertir un archivo existente en un archivo cifrado, use la función EncryptFile .
FILE_ATTRIBUTE_REPARSE_POINT 0x400	Para asociar un punto de reanálisis a un archivo o directorio, use la función DeviceIoControl con la operación FSCTL_SET_REPARSE_POINT .
FILE_ATTRIBUTE_SPARSE_FILE 0x200	Para establecer el atributo disperso de un archivo, use la función DeviceIoControl con la operación FSCTL_SET_SPARSE .

Si un archivo está abierto para su modificación en una transacción, ningún otro subproceso puede abrir correctamente el archivo para su modificación hasta que se confirme la transacción. Si un subproceso de transacción abre primero el archivo, cualquier subproceso posterior que intente abrir el archivo para su modificación antes de confirmar la transacción recibirá una infracción de uso compartido. Si un subproceso no transaccionado abre el archivo para su modificación antes de que lo haga el subproceso de transacción y todavía está abierto cuando el subproceso de transacción intenta abrirlo, la transacción recibirá el error de ERROR_TRANSACTIONAL_CONFLICT .

Para obtener más información sobre las transacciones, vea NTFS transaccional.

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

SMB 3.0 no admite TxF.

Operaciones de transacción

Si un archivo está abierto para su modificación en una transacción, ningún otro subproceso puede abrir el archivo para su modificación hasta que se confirme la transacción. Por lo tanto, si un subproceso de transacción abre primero el archivo, cualquier subproceso posterior que intente modificar el archivo antes de que se confirme la transacción recibe una infracción de uso compartido. Si un subproceso no transaccionado modifica el archivo antes de que lo haga el subproceso de transacción y el archivo sigue abierto cuando la transacción intenta abrirlo, la transacción recibe el error ERROR_TRANSACTIONAL_CONFLICT.

Nota

El encabezado winbase.h define SetFileAttributesTransacted 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