Função RemoveDirectoryA (fileapi.h)

Exclui um diretório vazio existente.

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

Sintaxe

BOOL RemoveDirectoryA(
  [in] LPCSTR lpPathName
);

Parâmetros

[in] lpPathName

O caminho do diretório a ser removido. Esse caminho deve especificar um diretório vazio e o processo de chamada deve ter acesso de exclusão ao diretório.

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.

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 função RemoveDirectory marca um diretório para exclusão no fechamento. Portanto, o diretório não será removido até que o último identificador do diretório seja fechado.

Para excluir recursivamente os arquivos em um diretório, use a função SHFileOperation.

RemoveDirectory pode ser usado para remover uma junção de diretório. Como o diretório de destino e seu conteúdo permanecerão acessíveis por meio de seu caminho canônico, o diretório de destino em si não é afetado pela remoção de uma junção direcionada a ele. Por esse motivo, quando lpPathName se refere a uma junção de diretório, RemoveDirectory removerá o link especificado, independentemente de o diretório de destino estiver vazio ou não. Para obter mais informações sobre junções, consulte links rígidos e junções.

O uso da exclusão POSIX faz com que o diretório seja excluído enquanto os identificadores permanecem abertos. Chamadas subsequentes para CreateDirectory para abrir o diretório falham com ERROR_FILE_NOT_FOUND.

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

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

Nota

O cabeçalho fileapi.h define RemoveDirectory 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

CreateDirectory

criando e excluindo diretórios

Funções de gerenciamento de diretório

RemoveDirectoryTransacted