aboutsummaryrefslogtreecommitdiff
path: root/src/dtf/WixToolset.Dtf.Compression/ArchiveProgressType.cs
diff options
context:
space:
mode:
authorRob Mensching <rob@firegiant.com>2021-05-11 07:36:37 -0700
committerRob Mensching <rob@firegiant.com>2021-05-11 07:36:37 -0700
commit3f583916719eeef598d10a5d4e14ef14f008243b (patch)
tree3d528e0ddb5c0550954217c97059d2f19cd6152a /src/dtf/WixToolset.Dtf.Compression/ArchiveProgressType.cs
parent2e5ab696b8b4666d551b2a0532b95fb7fe6dbe03 (diff)
downloadwix-3f583916719eeef598d10a5d4e14ef14f008243b.tar.gz
wix-3f583916719eeef598d10a5d4e14ef14f008243b.tar.bz2
wix-3f583916719eeef598d10a5d4e14ef14f008243b.zip
Merge Dtf
Diffstat (limited to 'src/dtf/WixToolset.Dtf.Compression/ArchiveProgressType.cs')
-rw-r--r--src/dtf/WixToolset.Dtf.Compression/ArchiveProgressType.cs69
1 files changed, 69 insertions, 0 deletions
diff --git a/src/dtf/WixToolset.Dtf.Compression/ArchiveProgressType.cs b/src/dtf/WixToolset.Dtf.Compression/ArchiveProgressType.cs
new file mode 100644
index 00000000..2307c28e
--- /dev/null
+++ b/src/dtf/WixToolset.Dtf.Compression/ArchiveProgressType.cs
@@ -0,0 +1,69 @@
1// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
2
3namespace WixToolset.Dtf.Compression
4{
5using System;
6using System.Collections.Generic;
7using System.Text;
8
9 /// <summary>
10 /// The type of progress event.
11 /// </summary>
12 /// <remarks>
13 /// <p>PACKING EXAMPLE: The following sequence of events might be received when
14 /// extracting a simple archive file with 2 files.</p>
15 /// <list type="table">
16 /// <listheader><term>Message Type</term><description>Description</description></listheader>
17 /// <item><term>StartArchive</term> <description>Begin extracting archive</description></item>
18 /// <item><term>StartFile</term> <description>Begin extracting first file</description></item>
19 /// <item><term>PartialFile</term> <description>Extracting first file</description></item>
20 /// <item><term>PartialFile</term> <description>Extracting first file</description></item>
21 /// <item><term>FinishFile</term> <description>Finished extracting first file</description></item>
22 /// <item><term>StartFile</term> <description>Begin extracting second file</description></item>
23 /// <item><term>PartialFile</term> <description>Extracting second file</description></item>
24 /// <item><term>FinishFile</term> <description>Finished extracting second file</description></item>
25 /// <item><term>FinishArchive</term><description>Finished extracting archive</description></item>
26 /// </list>
27 /// <p></p>
28 /// <p>UNPACKING EXAMPLE: Packing 3 files into 2 archive chunks, where the second file is
29 /// continued to the second archive chunk.</p>
30 /// <list type="table">
31 /// <listheader><term>Message Type</term><description>Description</description></listheader>
32 /// <item><term>StartFile</term> <description>Begin compressing first file</description></item>
33 /// <item><term>FinishFile</term> <description>Finished compressing first file</description></item>
34 /// <item><term>StartFile</term> <description>Begin compressing second file</description></item>
35 /// <item><term>PartialFile</term> <description>Compressing second file</description></item>
36 /// <item><term>PartialFile</term> <description>Compressing second file</description></item>
37 /// <item><term>FinishFile</term> <description>Finished compressing second file</description></item>
38 /// <item><term>StartArchive</term> <description>Begin writing first archive</description></item>
39 /// <item><term>PartialArchive</term><description>Writing first archive</description></item>
40 /// <item><term>FinishArchive</term> <description>Finished writing first archive</description></item>
41 /// <item><term>StartFile</term> <description>Begin compressing third file</description></item>
42 /// <item><term>PartialFile</term> <description>Compressing third file</description></item>
43 /// <item><term>FinishFile</term> <description>Finished compressing third file</description></item>
44 /// <item><term>StartArchive</term> <description>Begin writing second archive</description></item>
45 /// <item><term>PartialArchive</term><description>Writing second archive</description></item>
46 /// <item><term>FinishArchive</term> <description>Finished writing second archive</description></item>
47 /// </list>
48 /// </remarks>
49 public enum ArchiveProgressType : int
50 {
51 /// <summary>Status message before beginning the packing or unpacking an individual file.</summary>
52 StartFile,
53
54 /// <summary>Status message (possibly reported multiple times) during the process of packing or unpacking a file.</summary>
55 PartialFile,
56
57 /// <summary>Status message after completion of the packing or unpacking an individual file.</summary>
58 FinishFile,
59
60 /// <summary>Status message before beginning the packing or unpacking an archive.</summary>
61 StartArchive,
62
63 /// <summary>Status message (possibly reported multiple times) during the process of packing or unpacking an archiv.</summary>
64 PartialArchive,
65
66 /// <summary>Status message after completion of the packing or unpacking of an archive.</summary>
67 FinishArchive,
68 }
69}