Usina BRGuía AdvPL
Ingresar
← Todos los temas
FUNDAMENTOPublicado

User Function

User Function <Nome>()

Declara una función pública que puede ser llamada por el entorno, menús, puntos de entrada u otras rutinas AdvPL.

FuncionesEstructura del fuenteFundamentosRutinas
01 · DESCRIPCIÓN GENERAL

Descripción general

User Function es la forma tradicional de declarar una rutina AdvPL accesible externamente. El nombre informado identifica una función que puede ejecutarse desde menús, llamadas directas, puntos de entrada u otros mecanismos del entorno. En materiales didácticos antiguos aparece como la primera estructura para crear una rutina ejecutable.

02 · SINTAXIS

Sintaxis

User Function <Nome>()
03 · EJEMPLO PRÁCTICO

Rutina pública simple

#Include "TOTVS.ch"

User Function CursoADVPL()
    Local cMensagem := "Primeira rotina AdvPL"

    MsgInfo(cMensagem, "Treinamento")
Return
Resultado esperado

La función U_CursoADVPL puede ser llamada por el entorno u otro fuente según la convención utilizada.

04 · EJEMPLO PRÁCTICO

User Function llamando una función auxiliar

#Include "TOTVS.ch"

User Function ExRelatorio()
    Local cTitulo := "Relatório introdutório"

    U_MostraTitulo(cTitulo)
Return

Static Function MostraTitulo(cTitulo)
    MsgInfo(cTitulo, "Título")
Return
Resultado esperado

La User Function queda como punto de entrada y la regla auxiliar permanece encapsulada en el mismo fuente.

BUENAS PRÁCTICAS
  • Use nomes claros, curtos e estáveis para rotinas chamadas externamente.
  • Declare variáveis locais logo no início do bloco para reduzir criação implícita de Private.
  • Mantenha o retorno compatível com o contrato esperado por quem chama a função.
  • Evite misturar muitas responsabilidades em uma única User Function; extraia regras para funções auxiliares.
ERRORES COMUNES
  • Renombrar una User Function usada en menús, puntos de entrada o llamadas externas rompe la referencia.
  • Demasiadas funciones públicas dificultan la gobernanza y el mantenimiento.
  • Los ejemplos históricos usan RWMake.ch; para nuevos fuentes, evalúa TOTVS.ch según la orientación actual del entorno.

Contenido relacionado

REFERENCIAS
  1. Apostila ADVPL Introd. Microsiga Campinas, 2001. Documentação oficial histórica de caráter didático e de suporte. Conteúdo histórico, resumido, revisado e adaptado para guia de referência.
Estado
Publicado
Página creada el
Última revisión el
Idioma original
Portugués
Revisión
Usina.BR
0 comentario(s) aprobado(s)

Comentarios

Todavía no hay comentarios aprobados.

Inicia sesión con Google o Microsoft para comentar.

Desarrollado con Usina Docs · Alpha