//---------------------------------------------------------------------
// <copyright file="CabInfo.cs" company="Microsoft">
// Copyright (c) Microsoft Corporation. All rights reserved.
//
// The use and distribution terms for this software are covered by the
// Common Public License 1.0 (http://opensource.org/licenses/cpl.php)
// which can be found in the file CPL.TXT at the root of this distribution.
// By using this software in any fashion, you are agreeing to be bound by
// the terms of this license.
//
// You must not remove this notice, or any other, from this software.
// </copyright>
// <summary>
// Part of the Deployment Tools Foundation project.
// </summary>
//---------------------------------------------------------------------
namespace Microsoft.Deployment.Compression.Cab{
using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
/// <summary>
/// Object representing a cabinet file on disk; provides access to
/// file-based operations on the cabinet file.
/// </summary>
/// <remarks>
/// Generally, the methods on this class are much easier to use than the
/// stream-based interfaces provided by the <see cref="CabEngine"/> class.
/// </remarks>
[Serializable]
public class CabInfo : ArchiveInfo
{
/// <summary>
/// Creates a new CabinetInfo object representing a cabinet file in a specified path.
/// </summary>
/// <param name="path">The path to the cabinet file. When creating a cabinet file, this file does not
/// necessarily exist yet.</param>
public CabInfo(string path)
: base(path)
{
}
/// <summary>
/// Initializes a new instance of the CabinetInfo 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>
protected CabInfo(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
/// <summary>
/// Creates a compression engine that does the low-level work for
/// this object.
/// </summary>
/// <returns>A new <see cref="CabEngine"/> instance.</returns>
/// <remarks>
/// Each instance will be <see cref="CompressionEngine.Dispose()"/>d
/// immediately after use.
/// </remarks>
protected override CompressionEngine CreateCompressionEngine()
{
return new CabEngine();
}
/// <summary>
/// Gets information about the files contained in the archive.
/// </summary>
/// <returns>A list of <see cref="CabFileInfo"/> objects, each
/// containing information about a file in the archive.</returns>
public new IList<CabFileInfo> GetFiles()
{
IList<ArchiveFileInfo> files = base.GetFiles();
List<CabFileInfo> cabFiles = new List<CabFileInfo>(files.Count);
foreach (CabFileInfo cabFile in files) cabFiles.Add(cabFile);
return cabFiles.AsReadOnly();
}
/// <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="CabFileInfo"/> objects, each containing
/// information about a file in the archive.</returns>
public new IList<CabFileInfo> GetFiles(string searchPattern)
{
IList<ArchiveFileInfo> files = base.GetFiles(searchPattern);
List<CabFileInfo> cabFiles = new List<CabFileInfo>(files.Count);
foreach (CabFileInfo cabFile in files) cabFiles.Add(cabFile);
return cabFiles.AsReadOnly();
}
}
}
|