Xceed Logo
Shop
Xceed .NET Libraries Documentation
[Root] / Xceed.Zip Assembly / Xceed.Zip Namespace / QuickZip.DiskRequiredCallback Delegate
The full path and name of the zip file.
A value representing the required disk number.
Opaque data that is sent back to the event handler when the event is raised.
ExampleExample


In This Topic
    QuickZip.DiskRequiredCallback Delegate
    In This Topic
    Represents the method that is mapped to DiskRequiredCallback.
    Syntax
    'Declaration
 

    Public Delegate Function QuickZip.DiskRequiredCallback( _
   ByVal zipFileName As String, _
   ByVal diskNumber As Integer, _
   ByVal userParams As Object _
) As Boolean
    'Usage
 

    Dim instance As New QuickZip.DiskRequiredCallback(AddressOf HandlerMethod)
    public delegate bool QuickZip.DiskRequiredCallback( 
   string zipFileName,
   int diskNumber,
   object userParams
)

    Parameters

    zipFileName
    The full path and name of the zip file.
    diskNumber
    A value representing the required disk number.
    userParams
    Opaque data that is sent back to the event handler when the event is raised.

    Return Value

    true if a new disk was inserted; false otherwise.
    Example
    The following example demonstrates how to create a spanned self-extracting zip file. 
    Dim sfx As New XceedSfxPrefix(New DiskFile("C:\Xceed Components\Sfx\xcdsfx32.bin"))

sfx.DialogStrings(DialogStrings.Title) = "Welcome to Xceed Zip for .NET!"
sfx.DefaultDestinationFolder = "C:\"
sfx.ExistingFileBehavior = ExistingFileBehavior.OverwriteOlderOnly

QuickZip.Zip("a:\sfx.exe", String.Empty, True, True, False, sfx, _
             New QuickZip.DiskRequiredCallback(AddressOf Me.QuickDiskRequired), _
             Nothing, "d:\file.txt")

' This method will handle the DiskRequired events that are raised when creating
' spanned or split zip files.
Private Function QuickDiskRequired(ByVal zipFile As String, ByVal diskNumber As Integer, _
                                   ByVal userData As Object) As Boolean
     If (MessageBox.Show("Disk #" + diskNumber.ToString() + " is required.", "Disk Required", _
                         MessageBoxButtons.OKCancel) = DialogResult.OK) Then
          Return True
     Else
          Return False
     End If
End Function
    XceedSfxPrefix sfx = new XceedSfxPrefix( new DiskFile( @"C:\Xceed Components\Sfx\xcdsfx32.bin" ) );

sfx.DialogStrings[ DialogStrings.Title ] = "Welcome to Xceed Zip for .NET!";
sfx.DefaultDestinationFolder = @"C:\";
sfx.ExistingFileBehavior = ExistingFileBehavior.OverwriteOlderOnly;

QuickZip.Zip( @"a:\sfx.exe", string.Empty, true, true, false, sfx, 
              new QuickZip.DiskRequiredCallback( this.QuickDiskRequired ), 
              null, @"d:\file.txt" );

// This method will handle the DiskRequired events that are raised when creating
// spanned or split zip files.
private bool QuickDiskRequired( string zipFile, int diskNumber, object userData )
{
     if( MessageBox.Show( "Disk #" + diskNumber.ToString() + " is required.", "Disk Required", 
                          MessageBoxButtons.OKCancel ) == DialogResult.OK )
          return true;
     else
          return false;    
}
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    QuickZip.DiskRequiredCallback Members
    Xceed.Zip Namespace

    Send Feedback