STATICModificadorOpcional
Restringe la visibilidad de la función al archivo fuente donde fue declarada.
COMANDOPublicado
FUNCTION
[STATIC] FUNCTION <cNome>( [<uParam1>, <uParam2>, ...] )Declara una función AdvPL, con parámetros locales y finalización obligatoria mediante RETURN.
Descripción general
FUNCTION es el comando utilizado para declarar una función en AdvPL. La función recibe un nombre, puede recibir parámetros y debe finalizar su ejecución con RETURN. Cuando se declara como STATIC FUNCTION, queda visible solo dentro del propio archivo fuente; cuando se publica como USER FUNCTION, pasa a ser una rutina llamable externamente según las convenciones del entorno Protheus.
Sintaxis
[STATIC] FUNCTION <cNome>( [<uParam1>, <uParam2>, ...] )Parámetros
cNombreIdentificadorObligatorio
Nombre de la función declarada. Debe ser estable cuando se usa en menús, puntos de entrada o llamadas externas.
uParamNCualquier tipo AdvPLOpcional
Parámetros recibidos por la función. Cada parámetro funciona como variable local en el ámbito de la función.
RETURNComandoObligatorio
Finaliza la función y, opcionalmente, devuelve un valor al llamador.
Función con parámetros y retorno
#Include "TOTVS.ch"
User Function ExFunction()
Local nResultado := SomaValores(10, 5)
MsgInfo(CValToChar(nResultado), "Resultado")
Return
Static Function SomaValores(nValorA, nValorB)
Return nValorA + nValorBResultado esperado
La User Function es el punto de entrada. La Static Function recibe parámetros locales, calcula el resultado y devuelve el valor al llamador.
Retorno lógico para validación
#Include "TOTVS.ch"
User Function ExValida()
Local cCodigo := "A001"
If CodigoValido(cCodigo)
MsgInfo("Código aceito", "Validação")
EndIf
Return
Static Function CodigoValido(cCodigo)
Return !Empty(AllTrim(cCodigo))Resultado esperado
La función auxiliar devuelve .T. o .F., dejando explícito el contrato de validación.
- Cada parâmetro declarado entre parênteses é criado como variável local da função.
- A execução da função deve ser finalizada com RETURN, com ou sem valor de retorno.
- Use STATIC FUNCTION para rotinas auxiliares internas do fonte.
- Use USER FUNCTION quando a rotina precisar ser chamada externamente pelo ambiente, menu, ponto de entrada ou outra integração.
- O TDN registra que uma função pode ser chamada diretamente pelo nome ou pelo operador de alias, conforme o contexto.
- No confundas FUNCTION con una llamada de función: FUNCTION declara la rutina; usar el nombre la ejecuta.
- Parámetros omitidos o en orden incorrecto cambian el comportamiento de la rutina llamada.
- Funciones sin contrato claro de retorno dificultan pruebas y mantenimiento.
- Exponer como USER FUNCTION algo que debería ser solo auxiliar aumenta el acoplamiento del fuente.
Comentarios
Todavía no hay comentarios aprobados.
Inicia sesión con Google o Microsoft para comentar.