Aide:Func.txt

Document original V3.3.6.1 :

###Keyword###
Func...Return...EndFunc

###Description###
Defines a user-defined function that takes zero or more arguments and optionally returns a result.

###Syntax###
<b>Func</b> functioname ( [<b>Const</b>] [<b>ByRef</b>] $param1, ..., [<b>Const</b>] [<b>ByRef</b>] $paramN, $optionalpar1 = value, ...)
	...
	[<b>Return</b> [<i>value</i>]]
<b>EndFunc</b>


###Parameters###
The parameters are set by you.  You later call the function like any other built-in function.


###Remarks###
The Const keyword is optional and indicates that the value of the parameter will not change during the execution of the function.  A variable declared Const can only be passed to a function using a Const parameter.

The ByRef keyword indicates the parameter should be treated as a reference to the original object.  The default behavior copies the parameter into a new variable however ByRef links the new variable to the original parameter.  ByRef is typically preferred when a function expects large amounts of data, such as a large array, where copying all the data would impose a significant performance penalty.  Note that not only a named variable can be passed for a ByRef parameter; unnamed temporary variables, such as function return values, may be passed as ByRef parameters as well.  A literal can not be passed to a ByRef parameter.

If using both keywords ByRef and Const with a function parameter, the order of the keywords is not important, so long as they are both in front of the variable they modify.

Entire arrays can be passed to functions (and returned from them) by simply using the array name without any brackets.  Arrays should be passed to user-defined functions using the ByRef keyword to avoid the overhead of copying all the data in the array.

Optional parameters are defined by assigning a default value to them. The value may be a global variable, macro or literal value.  Optional parameters always appear last in the function definition. All parameters added after the first optional parameter must also be optional. Inside the function, the number of parameters given when the function was called can be retrieved with the @NUMPARAMS macro (see example 2).

Use the Return keyword to exit the function.  Unlike built-in functions, user-defined functions return 0 unless another return value is specified.

Note that function declarations cannot appear inside other function declarations.

###Related###
<a href="Dim.htm">Dim/Global/Local</a>, <a href="include.htm">#include</a>, <a href="Dim.htm">Const</a>


###Example###
@@IncludeExample@@

Document traduit V3.3.6.1 :

###Keyword###
Func...Return...EndFunc

###Description###
Définit une fonction définie par l'utilisateur qui prend zéro ou plusieurs arguments et retourne facultativement un résultat.


###Syntax###
<b>Func</b> functioname ( [<b>Const</b>] [<b>ByRef</b>] $param1, ..., [<b>Const</b>] [<b>ByRef</b>] $paramN, $optionalpar1 = value, ...)
	...
	[<b>Return</b> [<i>value</i>]]
<b>EndFunc</b>


###Parameters###
Les paramètres sont indiqué par vous. Vous appellerez plus tard la fonction comme n'importe qu'elle autre fonction interne.


###Remarks###
Le mot-clé Const est optionnel et indique que la valeur du paramètre ne changera pas durant l'exécution de la fonction.  Une variable déclarée Const ne peut être passée à une fonction qu'en tant que paramètre Const.

Le mot-clé ByRef indique que le paramètre devrait être traité comme une référence à l'objet original.  Le comportement par défaut copie le paramètre dans une nouvelle variable, cependant ByRef lie la nouvelle variable avec le paramètre original.  ByRef est typiquement préféré lorsqu'une fonction s'attend à de grandes quantités de données, comme un grand tableau où la reproduction de toutes les données imposerait une pénalité de performance significative.  Notez que non seulement on peut passer une variable nommée comme paramètre ByRef; mais une variable temporaire tel que des valeurs de retour de fonction peuvent aussi être passées en paramètre ByRef.  Un littéral ne peut être passé en paramètre ByRef.

En utilisant les deux mots-clés ByRef et Const avec un paramètre de fonction, l'ordre des mots-clés n'est pas important, tant qu'ils sont tous les deux devant la variable qu'ils modifient.

On peut passer des tableaux Entiers aux fonctions (et retournés par elles) en utilisant simplement le nom du tableau sans aucune parenthèse. On devrait passer les tableaux aux fonctions définies par l'utilisateur en utilisant le mot-clé ByRef pour économiser du temps sur la copie des données dans le tableau.

Les paramètres facultatifs sont définis en leur assignant une valeur par défaut. La valeur peut être une variable globale, une macro ou une valeur littérale.  Les paramètres facultatifs apparaissent toujours en derniers dans la définition d'une fonction. Tous les paramètres supplémentaire après le premier paramètre facultatif doivent aussi être facultatifs. À l'intérieur de la fonction, le nombre de paramètres donnés lorsque la fonction a été appelée peut être retrouvé avec la macro @NUMPARAMS (voir l'exemple 2).

Utilisez le mot-clé Return pour quitter la fonction. À la différence des fonctions interne, les fonctions définies par l'utilisateur retournent 0 à moins qu'une autre valeur de retour ne soit spécifiée.

Notez que les déclarations de fonction ne peuvent pas apparaître à l'intérieur d'autres déclarations de fonction.


###Related###
<a href="Dim.htm">Dim/Global/Local</a>, <a href="include.htm">#include</a>, <a href="Dim.htm">Const</a>


###Example###
@@IncludeExample@@

Traducteur : Tlem