Name

New-ReadOptions

SYNOPSIS

Crée un objet contenant les différentes options pouvant être utilisées lors de la lecture d'une archive Zip.

SYNTAX

New-ReadOptions [[-Encoding] <Encoding>] [[-ProgressBarInformations] <Object>] [<CommonParameters>]

DESCRIPTION

Il est possible de préciser différent comportement lors de la lecture d'une archive Zip

PARAMETERS

-Encoding <Encoding>

Type d'encodage de l'archive. Les valeurs possibles sont :

-ASCII           : encodage pour le jeu de caractères ASCII (7 bits).

-BigEndianUnicode : encodage pour le format UTF-16 qui utilise l'ordre d'octet avec primauté des octets de poids fort (big-endian).

-Default          : encodage pour la page de codes ANSI actuelle du système d'exploitation. -Unicode          : encodage pour le format UTF-16 avec primauté des octets de poids faible (little-endian).

-UTF32           : encodage pour le format UTF-32 avec primauté des octets de poids faible (little-endian). -UTF7           : encodage pour le format UTF-7.

-UTF8           : encodage pour le format UTF-8.

A moins d'être assuré que celui sélectionné corresponde à celui utilisé lors de la compression de l'archive, l'utilisation de la valeur par défaut ('DefaultEncoding') est recommandé,

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

-ProgressBarInformations <Object>

L'usage de ce paramètre crée un gestionnaire d'événements pour les opérations de lecture. Lors de l'ouverture d'archive zip de grande taille, vous pouvez choisir d'afficher une barre de progression.

L'objet passé en paramètre est construit à l'aide de fonction New-ProgressBarInformations.

Required? False
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

Ionic.Zip.ReadOptions

NOTES

Concernant l'usage de l'encodage, consultez l'aide de la dll Ionic. Si le paramètre -Verbose est précisé, alors cet objet d'options est configuré avec une instance de la classe PSIonicTools.PSVerboseTextWriter.

La DLL Ionic l'utilise pour afficher des messages supplémentaires lors d'opérations sur une archive zip.

La présence du paramètre -Verbose impose donc la libération implicite de cette instance via un appel à la méthode Close() sur l'archive ciblée par cet objet d'options.

EXAMPLES

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

PS C:\> $ReadOptions=New-ReadOptions

Cet exemple crée un objet option de lecture avec les valeurs par défaut.

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

PS C:\> $ReadOptions=New-ReadOptions -Verbose

Cet exemple crée un objet option de lecture avec une valeur d'encodage par défaut et un PSVerboseTextWriter pour des affichages supplémentaires.

-------------- EXAMPLE 3 --------------

PS C:\> $pbi=New-ProgressBarInformations $ProgressID "Reading in progress  "
$ReadOptions=New-ReadOptions $Encoding $pbi

Cet exemple crée un objet option de lecture avec une valeur d'encodage par défaut et une barre de progression.

-------------- EXAMPLE 4 --------------

PS C:\> $pbi=New-ProgressBarInformations $ProgressID "Reading in progress "
$ReadOptions=New-ReadOptions $Encoding $pbi  
$ReadOptions.StatusMessageWriter = [System.Console]::Out

Cet exemple crée un objet option de lecture avec une valeur d'encodage par défaut et une barre de progression. Puis on modifie directement sa propriété StatusMessageWriter afin d'afficher le suivi de l'opération sur la console et plus sur le flux verbose.

RELATED LINKS

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

Comments

No comments yet.