Expand-Gzip Cmdlet
Parameters Output Objects Configuration Settings
The Expand-Gzip cmdlet 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 archiveExpand-Gzip -Input "simple.gz"# extract fileExpand-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. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |