Format-ZipFile

Synopsis

Formats content of the properties of an archive object.

Syntax

Format-ZipFile -Zip <PSObject> [[-Properties] <Object>] [<CommonParameters>]

Description

Formats content of the properties of a Zip archive. Read Notes section for details about default displayed properties.

Parameters

-Zip <PSObject>

Archive object to format. You need to force the inclusion of the object by prefixing the variable with a comma.

Required? True
Position? named
Default value  
Accept pipeline input? true (ByValue)
Accept wildcard characters? False

-Properties <Object>

Array of property names to display when internal calling to Format-List.

Required? False
Position? 0
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

Inputs

Ionic.Zip.ZipFile

Outputs

Microsoft.PowerShell.Commands.Internal.Format

Notes

List of default properties to display : CaseSensitiveRetrieval UseUnicodeAsNecessary UseZip64WhenSaving RequiresZip64 OutputUsedZip64 InputUsesZip64 ProvisionalAlternateEncoding AlternateEncoding AlternateEncodingUsage StatusMessageTextWriter TempFileFolder Password ExtractExistingFile ZipErrorAction Encryption SetCompression MaxOutputSegmentSize NumberOfSegmentsForMostRecentSave ParallelDeflateThreshold ParallelDeflateMaxBufferPairs Count FullScan SortEntriesBeforeSaving AddDirectoryWillTraverseReparsePoints BufferSize CodecBufferSize FlattenFoldersOnExtract Strategy Name CompressionLevel CompressionMethod Comment EmitTimesInWindowsFormatWhenSaving . The presence of this function is due to a bug in the type extension system and formatting that can not manage a class with an indexer.

Examples

EXAMPLE 1

PS C:\> try {         
,($ZipFile=Get-Zipfile -Path Test.zip)|Format-ZipFile
} finally {
$ZipFile.PSDispose()
}

This example gets an archive object from a file name, then formats his contents before freeing system resources.

Related links

Unknown https://psionic.codeplex.com/wikipage?title=Format-ZipFile-EN

PowerShell Support

  • PowerShell 2.0

Operating System Support

  • Windows 7
  • Windows 8
  • Windows 8.1
  • Windows Server 2008 all editions
  • Windows Server 2008 R2 all editions
  • Windows Server 2012 all editions
  • Windows Server 2012 R2 all editions

Last edited May 14, 2014 at 11:42 AM by LaurentDardenne, version 2

Comments

No comments yet.