Função GetFileAttributesA (fileapi.h)
Recupera atributos do sistema de arquivos para um arquivo ou diretório especificado.
Para obter mais informações de atributo, use a função GetFileAttributesEx .
Para executar essa operação como uma operação transacionada, use a função GetFileAttributesTransacted .
Sintaxe
DWORD GetFileAttributesA(
[in] LPCSTR lpFileName
);
Parâmetros
[in] lpFileName
O nome do diretório ou arquivo.
Por padrão, o nome é limitado a caracteres MAX_PATH. Para estender esse limite para 32.767 caracteres largos, preencha "\\?\" para o caminho. Para obter mais informações, confira Nomear arquivos, caminhos e namespaces.
Dica
A partir do Windows 10, versão 1607, você pode optar por remover a limitação de MAX_PATH sem acrescentar "\\?\". Consulte a seção "Limitação máxima de comprimento do caminho" de Arquivos de Nomenclatura, Caminhos e Namespaces para obter detalhes.
Retornar valor
Se a função for bem-sucedida, o valor retornado conterá os atributos do arquivo ou diretório especificado. Para obter uma lista de valores de atributo e suas descrições, consulte Constantes de atributo de arquivo.
Se a função falhar, o valor retornado será INVALID_FILE_ATTRIBUTES. Para obter informações de erro estendidas, chame GetLastError.
Comentários
Quando GetFileAttributes é chamado em um diretório que é uma pasta montada, ele retorna os atributos do sistema de arquivos do diretório, não os do diretório raiz no volume que a pasta montada associa ao diretório. Para obter os atributos de arquivo do volume associado, chame GetVolumeNameForVolumeMountPoint para obter o nome do volume associado. Em seguida, use o nome resultante em uma chamada para GetFileAttributes. Os resultados são os atributos do diretório raiz no volume associado.
Se você chamar GetFileAttributes para um compartilhamento de rede, a função falhará e GetLastError retornará ERROR_BAD_NETPATH. Você deve especificar um caminho para uma subpasta nesse compartilhamento.
Em Windows 8 e Windows Server 2012, essa função é compatível com as tecnologias a seguir.
Tecnologia | Com suporte |
---|---|
Protocolo SMB (Bloco de Mensagens do Servidor) 3.0 | Sim |
TFO (Failover Transparente) do SMB 3.0 | Sim |
SMB 3.0 com compartilhamentos de arquivos de expansão (SO) | Sim |
Sistema de arquivos de volume compartilhado de cluster (CsvFS) | Sim |
ReFS (Sistema de Arquivos Resiliente) | Sim |
Comportamento simbólico do link – se o caminho apontar para um link simbólico, a função retornará atributos para o link simbólico.
Operações transacionadas
Se um arquivo estiver aberto para modificação em uma transação, nenhum outro thread poderá abrir o arquivo para modificação até que a transação seja confirmada. Portanto, se um thread transacionado abrir o arquivo primeiro, todos os threads subsequentes que tentarem modificar o arquivo antes que a transação seja confirmada receberão uma violação de compartilhamento. Se um thread não transacionado modificar o arquivo antes do thread transacionado e o arquivo ainda estiver aberto quando a transação tentar abri-lo, a transação receberá o erro ERROR_TRANSACTIONAL_CONFLICT.Exemplos
Para obter um exemplo, consulte Recuperando e alterando atributos de arquivo.
Observação
O cabeçalho fileapi.h define GetFileAttributes como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.
Requisitos
Cliente mínimo com suporte | Windows XP [aplicativos da área de trabalho | Aplicativos UWP] |
Servidor mínimo com suporte | Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP] |
Plataforma de Destino | Windows |
Cabeçalho | fileapi.h (inclua Windows.h) |
Biblioteca | Kernel32.lib |
DLL | Kernel32.dll |
Confira também
Constantes de atributo de arquivo