Liste de paramètres (Visual Basic)

Article
08/10/2011

Spécifie les paramètres qu'une procédure attend lorsqu'elle est appelée. Les paramètres, lorsqu'il y en a plusieurs, sont séparés par des virgules. La syntaxe pour un paramètre est la suivante.

[ <attributelist> ] [ Optional ] [{ ByVal | ByRef }] [ ParamArray ] 
parametername[( )] [ As parametertype ] [ = defaultvalue ]

Éléments

attributelist
Facultatif. Liste des attributs qui s'appliquent à ce paramètre. Vous devez placer le Liste d'attributs (Visual Basic) entre des signes "inférieur à" et "supérieur à" ("<" et ">").
Optional
Facultatif. Spécifie que ce paramètre n'est pas requis lorsque la procédure est appelée.
ByVal
Facultatif. Spécifie que la procédure ne peut pas remplacer ou réassigner l'élément de variable sous-jacent de l'argument correspondant dans le code appelant.
ByRef
Facultatif. Spécifie que la procédure peut modifier l'élément de variable sous-jacent dans le code appelant comme le ferait le code appelant lui-même.
ParamArray
Facultatif. Spécifie que le dernier paramètre dans la liste de paramètres est un tableau facultatif d'éléments du type de données spécifié. Cela permet au code appelant de passer un nombre arbitraire d'arguments à la procédure.
parametername
Obligatoire. Nom de la variable locale représentant le paramètre.
parametertype
Requis si Option Strict a la valeur On. Type de données de la variable locale représentant le paramètre.
defaultvalue
Requis pour les paramètres Optional. Toute constante ou expression constante qui prend la valeur du type de données du paramètre. Si le type est Object ou bien une classe, une interface, un tableau ou une structure, la valeur par défaut ne peut être que Nothing.

Notes

Les paramètres sont placés entre parenthèses et sont séparés par des virgules. Un paramètre peut être déclaré avec n'importe quel type de données. Si vous ne spécifiez pas parametertype, la valeur prise par défaut est Object.

Lorsque le code appelant appelle la procédure, il passe un argument à chaque paramètre requis. Pour plus d'informations, consultez Différences entre les paramètres et les arguments (Visual Basic).

L'argument que le code appelant passe à chaque paramètre est un pointeur vers un élément sous-jacent dans le code appelant. Si cet élément est non variable (une constante, un littéral, une énumération ou une expression), aucun code ne pourra le modifier. S'il s'agit d'un élément variable (une variable, un champ, une propriété, un élément de tableau ou un élément de structure déclaré), le code appelant peut le modifier. Pour plus d'informations, consultez Différences entre les arguments modifiables et non modifiables (Visual Basic).

Si un élément variable est passé ByRef, la procédure peut également le modifier. Pour plus d'informations, consultez Différences entre le passage d'un argument par valeur et par référence (Visual Basic).

Règles

Parenthèses. Si vous spécifiez une liste de paramètres, vous devez la placer entre parenthèses. S'il n'y a aucun paramètre, vous pouvez tout de même utiliser des parenthèses entourant une liste vide. Cela permet d'améliorer la lisibilité de votre code en clarifiant que l'élément est une procédure.
Paramètres facultatifs. Si vous utilisez le modificateur Optional sur un paramètre, tous les paramètres suivants dans la liste doivent également être facultatifs et être déclarés à l'aide du modificateur Optional .

Chaque déclaration de paramètre facultative doit fournir la clause defaultvalue.

Pour plus d'informations, consultez Paramètres facultatifs (Visual Basic).
Tableaux de paramètres. Vous devez spécifier ByVal pour un paramètre ParamArray.

Vous ne pouvez pas utiliser à la fois Optional et ParamArray dans la même liste de paramètres.

Pour plus d'informations, consultez Tableaux de paramètres (Visual Basic).
Mécanisme de passage. Le mécanisme par défaut pour chaque argument est ByVal, ce qui signifie que la procédure ne peut pas modifier l'élément de variable sous-jacent. Toutefois, si l'élément est un type référence, la procédure peut modifier le contenu ou les membres de l'objet sous-jacent, bien qu'il ne puisse pas remplacer ou réassigner l'objet lui-même.
Noms de paramètres. Si le type de données du paramètre est un tableau, insérez des parenthèses immédiatement après parametername. Pour plus d'informations sur les noms de paramètres, consultez Noms d'éléments déclarés (Visual Basic).

Exemple

L'exemple suivant indique une procédure Function qui définit deux paramètres.

Public Function howMany(ByVal ch As Char, ByVal st As String) As Integer
End Function
Dim howManyA As Integer = howMany("a"c, "How many a's in this string?")