Descrição
| Renomeia um arquivo. |
Sintaxe
| fRename( <cArquivo>, <cNovoArq> ) |
Parâmetros
| Par | Nome | Tipo | Descrição | Default | Obg | Ref |
| 01 |
cArquivo |
Caracter | 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 | ||
| 02 | cNovoArq | Caracter | 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 |
Retorno
| Retorno | 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 |
Exemplo
#INCLUDE "TOTVS.CH"
User Function fRename()
Local nRet := 0
nRet := fRename('C:\Temp\Origem.txt' , 'C:\Temp\Destino.txt' )
If nRet == -1
MsgStop('Falha na operação 1 : FError ' + Str( fError(), 4 ), 'UniversoADVPL' )
Endif
Return( Nil )
Resultado
Informações adicionais
|
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 |
|
LÉ 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 ?. |
|
Quando especificado um path diferente nos arquivos de origem e destino, a função FRename() move o arquivo para o path especificado |
Gostou? Compartilhe com seus amigos e deixe um comentário! 😎