OpenMcdf.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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>OpenMcdf</name>
    </assembly>
    <members>
        <member name="T:OpenMcdf.CFException">
            <summary>
            OpenMCDF base exception.
            </summary>
        </member>
        <member name="T:OpenMcdf.CFDisposedException">
            <summary>
            Raised when a data setter/getter method is invoked
            on a stream or storage object after the disposal of the owner
            compound file object.
            </summary>
        </member>
        <member name="T:OpenMcdf.CFFileFormatException">
            <summary>
            Raised when opening a file with invalid header
            or not supported COM/OLE Structured storage version.
            </summary>
        </member>
        <member name="T:OpenMcdf.CFItemNotFound">
            <summary>
            Raised when a named stream or a storage object
            are not found in a parent storage.
            </summary>
        </member>
        <member name="T:OpenMcdf.CFInvalidOperation">
            <summary>
            Raised when a method call is invalid for the current object state
            </summary>
        </member>
        <member name="T:OpenMcdf.CFDuplicatedItemException">
            <summary>
            Raised when trying to add a duplicated CFItem
            </summary>
            <remarks>
            Items are compared by name as indicated by specs.
            Two items with the same name CANNOT be added within
            the same storage or sub-storage.
            </remarks>
        </member>
        <member name="T:OpenMcdf.CFCorruptedFileException">
            <summary>
            Raised when trying to load a Compound File with invalid, corrupted or mismatched fields (4.1 - specifications)
            </summary>
            <remarks>
            This exception is NOT raised when Compound file has been opened with NO_VALIDATION_EXCEPTION option.
            </remarks>
        </member>
        <member name="T:OpenMcdf.CFItem">
             <summary>
             Abstract base class for Structured Storage entities.
             </summary>
             <example>
             <code>
              
             const String STORAGE_NAME = "report.xls";
             CompoundFile cf = new CompoundFile(STORAGE_NAME);
             
             FileStream output = new FileStream("LogEntries.txt", FileMode.Create);
             TextWriter tw = new StreamWriter(output);
             
             // CFItem represents both storage and stream items
             VisitedEntryAction va = delegate(CFItem item)
             {
                  tw.WriteLine(item.Name);
             };
             
             cf.RootStorage.VisitEntries(va, true);
             
             tw.Close();
              
             </code>
             </example>
        </member>
        <member name="P:OpenMcdf.CFItem.Name">
            <summary>
            Get entity name
            </summary>
        </member>
        <member name="P:OpenMcdf.CFItem.Size">
            <summary>
            Size in bytes of the item. It has a valid value
            only if entity is a stream, otherwise it is setted to zero.
            </summary>
        </member>
        <member name="P:OpenMcdf.CFItem.IsStorage">
            <summary>
            Return true if item is Storage
            </summary>
            <remarks>
            This check doesn't use reflection or runtime type information
            and doesn't suffer related performance penalties.
            </remarks>
        </member>
        <member name="P:OpenMcdf.CFItem.IsStream">
            <summary>
            Return true if item is a Stream
            </summary>
            <remarks>
            This check doesn't use reflection or runtime type information
            and doesn't suffer related performance penalties.
            </remarks>
        </member>
        <member name="P:OpenMcdf.CFItem.IsRoot">
            <summary>
            Return true if item is the Root Storage
            </summary>
            <remarks>
            This check doesn't use reflection or runtime type information
            and doesn't suffer related performance penalties.
            </remarks>
        </member>
        <member name="P:OpenMcdf.CFItem.CreationDate">
            <summary>
            Get/Set the Creation Date of the current item
            </summary>
        </member>
        <member name="P:OpenMcdf.CFItem.ModifyDate">
            <summary>
            Get/Set the Modify Date of the current item
            </summary>
        </member>
        <member name="P:OpenMcdf.CFItem.CLSID">
            <summary>
            Get/Set Object class Guid for Root and Storage entries.
            </summary>
        </member>
        <member name="T:OpenMcdf.VisitedEntryAction">
             <summary>
             Action to apply to visited items in the OLE structured storage
             </summary>
             <param name="item">Currently visited <see cref="T:OpenMcdf.CFItem">item</see></param>
             <example>
             <code>
              
             //We assume that xls file should be a valid OLE compound file
             const String STORAGE_NAME = "report.xls";
             CompoundFile cf = new CompoundFile(STORAGE_NAME);
             
             FileStream output = new FileStream("LogEntries.txt", FileMode.Create);
             TextWriter tw = new StreamWriter(output);
             
             VisitedEntryAction va = delegate(CFItem item)
             {
                 tw.WriteLine(item.Name);
             };
             
             cf.RootStorage.VisitEntries(va, true);
             
             tw.Close();
             
             </code>
             </example>
        </member>
        <member name="T:OpenMcdf.CFStorage">
            <summary>
            Storage entity that acts like a logic container for streams
            or substorages in a compound file.
            </summary>
        </member>
        <member name="M:OpenMcdf.CFStorage.#ctor(OpenMcdf.CompoundFile,OpenMcdf.IDirectoryEntry)">
            <summary>
            Create a CFStorage using an existing directory (previously loaded).
            </summary>
            <param name="compFile">The Storage Owner - CompoundFile</param>
            <param name="dirEntry">An existing Directory Entry</param>
        </member>
        <member name="M:OpenMcdf.CFStorage.AddStream(System.String)">
             <summary>
             Create a new child stream inside the current <see cref="T:OpenMcdf.CFStorage">storage</see>
             </summary>
             <param name="streamName">The new stream name</param>
             <returns>The new <see cref="T:OpenMcdf.CFStream">stream</see> reference</returns>
             <exception cref="T:OpenMcdf.CFDuplicatedItemException">Raised when adding an item with the same name of an existing one</exception>
             <exception cref="T:OpenMcdf.CFDisposedException">Raised when adding a stream to a closed compound file</exception>
             <exception cref="T:OpenMcdf.CFException">Raised when adding a stream with null or empty name</exception>
             <example>
             <code>
              
              String filename = "A_NEW_COMPOUND_FILE_YOU_CAN_WRITE_TO.cfs";
             
              CompoundFile cf = new CompoundFile();
             
              CFStorage st = cf.RootStorage.AddStorage("MyStorage");
              CFStream sm = st.AddStream("MyStream");
              byte[] b = Helpers.GetBuffer(220, 0x0A);
              sm.SetData(b);
             
              cf.Save(filename);
               
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CFStorage.GetStream(System.String)">
             <summary>
             Get a named <see cref="T:OpenMcdf.CFStream">stream</see> contained in the current storage if existing.
             </summary>
             <param name="streamName">Name of the stream to look for</param>
             <returns>A stream reference if existing</returns>
             <exception cref="T:OpenMcdf.CFDisposedException">Raised if trying to delete item from a closed compound file</exception>
             <exception cref="T:OpenMcdf.CFItemNotFound">Raised if item to delete is not found</exception>
             <example>
             <code>
             String filename = "report.xls";
             
             CompoundFile cf = new CompoundFile(filename);
             CFStream foundStream = cf.RootStorage.GetStream("Workbook");
             
             byte[] temp = foundStream.GetData();
             
             Assert.IsNotNull(temp);
             
             cf.Close();
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CFStorage.TryGetStream(System.String)">
             <summary>
             Get a named <see cref="T:OpenMcdf.CFStream">stream</see> contained in the current storage if existing.
             </summary>
             <param name="streamName">Name of the stream to look for</param>
             <returns>A stream reference if found, else null</returns>
             <exception cref="T:OpenMcdf.CFDisposedException">Raised if trying to delete item from a closed compound file</exception>
             <example>
             <code>
             String filename = "report.xls";
             
             CompoundFile cf = new CompoundFile(filename);
             CFStream foundStream = cf.RootStorage.TryGetStream("Workbook");
             
             byte[] temp = foundStream.GetData();
             
             Assert.IsNotNull(temp);
             
             cf.Close();
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CFStorage.GetStorage(System.String)">
             <summary>
             Get a named storage contained in the current one if existing.
             </summary>
             <param name="storageName">Name of the storage to look for</param>
             <returns>A storage reference if existing.</returns>
             <exception cref="T:OpenMcdf.CFDisposedException">Raised if trying to delete item from a closed compound file</exception>
             <exception cref="T:OpenMcdf.CFItemNotFound">Raised if item to delete is not found</exception>
             <example>
             <code>
              
             String FILENAME = "MultipleStorage2.cfs";
             CompoundFile cf = new CompoundFile(FILENAME, UpdateMode.ReadOnly, false, false);
             
             CFStorage st = cf.RootStorage.GetStorage("MyStorage");
             
             Assert.IsNotNull(st);
             cf.Close();
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CFStorage.TryGetStorage(System.String)">
             <summary>
             Get a named storage contained in the current one if existing.
             </summary>
             <param name="storageName">Name of the storage to look for</param>
             <returns>A storage reference if found else null</returns>
             <exception cref="T:OpenMcdf.CFDisposedException">Raised if trying to delete item from a closed compound file</exception>
             <example>
             <code>
              
             String FILENAME = "MultipleStorage2.cfs";
             CompoundFile cf = new CompoundFile(FILENAME, UpdateMode.ReadOnly, false, false);
             
             CFStorage st = cf.RootStorage.TryGetStorage("MyStorage");
             
             Assert.IsNotNull(st);
             cf.Close();
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CFStorage.AddStorage(System.String)">
             <summary>
             Create new child storage directory inside the current storage.
             </summary>
             <param name="storageName">The new storage name</param>
             <returns>Reference to the new <see cref="T:OpenMcdf.CFStorage">storage</see></returns>
             <exception cref="T:OpenMcdf.CFDuplicatedItemException">Raised when adding an item with the same name of an existing one</exception>
             <exception cref="T:OpenMcdf.CFDisposedException">Raised when adding a storage to a closed compound file</exception>
             <exception cref="T:OpenMcdf.CFException">Raised when adding a storage with null or empty name</exception>
             <example>
             <code>
              
              String filename = "A_NEW_COMPOUND_FILE_YOU_CAN_WRITE_TO.cfs";
             
              CompoundFile cf = new CompoundFile();
             
              CFStorage st = cf.RootStorage.AddStorage("MyStorage");
              CFStream sm = st.AddStream("MyStream");
              byte[] b = Helpers.GetBuffer(220, 0x0A);
              sm.SetData(b);
             
              cf.Save(filename);
               
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CFStorage.VisitEntries(System.Action{OpenMcdf.CFItem},System.Boolean)">
             <summary>
             Visit all entities contained in the storage applying a user provided action
             </summary>
             <exception cref="T:OpenMcdf.CFDisposedException">Raised when visiting items of a closed compound file</exception>
             <param name="action">User <see cref="T:OpenMcdf.VisitedEntryAction">action</see> to apply to visited entities</param>
             <param name="recursive"> Visiting recursion level. True means substorages are visited recursively, false indicates that only the direct children of this storage are visited</param>
             <example>
             <code>
             const String STORAGE_NAME = "report.xls";
             CompoundFile cf = new CompoundFile(STORAGE_NAME);
             
             FileStream output = new FileStream("LogEntries.txt", FileMode.Create);
             TextWriter tw = new StreamWriter(output);
             
             VisitedEntryAction va = delegate(CFItem item)
             {
                 tw.WriteLine(item.Name);
             };
             
             cf.RootStorage.VisitEntries(va, true);
             
             tw.Close();
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CFStorage.Delete(System.String)">
            <summary>
            Remove an entry from the current storage and compound file.
            </summary>
            <param name="entryName">The name of the entry in the current storage to delete</param>
            <example>
            <code>
            cf = new CompoundFile("A_FILE_YOU_CAN_CHANGE.cfs", UpdateMode.Update, true, false);
            cf.RootStorage.Delete("AStream"); // AStream item is assumed to exist.
            cf.Commit(true);
            cf.Close();
            </code>
            </example>
            <exception cref="T:OpenMcdf.CFDisposedException">Raised if trying to delete item from a closed compound file</exception>
            <exception cref="T:OpenMcdf.CFItemNotFound">Raised if item to delete is not found</exception>
            <exception cref="T:OpenMcdf.CFException">Raised if trying to delete root storage</exception>
        </member>
        <member name="M:OpenMcdf.DirectoryEntry.fnv_hash(System.Byte[])">
            <summary>
            FNV hash, short for Fowler/Noll/Vo
            </summary>
            <param name="buffer"></param>
            <returns>(not warranted) unique hash for byte array</returns>
        </member>
        <member name="P:OpenMcdf.Header.FirstMiniFATSectorID">
            <summary>
            This integer field contains the starting sector number for the mini FAT
            </summary>
        </member>
        <member name="F:OpenMcdf.Header.OLE_CFS_SIGNATURE">
            <summary>
            Structured Storage signature
            </summary>
        </member>
        <member name="T:OpenMcdf.CFStream">
            <summary>
            OLE structured storage <see cref="T:OpenMcdf.CFStream">stream</see> Object
            It is contained inside a Storage object in a file-directory
            relationship and indexed by its name.
            </summary>
        </member>
        <member name="M:OpenMcdf.CFStream.SetData(System.Byte[])">
            <summary>
            Set the data associated with the stream object.
            </summary>
            <example>
            <code>
               byte[] b = new byte[]{0x0,0x1,0x2,0x3};
               CompoundFile cf = new CompoundFile();
               CFStream myStream = cf.RootStorage.AddStream("MyStream");
               myStream.SetData(b);
            </code>
            </example>
            <param name="data">Data bytes to write to this stream</param>
            <remarks>Existing associated data will be lost after method invocation</remarks>
        </member>
        <member name="M:OpenMcdf.CFStream.Write(System.Byte[],System.Int64)">
            <summary>
            Write a data buffer to a specific position into current CFStream object
            </summary>
            <param name="data">Data buffer to Write</param>
            <param name="position">Position into the stream object to start writing from</param>
            <remarks>Current stream will be extended to receive data buffer over
            its current size</remarks>
        </member>
        <member name="M:OpenMcdf.CFStream.Write(System.Byte[],System.Int64,System.Int32,System.Int32)">
            <summary>
            Write <paramref name="count">count</paramref> bytes of a data buffer to a specific position into
            the current CFStream object starting from the specified position.
            </summary>
            <param name="data">Data buffer to copy bytes from</param>
            <param name="position">Position into the stream object to start writing from</param>
            <param name="offset">The zero-based byte offset in buffer at which to
            begin copying bytes to the current <see cref="T:OpenMcdf.CFStream">CFStream</see>. </param>
            <param name="count">The number of bytes to be written to the current <see cref="T:OpenMcdf.CFStream">CFStream</see> </param>
            <remarks>Current stream will be extended to receive data buffer over
            its current size.</remarks>
        </member>
        <member name="M:OpenMcdf.CFStream.Append(System.Byte[])">
            <summary>
            Append the provided data to stream data.
            </summary>
            <example>
            <code>
               byte[] b = new byte[]{0x0,0x1,0x2,0x3};
               byte[] b2 = new byte[]{0x4,0x5,0x6,0x7};
               CompoundFile cf = new CompoundFile();
               CFStream myStream = cf.RootStorage.AddStream("MyStream");
               myStream.SetData(b); // here we could also have invoked .AppendData
               myStream.AppendData(b2);
               cf.Save("MyLargeStreamsFile.cfs);
               cf.Close();
            </code>
            </example>
            <param name="data">Data bytes to append to this stream</param>
            <remarks>
            This method allows user to create stream with more than 2GB of data,
            appending data to the end of existing ones.
            Large streams (>2GB) are only supported by CFS version 4.
            Append data can also be invoked on streams with no data in order
            to simplify its use inside loops.
            </remarks>
        </member>
        <member name="M:OpenMcdf.CFStream.GetData">
            <summary>
            Get all the data associated with the stream object.
            </summary>
            <example>
            <code>
                CompoundFile cf2 = new CompoundFile("AFileName.cfs");
                CFStream st = cf2.RootStorage.GetStream("MyStream");
                byte[] buffer = st.ReadAll();
            </code>
            </example>
            <returns>Array of byte containing stream data</returns>
            <exception cref="T:OpenMcdf.CFDisposedException">
            Raised when the owner compound file has been closed.
            </exception>
        </member>
        <!-- Commento XML in formato non corretto ignorato per il membro 'M:OpenMcdf.CFStream.Read(System.Byte[],System.Int64,System.Int32)' -->
        <!-- Commento XML in formato non corretto ignorato per il membro 'M:OpenMcdf.CFStream.Read(System.Byte[],System.Int64,System.Int32,System.Int32)' -->
        <member name="M:OpenMcdf.CFStream.CopyFrom(System.IO.Stream)">
            <summary>
            Copy data from an existing stream.
            </summary>
            <param name="input">A stream to read from</param>
            <remarks>
            Input stream will NOT be closed after method invocation.
            Existing associated data will be deleted.
            </remarks>
        </member>
        <member name="M:OpenMcdf.CFStream.Resize(System.Int64)">
            <summary>
            Resize stream padding with zero if enlarging, trimming data if reducing size.
            </summary>
            <param name="length">New length to assign to this stream</param>
        </member>
        <member name="T:OpenMcdf.Ver3SizeLimitReached">
            <summary>
            Action to implement when transaction support - sector
            has to be written to the underlying stream (see specs).
            </summary>
        </member>
        <member name="T:OpenMcdf.SectorCollection">
            <summary>
            Ad-hoc Heap Friendly sector collection to avoid using
            large array that may create some problem to GC collection
            (see http://www.simple-talk.com/dotnet/.net-framework/the-dangers-of-the-large-object-heap/ )
            </summary>
        </member>
        <member name="T:OpenMcdf.CFSConfiguration">
            <summary>
            Configuration parameters for the compund files.
            They can be OR-combined to configure
            <see cref="T:OpenMcdf.CompoundFile">Compound file</see> behaviour.
            All flags are NOT set by Default.
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSConfiguration.Default">
            <summary>
            Sector Recycling turn off,
            free sectors erasing off,
            format validation exception raised
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSConfiguration.SectorRecycle">
            <summary>
            Sector recycling reduces data writing performances
            but avoids space wasting in scenarios with frequently
            data manipulation of the same streams.
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSConfiguration.EraseFreeSectors">
            <summary>
            Free sectors are erased to avoid information leakage
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSConfiguration.NoValidationException">
            <summary>
            No exception is raised when a validation error occurs.
            This can possibly lead to a security issue but gives
            a chance to corrupted files to load.
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSConfiguration.LeaveOpen">
            <summary>
            If this flag is set true,
            backing stream is kept open after CompoundFile disposal
            </summary>
        </member>
        <member name="T:OpenMcdf.CFSVersion">
            <summary>
            Binary File Format Version. Sector size is 512 byte for version 3,
            4096 for version 4
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSVersion.Ver_3">
            <summary>
            Compound file version 3 - The default and most common version available. Sector size 512 bytes, 2GB max file size.
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSVersion.Ver_4">
            <summary>
            Compound file version 4 - Sector size is 4096 bytes. Using this version could bring some compatibility problem with existing applications.
            </summary>
        </member>
        <member name="T:OpenMcdf.CFSUpdateMode">
            <summary>
            Update mode of the compound file.
            Default is ReadOnly.
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSUpdateMode.ReadOnly">
            <summary>
            ReadOnly update mode prevents overwriting
            of the opened file.
            Data changes are allowed but they have to be
            persisted on a different file when required
            using <see cref="M:OpenMcdf.CompoundFile.Save">method</see>
            </summary>
        </member>
        <member name="F:OpenMcdf.CFSUpdateMode.Update">
            <summary>
            Update mode allows subsequent data changing operations
            to be persisted directly on the opened file or stream
            using the <see cref="M:OpenMcdf.CompoundFile.Commit">Commit</see>
            method when required. Warning: this option may cause existing data loss if misused.
            </summary>
        </member>
        <member name="T:OpenMcdf.CompoundFile">
            <summary>
            Standard Microsoft&#169; Compound File implementation.
            It is also known as OLE/COM structured storage
            and contains a hierarchy of storage and stream objects providing
            efficent storage of multiple kinds of documents in a single file.
            Version 3 and 4 of specifications are supported.
            </summary>
        </member>
        <member name="P:OpenMcdf.CompoundFile.Configuration">
            <summary>
            Get the configuration parameters of the CompoundFile object.
            </summary>
        </member>
        <member name="M:OpenMcdf.CompoundFile.GetSectorSize">
            <summary>
            Returns the size of standard sectors switching on CFS version (3 or 4)
            </summary>
            <returns>Standard sector size</returns>
        </member>
        <member name="F:OpenMcdf.CompoundFile.HEADER_DIFAT_ENTRIES_COUNT">
            <summary>
            Number of DIFAT entries in the header
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.DIFAT_SECTOR_FAT_ENTRIES_COUNT">
            <summary>
            Number of FAT entries in a DIFAT Sector
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.FAT_SECTOR_ENTRIES_COUNT">
            <summary>
            Sectors ID entries in a FAT Sector
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.SIZE_OF_SID">
            <summary>
            Sector ID Size (int)
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.sectorRecycle">
            <summary>
            Flag for sector recycling.
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.eraseFreeSectors">
            <summary>
            Flag for unallocated sector zeroing out.
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.FLUSHING_QUEUE_SIZE">
            <summary>
            Initial capacity of the flushing queue used
            to optimize commit writing operations
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.FLUSHING_BUFFER_MAX_SIZE">
            <summary>
            Maximum size of the flushing buffer used
            to optimize commit writing operations
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.header">
            <summary>
            CompoundFile header
            </summary>
        </member>
        <member name="F:OpenMcdf.CompoundFile.sourceStream">
            <summary>
            Compound underlying stream. Null when new CF has been created.
            </summary>
        </member>
        <member name="M:OpenMcdf.CompoundFile.#ctor">
             <summary>
             Create a blank, version 3 compound file.
             Sector recycle is turned off to achieve the best reading/writing
             performance in most common scenarios.
             </summary>
             <example>
             <code>
              
                 byte[] b = new byte[10000];
                 for (int i = 0; i &lt; 10000; i++)
                 {
                     b[i % 120] = (byte)i;
                 }
             
                 CompoundFile cf = new CompoundFile();
                 CFStream myStream = cf.RootStorage.AddStream("MyStream");
             
                 Assert.IsNotNull(myStream);
                 myStream.SetData(b);
                 cf.Save("MyCompoundFile.cfs");
                 cf.Close();
                  
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CompoundFile.#ctor(OpenMcdf.CFSVersion,OpenMcdf.CFSConfiguration)">
             <summary>
             Create a new, blank, compound file.
             </summary>
             <param name="cfsVersion">Use a specific Compound File Version to set 512 or 4096 bytes sectors</param>
             <param name="configFlags">Set <see cref="T:OpenMcdf.CFSConfiguration">configuration</see> parameters for the new compound file</param>
             <example>
             <code>
              
                 byte[] b = new byte[10000];
                 for (int i = 0; i &lt; 10000; i++)
                 {
                     b[i % 120] = (byte)i;
                 }
             
                 CompoundFile cf = new CompoundFile(CFSVersion.Ver_4, CFSConfiguration.Default);
                 CFStream myStream = cf.RootStorage.AddStream("MyStream");
             
                 Assert.IsNotNull(myStream);
                 myStream.SetData(b);
                 cf.Save("MyCompoundFile.cfs");
                 cf.Close();
                  
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CompoundFile.#ctor(System.String)">
             <summary>
             Load an existing compound file.
             </summary>
             <param name="fileName">Compound file to read from</param>
             <example>
             <code>
             //A xls file should have a Workbook stream
             String filename = "report.xls";
             
             CompoundFile cf = new CompoundFile(filename);
             CFStream foundStream = cf.RootStorage.GetStream("Workbook");
             
             byte[] temp = foundStream.GetData();
             
             Assert.IsNotNull(temp);
             
             cf.Close();
             </code>
             </example>
             <remarks>
             File will be open in read-only mode: it has to be saved
             with a different filename. A wrapping implementation has to be provided
             in order to remove/substitute an existing file. Version will be
             automatically recognized from the file. Sector recycle is turned off
             to achieve the best reading/writing performance in most common scenarios.
             </remarks>
        </member>
        <member name="M:OpenMcdf.CompoundFile.#ctor(System.String,OpenMcdf.CFSUpdateMode,OpenMcdf.CFSConfiguration)">
             <summary>
             Load an existing compound file.
             </summary>
             <param name="fileName">Compound file to read from</param>
             <param name="sectorRecycle">If true, recycle unused sectors</param>
             <param name="updateMode">Select the update mode of the underlying data file</param>
             <param name="eraseFreeSectors">If true, overwrite with zeros unallocated sectors</param>
             <example>
             <code>
             String srcFilename = "data_YOU_CAN_CHANGE.xls";
              
             CompoundFile cf = new CompoundFile(srcFilename, UpdateMode.Update, true, true);
             
             Random r = new Random();
             
             byte[] buffer = GetBuffer(r.Next(3, 4095), 0x0A);
             
             cf.RootStorage.AddStream("MyStream").SetData(buffer);
              
             //This will persist data to the underlying media.
             cf.Commit();
             cf.Close();
             
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CompoundFile.#ctor(System.IO.Stream,OpenMcdf.CFSUpdateMode,OpenMcdf.CFSConfiguration)">
             <summary>
             Load an existing compound file.
             </summary>
             <param name="stream">A stream containing a compound file to read</param>
             <param name="sectorRecycle">If true, recycle unused sectors</param>
             <param name="updateMode">Select the update mode of the underlying data file</param>
             <param name="eraseFreeSectors">If true, overwrite with zeros unallocated sectors</param>
             <example>
             <code>
              
             String filename = "reportREAD.xls";
                
             FileStream fs = new FileStream(filename, FileMode.Open);
             CompoundFile cf = new CompoundFile(fs, UpdateMode.ReadOnly, false, false);
             CFStream foundStream = cf.RootStorage.GetStream("Workbook");
             
             byte[] temp = foundStream.GetData();
             
             Assert.IsNotNull(temp);
             
             cf.Close();
             
             </code>
             </example>
             <exception cref="T:OpenMcdf.CFException">Raised when trying to open a non-seekable stream</exception>
             <exception cref="T:OpenMcdf.CFException">Raised stream is null</exception>
        </member>
        <member name="M:OpenMcdf.CompoundFile.#ctor(System.IO.Stream)">
             <summary>
             Load an existing compound file from a stream.
             </summary>
             <param name="stream">Streamed compound file</param>
             <example>
             <code>
              
             String filename = "reportREAD.xls";
                
             FileStream fs = new FileStream(filename, FileMode.Open);
             CompoundFile cf = new CompoundFile(fs);
             CFStream foundStream = cf.RootStorage.GetStream("Workbook");
             
             byte[] temp = foundStream.GetData();
             
             Assert.IsNotNull(temp);
             
             cf.Close();
             
             </code>
             </example>
             <exception cref="T:OpenMcdf.CFException">Raised when trying to open a non-seekable stream</exception>
             <exception cref="T:OpenMcdf.CFException">Raised stream is null</exception>
        </member>
        <member name="M:OpenMcdf.CompoundFile.Commit">
            <summary>
            Commit data changes since the previously commit operation
            to the underlying supporting stream or file on the disk.
            </summary>
            <remarks>
            This method can be used
            only if the supporting stream has been opened in
            <see cref="T:OpenMcdf.UpdateMode">Update mode</see>.
            </remarks>
        </member>
        <member name="M:OpenMcdf.CompoundFile.Commit(System.Boolean)">
            <summary>
            Commit data changes since the previously commit operation
            to the underlying supporting stream or file on the disk.
            </summary>
            <param name="releaseMemory">If true, release loaded sectors to limit memory usage but reduces following read operations performance</param>
            <remarks>
            This method can be used only if
            the supporting stream has been opened in
            <see cref="T:OpenMcdf.UpdateMode">Update mode</see>.
            </remarks>
        </member>
        <member name="M:OpenMcdf.CompoundFile.Load(System.IO.Stream)">
            <summary>
            Load compound file from an existing stream.
            </summary>
            <param name="stream">Stream to load compound file from</param>
        </member>
        <member name="P:OpenMcdf.CompoundFile.HasSourceStream">
            <summary>
            Return true if this compound file has been
            loaded from an existing file or stream
            </summary>
        </member>
        <member name="M:OpenMcdf.CompoundFile.AllocateMiniSectorChain(System.Collections.Generic.List{OpenMcdf.Sector})">
            <summary>
            Allocate space, setup sectors id and refresh header
            for the new or updated mini sector chain.
            </summary>
            <param name="sectorChain">The new MINI sector chain</param>
        </member>
        <member name="M:OpenMcdf.CompoundFile.SetSectorChain(System.Collections.Generic.List{OpenMcdf.Sector})">
            <summary>
            Allocate space, setup sectors id in the FAT and refresh header
            for the new or updated sector chain (Normal or Mini sectors)
            </summary>
            <param name="sectorChain">The new or updated normal or mini sector chain</param>
        </member>
        <member name="M:OpenMcdf.CompoundFile.AllocateSectorChain(System.Collections.Generic.List{OpenMcdf.Sector})">
            <summary>
            Allocate space, setup sectors id and refresh header
            for the new or updated sector chain.
            </summary>
            <param name="sectorChain">The new or updated generic sector chain</param>
        </member>
        <member name="M:OpenMcdf.CompoundFile.CheckForLockSector">
            <summary>
            Check for transaction lock sector addition and mark it in the FAT.
            </summary>
        </member>
        <member name="M:OpenMcdf.CompoundFile.AllocateFATSectorChain(System.Collections.Generic.List{OpenMcdf.Sector})">
            <summary>
            Allocate space, setup sectors id and refresh header
            for the new or updated FAT sector chain.
            </summary>
            <param name="sectorChain">The new or updated generic sector chain</param>
        </member>
        <member name="M:OpenMcdf.CompoundFile.AllocateDIFATSectorChain(System.Collections.Generic.List{OpenMcdf.Sector})">
            <summary>
            Setup the DIFAT sector chain
            </summary>
            <param name="FATsectorChain">A FAT sector chain</param>
        </member>
        <member name="M:OpenMcdf.CompoundFile.GetDifatSectorChain">
            <summary>
            Get the DIFAT Sector chain
            </summary>
            <returns>A list of DIFAT sectors</returns>
        </member>
        <member name="M:OpenMcdf.CompoundFile.GetFatSectorChain">
            <summary>
            Get the FAT sector chain
            </summary>
            <returns>List of FAT sectors</returns>
        </member>
        <member name="M:OpenMcdf.CompoundFile.GetNormalSectorChain(System.Int32)">
            <summary>
            Get a standard sector chain
            </summary>
            <param name="secID">First SecID of the required chain</param>
            <returns>A list of sectors</returns>
        </member>
        <member name="M:OpenMcdf.CompoundFile.GetMiniSectorChain(System.Int32)">
            <summary>
            Get a mini sector chain
            </summary>
            <param name="secID">First SecID of the required chain</param>
            <returns>A list of mini sectors (64 bytes)</returns>
        </member>
        <member name="M:OpenMcdf.CompoundFile.GetSectorChain(System.Int32,OpenMcdf.SectorType)">
            <summary>
            Get a sector chain from a compound file given the first sector ID
            and the required sector type.
            </summary>
            <param name="secID">First chain sector's id </param>
            <param name="chainType">Type of Sectors in the required chain (mini sectors, normal sectors or FAT)</param>
            <returns>A list of Sectors as the result of their concatenation</returns>
        </member>
        <member name="P:OpenMcdf.CompoundFile.RootStorage">
             <summary>
             The entry point object that represents the
             root of the structures tree to get or set storage or
             stream data.
             </summary>
             <example>
             <code>
              
                //Create a compound file
                string FILENAME = "MyFileName.cfs";
                CompoundFile ncf = new CompoundFile();
             
                CFStorage l1 = ncf.RootStorage.AddStorage("Storage Level 1");
             
                l1.AddStream("l1ns1");
                l1.AddStream("l1ns2");
                l1.AddStream("l1ns3");
                CFStorage l2 = l1.AddStorage("Storage Level 2");
                l2.AddStream("l2ns1");
                l2.AddStream("l2ns2");
             
                ncf.Save(FILENAME);
                ncf.Close();
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CompoundFile.ResetDirectoryEntry(System.Int32)">
            <summary>
            Reset a directory entry setting it to StgInvalid in the Directory.
            </summary>
            <param name="sid">Sid of the directory to invalidate</param>
        </member>
        <member name="M:OpenMcdf.CompoundFile.LoadDirectories">
            <summary>
            Load directory entries from compound file. Header and FAT MUST be already loaded.
            </summary>
        </member>
        <member name="M:OpenMcdf.CompoundFile.CommitDirectory">
            <summary>
             Commit directory entries change on the Current Source stream
            </summary>
        </member>
        <member name="M:OpenMcdf.CompoundFile.Save(System.String)">
            <summary>
            Saves the in-memory image of Compound File to a file.
            </summary>
            <param name="fileName">File name to write the compound file to</param>
            <exception cref="T:OpenMcdf.CFException">Raised if destination file is not seekable</exception>
        </member>
        <member name="M:OpenMcdf.CompoundFile.Save(System.IO.Stream)">
             <summary>
             Saves the in-memory image of Compound File to a stream.
             </summary>
             <remarks>
             Destination Stream must be seekable. Uncommitted data will be persisted to the destination stream.
             </remarks>
             <param name="stream">The stream to save compound File to</param>
             <exception cref="T:OpenMcdf.CFException">Raised if destination stream is not seekable</exception>
             <exception cref="T:OpenMcdf.CFDisposedException">Raised if Compound File Storage has been already disposed</exception>
             <example>
             <code>
                MemoryStream ms = new MemoryStream(size);
             
                CompoundFile cf = new CompoundFile();
                CFStorage st = cf.RootStorage.AddStorage("MyStorage");
                CFStream sm = st.AddStream("MyStream");
             
                byte[] b = new byte[]{0x00,0x01,0x02,0x03};
             
                sm.SetData(b);
                cf.Save(ms);
                cf.Close();
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CompoundFile.FindFreeSectors(OpenMcdf.SectorType)">
            <summary>
            Scan FAT o miniFAT for free sectors to reuse.
            </summary>
            <param name="sType">Type of sector to look for</param>
            <returns>A Queue of available sectors or minisectors already allocated</returns>
        </member>
        <!-- Commento XML in formato non corretto ignorato per il membro 'M:OpenMcdf.CompoundFile.AppendData(OpenMcdf.CFItem,System.Byte[])' -->
        <member name="M:OpenMcdf.CompoundFile.SetStreamLength(OpenMcdf.CFItem,System.Int64)">
            <summary>
            Resize stream length
            </summary>
            <param name="cfItem"></param>
            <param name="length"></param>
        </member>
        <member name="M:OpenMcdf.CompoundFile.CheckFileLength">
            <summary>
            Check file size limit ( 2GB for version 3 )
            </summary>
        </member>
        <member name="M:OpenMcdf.CompoundFile.Close">
             <summary>
             Close the Compound File object <see cref="T:OpenMcdf.CompoundFile">CompoundFile</see> and
             free all associated resources (e.g. open file handle and allocated memory).
             <remarks>
             When the <see cref="T:OpenMcdf.CompoundFile.Close()">Close</see> method is called,
             all the associated stream and storage objects are invalidated:
             any operation invoked on them will produce a <see cref="T:OpenMcdf.CFDisposedException">CFDisposedException</see>.
             </remarks>
             </summary>
             <example>
             <code>
                const String FILENAME = "CompoundFile.cfs";
                CompoundFile cf = new CompoundFile(FILENAME);
             
                CFStorage st = cf.RootStorage.GetStorage("MyStorage");
                cf.Close();
             
                try
                {
                    byte[] temp = st.GetStream("MyStream").GetData();
                     
                    // The following line will fail because back-end object has been closed
                    Assert.Fail("Stream without media");
                }
                catch (Exception ex)
                {
                    Assert.IsTrue(ex is CFDisposedException);
                }
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CompoundFile.Dispose(System.Boolean)">
            <summary>
            When called from user code, release all resources, otherwise, in the case runtime called it,
            only unmanagd resources are released.
            </summary>
            <param name="disposing">If true, method has been called from User code, if false it's been called from .net runtime</param>
        </member>
        <member name="M:OpenMcdf.CompoundFile.GetAllNamedEntries(System.String)">
            <summary>
            Get a list of all entries with a given name contained in the document.
            </summary>
            <param name="entryName">Name of entries to retrive</param>
            <returns>A list of name-matching entries</returns>
            <remarks>This function is aimed to speed up entity lookup in
            flat-structure files (only one or little more known entries)
            without the performance penalty related to entities hierarchy constraints.
            There is no implied hierarchy in the returned list.
            </remarks>
        </member>
        <member name="M:OpenMcdf.CompoundFile.ShrinkCompoundFile(System.IO.Stream)">
             <summary>
             Compress free space by removing unallocated sectors from compound file
             effectively reducing stream or file size.
             </summary>
             <remarks>
             Current implementation supports compression only for ver. 3 compound files.
             </remarks>
             <example>
             <code>
              
              //This code has been extracted from unit test
               
                String FILENAME = "MultipleStorage3.cfs";
             
                FileInfo srcFile = new FileInfo(FILENAME);
             
                File.Copy(FILENAME, "MultipleStorage_Deleted_Compress.cfs", true);
             
                CompoundFile cf = new CompoundFile("MultipleStorage_Deleted_Compress.cfs", UpdateMode.Update, true, true);
             
                CFStorage st = cf.RootStorage.GetStorage("MyStorage");
                st = st.GetStorage("AnotherStorage");
                 
                Assert.IsNotNull(st);
                st.Delete("Another2Stream"); //17Kb
                cf.Commit();
                cf.Close();
             
                CompoundFile.ShrinkCompoundFile("MultipleStorage_Deleted_Compress.cfs");
             
                FileInfo dstFile = new FileInfo("MultipleStorage_Deleted_Compress.cfs");
             
                Assert.IsTrue(srcFile.Length > dstFile.Length);
             
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CompoundFile.ShrinkCompoundFile(System.String)">
             <summary>
             Remove unallocated sectors from compound file in order to reduce its size.
             </summary>
             <remarks>
             Current implementation supports compression only for ver. 3 compound files.
             </remarks>
             <example>
             <code>
              
              //This code has been extracted from unit test
               
                String FILENAME = "MultipleStorage3.cfs";
             
                FileInfo srcFile = new FileInfo(FILENAME);
             
                File.Copy(FILENAME, "MultipleStorage_Deleted_Compress.cfs", true);
             
                CompoundFile cf = new CompoundFile("MultipleStorage_Deleted_Compress.cfs", UpdateMode.Update, true, true);
             
                CFStorage st = cf.RootStorage.GetStorage("MyStorage");
                st = st.GetStorage("AnotherStorage");
                 
                Assert.IsNotNull(st);
                st.Delete("Another2Stream"); //17Kb
                cf.Commit();
                cf.Close();
             
                CompoundFile.ShrinkCompoundFile("MultipleStorage_Deleted_Compress.cfs");
             
                FileInfo dstFile = new FileInfo("MultipleStorage_Deleted_Compress.cfs");
             
                Assert.IsTrue(srcFile.Length > dstFile.Length);
             
             </code>
             </example>
        </member>
        <member name="M:OpenMcdf.CompoundFile.DoCompression(OpenMcdf.CFStorage,OpenMcdf.CFStorage)">
            <summary>
            Recursively clones valid structures, avoiding to copy free sectors.
            </summary>
            <param name="currSrcStorage">Current source storage to clone</param>
            <param name="currDstStorage">Current cloned destination storage</param>
        </member>
        <member name="M:OpenMcdf.Sector.Dispose(System.Boolean)">
            <summary>
            When called from user code, release all resources, otherwise, in the case runtime called it,
            only unmanagd resources are released.
            </summary>
            <param name="disposing">If true, method has been called from User code, if false it's been called from .net runtime</param>
        </member>
        <member name="T:OpenMcdf.StreamView">
            <summary>
            Stream decorator for a Sector or miniSector chain
            </summary>
        </member>
        <member name="T:RedBlackTree.IRBNode">
            <summary>
            Red Black Node interface
            </summary>
        </member>
    </members>
</doc>