TOTVSTEC

Árvore de páginas

Carregando...
Tempo aproximado para leitura: 3 minutos

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 5 Próxima »

Exclui um arquivo do disco.

Sintaxe

FErase( < cArquivo >, [ xParam ], [ lChangeCase ] )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cArquivo

caractere

Indica o nome do arquivo que será apagado. Além disso, pode-se especificar um path absoluto ou relativo para apagar arquivos na estação local ou no servidor.

X

 

xParam

qualquer

Compatibilidade. Deve ser informado o valor nulo ( NIL )

 

 

lChangeCase

lógico

Caso seja verdadeiro (.T.) , o nome do arquivo informado será automaticamente convertido para letras minúsculas ; caso contrário, falso (.F.), não será feito nenhum ajuste no nome do arquivo informado. Valor padrão : .T. ( verdadeiro )

 

 

Retorno

Nome

Tipo

Descrição

nRet

numérico

Retorna 0 (zero), se o arquivo for apagado com sucesso, e -1, caso não seja possível. Se o retorno for -1, é possível utilizar a função FError() para obter mais detalhes da ocorrência.

Observações

  • Essa função faz exatamente a mesma coisa que o comando Erase, porém, retorna um valor e pode ser especificada em uma expressão.
  • Quando a função é chamada, o arquivo indicado, no parâmetro <cArquivo>, somente é eliminado do disco se for encontrado no diretório DOS - Disk Operating System (sistema operacional de disco) corrente ou no diretório especificado como parte do nome do arquivo.
  • Essa função não utiliza os comandos Set Default e Set Path para localizar o arquivo indicado no parâmetro <cArquivo>.
  • Caracteres do tipo curinga (Wildcards) (* ou ?) não são permitidos na especificação de arquivos.
  • O parâmetro lChangeCase caso informado, terá prioridade sobre qualquer outra configuração de Case Sensitive.

Atenção

Os arquivos devem ser fechados antes de serem excluídos pela função FErase().

Exemplos

//Exemplo 1
#include "fileio.ch"
User Function exemplo()
  // Apaga um arquivo no TOTVS Smart Client
  If FERASE("C:\ListaTXT.tmp") == -1
    MsgStop('Falha na deleção do Arquivo')
  Else
    MsgStop('Arquivo deletado com sucesso.')
  Endif
Return

//Exemplo 2
// Este exemplo apaga todos os arquivos .BAK do diretório corrente no Servidor
#include 'DIRECTRY.CH'
User Function exemplo2()
  aEval(Directory("*.BAK"), { |aFile| FERASE(aFile[F_NAME]) })
Return

//Exemplo 3
// Este exemplo apaga um arquivo no cliente ( Remote ) , informando o status da operação
User Function exemplo3()
  IF FERASE("C:\ListaTXT.tmp") == -1
    MsgStop('Falha na deleção do Arquivo ( FError'+str(ferror(),4)+             ')')
  Else
    MsgStop('Arquivo deletado com sucesso.')
  ENDIF
Return

Veja também

  • Sem rótulos