Usina BRAdvPL Guia
Entrar
← Todos os tópicos
FUNçãOEm revisão

FRename

FRename( cArquivo, cNovoArq, [nParam3], [lChangeCase] ) --> nRet

Renomeia e pode mover um arquivo para outro caminho.

FRenameAdvPL
01 · VISÃO GERAL

Visão geral

FRename retorna zero no sucesso e -1 na falha. A origem deve estar fechada; curingas não são aceitos. Se os diretórios diferirem, a operação move o arquivo, e a ficha restringe combinações entre servidor e estação e execução em JOB. O exemplo GitHub usa caminhos de estação; a adaptação prepara um callback parametrizado sem mover arquivos. Não afirmar que há sobrescrita segura ou movimento atômico: esses contratos não estão estabelecidos na ficha. (TOTVS, s.d., ref. 1)

02 · SINTAXE

Sintaxe

FRename( cArquivo, cNovoArq, [nParam3], [lChangeCase] ) --> nRet

Parâmetros

cArquivo
CaractereObrigatório

Origem com extensão e caminho aplicável.

cNovoArq
CaractereObrigatório

Novo nome e destino.

nParam3
QualquerOpcional

Compatibilidade: Nil.

lChangeCase
LógicoOpcional

Ajuste de caixa de nomes conforme build/configuração.

Retorno

Zero no sucesso; -1 na falha.

03 · EXEMPLO PRÁTICO

Exemplo comentado

#Include "Protheus.ch"
#Include "Fileio.ch"

User Function Ed395()
    Local bRenomear := {|cOrigem,cDestino| FRename(cOrigem,cDestino)}
    // Nao avaliar: confirmar arquivos fechados e destino antes de mover.
Return Nil
Resultado esperado

Callback preparado sem renomear ou mover. Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

BOAS PRÁTICAS
  • Conferir caminho, permissões, plataforma e propriedade do handle. Fechar somente handles obtidos pela própria rotina, inclusive em tratamento de erros da aplicação completa.
  • Em revisão: exemplo editorial não compilado nem executado em Protheus. Conferir includes, release, RDD e contexto antes de homologar.

Conteúdos relacionados

REFERÊNCIAS
  1. TOTVS. FRename. TDN. Consulta em 2026-10-26.
  2. EURAI. ADVPL/Funcoes/Arquivos de Disco/FRename.PRW. universo_do_desenvolvedor_site, commit a5c83e9490302bdb4a0fc5a9d92c2d569a60773c. Exemplo analisado. Consulta em 2026-10-26.
Situação
Em revisão
Página criada em
Última revisão em
Idioma original
Português
Revisão
Usina.BR
0 comentário(s) aprovado(s)

Comentários

Ainda não há comentários aprovados.

Entre com Google ou Microsoft para comentar.

Powered by Usina Docs · Alpha