~ubuntu-branches/ubuntu/wily/openmcdf/wily

        <member name="M:OpenMcdf.CompoundFile.#ctor(System.String,OpenMcdf.UpdateMode,System.Boolean,System.Boolean,System.Boolean)">

             <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>

             <param name="noValidationException">If true, no <see cref="T:OpenMcdf.CFCorruptedFileException">CFCorruptedFileException</see>

              will be thrown even if corrupted file is loaded. Please note that this option is could pose a potential security threat</param>

             <example>

             <code>

             String srcFilename = "data_YOU_CAN_CHANGE.xls";

             

             CompoundFile cf = new CompoundFile(srcFilename, UpdateMode.Update, true, 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.UpdateMode,System.Boolean,System.Boolean,System.Boolean)">

             <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>

             <param name="noValidationException">If true, openMcdf will try to ignore invalid references or format in order to load a possibly corrupted file anyway </param>

             <remarks>The 'noValidationEcxception' parameter could possibly lead to security issues so it's recommanded to use it only on trusted sources</remarks>

             <example>

             <code>

             

             String filename = "reportREAD.xls";

               

             FileStream fs = new FileStream(filename, FileMode.Open);

             CompoundFile cf = new CompoundFile(fs, UpdateMode.ReadOnly, false, false, false, true);

             CFStream foundStream = cf.RootStorage.GetStream("Workbook");

            

             byte[] temp = foundStream.GetData(); //if 'reportRead.xls' is corrupted, openMcdf will try to lad it anyway [noValidationException set true]

            

             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.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="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>