Return
From Base de connaissances eggdrops & TCL
return - Retourne d'une fonction
Syntaxe
return ?-code code? ?-errorinfo info? ?-errorcode code? ?string?Description
Retourne immédiatement de la fonction courante (ou d'une commande d'avant plan ou d'une commande source), avec string comme valeur de retour. Si string n'est pas spécifiée alors une chaîne vide sera renvoyée comme résultat.
Retours exceptionnels
Dans le cas normal où l'option -code n'est pas spécifiée la fonction renverra normalement (son code de retour sera TCL_OK). Néanmoins, l'option -code peut être employée pour générer un retour exceptionnel de la fonction. code peut avoir une des valeurs suivantes:
- ok (Retour normal): idem que si l'option est omise.
- error (Retour d'erreur): idem que si la commande [error] avait été utilisée pour terminer la fonction, excepté pour la gestion des variables errorInfo et errorCode (voir ci-dessous).
- return: La fonction courante renvoie un code de retour de TCL_RETURN, ainsi que la fonction qui l'a appelée.
- break: La fonction courante renvoie un code de retour de TCL_BREAK, qui terminera la boucle la plus imbriquée dans le code qui a appelé la fonction courante.
- continue: La fonction courante renvoie un code de retour de TCL_CONTINUE, qui terminera l'itération courante de la boucle la plus imbriquée dans le code qui appelée la fonction courante.
- value: value doit être un entier, il sera renvoyé comme code de retour de la fonction courante.
Si l'option -errorcode est spécifiée alors code fournit une valeur pour la variable errorCode. Si l'option n'est pas spécifiée alors errorCode sera par défaut de NONE
