-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMicrosoft.Deployment.Compression.xml
1960 lines (1960 loc) · 118 KB
/
Microsoft.Deployment.Compression.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.Deployment.Compression</name>
</assembly>
<members>
<member name="T:Microsoft.Deployment.Compression.ArchiveException">
<summary>
Base exception class for compression operations. Compression libraries should
derive subclass exceptions with more specific error information relevent to the
file format.
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveException.#ctor(System.String,System.Exception)">
<summary>
Creates a new ArchiveException with a specified error message and a reference to the
inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error.</param>
<param name="innerException">The exception that is the cause of the current exception. If the
innerException parameter is not a null reference (Nothing in Visual Basic), the current exception
is raised in a catch block that handles the inner exception.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveException.#ctor(System.String)">
<summary>
Creates a new ArchiveException with a specified error message.
</summary>
<param name="message">The message that describes the error.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveException.#ctor">
<summary>
Creates a new ArchiveException.
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the ArchiveException class with serialized data.
</summary>
<param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
<param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
</member>
<member name="T:Microsoft.Deployment.Compression.ArchiveFileInfo">
<summary>
Abstract object representing a compressed file within an archive;
provides operations for getting the file properties and unpacking
the file.
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.#ctor(Microsoft.Deployment.Compression.ArchiveInfo,System.String)">
<summary>
Creates a new ArchiveFileInfo object representing a file within
an archive in a specified path.
</summary>
<param name="archiveInfo">An object representing the archive
containing the file.</param>
<param name="filePath">The path to the file within the archive.
Usually, this is a simple file name, but if the archive contains
a directory structure this may include the directory.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.#ctor(System.String,System.Int32,System.IO.FileAttributes,System.DateTime,System.Int64)">
<summary>
Creates a new ArchiveFileInfo object with all parameters specified;
used by subclasses when reading the metadata out of an archive.
</summary>
<param name="filePath">The internal path and name of the file in
the archive.</param>
<param name="archiveNumber">The archive number where the file
starts.</param>
<param name="attributes">The stored attributes of the file.</param>
<param name="lastWriteTime">The stored last write time of the
file.</param>
<param name="length">The uncompressed size of the file.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the ArchiveFileInfo class with
serialized data.
</summary>
<param name="info">The SerializationInfo that holds the serialized
object data about the exception being thrown.</param>
<param name="context">The StreamingContext that contains contextual
information about the source or destination.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Sets the SerializationInfo with information about the archive.
</summary>
<param name="info">The SerializationInfo that holds the serialized
object data.</param>
<param name="context">The StreamingContext that contains contextual
information about the source or destination.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.ToString">
<summary>
Gets the full path to the file.
</summary>
<returns>The same as <see cref="P:Microsoft.Deployment.Compression.ArchiveFileInfo.FullName"/></returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.Delete">
<summary>
Deletes the file. NOT SUPPORTED.
</summary>
<exception cref="T:System.NotSupportedException">Files cannot be deleted
from an existing archive.</exception>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.Refresh">
<summary>
Refreshes the attributes and other cached information about the file,
by re-reading the information from the archive.
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.CopyTo(System.String)">
<summary>
Extracts the file.
</summary>
<param name="destFileName">The destination path where the file
will be extracted.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.CopyTo(System.String,System.Boolean)">
<summary>
Extracts the file, optionally overwriting any existing file.
</summary>
<param name="destFileName">The destination path where the file
will be extracted.</param>
<param name="overwrite">If true, <paramref name="destFileName"/>
will be overwritten if it exists.</param>
<exception cref="T:System.IO.IOException"><paramref name="overwrite"/> is false
and <paramref name="destFileName"/> exists.</exception>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.OpenRead">
<summary>
Opens the archive file for reading without actually extracting the
file to disk.
</summary>
<returns>
A stream for reading directly from the packed file. Like any stream
this should be closed/disposed as soon as it is no longer needed.
</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.OpenText">
<summary>
Opens the archive file reading text with UTF-8 encoding without
actually extracting the file to disk.
</summary>
<returns>
A reader for reading text directly from the packed file. Like any reader
this should be closed/disposed as soon as it is no longer needed.
</returns>
<remarks>
To open an archived text file with different encoding, use the
<see cref="M:Microsoft.Deployment.Compression.ArchiveFileInfo.OpenRead"/> method and pass the returned stream to one of
the <see cref="T:System.IO.StreamReader"/> constructor overloads.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveFileInfo.Refresh(Microsoft.Deployment.Compression.ArchiveFileInfo)">
<summary>
Refreshes the information in this object with new data retrieved
from an archive.
</summary>
<param name="newFileInfo">Fresh instance for the same file just
read from the archive.</param>
<remarks>
Subclasses may override this method to refresh sublcass fields.
However they should always call the base implementation first.
</remarks>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.Name">
<summary>
Gets the name of the file.
</summary>
<value>The name of the file, not including any path.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.Path">
<summary>
Gets the internal path of the file in the archive.
</summary>
<value>The internal path of the file in the archive, not including
the file name.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.FullName">
<summary>
Gets the full path to the file.
</summary>
<value>The full path to the file, including the full path to the
archive, the internal path in the archive, and the file name.</value>
<remarks>
For example, the path <c>"C:\archive.cab\file.txt"</c> refers to
a file "file.txt" inside the archive "archive.cab".
</remarks>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.Archive">
<summary>
Gets or sets the archive that contains this file.
</summary>
<value>
The ArchiveInfo instance that retrieved this file information -- this
may be null if the ArchiveFileInfo object was returned directly from
a stream.
</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.ArchiveName">
<summary>
Gets the full path of the archive that contains this file.
</summary>
<value>The full path of the archive that contains this file.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.ArchiveNumber">
<summary>
Gets the number of the archive where this file starts.
</summary>
<value>The number of the archive where this file starts.</value>
<remarks>A single archive or the first archive in a chain is
numbered 0.</remarks>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.Exists">
<summary>
Checks if the file exists within the archive.
</summary>
<value>True if the file exists, false otherwise.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.Length">
<summary>
Gets the uncompressed size of the file.
</summary>
<value>The uncompressed size of the file in bytes.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.Attributes">
<summary>
Gets the attributes of the file.
</summary>
<value>The attributes of the file as stored in the archive.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveFileInfo.LastWriteTime">
<summary>
Gets the last modification time of the file.
</summary>
<value>The last modification time of the file as stored in the
archive.</value>
</member>
<member name="T:Microsoft.Deployment.Compression.ArchiveInfo">
<summary>
Abstract object representing a compressed archive on disk;
provides access to file-based operations on the archive.
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.#ctor(System.String)">
<summary>
Creates a new ArchiveInfo object representing an archive in a
specified path.
</summary>
<param name="path">The path to the archive. When creating an archive,
this file does not necessarily exist yet.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the ArchiveInfo class with serialized data.
</summary>
<param name="info">The SerializationInfo that holds the serialized object
data about the exception being thrown.</param>
<param name="context">The StreamingContext that contains contextual
information about the source or destination.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.ToString">
<summary>
Gets the full path of the archive.
</summary>
<returns>The full path of the archive.</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.Delete">
<summary>
Deletes the archive.
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.CopyTo(System.String)">
<summary>
Copies an existing archive to another location.
</summary>
<param name="destFileName">The destination file path.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.CopyTo(System.String,System.Boolean)">
<summary>
Copies an existing archive to another location, optionally
overwriting the destination file.
</summary>
<param name="destFileName">The destination file path.</param>
<param name="overwrite">If true, the destination file will be
overwritten if it exists.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.MoveTo(System.String)">
<summary>
Moves an existing archive to another location.
</summary>
<param name="destFileName">The destination file path.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.IsValid">
<summary>
Checks if the archive contains a valid archive header.
</summary>
<returns>True if the file is a valid archive; false otherwise.</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.GetFiles">
<summary>
Gets information about the files contained in the archive.
</summary>
<returns>A list of <see cref="T:Microsoft.Deployment.Compression.ArchiveFileInfo"/> objects, each
containing information about a file in the archive.</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.GetFiles(System.String)">
<summary>
Gets information about the certain files contained in the archive file.
</summary>
<param name="searchPattern">The search string, such as
"*.txt".</param>
<returns>A list of <see cref="T:Microsoft.Deployment.Compression.ArchiveFileInfo"/> objects, each containing
information about a file in the archive.</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.Unpack(System.String)">
<summary>
Extracts all files from an archive to a destination directory.
</summary>
<param name="destDirectory">Directory where the files are to be
extracted.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.Unpack(System.String,System.EventHandler{Microsoft.Deployment.Compression.ArchiveProgressEventArgs})">
<summary>
Extracts all files from an archive to a destination directory,
optionally extracting only newer files.
</summary>
<param name="destDirectory">Directory where the files are to be
extracted.</param>
<param name="progressHandler">Handler for receiving progress
information; this may be null if progress is not desired.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.UnpackFile(System.String,System.String)">
<summary>
Extracts a single file from the archive.
</summary>
<param name="fileName">The name of the file in the archive. Also
includes the internal path of the file, if any. File name matching
is case-insensitive.</param>
<param name="destFileName">The path where the file is to be
extracted on disk.</param>
<remarks>If <paramref name="destFileName"/> already exists,
it will be overwritten.</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.UnpackFiles(System.Collections.Generic.IList{System.String},System.String,System.Collections.Generic.IList{System.String})">
<summary>
Extracts multiple files from the archive.
</summary>
<param name="fileNames">The names of the files in the archive.
Each name includes the internal path of the file, if any. File name
matching is case-insensitive.</param>
<param name="destDirectory">This parameter may be null, but if
specified it is the root directory for any relative paths in
<paramref name="destFileNames"/>.</param>
<param name="destFileNames">The paths where the files are to be
extracted on disk. If this parameter is null, the files will be
extracted with the names from the archive.</param>
<remarks>
If any extracted files already exist on disk, they will be overwritten.
<p>The <paramref name="destDirectory"/> and
<paramref name="destFileNames"/> parameters cannot both be null.</p>
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.UnpackFiles(System.Collections.Generic.IList{System.String},System.String,System.Collections.Generic.IList{System.String},System.EventHandler{Microsoft.Deployment.Compression.ArchiveProgressEventArgs})">
<summary>
Extracts multiple files from the archive, optionally extracting
only newer files.
</summary>
<param name="fileNames">The names of the files in the archive.
Each name includes the internal path of the file, if any. File name
matching is case-insensitive.</param>
<param name="destDirectory">This parameter may be null, but if
specified it is the root directory for any relative paths in
<paramref name="destFileNames"/>.</param>
<param name="destFileNames">The paths where the files are to be
extracted on disk. If this parameter is null, the files will be
extracted with the names from the archive.</param>
<param name="progressHandler">Handler for receiving progress information;
this may be null if progress is not desired.</param>
<remarks>
If any extracted files already exist on disk, they will be overwritten.
<p>The <paramref name="destDirectory"/> and
<paramref name="destFileNames"/> parameters cannot both be null.</p>
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.UnpackFileSet(System.Collections.Generic.IDictionary{System.String,System.String},System.String)">
<summary>
Extracts multiple files from the archive.
</summary>
<param name="fileNames">A mapping from internal file paths to
external file paths. Case-senstivity when matching internal paths
depends on the IDictionary implementation.</param>
<param name="destDirectory">This parameter may be null, but if
specified it is the root directory for any relative external paths
in <paramref name="fileNames"/>.</param>
<remarks>
If any extracted files already exist on disk, they will be overwritten.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.UnpackFileSet(System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.EventHandler{Microsoft.Deployment.Compression.ArchiveProgressEventArgs})">
<summary>
Extracts multiple files from the archive.
</summary>
<param name="fileNames">A mapping from internal file paths to
external file paths. Case-senstivity when matching internal
paths depends on the IDictionary implementation.</param>
<param name="destDirectory">This parameter may be null, but if
specified it is the root directory for any relative external
paths in <paramref name="fileNames"/>.</param>
<param name="progressHandler">Handler for receiving progress
information; this may be null if progress is not desired.</param>
<remarks>
If any extracted files already exist on disk, they will be overwritten.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.OpenRead(System.String)">
<summary>
Opens a file inside the archive for reading without actually
extracting the file to disk.
</summary>
<param name="fileName">The name of the file in the archive. Also
includes the internal path of the file, if any. File name matching
is case-insensitive.</param>
<returns>
A stream for reading directly from the packed file. Like any stream
this should be closed/disposed as soon as it is no longer needed.
</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.OpenText(System.String)">
<summary>
Opens a file inside the archive for reading text with UTF-8 encoding
without actually extracting the file to disk.
</summary>
<param name="fileName">The name of the file in the archive. Also
includes the internal path of the file, if any. File name matching
is case-insensitive.</param>
<returns>
A reader for reading text directly from the packed file. Like any reader
this should be closed/disposed as soon as it is no longer needed.
</returns>
<remarks>
To open an archived text file with different encoding, use the
<see cref="M:Microsoft.Deployment.Compression.ArchiveInfo.OpenRead(System.String)"/> method and pass the returned stream to one of
the <see cref="T:System.IO.StreamReader"/> constructor overloads.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.Pack(System.String)">
<summary>
Compresses all files in a directory into the archive.
Does not include subdirectories.
</summary>
<param name="sourceDirectory">The directory containing the
files to be included.</param>
<remarks>
Uses maximum compression level.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.Pack(System.String,System.Boolean,Microsoft.Deployment.Compression.CompressionLevel,System.EventHandler{Microsoft.Deployment.Compression.ArchiveProgressEventArgs})">
<summary>
Compresses all files in a directory into the archive, optionally
including subdirectories.
</summary>
<param name="sourceDirectory">This is the root directory
for to pack all files.</param>
<param name="includeSubdirectories">If true, recursively include
files in subdirectories.</param>
<param name="compLevel">The compression level used when creating
the archive.</param>
<param name="progressHandler">Handler for receiving progress information;
this may be null if progress is not desired.</param>
<remarks>
The files are stored in the archive using their relative file paths in
the directory tree, if supported by the archive file format.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.PackFiles(System.String,System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String})">
<summary>
Compresses files into the archive, specifying the names used to
store the files in the archive.
</summary>
<param name="sourceDirectory">This parameter may be null, but
if specified it is the root directory
for any relative paths in <paramref name="sourceFileNames"/>.</param>
<param name="sourceFileNames">The list of files to be included in
the archive.</param>
<param name="fileNames">The names of the files as they are stored
in the archive. Each name
includes the internal path of the file, if any. This parameter may
be null, in which case the files are stored in the archive with their
source file names and no path information.</param>
<remarks>
Uses maximum compression level.
<p>Duplicate items in the <paramref name="fileNames"/> array will cause
an <see cref="T:Microsoft.Deployment.Compression.ArchiveException"/>.</p>
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.PackFiles(System.String,System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String},Microsoft.Deployment.Compression.CompressionLevel,System.EventHandler{Microsoft.Deployment.Compression.ArchiveProgressEventArgs})">
<summary>
Compresses files into the archive, specifying the names used to
store the files in the archive.
</summary>
<param name="sourceDirectory">This parameter may be null, but if
specified it is the root directory
for any relative paths in <paramref name="sourceFileNames"/>.</param>
<param name="sourceFileNames">The list of files to be included in
the archive.</param>
<param name="fileNames">The names of the files as they are stored in
the archive. Each name includes the internal path of the file, if any.
This parameter may be null, in which case the files are stored in the
archive with their source file names and no path information.</param>
<param name="compLevel">The compression level used when creating the
archive.</param>
<param name="progressHandler">Handler for receiving progress information;
this may be null if progress is not desired.</param>
<remarks>
Duplicate items in the <paramref name="fileNames"/> array will cause
an <see cref="T:Microsoft.Deployment.Compression.ArchiveException"/>.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.PackFileSet(System.String,System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
Compresses files into the archive, specifying the names used
to store the files in the archive.
</summary>
<param name="sourceDirectory">This parameter may be null, but if
specified it is the root directory
for any relative paths in <paramref name="fileNames"/>.</param>
<param name="fileNames">A mapping from internal file paths to
external file paths.</param>
<remarks>
Uses maximum compression level.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.PackFileSet(System.String,System.Collections.Generic.IDictionary{System.String,System.String},Microsoft.Deployment.Compression.CompressionLevel,System.EventHandler{Microsoft.Deployment.Compression.ArchiveProgressEventArgs})">
<summary>
Compresses files into the archive, specifying the names used to
store the files in the archive.
</summary>
<param name="sourceDirectory">This parameter may be null, but if
specified it is the root directory
for any relative paths in <paramref name="fileNames"/>.</param>
<param name="fileNames">A mapping from internal file paths to
external file paths.</param>
<param name="compLevel">The compression level used when creating
the archive.</param>
<param name="progressHandler">Handler for receiving progress information;
this may be null if progress is not desired.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.GetRelativeFilePathsInDirectoryTree(System.String,System.Boolean)">
<summary>
Given a directory, gets the relative paths of all files in the
directory, optionally including all subdirectories.
</summary>
<param name="dir">The directory to search.</param>
<param name="includeSubdirectories">True to include subdirectories
in the search.</param>
<returns>A list of file paths relative to the directory.</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.GetFile(System.String)">
<summary>
Retrieves information about one file from this archive.
</summary>
<param name="path">Path of the file in the archive.</param>
<returns>File information, or null if the file was not found
in the archive.</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.CreateCompressionEngine">
<summary>
Creates a compression engine that does the low-level work for
this object.
</summary>
<returns>A new compression engine instance that matches the specific
subclass of archive.</returns>
<remarks>
Each instance will be <see cref="M:Microsoft.Deployment.Compression.CompressionEngine.Dispose"/>d
immediately after use.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.CreateStringDictionary(System.Collections.Generic.IList{System.String},System.Collections.Generic.IList{System.String})">
<summary>
Creates a case-insensitive dictionary mapping from one list of
strings to the other.
</summary>
<param name="keys">List of keys.</param>
<param name="values">List of values that are mapped 1-to-1 to
the keys.</param>
<returns>A filled dictionary of the strings.</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.RecursiveGetRelativeFilePathsInDirectoryTree(System.String,System.String,System.Boolean,System.Collections.Generic.IList{System.String})">
<summary>
Recursive-descent helper function for
GetRelativeFilePathsInDirectoryTree.
</summary>
<param name="dir">The root directory of the search.</param>
<param name="relativeDir">The relative directory to be
processed now.</param>
<param name="includeSubdirectories">True to descend into
subdirectories.</param>
<param name="fileList">List of files found so far.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveInfo.InternalGetFiles(System.Predicate{System.String})">
<summary>
Uses a CompressionEngine to get ArchiveFileInfo objects from this
archive, and then associates them with this ArchiveInfo instance.
</summary>
<param name="fileFilter">Optional predicate that can determine
which files to process.</param>
<returns>A list of <see cref="T:Microsoft.Deployment.Compression.ArchiveFileInfo"/> objects, each
containing information about a file in the archive.</returns>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveInfo.Directory">
<summary>
Gets the directory that contains the archive.
</summary>
<value>A DirectoryInfo object representing the parent directory of the
archive.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveInfo.DirectoryName">
<summary>
Gets the full path of the directory that contains the archive.
</summary>
<value>The full path of the directory that contains the archive.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveInfo.Length">
<summary>
Gets the size of the archive.
</summary>
<value>The size of the archive in bytes.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveInfo.Name">
<summary>
Gets the file name of the archive.
</summary>
<value>The file name of the archive, not including any path.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveInfo.Exists">
<summary>
Checks if the archive exists.
</summary>
<value>True if the archive exists; else false.</value>
</member>
<member name="T:Microsoft.Deployment.Compression.ArchiveProgressEventArgs">
<summary>
Contains the data reported in an archive progress event.
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.#ctor(Microsoft.Deployment.Compression.ArchiveProgressType,System.String,System.Int32,System.Int32,System.Int64,System.Int64,System.String,System.Int32,System.Int32,System.Int64,System.Int64,System.Int64,System.Int64)">
<summary>
Creates a new ArchiveProgressEventArgs object from specified event parameters.
</summary>
<param name="progressType">type of status message</param>
<param name="currentFileName">name of the file being processed</param>
<param name="currentFileNumber">number of the current file being processed</param>
<param name="totalFiles">total number of files to be processed</param>
<param name="currentFileBytesProcessed">number of bytes processed so far when compressing or extracting a file</param>
<param name="currentFileTotalBytes">total number of bytes in the current file</param>
<param name="currentArchiveName">name of the current Archive</param>
<param name="currentArchiveNumber">current Archive number, when processing a chained set of Archives</param>
<param name="totalArchives">total number of Archives in a chained set</param>
<param name="currentArchiveBytesProcessed">number of compressed bytes processed so far during an extraction</param>
<param name="currentArchiveTotalBytes">total number of compressed bytes to be processed during an extraction</param>
<param name="fileBytesProcessed">number of uncompressed file bytes processed so far</param>
<param name="totalFileBytes">total number of uncompressed file bytes to be processed</param>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.ProgressType">
<summary>
Gets the type of status message.
</summary>
<value>A <see cref="T:Microsoft.Deployment.Compression.ArchiveProgressType"/> value indicating what type of progress event occurred.</value>
<remarks>
The handler may choose to ignore some types of progress events.
For example, if the handler will only list each file as it is
compressed/extracted, it can ignore events that
are not of type <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.FinishFile"/>.
</remarks>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.CurrentFileName">
<summary>
Gets the name of the file being processed. (The name of the file within the Archive; not the external
file path.) Also includes the internal path of the file, if any. Valid for
<see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.StartFile"/>, <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.PartialFile"/>,
and <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.FinishFile"/> messages.
</summary>
<value>The name of the file currently being processed, or null if processing
is currently at the stream or archive level.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.CurrentFileNumber">
<summary>
Gets the number of the current file being processed. The first file is number 0, and the last file
is <see cref="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.TotalFiles"/>-1. Valid for <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.StartFile"/>,
<see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.PartialFile"/>, and <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.FinishFile"/> messages.
</summary>
<value>The number of the file currently being processed, or the most recent
file processed if processing is currently at the stream or archive level.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.TotalFiles">
<summary>
Gets the total number of files to be processed. Valid for all message types.
</summary>
<value>The total number of files to be processed that are known so far.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.CurrentFileBytesProcessed">
<summary>
Gets the number of bytes processed so far when compressing or extracting a file. Valid for
<see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.StartFile"/>, <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.PartialFile"/>,
and <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.FinishFile"/> messages.
</summary>
<value>The number of uncompressed bytes processed so far for the current file,
or 0 if processing is currently at the stream or archive level.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.CurrentFileTotalBytes">
<summary>
Gets the total number of bytes in the current file. Valid for <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.StartFile"/>,
<see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.PartialFile"/>, and <see cref="F:Microsoft.Deployment.Compression.ArchiveProgressType.FinishFile"/> messages.
</summary>
<value>The uncompressed size of the current file being processed,
or 0 if processing is currently at the stream or archive level.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.CurrentArchiveName">
<summary>
Gets the name of the current archive. Not necessarily the name of the archive on disk.
Valid for all message types.
</summary>
<value>The name of the current archive, or an empty string if no name was specified.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.CurrentArchiveNumber">
<summary>
Gets the current archive number, when processing a chained set of archives. Valid for all message types.
</summary>
<value>The number of the current archive.</value>
<remarks>The first archive is number 0, and the last archive is
<see cref="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.TotalArchives"/>-1.</remarks>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.TotalArchives">
<summary>
Gets the total number of known archives in a chained set. Valid for all message types.
</summary>
<value>The total number of known archives in a chained set.</value>
<remarks>
When using the compression option to auto-split into multiple archives based on data size,
this value will not be accurate until the end.
</remarks>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.CurrentArchiveBytesProcessed">
<summary>
Gets the number of compressed bytes processed so far during extraction
of the current archive. Valid for all extraction messages.
</summary>
<value>The number of compressed bytes processed so far during extraction
of the current archive.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.CurrentArchiveTotalBytes">
<summary>
Gets the total number of compressed bytes to be processed during extraction
of the current archive. Valid for all extraction messages.
</summary>
<value>The total number of compressed bytes to be processed during extraction
of the current archive.</value>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.FileBytesProcessed">
<summary>
Gets the number of uncompressed bytes processed so far among all files. Valid for all message types.
</summary>
<value>The number of uncompressed file bytes processed so far among all files.</value>
<remarks>
When compared to <see cref="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.TotalFileBytes"/>, this can be used as a measure of overall progress.
</remarks>
</member>
<member name="P:Microsoft.Deployment.Compression.ArchiveProgressEventArgs.TotalFileBytes">
<summary>
Gets the total number of uncompressed file bytes to be processed. Valid for all message types.
</summary>
<value>The total number of uncompressed bytes to be processed among all files.</value>
</member>
<member name="T:Microsoft.Deployment.Compression.ArchiveProgressType">
<summary>
The type of progress event.
</summary>
<remarks>
<p>PACKING EXAMPLE: The following sequence of events might be received when
extracting a simple archive file with 2 files.</p>
<list type="table">
<listheader><term>Message Type</term><description>Description</description></listheader>
<item><term>StartArchive</term> <description>Begin extracting archive</description></item>
<item><term>StartFile</term> <description>Begin extracting first file</description></item>
<item><term>PartialFile</term> <description>Extracting first file</description></item>
<item><term>PartialFile</term> <description>Extracting first file</description></item>
<item><term>FinishFile</term> <description>Finished extracting first file</description></item>
<item><term>StartFile</term> <description>Begin extracting second file</description></item>
<item><term>PartialFile</term> <description>Extracting second file</description></item>
<item><term>FinishFile</term> <description>Finished extracting second file</description></item>
<item><term>FinishArchive</term><description>Finished extracting archive</description></item>
</list>
<p></p>
<p>UNPACKING EXAMPLE: Packing 3 files into 2 archive chunks, where the second file is
continued to the second archive chunk.</p>
<list type="table">
<listheader><term>Message Type</term><description>Description</description></listheader>
<item><term>StartFile</term> <description>Begin compressing first file</description></item>
<item><term>FinishFile</term> <description>Finished compressing first file</description></item>
<item><term>StartFile</term> <description>Begin compressing second file</description></item>
<item><term>PartialFile</term> <description>Compressing second file</description></item>
<item><term>PartialFile</term> <description>Compressing second file</description></item>
<item><term>FinishFile</term> <description>Finished compressing second file</description></item>
<item><term>StartArchive</term> <description>Begin writing first archive</description></item>
<item><term>PartialArchive</term><description>Writing first archive</description></item>
<item><term>FinishArchive</term> <description>Finished writing first archive</description></item>
<item><term>StartFile</term> <description>Begin compressing third file</description></item>
<item><term>PartialFile</term> <description>Compressing third file</description></item>
<item><term>FinishFile</term> <description>Finished compressing third file</description></item>
<item><term>StartArchive</term> <description>Begin writing second archive</description></item>
<item><term>PartialArchive</term><description>Writing second archive</description></item>
<item><term>FinishArchive</term> <description>Finished writing second archive</description></item>
</list>
</remarks>
</member>
<member name="F:Microsoft.Deployment.Compression.ArchiveProgressType.StartFile">
<summary>Status message before beginning the packing or unpacking an individual file.</summary>
</member>
<member name="F:Microsoft.Deployment.Compression.ArchiveProgressType.PartialFile">
<summary>Status message (possibly reported multiple times) during the process of packing or unpacking a file.</summary>
</member>
<member name="F:Microsoft.Deployment.Compression.ArchiveProgressType.FinishFile">
<summary>Status message after completion of the packing or unpacking an individual file.</summary>
</member>
<member name="F:Microsoft.Deployment.Compression.ArchiveProgressType.StartArchive">
<summary>Status message before beginning the packing or unpacking an archive.</summary>
</member>
<member name="F:Microsoft.Deployment.Compression.ArchiveProgressType.PartialArchive">
<summary>Status message (possibly reported multiple times) during the process of packing or unpacking an archiv.</summary>
</member>
<member name="F:Microsoft.Deployment.Compression.ArchiveProgressType.FinishArchive">
<summary>Status message after completion of the packing or unpacking of an archive.</summary>
</member>
<member name="T:Microsoft.Deployment.Compression.ArchiveFileStreamContext">
<summary>
Provides a basic implementation of the archive pack and unpack stream context
interfaces, based on a list of archive files, a default directory, and an
optional mapping from internal to external file paths.
</summary>
<remarks>
This class can also handle creating or extracting chained archive packages.
</remarks>
</member>
<member name="T:Microsoft.Deployment.Compression.IPackStreamContext">
<summary>
This interface provides the methods necessary for the
<see cref="T:Microsoft.Deployment.Compression.CompressionEngine"/> to open and close streams for archives
and files. The implementor of this interface can use any kind of logic
to determine what kind of streams to open and where.
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.IPackStreamContext.GetArchiveName(System.Int32)">
<summary>
Gets the name of the archive with a specified number.
</summary>
<param name="archiveNumber">The 0-based index of the archive
within the chain.</param>
<returns>The name of the requested archive. May be an empty string
for non-chained archives, but may never be null.</returns>
<remarks>The archive name is the name stored within the archive, used for
identification of the archive especially among archive chains. That
name is often, but not necessarily the same as the filename of the
archive package.</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.IPackStreamContext.OpenArchiveWriteStream(System.Int32,System.String,System.Boolean,Microsoft.Deployment.Compression.CompressionEngine)">
<summary>
Opens a stream for writing an archive package.
</summary>
<param name="archiveNumber">The 0-based index of the archive within
the chain.</param>
<param name="archiveName">The name of the archive that was returned
by <see cref="M:Microsoft.Deployment.Compression.IPackStreamContext.GetArchiveName(System.Int32)"/>.</param>
<param name="truncate">True if the stream should be truncated when
opened (if it already exists); false if an existing stream is being
re-opened for writing additional data.</param>
<param name="compressionEngine">Instance of the compression engine
doing the operations.</param>
<returns>A writable Stream where the compressed archive bytes will be
written, or null to cancel the archive creation.</returns>
<remarks>
If this method returns null, the archive engine will throw a
FileNotFoundException.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.IPackStreamContext.CloseArchiveWriteStream(System.Int32,System.String,System.IO.Stream)">
<summary>
Closes a stream where an archive package was written.
</summary>
<param name="archiveNumber">The 0-based index of the archive within
the chain.</param>
<param name="archiveName">The name of the archive that was previously
returned by
<see cref="M:Microsoft.Deployment.Compression.IPackStreamContext.GetArchiveName(System.Int32)"/>.</param>
<param name="stream">A stream that was previously returned by
<see cref="M:Microsoft.Deployment.Compression.IPackStreamContext.OpenArchiveWriteStream(System.Int32,System.String,System.Boolean,Microsoft.Deployment.Compression.CompressionEngine)"/> and is now ready to be closed.</param>
<remarks>
If there is another archive package in the chain, then after this stream
is closed a new stream will be opened.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.IPackStreamContext.OpenFileReadStream(System.String,System.IO.FileAttributes@,System.DateTime@)">
<summary>
Opens a stream to read a file that is to be included in an archive.
</summary>
<param name="path">The path of the file within the archive. This is often,
but not necessarily, the same as the relative path of the file outside
the archive.</param>
<param name="attributes">Returned attributes of the opened file, to be
stored in the archive.</param>
<param name="lastWriteTime">Returned last-modified time of the opened file,
to be stored in the archive.</param>
<returns>A readable Stream where the file bytes will be read from before
they are compressed, or null to skip inclusion of the file and continue to
the next file.</returns>
</member>
<member name="M:Microsoft.Deployment.Compression.IPackStreamContext.CloseFileReadStream(System.String,System.IO.Stream)">
<summary>
Closes a stream that has been used to read a file.
</summary>
<param name="path">The path of the file within the archive; the same as
the path provided
when the stream was opened.</param>
<param name="stream">A stream that was previously returned by
<see cref="M:Microsoft.Deployment.Compression.IPackStreamContext.OpenFileReadStream(System.String,System.IO.FileAttributes@,System.DateTime@)"/> and is now ready to be closed.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.IPackStreamContext.GetOption(System.String,System.Object[])">
<summary>
Gets extended parameter information specific to the compression
format being used.
</summary>
<param name="optionName">Name of the option being requested.</param>
<param name="parameters">Parameters for the option; for per-file options,
the first parameter is typically the internal file path.</param>
<returns>Option value, or null to use the default behavior.</returns>
<remarks>
This method provides a way to set uncommon options during packaging, or a
way to handle aspects of compression formats not supported by the base library.
<para>For example, this may be used by the zip compression library to
specify different compression methods/levels on a per-file basis.</para>
<para>The available option names, parameters, and expected return values
should be documented by each compression library.</para>
</remarks>
</member>
<member name="T:Microsoft.Deployment.Compression.IUnpackStreamContext">
<summary>
This interface provides the methods necessary for the <see cref="T:Microsoft.Deployment.Compression.CompressionEngine"/> to open
and close streams for archives and files. The implementor of this interface can use any
kind of logic to determine what kind of streams to open and where
</summary>
</member>
<member name="M:Microsoft.Deployment.Compression.IUnpackStreamContext.OpenArchiveReadStream(System.Int32,System.String,Microsoft.Deployment.Compression.CompressionEngine)">
<summary>
Opens the archive stream for reading.
</summary>
<param name="archiveNumber">The zero-based index of the archive to open.</param>
<param name="archiveName">The name of the archive being opened.</param>
<param name="compressionEngine">Instance of the compression engine doing the operations.</param>
<returns>A stream from which archive bytes are read, or null to cancel extraction
of the archive.</returns>
<remarks>
When the first archive in a chain is opened, the name is not yet known, so the
provided value will be an empty string. When opening further archives, the
provided value is the next-archive name stored in the previous archive. This
name is often, but not necessarily, the same as the filename of the archive
package to be opened.
<para>If this method returns null, the archive engine will throw a
FileNotFoundException.</para>
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.IUnpackStreamContext.CloseArchiveReadStream(System.Int32,System.String,System.IO.Stream)">
<summary>
Closes a stream where an archive package was read.
</summary>
<param name="archiveNumber">The archive number of the stream to close.</param>
<param name="archiveName">The name of the archive being closed.</param>
<param name="stream">The stream that was previously returned by
<see cref="M:Microsoft.Deployment.Compression.IUnpackStreamContext.OpenArchiveReadStream(System.Int32,System.String,Microsoft.Deployment.Compression.CompressionEngine)"/> and is now ready to be closed.</param>
</member>
<member name="M:Microsoft.Deployment.Compression.IUnpackStreamContext.OpenFileWriteStream(System.String,System.Int64,System.DateTime)">
<summary>
Opens a stream for writing extracted file bytes.
</summary>
<param name="path">The path of the file within the archive. This is often, but
not necessarily, the same as the relative path of the file outside the archive.</param>
<param name="fileSize">The uncompressed size of the file to be extracted.</param>
<param name="lastWriteTime">The last write time of the file to be extracted.</param>
<returns>A stream where extracted file bytes are to be written, or null to skip
extraction of the file and continue to the next file.</returns>
<remarks>
The implementor may use the path, size and date information to dynamically
decide whether or not the file should be extracted.
</remarks>
</member>
<member name="M:Microsoft.Deployment.Compression.IUnpackStreamContext.CloseFileWriteStream(System.String,System.IO.Stream,System.IO.FileAttributes,System.DateTime)">
<summary>
Closes a stream where an extracted file was written.
</summary>
<param name="path">The path of the file within the archive.</param>