Función SetFileAttributesA (fileapi.h)

Artículo
06/02/2023

Establece los atributos de un archivo o directorio.

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

Sintaxis

BOOL SetFileAttributesA(
  [in] LPCSTR lpFileName,
  [in] DWORD  dwFileAttributes
);

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.

[in] dwFileAttributes

Atributos de archivo que se van a establecer para el 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.

Value	Significado
FILE_ATTRIBUTE_ARCHIVE 32 (0x20)	Un archivo o directorio que es un archivo o directorio de archivo. Las aplicaciones suelen usar este atributo para marcar los archivos de copia de seguridad o eliminación.
FILE_ATTRIBUTE_HIDDEN 2 (0x2)	El archivo o directorio está oculto. No se incluye en una lista de directorios normal.
FILE_ATTRIBUTE_NORMAL 128 (0x80)	Archivo que no tiene otros atributos establecidos. Este atributo solo es válido cuando se usa solo.
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED 8192 (0x2000)	El servicio de indexación de contenido no indexa el archivo o directorio.
FILE_ATTRIBUTE_OFFLINE 4096 (0x1000)	Los datos de un archivo no están disponibles inmediatamente. Este atributo indica que los datos del archivo se mueven físicamente al almacenamiento sin conexión. El almacenamiento remoto usa este atributo, que es el software de administración de almacenamiento jerárquico. Las aplicaciones no deben cambiar arbitrariamente este atributo.
FILE_ATTRIBUTE_READONLY 1 (0x1)	Un archivo que es de solo lectura. Las aplicaciones pueden leer el archivo, pero no pueden escribir en él ni eliminarlo. Este atributo no se respeta en directorios. Para obtener más información, vea "No puede ver ni cambiar los atributos de solo lectura o system de carpetas en Windows Server 2003, en Windows XP o en Windows Vista.
FILE_ATTRIBUTE_SYSTEM 4 (0x4)	Un archivo o directorio del que el sistema operativo usa una parte o utiliza exclusivamente.
FILE_ATTRIBUTE_TEMPORARY 256 (0x100)	Un archivo que se usa para el almacenamiento temporal. Los sistemas de archivos evitan volver a escribir datos en almacenamiento masivo si hay suficiente memoria caché disponible, ya que normalmente una aplicación elimina un archivo temporal después de cerrar el identificador. En ese escenario, el sistema puede evitar por completo la escritura de los datos. De lo contrario, los datos se escriben después de cerrar el 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 SetFileAttributes. Para obtener una lista completa de todos los valores de atributo de archivo y sus descripciones, vea Constantes de atributo de archivo.

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	Reservados; no use.
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 .

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.

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

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í

Ejemplos

Para obtener un ejemplo, vea Recuperar y cambiar atributos de archivo.

Nota:

El encabezado fileapi.h define SetFileAttributes 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


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	fileapi.h (incluye Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll