Expand-Zip Cmdlet

Parameters   Output Objects   Config Settings  

The Expand-ZIP component implements a decompressor for ZIP, GZIP, JAR, and TAR archives.

Syntax

Expand-Zip [parameters]

Remarks

The format for decompression is specified by the Format parameter.

To scan an archive, set the Input parameter to the archive to examine, and set the Format parameter to the appropriate type. A ZipFileInfo object will be returned for every entry in the archive.

If the Output parameter is set, the cmdlet will attempt to extract the archive to the specified location. A single ZipFileInfo object will be returned indicating the success of the operation and the number of extracted files.

For the Zip format, the cmdlet uses the Deflate algorithm specified in RFC 1951 for decompression, and reads output compatible with PKZip, WinZip, etc.

For Gzip, the cmdlet component implements a gzip decompressor compliant to RFC 1952 and compatible with the UNIX gzip and gunzip utilities.

For Jar files, the operation of the cmdlet is similar to that of the Zip format.

The Tar files, the cmdlet implements a tar archive utility, compatible with the UNIX tar and untar utilities. The interface is identical to that of the Zip format and is the same whether gzip compression is used or not, so the Tar Format can be used for both .tar and .tgz archives.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.

# scan a jar file Expand-Zip -Input "simple.jar" -Format "jar" # extract files from a zip archive Expand-Zip -Input "C:\temp.zip" -Password "mypassword" -Output "C:\temp" # extract files from a tar-gzip archive Expand-Zip -Input "C:\sample.tgz" -Format "tar"

Parameter List

---

The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFile	The location of a file to which debug information is written.
Config	Specifies one or more configuration settings.
ExcludedFiles	A list of files to exclude.
Format	The format of the compression used.
IncludedFiles	Specifies that only files matching the provided values should be extracted.
Input	The archive file from which to read.
LogFile	The location of a file to which debug information is written.
Output	The directory where the files will be decompressed.
Overwrite	Whether or not to overwrite files when writing to them.
Password	The password for the zip archive.
Recurse	Whether or not to recurse into subdirectories.

Output Objects

---

The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

ZipFileInfo	Information about the entries in the archive.

Config Settings

---

The following is a list of config settings for the cmdlet with short descriptions. Click on the links for further details.

BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

LogFile Parameter (Expand-Zip Cmdlet)

The location of a file to which debug information is written.

Syntax

Expand-Zip -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

null

Config Property (Expand-Zip Cmdlet)

Specifies one or more configuration settings.

Syntax

Expand-Zip -Config string[]

Remarks

The Config parameter takes one or more name-value pairs that represent the name of the configuration setting and value, i.e.: -config "Name=Value"

Default Value

null

ExcludedFiles Property (Expand-Zip Cmdlet)

A list of files to exclude.

Syntax

Expand-Zip -ExcludedFiles string[]

Remarks

This parameter may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be excluded If no path is specified but wildcards are, matching files in all directories will be excluded.

Directories should end with a slash ("/" or "\", as appropriate.) If a directory is specified, all files and subdirectories in the specified directory will be excluded.

The ExcludedFiles parameter is not supported when extracting GZIP archives.

Default Value

null

Format Property (Expand-Zip Cmdlet)

The format of the compression used.

Syntax

Expand-Zip -Format string

Remarks

Possible values for the compression used include: Zip, Gzip, Jar, Tar, ZipSFX.

Default Value

0

IncludedFiles Property (Expand-Zip Cmdlet)

Specifies that only files matching the provided values should be extracted.

Syntax

Expand-Zip -IncludedFiles string[]

Remarks

If IncludedFiles is specified, only files with names matching the specified values will be extracted. You can also specify which files to extract using masks ("/dir/*.txt"). If IncludedFiles is not provided, then all files in the archive will be extracted.

Both IncludedFiles and ExcludedFiles can be specified at the same time, in which case only files matching IncludedFiles and not matching ExcludedFiles will be extracted.

The IncludedFiles parameter is not supported when extracting files from a GZIP archive.

Default Value

null

Input Property (Expand-Zip Cmdlet)

The archive file from which to read.

Syntax

Expand-Zip -Input string

Remarks

This parameter indicates the archive file to decompress. The format of the file is specified by Format.

Default Value

""

Parameter Position

0

Parameter Alias

in

This is a required parameter.

LogFile Property (Expand-Zip Cmdlet)

The location of a file to which debug information is written.

Syntax

Expand-Zip -LogFile string

Remarks

When specified, the cmdlet will log debug information to the file. If the file exists, the information will be appended.

Default Value

""

Output Property (Expand-Zip Cmdlet)

The directory where the files will be decompressed.

Syntax

Expand-Zip -Output string

Remarks

If a value is specified, the cmdlet will attempt to extract the archive to that location. An output location of empty string will result in the archive being extracted to the current directory. If no output directory is specified, the cmdlet will only scan the archive without decompressing it.

Default Value

""

Parameter Alias

out

Overwrite Property (Expand-Zip Cmdlet)

Whether or not to overwrite files when writing to them.

Syntax

Expand-Zip -Overwrite SwitchParameter

Remarks

If set to true, the user is not queried for confirmation when overwriting a file.

Default Value

false

Password Property (Expand-Zip Cmdlet)

The password for the zip archive.

Syntax

Expand-Zip -Password string

Remarks

If the archive is password protected, the Password parameter must be set to the value of the password.

Default Value

""

Recurse Property (Expand-Zip Cmdlet)

Whether or not to recurse into subdirectories.

Syntax

Expand-Zip -Recurse SwitchParameter

Remarks

This switch affects the behavior of Input and the meaning of excluded files. If this switch is set, Input will recurse into all subdirectories whenever it performs a search on the file system.

This setting has no effect on scan operations.

Default Value

false

ZipFileInfo Output Object (Expand-Zip Cmdlet)

Information about the entries in the archive.

Syntax

Object ZipFileInfo {
   string CompressedName;
   string DecompressedName;
   bool IsDirectory;
   long Length;
}

Remarks

For every entry found in the archive, a ZipFileInfo object will be returned.

CompressedName is the name of the entry in the archive, including any directory information.

DecompressedName is the name of the extracted archive (if extracting).

IsDirectory is true if this is a directory entry, false otherwise.

Length is the size, in bytes, of the entry.

Note: During a scan operation for the GZIP Format, the length cannot be computed and it's always 0.

Config Settings (Expand-Zip Cmdlet)

The cmdlet accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the cmdlet, access to these internal properties is provided through the Config method.

Base Config Settings