FOR EACH/FOR ALL statement (browse of associative arrays)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / WLanguage syntax / Structured statements

Syntax 1: Iterating over elements in the array
Syntax 2: Browse element values of the array

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

FOR EACH/FOR ALL statement (browse of associative arrays)

In french: POUR TOUT / POUR TOUS

FOR EACH is used to perform different types of browse operations on the associative arrays:

Browse the elements of the associative array.
Browsing the values of the elements found in the associative array.

Note: The FOR EACH, FOR ALL statements are accepted. The FOR EACH statement will be used in this documentation but it can be replaced with FOR ALL.

The FOR EACH statement can also be used to browse the .Net objects that implement the IEnumerable interface.

Example

// Déclaration d'un tableau associatif d'entiers 
// Tableau indexé sur des chaînes et sans doublon
taIDParClient is associative array of int
taIDParClient["A"] = 55 // Ajout de l'identifiant du client "A"
taIDParClient["B"] = 321 // Ajout de l'identifiant du client "B"
taIDParClient["A"] = 56 // Modification de l'identifiant du client "A"
// Parcours de tous les identifiants (syntaxe 1)
// 56
// 321
FOR EACH nIdentifiant OF taIDParClient
	Trace(nIdentifiant)
END

// Déclaration d'un tableau associatif d'entiers
// Ce tableau est indexé sur des chaînes avec doublons
// Ne tient pas compte de la casse ni des accents
taIDParClient is associative array (WithDuplicates + ccIgnoreCase + ccIgnoreAccent) of int
taIDParClient["E"] = 55	 // ajout de l'identifiant du client "E"
taIDParClient["B"] = 321	// ajout de l'identifiant du client "B"
taIDParClient["e"] = 8	  // ajout de l'identifiant du client "e"
taIDParClient["é"] = 127	// ajout de l'identifiant du client "é"
// Parcours de tous les identifiants des clients "E" (Syntaxe 2)
// 55
// 8
// 127
FOR EACH nIdentifiant OF taIDParClient = "E"
	Trace(nIdentifiant)
END

Syntax

Browsing the array elements Hide the details

FOR EACH [ELEMENT] <Variable> [, <Key> [, <Counter>]] OF <Array> [WHERE <Condition>] [<Direction>]
...
END

<FOR EACH [ELEMENT]>:

Marks the beginning of the statement block. The ELEMENT keyword is optional.

<Variable>:

Variable whose type is identical to the type of the array elements. For the arrays of classes, the variable must be a Dynamic Class variable. There is no need to declare this variable.
Note: This variable is a reference to the value of the array. A modification of this variable in FOR EACH will also modify the value in the associative array.

<Key>:

Key of element browsed. There is no need to declare this variable.

<Counter>:

Integer variable containing the number of iterations. There is no need to declare this variable.

<Array>:

Array to browse.

<Condition>:

Condition to indicate to filter the browse. Only the array elements corresponding to the filter will be browsed.

<Direction>:

Optional indicator for the iteration direction.
FromBeginning
(default value) Browse the array in the order of additions into the array.
FromEnd Browse the array in the reverse order of additions into the array.

Browsing the values of the "Key" elements found in the array Hide the details

FOR EACH [ELEMENT] <Variable> OF <Array> = <Key> [WHERE <Condition>] [<Direction>]
...
END

<FOR EACH ELEMENT>:

Marks the beginning of the statement block. The ELEMENT keyword is optional.

<Variable>:

Variable whose type is identical to the type of the array elements. For the arrays of classes, the variable must be a Dynamic Class variable. There is no need to declare this variable.
Note: This variable is a reference to the value of the array. A modification of this variable in FOR EACH will also modify the value in the associative array.

<Array>:

Array to browse.

<Key>:

Value of the key for which the array elements must be browsed. For an associative array without duplicates, 0 or 1 element will be browsed. For an associative array with duplicates, 0 or N elements will be browsed.

<Condition>:

Condition to indicate to filter the browse. Only the array elements corresponding to the filter will be browsed.

<Direction>:

Optional indicator for the iteration direction.
FromBeginning
(default value) Browse the array in the order of additions into the array.
FromEnd Browse the array in the reverse order of additions into the array.

Remarks

Syntax 1: Iterating over elements in the array

For each iteration, <Variable> directly refers to the current element in the array. If the value of <Variable> is modified, the current element in the array is modified.

When exiting from the loop (standard exit or via the BREAK statement), the value of the last element read is assigned to <Variable> but <Variable> does not directly refer to the array element anymore.

Example:

// Déclaration d'un tableau associatif d'entiers 
// Tableau indexé sur des chaînes et sans doublon
taIDParClient is associative array of int
taIDParClient["A"] = 55 // Ajout de l'identifiant du client "A"
taIDParClient["B"] = 321 // Ajout de l'identifiant du client "B"
taIDParClient["A"] = 56 // Modification de l'identifiant du client "A"
// Parcours de tous les identifiants
// 56
// 321
FOR EACH nIdentifiant OF taIDParClient
	Trace(nIdentifiant)
END

Syntax 2: Browse element values <Clé> of the array

This syntax browses all the array elements with the specified <Key> value. For each iteration, <Variable> directly refers to the current element in the array. If the value of <Variable> is modified, the current element in the array is modified.

This syntax is useful when browsing associative arrays with duplicates. In an associative array without duplicates, the number of elements browsed can be 0 or 1. In an associative array with duplicates, the number of elements browsed can be 0 or N.

The array elements are browsed in the order of additions (no direction option).

Example:

// Déclaration d'un tableau associatif d'entiers
// Ce tableau est indexé sur des chaînes avec doublons
// Ne tient pas compte de la casse ni des accents
taIDParClient is associative array (WithDuplicates + ccIgnoreCase + ccIgnoreAccent) of int
taIDParClient["E"] = 55	 // ajout de l'identifiant du client "E"
taIDParClient["B"] = 321	// ajout de l'identifiant du client "B"
taIDParClient["e"] = 8	  // ajout de l'identifiant du client "e"
taIDParClient["é"] = 127	// ajout de l'identifiant du client "é"
// Parcours de tous les identifiants des clients "E"
// 55
// 8
// 127
FOR EACH nIdentifiant OF taIDParClient = "E"
	Trace(nIdentifiant)
END