TOTVSTEC

Árvore de páginas

Tempo aproximado para leitura: 2 minutos

Renomeia um arquivo no Application Server e/ou Smart Client respeitando o case do nome do arquivo indicado no segundo parâmetro. (Por default, primeiro parametro continua alterando o case)

Sintaxe

FRenameEx( < cArquivo >, < cNovoArq >, [ nParam3 ] )

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cArquivo

caractere

Indica o nome do arquivo que será renomeado, inclusive sua extensão. Também podem ser incluídos como parte do nome uma letra indicativa da unidade de disco e/ou nome do diretório. Caso não seja especificado nenhuma unidade de disco ou diretório, será considerado o diretório atual do servidor.

X

 

cNovoArq

caractere

Indica o novo nome do arquivo, incluindo a extensão. Também podem ser incluídos como parte do nome uma letra indicativa da unidade de disco e/ou nome do diretório.

X

 

nParam3

nil

Compatibilidade, informar sempre Nil.

 

 

Retorno

Nome

Tipo

Descrição

nRet

numérico

Retorna 0 (zero), se a operação for realizada com sucesso; caso contrário, retornará -1 se falhar. Em caso de falha, utilize a função FError() para obter mais detalhes.

Observações

  • Para renomear o arquivo, este deve estar fechado. Isto é, não pode estar em uso por nenhum outro processo ou estação. Caso o arquivo esteja aberto, a operação de renomear não será realizada.
  • É possível renomear o arquivo especificando nos parâmetros, simultaneamente, um diretório do servidor e da estação remota, bem como especificar dois arquivos remotos e executar a função através de um JOB.
  • Essa função não aceita caracteres-curinga (Wild cards), tais como: * e/ou ?.

Exemplos

#include 'fileio.ch'...
// Neste exemplo, a função é utilizada para 3 finalidades diferentes, observe:
User Function exemplo()
  // Renomeando um arquivo na estação de origem.txt para destino.txt , na pasta c:\Temp
  nStatus1 := frenameex('c:\Temp\Origem.txt' , 'c:\Temp\Destino.txt' )
  IF nStatus1 == -1
    MsgStop('Falha na operação 1 : FError '+str(ferror(),4))
  Endif
  // Renomeando um arquivo no servidor, na pasta sigaadv, de error.log para error.old
  nStatus2 := frenameex('\sigaadv\error.log' , '\sigaadv\error.old' )
  IF nStatus2 == -1
    MsgStop('Falha na operação 2 : FError '+str(ferror(),4))
  Endif
  // Movendo um arquivo no Client, da pasta Raiz para a pasta c:\Temp , alterando também o nome do arquivo.
  nStatus3 := frenameex('c:\Lista.txt','c:\Temp\OldLista.txt')
  IF nStatus3 == -1
    MsgStop('Falha na operação 3 : FError '+str(ferror(),4))
  Endif
Return

Veja também

  • Sem rótulos