Soullies/Continentis
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
27af2b7eb294c8bd4616ce0eb70102252051984c
Continentis/Assets/UMod/Plugin/UMod-Shared.xml
SoulliesOfficial 9b1b5ca93f initial
2025-10-03 00:02:43 -04:00

6585 lines
316 KiB
XML
Raw Blame History

<?xml version="1.0"?>
<doc>
<assembly>
<name>UMod-Shared</name>
</assembly>
<members>
<member name="E:UMod.Shared.AssetSharing.GameAssetLink.OnGameAssetLoaded">
<summary>
Called by uMod when this game asset link has loaded its target game asset or edit time bundle asset as a result of a relink request.
The passed object is that actual game asset or bundle asset and not an instantiated copy so care should be taken to avoid data loss. Typically this will be a prefab asset passed as a game object.
</summary>
</member>
<member name="E:UMod.Shared.AssetSharing.GameAssetLink.OnGameAssetRelinked">
<summary>
Called by uMod when this game asset has been successfully relinked to its target game asset or edit time bundle asset.
The passed object is the instantiated scene asset which was relinked, typically a prefab instance.
</summary>
</member>
<member name="T:UMod.Shared.Linker.TypeHandler.TypeHandler_PrimitiveEnum">
<summary>
Enums are directly convertible to and from integers so we use this as the main storage container.
</summary>
</member>
<member name="M:UMod.Shared.Linker.LinkArray.IsGenericList(System.Type)">
<summary>
Used to determine whether a type is a generic list which is given special treatment during serialization as per Unity.
</summary>
<param name="type">The type to check</param>
<returns>True if the type is a generic list of false if not</returns>
</member>
<member name="T:UMod.Shared.Linker.LinkBehaviour">
<summary>
Responsible for storing type information of custom scripts so that they can be successfully loaded by the host.
Is also used to access game scripts by name type
</summary>
</member>
<member name="F:UMod.Shared.Linker.LinkBehaviour.skipAssemblies">
<summary>
All assemblies containing these strings will not be linked.
</summary>
</member>
<member name="M:UMod.Shared.Linker.LinkBehaviour.DestroyInstanceIdentity">
<summary>
If the target object is a prefab instance then it will have 2 <see cref="T:UMod.Shared.ModObjectIdentity"/> componenets at export time so we need to strip the prefab identity leaving only the scene identity since using the prefab identity would cause all the same prefab instances to have the same id
</summary>
</member>
<member name="M:UMod.Shared.Linker.ModLinker.RelinkModScript(UMod.Shared.Linker.LinkBehaviour,System.Boolean)">
<summary>
Attempt to restore the correct script component for the specified <see cref="T:UMod.Shared.Linker.LinkBehaviour"/>.
</summary>
<param name="script">The behaviour script to relink</param>
<param name="isSceneLink">Is the target script attached to a scene game object</param>
</member>
<member name="P:UMod.Shared.Linker.TypeReference.IsUnityType">
<summary>
Is the type a built in unity type
</summary>
</member>
<member name="T:UMod.Shared.Resources.ModInfoResource">
<summary>
Represents the mod date file that is present will all mods.
Provides additional information about a mod that can be accessed prior to loading the mod.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModInfoResource.NameInfo">
<summary>
Get the <see cref="T:UMod.IModNameInfo"/> for this mod.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModInfoResource.ReferenceInfo">
<summary>
Get an array of <see cref="T:UMod.IModNameInfo"/> representing the mods that are referenced by this mod.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModInfoResource.ModDescription">
<summary>
Returns a description string for the mod as specified by the mod creator.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModInfoResource.ModAuthor">
<summary>
Returns the name of the person who created the mod.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModInfoResource.ModCoreVersion">
<summary>
Returns a version string representing the version of uMod Build Engine that compiled the mod.
Used internally during loading.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModInfoResource.ModUnityVersion">
<summary>
Returns the version of unity required to load the mod.
</summary>
</member>
<member name="M:UMod.Shared.Resources.ModInfoResource.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:UMod.Shared.Resources.ModInfoResource.#ctor(System.String,System.String,UMod.Shared.ModContent,UMod.Shared.ModIdentifier)">
<summary>
Overloadded constructor used to manually configure a mod file.
</summary>
<param name="coreVersion">The version string representing the build engine version used to compile the mod</param>
<param name="unityVersion">The version of Unity requried to load the mod</param>
<param name="contentMask">The <see cref="T:UMod.Shared.ModContent"/> enum mask representing the type of content that is included in the mod</param>
<param name="identifier">The unique 8 byte code for this mod</param>
</member>
<member name="M:UMod.Shared.Resources.ModInfoResource.GetModUniqueIdentifier">
<summary>
Returns the unique 8-byte identifier code used to represent a specific mod.
</summary>
<returns>The 8-byte id code of the mod</returns>
</member>
<member name="M:UMod.Shared.Resources.ModInfoResource.GetModContentMask">
<summary>
Get the included content types of the mod.
</summary>
<returns>A masked value containing included content types</returns>
</member>
<member name="M:UMod.Shared.Resources.ModInfoResource.ModWriteToArchive(System.IO.Stream,UMod.Shared.Resources.ModArchiveOperation)">
<summary>
Write the mod file to the data chunk.
</summary>
<param name="stream">The data stream to write to</param>
</member>
<member name="M:UMod.Shared.Resources.ModInfoResource.ModReadFromArchive(System.IO.Stream,UMod.Shared.Resources.ModArchiveOperation)">
<summary>
Read the mod file from the data chunk
</summary>
<param name="stream">The data stream to read from</param>
</member>
<member name="M:UMod.Shared.Resources.ModInfoResource.ToString">
<summary>
Get a string representation of the mod file.
</summary>
<returns></returns>
</member>
<member name="T:UMod.Shared.Resources.ModAssemblyEntry">
<summary>
Represents a single assembly description.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModAssemblyEntry.Assembly">
<summary>
Get the assembly for this <see cref="T:UMod.Shared.Resources.ModAssemblyEntry"/>.
A valid assembly is only available at export time.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModAssemblyEntry.AssemblyName">
<summary>
Get the name of the assembly.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModAssemblyEntry.AssetName">
<summary>
Get the name of the asset in the mod file.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModAssemblyEntry.AssemblyImage">
<summary>
Get the raw byte data for the assembly.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModAssemblyEntry.AssemblySymbolsImage">
<summary>
Get the raw debug symbol data for the assembly.
If there is no debug data then this value will be null.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModAssemblyEntry.AssemblyMetaData">
<summary>
Get the date for the assembly meta file that Unity generated for the assembly when built.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModAssemblyEntry.HasDebugSymbols">
<summary>
Returns true if the assembly entry contains debug symbols for the module.
</summary>
</member>
<member name="M:UMod.Shared.Resources.ModAssemblyEntry.#ctor(System.Reflection.Assembly,System.String,System.Byte[],System.Byte[])">
<summary>
Create an assembly entry from a loaded assembly.
</summary>
<param name="assembly">The assembly to create an entry for</param>
<param name="assetName">The filename of the asset</param>
<param name="assemblyImage">The assembly image data</param>
<param name="assemblySymbolsImage">The symbol image data</param>
</member>
<member name="M:UMod.Shared.Resources.ModAssemblyEntry.AddSymbolsImage(System.Byte[])">
<summary>
Add assembly image data to the entry.
</summary>
<param name="assemblySymbolsImage">The assembly file raw bytes</param>
</member>
<member name="M:UMod.Shared.Resources.ModAssemblyEntry.AddMetaData(System.Byte[])">
<summary>
Add symbol image data to the entry.
</summary>
<param name="metaData">The symbols file raw bytes</param>
</member>
<member name="M:UMod.Shared.Resources.ModAssemblyEntry.OnModSerialize(System.IO.BinaryWriter)">
<summary>
Serialize the assembly entry to file.
</summary>
<param name="stream">The stream to write the data to</param>
</member>
<member name="M:UMod.Shared.Resources.ModAssemblyEntry.OnModDeserialize(System.IO.BinaryReader)">
<summary>
Deserialize the assembly entry from file.
</summary>
<param name="stream">The stream to load the data from</param>
</member>
<member name="T:UMod.Shared.Resources.ModAssemblyInfoResource">
<summary>
Defines all included assemblies that have been provided by the user.
Typically there will only be one assembly (Assembly-CSharp) however there can be any number.
</summary>
</member>
<member name="P:UMod.Shared.Resources.ModAssemblyInfoResource.Assemblies">
<summary>
Enumerate all the assemblies defined in this assembly file.
</summary>
</member>
<member name="M:UMod.Shared.Resources.ModAssemblyInfoResource.AddRequirement(UMod.Shared.Resources.ModAssemblyEntry)">
<summary>
Adds a required assembly to the assembly file.
</summary>
<param name="entry"></param>
</member>
<member name="M:UMod.Shared.Resources.ModAssemblyInfoResource.ModWriteToArchive(System.IO.Stream,UMod.Shared.Resources.ModArchiveOperation)">
<summary>
Serialize the assembly file to file.
</summary>
<param name="stream">The stream to write the data to</param>
</member>
<member name="M:UMod.Shared.Resources.ModAssemblyInfoResource.ModReadFromArchive(System.IO.Stream,UMod.Shared.Resources.ModArchiveOperation)">
<summary>
Deserialize the assembly file from file.
</summary>
<param name="stream">The stream to load the data from</param>
</member>
<member name="T:UMod.Shared.ModNameInfo">
<summary>
Represents a mods name and version information.
</summary>
</member>
<member name="P:UMod.Shared.ModNameInfo.ModName">
<summary>
Get the name of the mod.
</summary>
</member>
<member name="P:UMod.Shared.ModNameInfo.ModVersion">
<summary>
Get the mod version as specified bu the creator.
</summary>
</member>
<member name="M:UMod.Shared.ModNameInfo.OnModSerialize(System.IO.BinaryWriter)">
<summary>
Write the mod name info to the stream.
</summary>
<param name="stream">The stream to write to</param>
</member>
<member name="M:UMod.Shared.ModNameInfo.OnModDeserialize(System.IO.BinaryReader)">
<summary>
Read the mod name info from the stream.
</summary>
<param name="stream">The stream to read from</param>
</member>
<member name="T:UMod.Shared.ModSerializedType">
<summary>
Used to serialize a system type between sessions.
This type is Unity serializable.
</summary>
</member>
<member name="P:UMod.Shared.ModSerializedType.HasValidType">
<summary>
Returns a value indicating whether the type is valid and resolvable.
</summary>
</member>
<member name="M:UMod.Shared.ModSerializedType.#ctor">
<summary>
Create a new instance.
</summary>
</member>
<member name="M:UMod.Shared.ModSerializedType.#ctor(System.Type)">
<summary>
Create a new instance from the specified type.
</summary>
<param name="type">The system type to serialize</param>
</member>
<member name="M:UMod.Shared.ModSerializedType.ClearReference">
<summary>
Causes any stored type reference to be removed.
</summary>
</member>
<member name="M:UMod.Shared.ModSerializedType.op_Implicit(System.Type)~UMod.Shared.ModSerializedType">
<summary>
Implicit conversion to serialized type.
</summary>
<param name="type">The system type to convert</param>
</member>
<member name="M:UMod.Shared.ModSerializedType.op_Implicit(UMod.Shared.ModSerializedType)~System.Type">
<summary>
Implicit conversion to system type.
</summary>
<param name="type">The mod type to convert</param>
</member>
<member name="F:UMod.Shared.UModBundleAsset.projectRelativeAssetsPaths">
<summary>
A list of asset paths including extension relative to the project folder. For example: 'Assets/ExportMod/TestMaterial.mat'
</summary>
</member>
<member name="T:UMod.Shared.ArrayUtil">
<summary>
Similar to the Unity Editor class but allows access at runtime.
</summary>
</member>
<member name="M:UMod.Shared.ArrayUtil.Add``1(``0[]@,``0)">
<summary>
Add an item to the back of the array.
The array size will be increased by 1.
</summary>
<typeparam name="T">The generic array item type</typeparam>
<param name="array">The array to modify</param>
<param name="item">The item to add to the array</param>
</member>
<member name="M:UMod.Shared.ArrayUtil.AddRange``1(``0[]@,``0[])">
<summary>
Add a range of items to the back of the array.
The array size will be increased by the size of the items array.
</summary>
<typeparam name="T">The generic array item type</typeparam>
<param name="array">The array to modify</param>
<param name="items">The array of items to add</param>
</member>
<member name="M:UMod.Shared.ArrayUtil.Remove``1(``0[]@,``0)">
<summary>
Remove the specified item from the array.
The item will only be remove if it was found.
</summary>
<typeparam name="T">The generic array item type</typeparam>
<param name="array">The array to modify</param>
<param name="item">The item to remove</param>
</member>
<member name="M:UMod.Shared.ArrayUtil.RemoveAt``1(``0[]@,System.Int32)">
<summary>
Remove the item at the specified index.
The index must be inside the bounds of the array.
</summary>
<typeparam name="T">The generic array item type</typeparam>
<param name="array">The array to modify</param>
<param name="index">The array index to remove at</param>
</member>
<member name="M:UMod.Shared.ArrayUtil.Contains``1(``0[]@,``0)">
<summary>
Check whether the array contains the specified item.
</summary>
<typeparam name="T">The generic array item type</typeparam>
<param name="array">The array to check</param>
<param name="item">The item to look for</param>
<returns>True if the item was found or false if not</returns>
</member>
<member name="M:UMod.Shared.ArrayUtil.Clear``1(``0[]@)">
<summary>
Reset the array to a size of 0.
</summary>
<typeparam name="T">The generic array item type</typeparam>
<param name="array">The array to clear</param>
</member>
<member name="T:UMod.Shared.LogLevel">
<summary>
The log level currently in use.
</summary>
</member>
<member name="F:UMod.Shared.LogLevel.None">
<summary>
Nothing should be logged.
</summary>
</member>
<member name="F:UMod.Shared.LogLevel.Exceptions">
<summary>
Only exceptions and errors should be logged.
</summary>
</member>
<member name="F:UMod.Shared.LogLevel.Errors">
<summary>
Only errors should be logged.
</summary>
</member>
<member name="F:UMod.Shared.LogLevel.Warnings">
<summary>
Only warnings, exceptions and errors should be logged.
</summary>
</member>
<member name="F:UMod.Shared.LogLevel.All">
<summary>
Everything should be logged.
</summary>
</member>
<member name="T:UMod.Shared.Log">
<summary>
Provides user control over the amount of console logging as developers are able to set the type of messages that should be displayed
</summary>
</member>
<member name="M:UMod.Shared.Log.SetLogMode(UMod.Shared.LogLevel)">
<summary>
Allows the log level to be set by the user.
See also <see cref="T:UMod.Shared.LogLevel"/>.
</summary>
<param name="levelMask">The <see cref="T:UMod.Shared.LogLevel"/> enum values used to specifiy which type of messages will be logged</param>
</member>
<member name="M:UMod.Shared.Log.Message(System.Object,System.Object[])">
<summary>
Log a message to the Unity Console depending on log level
</summary>
<param name="sender">The object that logged the message</param>
<param name="args">The objects to log</param>
</member>
<member name="M:UMod.Shared.Log.Warning(System.Object,System.Object[])">
<summary>
Log a warning to the Unity console depending on the log level
</summary>
<param name="sender">The object that logged the warning</param>
<param name="args">The objects to log</param>
</member>
<member name="M:UMod.Shared.Log.Error(System.Object,System.Object[])">
<summary>
Log an error to the Unity console depending on the log level
</summary>
<param name="sender">The object that logged the warning</param>
<param name="args">The objects to log</param>
</member>
<member name="M:UMod.Shared.Log.Exception(System.Exception)">
<summary>
Log an exception to the Unity console depending on the log level.
</summary>
<param name="e">The exception instance to log</param>
</member>
<member name="T:UMod.Shared.ModDontCompileAttribute">
<summary>
Used to inform the build engine that this script should not be linked or compiled in any way.
</summary>
</member>
<member name="T:UMod.Shared.ModEvent">
<summary>
Utility class that handles basic events and calling.
</summary>
</member>
<member name="M:UMod.Shared.ModEvent.Invoke(System.Action)">
<summary>
Attempts to dyncamiaclly invoke the supplied event.
</summary>
<param name="method">The event to trigger</param>
</member>
<member name="M:UMod.Shared.ModEvent.Invoke``1(System.Action{``0},``0)">
<summary>
Attempts to dyncamically invoke the supplied event with the specicfied argument.
</summary>
<typeparam name="T">The type of argument the event takes</typeparam>
<param name="method">The event to trigger</param>
<param name="value">The value for the argument</param>
</member>
<member name="M:UMod.Shared.ModEvent.Invoke``2(System.Action{``0,``1},``0,``1)">
<summary>
Attempts to dyncamically invoke the supplied event with the specified arguments.
</summary>
<typeparam name="T">The type of the first argument</typeparam>
<typeparam name="TJ">The type of the second argument</typeparam>
<param name="method">The event to trigger</param>
<param name="arg0">The value for the first argument</param>
<param name="arg1">The value for the second argument</param>
</member>
<member name="M:UMod.Shared.ModEvent.Invoke``1(System.Func{``0})">
<summary>
Attempts to dyncamically invoke the supplied event with the specified return value.
</summary>
<typeparam name="TR">The type of value the event returns</typeparam>
<param name="method">The event to trigger</param>
<returns>The value returned as a result of invoking the delegate or the default value if the event could not be triggered</returns>
</member>
<member name="M:UMod.Shared.ModEvent.Invoke``2(System.Func{``1,``0},``1)">
<summary>
Attempts to dyncamically invoke the supplied event with the specified argument and return value.
</summary>
<typeparam name="TR">The type of value the event returns</typeparam>
<typeparam name="T">The type of argument accepted</typeparam>
<param name="method">The event to trigger</param>
<param name="value">The value for the argument</param>
<returns>The value returned as a result of invoking the delegate or the default value if the event could not be triggered</returns>
</member>
<member name="M:UMod.Shared.ModEvent.Invoke``3(System.Func{``1,``2,``0},``1,``2)">
<summary>
Attempts to dynamically infoke the supplied event with the specified arguments and return value.
</summary>
<typeparam name="TR">The type of value the event returns</typeparam>
<typeparam name="T">The type of the first argument</typeparam>
<typeparam name="TJ">The type of the second argument</typeparam>
<param name="method">The event to trigger</param>
<param name="arg0">The value for the first argument</param>
<param name="arg1">The value for the second argument</param>
<returns>The value returned as a result of invoking the delegate or the default value if the event could not be triggered</returns>
</member>
<member name="M:UMod.Shared.ModEvent.HasListener(System.Action)">
<summary>
Returns true if there are oe or more subscribers for the specified event.
</summary>
<param name="method">The event to check</param>
<returns>True if the event has one or more listeners subscribed</returns>
</member>
<member name="M:UMod.Shared.ModEvent.HasListener``1(System.Action{``0})">
<summary>
Returns true if there are oe or more subscribers for the specified event.
</summary>
<typeparam name="T">Generic type for compatibility agains all event types</typeparam>
<param name="method">The event to check</param>
<returns>True if the event has one or more listeners subscribed</returns>
</member>
<member name="M:UMod.Shared.ModEvent.HasListener``2(System.Action{``0,``1})">
<summary>
Returns true if there are oe or more subscribers for the specified event.
</summary>
<typeparam name="T">Generic type for compatibility agains all event types</typeparam>
<typeparam name="TJ">Generic type for compatibility agains all event types</typeparam>
<param name="method">The event to check</param>
<returns>True if the event has one or more listeners subscribed</returns>
</member>
<member name="M:UMod.Shared.ModEvent.HasListener``1(System.Func{``0})">
<summary>
Returns true if there are oe or more subscribers for the specified event.
</summary>
<typeparam name="TR">Generic type for compatibility agains all event types</typeparam>
<param name="method">The event to check</param>
<returns>True if the event has one or more listeners subscribed</returns>
</member>
<member name="M:UMod.Shared.ModEvent.HasListener``2(System.Func{``1,``0})">
<summary>
Returns true if there are oe or more subscribers for the specified event.
</summary>
<typeparam name="TR">Generic type for compatibility agains all event types</typeparam>
<typeparam name="T">Generic type for compatibility agains all event types</typeparam>
<param name="method">The event to check</param>
<returns>True if the event has one or more listeners subscribed</returns>
</member>
<member name="M:UMod.Shared.ModEvent.HasListener``3(System.Func{``1,``2,``0})">
<summary>
Returns true if there are oe or more subscribers for the specified event.
</summary>
<typeparam name="TR">Generic type for compatibility agains all event types</typeparam>
<typeparam name="T">Generic type for compatibility agains all event types</typeparam>
<typeparam name="TJ">Generic type for compatibility agains all event types</typeparam>
<param name="method">The event to check</param>
<returns>True if the event has one or more listeners subscribed</returns>
</member>
<member name="T:UMod.Shared.ModFiles">
<summary>
Global helper class used to represent the files produced and consumed by UMod applications
</summary>
</member>
<member name="F:UMod.Shared.ModFiles.modAssemblyFile">
<summary>
The file that is packaged with every mod that lists all scripting assemblies included
</summary>
</member>
<member name="T:UMod.Shared.ModIdentifier">
<summary>
Represents a unique 8-byte identifier code for a mod.
</summary>
</member>
<member name="F:UMod.Shared.ModIdentifier.friendlyIdentifier">
<summary>
The friendly string code for this identifier.
</summary>
</member>
<member name="F:UMod.Shared.ModIdentifier.identifier">
<summary>
The raw 8-byte hash code for this identifier.
</summary>
</member>
<member name="F:UMod.Shared.ModIdentifier.identifierLength">
<summary>
Get the number of bytes that makes up the identifier hash code.
</summary>
</member>
<member name="P:UMod.Shared.ModIdentifier.FriendlyIdentifier">
<summary>
Get the friendly string representation of the hash code.
Mainly used for displaying the hash code in debug scenarios.
</summary>
</member>
<member name="M:UMod.Shared.ModIdentifier.#ctor">
<summary>
Create a new mod identifier.
</summary>
</member>
<member name="M:UMod.Shared.ModIdentifier.#ctor(System.Byte[])">
<summary>
Create a new mod identifier from the specified byte array.
</summary>
<param name="identifier">The 8-byte array representing the hash code for the identifier</param>
</member>
<member name="M:UMod.Shared.ModIdentifier.#ctor(System.String)">
<summary>
Create a new mod identifier from the specified friendly string.
</summary>
<param name="friendlyIdentifier">The string value to create the hash code from</param>
</member>
<member name="M:UMod.Shared.ModIdentifier.Equals(UMod.Shared.ModIdentifier)">
<summary>
Custom equals method.
</summary>
<param name="other">The other mod identifier to check against</param>
<returns>True if the other identifier is equal to this identifier or false if not</returns>
</member>
<member name="M:UMod.Shared.ModIdentifier.Equals(System.Object)">
<summary>
Override equals method.
</summary>
<param name="obj">The other object to check against</param>
<returns>True if the other object is equal to this identifier or false if not</returns>
</member>
<member name="M:UMod.Shared.ModIdentifier.GetHashCode">
<summary>
Override method.
</summary>
<returns>The new hash code for this identifier</returns>
</member>
<member name="M:UMod.Shared.ModIdentifier.ToString">
<summary>
Override method.
</summary>
<returns>A string representation of the identifier</returns>
</member>
<member name="M:UMod.Shared.ModIdentifier.op_Equality(UMod.Shared.ModIdentifier,UMod.Shared.ModIdentifier)">
<summary>
Override equals operator.
</summary>
<param name="a">The first value</param>
<param name="b">The second value</param>
<returns>True if the values are considered equal</returns>
</member>
<member name="M:UMod.Shared.ModIdentifier.op_Inequality(UMod.Shared.ModIdentifier,UMod.Shared.ModIdentifier)">
<summary>
Override not-equal operator.
</summary>
<param name="a">The first value</param>
<param name="b">The second value</param>
<returns>True if the values are considered not-equal</returns>
</member>
<member name="M:UMod.Shared.ModIdentifier.op_Implicit(System.Byte[])~UMod.Shared.ModIdentifier">
<summary>
Implicit conversion of 'byte[]' to <see cref="T:UMod.Shared.ModIdentifier"/>.
</summary>
<param name="identifier">The byte[] data for the identifier</param>
</member>
<member name="M:UMod.Shared.ModIdentifier.op_Implicit(UMod.Shared.ModIdentifier)~System.Byte[]">
<summary>
Get the specified <see cref="T:UMod.Shared.ModIdentifier"/> as a byte array.
The lenght of the array will always be equal to <see cref="F:UMod.Shared.ModIdentifier.identifierLength"/>.
</summary>
<param name="identifier">The <see cref="T:UMod.Shared.ModIdentifier"/> to convert</param>
</member>
<member name="M:UMod.Shared.ModIdentifier.GeneratePotentiallyUnique">
<summary>
Attempts to generate a unique identifier that has a very high chance of being unique.
</summary>
<returns>A new <see cref="T:UMod.Shared.ModIdentifier"/> representing the unique id</returns>
</member>
<member name="T:UMod.Shared.ModIdentity">
<summary>
The mod identity represent a unique id for a loaded mod that can be used to reference the mod at any time. ///
</summary>
</member>
<member name="P:UMod.Shared.ModIdentity.ModName">
<summary>
Get the name of the mod for this identity.
</summary>
</member>
<member name="P:UMod.Shared.ModIdentity.ModVersion">
<summary>
Get the version of the mod for this identity.
</summary>
</member>
<member name="P:UMod.Shared.ModIdentity.ModIdentifier">
<summary>
Get the identifier for this mod identity.
The identifier is a unique 8-byte hash code.
</summary>
</member>
<member name="M:UMod.Shared.ModIdentity.#ctor">
<summary>
Create a new mod identity.
</summary>
</member>
<member name="M:UMod.Shared.ModIdentity.#ctor(System.String,System.String,UMod.Shared.ModIdentifier)">
<summary>
Create a new mod identity with the specified id values.
</summary>
<param name="name">The name of the mod</param>
<param name="version">The version of the mod</param>
<param name="identifier">The identifier for the mod</param>
</member>
<member name="M:UMod.Shared.ModIdentity.Equals(UMod.Shared.ModIdentity)">
<summary>
Determine whtether the specified mod idnetity is equal to this mod identity.
</summary>
<param name="other">The other identity to check against</param>
<returns>True if the identities are equal or false if they are not</returns>
</member>
<member name="M:UMod.Shared.ModIdentity.Equals(System.Object)">
<summary>
Determine whether the specified object is equal to this mod idendity.
</summary>
<param name="obj">The other object to check against</param>
<returns>True if the identities are equal or false if they are not</returns>
</member>
<member name="M:UMod.Shared.ModIdentity.GetHashCode">
<summary>
Override method.
</summary>
<returns>The new hash code for the identity</returns>
</member>
<member name="M:UMod.Shared.ModIdentity.op_Equality(UMod.Shared.ModIdentity,UMod.Shared.ModIdentity)">
<summary>
Override equals operator.
</summary>
<param name="a">First value in comparison</param>
<param name="b">Second value in comparison</param>
<returns>True if the identities match or false if not</returns>
</member>
<member name="M:UMod.Shared.ModIdentity.op_Inequality(UMod.Shared.ModIdentity,UMod.Shared.ModIdentity)">
<summary>
Override not-equals operator.
</summary>
<param name="a">First value in comparison</param>
<param name="b">Second value in comparison</param>
<returns>True if the identities match or false if not</returns>
</member>
<member name="M:UMod.Shared.ModIdentity.ToString">
<summary>
Override method.
</summary>
<returns>A string representation of this identity</returns>
</member>
<member name="T:UMod.Shared.ModObjectIdentifier">
<summary>
Represents a unique identifier for a mod object in the form of an 8-byte hash.
</summary>
</member>
<member name="P:UMod.Shared.ModObjectIdentifier.Hash">
<summary>
Get the hash code for this identifier.
</summary>
</member>
<member name="M:UMod.Shared.ModObjectIdentifier.#ctor">
<summary>
Create a new object identifier.
</summary>
</member>
<member name="M:UMod.Shared.ModObjectIdentifier.#ctor(System.Byte[])">
<summary>
Create a new object identifier with the specified byte code hash.
</summary>
<param name="identifier">The 8-byte array that makes up the hash code</param>
</member>
<member name="M:UMod.Shared.ModObjectIdentifier.#ctor(System.String)">
<summary>
Create a new object identifier with the specified friendly string identifier.
</summary>
<param name="friendlyIdentifier">The 8-character string that makes up the hash code</param>
</member>
<member name="M:UMod.Shared.ModObjectIdentifier.GenerateUnique">
<summary>
Generate a unique object identifier for a mod object.
</summary>
<returns>A unique object identifier</returns>
</member>
<member name="T:UMod.Shared.ModObjectIdentity">
<summary>
Attached to every object in a mod project by the UMod Exporter so that the mod host can differentiate between modded content and game content.
Triggers events when mod object instances are spawned or destroyed allowing the host to track and manage them.
</summary>
</member>
<member name="E:UMod.Shared.ModObjectIdentity.OnModObjectCreated">
<summary>
Triggered when the identity is created and allows the object to be tracked by the host so that it can be destroyed automatically when the mod is unloaded.
</summary>
</member>
<member name="E:UMod.Shared.ModObjectIdentity.OnModObjectDestroyed">
<summary>
Triggered when the identity will be destroyed so that the host no longer need to destroy it on unload.
</summary>
</member>
<member name="P:UMod.Shared.ModObjectIdentity.ModIdentity">
<summary>
Get the Mod identity for the mod object.
Multiple mods can be loaded at the same time so this links a mod object with a mod.
</summary>
</member>
<member name="P:UMod.Shared.ModObjectIdentity.ObjectIdentity">
<summary>
Get the object identifier.
</summary>
</member>
<member name="M:UMod.Shared.ModObjectIdentity.AssociateObject(UMod.Shared.ModIdentity,UnityEngine.GameObject)">
<summary>
Called by the build engine to associate a game object with a mod.
</summary>
<param name="identity">The <see cref="P:UMod.Shared.ModObjectIdentity.ModIdentity"/> to give to the object</param>
<param name="go">The game object to associated</param>
<returns>The new identity for the specified object</returns>
</member>
<member name="M:UMod.Shared.ModObjectIdentity.FindWithIdentifier(UMod.Shared.ModObjectIdentifier)">
<summary>
Attempts to find the object identity for the object identifier.
</summary>
<param name="identifier"></param>
<returns></returns>
</member>
<member name="T:UMod.Shared.Platform">
<summary>
Enum of supported platforms allowing mask functionality for compression
</summary>
</member>
<member name="T:UMod.Shared.ModContent">
<summary>
Enumeration used to specifiy the type of content that is included in a mod.
The enum is used as a bitmask value where one or more values can be combined to specifiy multiple values.
</summary>
</member>
<member name="F:UMod.Shared.ModContent.Scripts">
<summary>
Indicates that the mod includes scripted content.
</summary>
</member>
<member name="F:UMod.Shared.ModContent.Assets">
<summary>
Indicates that the mod includes asset content in the form of prefabs.
</summary>
</member>
<member name="F:UMod.Shared.ModContent.Scenes">
<summary>
Indicates that the mod includes complete scenes.
</summary>
</member>
<member name="T:UMod.Shared.ModPlatform">
<summary>
Used to identify the supported platforms
</summary>
</member>
<member name="P:UMod.Shared.ModPlatform.IsEditorPlatform">
<summary>
Returns true if the mod is currently executing within the editor.
</summary>
</member>
<member name="P:UMod.Shared.ModPlatform.IsStandalonePlatform">
<summary>
Retruns true if the mod is currently executing in a supported standalong player.
</summary>
</member>
<member name="M:UMod.Shared.ModPlatform.CurrentPlatformSupported">
<summary>
Returns true if the current platform is supported by uMod.
</summary>
<returns>True if supported</returns>
</member>
<member name="M:UMod.Shared.ModPlatform.GetCurrentPlatform">
<summary>
returns true if the current build target is supported by uMod.
</summary>
<returns>True if supported</returns>
</member>
<member name="T:UMod.Shared.ModReflect">
<summary>
Helper class that provides method for common reflection tasks.
</summary>
</member>
<member name="M:UMod.Shared.ModReflect.HasAttribute(System.Type,System.Type,System.Boolean)">
<summary>
Checks whether a specified type has an attribute associated with it.
</summary>
<param name="type">The type to check for attributes</param>
<param name="attributeType">The type of the attribute to check for</param>
<param name="inherit">Should sub classes be checked</param>
<returns>True if the attribute was found</returns>
</member>
<member name="M:UMod.Shared.ModReflect.HasAttribute``1(System.Type,System.Boolean)">
<summary>
Checks whether a specified type has the specified generic attribute type associated with it.
</summary>
<typeparam name="T">The generic attribute type to check for</typeparam>
<param name="type">The type to check for attributes</param>
<param name="inherit">Should sub classes be checked</param>
<returns>True if the specified attribute type was found</returns>
</member>
<member name="M:UMod.Shared.ModReflect.GetAttribute(System.Type,System.Type,System.Boolean)">
<summary>
Attempts to get an attrtibute from the specified type.
</summary>
<param name="type">The type to check for attributes</param>
<param name="attributeType">The type of attribute to check for</param>
<param name="inherit">Should sub classes be checked</param>
<returns>The specified attabute if found or null</returns>
</member>
<member name="M:UMod.Shared.ModReflect.GetAttribute``1(System.Type,System.Boolean)">
<summary>
Attempts to get an attribute of the specified generic type for the specified type.
</summary>
<typeparam name="T">The generic attribute to check for</typeparam>
<param name="type">The type to check for attributes</param>
<param name="inherit">Should sub classes be checked</param>
<returns>The specified attribute if found or null</returns>
</member>
<member name="M:UMod.Shared.ModReflect.GetAttributes(System.Type,System.Type,System.Boolean)">
<summary>
Attempts to get all attributes from the specified type.
</summary>
<param name="type">The type to check fir attributes</param>
<param name="attributeType">The type of attribute to check for</param>
<param name="inherit">Should sub classes be checked</param>
<returns>An array of specified attributes if found otherwise an empty array</returns>
</member>
<member name="M:UMod.Shared.ModReflect.GetAttributes``1(System.Type,System.Boolean)">
<summary>
Attempts to get all attributes of the specified generic type from the specified type.
</summary>
<typeparam name="T">The generic attribute type to check for</typeparam>
<param name="type">The type to check for attributes</param>
<param name="inherit">Should sub classes be checked</param>
<returns>An array of generic attributes if found otherwise an empty array</returns>
</member>
<member name="T:UMod.Shared.ModScriptableAsset`1">
<summary>
Settings class that allows editor configured settings to be acessible at runtime.
</summary>
<typeparam name="T">The type of settings</typeparam>
</member>
<member name="P:UMod.Shared.ModScriptableAsset`1.AssetName">
<summary>
Returns the name of the asset.
</summary>
</member>
<member name="P:UMod.Shared.ModScriptableAsset`1.Active">
<summary>
Get the current instance of the specified type.
</summary>
</member>
<member name="M:UMod.Shared.ModScriptableAsset`1.LoadResources">
<summary>
Load the settings from the resources folder. Runtime.
</summary>
<returns>An instance of the settings class</returns>
</member>
<member name="T:UMod.Shared.ModVersion`1">
<summary>
Base version class used to provide the same functionality between assemblies while allowing for independant versions
</summary>
<typeparam name="T">The generic type of the inheriting class</typeparam>
</member>
<member name="P:UMod.Shared.ModVersion`1.MajorVersion">
<summary>
When implemented by the child class should return the major version for the product.
</summary>
</member>
<member name="P:UMod.Shared.ModVersion`1.MinorVersion">
<summary>
When implemented by the child class should return the minor version for the product.
</summary>
</member>
<member name="P:UMod.Shared.ModVersion`1.RevisionVersion">
<summary>
When implemented by the child class should return the revision version for the product.
</summary>
</member>
<member name="M:UMod.Shared.ModVersion`1.IsSameVersionOrLower(UMod.Shared.ModVersion)">
<summary>
Returns true if the specified <see cref="T:UMod.Shared.ModVersion"/> is less than or equal to this version.
</summary>
<param name="other">The other version to check</param>
<returns></returns>
</member>
<member name="T:UMod.Shared.IModSerialize">
<summary>
Represents an object that can be serialized into mod format for export.
</summary>
</member>
<member name="M:UMod.Shared.IModSerialize.OnModSerialize(System.IO.BinaryWriter)">
<summary>
Serialize the object into the specified stream.
</summary>
<param name="stream">The stream to write the data to</param>
</member>
<member name="M:UMod.Shared.IModSerialize.OnModDeserialize(System.IO.BinaryReader)">
<summary>
Deserialize the object from the specified stream.
</summary>
<param name="stream">The stream to read the data from</param>
</member>
<member name="T:UMod.Shared.SupportUtility">
<summary>
Helper class used to get system and software configuration that is used to report bugs.
</summary>
</member>
<member name="M:UMod.Shared.SupportUtility.GetCurrentHardwareSoftware">
<summary>
Get the current hardware and software specifications.
</summary>
<returns>A string value containing hardware and software information and versions</returns>
</member>
<member name="T:UMod.Shared.ModScriptableAssetNameAttribute">
<summary>
Attribute used to specify the name of a <see cref="T:UMod.Shared.ModScriptableAsset`1"/>.
</summary>
</member>
<member name="P:UMod.Shared.ModScriptableAssetNameAttribute.Name">
<summary>
The name that the asset should be saved with.
</summary>
</member>
<member name="M:UMod.Shared.ModScriptableAssetNameAttribute.#ctor(System.String)">
<summary>
Create a new instance of the attribute uwing the specified name.
</summary>
<param name="name">The name to store the asset with</param>
</member>
<member name="T:UMod.InvalidModDirectoryException">
<summary>
Exception thrown while accessing invalid mod directories.
</summary>
</member>
<member name="M:UMod.InvalidModDirectoryException.#ctor">
<summary>
Default constructor.
</summary>
</member>
<member name="M:UMod.InvalidModDirectoryException.#ctor(System.String)">
<summary>
Create an instance of this class with a message.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
</member>
<member name="M:UMod.InvalidModDirectoryException.#ctor(System.String,System.Exception)">
<summary>
Create an instance of this class with a message and inner exception.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
<param name="inner">Child exception</param>
</member>
<member name="T:UMod.InvalidModPathException">
<summary>
Exception thrown when a mod path is not valid.
</summary>
</member>
<member name="M:UMod.InvalidModPathException.#ctor">
<summary>
Default constructor.
</summary>
</member>
<member name="M:UMod.InvalidModPathException.#ctor(System.String)">
<summary>
Create an instance of this class with a message.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
</member>
<member name="M:UMod.InvalidModPathException.#ctor(System.String,System.Exception)">
<summary>
Create an instance of this class with a message and inner exception.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
<param name="inner">Child exception</param>
</member>
<member name="T:UMod.InvalidModServerException">
<summary>
Exception thrown while accessing invalid mod directories.
</summary>
</member>
<member name="M:UMod.InvalidModServerException.#ctor">
<summary>
Default constructor.
</summary>
</member>
<member name="M:UMod.InvalidModServerException.#ctor(System.String)">
<summary>
Create an instance of this class with a message.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
</member>
<member name="M:UMod.InvalidModServerException.#ctor(System.String,System.Exception)">
<summary>
Create an instance of this class with a message and inner exception.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
<param name="inner">Child exception</param>
</member>
<member name="T:UMod.ModArchiveException">
<summary>
Exception that is thrown when a mod file cannot be loaded.
</summary>
</member>
<member name="M:UMod.ModArchiveException.#ctor(System.String)">
<summary>
Create a new instance.
</summary>
<param name="message">The string error message of the exception</param>
</member>
<member name="M:UMod.ModArchiveException.#ctor(System.String,System.Exception)">
<summary>
Create a new instance.
</summary>
<param name="message">The string error message of the exception</param>
<param name="inner">The inner exception</param>
</member>
<member name="T:UMod.ModBetaException">
<summary>
Exception thrown when uMod cannot fully initialize becuase it is a trial version.
</summary>
</member>
<member name="M:UMod.ModBetaException.#ctor">
<summary>
Throw default exception.
</summary>
</member>
<member name="M:UMod.ModBetaException.#ctor(System.String)">
<summary>
Throw exception with message.
</summary>
<param name="message">A message containg the failure reason</param>
</member>
<member name="M:UMod.ModBetaException.#ctor(System.String,System.Exception)">
<summary>
Throw exception with message and inner exception
</summary>
<param name="message">A message containing the failure reason</param>
<param name="inner">Internal exception (If any)</param>
</member>
<member name="T:UMod.ModFormatException">
<summary>
Exception thrown when the command line is invalid.
</summary>
</member>
<member name="M:UMod.ModFormatException.#ctor">
<summary>
Default constructor.
</summary>
</member>
<member name="M:UMod.ModFormatException.#ctor(System.String)">
<summary>
Create an instance of this class with a message.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
</member>
<member name="M:UMod.ModFormatException.#ctor(System.String,System.Exception)">
<summary>
Create an instance of this class with a message and inner exception.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
<param name="inner">Child exception</param>
</member>
<member name="T:UMod.ModLoadException">
<summary>
An exception that is thrown when there is a mod loading error.
</summary>
</member>
<member name="M:UMod.ModLoadException.#ctor(System.String)">
<summary>
Create a new instance.
</summary>
<param name="message">The message for the exception</param>
</member>
<member name="T:UMod.ModNotActivatedException">
<summary>
Exception thrown when invalid calls are made to the API when a mod has been loaded but noy yet activated.
</summary>
</member>
<member name="M:UMod.ModNotActivatedException.#ctor">
<summary>
Throw default exception.
</summary>
</member>
<member name="M:UMod.ModNotActivatedException.#ctor(System.String)">
<summary>
Throw exception with message.
</summary>
<param name="message">A message containting the failure reason</param>
</member>
<member name="M:UMod.ModNotActivatedException.#ctor(System.String,System.Exception)">
<summary>
Throw exception with message and inner exception.
</summary>
<param name="message">A message containing the failure reason</param>
<param name="inner">Internal exception (If any)</param>
</member>
<member name="T:UMod.ModNotLoadedException">
<summary>
Exception thrown when invalid calls are made t the API when a mod has not been loaded.
</summary>
</member>
<member name="M:UMod.ModNotLoadedException.#ctor">
<summary>
Throw default exception.
</summary>
</member>
<member name="M:UMod.ModNotLoadedException.#ctor(System.String)">
<summary>
Throw exception with message.
</summary>
<param name="message">A message containg the failure reason</param>
</member>
<member name="M:UMod.ModNotLoadedException.#ctor(System.String,System.Exception)">
<summary>
Throw exception with message and inner exception
</summary>
<param name="message">A message containing the failure reason</param>
<param name="inner">Internal exception (If any)</param>
</member>
<member name="T:UMod.ModNotSupportedException">
<summary>
Exception thrown when a requested feature is not supported.
</summary>
</member>
<member name="M:UMod.ModNotSupportedException.#ctor">
<summary>
Default contructor.
</summary>
</member>
<member name="M:UMod.ModNotSupportedException.#ctor(System.String)">
<summary>
Create an instance of this class with a message.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
</member>
<member name="M:UMod.ModNotSupportedException.#ctor(System.String,System.Exception)">
<summary>
Create an instance of this class with a message and inner exception.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
<param name="inner">Child exception</param>
</member>
<member name="T:UMod.ModSecurityException">
<summary>
Exception thrown when host security is breached.
</summary>
</member>
<member name="M:UMod.ModSecurityException.#ctor">
<summary>
Default constructor.
</summary>
</member>
<member name="M:UMod.ModSecurityException.#ctor(System.String)">
<summary>
Create an instance of this class with a message.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
</member>
<member name="M:UMod.ModSecurityException.#ctor(System.String,System.Exception)">
<summary>
Create an instance of this class with a message and inner exception.
</summary>
<param name="message">The message indicating why the exception was thrown</param>
<param name="inner">Child exception</param>
</member>
<member name="T:UMod.ModTrialException">
<summary>
Exception thrown when uMod cannot fully initialize becuase it is a trial version.
</summary>
</member>
<member name="M:UMod.ModTrialException.#ctor">
<summary>
Throw default exception.
</summary>
</member>
<member name="M:UMod.ModTrialException.#ctor(System.String)">
<summary>
Throw exception with message.
</summary>
<param name="message">A message containg the failure reason</param>
</member>
<member name="M:UMod.ModTrialException.#ctor(System.String,System.Exception)">
<summary>
Throw exception with message and inner exception
</summary>
<param name="message">A message containing the failure reason</param>
<param name="inner">Internal exception (If any)</param>
</member>
<member name="T:UMod.IModNameInfo">
<summary>
Represents mod name information including the mod version.
</summary>
</member>
<member name="P:UMod.IModNameInfo.ModName">
<summary>
Get the name of the mod.
</summary>
</member>
<member name="P:UMod.IModNameInfo.ModVersion">
<summary>
Get the mod version as specified bu the creator.
</summary>
</member>
<member name="T:UMod.ModAsyncOperation`1">
<summary>
An awaitable object that is returned by async operations so you can wait for completion in a coroutine as well as access progress and status information.
</summary>
<typeparam name="T">The generic result type</typeparam>
</member>
<member name="P:UMod.ModAsyncOperation`1.Result">
<summary>
Get the generic result of the async operation.
</summary>
</member>
<member name="T:UMod.ModAsyncOperation">
<summary>
An awaitable object that is returned by async operations so you can wait for completion in a coroutine as well as access progress and status information.
</summary>
</member>
<member name="F:UMod.ModAsyncOperation.userData">
<summary>
User data suppiled by the object that marked the operation as complete.
</summary>
</member>
<member name="F:UMod.ModAsyncOperation.isSuccessful">
<summary>
Was the operation successful or did something gowrong.
</summary>
</member>
<member name="F:UMod.ModAsyncOperation.status">
<summary>
Get the current status of the async operation.
</summary>
</member>
<member name="P:UMod.ModAsyncOperation.Result">
<summary>
Get the <see cref="T:UnityEngine.Object"/> result of the async operation.
</summary>
</member>
<member name="P:UMod.ModAsyncOperation.Status">
<summary>
Get the current status of the async operation.
</summary>
</member>
<member name="P:UMod.ModAsyncOperation.Progress">
<summary>
Get the current progress of the async operation.
This is a normalized value between 0-1.
</summary>
</member>
<member name="P:UMod.ModAsyncOperation.ProgressPercentage">
<summary>
Get the current progress percentage of the async operation.
</summary>
</member>
<member name="P:UMod.ModAsyncOperation.IsDone">
<summary>
Returns true if the async operation has finished or false if it is still running.
</summary>
</member>
<member name="P:UMod.ModAsyncOperation.IsSuccessful">
<summary>
Returns true if the async operation completed successfully or false if an error occurred.
</summary>
</member>
<member name="P:UMod.ModAsyncOperation.Current">
<summary>
IEnumerator.Current imlementation.
</summary>
</member>
<member name="M:UMod.ModAsyncOperation.MoveNext">
<summary>
IEnumerator.MoveNext() implementation.
</summary>
<returns>True if the enumerator advanced successfully or false if not</returns>
</member>
<member name="M:UMod.ModAsyncOperation.Reset">
<summary>
IEnumerator.Reset() implementation.
</summary>
</member>
<member name="T:UMod.IModInfo">
<summary>
Interface exposed to the developer.
</summary>
</member>
<member name="P:UMod.IModInfo.NameInfo">
<summary>
Get the <see cref="T:UMod.IModNameInfo"/> for the mod.
</summary>
</member>
<member name="P:UMod.IModInfo.ReferenceInfo">
<summary>
Get an array of <see cref="T:UMod.IModNameInfo"/> representing the mods that this mod references.
</summary>
</member>
<member name="P:UMod.IModInfo.ModDescription">
<summary>
Get a description of the mod as specified by the creator.
</summary>
</member>
<member name="P:UMod.IModInfo.ModAuthor">
<summary>
Get the name of the person or company that created the mod.
</summary>
</member>
<member name="P:UMod.IModInfo.ModCoreVersion">
<summary>
Get the uMod 2.0 version that the mod was build with.
</summary>
</member>
<member name="P:UMod.IModInfo.ModUnityVersion">
<summary>
Get the unity version that created this mod and is required for loading.
</summary>
</member>
<member name="M:UMod.IModInfo.GetModUniqueIdentifier">
<summary>
Get the 8-byte identifier code for the mod.
</summary>
<returns></returns>
</member>
<member name="M:UMod.IModInfo.GetModContentMask">
<summary>
Get a masked value containing the included types of content.
</summary>
<returns></returns>
</member>
<member name="T:System.Security.Cryptography.HashAlgorithmName">
<summary>
Specifies the name of a cryptographic hash algorithm.
</summary>
<remarks>
Asymmetric Algorithms implemented using Microsoft's CNG (Cryptography Next Generation) API
will interpret the underlying string value as a CNG algorithm identifier:
* https://msdn.microsoft.com/en-us/library/windows/desktop/aa375534(v=vs.85).aspx
As with CNG, the names are case-sensitive.
Asymmetric Algorithms implemented using other technologies:
* Must recognize at least "MD5", "SHA1", "SHA256", "SHA384", and "SHA512".
* Should recognize additional CNG IDs for any other hash algorithms that they also support.
</remarks>
</member>
<member name="P:System.Security.Cryptography.HashAlgorithmName.MD5">
<summary>
Gets a <see cref="T:System.Security.Cryptography.HashAlgorithmName" /> representing "MD5"
</summary>
</member>
<member name="P:System.Security.Cryptography.HashAlgorithmName.SHA1">
<summary>
Gets a <see cref="T:System.Security.Cryptography.HashAlgorithmName" /> representing "SHA1"
</summary>
</member>
<member name="P:System.Security.Cryptography.HashAlgorithmName.SHA256">
<summary>
Gets a <see cref="T:System.Security.Cryptography.HashAlgorithmName" /> representing "SHA256"
</summary>
</member>
<member name="P:System.Security.Cryptography.HashAlgorithmName.SHA384">
<summary>
Gets a <see cref="T:System.Security.Cryptography.HashAlgorithmName" /> representing "SHA384"
</summary>
</member>
<member name="P:System.Security.Cryptography.HashAlgorithmName.SHA512">
<summary>
Gets a <see cref="T:System.Security.Cryptography.HashAlgorithmName" /> representing "SHA512"
</summary>
</member>
<member name="M:System.Security.Cryptography.HashAlgorithmName.#ctor(System.String)">
<summary>
Gets a <see cref="T:System.Security.Cryptography.HashAlgorithmName" /> representing a custom name.
</summary>
<param name="name">The custom hash algorithm name.</param>
</member>
<member name="P:System.Security.Cryptography.HashAlgorithmName.Name">
<summary>
Gets the underlying string representation of the algorithm name.
</summary>
<remarks>
May be null or empty to indicate that no hash algorithm is applicable.
</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Checksum.Adler32">
<summary>
Computes Adler32 checksum for a stream of data. An Adler32
checksum is not as reliable as a CRC32 checksum, but a lot faster to
compute.
The specification for Adler32 may be found in RFC 1950.
ZLIB Compressed Data Format Specification version 3.3)
From that document:
"ADLER32 (Adler-32 checksum)
This contains a checksum value of the uncompressed data
(excluding any dictionary data) computed according to Adler-32
algorithm. This algorithm is a 32-bit extension and improvement
of the Fletcher algorithm, used in the ITU-T X.224 / ISO 8073
standard.
Adler-32 is composed of two sums accumulated per byte: s1 is
the sum of all bytes, s2 is the sum of all s1 values. Both sums
are done modulo 65521. s1 is initialized to 1, s2 to zero. The
Adler-32 checksum is stored as s2*65536 + s1 in most-
significant-byte first (network) order."
"8.2. The Adler-32 algorithm
The Adler-32 algorithm is much faster than the CRC32 algorithm yet
still provides an extremely low probability of undetected errors.
The modulo on unsigned long accumulators can be delayed for 5552
bytes, so the modulo operation time is negligible. If the bytes
are a, b, c, the second sum is 3a + 2b + c + 3, and so is position
and order sensitive, unlike the first sum, which is just a
checksum. That 65521 is prime is important to avoid a possible
large class of two-byte errors that leave the check unchanged.
(The Fletcher checksum uses 255, which is not prime and which also
makes the Fletcher check insensitive to single byte changes 0 -
255.)
The sum s1 is initialized to 1 instead of zero to make the length
of the sequence part of s2, so that the length does not have to be
checked separately. (Any sequence of zeroes has a Fletcher
checksum of zero.)"
</summary>
<see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream"/>
<see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream"/>
</member>
<member name="F:ICSharpCode.SharpZipLib.Checksum.Adler32.BASE">
<summary>
largest prime smaller than 65536
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Checksum.Adler32.checkValue">
<summary>
The CRC data checksum so far.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.#ctor">
<summary>
Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Checksum.Adler32"></see>
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.Reset">
<summary>
Resets the Adler32 data checksum as if no update was ever called.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Checksum.Adler32.Value">
<summary>
Returns the Adler32 data checksum computed so far.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.Update(System.Int32)">
<summary>
Updates the checksum with the byte b.
</summary>
<param name="bval">
The data value to add. The high byte of the int is ignored.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.Update(System.Byte[])">
<summary>
Updates the Adler32 data checksum with the bytes taken from
a block of data.
</summary>
<param name="buffer">Contains the data to update the checksum with.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.Update(System.ArraySegment{System.Byte})">
<summary>
Update Adler32 data checksum based on a portion of a block of data
</summary>
<param name = "segment">
The chunk of data to add
</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Checksum.BZip2Crc">
<summary>
CRC-32 with unreversed data and reversed output
</summary>
<remarks>
Generate a table for a byte-wise 32-bit CRC calculation on the polynomial:
x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x^1+x^0.
Polynomials over GF(2) are represented in binary, one bit per coefficient,
with the lowest powers in the most significant bit. Then adding polynomials
is just exclusive-or, and multiplying a polynomial by x is a right shift by
one. If we call the above polynomial p, and represent a byte as the
polynomial q, also with the lowest power in the most significant bit (so the
byte 0xb1 is the polynomial x^7+x^3+x+1), then the CRC is (q*x^32) mod p,
where a mod b means the remainder after dividing a by b.
This calculation is done using the shift-register method of multiplying and
taking the remainder. The register is initialized to zero, and for each
incoming bit, x^32 is added mod p to the register if the bit is a one (where
x^32 mod p is p+x^32 = x^26+...+1), and the register is multiplied mod p by
x (which is shifting right by one and adding x^32 mod p if the bit shifted
out is a one). We start with the highest power (least significant bit) of
q and repeat for all eight bits of q.
The table is simply the CRC of all possible eight bit values. This is all
the information needed to generate CRC's on data a byte at a time for all
combinations of CRC register values and incoming bytes.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.checkValue">
<summary>
The CRC data checksum so far.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.#ctor">
<summary>
Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Checksum.BZip2Crc"></see>
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Reset">
<summary>
Resets the CRC data checksum as if no update was ever called.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Value">
<summary>
Returns the CRC data checksum computed so far.
</summary>
<remarks>Reversed Out = true</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Update(System.Int32)">
<summary>
Updates the checksum with the int bval.
</summary>
<param name = "bval">
the byte is taken as the lower 8 bits of bval
</param>
<remarks>Reversed Data = false</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Update(System.Byte[])">
<summary>
Updates the CRC data checksum with the bytes taken from
a block of data.
</summary>
<param name="buffer">Contains the data to update the CRC with.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Update(System.ArraySegment{System.Byte})">
<summary>
Update CRC data checksum based on a portion of a block of data
</summary>
<param name = "segment">
The chunk of data to add
</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Checksum.Crc32">
<summary>
CRC-32 with reversed data and unreversed output
</summary>
<remarks>
Generate a table for a byte-wise 32-bit CRC calculation on the polynomial:
x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x^1+x^0.
Polynomials over GF(2) are represented in binary, one bit per coefficient,
with the lowest powers in the most significant bit. Then adding polynomials
is just exclusive-or, and multiplying a polynomial by x is a right shift by
one. If we call the above polynomial p, and represent a byte as the
polynomial q, also with the lowest power in the most significant bit (so the
byte 0xb1 is the polynomial x^7+x^3+x+1), then the CRC is (q*x^32) mod p,
where a mod b means the remainder after dividing a by b.
This calculation is done using the shift-register method of multiplying and
taking the remainder. The register is initialized to zero, and for each
incoming bit, x^32 is added mod p to the register if the bit is a one (where
x^32 mod p is p+x^32 = x^26+...+1), and the register is multiplied mod p by
x (which is shifting right by one and adding x^32 mod p if the bit shifted
out is a one). We start with the highest power (least significant bit) of
q and repeat for all eight bits of q.
The table is simply the CRC of all possible eight bit values. This is all
the information needed to generate CRC's on data a byte at a time for all
combinations of CRC register values and incoming bytes.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Checksum.Crc32.checkValue">
<summary>
The CRC data checksum so far.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.#ctor">
<summary>
Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Checksum.Crc32"></see>
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Reset">
<summary>
Resets the CRC data checksum as if no update was ever called.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Checksum.Crc32.Value">
<summary>
Returns the CRC data checksum computed so far.
</summary>
<remarks>Reversed Out = false</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Update(System.Int32)">
<summary>
Updates the checksum with the int bval.
</summary>
<param name = "bval">
the byte is taken as the lower 8 bits of bval
</param>
<remarks>Reversed Data = true</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Update(System.Byte[])">
<summary>
Updates the CRC data checksum with the bytes taken from
a block of data.
</summary>
<param name="buffer">Contains the data to update the CRC with.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Update(System.ArraySegment{System.Byte})">
<summary>
Update CRC data checksum based on a portion of a block of data
</summary>
<param name = "segment">
The chunk of data to add
</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Checksum.IChecksum">
<summary>
Interface to compute a data checksum used by checked input/output streams.
A data checksum can be updated by one byte or with a byte array. After each
update the value of the current checksum can be returned by calling
<code>getValue</code>. The complete checksum object can also be reset
so it can be used again with new data.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.IChecksum.Reset">
<summary>
Resets the data checksum as if no update was ever called.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Checksum.IChecksum.Value">
<summary>
Returns the data checksum computed so far.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.IChecksum.Update(System.Int32)">
<summary>
Adds one byte to the data checksum.
</summary>
<param name = "bval">
the data value to add. The high byte of the int is ignored.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.IChecksum.Update(System.Byte[])">
<summary>
Updates the data checksum with the bytes taken from the array.
</summary>
<param name="buffer">
buffer an array of bytes
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Checksum.IChecksum.Update(System.ArraySegment{System.Byte})">
<summary>
Adds the byte array to the data checksum.
</summary>
<param name = "segment">
The chunk of data to add
</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater">
<summary>
This is the Deflater class. The deflater class compresses input
with the deflate algorithm described in RFC 1951. It has several
compression levels and three different strategies described below.
This class is <i>not</i> thread safe. This is inherent in the API, due
to the split of deflate and setInput.
author of the original java version : Jochen Hoenicke
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.BEST_COMPRESSION">
<summary>
The best and slowest compression level. This tries to find very
long and distant string repetitions.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.BEST_SPEED">
<summary>
The worst but fastest compression level.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.DEFAULT_COMPRESSION">
<summary>
The default compression level.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.NO_COMPRESSION">
<summary>
This level won't compress at all but output uncompressed blocks.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.DEFLATED">
<summary>
The compression method. This is the only method supported so far.
There is no need to use this constant at all.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel">
<summary>
Compression Level as an enum for safer use
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.BEST_COMPRESSION">
<summary>
The best and slowest compression level. This tries to find very
long and distant string repetitions.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.BEST_SPEED">
<summary>
The worst but fastest compression level.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.DEFAULT_COMPRESSION">
<summary>
The default compression level.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.NO_COMPRESSION">
<summary>
This level won't compress at all but output uncompressed blocks.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.DEFLATED">
<summary>
The compression method. This is the only method supported so far.
There is no need to use this constant at all.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.#ctor">
<summary>
Creates a new deflater with default compression level.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.#ctor(System.Int32)">
<summary>
Creates a new deflater with given compression level.
</summary>
<param name="level">
the compression level, a value between NO_COMPRESSION
and BEST_COMPRESSION, or DEFAULT_COMPRESSION.
</param>
<exception cref="T:System.ArgumentOutOfRangeException">if lvl is out of range.</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.#ctor(System.Int32,System.Boolean)">
<summary>
Creates a new deflater with given compression level.
</summary>
<param name="level">
the compression level, a value between NO_COMPRESSION
and BEST_COMPRESSION.
</param>
<param name="noZlibHeaderOrFooter">
true, if we should suppress the Zlib/RFC1950 header at the
beginning and the adler checksum at the end of the output. This is
useful for the GZIP/PKZIP formats.
</param>
<exception cref="T:System.ArgumentOutOfRangeException">if lvl is out of range.</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Reset">
<summary>
Resets the deflater. The deflater acts afterwards as if it was
just created with the same compression level and strategy as it
had before.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Adler">
<summary>
Gets the current adler checksum of the data that was processed so far.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.TotalIn">
<summary>
Gets the number of input bytes processed so far.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.TotalOut">
<summary>
Gets the number of output bytes so far.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Flush">
<summary>
Flushes the current input block. Further calls to deflate() will
produce enough output to inflate everything in the current input
block. This is not part of Sun's JDK so I have made it package
private. It is used by DeflaterOutputStream to implement
flush().
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Finish">
<summary>
Finishes the deflater with the current input block. It is an error
to give more input after this method was called. This method must
be called to force all bytes to be flushed.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.IsFinished">
<summary>
Returns true if the stream was finished and no more output bytes
are available.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.IsNeedingInput">
<summary>
Returns true, if the input buffer is empty.
You should then call setInput().
NOTE: This method can also return true when the stream
was finished.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetInput(System.Byte[])">
<summary>
Sets the data which should be compressed next. This should be only
called when needsInput indicates that more input is needed.
If you call setInput when needsInput() returns false, the
previous input that is still pending will be thrown away.
The given byte array should not be changed, before needsInput() returns
true again.
This call is equivalent to <code>setInput(input, 0, input.length)</code>.
</summary>
<param name="input">
the buffer containing the input data.
</param>
<exception cref="T:System.InvalidOperationException">
if the buffer was finished() or ended().
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetInput(System.Byte[],System.Int32,System.Int32)">
<summary>
Sets the data which should be compressed next. This should be
only called when needsInput indicates that more input is needed.
The given byte array should not be changed, before needsInput() returns
true again.
</summary>
<param name="input">
the buffer containing the input data.
</param>
<param name="offset">
the start of the data.
</param>
<param name="count">
the number of data bytes of input.
</param>
<exception cref="T:System.InvalidOperationException">
if the buffer was Finish()ed or if previous input is still pending.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetLevel(System.Int32)">
<summary>
Sets the compression level. There is no guarantee of the exact
position of the change, but if you call this when needsInput is
true the change of compression level will occur somewhere near
before the end of the so far given input.
</summary>
<param name="level">
the new compression level.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.GetLevel">
<summary>
Get current compression level
</summary>
<returns>Returns the current compression level</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetStrategy(ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy)">
<summary>
Sets the compression strategy. Strategy is one of
DEFAULT_STRATEGY, HUFFMAN_ONLY and FILTERED. For the exact
position where the strategy is changed, the same as for
SetLevel() applies.
</summary>
<param name="strategy">
The new compression strategy.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Deflate(System.Byte[])">
<summary>
Deflates the current input block with to the given array.
</summary>
<param name="output">
The buffer where compressed data is stored
</param>
<returns>
The number of compressed bytes added to the output, or 0 if either
IsNeedingInput() or IsFinished returns true or length is zero.
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Deflate(System.Byte[],System.Int32,System.Int32)">
<summary>
Deflates the current input block to the given array.
</summary>
<param name="output">
Buffer to store the compressed data.
</param>
<param name="offset">
Offset into the output array.
</param>
<param name="length">
The maximum number of bytes that may be stored.
</param>
<returns>
The number of compressed bytes added to the output, or 0 if either
needsInput() or finished() returns true or length is zero.
</returns>
<exception cref="T:System.InvalidOperationException">
If Finish() was previously called.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
If offset or length don't match the array length.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetDictionary(System.Byte[])">
<summary>
Sets the dictionary which should be used in the deflate process.
This call is equivalent to <code>setDictionary(dict, 0, dict.Length)</code>.
</summary>
<param name="dictionary">
the dictionary.
</param>
<exception cref="T:System.InvalidOperationException">
if SetInput () or Deflate () were already called or another dictionary was already set.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetDictionary(System.Byte[],System.Int32,System.Int32)">
<summary>
Sets the dictionary which should be used in the deflate process.
The dictionary is a byte array containing strings that are
likely to occur in the data which should be compressed. The
dictionary is not stored in the compressed output, only a
checksum. To decompress the output you need to supply the same
dictionary again.
</summary>
<param name="dictionary">
The dictionary data
</param>
<param name="index">
The index where dictionary information commences.
</param>
<param name="count">
The number of bytes in the dictionary.
</param>
<exception cref="T:System.InvalidOperationException">
If SetInput () or Deflate() were already called or another dictionary was already set.
</exception>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.level">
<summary>
Compression level.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.noZlibHeaderOrFooter">
<summary>
If true no Zlib/RFC1950 headers or footers are generated
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.state">
<summary>
The current state.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.totalOut">
<summary>
The total bytes of output written.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.pending">
<summary>
The pending output.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.engine">
<summary>
The deflater engine.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants">
<summary>
This class contains constants used for deflation.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEBUGGING">
<summary>
Set to true to enable debugging
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.STORED_BLOCK">
<summary>
Written to Zip file to identify a stored block
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.STATIC_TREES">
<summary>
Identifies static tree in Zip file
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DYN_TREES">
<summary>
Identifies dynamic tree in Zip file
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.PRESET_DICT">
<summary>
Header flag indicating a preset dictionary for deflation
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFAULT_MEM_LEVEL">
<summary>
Sets internal buffer sizes for Huffman encoding
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_MATCH">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MIN_MATCH">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_WBITS">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.WSIZE">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.WMASK">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_BITS">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_SIZE">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_MASK">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_SHIFT">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MIN_LOOKAHEAD">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_DIST">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.PENDING_BUF_SIZE">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_BLOCK_SIZE">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_STORED">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_FAST">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_SLOW">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.GOOD_LENGTH">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_LAZY">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.NICE_LENGTH">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_CHAIN">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.COMPR_FUNC">
<summary>
Internal compression engine constant
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy">
<summary>
Strategies for deflater
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy.Default">
<summary>
The default strategy
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy.Filtered">
<summary>
This strategy will only allow longer string repetitions. It is
useful for random data with a small character set.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy.HuffmanOnly">
<summary>
This strategy will not look for string repetitions at all. It
only encodes with Huffman trees (which means, that more common
characters get a smaller encoding.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine">
<summary>
Low level compression engine for deflate algorithm which uses a 32K sliding window
with secondary compression from Huffman/Shannon-Fano codes.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.#ctor(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending)">
<summary>
Construct instance with pending buffer
Adler calculation will be peformed
</summary>
<param name="pending">
Pending buffer to use
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.#ctor(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending,System.Boolean)">
<summary>
Construct instance with pending buffer
</summary>
<param name="pending">
Pending buffer to use
</param>
<param name="noAdlerCalculation">
If no adler calculation should be performed
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.Deflate(System.Boolean,System.Boolean)">
<summary>
Deflate drives actual compression of data
</summary>
<param name="flush">True to flush input buffers</param>
<param name="finish">Finish deflation with the current input.</param>
<returns>Returns true if progress has been made.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetInput(System.Byte[],System.Int32,System.Int32)">
<summary>
Sets input data to be deflated. Should only be called when <code>NeedsInput()</code>
returns true
</summary>
<param name="buffer">The buffer containing input data.</param>
<param name="offset">The offset of the first byte of data.</param>
<param name="count">The number of bytes of data to use as input.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.NeedsInput">
<summary>
Determines if more <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetInput(System.Byte[],System.Int32,System.Int32)">input</see> is needed.
</summary>
<returns>Return true if input is needed via <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetInput(System.Byte[],System.Int32,System.Int32)">SetInput</see></returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetDictionary(System.Byte[],System.Int32,System.Int32)">
<summary>
Set compression dictionary
</summary>
<param name="buffer">The buffer containing the dictionary data</param>
<param name="offset">The offset in the buffer for the first byte of data</param>
<param name="length">The length of the dictionary data.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.Reset">
<summary>
Reset internal state
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.ResetAdler">
<summary>
Reset Adler checksum
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.Adler">
<summary>
Get current value of Adler checksum
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.TotalIn">
<summary>
Total data processed
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.Strategy">
<summary>
Get/set the <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy">deflate strategy</see>
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetLevel(System.Int32)">
<summary>
Set the deflate level (0-9)
</summary>
<param name="level">The value to set the level to.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.FillWindow">
<summary>
Fill the window
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.InsertString">
<summary>
Inserts the current string in the head hash and returns the previous
value for this hash.
</summary>
<returns>The previous hash value</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.FindLongestMatch(System.Int32)">
<summary>
Find the best (longest) string in the window matching the
string starting at strstart.
Preconditions:
<code>
strstart + DeflaterConstants.MAX_MATCH &lt;= window.length.</code>
</summary>
<param name="curMatch"></param>
<returns>True if a match greater than the minimum length is found</returns>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.head">
<summary>
Hashtable, hashing three characters to an index for window, so
that window[index]..window[index+2] have this hash code.
Note that the array should really be unsigned short, so you need
to and the values with 0xffff.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.prev">
<summary>
<code>prev[index &amp; WMASK]</code> points to the previous index that has the
same hash code as the string starting at index. This way
entries with the same hash code are in a linked list.
Note that the array should really be unsigned short, so you need
to and the values with 0xffff.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.strstart">
<summary>
Points to the current character in the window.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.lookahead">
<summary>
lookahead is the number of characters starting at strstart in
window that are valid.
So window[strstart] until window[strstart+lookahead-1] are valid
characters.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.window">
<summary>
This array contains the part of the uncompressed stream that
is of relevance. The current character is indexed by strstart.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.compressionFunction">
<summary>
The current compression function.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.inputBuf">
<summary>
The input data for compression.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.totalIn">
<summary>
The total bytes of input read.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.inputOff">
<summary>
The offset into inputBuf, where input data starts.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.inputEnd">
<summary>
The end offset of the input data.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.adler">
<summary>
The adler checksum
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman">
<summary>
This is the DeflaterHuffman class.
This class is <i>not</i> thread safe. This is inherent in the API, due
to the split of Deflate and SetInput.
author of the original java version : Jochen Hoenicke
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.Reset">
<summary>
Resets the internal state of the tree
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.CheckEmpty">
<summary>
Check that all frequencies are zero
</summary>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
At least one frequency is non-zero
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.SetStaticCodes(System.Int16[],System.Byte[])">
<summary>
Set static codes and length
</summary>
<param name="staticCodes">new codes</param>
<param name="staticLengths">length for new codes</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.BuildCodes">
<summary>
Build dynamic codes and lengths
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.GetEncodedLength">
<summary>
Get encoded length
</summary>
<returns>Encoded length, the sum of frequencies * lengths</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.CalcBLFreq(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree)">
<summary>
Scan a literal or distance tree to determine the frequencies of the codes
in the bit length tree.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.WriteTree(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree)">
<summary>
Write tree values
</summary>
<param name="blTree">Tree to write</param>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.pending">
<summary>
Pending buffer to use
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.#ctor(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending)">
<summary>
Construct instance with pending buffer
</summary>
<param name="pending">Pending buffer to use</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Reset">
<summary>
Reset internal state
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.SendAllTrees(System.Int32)">
<summary>
Write all trees to pending buffer
</summary>
<param name="blTreeCodes">The number/rank of treecodes to send.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.CompressBlock">
<summary>
Compress current buffer writing data to pending buffer
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.FlushStoredBlock(System.Byte[],System.Int32,System.Int32,System.Boolean)">
<summary>
Flush block to output with no compression
</summary>
<param name="stored">Data to write</param>
<param name="storedOffset">Index of first byte to write</param>
<param name="storedLength">Count of bytes to write</param>
<param name="lastBlock">True if this is the last block</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.FlushBlock(System.Byte[],System.Int32,System.Int32,System.Boolean)">
<summary>
Flush block to output with compression
</summary>
<param name="stored">Data to flush</param>
<param name="storedOffset">Index of first byte to flush</param>
<param name="storedLength">Count of bytes to flush</param>
<param name="lastBlock">True if this is the last block</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.IsFull">
<summary>
Get value indicating if internal buffer is full
</summary>
<returns>true if buffer is full</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.TallyLit(System.Int32)">
<summary>
Add literal to buffer
</summary>
<param name="literal">Literal value to add to buffer.</param>
<returns>Value indicating internal buffer is full</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.TallyDist(System.Int32,System.Int32)">
<summary>
Add distance code and length to literal and distance trees
</summary>
<param name="distance">Distance code</param>
<param name="length">Length</param>
<returns>Value indicating if internal buffer is full</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.BitReverse(System.Int32)">
<summary>
Reverse the bits of a 16 bit value.
</summary>
<param name="toReverse">Value to reverse bits</param>
<returns>Value with bits reversed</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending">
<summary>
This class stores the pending output of the Deflater.
author of the original java version : Jochen Hoenicke
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending.#ctor">
<summary>
Construct instance with default buffer size
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Inflater">
<summary>
Inflater is used to decompress data that has been compressed according
to the "deflate" standard described in rfc1951.
By default Zlib (rfc1950) headers and footers are expected in the input.
You can use constructor <code> public Inflater(bool noHeader)</code> passing true
if there is no Zlib header information
The usage is as following. First you have to set some input with
<code>SetInput()</code>, then Inflate() it. If inflate doesn't
inflate any bytes there may be three reasons:
<ul>
<li>IsNeedingInput() returns true because the input buffer is empty.
You have to provide more input with <code>SetInput()</code>.
NOTE: IsNeedingInput() also returns true when, the stream is finished.
</li>
<li>IsNeedingDictionary() returns true, you have to provide a preset
dictionary with <code>SetDictionary()</code>.</li>
<li>IsFinished returns true, the inflater has finished.</li>
</ul>
Once the first output byte is produced, a dictionary will not be
needed at a later stage.
author of the original java version : John Leuner, Jochen Hoenicke
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.CPLENS">
<summary>
Copy lengths for literal codes 257..285
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.CPLEXT">
<summary>
Extra bits for literal codes 257..285
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.CPDIST">
<summary>
Copy offsets for distance codes 0..29
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.CPDEXT">
<summary>
Extra bits for distance codes
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DECODE_HEADER">
<summary>
These are the possible states for an inflater
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.mode">
<summary>
This variable contains the current state.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.readAdler">
<summary>
The adler checksum of the dictionary or of the decompressed
stream, as it is written in the header resp. footer of the
compressed stream.
Only valid if mode is DECODE_DICT or DECODE_CHKSUM.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.neededBits">
<summary>
The number of bits needed to complete the current state. This
is valid, if mode is DECODE_DICT, DECODE_CHKSUM,
DECODE_HUFFMAN_LENBITS or DECODE_HUFFMAN_DISTBITS.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.isLastBlock">
<summary>
True, if the last block flag was set in the last block of the
inflated stream. This means that the stream ends after the
current block.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.totalOut">
<summary>
The total number of inflated bytes.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.totalIn">
<summary>
The total number of bytes set with setInput(). This is not the
value returned by the TotalIn property, since this also includes the
unprocessed input.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.noHeader">
<summary>
This variable stores the noHeader flag that was given to the constructor.
True means, that the inflated stream doesn't contain a Zlib header or
footer.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.#ctor">
<summary>
Creates a new inflater or RFC1951 decompressor
RFC1950/Zlib headers and footers will be expected in the input data
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.#ctor(System.Boolean)">
<summary>
Creates a new inflater.
</summary>
<param name="noHeader">
True if no RFC1950/Zlib header and footer fields are expected in the input data
This is used for GZIPed/Zipped input.
For compatibility with
Sun JDK you should provide one byte of input more than needed in
this case.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Reset">
<summary>
Resets the inflater so that a new stream can be decompressed. All
pending input and output will be discarded.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DecodeHeader">
<summary>
Decodes a zlib/RFC1950 header.
</summary>
<returns>
False if more input is needed.
</returns>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
The header is invalid.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DecodeDict">
<summary>
Decodes the dictionary checksum after the deflate header.
</summary>
<returns>
False if more input is needed.
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DecodeHuffman">
<summary>
Decodes the huffman encoded symbols in the input stream.
</summary>
<returns>
false if more input is needed, true if output window is
full or the current block ends.
</returns>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
if deflated stream is invalid.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DecodeChksum">
<summary>
Decodes the adler checksum after the deflate stream.
</summary>
<returns>
false if more input is needed.
</returns>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
If checksum doesn't match.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Decode">
<summary>
Decodes the deflated stream.
</summary>
<returns>
false if more input is needed, or if finished.
</returns>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
if deflated stream is invalid.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetDictionary(System.Byte[])">
<summary>
Sets the preset dictionary. This should only be called, if
needsDictionary() returns true and it should set the same
dictionary, that was used for deflating. The getAdler()
function returns the checksum of the dictionary needed.
</summary>
<param name="buffer">
The dictionary.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetDictionary(System.Byte[],System.Int32,System.Int32)">
<summary>
Sets the preset dictionary. This should only be called, if
needsDictionary() returns true and it should set the same
dictionary, that was used for deflating. The getAdler()
function returns the checksum of the dictionary needed.
</summary>
<param name="buffer">
The dictionary.
</param>
<param name="index">
The index into buffer where the dictionary starts.
</param>
<param name="count">
The number of bytes in the dictionary.
</param>
<exception cref="T:System.InvalidOperationException">
No dictionary is needed.
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
The adler checksum for the buffer is invalid
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetInput(System.Byte[])">
<summary>
Sets the input. This should only be called, if needsInput()
returns true.
</summary>
<param name="buffer">
the input.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetInput(System.Byte[],System.Int32,System.Int32)">
<summary>
Sets the input. This should only be called, if needsInput()
returns true.
</summary>
<param name="buffer">
The source of input data
</param>
<param name="index">
The index into buffer where the input starts.
</param>
<param name="count">
The number of bytes of input to use.
</param>
<exception cref="T:System.InvalidOperationException">
No input is needed.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
The index and/or count are wrong.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Inflate(System.Byte[])">
<summary>
Inflates the compressed stream to the output buffer. If this
returns 0, you should check, whether IsNeedingDictionary(),
IsNeedingInput() or IsFinished() returns true, to determine why no
further output is produced.
</summary>
<param name="buffer">
the output buffer.
</param>
<returns>
The number of bytes written to the buffer, 0 if no further
output can be produced.
</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
if buffer has length 0.
</exception>
<exception cref="T:System.FormatException">
if deflated stream is invalid.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Inflate(System.Byte[],System.Int32,System.Int32)">
<summary>
Inflates the compressed stream to the output buffer. If this
returns 0, you should check, whether needsDictionary(),
needsInput() or finished() returns true, to determine why no
further output is produced.
</summary>
<param name="buffer">
the output buffer.
</param>
<param name="offset">
the offset in buffer where storing starts.
</param>
<param name="count">
the maximum number of bytes to output.
</param>
<returns>
the number of bytes written to the buffer, 0 if no further output can be produced.
</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
if count is less than 0.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
if the index and / or count are wrong.
</exception>
<exception cref="T:System.FormatException">
if deflated stream is invalid.
</exception>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.IsNeedingInput">
<summary>
Returns true, if the input buffer is empty.
You should then call setInput().
NOTE: This method also returns true when the stream is finished.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.IsNeedingDictionary">
<summary>
Returns true, if a preset dictionary is needed to inflate the input.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.IsFinished">
<summary>
Returns true, if the inflater has finished. This means, that no
input is needed and no output can be produced.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Adler">
<summary>
Gets the adler checksum. This is either the checksum of all
uncompressed bytes returned by inflate(), or if needsDictionary()
returns true (and thus no output was yet produced) this is the
adler checksum of the expected dictionary.
</summary>
<returns>
the adler checksum.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.TotalOut">
<summary>
Gets the total number of output bytes returned by Inflate().
</summary>
<returns>
the total number of output bytes.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.TotalIn">
<summary>
Gets the total number of processed compressed input bytes.
</summary>
<returns>
The total number of bytes of processed input bytes.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.RemainingInput">
<summary>
Gets the number of unprocessed input bytes. Useful, if the end of the
stream is reached and you want to further process the bytes after
the deflate stream.
</summary>
<returns>
The number of bytes of the input which have not been processed.
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.AttemptRead">
<summary>
Continue decoding header from <see cref="F:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.input"/> until more bits are needed or decoding has been completed
</summary>
<returns>Returns whether decoding could be completed</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.LiteralLengthTree">
<summary>
Get literal/length huffman tree, must not be used before <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.AttemptRead"/> has returned true
</summary>
<exception cref="T:ICSharpCode.SharpZipLib.StreamDecodingException">If hader has not been successfully read by the state machine</exception>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.DistanceTree">
<summary>
Get distance huffman tree, must not be used before <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.AttemptRead"/> has returned true
</summary>
<exception cref="T:ICSharpCode.SharpZipLib.StreamDecodingException">If hader has not been successfully read by the state machine</exception>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree">
<summary>
Huffman tree used for inflation
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.defLitLenTree">
<summary>
Literal length tree
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.defDistTree">
<summary>
Distance tree
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.#ctor(System.Collections.Generic.IList{System.Byte})">
<summary>
Constructs a Huffman tree from the array of code lengths.
</summary>
<param name = "codeLengths">
the array of code lengths
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.GetSymbol(ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator)">
<summary>
Reads the next symbol from input. The symbol is encoded using the
huffman tree.
</summary>
<param name="input">
input the input source.
</param>
<returns>
the next symbol, or -1 if not enough input is available.
</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer">
<summary>
This class is general purpose class for writing data to a buffer.
It allows you to write bits as well as bytes
Based on DeflaterPending.java
author of the original java version : Jochen Hoenicke
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.buffer">
<summary>
Internal work buffer
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.#ctor">
<summary>
construct instance using default buffer size of 4096
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.#ctor(System.Int32)">
<summary>
construct instance using specified buffer size
</summary>
<param name="bufferSize">
size to use for internal buffer
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.Reset">
<summary>
Clear internal state/buffers
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteByte(System.Int32)">
<summary>
Write a byte to buffer
</summary>
<param name="value">
The value to write
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteShort(System.Int32)">
<summary>
Write a short value to buffer LSB first
</summary>
<param name="value">
The value to write.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteInt(System.Int32)">
<summary>
write an integer LSB first
</summary>
<param name="value">The value to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Write a block of data to buffer
</summary>
<param name="block">data to write</param>
<param name="offset">offset of first byte to write</param>
<param name="length">number of bytes to write</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.BitCount">
<summary>
The number of bits written to the buffer
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.AlignToByte">
<summary>
Align internal buffer on a byte boundary
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteBits(System.Int32,System.Int32)">
<summary>
Write bits to internal buffer
</summary>
<param name="b">source of bits</param>
<param name="count">number of bits to write</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteShortMSB(System.Int32)">
<summary>
Write a short value to internal buffer most significant byte first
</summary>
<param name="s">value to write</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.IsFlushed">
<summary>
Indicates if buffer has been flushed
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.Flush(System.Byte[],System.Int32,System.Int32)">
<summary>
Flushes the pending buffer into the given output array. If the
output array is to small, only a partial flush is done.
</summary>
<param name="output">The output array.</param>
<param name="offset">The offset into output array.</param>
<param name="length">The maximum number of bytes to store.</param>
<returns>The number of bytes flushed.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.ToByteArray">
<summary>
Convert internal buffer to byte array.
Buffer is empty on completion
</summary>
<returns>
The internal buffer contents converted to a byte array.
</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream">
<summary>
A special stream deflating or compressing the bytes that are
written to it. It uses a Deflater to perform actual deflating.<br/>
Authors of the original java version : Tom Tromey, Jochen Hoenicke
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream)">
<summary>
Creates a new DeflaterOutputStream with a default Deflater and default buffer size.
</summary>
<param name="baseOutputStream">
the output stream where deflated output should be written.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Deflater)">
<summary>
Creates a new DeflaterOutputStream with the given Deflater and
default buffer size.
</summary>
<param name="baseOutputStream">
the output stream where deflated output should be written.
</param>
<param name="deflater">
the underlying deflater.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Deflater,System.Int32)">
<summary>
Creates a new DeflaterOutputStream with the given Deflater and
buffer size.
</summary>
<param name="baseOutputStream">
The output stream where deflated output is written.
</param>
<param name="deflater">
The underlying deflater to use
</param>
<param name="bufferSize">
The buffer size in bytes to use when deflating (minimum value 512)
</param>
<exception cref="T:System.ArgumentOutOfRangeException">
bufsize is less than or equal to zero.
</exception>
<exception cref="T:System.ArgumentException">
baseOutputStream does not support writing
</exception>
<exception cref="T:System.ArgumentNullException">
deflater instance is null
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Finish">
<summary>
Finishes the stream by calling finish() on the deflater.
</summary>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
Not all input is deflated
</exception>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.IsStreamOwner">
<summary>
Gets or sets a flag indicating ownership of underlying stream.
When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
</summary>
<remarks>The default value is true.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanPatchEntries">
<summary>
Allows client to determine if an entry can be patched after its added
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.AESAuthCode">
<summary>
Returns the 10 byte AUTH CODE to be appended immediately following the AES data stream.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Password">
<summary>
Get/set the password used for encryption.
</summary>
<remarks>When set to null or if the password is empty no encryption is performed</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.EncryptBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Encrypt a block of data
</summary>
<param name="buffer">
Data to encrypt. NOTE the original contents of the buffer are lost
</param>
<param name="offset">
Offset of first byte in buffer to encrypt
</param>
<param name="length">
Number of bytes in buffer to encrypt
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.InitializePassword(System.String)">
<summary>
Initializes encryption keys based on given <paramref name="password"/>.
</summary>
<param name="password">The password.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.InitializeAESPassword(ICSharpCode.SharpZipLib.Zip.ZipEntry,System.String,System.Byte[]@,System.Byte[]@)">
<summary>
Initializes encryption keys based on given password.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Deflate">
<summary>
Deflates everything in the input buffers. This will call
<code>def.deflate()</code> until all bytes from the input buffers
are processed.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanRead">
<summary>
Gets value indicating stream can be read from
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanSeek">
<summary>
Gets a value indicating if seeking is supported for this stream
This property always returns false
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanWrite">
<summary>
Get value indicating if this stream supports writing
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Length">
<summary>
Get current length of stream
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Position">
<summary>
Gets the current position within the stream.
</summary>
<exception cref="T:System.NotSupportedException">Any attempt to set position</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the current position of this stream to the given value. Not supported by this class!
</summary>
<param name="offset">The offset relative to the <paramref name="origin"/> to seek.</param>
<param name="origin">The <see cref="T:System.IO.SeekOrigin"/> to seek from.</param>
<returns>The new position in the stream.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.SetLength(System.Int64)">
<summary>
Sets the length of this stream to the given value. Not supported by this class!
</summary>
<param name="value">The new stream length.</param>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.ReadByte">
<summary>
Read a byte from stream advancing position by one
</summary>
<returns>The byte read cast to an int. THe value is -1 if at the end of the stream.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read a block of bytes from stream
</summary>
<param name="buffer">The buffer to store read data in.</param>
<param name="offset">The offset to start storing at.</param>
<param name="count">The maximum number of bytes to read.</param>
<returns>The actual number of bytes read. Zero if end of stream is detected.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Flush">
<summary>
Flushes the stream by calling <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Flush">Flush</see> on the deflater and then
on the underlying stream. This ensures that all bytes are flushed.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Dispose(System.Boolean)">
<summary>
Calls <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Finish"/> and closes the underlying
stream when <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.IsStreamOwner"></see> is true.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.WriteByte(System.Byte)">
<summary>
Writes a single byte to the compressed output stream.
</summary>
<param name="value">
The byte value.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes bytes from an array to the compressed stream.
</summary>
<param name="buffer">
The byte array
</param>
<param name="offset">
The offset into the byte array where to start.
</param>
<param name="count">
The number of bytes to write.
</param>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.buffer_">
<summary>
This buffer is used temporarily to retrieve the bytes from the
deflater and write them to the underlying output stream.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.deflater_">
<summary>
The deflater which is used to deflate the stream.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.baseOutputStream_">
<summary>
Base stream the deflater depends on.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer">
<summary>
An input buffer customised for use by <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream"/>
</summary>
<remarks>
The buffer supports decryption of incoming data.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.#ctor(System.IO.Stream)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer"/> with a default buffer size
</summary>
<param name="stream">The stream to buffer.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.#ctor(System.IO.Stream,System.Int32)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer"/>
</summary>
<param name="stream">The stream to buffer.</param>
<param name="bufferSize">The size to use for the buffer</param>
<remarks>A minimum buffer size of 1KB is permitted. Lower sizes are treated as 1KB.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.RawLength">
<summary>
Get the length of bytes bytes in the <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.RawData"/>
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.RawData">
<summary>
Get the contents of the raw data buffer.
</summary>
<remarks>This may contain encrypted data.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ClearTextLength">
<summary>
Get the number of useable bytes in <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ClearText"/>
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ClearText">
<summary>
Get the contents of the clear text buffer.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.Available">
<summary>
Get/set the number of bytes available
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.SetInflaterInput(ICSharpCode.SharpZipLib.Zip.Compression.Inflater)">
<summary>
Call <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetInput(System.Byte[],System.Int32,System.Int32)"/> passing the current clear text buffer contents.
</summary>
<param name="inflater">The inflater to set input for.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.Fill">
<summary>
Fill the buffer from the underlying input stream.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadRawBuffer(System.Byte[])">
<summary>
Read a buffer directly from the input stream
</summary>
<param name="buffer">The buffer to fill</param>
<returns>Returns the number of bytes read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadRawBuffer(System.Byte[],System.Int32,System.Int32)">
<summary>
Read a buffer directly from the input stream
</summary>
<param name="outBuffer">The buffer to read into</param>
<param name="offset">The offset to start reading data into.</param>
<param name="length">The number of bytes to read.</param>
<returns>Returns the number of bytes read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadClearTextBuffer(System.Byte[],System.Int32,System.Int32)">
<summary>
Read clear text data from the input stream.
</summary>
<param name="outBuffer">The buffer to add data to.</param>
<param name="offset">The offset to start adding data at.</param>
<param name="length">The number of bytes to read.</param>
<returns>Returns the number of bytes actually read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadLeByte">
<summary>
Read a <see cref="T:System.Byte"/> from the input stream.
</summary>
<returns>Returns the byte read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadLeShort">
<summary>
Read an <see cref="T:System.Int16"/> in little endian byte order.
</summary>
<returns>The short value read case to an int.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadLeInt">
<summary>
Read an <see cref="T:System.Int32"/> in little endian byte order.
</summary>
<returns>The int value read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadLeLong">
<summary>
Read a <see cref="T:System.Int64"/> in little endian byte order.
</summary>
<returns>The long value read.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.CryptoTransform">
<summary>
Get/set the <see cref="T:System.Security.Cryptography.ICryptoTransform"/> to apply to any data.
</summary>
<remarks>Set this value to null to have no transform applied.</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream">
<summary>
This filter stream is used to decompress data compressed using the "deflate"
format. The "deflate" format is described in RFC 1951.
This stream may form the basis for other decompression filters, such
as the <see cref="!:ICSharpCode.SharpZipLib.GZip.GZipInputStream">GZipInputStream</see>.
Author of the original java version : John Leuner.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream)">
<summary>
Create an InflaterInputStream with the default decompressor
and a default buffer size of 4KB.
</summary>
<param name = "baseInputStream">
The InputStream to read bytes from
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Inflater)">
<summary>
Create an InflaterInputStream with the specified decompressor
and a default buffer size of 4KB.
</summary>
<param name = "baseInputStream">
The source of input data
</param>
<param name = "inf">
The decompressor used to decompress data read from baseInputStream
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Inflater,System.Int32)">
<summary>
Create an InflaterInputStream with the specified decompressor
and the specified buffer size.
</summary>
<param name = "baseInputStream">
The InputStream to read bytes from
</param>
<param name = "inflater">
The decompressor to use
</param>
<param name = "bufferSize">
Size of the buffer to use
</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.IsStreamOwner">
<summary>
Gets or sets a flag indicating ownership of underlying stream.
When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
</summary>
<remarks>The default value is true.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Skip(System.Int64)">
<summary>
Skip specified number of bytes of uncompressed data
</summary>
<param name ="count">
Number of bytes to skip
</param>
<returns>
The number of bytes skipped, zero if the end of
stream has been reached
</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="count">The number of bytes</paramref> to skip is less than or equal to zero.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.StopDecrypting">
<summary>
Clear any cryptographic state.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Available">
<summary>
Returns 0 once the end of the stream (EOF) has been reached.
Otherwise returns 1.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Fill">
<summary>
Fills the buffer with more data to decompress.
</summary>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
Stream ends early
</exception>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.CanRead">
<summary>
Gets a value indicating whether the current stream supports reading
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.CanSeek">
<summary>
Gets a value of false indicating seeking is not supported for this stream.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.CanWrite">
<summary>
Gets a value of false indicating that this stream is not writeable.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Length">
<summary>
A value representing the length of the stream in bytes.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Position">
<summary>
The current position within the stream.
Throws a NotSupportedException when attempting to set the position
</summary>
<exception cref="T:System.NotSupportedException">Attempting to set the position</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Flush">
<summary>
Flushes the baseInputStream
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
Sets the position within the current stream
Always throws a NotSupportedException
</summary>
<param name="offset">The relative offset to seek to.</param>
<param name="origin">The <see cref="T:System.IO.SeekOrigin"/> defining where to seek from.</param>
<returns>The new position in the stream.</returns>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.SetLength(System.Int64)">
<summary>
Set the length of the current stream
Always throws a NotSupportedException
</summary>
<param name="value">The new length value for the stream.</param>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes a sequence of bytes to stream and advances the current position
This method always throws a NotSupportedException
</summary>
<param name="buffer">Thew buffer containing data to write.</param>
<param name="offset">The offset of the first byte to write.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.WriteByte(System.Byte)">
<summary>
Writes one byte to the current stream and advances the current position
Always throws a NotSupportedException
</summary>
<param name="value">The byte to write.</param>
<exception cref="T:System.NotSupportedException">Any access</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Dispose(System.Boolean)">
<summary>
Closes the input stream. When <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.IsStreamOwner"></see>
is true the underlying stream is also closed.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads decompressed data into the provided buffer byte array
</summary>
<param name ="buffer">
The array to read and decompress data into
</param>
<param name ="offset">
The offset indicating where the data should be placed
</param>
<param name ="count">
The number of bytes to decompress
</param>
<returns>The number of bytes read. Zero signals the end of stream</returns>
<exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
Inflater needs a dictionary
</exception>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.inf">
<summary>
Decompressor for this stream
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.inputBuffer">
<summary>
<see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer">Input buffer</see> for this stream.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.baseInputStream">
<summary>
Base stream the inflater reads from.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.csize">
<summary>
The compressed size
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.isClosed">
<summary>
Flag indicating wether this instance has been closed or not.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow">
<summary>
Contains the output from the Inflation process.
We need to have a window so that we can refer backwards into the output stream
to repeat stuff.<br/>
Author of the original java version : John Leuner
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Write(System.Int32)">
<summary>
Write a byte to this output window
</summary>
<param name="value">value to write</param>
<exception cref="T:System.InvalidOperationException">
if window is full
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Repeat(System.Int32,System.Int32)">
<summary>
Append a byte pattern already in the window itself
</summary>
<param name="length">length of pattern to copy</param>
<param name="distance">distance from end of window pattern occurs</param>
<exception cref="T:System.InvalidOperationException">
If the repeated data overflows the window
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyStored(ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator,System.Int32)">
<summary>
Copy from input manipulator to internal window
</summary>
<param name="input">source of data</param>
<param name="length">length of data to copy</param>
<returns>the number of bytes copied</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyDict(System.Byte[],System.Int32,System.Int32)">
<summary>
Copy dictionary to window
</summary>
<param name="dictionary">source dictionary</param>
<param name="offset">offset of start in source dictionary</param>
<param name="length">length of dictionary</param>
<exception cref="T:System.InvalidOperationException">
If window isnt empty
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetFreeSpace">
<summary>
Get remaining unfilled space in window
</summary>
<returns>Number of bytes left in window</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetAvailable">
<summary>
Get bytes available for output in window
</summary>
<returns>Number of bytes filled</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyOutput(System.Byte[],System.Int32,System.Int32)">
<summary>
Copy contents of window to output
</summary>
<param name="output">buffer to copy to</param>
<param name="offset">offset to start at</param>
<param name="len">number of bytes to count</param>
<returns>The number of bytes copied</returns>
<exception cref="T:System.InvalidOperationException">
If a window underflow occurs
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Reset">
<summary>
Reset by clearing window so <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetAvailable">GetAvailable</see> returns 0
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator">
<summary>
This class allows us to retrieve a specified number of bits from
the input buffer, as well as copy big byte blocks.
It uses an int buffer to store up to 31 bits for direct
manipulation. This guarantees that we can get at least 16 bits,
but we only need at most 15, so this is all safe.
There are some optimizations in this class, for example, you must
never peek more than 8 bits more than needed, and you must first
peek bits before you may drop them. This is not a general purpose
class but optimized for the behaviour of the Inflater.
authors of the original java version : John Leuner, Jochen Hoenicke
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.PeekBits(System.Int32)">
<summary>
Get the next sequence of bits but don't increase input pointer. bitCount must be
less or equal 16 and if this call succeeds, you must drop
at least n - 8 bits in the next call.
</summary>
<param name="bitCount">The number of bits to peek.</param>
<returns>
the value of the bits, or -1 if not enough bits available. */
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.TryGetBits(System.Int32,System.Int32@,System.Int32)">
<summary>
Tries to grab the next <paramref name="bitCount"/> bits from the input and
sets <paramref name="output"/> to the value, adding <paramref name="outputOffset"/>.
</summary>
<returns>true if enough bits could be read, otherwise false</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.TryGetBits(System.Int32,System.Byte[]@,System.Int32)">
<summary>
Tries to grab the next <paramref name="bitCount"/> bits from the input and
sets <paramref name="index"/> of <paramref name="array"/> to the value.
</summary>
<returns>true if enough bits could be read, otherwise false</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.DropBits(System.Int32)">
<summary>
Drops the next n bits from the input. You should have called PeekBits
with a bigger or equal n before, to make sure that enough bits are in
the bit buffer.
</summary>
<param name="bitCount">The number of bits to drop.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.GetBits(System.Int32)">
<summary>
Gets the next n bits and increases input pointer. This is equivalent
to <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.PeekBits(System.Int32)"/> followed by <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.DropBits(System.Int32)"/>, except for correct error handling.
</summary>
<param name="bitCount">The number of bits to retrieve.</param>
<returns>
the value of the bits, or -1 if not enough bits available.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.AvailableBits">
<summary>
Gets the number of bits available in the bit buffer. This must be
only called when a previous PeekBits() returned -1.
</summary>
<returns>
the number of bits available.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.AvailableBytes">
<summary>
Gets the number of bytes available.
</summary>
<returns>
The number of bytes available.
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.SkipToByteBoundary">
<summary>
Skips to the next byte boundary.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.IsNeedingInput">
<summary>
Returns true when SetInput can be called
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.CopyBytes(System.Byte[],System.Int32,System.Int32)">
<summary>
Copies bytes from input buffer to output buffer starting
at output[offset]. You have to make sure, that the buffer is
byte aligned. If not enough bytes are available, copies fewer
bytes.
</summary>
<param name="output">
The buffer to copy bytes to.
</param>
<param name="offset">
The offset in the buffer at which copying starts
</param>
<param name="length">
The length to copy, 0 is allowed.
</param>
<returns>
The number of bytes copied, 0 if no bytes were available.
</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
Length is less than zero
</exception>
<exception cref="T:System.InvalidOperationException">
Bit buffer isnt byte aligned
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.Reset">
<summary>
Resets state and empties internal buffers
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.SetInput(System.Byte[],System.Int32,System.Int32)">
<summary>
Add more input for consumption.
Only call when IsNeedingInput returns true
</summary>
<param name="buffer">data to be input</param>
<param name="offset">offset of first byte of input</param>
<param name="count">number of bytes of input to add.</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.UseZip64">
<summary>
Determines how entries are tested to see if they should use Zip64 extensions or not.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.Off">
<summary>
Zip64 will not be forced on entries during processing.
</summary>
<remarks>An entry can have this overridden if required <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ForceZip64"></see></remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.On">
<summary>
Zip64 should always be used.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.Dynamic">
<summary>
#ZipLib will determine use based on entry values when added to archive.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.CompressionMethod">
<summary>
The kind of compression used for an entry in an archive
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Stored">
<summary>
A direct copy of the file contents is held in the archive
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Deflated">
<summary>
Common Zip compression method using a sliding dictionary
of up to 32KB and secondary compression from Huffman/Shannon-Fano trees
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Deflate64">
<summary>
An extension to deflate with a 64KB window. Not supported by #Zip currently
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.BZip2">
<summary>
BZip2 compression. Not supported by #Zip.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.WinZipAES">
<summary>
WinZip special for AES encryption, Now supported by #Zip.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm">
<summary>
Identifies the encryption algorithm used for an entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.None">
<summary>
No encryption has been used.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.PkzipClassic">
<summary>
Encrypted using PKZIP 2.0 or 'classic' encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Des">
<summary>
DES encryption has been used.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC2">
<summary>
RC2 encryption has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.TripleDes168">
<summary>
Triple DES encryption with 168 bit keys has been used for this entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.TripleDes112">
<summary>
Triple DES with 112 bit keys has been used for this entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes128">
<summary>
AES 128 has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes192">
<summary>
AES 192 has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes256">
<summary>
AES 256 has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC2Corrected">
<summary>
RC2 corrected has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Blowfish">
<summary>
Blowfish has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Twofish">
<summary>
Twofish has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC4">
<summary>
RC4 has been used for encryption.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Unknown">
<summary>
An unknown algorithm has been used for encryption.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags">
<summary>
Defines the contents of the general bit flags field for an archive entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Encrypted">
<summary>
Bit 0 if set indicates that the file is encrypted
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Method">
<summary>
Bits 1 and 2 - Two bits defining the compression method (only for Method 6 Imploding and 8,9 Deflating)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Descriptor">
<summary>
Bit 3 if set indicates a trailing data desciptor is appended to the entry data
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPKware4">
<summary>
Bit 4 is reserved for use with method 8 for enhanced deflation
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Patched">
<summary>
Bit 5 if set indicates the file contains Pkzip compressed patched data.
Requires version 2.7 or greater.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.StrongEncryption">
<summary>
Bit 6 if set indicates strong encryption has been used for this entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused7">
<summary>
Bit 7 is currently unused
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused8">
<summary>
Bit 8 is currently unused
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused9">
<summary>
Bit 9 is currently unused
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused10">
<summary>
Bit 10 is currently unused
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.UnicodeText">
<summary>
Bit 11 if set indicates the filename and
comment fields for this file must be encoded using UTF-8.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.EnhancedCompress">
<summary>
Bit 12 is documented as being reserved by PKware for enhanced compression.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.HeaderMasked">
<summary>
Bit 13 if set indicates that values in the local header are masked to hide
their actual values, and the central directory is encrypted.
</summary>
<remarks>
Used when encrypting the central directory contents.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPkware14">
<summary>
Bit 14 is documented as being reserved for use by PKware
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPkware15">
<summary>
Bit 15 is documented as being reserved for use by PKware
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipConstants">
<summary>
This class contains constants used for Zip format files
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionMadeBy">
<summary>
The version made by field for entries in the central header when created by this library
</summary>
<remarks>
This is also the Zip version for the library when comparing against the version required to extract
for an entry. See <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CanDecompress"/>.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VERSION_MADE_BY">
<summary>
The version made by field for entries in the central header when created by this library
</summary>
<remarks>
This is also the Zip version for the library when comparing against the version required to extract
for an entry. See <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CanDecompressEntry">ZipInputStream.CanDecompressEntry</see>.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionStrongEncryption">
<summary>
The minimum version required to support strong encryption
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VERSION_STRONG_ENCRYPTION">
<summary>
The minimum version required to support strong encryption
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VERSION_AES">
<summary>
Version indicating AES encryption
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionZip64">
<summary>
The version required for Zip64 extensions (4.5 or higher)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LocalHeaderBaseSize">
<summary>
Size of local entry header (excluding variable length fields at end)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LOCHDR">
<summary>
Size of local entry header (excluding variable length fields at end)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64DataDescriptorSize">
<summary>
Size of Zip64 data descriptor
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.DataDescriptorSize">
<summary>
Size of data descriptor
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EXTHDR">
<summary>
Size of data descriptor
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderBaseSize">
<summary>
Size of central header entry (excluding variable fields)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENHDR">
<summary>
Size of central header entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EndOfCentralRecordBaseSize">
<summary>
Size of end of central record (excluding variable fields)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ENDHDR">
<summary>
Size of end of central record (excluding variable fields)
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CryptoHeaderSize">
<summary>
Size of 'classic' cryptographic header stored before any entry data
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CRYPTO_HEADER_SIZE">
<summary>
Size of cryptographic header stored before entry data
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LocalHeaderSignature">
<summary>
Signature for local entry header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LOCSIG">
<summary>
Signature for local entry header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SpanningSignature">
<summary>
Signature for spanning entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SPANNINGSIG">
<summary>
Signature for spanning entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SpanningTempSignature">
<summary>
Signature for temporary spanning entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SPANTEMPSIG">
<summary>
Signature for temporary spanning entry
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.DataDescriptorSignature">
<summary>
Signature for data descriptor
</summary>
<remarks>
This is only used where the length, Crc, or compressed size isnt known when the
entry is created and the output stream doesnt support seeking.
The local entry cannot be 'patched' with the correct values in this case
so the values are recorded after the data prefixed by this header, as well as in the central directory.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EXTSIG">
<summary>
Signature for data descriptor
</summary>
<remarks>
This is only used where the length, Crc, or compressed size isnt known when the
entry is created and the output stream doesnt support seeking.
The local entry cannot be 'patched' with the correct values in this case
so the values are recorded after the data prefixed by this header, as well as in the central directory.
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENSIG">
<summary>
Signature for central header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderSignature">
<summary>
Signature for central header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64CentralFileHeaderSignature">
<summary>
Signature for Zip64 central file header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENSIG64">
<summary>
Signature for Zip64 central file header
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64CentralDirLocatorSignature">
<summary>
Signature for Zip64 central directory locator
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ArchiveExtraDataSignature">
<summary>
Signature for archive extra data signature (were headers are encrypted).
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderDigitalSignature">
<summary>
Central header digitial signature
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENDIGITALSIG">
<summary>
Central header digitial signature
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EndOfCentralDirectorySignature">
<summary>
End of central directory record signature
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ENDSIG">
<summary>
End of central directory record signature
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipConstants.DefaultCodePage">
<summary>
Default encoding used for string conversion. 0 gives the default system OEM code page.
Using the default code page isnt the full solution neccessarily
there are many variable factors, codepage 850 is often a good choice for
European users, however be careful about compatability.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToString(System.Byte[],System.Int32)">
<summary> Depracated wrapper for <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToString(System.Byte[],System.Int32)"/></summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToString(System.Byte[])">
<summary> Depracated wrapper for <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToString(System.Byte[])"/></summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToStringExt(System.Int32,System.Byte[],System.Int32)">
<summary> Depracated wrapper for <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToStringExt(System.Int32,System.Byte[],System.Int32)"/></summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToStringExt(System.Int32,System.Byte[])">
<summary> Depracated wrapper for <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToStringExt(System.Int32,System.Byte[])"/></summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToArray(System.String)">
<summary> Depracated wrapper for <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToArray(System.String)"/></summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipConstants.ConvertToArray(System.Int32,System.String)">
<summary> Depracated wrapper for <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToArray(System.Int32,System.String)"/></summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.HostSystemID">
<summary>
Defines known values for the <see cref="T:ICSharpCode.SharpZipLib.Zip.HostSystemID"/> property.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Msdos">
<summary>
Host system = MSDOS
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Amiga">
<summary>
Host system = Amiga
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.OpenVms">
<summary>
Host system = Open VMS
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Unix">
<summary>
Host system = Unix
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.VMCms">
<summary>
Host system = VMCms
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.AtariST">
<summary>
Host system = Atari ST
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.OS2">
<summary>
Host system = OS2
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Macintosh">
<summary>
Host system = Macintosh
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.ZSystem">
<summary>
Host system = ZSystem
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Cpm">
<summary>
Host system = Cpm
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.WindowsNT">
<summary>
Host system = Windows NT
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.MVS">
<summary>
Host system = MVS
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Vse">
<summary>
Host system = VSE
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.AcornRisc">
<summary>
Host system = Acorn RISC
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Vfat">
<summary>
Host system = VFAT
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.AlternateMvs">
<summary>
Host system = Alternate MVS
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.BeOS">
<summary>
Host system = BEOS
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Tandem">
<summary>
Host system = Tandem
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.OS400">
<summary>
Host system = OS400
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.OSX">
<summary>
Host system = OSX
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.WinZipAES">
<summary>
Host system = WinZIP AES
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">
<summary>
This class represents an entry in a zip archive. This can be a file
or a directory
ZipFile and ZipInputStream will give you instances of this class as
information about the members in an archive. ZipOutputStream
uses an instance of this class when creating an entry in a Zip file.
<br/>
<br/>Author of the original java version : Jochen Hoenicke
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.#ctor(System.String)">
<summary>
Creates a zip entry with the given name.
</summary>
<param name="name">
The name for this entry. Can include directory components.
The convention for names is 'unix' style paths with relative names only.
There are with no device names and path elements are separated by '/' characters.
</param>
<exception cref="T:System.ArgumentNullException">
The name passed is null
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.#ctor(System.String,System.Int32)">
<summary>
Creates a zip entry with the given name and version required to extract
</summary>
<param name="name">
The name for this entry. Can include directory components.
The convention for names is 'unix' style paths with no device names and
path elements separated by '/' characters. This is not enforced see <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.CleanName(System.String)">CleanName</see>
on how to ensure names are valid if this is desired.
</param>
<param name="versionRequiredToExtract">
The minimum 'feature version' required this entry
</param>
<exception cref="T:System.ArgumentNullException">
The name passed is null
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.#ctor(System.String,System.Int32,System.Int32,ICSharpCode.SharpZipLib.Zip.CompressionMethod)">
<summary>
Initializes an entry with the given name and made by information
</summary>
<param name="name">Name for this entry</param>
<param name="madeByInfo">Version and HostSystem Information</param>
<param name="versionRequiredToExtract">Minimum required zip feature version required to extract this entry</param>
<param name="method">Compression method for this entry.</param>
<exception cref="T:System.ArgumentNullException">
The name passed is null
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
versionRequiredToExtract should be 0 (auto-calculate) or > 10
</exception>
<remarks>
This constructor is used by the ZipFile class when reading from the central header
It is not generally useful, use the constructor specifying the name only.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.#ctor(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Creates a deep copy of the given zip entry.
</summary>
<param name="entry">
The entry to copy.
</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.HasCrc">
<summary>
Get a value indicating wether the entry has a CRC value available.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCrypted">
<summary>
Get/Set flag indicating if entry is encrypted.
A simple helper routine to aid interpretation of <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Flags">flags</see>
</summary>
<remarks>This is an assistant that interprets the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Flags">flags</see> property.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsUnicodeText">
<summary>
Get / set a flag indicating wether entry name and comment text are
encoded in <a href="http://www.unicode.org">unicode UTF8</a>.
</summary>
<remarks>This is an assistant that interprets the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Flags">flags</see> property.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CryptoCheckValue">
<summary>
Value used during password checking for PKZIP 2.0 / 'classic' encryption.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Flags">
<summary>
Get/Set general purpose bit flag for entry
</summary>
<remarks>
General purpose bit flag<br/>
<br/>
Bit 0: If set, indicates the file is encrypted<br/>
Bit 1-2 Only used for compression type 6 Imploding, and 8, 9 deflating<br/>
Imploding:<br/>
Bit 1 if set indicates an 8K sliding dictionary was used. If clear a 4k dictionary was used<br/>
Bit 2 if set indicates 3 Shannon-Fanno trees were used to encode the sliding dictionary, 2 otherwise<br/>
<br/>
Deflating:<br/>
Bit 2 Bit 1<br/>
0 0 Normal compression was used<br/>
0 1 Maximum compression was used<br/>
1 0 Fast compression was used<br/>
1 1 Super fast compression was used<br/>
<br/>
Bit 3: If set, the fields crc-32, compressed size
and uncompressed size are were not able to be written during zip file creation
The correct values are held in a data descriptor immediately following the compressed data. <br/>
Bit 4: Reserved for use by PKZIP for enhanced deflating<br/>
Bit 5: If set indicates the file contains compressed patch data<br/>
Bit 6: If set indicates strong encryption was used.<br/>
Bit 7-10: Unused or reserved<br/>
Bit 11: If set the name and comments for this entry are in <a href="http://www.unicode.org">unicode</a>.<br/>
Bit 12-15: Unused or reserved<br/>
</remarks>
<seealso cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsUnicodeText"></seealso>
<seealso cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCrypted"></seealso>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.ZipFileIndex">
<summary>
Get/Set index of this entry in Zip file
</summary>
<remarks>This is only valid when the entry is part of a <see cref="!:ZipFile"></see></remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Offset">
<summary>
Get/set offset for use in central header
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.ExternalFileAttributes">
<summary>
Get/Set external file attributes as an integer.
The values of this are operating system dependant see
<see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.HostSystem">HostSystem</see> for details
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.VersionMadeBy">
<summary>
Get the version made by for this entry or zero if unknown.
The value / 10 indicates the major version number, and
the value mod 10 is the minor version number
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsDOSEntry">
<summary>
Get a value indicating this entry is for a DOS/Windows system.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.HasDosAttributes(System.Int32)">
<summary>
Test the external attributes for this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> to
see if the external attributes are Dos based (including WINNT and variants)
and match the values
</summary>
<param name="attributes">The attributes to test.</param>
<returns>Returns true if the external attributes are known to be DOS/Windows
based and have the same attributes set as the value passed.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.HostSystem">
<summary>
Gets the compatability information for the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.ExternalFileAttributes">external file attribute</see>
If the external file attributes are compatible with MS-DOS and can be read
by PKZIP for DOS version 2.04g then this value will be zero. Otherwise the value
will be non-zero and identify the host system on which the attributes are compatible.
</summary>
<remarks>
The values for this as defined in the Zip File format and by others are shown below. The values are somewhat
misleading in some cases as they are not all used as shown. You should consult the relevant documentation
to obtain up to date and correct information. The modified appnote by the infozip group is
particularly helpful as it documents a lot of peculiarities. The document is however a little dated.
<list type="table">
<item>0 - MS-DOS and OS/2 (FAT / VFAT / FAT32 file systems)</item>
<item>1 - Amiga</item>
<item>2 - OpenVMS</item>
<item>3 - Unix</item>
<item>4 - VM/CMS</item>
<item>5 - Atari ST</item>
<item>6 - OS/2 HPFS</item>
<item>7 - Macintosh</item>
<item>8 - Z-System</item>
<item>9 - CP/M</item>
<item>10 - Windows NTFS</item>
<item>11 - MVS (OS/390 - Z/OS)</item>
<item>12 - VSE</item>
<item>13 - Acorn Risc</item>
<item>14 - VFAT</item>
<item>15 - Alternate MVS</item>
<item>16 - BeOS</item>
<item>17 - Tandem</item>
<item>18 - OS/400</item>
<item>19 - OS/X (Darwin)</item>
<item>99 - WinZip AES</item>
<item>remainder - unused</item>
</list>
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Version">
<summary>
Get minimum Zip feature version required to extract this entry
</summary>
<remarks>
Minimum features are defined as:<br/>
1.0 - Default value<br/>
1.1 - File is a volume label<br/>
2.0 - File is a folder/directory<br/>
2.0 - File is compressed using Deflate compression<br/>
2.0 - File is encrypted using traditional encryption<br/>
2.1 - File is compressed using Deflate64<br/>
2.5 - File is compressed using PKWARE DCL Implode<br/>
2.7 - File is a patch data set<br/>
4.5 - File uses Zip64 format extensions<br/>
4.6 - File is compressed using BZIP2 compression<br/>
5.0 - File is encrypted using DES<br/>
5.0 - File is encrypted using 3DES<br/>
5.0 - File is encrypted using original RC2 encryption<br/>
5.0 - File is encrypted using RC4 encryption<br/>
5.1 - File is encrypted using AES encryption<br/>
5.1 - File is encrypted using corrected RC2 encryption<br/>
5.1 - File is encrypted using corrected RC2-64 encryption<br/>
6.1 - File is encrypted using non-OAEP key wrapping<br/>
6.2 - Central directory encryption (not confirmed yet)<br/>
6.3 - File is compressed using LZMA<br/>
6.3 - File is compressed using PPMD+<br/>
6.3 - File is encrypted using Blowfish<br/>
6.3 - File is encrypted using Twofish<br/>
</remarks>
<seealso cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CanDecompress"></seealso>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CanDecompress">
<summary>
Get a value indicating whether this entry can be decompressed by the library.
</summary>
<remarks>This is based on the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Version"></see> and
wether the <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCompressionMethodSupported">compression method</see> is supported.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ForceZip64">
<summary>
Force this entry to be recorded using Zip64 extensions.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsZip64Forced">
<summary>
Get a value indicating wether Zip64 extensions were forced.
</summary>
<returns>A <see cref="T:System.Boolean"/> value of true if Zip64 extensions have been forced on; false if not.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.LocalHeaderRequiresZip64">
<summary>
Gets a value indicating if the entry requires Zip64 extensions
to store the full entry values.
</summary>
<value>A <see cref="T:System.Boolean"/> value of true if a local header requires Zip64 extensions; false if not.</value>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CentralHeaderRequiresZip64">
<summary>
Get a value indicating wether the central directory entry requires Zip64 extensions to be stored.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DosTime">
<summary>
Get/Set DosTime value.
</summary>
<remarks>
The MS-DOS date format can only represent dates between 1/1/1980 and 12/31/2107.
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DateTime">
<summary>
Gets/Sets the time of last modification of the entry.
</summary>
<remarks>
The <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DosTime"></see> property is updated to match this as far as possible.
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Name">
<summary>
Returns the entry name.
</summary>
<remarks>
The unix naming convention is followed.
Path components in the entry should always separated by forward slashes ('/').
Dos device names like C: should also be removed.
See the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform"/> class, or <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.CleanName(System.String)"/>
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Size">
<summary>
Gets/Sets the size of the uncompressed data.
</summary>
<returns>
The size or -1 if unknown.
</returns>
<remarks>Setting the size before adding an entry to an archive can help
avoid compatability problems with some archivers which dont understand Zip64 extensions.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CompressedSize">
<summary>
Gets/Sets the size of the compressed data.
</summary>
<returns>
The compressed entry size or -1 if unknown.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Crc">
<summary>
Gets/Sets the crc of the uncompressed data.
</summary>
<exception cref="T:System.ArgumentOutOfRangeException">
Crc is not in the range 0..0xffffffffL
</exception>
<returns>
The crc value or -1 if unknown.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CompressionMethod">
<summary>
Gets/Sets the compression method. Only Deflated and Stored are supported.
</summary>
<returns>
The compression method for this entry
</returns>
<see cref="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Deflated"/>
<see cref="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Stored"/>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CompressionMethodForHeader">
<summary>
Gets the compression method for outputting to the local or central header.
Returns same value as CompressionMethod except when AES encrypting, which
places 99 in the method and places the real method in the extra data.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.ExtraData">
<summary>
Gets/Sets the extra data.
</summary>
<exception cref="T:System.ArgumentOutOfRangeException">
Extra data is longer than 64KB (0xffff) bytes.
</exception>
<returns>
Extra data or null if not set.
</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.AESKeySize">
<summary>
For AES encrypted files returns or sets the number of bits of encryption (128, 192 or 256).
When setting, only 0 (off), 128 or 256 is supported.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.AESEncryptionStrength">
<summary>
AES Encryption strength for storage in extra data in entry header.
1 is 128 bit, 2 is 192 bit, 3 is 256 bit.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.AESSaltLen">
<summary>
Returns the length of the salt, in bytes
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.AESOverheadSize">
<summary>
Number of extra bytes required to hold the AES Header fields (Salt, Pwd verify, AuthCode)
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ProcessExtraData(System.Boolean)">
<summary>
Process extra data fields updating the entry based on the contents.
</summary>
<param name="localHeader">True if the extra data fields should be handled
for a local header, rather than for a central header.
</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Comment">
<summary>
Gets/Sets the entry comment.
</summary>
<exception cref="T:System.ArgumentOutOfRangeException">
If comment is longer than 0xffff.
</exception>
<returns>
The comment or null if not set.
</returns>
<remarks>
A comment is only available for entries when read via the <see cref="!:ZipFile"/> class.
The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream"/> class doesnt have the comment data available.
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsDirectory">
<summary>
Gets a value indicating if the entry is a directory.
however.
</summary>
<remarks>
A directory is determined by an entry name with a trailing slash '/'.
The external file attributes can also indicate an entry is for a directory.
Currently only dos/windows attributes are tested in this manner.
The trailing slash convention should always be followed.
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsFile">
<summary>
Get a value of true if the entry appears to be a file; false otherwise
</summary>
<remarks>
This only takes account of DOS/Windows attributes. Other operating systems are ignored.
For linux and others the result may be incorrect.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCompressionMethodSupported">
<summary>
Test entry to see if data can be extracted.
</summary>
<returns>Returns true if data can be extracted for this entry; false otherwise.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.Clone">
<summary>
Creates a copy of this zip entry.
</summary>
<returns>An <see cref="T:System.Object"/> that is a copy of the current instance.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ToString">
<summary>
Gets a string representation of this ZipEntry.
</summary>
<returns>A readable textual representation of this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/></returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCompressionMethodSupported(ICSharpCode.SharpZipLib.Zip.CompressionMethod)">
<summary>
Test a <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CompressionMethod">compression method</see> to see if this library
supports extracting data compressed with that method
</summary>
<param name="method">The compression method to test.</param>
<returns>Returns true if the compression method is supported; false otherwise</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.CleanName(System.String)">
<summary>
Cleans a name making it conform to Zip file conventions.
Devices names ('c:\') and UNC share names ('\\server\share') are removed
and forward slashes ('\') are converted to back slashes ('/').
Names are made relative by trimming leading slashes which is compatible
with the ZIP naming convention.
</summary>
<param name="name">The name to clean</param>
<returns>The 'cleaned' name.</returns>
<remarks>
The <seealso cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform">Zip name transform</seealso> class is more flexible.
</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipException">
<summary>
ZipException represents exceptions specific to Zip classes and code.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipException" />.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor(System.String)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipException" /> with its message string.
</summary>
<param name="message">A <see cref="T:System.String"/> that describes the error.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor(System.String,System.Exception)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipException" />.
</summary>
<param name="message">A <see cref="T:System.String"/> that describes the error.</param>
<param name="innerException">The <see cref="T:System.Exception"/> that caused this exception.</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">
<summary>
ExtraData tagged value interface.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ITaggedData.TagID">
<summary>
Get the ID for this tagged data value.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ITaggedData.SetData(System.Byte[],System.Int32,System.Int32)">
<summary>
Set the contents of this instance from the data passed.
</summary>
<param name="data">The data to extract contents from.</param>
<param name="offset">The offset to begin extracting data from.</param>
<param name="count">The number of bytes to extract.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ITaggedData.GetData">
<summary>
Get the data representing this instance.
</summary>
<returns>Returns the data for this instance.</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.RawTaggedData">
<summary>
A raw binary tagged value
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.RawTaggedData.#ctor(System.Int16)">
<summary>
Initialise a new instance.
</summary>
<param name="tag">The tag ID.</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.RawTaggedData.TagID">
<summary>
Get the ID for this tagged data value.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.RawTaggedData.SetData(System.Byte[],System.Int32,System.Int32)">
<summary>
Set the data from the raw values provided.
</summary>
<param name="data">The raw data to extract values from.</param>
<param name="offset">The index to start extracting values from.</param>
<param name="count">The number of bytes available.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.RawTaggedData.GetData">
<summary>
Get the binary data representing this instance.
</summary>
<returns>The raw binary data representing this instance.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.RawTaggedData.Data">
<summary>
Get /set the binary data representing this instance.
</summary>
<returns>The raw binary data representing this instance.</returns>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.RawTaggedData._tag">
<summary>
The tag ID for this instance.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData">
<summary>
Class representing extended unix date time values.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags">
<summary>
Flags indicate which values are included in this instance.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags.ModificationTime">
<summary>
The modification time is included
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags.AccessTime">
<summary>
The access time is included
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags.CreateTime">
<summary>
The create time is included.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.TagID">
<summary>
Get the ID
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.SetData(System.Byte[],System.Int32,System.Int32)">
<summary>
Set the data from the raw values provided.
</summary>
<param name="data">The raw data to extract values from.</param>
<param name="index">The index to start extracting values from.</param>
<param name="count">The number of bytes available.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.GetData">
<summary>
Get the binary data representing this instance.
</summary>
<returns>The raw binary data representing this instance.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.IsValidValue(System.DateTime)">
<summary>
Test a <see cref="T:System.DateTime"> value to see if is valid and can be represented here.</see>
</summary>
<param name="value">The <see cref="T:System.DateTime">value</see> to test.</param>
<returns>Returns true if the value is valid and can be represented; false if not.</returns>
<remarks>The standard Unix time is a signed integer data type, directly encoding the Unix time number,
which is the number of seconds since 1970-01-01.
Being 32 bits means the values here cover a range of about 136 years.
The minimum representable time is 1901-12-13 20:45:52,
and the maximum representable time is 2038-01-19 03:14:07.
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.ModificationTime">
<summary>
Get /set the Modification Time
</summary>
<exception cref="T:System.ArgumentOutOfRangeException"></exception>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.IsValidValue(System.DateTime)"></seealso>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.AccessTime">
<summary>
Get / set the Access Time
</summary>
<exception cref="T:System.ArgumentOutOfRangeException"></exception>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.IsValidValue(System.DateTime)"></seealso>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.CreateTime">
<summary>
Get / Set the Create Time
</summary>
<exception cref="T:System.ArgumentOutOfRangeException"></exception>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.IsValidValue(System.DateTime)"></seealso>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Include">
<summary>
Get/set the <see cref="T:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags">values</see> to include.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.NTTaggedData">
<summary>
Class handling NT date time values.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.NTTaggedData.TagID">
<summary>
Get the ID for this tagged data value.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.NTTaggedData.SetData(System.Byte[],System.Int32,System.Int32)">
<summary>
Set the data from the raw values provided.
</summary>
<param name="data">The raw data to extract values from.</param>
<param name="index">The index to start extracting values from.</param>
<param name="count">The number of bytes available.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.NTTaggedData.GetData">
<summary>
Get the binary data representing this instance.
</summary>
<returns>The raw binary data representing this instance.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.NTTaggedData.IsValidValue(System.DateTime)">
<summary>
Test a <see cref="T:System.DateTime"> valuie to see if is valid and can be represented here.</see>
</summary>
<param name="value">The <see cref="T:System.DateTime">value</see> to test.</param>
<returns>Returns true if the value is valid and can be represented; false if not.</returns>
<remarks>
NTFS filetimes are 64-bit unsigned integers, stored in Intel
(least significant byte first) byte order. They determine the
number of 1.0E-07 seconds (1/10th microseconds!) past WinNT "epoch",
which is "01-Jan-1601 00:00:00 UTC". 28 May 60056 is the upper limit
</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.NTTaggedData.LastModificationTime">
<summary>
Get/set the <see cref="T:System.DateTime">last modification time</see>.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.NTTaggedData.CreateTime">
<summary>
Get /set the <see cref="T:System.DateTime">create time</see>
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.NTTaggedData.LastAccessTime">
<summary>
Get /set the <see cref="T:System.DateTime">last access time</see>.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ITaggedDataFactory">
<summary>
A factory that creates <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">tagged data</see> instances.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ITaggedDataFactory.Create(System.Int16,System.Byte[],System.Int32,System.Int32)">
<summary>
Get data for a specific tag value.
</summary>
<param name="tag">The tag ID to find.</param>
<param name="data">The data to search.</param>
<param name="offset">The offset to begin extracting data from.</param>
<param name="count">The number of bytes to extract.</param>
<returns>The located <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">value found</see>, or null if not found.</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipExtraData">
<summary>
A class to handle the extra data field for Zip entries
</summary>
<remarks>
Extra data contains 0 or more values each prefixed by a header tag and length.
They contain zero or more bytes of actual data.
The data is held internally using a copy on write strategy. This is more efficient but
means that for extra data created by passing in data can have the values modified by the caller
in some circumstances.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.#ctor">
<summary>
Initialise a default instance.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.#ctor(System.Byte[])">
<summary>
Initialise with known extra data.
</summary>
<param name="data">The extra data.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.GetEntryData">
<summary>
Get the raw extra data value
</summary>
<returns>Returns the raw byte[] extra data this instance represents.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Clear">
<summary>
Clear the stored data.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Length">
<summary>
Gets the current extra data length.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.GetStreamForTag(System.Int32)">
<summary>
Get a read-only <see cref="T:System.IO.Stream"/> for the associated tag.
</summary>
<param name="tag">The tag to locate data for.</param>
<returns>Returns a <see cref="T:System.IO.Stream"/> containing tag data or null if no tag was found.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.GetData``1">
<summary>
Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">tagged data</see> for a tag.
</summary>
<typeparam name="T">The tag to search for.</typeparam>
<returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">tagged value</see> or null if none found.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ValueLength">
<summary>
Get the length of the last value found by <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)"/>
</summary>
<remarks>This is only valid if <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)"/> has previously returned true.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipExtraData.CurrentReadIndex">
<summary>
Get the index for the current read value.
</summary>
<remarks>This is only valid if <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)"/> has previously returned true.
Initially the result will be the index of the first byte of actual data. The value is updated after calls to
<see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadInt"/>, <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadShort"/> and <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadLong"/>. </remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipExtraData.UnreadCount">
<summary>
Get the number of bytes remaining to be read for the current value;
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)">
<summary>
Find an extra data value
</summary>
<param name="headerID">The identifier for the value to find.</param>
<returns>Returns true if the value was found; false otherwise.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddEntry(ICSharpCode.SharpZipLib.Zip.ITaggedData)">
<summary>
Add a new entry to extra data.
</summary>
<param name="taggedData">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData"/> value to add.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddEntry(System.Int32,System.Byte[])">
<summary>
Add a new entry to extra data
</summary>
<param name="headerID">The ID for this entry.</param>
<param name="fieldData">The data to add.</param>
<remarks>If the ID already exists its contents are replaced.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry">
<summary>
Start adding a new entry.
</summary>
<remarks>Add data using <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddData(System.Byte[])"/>, <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeShort(System.Int32)"/>, <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeInt(System.Int32)"/>, or <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeLong(System.Int64)"/>.
The new entry is completed and actually added by calling <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddNewEntry(System.Int32)"/></remarks>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddEntry(ICSharpCode.SharpZipLib.Zip.ITaggedData)"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddNewEntry(System.Int32)">
<summary>
Add entry data added since <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/> using the ID passed.
</summary>
<param name="headerID">The identifier to use for this entry.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddData(System.Byte)">
<summary>
Add a byte of data to the pending new entry.
</summary>
<param name="data">The byte to add.</param>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddData(System.Byte[])">
<summary>
Add data to a pending new entry.
</summary>
<param name="data">The data to add.</param>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeShort(System.Int32)">
<summary>
Add a short value in little endian order to the pending new entry.
</summary>
<param name="toAdd">The data to add.</param>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeInt(System.Int32)">
<summary>
Add an integer value in little endian order to the pending new entry.
</summary>
<param name="toAdd">The data to add.</param>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeLong(System.Int64)">
<summary>
Add a long value in little endian order to the pending new entry.
</summary>
<param name="toAdd">The data to add.</param>
<seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Delete(System.Int32)">
<summary>
Delete an extra data field.
</summary>
<param name="headerID">The identifier of the field to delete.</param>
<returns>Returns true if the field was found and deleted.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadLong">
<summary>
Read a long in little endian form from the last <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)">found</see> data value
</summary>
<returns>Returns the long value read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadInt">
<summary>
Read an integer in little endian form from the last <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)">found</see> data value.
</summary>
<returns>Returns the integer read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadShort">
<summary>
Read a short value in little endian form from the last <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)">found</see> data value.
</summary>
<returns>Returns the short value read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadByte">
<summary>
Read a byte from an extra data
</summary>
<returns>The byte value read or -1 if the end of data has been reached.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Skip(System.Int32)">
<summary>
Skip data during reading.
</summary>
<param name="amount">The number of bytes to skip.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadShortInternal">
<summary>
Internal form of <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadShort"/> that reads data at any location.
</summary>
<returns>Returns the short value read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Dispose">
<summary>
Dispose of this instance.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.DescriptorData">
<summary>
Holds data pertinent to a data descriptor.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.DescriptorData.CompressedSize">
<summary>
Get /set the compressed size of data.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.DescriptorData.Size">
<summary>
Get / set the uncompressed size of data
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.DescriptorData.Crc">
<summary>
Get /set the crc value.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipHelperStream">
<summary>
This class assists with writing/reading from Zip files.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.#ctor(System.String)">
<summary>
Initialise an instance of this class.
</summary>
<param name="name">The name of the file to open.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.#ctor(System.IO.Stream)">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipHelperStream"/>.
</summary>
<param name="stream">The stream to use.</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.IsStreamOwner">
<summary>
Get / set a value indicating wether the the underlying stream is owned or not.
</summary>
<remarks>If the stream is owned it is closed when this instance is closed.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.Dispose(System.Boolean)">
<summary>
Close the stream.
</summary>
<remarks>
The underlying stream is closed only if <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.IsStreamOwner"/> is true.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.LocateBlockWithSignature(System.Int32,System.Int64,System.Int32,System.Int32)">
<summary>
Locates a block with the desired <paramref name="signature"/>.
</summary>
<param name="signature">The signature to find.</param>
<param name="endLocation">Location, marking the end of block.</param>
<param name="minimumBlockSize">Minimum size of the block.</param>
<param name="maximumVariableData">The maximum variable data.</param>
<returns>Eeturns the offset of the first byte after the signature; -1 if not found</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteZip64EndOfCentralDirectory(System.Int64,System.Int64,System.Int64)">
<summary>
Write Zip64 end of central directory records (File header and locator).
</summary>
<param name="noOfEntries">The number of entries in the central directory.</param>
<param name="sizeEntries">The size of entries in the central directory.</param>
<param name="centralDirOffset">The offset of the dentral directory.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteEndOfCentralDirectory(System.Int64,System.Int64,System.Int64,System.Byte[])">
<summary>
Write the required records to end the central directory.
</summary>
<param name="noOfEntries">The number of entries in the directory.</param>
<param name="sizeEntries">The size of the entries in the directory.</param>
<param name="startOfCentralDirectory">The start of the central directory.</param>
<param name="comment">The archive comment. (This can be null).</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.ReadLEShort">
<summary>
Read an unsigned short in little endian byte order.
</summary>
<returns>Returns the value read.</returns>
<exception cref="T:System.IO.IOException">
An i/o error occurs.
</exception>
<exception cref="T:System.IO.EndOfStreamException">
The file ends prematurely
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.ReadLEInt">
<summary>
Read an int in little endian byte order.
</summary>
<returns>Returns the value read.</returns>
<exception cref="T:System.IO.IOException">
An i/o error occurs.
</exception>
<exception cref="T:System.IO.EndOfStreamException">
The file ends prematurely
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.ReadLELong">
<summary>
Read a long in little endian byte order.
</summary>
<returns>The value read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteLEShort(System.Int32)">
<summary>
Write an unsigned short in little endian byte order.
</summary>
<param name="value">The value to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteLEUshort(System.UInt16)">
<summary>
Write a ushort in little endian byte order.
</summary>
<param name="value">The value to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteLEInt(System.Int32)">
<summary>
Write an int in little endian byte order.
</summary>
<param name="value">The value to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteLEUint(System.UInt32)">
<summary>
Write a uint in little endian byte order.
</summary>
<param name="value">The value to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteLELong(System.Int64)">
<summary>
Write a long in little endian byte order.
</summary>
<param name="value">The value to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteLEUlong(System.UInt64)">
<summary>
Write a ulong in little endian byte order.
</summary>
<param name="value">The value to write.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.WriteDataDescriptor(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Write a data descriptor.
</summary>
<param name="entry">The entry to write a descriptor for.</param>
<returns>Returns the number of descriptor bytes written.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipHelperStream.ReadDataDescriptor(System.Boolean,ICSharpCode.SharpZipLib.Zip.DescriptorData)">
<summary>
Read data descriptor at the end of compressed data.
</summary>
<param name="zip64">if set to <c>true</c> [zip64].</param>
<param name="data">The data to fill in.</param>
<returns>Returns the number of bytes read in the descriptor.</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream">
<summary>
This is an InflaterInputStream that reads the files baseInputStream an zip archive
one after another. It has a special method to get the zip entry of
the next file. The zip entry contains information about the file name
size, compressed size, Crc, etc.
It includes support for Stored and Deflated entries.
<br/>
<br/>Author of the original java version : Jochen Hoenicke
</summary>
<example> This sample shows how to read a zip file
<code lang="C#">
using System;
using System.Text;
using System.IO;
using ICSharpCode.SharpZipLib.Zip;
class MainClass
{
public static void Main(string[] args)
{
using ( ZipInputStream s = new ZipInputStream(File.OpenRead(args[0]))) {
ZipEntry theEntry;
const int size = 2048;
byte[] data = new byte[2048];
while ((theEntry = s.GetNextEntry()) != null) {
if ( entry.IsFile ) {
Console.Write("Show contents (y/n) ?");
if (Console.ReadLine() == "y") {
while (true) {
size = s.Read(data, 0, data.Length);
if (size > 0) {
Console.Write(new ASCIIEncoding().GetString(data, 0, size));
} else {
break;
}
}
}
}
}
}
}
}
</code>
</example>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadDataHandler">
<summary>
Delegate for reading bytes from a stream.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipInputStream.internalReader">
<summary>
The current reader this instance.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.#ctor(System.IO.Stream)">
<summary>
Creates a new Zip input stream, for reading a zip archive.
</summary>
<param name="baseInputStream">The underlying <see cref="T:System.IO.Stream"/> providing data.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.#ctor(System.IO.Stream,System.Int32)">
<summary>
Creates a new Zip input stream, for reading a zip archive.
</summary>
<param name="baseInputStream">The underlying <see cref="T:System.IO.Stream"/> providing data.</param>
<param name="bufferSize">Size of the buffer.</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Password">
<summary>
Optional password used for encryption when non-null
</summary>
<value>A password for all encrypted <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">entries </see> in this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream"/></value>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CanDecompressEntry">
<summary>
Gets a value indicating if there is a current entry and it can be decompressed
</summary>
<remarks>
The entry can only be decompressed if the library supports the zip features required to extract it.
See the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Version">ZipEntry Version</see> property for more details.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.GetNextEntry">
<summary>
Advances to the next entry in the archive
</summary>
<returns>
The next <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">entry</see> in the archive or null if there are no more entries.
</returns>
<remarks>
If the previous entry is still open <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CloseEntry">CloseEntry</see> is called.
</remarks>
<exception cref="T:System.InvalidOperationException">
Input stream is closed
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
Password is not set, password is invalid, compression method is invalid,
version required to extract is not supported
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadDataDescriptor">
<summary>
Read data descriptor at the end of compressed data.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CompleteCloseEntry(System.Boolean)">
<summary>
Complete cleanup as the final part of closing.
</summary>
<param name="testCrc">True if the crc value should be tested</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CloseEntry">
<summary>
Closes the current zip entry and moves to the next one.
</summary>
<exception cref="T:System.InvalidOperationException">
The stream is closed
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The Zip stream ends early
</exception>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Available">
<summary>
Returns 1 if there is an entry available
Otherwise returns 0.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Length">
<summary>
Returns the current size that can be read from the current entry if available
</summary>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">Thrown if the entry size is not known.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if no entry is currently available.</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadByte">
<summary>
Reads a byte from the current zip entry.
</summary>
<returns>
The byte or -1 if end of stream is reached.
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadingNotAvailable(System.Byte[],System.Int32,System.Int32)">
<summary>
Handle attempts to read by throwing an <see cref="T:System.InvalidOperationException"/>.
</summary>
<param name="destination">The destination array to store data in.</param>
<param name="offset">The offset at which data read should be stored.</param>
<param name="count">The maximum number of bytes to read.</param>
<returns>Returns the number of bytes actually read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadingNotSupported(System.Byte[],System.Int32,System.Int32)">
<summary>
Handle attempts to read from this entry by throwing an exception
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.InitialRead(System.Byte[],System.Int32,System.Int32)">
<summary>
Perform the initial read on an entry which may include
reading encryption headers and setting up inflation.
</summary>
<param name="destination">The destination to fill with data read.</param>
<param name="offset">The offset to start reading at.</param>
<param name="count">The maximum number of bytes to read.</param>
<returns>The actual number of bytes read.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Read a block of bytes from the stream.
</summary>
<param name="buffer">The destination for the bytes.</param>
<param name="offset">The index to start storing data.</param>
<param name="count">The number of bytes to attempt to read.</param>
<returns>Returns the number of bytes read.</returns>
<remarks>Zero bytes read means end of stream.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.BodyRead(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a block of bytes from the current zip entry.
</summary>
<returns>
The number of bytes read (this may be less than the length requested, even before the end of stream), or 0 on end of stream.
</returns>
<exception name="IOException">
An i/o error occured.
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
The deflated stream is corrupted.
</exception>
<exception cref="T:System.InvalidOperationException">
The stream is not open.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Dispose(System.Boolean)">
<summary>
Closes the zip input stream
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform">
<summary>
ZipNameTransform transforms names as per the Zip file naming convention.
</summary>
<remarks>The use of absolute names is supported although its use is not valid
according to Zip naming conventions, and should not be used if maximum compatability is desired.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.#ctor">
<summary>
Initialize a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform"></see>
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.#ctor(System.String)">
<summary>
Initialize a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform"></see>
</summary>
<param name="trimPrefix">The string to trim from the front of paths if found.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.#cctor">
<summary>
Static constructor.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.TransformDirectory(System.String)">
<summary>
Transform a windows directory name according to the Zip file naming conventions.
</summary>
<param name="name">The directory name to transform.</param>
<returns>The transformed name.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.TransformFile(System.String)">
<summary>
Transform a windows file name according to the Zip file naming conventions.
</summary>
<param name="name">The file name to transform.</param>
<returns>The transformed name.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.TrimPrefix">
<summary>
Get/set the path prefix to be trimmed from paths if present.
</summary>
<remarks>The prefix is trimmed before any conversion from
a windows path is done.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.MakeValidName(System.String,System.Char)">
<summary>
Force a name to be valid by replacing invalid characters with a fixed value
</summary>
<param name="name">The name to force valid</param>
<param name="replacement">The replacement character to use.</param>
<returns>Returns a valid name</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.IsValidName(System.String,System.Boolean)">
<summary>
Test a name to see if it is a valid name for a zip entry.
</summary>
<param name="name">The name to test.</param>
<param name="relaxed">If true checking is relaxed about windows file names and absolute paths.</param>
<returns>Returns true if the name is a valid zip name; false otherwise.</returns>
<remarks>Zip path names are actually in Unix format, and should only contain relative paths.
This means that any path stored should not contain a drive or
device letter, or a leading slash. All slashes should forward slashes '/'.
An empty name is valid for a file where the input comes from standard input.
A null name is not considered valid.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.IsValidName(System.String)">
<summary>
Test a name to see if it is a valid name for a zip entry.
</summary>
<param name="name">The name to test.</param>
<returns>Returns true if the name is a valid zip name; false otherwise.</returns>
<remarks>Zip path names are actually in unix format,
and should only contain relative paths if a path is present.
This means that the path stored should not contain a drive or
device letter, or a leading slash. All slashes should forward slashes '/'.
An empty name is valid where the input comes from standard input.
A null name is not considered valid.
</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipOutputStream">
<summary>
This is a DeflaterOutputStream that writes the files into a zip
archive one after another. It has a special method to start a new
zip entry. The zip entries contains information about the file name
size, compressed size, CRC, etc.
It includes support for Stored and Deflated entries.
This class is not thread safe.
<br/>
<br/>Author of the original java version : Jochen Hoenicke
</summary>
<example> This sample shows how to create a zip file
<code>
using System;
using System.IO;
using ICSharpCode.SharpZipLib.Core;
using ICSharpCode.SharpZipLib.Zip;
class MainClass
{
public static void Main(string[] args)
{
string[] filenames = Directory.GetFiles(args[0]);
byte[] buffer = new byte[4096];
using ( ZipOutputStream s = new ZipOutputStream(File.Create(args[1])) ) {
s.SetLevel(9); // 0 - store only to 9 - means best compression
foreach (string file in filenames) {
ZipEntry entry = new ZipEntry(file);
s.PutNextEntry(entry);
using (FileStream fs = File.OpenRead(file)) {
StreamUtils.Copy(fs, s, buffer);
}
}
}
}
}
</code>
</example>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.#ctor(System.IO.Stream)">
<summary>
Creates a new Zip output stream, writing a zip archive.
</summary>
<param name="baseOutputStream">
The output stream to which the archive contents are written.
</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.#ctor(System.IO.Stream,System.Int32)">
<summary>
Creates a new Zip output stream, writing a zip archive.
</summary>
<param name="baseOutputStream">The output stream to which the archive contents are written.</param>
<param name="bufferSize">Size of the buffer to use.</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.IsFinished">
<summary>
Gets a flag value of true if the central header has been added for this archive; false if it has not been added.
</summary>
<remarks>No further entries can be added once this has been done.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.SetComment(System.String)">
<summary>
Set the zip file comment.
</summary>
<param name="comment">
The comment text for the entire archive.
</param>
<exception name ="ArgumentOutOfRangeException">
The converted comment is longer than 0xffff bytes.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.SetLevel(System.Int32)">
<summary>
Sets the compression level. The new level will be activated
immediately.
</summary>
<param name="level">The new compression level (1 to 9).</param>
<exception cref="T:System.ArgumentOutOfRangeException">
Level specified is not supported.
</exception>
<see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.GetLevel">
<summary>
Get the current deflater compression level
</summary>
<returns>The current compression level</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.UseZip64">
<summary>
Get / set a value indicating how Zip64 Extension usage is determined when adding entries.
</summary>
<remarks>Older archivers may not understand Zip64 extensions.
If backwards compatability is an issue be careful when adding <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Size">entries</see> to an archive.
Setting this property to off is workable but less desirable as in those circumstances adding a file
larger then 4GB will fail.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeShort(System.Int32)">
<summary>
Write an unsigned short in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeInt(System.Int32)">
<summary>
Write an int in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeLong(System.Int64)">
<summary>
Write an int in little endian byte order.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.PutNextEntry(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
<summary>
Starts a new Zip entry. It automatically closes the previous
entry if present.
All entry elements bar name are optional, but must be correct if present.
If the compression method is stored and the output is not patchable
the compression for that entry is automatically changed to deflate level 0
</summary>
<param name="entry">
the entry.
</param>
<exception cref="T:System.ArgumentNullException">
if entry passed is null.
</exception>
<exception cref="T:System.IO.IOException">
if an I/O error occured.
</exception>
<exception cref="T:System.InvalidOperationException">
if stream was finished
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
Too many entries in the Zip file<br/>
Entry name is too long<br/>
Finish has already been called<br/>
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.CloseEntry">
<summary>
Closes the current entry, updating header and footer information as required
</summary>
<exception cref="T:System.IO.IOException">
An I/O error occurs.
</exception>
<exception cref="T:System.InvalidOperationException">
No entry is active.
</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes the given buffer to the current entry.
</summary>
<param name="buffer">The buffer containing data to write.</param>
<param name="offset">The offset of the first byte to write.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">Archive size is invalid</exception>
<exception cref="T:System.InvalidOperationException">No entry is active.</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Finish">
<summary>
Finishes the stream. This will write the central directory at the
end of the zip file and flush the stream.
</summary>
<remarks>
This is automatically called when the stream is closed.
</remarks>
<exception cref="T:System.IO.IOException">
An I/O error occurs.
</exception>
<exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
Comment exceeds the maximum length<br/>
Entry name exceeds the maximum length
</exception>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.entries">
<summary>
The entries for the archive.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.crc">
<summary>
Used to track the crc of data added to entries.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.curEntry">
<summary>
The current entry being added.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.size">
<summary>
Used to track the size of data for an entry during writing.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.offset">
<summary>
Offset to be recorded for each entry in the central header.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.zipComment">
<summary>
Comment for the entire archive recorded in central header.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.patchEntryHeader">
<summary>
Flag indicating that header patching is required for the current entry.
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.crcPatchPos">
<summary>
Position to patch crc
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.sizePatchPos">
<summary>
Position to patch size.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Zip.ZipStrings">
<summary>
This static class contains functions for encoding and decoding zip file strings
</summary>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipStrings.codePage">
<summary>Code page backing field</summary>
<remarks>
The original Zip specification (https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT) states
that file names should only be encoded with IBM Code Page 437 or UTF-8.
In practice, most zip apps use OEM or system encoding (typically cp437 on Windows).
Let's be good citizens and default to UTF-8 http://utf8everywhere.org/
</remarks>
</member>
<member name="F:ICSharpCode.SharpZipLib.Zip.ZipStrings.AutomaticCodePage">
Automatically select codepage while opening archive
see https://github.com/icsharpcode/SharpZipLib/pull/280#issuecomment-433608324
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage">
<summary>
Encoding used for string conversion. Setting this to 65001 (UTF-8) will
also set the Language encoding flag to indicate UTF-8 encoded file names.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.SystemDefaultCodePage">
<summary>
Attempt to get the operating system default codepage, or failing that, to
the fallback code page IBM 437.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.UseUnicode">
<summary>
Get wether the default codepage is set to UTF-8. Setting this property to false will
set the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage"/> to <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.SystemDefaultCodePage"/>
</summary>
<remarks>
/// Get OEM codepage from NetFX, which parses the NLP file with culture info table etc etc.
But sometimes it yields the special value of 1 which is nicknamed <c>CodePageNoOEM</c> in <see cref="T:System.Text.Encoding"/> sources (might also mean <c>CP_OEMCP</c>, but Encoding puts it so).
This was observed on Ukranian and Hindu systems.
Given this value, <see cref="M:System.Text.Encoding.GetEncoding(System.Int32)"/> throws an <see cref="T:System.ArgumentException"/>.
So replace it with <see cref="F:ICSharpCode.SharpZipLib.Zip.ZipStrings.FallbackCodePage"/>, (IBM 437 which is the default code page in a default Windows installation console.
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToString(System.Byte[],System.Int32)">
<summary>
Convert a portion of a byte array to a string using <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage"/>
</summary>
<param name="data">
Data to convert to string
</param>
<param name="count">
Number of bytes to convert starting from index 0
</param>
<returns>
data[0]..data[count - 1] converted to a string
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToString(System.Byte[])">
<summary>
Convert a byte array to a string using <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage"/>
</summary>
<param name="data">
Byte array to convert
</param>
<returns>
<paramref name="data">data</paramref>converted to a string
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToStringExt(System.Int32,System.Byte[],System.Int32)">
<summary>
Convert a byte array to a string using <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage"/>
</summary>
<param name="flags">The applicable general purpose bits flags</param>
<param name="data">
Byte array to convert
</param>
<param name="count">The number of bytes to convert.</param>
<returns>
<paramref name="data">data</paramref>converted to a string
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToStringExt(System.Int32,System.Byte[])">
<summary>
Convert a byte array to a string using <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage"/>
</summary>
<param name="data">
Byte array to convert
</param>
<param name="flags">The applicable general purpose bits flags</param>
<returns>
<paramref name="data">data</paramref>converted to a string
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToArray(System.String)">
<summary>
Convert a string to a byte array using <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage"/>
</summary>
<param name="str">
String to convert to an array
</param>
<returns>Converted array</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToArray(System.Int32,System.String)">
<summary>
Convert a string to a byte array using <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage"/>
</summary>
<param name="flags">The applicable <see cref="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags">general purpose bits flags</see></param>
<param name="str">
String to convert to an array
</param>
<returns>Converted array</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
<summary>
SharpZipBaseException is the base exception class for SharpZipLib.
All library exceptions are derived from this.
</summary>
<remarks>NOTE: Not all exceptions thrown will be derived from this class.
A variety of other exceptions are possible for example <see cref="T:System.ArgumentNullException"></see></remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor">
<summary>
Initializes a new instance of the SharpZipBaseException class.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor(System.String)">
<summary>
Initializes a new instance of the SharpZipBaseException class with a specified error message.
</summary>
<param name="message">A message describing the exception.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the SharpZipBaseException class with a specified
error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">A message describing the exception.</param>
<param name="innerException">The inner exception</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.StreamDecodingException">
<summary>
Indicates that an error occured during decoding of a input stream due to corrupt
data or (unintentional) library incompability.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.StreamDecodingException.#ctor">
<summary>
Initializes a new instance of the StreamDecodingException with a generic message
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.StreamDecodingException.#ctor(System.String)">
<summary>
Initializes a new instance of the StreamDecodingException class with a specified error message.
</summary>
<param name="message">A message describing the exception.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.StreamDecodingException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the StreamDecodingException class with a specified
error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">A message describing the exception.</param>
<param name="innerException">The inner exception</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.ValueOutOfRangeException">
<summary>
Indicates that a value was outside of the expected range when decoding an input stream
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.ValueOutOfRangeException.#ctor(System.String)">
<summary>
Initializes a new instance of the ValueOutOfRangeException class naming the the causing variable
</summary>
<param name="nameOfValue">Name of the variable, use: nameof()</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.ValueOutOfRangeException.#ctor(System.String,System.Int64,System.Int64,System.Int64)">
<summary>
Initializes a new instance of the ValueOutOfRangeException class naming the the causing variable,
it's current value and expected range.
</summary>
<param name="nameOfValue">Name of the variable, use: nameof()</param>
<param name="value">The invalid value</param>
<param name="maxValue">Expected maximum value</param>
<param name="minValue">Expected minimum value</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.ValueOutOfRangeException.#ctor(System.String,System.String,System.String,System.String)">
<summary>
Initializes a new instance of the ValueOutOfRangeException class naming the the causing variable,
it's current value and expected range.
</summary>
<param name="nameOfValue">Name of the variable, use: nameof()</param>
<param name="value">The invalid value</param>
<param name="maxValue">Expected maximum value</param>
<param name="minValue">Expected minimum value</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.INameTransform">
<summary>
INameTransform defines how file system names are transformed for use with archives, or vice versa.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.INameTransform.TransformFile(System.String)">
<summary>
Given a file name determine the transformed value.
</summary>
<param name="name">The name to transform.</param>
<returns>The transformed file name.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.INameTransform.TransformDirectory(System.String)">
<summary>
Given a directory name determine the transformed value.
</summary>
<param name="name">The name to transform.</param>
<returns>The transformed directory name</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.ProgressHandler">
<summary>
Delegate invoked during processing of a file or directory
</summary>
<param name="sender">The source of the event</param>
<param name="e">The event arguments.</param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.ProgressEventArgs">
<summary>
Event arguments during processing of a single file or directory.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.#ctor(System.String,System.Int64,System.Int64)">
<summary>
Initialise a new instance of <see cref="!:ScanEventArgs"/>
</summary>
<param name="name">The file or directory name if known.</param>
<param name="processed">The number of bytes processed so far</param>
<param name="target">The total number of bytes to process, 0 if not known</param>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.Name">
<summary>
The name for this event if known.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.ContinueRunning">
<summary>
Get set a value indicating wether scanning should continue or not.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.PercentComplete">
<summary>
Get a percentage representing how much of the <see cref="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.Target"></see> has been processed
</summary>
<value>0.0 to 100.0 percent; 0 if target is not known.</value>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.Processed">
<summary>
The number of bytes processed so far
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.Target">
<summary>
The number of bytes to process.
</summary>
<remarks>Target may be 0 or negative if the value isnt known.</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.StreamUtils">
<summary>
Provides simple <see cref="T:System.IO.Stream"/>" utilities.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.ReadFully(System.IO.Stream,System.Byte[])">
<summary>
Read from a <see cref="T:System.IO.Stream"/> ensuring all the required data is read.
</summary>
<param name="stream">The stream to read.</param>
<param name="buffer">The buffer to fill.</param>
<seealso cref="M:ICSharpCode.SharpZipLib.Core.StreamUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)"/>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
<summary>
Read from a <see cref="T:System.IO.Stream"/>" ensuring all the required data is read.
</summary>
<param name="stream">The stream to read data from.</param>
<param name="buffer">The buffer to store data in.</param>
<param name="offset">The offset at which to begin storing data.</param>
<param name="count">The number of bytes of data to store.</param>
<exception cref="T:System.ArgumentNullException">Required parameter is null</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset"/> and or <paramref name="count"/> are invalid.</exception>
<exception cref="T:System.IO.EndOfStreamException">End of stream is encountered before all the data has been read.</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.ReadRequestedBytes(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
<summary>
Read as much data as possible from a <see cref="T:System.IO.Stream"/>", up to the requested number of bytes
</summary>
<param name="stream">The stream to read data from.</param>
<param name="buffer">The buffer to store data in.</param>
<param name="offset">The offset at which to begin storing data.</param>
<param name="count">The number of bytes of data to store.</param>
<exception cref="T:System.ArgumentNullException">Required parameter is null</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset"/> and or <paramref name="count"/> are invalid.</exception>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.Copy(System.IO.Stream,System.IO.Stream,System.Byte[])">
<summary>
Copy the contents of one <see cref="T:System.IO.Stream"/> to another.
</summary>
<param name="source">The stream to source data from.</param>
<param name="destination">The stream to write data to.</param>
<param name="buffer">The buffer to use during copying.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.Copy(System.IO.Stream,System.IO.Stream,System.Byte[],ICSharpCode.SharpZipLib.Core.ProgressHandler,System.TimeSpan,System.Object,System.String)">
<summary>
Copy the contents of one <see cref="T:System.IO.Stream"/> to another.
</summary>
<param name="source">The stream to source data from.</param>
<param name="destination">The stream to write data to.</param>
<param name="buffer">The buffer to use during copying.</param>
<param name="progressHandler">The <see cref="T:ICSharpCode.SharpZipLib.Core.ProgressHandler">progress handler delegate</see> to use.</param>
<param name="updateInterval">The minimum <see cref="T:System.TimeSpan"/> between progress updates.</param>
<param name="sender">The source for this event.</param>
<param name="name">The name to use with the event.</param>
<remarks>This form is specialised for use within #Zip to support events during archive operations.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.Copy(System.IO.Stream,System.IO.Stream,System.Byte[],ICSharpCode.SharpZipLib.Core.ProgressHandler,System.TimeSpan,System.Object,System.String,System.Int64)">
<summary>
Copy the contents of one <see cref="T:System.IO.Stream"/> to another.
</summary>
<param name="source">The stream to source data from.</param>
<param name="destination">The stream to write data to.</param>
<param name="buffer">The buffer to use during copying.</param>
<param name="progressHandler">The <see cref="T:ICSharpCode.SharpZipLib.Core.ProgressHandler">progress handler delegate</see> to use.</param>
<param name="updateInterval">The minimum <see cref="T:System.TimeSpan"/> between progress updates.</param>
<param name="sender">The source for this event.</param>
<param name="name">The name to use with the event.</param>
<param name="fixedTarget">A predetermined fixed target value to use with progress updates.
If the value is negative the target is calculated by looking at the stream.</param>
<remarks>This form is specialised for use within #Zip to support events during archive operations.</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.#ctor">
<summary>
Initialise an instance of <see cref="T:ICSharpCode.SharpZipLib.Core.StreamUtils"></see>
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Core.WindowsPathUtils">
<summary>
WindowsPathUtils provides simple utilities for handling windows paths.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.WindowsPathUtils.#ctor">
<summary>
Initializes a new instance of the <see cref="T:ICSharpCode.SharpZipLib.Core.WindowsPathUtils"/> class.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Core.WindowsPathUtils.DropPathRoot(System.String)">
<summary>
Remove any path root present in the path
</summary>
<param name="path">A <see cref="T:System.String"/> containing path information.</param>
<returns>The path with the root removed if it was present; path otherwise.</returns>
<remarks>Unlike the <see cref="T:System.IO.Path"/> class the path isnt otherwise checked for validity.</remarks>
</member>
<member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassic">
<summary>
PkzipClassic embodies the classic or original encryption facilities used in Pkzip archives.
While it has been superceded by more recent and more powerful algorithms, its still in use and
is viable for preventing casual snooping
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassic.GenerateKeys(System.Byte[])">
<summary>
Generates new encryption keys based on given seed
</summary>
<param name="seed">The seed value to initialise keys with.</param>
<returns>A new key value.</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase">
<summary>
PkzipClassicCryptoBase provides the low level facilities for encryption
and decryption using the PkzipClassic algorithm.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase.TransformByte">
<summary>
Transform a single byte
</summary>
<returns>
The transformed value
</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase.SetKeys(System.Byte[])">
<summary>
Set the key schedule for encryption/decryption.
</summary>
<param name="keyData">The data use to set the keys from.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase.UpdateKeys(System.Byte)">
<summary>
Update encryption keys
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase.Reset">
<summary>
Reset the internal state.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform">
<summary>
PkzipClassic CryptoTransform for encryption.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.#ctor(System.Byte[])">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform"></see>
</summary>
<param name="keyBlock">The key block to use.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.TransformFinalBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Transforms the specified region of the specified byte array.
</summary>
<param name="inputBuffer">The input for which to compute the transform.</param>
<param name="inputOffset">The offset into the byte array from which to begin using data.</param>
<param name="inputCount">The number of bytes in the byte array to use as data.</param>
<returns>The computed transform.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.TransformBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
<summary>
Transforms the specified region of the input byte array and copies
the resulting transform to the specified region of the output byte array.
</summary>
<param name="inputBuffer">The input for which to compute the transform.</param>
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
<param name="outputBuffer">The output to which to write the transform.</param>
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
<returns>The number of bytes written.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.CanReuseTransform">
<summary>
Gets a value indicating whether the current transform can be reused.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.InputBlockSize">
<summary>
Gets the size of the input data blocks in bytes.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.OutputBlockSize">
<summary>
Gets the size of the output data blocks in bytes.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.CanTransformMultipleBlocks">
<summary>
Gets a value indicating whether multiple blocks can be transformed.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.Dispose">
<summary>
Cleanup internal state.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform">
<summary>
PkzipClassic CryptoTransform for decryption.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.#ctor(System.Byte[])">
<summary>
Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform"></see>.
</summary>
<param name="keyBlock">The key block to decrypt with.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.TransformFinalBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Transforms the specified region of the specified byte array.
</summary>
<param name="inputBuffer">The input for which to compute the transform.</param>
<param name="inputOffset">The offset into the byte array from which to begin using data.</param>
<param name="inputCount">The number of bytes in the byte array to use as data.</param>
<returns>The computed transform.</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.TransformBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
<summary>
Transforms the specified region of the input byte array and copies
the resulting transform to the specified region of the output byte array.
</summary>
<param name="inputBuffer">The input for which to compute the transform.</param>
<param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
<param name="inputCount">The number of bytes in the input byte array to use as data.</param>
<param name="outputBuffer">The output to which to write the transform.</param>
<param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
<returns>The number of bytes written.</returns>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.CanReuseTransform">
<summary>
Gets a value indicating whether the current transform can be reused.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.InputBlockSize">
<summary>
Gets the size of the input data blocks in bytes.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.OutputBlockSize">
<summary>
Gets the size of the output data blocks in bytes.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.CanTransformMultipleBlocks">
<summary>
Gets a value indicating whether multiple blocks can be transformed.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.Dispose">
<summary>
Cleanup internal state.
</summary>
</member>
<member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged">
<summary>
Defines a wrapper object to access the Pkzip algorithm.
This class cannot be inherited.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.BlockSize">
<summary>
Get / set the applicable block size in bits.
</summary>
<remarks>The only valid block size is 8.</remarks>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.LegalKeySizes">
<summary>
Get an array of legal <see cref="T:System.Security.Cryptography.KeySizes">key sizes.</see>
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.GenerateIV">
<summary>
Generate an initial vector.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.LegalBlockSizes">
<summary>
Get an array of legal <see cref="T:System.Security.Cryptography.KeySizes">block sizes</see>.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.Key">
<summary>
Get / set the key value applicable.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.GenerateKey">
<summary>
Generate a new random key.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.CreateEncryptor(System.Byte[],System.Byte[])">
<summary>
Create an encryptor.
</summary>
<param name="rgbKey">The key to use for this encryptor.</param>
<param name="rgbIV">Initialisation vector for the new encryptor.</param>
<returns>Returns a new PkzipClassic encryptor</returns>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.CreateDecryptor(System.Byte[],System.Byte[])">
<summary>
Create a decryptor.
</summary>
<param name="rgbKey">Keys to use for this new decryptor.</param>
<param name="rgbIV">Initialisation vector for the new decryptor.</param>
<returns>Returns a new decryptor.</returns>
</member>
<member name="T:ICSharpCode.SharpZipLib.Encryption.ZipAESStream">
<summary>
Encrypts and decrypts AES ZIP
</summary>
<remarks>
Based on information from http://www.winzip.com/aes_info.htm
and http://www.gladman.me.uk/cryptography_technology/fileencrypt/
</remarks>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Encryption.ZipAESTransform,System.Security.Cryptography.CryptoStreamMode)">
<summary>
Constructor
</summary>
<param name="stream">The stream on which to perform the cryptographic transformation.</param>
<param name="transform">Instance of ZipAESTransform</param>
<param name="mode">Read or Write</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
Reads a sequence of bytes from the current CryptoStream into buffer,
and advances the position within the stream by the number of bytes read.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
</summary>
<param name="buffer">An array of bytes. This method copies count bytes from buffer to the current stream. </param>
<param name="offset">The byte offset in buffer at which to begin copying bytes to the current stream. </param>
<param name="count">The number of bytes to be written to the current stream. </param>
</member>
<member name="T:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform">
<summary>
Transforms stream using AES in CTR mode
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.#ctor(System.String,System.Byte[],System.Int32,System.Boolean)">
<summary>
Constructor.
</summary>
<param name="key">Password string</param>
<param name="saltBytes">Random bytes, length depends on encryption strength.
128 bits = 8 bytes, 192 bits = 12 bytes, 256 bits = 16 bytes.</param>
<param name="blockSize">The encryption strength, in bytes eg 16 for 128 bits.</param>
<param name="writeMode">True when creating a zip, false when reading. For the AuthCode.</param>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.TransformBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
<summary>
Implement the ICryptoTransform method.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.PwdVerifier">
<summary>
Returns the 2 byte password verifier
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.GetAuthCode">
<summary>
Returns the 10 byte AUTH CODE to be checked or appended immediately following the AES data stream.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.TransformFinalBlock(System.Byte[],System.Int32,System.Int32)">
<summary>
Not implemented.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.InputBlockSize">
<summary>
Gets the size of the input data blocks in bytes.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.OutputBlockSize">
<summary>
Gets the size of the output data blocks in bytes.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.CanTransformMultipleBlocks">
<summary>
Gets a value indicating whether multiple blocks can be transformed.
</summary>
</member>
<member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.CanReuseTransform">
<summary>
Gets a value indicating whether the current transform can be reused.
</summary>
</member>
<member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.Dispose">
<summary>
Cleanup internal state.
</summary>
</member>
</members>
</doc>
Reference in New Issue View Git Blame Copy Permalink