DirRemove [AS]
Autor: Eurai Criado: 01/01/2016 Atualizado: 25/04/2025Descrição
DirRemove [AS] - Remove um diretório específico. |
Sintaxe
DirRemove( <cPath>, <uParam1>, <lChangeCase> ) |
Parâmetros
Par | Nome | Tipo | Descrição | Default | Obg | Ref |
01 |
cPath |
Caracter |
Indica o nome do diretório que será removido |
X | ||
02 | uParam1 |
Indefinido |
Parâmetro de compatibilidade. Passar Nil |
X | ||
03 | lChangeCase |
Boolean | Indica se colocará o nome do diretório em letra minúscula |
Retorno
Retorno | Tipo | Descrição |
lRet | Boolean |
Retorna verdadeiro (.T.), se o diretório for removido com sucesso; caso contrário, falso (.F.). |
Exemplo
#INCLUDE "TOTVS.CH" User Function DirRemove() If DirRemove( "C:\TEMP\" ) Conout( 'Removido com Sucesso' ) Endif Return( Nil )
Resultado
Informações adicionais
Caso seja especificado um path sem a unidade de disco, o mesmo será considerado no ambiente do servidor, a partir do RootPath do ambiente (caso o path comece com \ ou /), ou a partir do diretório corrente (caso o path não seja iniciado com \ ou /). |
Quando um path absoluto é especificado (com unidade de disco preenchida), a função será executada na estação em que o SmartClient está em execução |
O valor retornado pela função serve apenas para indicar falha na operação, mas não têm relação com a causa da falha. Para identificar o motivo do erro, devemos chamar a função FError |
Ao executar essa função em JOB (processo isolado do servidor, sem interface), não é possível especificar um Path absoluto de disco. Caso isso seja realizado, o retorno da função será .F. e a função FError retornará -1 (Syntax Error). |
Para remover o diretório, é necessário ter permissão correspondente (incluir, alterar e excluir) e que o mesmo esteja vazio; ou seja, sem subdiretórios ou arquivos |
O caminho de cPath será convertido para letra minúscula. A partir da build 7.00.121227A, o caminho não será convertido para letra minúscula para Logix |
A partir da build 7.00.120420A, o comportamento de mudança para letra minúscula, para Linux, pode ser alterado modificando o valor da chave CaseSensitive, na seção General, do arquivo ini do TOTVS | Application Server. Essa mudança impacta outras funções que também tratam arquivos |
A partir da build 7.00.131227A foi criado o parâmetro lChangeCase, que se for definido com o valor .T., altera o nome dos arquivos e pastas para letra minúscula, e se for .F. não altera o nome informado. O valor padrão do parâmetro é .T. |
Em ambiente Windows, os nomes de arquivos e pastas não possuem diferenciação entre maiúsculo e minúsculo, logo, a função conseguirá tratar a pasta apontada por cPath independente do valor definido no parâmetro lChangeCase. Em ambiente Linux ou Mac, os nomes dos arquivos e pastas respeitam a diferenciação |
Gostou? Compartilhe com seus amigos e deixe um comentário! 😎
Discussão (0)
Sem comentários ainda
Realize o LOGIN no site para poder comentar