Função SetFileAttributesA (fileapi.h)
Define os atributos de um arquivo ou diretório.
Para executar essa operação como uma operação transacionada, use a função SetFileAttributesTransacted.
Sintaxe
BOOL SetFileAttributesA(
[in] LPCSTR lpFileName,
[in] DWORD dwFileAttributes
);
Parâmetros
[in] lpFileName
O nome do arquivo cujos atributos devem ser definidos.
Por padrão, o nome é limitado a MAX_PATH caracteres. Para estender esse limite para 32.767 caracteres de largura, acrescente "\\?\" ao caminho. Para obter mais informações, consulte Arquivos de Nomenclatura, Caminhos e Namespaces.
Ponta
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 do comprimento do caminho" de arquivos de nomenclatura, caminhos e namespaces para obter detalhes.
[in] dwFileAttributes
Os atributos de arquivo a serem definidos para o arquivo.
Esse parâmetro pode ser um ou mais valores, combinados usando o operador OR bit a bit. No entanto, todos os outros valores substituem FILE_ATTRIBUTE_NORMAL.
Nem todos os atributos têm suporte nessa função. Para obter mais informações, consulte a seção Comentários.
Veja a seguir uma lista de valores de atributo com suporte.
Valor de retorno
Se a função for bem-sucedida, o valor retornado não será zero.
Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.
Observações
A tabela a seguir descreve como definir os atributos que não podem ser definidos usando SetFileAttributes. Para obter uma lista completa de todos os valores de atributo de arquivo e suas descrições, consulte Constantes de Atributo de Arquivo.
| Atributo | Como definir |
|---|---|
|
FILE_ATTRIBUTE_COMPRESSED
0x800 |
Para definir o estado de compactação de um arquivo, use a função |
|
FILE_ATTRIBUTE_DEVICE
0x40 |
Reservado; não use. |
|
FILE_ATTRIBUTE_DIRECTORY
0x10 |
Os arquivos não podem ser convertidos em diretórios. Para criar um diretório, use a função CreateDirectory ou CreateDirectoryEx. |
|
FILE_ATTRIBUTE_ENCRYPTED
0x4000 |
Para criar um arquivo criptografado, use a função CreateFile com o atributo FILE_ATTRIBUTE_ENCRYPTED. Para converter um arquivo existente em um arquivo criptografado, use a função EncryptFile. |
|
FILE_ATTRIBUTE_REPARSE_POINT
0x400 |
Para associar um ponto de nova análise a um arquivo ou diretório, use a função |
|
FILE_ATTRIBUTE_SPARSE_FILE
0x200 |
Para definir o atributo esparso de um arquivo, use a função DeviceIoControl com a operação FSCTL_SET_SPARSE. |
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, 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.No Windows 8 e no Windows Server 2012, essa função é compatível com as tecnologias a seguir.
| Tecnologia | Suportado |
|---|---|
| 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 |
Exemplos
Para obter um exemplo, consulte Recuperar e alterar atributos de arquivo.
Nota
O cabeçalho fileapi.h define SetFileAttributes como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| de cliente com suporte mínimo | Windows XP [aplicativos da área de trabalho | Aplicativos UWP] |
| servidor com suporte mínimo | Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP] |
| da Plataforma de Destino |
Windows |
| cabeçalho | fileapi.h (inclua Windows.h) |
| biblioteca | Kernel32.lib |
| de DLL |
Kernel32.dll |
Consulte também
constantes de atributo de arquivo