// ExtractExistingFileAction.cs
|
// ------------------------------------------------------------------
|
//
|
// Copyright (c) 2009 Dino Chiesa
|
// All rights reserved.
|
//
|
// This code module is part of DotNetZip, a zipfile class library.
|
//
|
// ------------------------------------------------------------------
|
//
|
// This code is licensed under the Microsoft Public License.
|
// See the file License.txt for the license details.
|
// More info on: http://dotnetzip.codeplex.com
|
//
|
// ------------------------------------------------------------------
|
//
|
// last saved (in emacs):
|
// Time-stamp: <2009-August-25 08:44:37>
|
//
|
// ------------------------------------------------------------------
|
//
|
// This module defines the ExtractExistingFileAction enum
|
//
|
//
|
// ------------------------------------------------------------------
|
|
|
namespace HH.WMS.Utils.Ionic.Zip
|
{
|
|
/// <summary>
|
/// An enum for the options when extracting an entry would overwrite an existing file.
|
/// </summary>
|
///
|
/// <remarks>
|
/// <para>
|
/// This enum describes the actions that the library can take when an
|
/// <c>Extract()</c> or <c>ExtractWithPassword()</c> method is called to extract an
|
/// entry to a filesystem, and the extraction would overwrite an existing filesystem
|
/// file.
|
/// </para>
|
/// </remarks>
|
///
|
public enum ExtractExistingFileAction
|
{
|
/// <summary>
|
/// Throw an exception when extraction would overwrite an existing file. (For
|
/// COM clients, this is a 0 (zero).)
|
/// </summary>
|
Throw,
|
|
/// <summary>
|
/// When extraction would overwrite an existing file, overwrite the file silently.
|
/// The overwrite will happen even if the target file is marked as read-only.
|
/// (For COM clients, this is a 1.)
|
/// </summary>
|
OverwriteSilently,
|
|
/// <summary>
|
/// When extraction would overwrite an existing file, don't overwrite the file, silently.
|
/// (For COM clients, this is a 2.)
|
/// </summary>
|
DoNotOverwrite,
|
|
/// <summary>
|
/// When extraction would overwrite an existing file, invoke the ExtractProgress
|
/// event, using an event type of <see
|
/// cref="ZipProgressEventType.Extracting_ExtractEntryWouldOverwrite"/>. In
|
/// this way, the application can decide, just-in-time, whether to overwrite the
|
/// file. For example, a GUI application may wish to pop up a dialog to allow
|
/// the user to choose. You may want to examine the <see
|
/// cref="ExtractProgressEventArgs.ExtractLocation"/> property before making
|
/// the decision. If, after your processing in the Extract progress event, you
|
/// want to NOT extract the file, set <see cref="ZipEntry.ExtractExistingFile"/>
|
/// on the <c>ZipProgressEventArgs.CurrentEntry</c> to <c>DoNotOverwrite</c>.
|
/// If you do want to extract the file, set <c>ZipEntry.ExtractExistingFile</c>
|
/// to <c>OverwriteSilently</c>. If you want to cancel the Extraction, set
|
/// <c>ZipProgressEventArgs.Cancel</c> to true. Cancelling differs from using
|
/// DoNotOverwrite in that a cancel will not extract any further entries, if
|
/// there are any. (For COM clients, the value of this enum is a 3.)
|
/// </summary>
|
InvokeExtractProgressEvent,
|
}
|
|
}
|
