Función GetFileAttributesA (fileapi.h)

Artículo
06/02/2023

Recupera los atributos del sistema de archivos para un archivo o directorio especificados.

Para obtener más información de atributos, use la función GetFileAttributesEx .

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

Sintaxis

DWORD GetFileAttributesA(
  [in] LPCSTR lpFileName
);

Parámetros

[in] lpFileName

Nombre del archivo o directorio.

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.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto contiene los atributos del archivo o directorio especificados. Para obtener una lista de los valores de atributo y sus descripciones, vea Constantes de atributo de archivo.

Si se produce un error en la función, el valor devuelto se INVALID_FILE_ATTRIBUTES. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Cuando se llama a GetFileAttributes en un directorio que es una carpeta montada, devuelve los atributos del sistema de archivos del directorio, no los del directorio raíz del volumen que la carpeta montada asocia al directorio. Para obtener los atributos de archivo del volumen asociado, llame a GetVolumeNameForVolumeMountPoint para obtener el nombre del volumen asociado. A continuación, use el nombre resultante en una llamada a GetFileAttributes. Los resultados son los atributos del directorio raíz del volumen asociado.

Si llama a GetFileAttributes para un recurso compartido de red, se produce un error en la función y GetLastError devuelve ERROR_BAD_NETPATH. Debe especificar una ruta de acceso a una subcarpeta en ese recurso compartido.

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í

Comportamiento de vínculo simbólico: si la ruta de acceso apunta a un vínculo simbólico, la función devuelve atributos para el vínculo simbólico.

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.

Ejemplos

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

Nota:

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