UBound, fonction (Visual Basic)

Article
09/12/2008

Mise à jour : novembre 2007

Retourne le plus grand indice disponible pour la dimension indiquée d'un tableau.

Public Function UBound( _
   ByVal Array As System.Array, _ 
   Optional ByVal Rank As Integer = 1 _
) As Integer

Paramètres

Array
Requis. Tableau de tout type de données. Tableau dans lequel vous voulez trouver le plus grand indice possible d'une dimension.
Rank
Facultatif. Integer. Dimension pour laquelle le plus grand indice possible doit être retourné. Utilisez la valeur 1 pour la première dimension, la valeur 2 pour la deuxième, etc. Si l'argument Rank est omis, 1 est supposé.

Valeur de retour

Integer. Valeur la plus élevée que l'indice pour la dimension spécifiée peut contenir. Si Array a un seul élément, UBound retourne 0. Si Array n'a pas d'éléments, par exemple, si c'est une chaîne de longueur nulle, UBound retourne -1.

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentNullException	9	Array est Nothing
RankException	9	Rank est inférieur à 1 ou Rank est supérieur au rang de Array.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion des erreurs non structurée. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreur par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Compte tenu que les indices de tableau commencent à 0, la longueur d'une dimension est supérieure de un à l'indice le plus grand disponible pour cette dimension.

Pour un tableau avec les dimensions suivantes, UBound retourne les valeurs dans le tableau suivant :

Dim a(100, 5, 4) As Byte

Appel à UBound	Valeur de retour
UBound(a, 1)	100
UBound(a, 2)	5
UBound(a, 3)	4

Vous pouvez utiliser UBound pour déterminer le nombre total d'éléments dans un tableau, mais vous devez ajuster la valeur de retour pour prendre en compte le fait que les indices commencent à 0. L'exemple suivant calcule la taille totale du tableau a de l'exemple précédent :

Dim total As Integer
total = (UBound(A, 1) + 1) * (UBound(A, 2) + 1) * (UBound(A, 3) + 1)

La valeur calculée pour total est 3 030, c'est-à-dire 101 * 6 * 5.

Exemple

Cet exemple utilise la fonction UBound pour déterminer le plus grand indice disponible pour la dimension indiquée d'un tableau.

Dim highest, bigArray(10, 15, 20), littleArray(6) As Integer
highest = UBound(bigArray, 1)
highest = UBound(bigArray, 3)
highest = UBound(littleArray)
' The three calls to UBound return 10, 20, and 6 respectively.