Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Composition Setup
import.css=/download/attachments/3279126062824/newLayouttecnologia.css
Portuguese

Pagetitle

...

DirRemove

DirRemove

Remove

...

um

...

diretório

...

específico.

Sintaxe

Bloco de código
collapsefalse
DirRemove(
< cDiretorio> ) --> lRet Parâmetros/Elementos
 < cPath >, [ uParam1 ], [ lChangeCase ] )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

...

cPath

...

caractere

Indica o nome do diretório que será removido.

X

 

uParam1

numérico

Parâmetro de compatibilidade. Passar Nil.

 

 

lChangeCase

lógico

Indica se colocará o nome do diretório em letra minúscula.

 

 

Retorno

Nome

Tipo

Descrição

lRet

...

lógico

Retorna

...

verdadeiro (.T.), se o diretório for

...

removido com sucesso; caso contrário, falso (.F.).

...

Observações

  • 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.

Exemplos

Bloco de código
themeEclipse
languagecpp
titleExemplo 1
linenumberstrue
collapsefalse
user function teste()
  Local cDelPath := 
'
"c:\TmpFiles
'
"
  Local lRemoveOk := 
DIRREMOVE
DirRemove( cDelPath
)IF
 )
  
  if !lRemoveOk

    MsgStop(
'
 "Falha ao remover a pasta." 
'
)
Else

  else
    MsgStop(
'
 "Pasta 
'
" + cDelPath +
'
 " removida com sucesso.
')Endif Advanced Protheus 6.09 , Advanced Protheus 7.10 , Microsiga Protheus 8.11 , Protheus 10 , TOTVS Application Server 10 , ByYou Application Server
" )
  endif
return

Abrangência

Todas as versões

Veja também