Aide:SetError.txt

Document original V3.3.6.1 :

###Function###
SetError

###Description###
Manually set the value of the @error macro.

###Syntax###
SetError ( code [, extended [, return value]] )


###Parameters###
@@ParamTable@@
code
	The required value (integer) to set the @error macro to.
extended
	[optional] The optional value (integer) to set the @extended macro to.  This sets the same macro as the SetExtended() function.
return value
	[optional] Override the default return value and return this parameter.
@@End@@


###ReturnValue###
By default, none, however if the optional return value argument is passed, then the function will return that value.


###Remarks###
When entering a function @error is set to 0.  Unless SetError() is called, then @error will remain 0 after the function has ended.  This means that in order for @error to be set after a function, it must be explicitly set.  This also means you may need to backup the status of @error in a variable if you are testing it in a While-WEnd loop.
The extended parameter is optional.  It is only provided as a way to set both @error and @extended at the same time.  If only @extended needs set, then it is recommended to use the SetExtended() function instead.

###Related###
SetExtended


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

Document traduit V3.3.6.1 :

###Function###
SetError

###Description###
Définit manuellement la valeur de la macro @error.


###Syntax###
SetError ( code [, extended [, return value]] )


###Parameters###
@@ParamTable@@
code
	La valeur requise (entier) pour définir la macro @error.
extended
	[optionnel] La valeur optionnelle (entier) pour définir la macro @extended. Ceci définit la même macro que la fonction SetExtended().
return value
	[optionnel] Remplace la valeur de retour par défaut et retourne ce paramètre.
@@End@@


###ReturnValue###
Par défaut, aucune, cependant, si l'argument optionnel de valeur de retour est transmis, alors la fonction retournera cette valeur.


###Remarks###
Lorsque vous entrez dans une fonction, @error est remis à 0. à moins que SetError() ne soit appelée, @error restera à 0 à la sortie de la fonction. Cela signifie que vous devez assigner explicitement @error à la sortie d'une fonction. Cela signifie également que vous pouvez avoir besoin de sauvegarder le statut de @error dans une variable si vous testez dans une boucle While-WEnd.
Le paramètre extended est optionnel. Il est seulement prévu comme un moyen de régler à la fois @error et @extended au même moment. Si vous avez seulement besoin de définir @extended, alors il est recommandé d'utiliser la fonction SetExtended().


###Related###
SetExtended


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

Traducteur : sablier94

Contributeurs (pour les modifications avant le Wiki) : Tlem