Função DeleteFile (winbase.h)

Exclui um arquivo existente.

Para executar essa operação como uma operação transacionada, use a função DeleteFileTransacted .

Sintaxe

BOOL DeleteFile(
  [in] LPCTSTR lpFileName
);

Parameters

[in] lpFileName

O nome do arquivo a ser excluído.

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, veja Naming Files, Paths, and Namespaces (Nomenclatura de Ficheiros, Caminhos e Espaços de Nomes).

Valor de devolução

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero (0). Para obter informações de erro estendidas, chame GetLastError.

Observações

Se um aplicativo tentar excluir um arquivo que não existe, a função DeleteFile falhará com ERROR_FILE_NOT_FOUND. Se o arquivo for um arquivo somente leitura, a função falhará com ERROR_ACCESS_DENIED.

A lista a seguir identifica algumas dicas para excluir, remover ou fechar arquivos:

• Para excluir um arquivo somente leitura, primeiro você deve remover o atributo somente leitura.
• Para excluir ou renomear um arquivo, você deve ter permissão de exclusão no arquivo ou excluir a permissão filho no diretório pai.
• Para excluir recursivamente os arquivos em um diretório, use a função SHFileOperation .
• Para remover um diretório vazio, use a função RemoveDirectory .
• Para fechar um arquivo aberto, use a função CloseHandle .

Se você solicitar permissão de exclusão no momento em que criar um arquivo, poderá excluir ou renomear o arquivo com esse identificador, mas não com qualquer outro identificador. Para obter mais informações, consulte de Segurança de Arquivos e Direitos de Acesso.

A função DeleteFile falhará se um aplicativo tentar excluir um arquivo que tenha outros identificadores abertos que foram abertos sem FILE_SHARE_DELETE ou que seja mapeado pela memória.

A função DeleteFile marca um arquivo para exclusão no fechamento. Portanto, a exclusão de arquivo não ocorre até que o último identificador do arquivo seja fechado. As chamadas subsequentes para CreateFile para abrir o arquivo falham com ERROR_ACCESS_DENIED.

Comportamento de vínculo simbólico:

Se o caminho apontar para um link simbólico, o link simbólico será excluído, não o destino. Para excluir um destino, você deve chamar CreateFile e especificar FILE_FLAG_DELETE_ON_CLOSE.

No Windows 8 e no Windows Server 2012, essa função é compatível com as tecnologias a seguir.

Exemplos

Para obter um exemplo, consulte Bloqueio e desbloqueio de intervalos de bytes em arquivos.

Requirements

Consulte também

CloseHandle

CreateFile

DeleteFileTransacted

Funções de gerenciamento de arquivos

links simbólicos