Xceed .NET Libraries Documentation
Xceed.GZip Assembly / Xceed.GZip Namespace / QuickGZip Class / GZip Method / GZip(String,Boolean,ByteProgressionCallback,ItemProgressionCallback,Object,String) Method
The full path of the destination GZip file.
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 add to the GZip file.


In This Topic
    GZip(String,Boolean,ByteProgressionCallback,ItemProgressionCallback,Object,String) Method
    In This Topic
    Adds the specified file to the GZip file, providing delegates for notifications and specifying whether files should be replaced.
    Syntax
    'Declaration
     
    Public Overloads Shared Sub GZip( _
       ByVal gzipFileName As String, _
       ByVal replaceExistingFiles As Boolean, _
       ByVal byteProgressionCallback As QuickGZip.ByteProgressionCallback, _
       ByVal itemProgressionCallback As QuickGZip.ItemProgressionCallback, _
       ByVal userParams As Object, _
       ByVal fileToGZip As String _
    ) 
    'Usage
     
    Dim gzipFileName As String
    Dim replaceExistingFiles As Boolean
    Dim byteProgressionCallback As QuickGZip.ByteProgressionCallback
    Dim itemProgressionCallback As QuickGZip.ItemProgressionCallback
    Dim userParams As Object
    Dim fileToGZip As String
     
    QuickGZip.GZip(gzipFileName, replaceExistingFiles, byteProgressionCallback, itemProgressionCallback, userParams, fileToGZip)

    Parameters

    gzipFileName
    The full path of the destination GZip file.
    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.
    fileToGZip
    The path of the file to add to the 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