Xceed .NET Libraries Documentation
Xceed.GZip Assembly / Xceed.GZip Namespace / QuickGZip Class / Ungzip Method / Ungzip(String,String,Boolean,ByteProgressionCallback,ItemProgressionCallback,Object,String) Method
The full path of the source GZip file.
The full path of the folder into which the uncompressed file will be placed
Boolean value indicating whether existing items in the destination should be replaced.
Delegate for ByteProgression notification.
Delegate for ItemProgression notification.
Opaque data that will be passed back to the event handler when an event is raised.
The path of the file to uncompress from the GZip file.


In This Topic
    Ungzip(String,String,Boolean,ByteProgressionCallback,ItemProgressionCallback,Object,String) Method
    In This Topic
    Uncompresses a file from the specified GZip file, using the provided delegates for notifications, specifying whether existing files should be replaced in the provided destination folder.
    Syntax
    'Declaration
     
    Public Overloads Shared Sub Ungzip( _
       ByVal gzipFileName As String, _
       ByVal destinationFolder As String, _
       ByVal replaceExistingFiles As Boolean, _
       ByVal byteProgressionCallback As QuickGZip.ByteProgressionCallback, _
       ByVal itemProgressionCallback As QuickGZip.ItemProgressionCallback, _
       ByVal userParams As Object, _
       ByVal fileToUngzip As String _
    ) 
    'Usage
     
    Dim gzipFileName As String
    Dim destinationFolder As String
    Dim replaceExistingFiles As Boolean
    Dim byteProgressionCallback As QuickGZip.ByteProgressionCallback
    Dim itemProgressionCallback As QuickGZip.ItemProgressionCallback
    Dim userParams As Object
    Dim fileToUngzip As String
     
    QuickGZip.Ungzip(gzipFileName, destinationFolder, replaceExistingFiles, byteProgressionCallback, itemProgressionCallback, userParams, fileToUngzip)

    Parameters

    gzipFileName
    The full path of the source GZip file.
    destinationFolder
    The full path of the folder into which the uncompressed file will be placed
    replaceExistingFiles
    Boolean value indicating whether existing items in the destination should be replaced.
    byteProgressionCallback
    Delegate for ByteProgression notification.
    itemProgressionCallback
    Delegate for ItemProgression notification.
    userParams
    Opaque data that will be passed back to the event handler when an event is raised.
    fileToUngzip
    The path of the file to uncompress from the GZip file.
    Remarks
    QuickGZip only supports uncompressing a single file from a GZip file.
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also