154 lines
5.7 KiB
C#
Raw Normal View History

///------------------------------------------------------------------------------
/// <copyright file="ZLibException.cs" company="Microsoft">
/// Copyright (c) Microsoft Corporation. All rights reserved.
/// </copyright>
///
/// <owner>gpaperin</owner>
///------------------------------------------------------------------------------
using System.Runtime.Serialization;
using System.Security;
using System.Security.Permissions;
using ZErrorCode = System.IO.Compression.ZLibNative.ErrorCode;
namespace System.IO.Compression {
/// <summary>
/// This is the exception that is thrown when a ZLib returns an error code inticating an unrecovarable error.
/// </summary>
#if SILVERLIGHT
internal class ZLibException : IOException {
#else
[Serializable]
internal class ZLibException : IOException, ISerializable {
#endif
private string zlibErrorContext = null;
private string zlibErrorMessage = null;
private ZErrorCode zlibErrorCode = ZErrorCode.Ok;
/// <summary>
/// This is the preferred constructor to use.
/// The other constructors are provided for compliance to Fx design guidelines.
/// </summary>
/// <param name="message">A (localised) human readable error description.</param>
/// <param name="zlibErrorContext">A description of the context within zlib where the error occured (e.g. the function name).</param>
/// <param name="zlibErrorCode">The error code returned by a ZLib function that casued this exception.</param>
/// <param name="zlibErrorMessage">The string provided by ZLib as error information (unloicalised).</param>
public ZLibException(string message, string zlibErrorContext, int zlibErrorCode, string zlibErrorMessage) :
base(message) {
Init(zlibErrorContext, (ZErrorCode) zlibErrorCode, zlibErrorMessage);
}
/// <summary>
/// This constructor is provided in compliance with common NetFx design patterns;
/// developers should prefer using the constructor
/// <code>public ZLibException(string message, string zlibErrorContext, ZLibNative.ErrorCode zlibErrorCode, string zlibErrorMessage)</code>.
/// </summary>
public ZLibException()
: base() {
Init();
}
/// <summary>
/// This constructor is provided in compliance with common NetFx design patterns;
/// developers should prefer using the constructor
/// <code>public ZLibException(string message, string zlibErrorContext, ZLibNative.ErrorCode zlibErrorCode, string zlibErrorMessage)</code>.
/// </summary>
/// <param name="message">The error message that explains the reason for the exception.</param>
public ZLibException(string message)
: base(message) {
Init();
}
/// <summary>
/// This constructor is provided in compliance with common NetFx design patterns;
/// developers should prefer using the constructor
/// <code>public ZLibException(string message, string zlibErrorContext, ZLibNative.ErrorCode zlibErrorCode, string zlibErrorMessage)</code>.
/// </summary>
/// <param name="message">The error message that explains the reason for the exception.</param>
/// <param name="inner">The exception that is the cause of the current exception, or a <code>null</code>.</param>
public ZLibException(string message, Exception inner)
: base(message, inner) {
Init();
}
#if !SILVERLIGHT
/// <summary>
/// Initializes a new ZLibException 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>
[SecurityPermission(SecurityAction.LinkDemand, SerializationFormatter=true)]
protected ZLibException(SerializationInfo info, StreamingContext context) :
base(info, context) {
string errContext = info.GetString("zlibErrorContext");
ZErrorCode errCode = (ZErrorCode) info.GetInt32("zlibErrorCode");
string errMessage = info.GetString("zlibErrorMessage");
Init(errContext, errCode, errMessage);
}
[SecurityPermission(SecurityAction.LinkDemand, SerializationFormatter=true)]
void ISerializable.GetObjectData(SerializationInfo si, StreamingContext context) {
base.GetObjectData(si, context);
si.AddValue("zlibErrorContext", this.zlibErrorContext);
si.AddValue("zlibErrorCode", (Int32) this.zlibErrorCode);
si.AddValue("zlibErrorMessage", zlibErrorMessage);
}
#endif // !SILVERLIGHT
private void Init() {
Init("", ZErrorCode.Ok, "");
}
private void Init(string zlibErrorContext, ZErrorCode zlibErrorCode, string zlibErrorMessage) {
this.zlibErrorContext = zlibErrorContext;
this.zlibErrorCode = zlibErrorCode;
this.zlibErrorMessage = zlibErrorMessage;
}
public string ZLibContext {
#if SILVERLIGHT
[SecurityCritical]
#else
[PermissionSet(SecurityAction.LinkDemand, Unrestricted=true)]
#endif
get { return zlibErrorContext; }
}
public int ZLibErrorCode {
#if SILVERLIGHT
[SecurityCritical]
#else
[PermissionSet(SecurityAction.LinkDemand, Unrestricted=true)]
#endif
get { return (int) zlibErrorCode; }
}
public string ZLibErrorMessage {
#if SILVERLIGHT
[SecurityCritical]
#else
[PermissionSet(SecurityAction.LinkDemand, Unrestricted=true)]
#endif
get { return zlibErrorMessage; }
}
} // internal class ZLibException
} // namespace System.IO.Compression
// file ZLibException.cs