Expand-Gzip Cmdlet

Parameters   Output Objects   Config Settings  

The Expand-Gzip component implements a decompressor for GZIP archives.

Syntax

Expand-Gzip [parameters]

Remarks

The cmdlet implements a gzip decompressor compliant to RFC 1952 and compatible with the UNIX gzip and gunzip utilities.

To scan an archive, set the Input parameter to the archive to examine and do not set the Output parameter. A ZipFileInfo object will be returned.

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

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 an archive Expand-Gzip -Input "simple.gz" # extract file Expand-Gzip -Input "C:\simple.gz" -Output "C:\temp"

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.
CompressionMethod	The method with which the archive was compressed.
Config	Specifies one or more configuration settings.
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.

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-Gzip Cmdlet)

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

Syntax

Expand-Gzip -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

CompressionMethod Property (Expand-Gzip Cmdlet)

The method with which the archive was compressed.

Syntax

Expand-Gzip -CompressionMethod string

Remarks

Possible values for decompression are: Deflate, LZCCompress.

By default, the component uses the Deflate compression method described in rfc 1952. When set to LZC compress method, the component will use a variation of the method described by the LZW (Lempel-Ziv-Welch) algorithm that is compatible with Unix's compress utility.

Default Value

0

Config Property (Expand-Gzip Cmdlet)

Specifies one or more configuration settings.

Syntax

Expand-Gzip -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

Input Property (Expand-Gzip Cmdlet)

The archive file from which to read.

Syntax

Expand-Gzip -Input string

Remarks

This parameter indicates the archive file to decompress.

Default Value

""

Parameter Position

0

Parameter Alias

in

This is a required parameter.

LogFile Property (Expand-Gzip Cmdlet)

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

Syntax

Expand-Gzip -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-Gzip Cmdlet)

The directory where the files will be decompressed.

Syntax

Expand-Gzip -Output string

Remarks

If a value is specified, the cmdlet will attempt to extract the archive to that location. An output value 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-Gzip Cmdlet)

Whether or not to overwrite files when writing to them.

Syntax

Expand-Gzip -Overwrite SwitchParameter

Remarks

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

Default Value

false

ZipFileInfo Output Object (Expand-Gzip 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-Gzip 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