Write-Progress

Write-Progress [-Activity] <string> [-Status] <string> [[-Id] <int>] [-Completed] [-CurrentOperation <string>] [-ParentId <int>] [-PercentComplete <int>] [-SecondsRemaining <int>] [-SourceId <int>] [<CommonParameters>]

C:\PS>for ($i = 1; $i -lt 101; $i++ ) 
{for ($j=0;$j -lt 10000;$j++) {} write-progress -activity "Search in Progress" -status "% Complete:" -percentcomplete $i;}

Description
-----------
Cette commande affiche la progression de deux boucles For imbriquées. La première boucle compte jusqu'à 100. Pour chaque incrément de cette boucle, la deuxième boucle compte jusqu'à 10 000.
La commande Write-Progress inclut un titre de barre d'état (« activity »), une ligne d'état et la variable $i (le compteur de la boucle For), ce qui indique l'état complet relatif de la tâche.

C:\PS>for($i = 1; $i -lt 101; $i++ ) {write-progress -activity Updating -status progress-> -percentcomplete $i -currentOperation OuterLoop} for($i = 1; $i -lt 101; $i++ ) {write-progress -activity Updating -status progress -percentcomplete $i -id  1 -currentOperation InnerLoop}

Updating 
   progress ->
   [oooooooooooooooooo                                                   ]

   OutsideLoop

Updating
  progress  
  [oooooooooooooooooo                                                    ]

  InnerLoop

Description
-----------
Cet exemple affiche la progression de deux boucles For imbriquées, chacune étant représentée par une barre de progression.

La commande Write-Progress de la deuxième barre de progression inclut le paramètre Id qui la distingue de la première barre de progression. Sans ce paramètre Id, les barres de progression se superposeraient au lieu de s'afficher l'une au-dessous de l'autre.

C:\PS>$events = get-eventlog -logname system

C:\PS> $events | foreach-object -begin {clear-host;$i=0;$out=""} `
-process {if($_.message -like "*bios*") {$out=$out + $_.Message};
$i = $i+1;`
write-progress -activity "Searching Events" `
-status "Progress:" -percentcomplete ($i/$events.count*100)} `
-end {$out}

Description
-----------
Cette commande affiche la progression d'une commande visant à rechercher la chaîne « bios » dans le journal des événements système. 

Dans la première ligne de la commande, l'applet de commande Get-EventLog obtient les événements du journal système et les stocke dans la variable $events. 

Dans la deuxième ligne, les événements sont dirigés vers l'applet de commande ForEach-Object. Avant que le traitement ne commence, l'applet de commande Clear-Host est utilisée pour effacer l'écran, la variable de compteur $i a la valeur zéro et la valeur de la variable de sortie $out est la chaîne vide. 


Dans la troisième ligne, qui est le bloc de script Process de l'applet de commande ForEach-Object, l'applet de commande recherche « bios » dans la propriété de message de chaque objet entrant. Si la chaîne est trouvée, le message est ajouté à $out. 

Dans la quatrième ligne, la variable de compteur $i est incrémentée pour indiquer qu'un autre événement a été examiné. 

La cinquième ligne utilise l'applet de commande Write-Progress avec des valeurs pour les champs de texte Activity et Status qui créent respectivement la première et la deuxième lignes du titre de la barre de progression. La valeur du paramètre PercentComplete est calculée en divisant le nombre des événements traités ($i) par le nombre total d'événements récupérés ($events.count), puis en multipliant le résultat obtenu par 100. 

Dans la dernière ligne, le paramètre End de l'applet de commande ForEach-Object est utilisé pour afficher les messages stockés dans la variable $out.