Name

New-ProgressBarInformations

SYNOPSIS

Créer un objet de déclaration d'une barre de progression PSionic standardisée.

SYNTAX

New-ProgressBarInformations [-activityId] <Int32> [-activity] <String> [<CommonParameters>]

DESCRIPTION

Cet objet est utilisé par la fonction New-ReadOptions.

PARAMETERS

-activityId <Int32>

Indique un identifiant distinguant chaque barre de progression. Utilisez ce paramètre lorsque vous créez plusieurs barres de progression en une seule commande.

Si les barres de progression n'ont pas d'identifiant différent, elles seront superposées au lieu d'être affichées l'une en dessous de l'autre.

Required? True
Position? 0
Default value  
Accept pipeline input? false
Accept wildcard characters? False

-activity <String>

Indique la première ligne de texte dans le titre de la barre de progression.

Ce texte décrit l'activité dont la progression est rapportée.

Required? True
Position? 1
Default value  
Accept pipeline input? false
Accept wildcard characters? False

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable.

For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

EXAMPLES

-------------- EXAMPLE 1 --------------

PS C:\> $pbi=New-ProgressBarInformations 1 "Read in progress "
$ReadOptions=New-ReadOptions $Encoding $pbi  
$FileName='C:\Temp\Backup.zip'
try {
$ZipFile = [Ionic.Zip.ZipFile]::Read($FileName,$ReadOptions)
} finally {
 $ZipFile.Dispose()
}

Cet exemple crée une barre de progression utilisée dans le paramétrage des options de lecture d'une archive.

Dans ce contexte le nom des fichiers lus n'étant pas accessible, la barre de progression affichera uniquement le nombre d'entrées lues.

-------------- EXAMPLE 2 --------------

PS C:\> $Files=Dir 'C:\temp\*.zip'
$Count=$Files.Count
$I=0
$Files| 
Foreach -begin {  $id=1 } -process { 
  [int]$PCpercent =(($I / $Count ) * 100)
  $I++
  
  Write-Progress -id $id -Activity "Archive : " -Status "$_" -PercentComplete $PCpercent
  Expand-ZipFile -Path $_ -OutputPath 'C:\Temp\TestZip' -Create -ExtractAction OverwriteSilently -ProgressID 2
}#foreach

Cet exemple lit toutes les archives ZIP du répertoire C:\Temp, puis les extrait. On utilise directement le paramètre -ProgressID de la fonction Expand-ZipFile qui configure en interne une barre de progression.

Dans ce cas lors de la lecture du catalogue, la valeur du paramètre Activity n'est pas modifiable, car elle est figée dans le code.

RELATED LINKS

Last edited Mar 8, 2014 at 2:43 PM by LaurentDardenne, version 2

Comments

No comments yet.