SharpZip Compression LibraryCompress Compress instream sending result to outputstream Decompress...

SharpZipCompressionLibrary

Namespacehierarchy

ClassesClass DescriptionSharpZipBaseException SharpZipBaseExceptionisthe

baseexceptionclassfortheSharpZipLibrary.Alllibraryexceptionsarederivedfromthis.

ICSharpCode.SharpZipLibNamespace

SharpZipBaseExceptionisthebaseexceptionclassfortheSharpZipLibrary.Alllibraryexceptionsarederivedfromthis.

Foralistofallmembersofthistype,seeSharpZipBaseExceptionMembers.

System.ObjectSystem.ExceptionSystem.ApplicationExceptionICSharpCode.SharpZipLib.SharpZipBaseExceptionICSharpCode.SharpZipLib.BZip2.BZip2ExceptionICSharpCode.SharpZipLib.GZip.GZipExceptionICSharpCode.SharpZipLib.Tar.TarExceptionICSharpCode.SharpZipLib.Zip.ZipException

publicclassSharpZipBaseException:

ApplicationException

ThreadSafetyPublicstatic(SharedinVisualBasic)membersofthistypearesafeformultithreadedoperations.Instancemembersarenotguaranteedtobethread-safe.

RequirementsNamespace:ICSharpCode.SharpZipLibAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoSharpZipBaseExceptionMembers|ICSharpCode.SharpZipLibNamespace

SharpZipBaseExceptionClass

SharpZipBaseExceptionoverview

PublicInstanceConstructorsSharpZipBaseException Overloaded.Initializesanew

instanceoftheSharpZipBaseExceptionclass.

PublicInstancePropertiesHelpLink(inheritedfrom

Exception)Getsorsetsalinktothehelpfileassociatedwiththisexception.

InnerException(inheritedfromException)

GetstheExceptioninstancethatcausedthecurrentexception.

Message(inheritedfromException)

Getsamessagethatdescribesthecurrentexception.

Source(inheritedfromException)

Getsorsetsthenameoftheapplicationortheobjectthatcausestheerror.

StackTrace(inheritedfromException)

Getsastringrepresentationoftheframesonthecallstackatthetimethecurrentexceptionwasthrown.

TargetSite(inheritedfromException)

Getsthemethodthatthrowsthecurrentexception.

PublicInstanceMethodsEquals(inheritedfromObject) Determineswhetherthe

specifiedObjectisequaltothecurrentObject.

GetBaseException(inheritedfromException)

Whenoverriddeninaderivedclass,returnstheExceptionthat

SharpZipBaseExceptionMembers

istherootcauseofoneormoresubsequentexceptions.

GetHashCode(inheritedfromObject)

Servesasahashfunctionforaparticulartype,suitableforuseinhashingalgorithmsanddatastructureslikeahashtable.

GetObjectData(inheritedfromException)

Whenoverriddeninaderivedclass,setstheSerializationInfowithinformationabouttheexception.

GetType(inheritedfromObject)

GetstheTypeofthecurrentinstance.

ToString(inheritedfromException)

Createsandreturnsastringrepresentationofthecurrentexception.

ProtectedInstancePropertiesHResult(inheritedfrom

Exception)GetsorsetsHRESULT,acodednumericalvaluethatisassignedtoaspecificexception.

ProtectedInstanceMethodsFinalize(inheritedfrom

Object)AllowsanObjecttoattempttofreeresourcesandperformothercleanupoperationsbeforetheObjectisreclaimedbygarbagecollection.

MemberwiseClone(inheritedfromObject)

CreatesashallowcopyofthecurrentObject.

SeeAlsoSharpZipBaseExceptionClass|ICSharpCode.SharpZipLibNamespace

InitializesanewinstanceoftheSharpZipLibraryExceptionclass.

OverloadListInitializesanewinstanceoftheSharpZipLibraryExceptionclass.

publicSharpZipBaseException();

InitializesanewinstanceoftheSharpZipLibraryExceptionclasswithaspecifiederrormessage.

publicSharpZipBaseException(string);

InitializesanewinstanceoftheSharpZipLibraryExceptionclasswithaspecifiederrormessageandareferencetotheinnerexceptionthatisthecauseofthisexception.

publicSharpZipBaseException(string,Exception);

SeeAlsoSharpZipBaseExceptionClass|ICSharpCode.SharpZipLibNamespace

SharpZipBaseExceptionConstructor

InitializesanewinstanceoftheSharpZipLibraryExceptionclass.

publicSharpZipBaseException();

SeeAlsoSharpZipBaseExceptionClass|ICSharpCode.SharpZipLibNamespace|SharpZipBaseExceptionConstructorOverloadList

SharpZipBaseExceptionConstructor()

InitializesanewinstanceoftheSharpZipLibraryExceptionclasswithaspecifiederrormessage.

publicSharpZipBaseException(

stringmsg

SharpZipBaseExceptionConstructor(String)

InitializesanewinstanceoftheSharpZipLibraryExceptionclasswithaspecifiederrormessageandareferencetotheinnerexceptionthatisthecauseofthisexception.

publicSharpZipBaseException(

stringmessage,

ExceptioninnerException

Parametersmessage

Errormessagestring

innerExceptionTheinnerexception

SharpZipBaseExceptionConstructor(String,Exception)

Namespacehierarchy

ClassesClass DescriptionBZip2 Doesallthecompressand

decompresspre-operationstuff.Setsupthestreamsandfileheadercharacters.Usesmultiplyoverloadedmethodstocallforthecompress/decompress.

BZip2Constants Definesinternalvaluesforbothcompressionanddecompression

BZip2Exception BZip2ExceptionrepresentsexceptionsspecifictoBzip2algorithm

BZip2InputStream AninputstreamthatdecompressesfilesintheBZip2format

BZip2OutputStream AnoutputstreamthatcompressesintotheBZip2formatincludingfileheadercharsintoanotherstream.

ICSharpCode.SharpZipLib.BZip2Namespace

Doesallthecompressanddecompresspre-operationstuff.Setsupthestreamsandfileheadercharacters.Usesmultiplyoverloadedmethodstocallforthecompress/decompress.

Foralistofallmembersofthistype,seeBZip2Members.

System.ObjectICSharpCode.SharpZipLib.BZip2.BZip2

publicsealedclassBZip2

RequirementsNamespace:ICSharpCode.SharpZipLib.BZip2Assembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoBZip2Members|ICSharpCode.SharpZipLib.BZip2Namespace

BZip2Class

BZip2overview

PublicStaticMethodsCompress Compressinstreamsending

resulttooutputstream

Decompress Decompressinstreamwritingdecompresseddatatooutstream

PublicInstanceConstructorsBZip2Constructor Initializesanewinstanceofthe

BZip2class.

ToString(inheritedfromObject)

ReturnsaStringthatrepresentsthecurrentObject.

SeeAlsoBZip2Class|ICSharpCode.SharpZipLib.BZip2Namespace

BZip2Members

InitializesanewinstanceoftheBZip2class.

publicBZip2();

BZip2Constructor

ThemethodsoftheBZip2classarelistedbelow.ForacompletelistofBZip2classmembers,seetheBZip2Memberstopic.

PublicStaticMethodsCompress Compressinstreamsending

resulttooutputstream

Decompress Decompressinstreamwritingdecompresseddatatooutstream

BZip2Methods

Compressinstreamsendingresulttooutputstream

publicstaticvoidCompress(

Streaminstream,

Streamoutstream,

intblockSize

BZip2.CompressMethod

Decompressinstreamwritingdecompresseddatatooutstream

publicstaticvoidDecompress(

Streaminstream,

Streamoutstream

BZip2.DecompressMethod

Definesinternalvaluesforbothcompressionanddecompression

Foralistofallmembersofthistype,seeBZip2ConstantsMembers.

System.ObjectICSharpCode.SharpZipLib.BZip2.BZip2Constants

publicsealedclassBZip2Constants

SeeAlsoBZip2ConstantsMembers|ICSharpCode.SharpZipLib.BZip2Namespace

BZip2ConstantsClass

BZip2Constantsoverview

PublicStaticFieldsbaseBlockSize Whenmultipliedby

compressionparameter(1-9)givestheblocksizeforcompression9givesthebestcompresssionbutusesthemostmemory.

G_SIZE Backendconstant

MAX_ALPHA_SIZE Backendconstant

MAX_CODE_LEN Backendconstant

MAX_SELECTORS Backendconstant

N_GROUPS Backendconstant

N_ITERS Backendconstant

NUM_OVERSHOOT_BYTESBackendconstant

rNums Randomnumbersusedtorandomiserepetitiveblocks

RUNA Backendconstant

RUNB Backendconstant

BZip2ConstantsMembers

SeeAlsoBZip2ConstantsClass|ICSharpCode.SharpZipLib.BZip2Namespace

ThefieldsoftheBZip2Constantsclassarelistedbelow.ForacompletelistofBZip2Constantsclassmembers,seetheBZip2ConstantsMemberstopic.

PublicStaticFieldsbaseBlockSize Whenmultipliedby

compressionparameter(1-9)givestheblocksizeforcompression9givesthebestcompresssionbutusesthemostmemory.

G_SIZE Backendconstant

MAX_ALPHA_SIZE Backendconstant

MAX_CODE_LEN Backendconstant

MAX_SELECTORS Backendconstant

N_GROUPS Backendconstant

N_ITERS Backendconstant

NUM_OVERSHOOT_BYTESBackendconstant

rNums Randomnumbersusedtorandomiserepetitiveblocks

RUNA Backendconstant

RUNB Backendconstant

BZip2ConstantsFields

Whenmultipliedbycompressionparameter(1-9)givestheblocksizeforcompression9givesthebestcompresssionbutusesthemostmemory.

publicstaticreadonlyintbaseBlockSize;

BZip2Constants.baseBlockSizeField

Backendconstant

publicstaticreadonlyintG_SIZE;

BZip2Constants.G_SIZEField

Backendconstant

publicstaticreadonlyintMAX_ALPHA_SIZE;

BZip2Constants.MAX_ALPHA_SIZEField

Backendconstant

publicstaticreadonlyintMAX_CODE_LEN;

BZip2Constants.MAX_CODE_LENField

Backendconstant

publicstaticreadonlyintMAX_SELECTORS;

BZip2Constants.MAX_SELECTORSField

Backendconstant

publicstaticreadonlyintN_GROUPS;

BZip2Constants.N_GROUPSField

Backendconstant

publicstaticreadonlyintN_ITERS;

BZip2Constants.N_ITERSField

Backendconstant

publicstaticreadonlyintNUM_OVERSHOOT_BYTES;

BZip2Constants.NUM_OVERSHOOT_BYTESField

Randomnumbersusedtorandomiserepetitiveblocks

publicstaticreadonlyint[]rNums;

BZip2Constants.rNumsField

Backendconstant

publicstaticreadonlyintRUNA;

BZip2Constants.RUNAField

Backendconstant

publicstaticreadonlyintRUNB;

BZip2Constants.RUNBField

BZip2ExceptionrepresentsexceptionsspecifictoBzip2algorithm

Foralistofallmembersofthistype,seeBZip2ExceptionMembers.

System.ObjectSystem.ExceptionSystem.ApplicationExceptionICSharpCode.SharpZipLib.SharpZipBaseExceptionICSharpCode.SharpZipLib.BZip2.BZip2Exception

publicclassBZip2Exception:

SharpZipBaseException

SeeAlsoBZip2ExceptionMembers|ICSharpCode.SharpZipLib.BZip2Namespace

BZip2ExceptionClass

BZip2Exceptionoverview

PublicInstanceConstructorsBZip2Exception Overloaded.Initializesanew

instanceoftheBZip2Exceptionclass.

BZip2ExceptionMembers

SeeAlsoBZip2ExceptionClass|ICSharpCode.SharpZipLib.BZip2Namespace

InitialiseanewinstanceofBZip2Exception.

OverloadListInitialiseanewinstanceofBZip2Exception.

publicBZip2Exception();

InitialiseanewinstanceofBZip2Exceptionwithitsmessagesettomessage.

publicBZip2Exception(string);

SeeAlsoBZip2ExceptionClass|ICSharpCode.SharpZipLib.BZip2Namespace

BZip2ExceptionConstructor

InitialiseanewinstanceofBZip2Exception.

publicBZip2Exception();

SeeAlsoBZip2ExceptionClass|ICSharpCode.SharpZipLib.BZip2Namespace|BZip2ExceptionConstructorOverloadList

BZip2ExceptionConstructor()

InitialiseanewinstanceofBZip2Exceptionwithitsmessagesettomessage.

publicBZip2Exception(

stringmessage

Parametersmessage

Themessagedescribingtheerror.

SeeAlsoBZip2ExceptionClass|ICSharpCode.SharpZipLib.BZip2Namespace|BZip2ExceptionConstructorOverloadList

BZip2ExceptionConstructor(String)

AninputstreamthatdecompressesfilesintheBZip2format

Foralistofallmembersofthistype,seeBZip2InputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.BZip2.BZip2InputStream

publicclassBZip2InputStream:Stream

SeeAlsoBZip2InputStreamMembers|ICSharpCode.SharpZipLib.BZip2Namespace

BZip2InputStreamClass

BZip2InputStreamoverview

PublicInstanceConstructorsBZip2InputStream

ConstructorConstructinstanceforreadingfromstream

PublicInstancePropertiesCanRead Getsavalueindicatingifthe

streamsupportsreading

CanSeek Getsavalueindicatingwhetherthecurrentstreamsupportsseeking.

CanWrite Getsavalueindicatingwhetherthecurrentstreamsupportswriting.Thispropertyalwaysreturnsfalse

Length Getsthelengthinbytesofthestream.

Position Getsorsetsthestreamsposition.SettingthepositionisnotsupportedandwillthrowaNotSupportException

PublicInstanceMethodsBeginRead(inherited

fromStream)Beginsanasynchronousreadoperation.

BeginWrite(inheritedfromStream)

Beginsanasynchronouswriteoperation.

Close Closesthestream,releasinganyassociatedresources.

CreateObjRef(inheritedfrom

Createsanobjectthatcontainsalltherelevantinformationrequiredto

BZip2InputStreamMembers

MarshalByRefObject) generateaproxyusedtocommunicatewitharemoteobject.

EndRead(inheritedfromStream)

Waitsforthependingasynchronousreadtocomplete.

EndWrite(inheritedfromStream)

Endsanasynchronouswriteoperation.

Equals(inheritedfromObject)

DetermineswhetherthespecifiedObjectisequaltothecurrentObject.

Flush Flushesthestream.

GetLifetimeService(inheritedfromMarshalByRefObject)

Retrievesthecurrentlifetimeserviceobjectthatcontrolsthelifetimepolicyforthisinstance.

InitializeLifetimeService(inheritedfromMarshalByRefObject)

Obtainsalifetimeserviceobjecttocontrolthelifetimepolicyforthisinstance.

Read Readasequenceofbytesandadvancesthereadpositionbyonebyte.

ReadByte Readabytefromstreamadvancingposition

Seek Setthestreamsposition.ThisoperationisnotsupportedandwillthrowaNotSupportedException

SetLength Setsthelengthofthisstreamtothegivenvalue.ThisoperationisnotsupportedandwillthrowaNotSupportedExceptionortedException

Write Writesablockofbytestothisstreamusingdatafromabuffer.ThisoperationisnotsupportedandwillthrowaNotSupportedException

WriteByte Writesabytetothecurrentpositioninthefilestream.ThisoperationisnotsupportedandwillthrowaNotSupportedException

ProtectedInstanceMethodsCreateWaitHandle(inherited

fromStream)AllocatesaWaitHandleobject.

Finalize(inheritedfromObject)

AllowsanObjecttoattempttofreeresourcesandperformothercleanupoperationsbeforetheObjectisreclaimedbygarbagecollection.

SeeAlsoBZip2InputStreamClass|ICSharpCode.SharpZipLib.BZip2Namespace

Constructinstanceforreadingfromstream

publicBZip2InputStream(

Streamstream

Parametersstream

Datasource

BZip2InputStreamConstructor

ThepropertiesoftheBZip2InputStreamclassarelistedbelow.ForacompletelistofBZip2InputStreamclassmembers,seetheBZip2InputStreamMemberstopic.

PublicInstancePropertiesCanRead Getsavalueindicatingifthe

streamsupportsreading

CanSeek Getsavalueindicatingwhetherthecurrentstreamsupportsseeking.

CanWrite Getsavalueindicatingwhetherthecurrentstreamsupportswriting.Thispropertyalwaysreturnsfalse

Length Getsthelengthinbytesofthestream.

Position Getsorsetsthestreamsposition.SettingthepositionisnotsupportedandwillthrowaNotSupportException

BZip2InputStreamProperties

Getsavalueindicatingifthestreamsupportsreading

publicoverrideboolCanRead{get;}

BZip2InputStream.CanReadProperty

Getsavalueindicatingwhetherthecurrentstreamsupportsseeking.

publicoverrideboolCanSeek{get;}

BZip2InputStream.CanSeekProperty

Getsavalueindicatingwhetherthecurrentstreamsupportswriting.Thispropertyalwaysreturnsfalse

publicoverrideboolCanWrite{get;}

BZip2InputStream.CanWriteProperty

Getsthelengthinbytesofthestream.

publicoverridelongLength{get;}

BZip2InputStream.LengthProperty

Getsorsetsthestreamsposition.SettingthepositionisnotsupportedandwillthrowaNotSupportException

publicoverridelongPosition{get;set;}

ExceptionsExceptionType ConditionNotSupportedException Anyattempttosettheposition

BZip2InputStream.PositionProperty

ThemethodsoftheBZip2InputStreamclassarelistedbelow.ForacompletelistofBZip2InputStreamclassmembers,seetheBZip2InputStreamMemberstopic.

PublicInstanceMethodsBeginRead(inherited

fromStream)Beginsanasynchronousreadoperation.

Close Closesthestream,releasinganyassociatedresources.

CreateObjRef(inheritedfromMarshalByRefObject)

Createsanobjectthatcontainsalltherelevantinformationrequiredtogenerateaproxyusedtocommunicatewitharemoteobject.

Flush Flushesthestream.

BZip2InputStreamMethods

Read Readasequenceofbytesandadvancesthereadpositionbyonebyte.

ReadByte Readabytefromstreamadvancingposition

SetLength Setsthelengthofthisstreamtothegivenvalue.ThisoperationisnotsupportedandwillthrowaNotSupportedExceptionortedException

Closesthestream,releasinganyassociatedresources.

publicoverridevoidClose();

BZip2InputStream.CloseMethod

Flushesthestream.

publicoverridevoidFlush();

BZip2InputStream.FlushMethod

Readasequenceofbytesandadvancesthereadpositionbyonebyte.

publicoverrideintRead(

byte[]b,

intoffset,

intcount

Parametersb

Arrayofbytestostorevaluesin

offsetOffsetinarraytobeginstoringdata

countThemaximumnumberofbytestoread

ReturnValueThetotalnumberofbytesreadintothebuffer.Thismightbelessthanthenumberofbytesrequestedifthatnumberofbytesarenotcurrentlyavailableorzeroiftheendofthestreamisreached.

BZip2InputStream.ReadMethod

Readabytefromstreamadvancingposition

publicoverrideintReadByte();

ReturnValuebytereador-1onendofstream

BZip2InputStream.ReadByteMethod

Setthestreamsposition.ThisoperationisnotsupportedandwillthrowaNotSupportedException

publicoverridelongSeek(

longoffset,

SeekOriginorigin

ExceptionsExceptionType ConditionNotSupportedException Anyaccess

BZip2InputStream.SeekMethod

Setsthelengthofthisstreamtothegivenvalue.ThisoperationisnotsupportedandwillthrowaNotSupportedExceptionortedException

publicoverridevoidSetLength(

longval

BZip2InputStream.SetLengthMethod

Writesablockofbytestothisstreamusingdatafromabuffer.ThisoperationisnotsupportedandwillthrowaNotSupportedException

publicoverridevoidWrite(

byte[]array,

intoffset,

intcount

BZip2InputStream.WriteMethod

Writesabytetothecurrentpositioninthefilestream.ThisoperationisnotsupportedandwillthrowaNotSupportedException

publicoverridevoidWriteByte(

byteval

BZip2InputStream.WriteByteMethod

AnoutputstreamthatcompressesintotheBZip2formatincludingfileheadercharsintoanotherstream.

Foralistofallmembersofthistype,seeBZip2OutputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.BZip2.BZip2OutputStream

publicclassBZip2OutputStream:Stream

SeeAlsoBZip2OutputStreamMembers|ICSharpCode.SharpZipLib.BZip2Namespace

BZip2OutputStreamClass

BZip2OutputStreamoverview

PublicInstanceConstructorsBZip2OutputStream Overloaded.Initializesanew

instanceoftheBZip2OutputStreamclass.

PublicInstancePropertiesCanRead Getsavalueindicatingwhether

thecurrentstreamsupportsreading

CanSeek Getsavalueindicatingwhetherthecurrentstreamsupportsseeking

CanWrite Getsavalueindicatingwhetherthecurrentstreamsupportswriting

Length Getsthelengthinbytesofthestream

Position Getsorsetsthecurrentpositionofthisstream.

PublicInstanceMethodsBeginRead(inheritedfrom

Stream)Beginsanasynchronousreadoperation.

Close Endthecurrentblockandendcompression.Closethestreamandfreeanyresources

Createsanobjectthatcontainsalltherelevantinformation

BZip2OutputStreamMembers

requiredtogenerateaproxyusedtocommunicatewitharemoteobject.

Equals(inheritedfromObject) DetermineswhetherthespecifiedObjectisequaltothecurrentObject.

Flush Flushoutputbuffers

Read Readablockofbytes

ReadByte Readabytefromthestreamadvancingtheposition.

Seek Setsthecurrentpositionofthisstreamtothegivenvalue.

SetLength Setsthelengthofthisstreamtothegivenvalue.

Write Writeablockofbytestothestream

WriteByte Writeabytetothestream.

Finalize Freeanyresourcesandothercleanupbeforegarbagecollectionreclaimsmemory

SeeAlsoBZip2OutputStreamClass|ICSharpCode.SharpZipLib.BZip2Namespace

Constructadefaultoutputstreamwithmaximumblocksize

OverloadListConstructadefaultoutputstreamwithmaximumblocksize

publicBZip2OutputStream(Stream);

InitialiseanewinstanceoftheBZip2OutputStreamforthespecifiedstream,usingthegivenblocksize.

publicBZip2OutputStream(Stream,int);

BZip2OutputStreamConstructor

Constructadefaultoutputstreamwithmaximumblocksize

publicBZip2OutputStream(

Streamstream

Parametersstream

ThestreamtowriteBZipdataonto.

SeeAlsoBZip2OutputStreamClass|ICSharpCode.SharpZipLib.BZip2Namespace|BZip2OutputStreamConstructorOverloadList

BZip2OutputStreamConstructor(Stream)

InitialiseanewinstanceoftheBZip2OutputStreamforthespecifiedstream,usingthegivenblocksize.

publicBZip2OutputStream(

Streamstream,

intblockSize

Parametersstream

Thestreamtowritecompresseddatato.

blockSizeTheblocksizetouse.

RemarksValidblocksizesareintherange1..9,with1givingthelowestcompressionand9thehighest.

SeeAlsoBZip2OutputStreamClass|ICSharpCode.SharpZipLib.BZip2Namespace|BZip2OutputStreamConstructorOverloadList

BZip2OutputStreamConstructor(Stream,Int32)

ThepropertiesoftheBZip2OutputStreamclassarelistedbelow.ForacompletelistofBZip2OutputStreamclassmembers,seetheBZip2OutputStreamMemberstopic.

PublicInstancePropertiesCanRead Getsavalueindicatingwhether

thecurrentstreamsupportsreading

CanSeek Getsavalueindicatingwhetherthecurrentstreamsupportsseeking

CanWrite Getsavalueindicatingwhetherthecurrentstreamsupportswriting

Length Getsthelengthinbytesofthestream

Position Getsorsetsthecurrentpositionofthisstream.

BZip2OutputStreamProperties

Getsavalueindicatingwhetherthecurrentstreamsupportsreading

BZip2OutputStream.CanReadProperty

Getsavalueindicatingwhetherthecurrentstreamsupportsseeking

BZip2OutputStream.CanSeekProperty

Getsavalueindicatingwhetherthecurrentstreamsupportswriting

BZip2OutputStream.CanWriteProperty

Getsthelengthinbytesofthestream

BZip2OutputStream.LengthProperty

Getsorsetsthecurrentpositionofthisstream.

BZip2OutputStream.PositionProperty

ThemethodsoftheBZip2OutputStreamclassarelistedbelow.ForacompletelistofBZip2OutputStreamclassmembers,seetheBZip2OutputStreamMemberstopic.

Close Endthecurrentblockandendcompression.Closethestreamandfreeanyresources

Flush Flushoutputbuffers

BZip2OutputStreamMethods

Read Readablockofbytes

ReadByte Readabytefromthestreamadvancingtheposition.

Seek Setsthecurrentpositionofthisstreamtothegivenvalue.

SetLength Setsthelengthofthisstreamtothegivenvalue.

Write Writeablockofbytestothestream

WriteByte Writeabytetothestream.

Finalize Freeanyresourcesandothercleanupbeforegarbagecollectionreclaimsmemory

Endthecurrentblockandendcompression.Closethestreamandfreeanyresources

BZip2OutputStream.CloseMethod

Freeanyresourcesandothercleanupbeforegarbagecollectionreclaimsmemory

protectedoverridevoidFinalize();

BZip2OutputStream.FinalizeMethod

Flushoutputbuffers

BZip2OutputStream.FlushMethod

Readablockofbytes

byte[]b,

intoff,

intlen

BZip2OutputStream.ReadMethod

Readabytefromthestreamadvancingtheposition.

BZip2OutputStream.ReadByteMethod

Setsthecurrentpositionofthisstreamtothegivenvalue.

longoffset,

SeekOriginorigin

BZip2OutputStream.SeekMethod

Setsthelengthofthisstreamtothegivenvalue.

longval

BZip2OutputStream.SetLengthMethod

Writeablockofbytestothestream

byte[]buf,

intoff,

intlen

BZip2OutputStream.WriteMethod

Writeabytetothestream.

bytebv

BZip2OutputStream.WriteByteMethod

Namespacehierarchy

ClassesClass DescriptionAdler32 ComputesAdler32checksumforastreamofdata.AnAdler32checksumis

notasreliableasaCRC32checksum,butalotfastertocompute.ThespecificationforAdler32maybefoundinRFC1950.ZLIBCompressedDataFormatSpecificationversion3.3)Fromthatdocument:"ADLER32(Adler-32checksum)Thiscontainsachecksumvalueoftheuncompresseddata(excludinganydictionarydata)computedaccordingtoAdler-32algorithm.Thisalgorithmisa32-bitextensionandimprovementoftheFletcheralgorithm,usedintheITU-TX.224/ISO8073standard.Adler-32iscomposedoftwosumsaccumulatedperbyte:s1isthesumofallbytes,s2isthesumofalls1values.Bothsumsaredonemodulo65521.s1isinitializedto1,s2tozero.TheAdler-32checksumisstoredass2*65536+s1inmost-significant-bytefirst(network)order.""8.2.TheAdler-32algorithmTheAdler-32algorithmismuchfasterthantheCRC32algorithmyetstillprovidesanextremelylowprobabilityofundetectederrors.Themoduloonunsignedlongaccumulatorscanbedelayedfor5552bytes,sothemodulooperationtimeisnegligible.Ifthebytesarea,b,c,thesecondsumis3a+2b+c+3,andsoispositionandordersensitive,unlikethefirstsum,whichisjustachecksum.That65521isprimeisimportanttoavoidapossiblelargeclassoftwo-byteerrorsthatleavethecheckunchanged.(TheFletcherchecksumuses255,whichisnotprimeandwhichalsomakestheFletchercheckinsensitivetosinglebytechanges0-255.)Thesums1isinitializedto1insteadofzerotomakethelengthofthesequencepartofs2,sothatthelengthdoesnothavetobecheckedseparately.(AnysequenceofzeroeshasaFletcherchecksumofzero.)"

Crc32 Generateatableforabyte-wise32-bitCRCcalculationonthepolynomial: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.PolynomialsoverGF(2)arerepresentedinbinary,onebitpercoefficient,withthelowestpowersinthemostsignificantbit.Thenaddingpolynomialsisjustexclusive-or,andmultiplyingapolynomialbyxisarightshiftbyone.Ifwecalltheabovepolynomialp,andrepresentabyteasthepolynomialq,alsowiththelowestpowerinthemostsignificantbit(sothebyte0xb1isthe

ICSharpCode.SharpZipLib.ChecksumsNamespace

polynomialx^7+x^3+x+1),thentheCRCis(q*x^32)modp,whereamodbmeanstheremainderafterdividingabyb.Thiscalculationisdoneusingtheshift-registermethodofmultiplyingandtakingtheremainder.Theregisterisinitializedtozero,andforeachincomingbit,x^32isaddedmodptotheregisterifthebitisaone(wherex^32modpisp+x^32=x^26+...+1),andtheregisterismultipliedmodpbyx(whichisshiftingrightbyoneandaddingx^32modpifthebitshiftedoutisaone).Westartwiththehighestpower(leastsignificantbit)ofqandrepeatforalleightbitsofq.ThetableissimplytheCRCofallpossibleeightbitvalues.ThisisalltheinformationneededtogenerateCRC'sondataabyteatatimeforallcombinationsofCRCregistervaluesandincomingbytes.

StrangeCRC Bzip2checksumalgorithm

InterfacesInterface DescriptionIChecksum Interfacetocomputeadata

checksumusedbycheckedinput/outputstreams.Adatachecksumcanbeupdatedbyonebyteorwithabytearray.Aftereachupdatethevalueofthecurrentchecksumcanbereturnedbycalling

getValue

.Thecompletechecksumobjectcanalsoberesetsoitcanbeusedagainwithnewdata.

ComputesAdler32checksumforastreamofdata.AnAdler32checksumisnotasreliableasaCRC32checksum,butalotfastertocompute.ThespecificationforAdler32maybefoundinRFC1950.ZLIBCompressedDataFormatSpecificationversion3.3)Fromthatdocument:"ADLER32(Adler-32checksum)Thiscontainsachecksumvalueoftheuncompresseddata(excludinganydictionarydata)computedaccordingtoAdler-32algorithm.Thisalgorithmisa32-bitextensionandimprovementoftheFletcheralgorithm,usedintheITU-TX.224/ISO8073standard.Adler-32iscomposedoftwosumsaccumulatedperbyte:s1isthesumofallbytes,s2isthesumofalls1values.Bothsumsaredonemodulo65521.s1isinitializedto1,s2tozero.TheAdler-32checksumisstoredass2*65536+s1inmost-significant-bytefirst(network)order.""8.2.TheAdler-32algorithmTheAdler-32algorithmismuchfasterthantheCRC32algorithmyetstillprovidesanextremelylowprobabilityofundetectederrors.Themoduloonunsignedlongaccumulatorscanbedelayedfor5552bytes,sothemodulooperationtimeisnegligible.Ifthebytesarea,b,c,thesecondsumis3a+2b+c+3,andsoispositionandordersensitive,unlikethefirstsum,whichisjustachecksum.That65521isprimeisimportanttoavoidapossiblelargeclassoftwo-byteerrorsthatleavethecheckunchanged.(TheFletcherchecksumuses255,whichisnotprimeandwhichalsomakestheFletchercheckinsensitivetosinglebytechanges0-255.)Thesums1isinitializedto1insteadofzerotomakethelengthofthesequencepartofs2,sothatthelengthdoesnothavetobecheckedseparately.(AnysequenceofzeroeshasaFletcherchecksumofzero.)"

Foralistofallmembersofthistype,seeAdler32Members.

System.ObjectICSharpCode.SharpZipLib.Checksums.Adler32

publicsealedclassAdler32:IChecksum

ThreadSafetyPublicstatic(SharedinVisualBasic)membersofthistypearesafeformultithreadedoperations.Instancemembersarenotguaranteed

Adler32Class

tobethread-safe.

RequirementsNamespace:ICSharpCode.SharpZipLib.ChecksumsAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoAdler32Members|ICSharpCode.SharpZipLib.ChecksumsNamespace

Adler32overview

PublicInstanceConstructorsAdler32Constructor Createsanewinstanceofthe

Adler32class.Thechecksumstartsoffwithavalueof1.

PublicInstancePropertiesValue ReturnstheAdler32data

checksumcomputedsofar.

Reset ResetstheAdler32checksumtotheinitialvalue.

Update Overloaded.Updatesthechecksumwiththebytestakenfromthearray.

SeeAlsoAdler32Class|ICSharpCode.SharpZipLib.ChecksumsNamespace

Adler32Members

CreatesanewinstanceoftheAdler32class.Thechecksumstartsoffwithavalueof1.

publicAdler32();

Adler32Constructor

ThepropertiesoftheAdler32classarelistedbelow.ForacompletelistofAdler32classmembers,seetheAdler32Memberstopic.

PublicInstancePropertiesValue ReturnstheAdler32data

Adler32Properties

ReturnstheAdler32datachecksumcomputedsofar.

publiclongValue{get;}

ImplementsIChecksum.Value

Adler32.ValueProperty

ThemethodsoftheAdler32classarelistedbelow.ForacompletelistofAdler32classmembers,seetheAdler32Memberstopic.

Reset ResetstheAdler32checksumtotheinitialvalue.

Update Overloaded.Updatesthechecksumwiththebytestakenfromthearray.

Adler32Methods

ResetstheAdler32checksumtotheinitialvalue.

publicvoidReset();

ImplementsIChecksum.Reset

Adler32.ResetMethod

Updatesthechecksumwithanarrayofbytes.

OverloadListUpdatesthechecksumwithanarrayofbytes.

publicvoidUpdate(byte[]);

Updatesthechecksumwiththebytestakenfromthearray.

publicvoidUpdate(byte[],int,int);

Updatesthechecksumwiththebyteb.

publicvoidUpdate(int);

Adler32.UpdateMethod

Updatesthechecksumwithanarrayofbytes.

publicvoidUpdate(

byte[]buffer

Parametersbuffer

Thesourceofthedatatoupdatewith.

ImplementsIChecksum.Update

SeeAlsoAdler32Class|ICSharpCode.SharpZipLib.ChecksumsNamespace|Adler32.UpdateOverloadList

Adler32.UpdateMethod(Byte[])

publicvoidUpdate(

byte[]buf,

intoff,

intlen

Parametersbuf

anarrayofbytes

offthestartofthedatausedforthisupdate

lenthenumberofbytestouseforthisupdate

Adler32.UpdateMethod(Byte[],Int32,Int32)

Updatesthechecksumwiththebyteb.

publicvoidUpdate(

intbval

Parametersbval

Thedatavaluetoadd.Thehighbyteoftheintisignored.

Adler32.UpdateMethod(Int32)

Generateatableforabyte-wise32-bitCRCcalculationonthepolynomial: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.PolynomialsoverGF(2)arerepresentedinbinary,onebitpercoefficient,withthelowestpowersinthemostsignificantbit.Thenaddingpolynomialsisjustexclusive-or,andmultiplyingapolynomialbyxisarightshiftbyone.Ifwecalltheabovepolynomialp,andrepresentabyteasthepolynomialq,alsowiththelowestpowerinthemostsignificantbit(sothebyte0xb1isthepolynomialx^7+x^3+x+1),thentheCRCis(q*x^32)modp,whereamodbmeanstheremainderafterdividingabyb.Thiscalculationisdoneusingtheshift-registermethodofmultiplyingandtakingtheremainder.Theregisterisinitializedtozero,andforeachincomingbit,x^32isaddedmodptotheregisterifthebitisaone(wherex^32modpisp+x^32=x^26+...+1),andtheregisterismultipliedmodpbyx(whichisshiftingrightbyoneandaddingx^32modpifthebitshiftedoutisaone).Westartwiththehighestpower(leastsignificantbit)ofqandrepeatforalleightbitsofq.ThetableissimplytheCRCofallpossibleeightbitvalues.ThisisalltheinformationneededtogenerateCRC'sondataabyteatatimeforallcombinationsofCRCregistervaluesandincomingbytes.

Foralistofallmembersofthistype,seeCrc32Members.

System.ObjectICSharpCode.SharpZipLib.Checksums.Crc32

publicsealedclassCrc32:IChecksum

RequirementsNamespace:ICSharpCode.SharpZipLib.ChecksumsAssembly:ICSharpCode.SharpZipLib(in

Crc32Class

ICSharpCode.SharpZipLib.dll)

SeeAlsoCrc32Members|ICSharpCode.SharpZipLib.ChecksumsNamespace

Crc32overview

PublicInstanceConstructorsCrc32Constructor Initializesanewinstanceofthe

Crc32class.

PublicInstancePropertiesValue ReturnstheCRC32data

Reset ResetstheCRC32datachecksumasifnoupdatewasevercalled.

Update Overloaded.Addsthebytearraytothedatachecksum.

SeeAlsoCrc32Class|ICSharpCode.SharpZipLib.ChecksumsNamespace

Crc32Members

InitializesanewinstanceoftheCrc32class.

publicCrc32();

Crc32Constructor

ThepropertiesoftheCrc32classarelistedbelow.ForacompletelistofCrc32classmembers,seetheCrc32Memberstopic.

PublicInstancePropertiesValue ReturnstheCRC32data

Crc32Properties

ReturnstheCRC32datachecksumcomputedsofar.

publiclongValue{get;set;}

Crc32.ValueProperty

ThemethodsoftheCrc32classarelistedbelow.ForacompletelistofCrc32classmembers,seetheCrc32Memberstopic.

Reset ResetstheCRC32datachecksumasifnoupdatewasevercalled.

Crc32Methods

ResetstheCRC32datachecksumasifnoupdatewasevercalled.

publicvoidReset();

Crc32.ResetMethod

OverloadListUpdatesthechecksumwiththebytestakenfromthearray.

Addsthebytearraytothedatachecksum.

Updatesthechecksumwiththeintbval.

Crc32.UpdateMethod

publicvoidUpdate(

byte[]buffer

Parametersbuffer

bufferanarrayofbytes

SeeAlsoCrc32Class|ICSharpCode.SharpZipLib.ChecksumsNamespace|Crc32.UpdateOverloadList

Crc32.UpdateMethod(Byte[])

publicvoidUpdate(

byte[]buf,

intoff,

intlen

Parametersbuf

thebufferwhichcontainsthedata

offtheoffsetinthebufferwherethedatastarts

lenthelengthofthedata

Crc32.UpdateMethod(Byte[],Int32,Int32)

Updatesthechecksumwiththeintbval.

publicvoidUpdate(

intbval

Parametersbval

thebyteistakenasthelower8bitsofbval

Crc32.UpdateMethod(Int32)

Interfacetocomputeadatachecksumusedbycheckedinput/outputstreams.Adatachecksumcanbeupdatedbyonebyteorwithabytearray.Aftereachupdatethevalueofthecurrentchecksumcanbereturnedbycalling

getValue

.Thecompletechecksumobjectcanalsoberesetsoitcanbeusedagainwithnewdata.

Foralistofallmembersofthistype,seeIChecksumMembers.

publicinterfaceIChecksum

TypesthatimplementIChecksumType DescriptionAdler32 ComputesAdler32checksumforastreamofdata.AnAdler32checksumis

notasreliableasaCRC32checksum,butalotfastertocompute.ThespecificationforAdler32maybefoundinRFC1950.ZLIBCompressedDataFormatSpecificationversion3.3)Fromthatdocument:"ADLER32(Adler-32checksum)Thiscontainsachecksumvalueoftheuncompresseddata(excludinganydictionarydata)computedaccordingtoAdler-32algorithm.Thisalgorithmisa32-bitextensionandimprovementoftheFletcheralgorithm,usedintheITU-TX.224/ISO8073standard.Adler-32iscomposedoftwosumsaccumulatedperbyte:s1isthesumofallbytes,s2isthesumofalls1values.Bothsumsaredonemodulo65521.s1isinitializedto1,s2tozero.TheAdler-32checksumisstoredass2*65536+s1inmost-significant-bytefirst(network)order.""8.2.TheAdler-32algorithmTheAdler-32algorithmismuchfasterthantheCRC32algorithmyetstillprovidesanextremelylowprobabilityofundetectederrors.Themoduloonunsignedlongaccumulatorscanbedelayedfor5552bytes,sothemodulooperationtimeisnegligible.Ifthebytesarea,b,c,thesecondsumis3a+2b+c+3,andsoispositionandordersensitive,unlikethefirstsum,whichisjustachecksum.That65521isprimeisimportanttoavoidapossiblelargeclassoftwo-byteerrorsthatleavethecheckunchanged.(TheFletcherchecksumuses255,whichisnotprimeandwhichalso

IChecksumInterface

makestheFletchercheckinsensitivetosinglebytechanges0-255.)Thesums1isinitializedto1insteadofzerotomakethelengthofthesequencepartofs2,sothatthelengthdoesnothavetobecheckedseparately.(AnysequenceofzeroeshasaFletcherchecksumofzero.)"

Crc32 Generateatableforabyte-wise32-bitCRCcalculationonthepolynomial: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.PolynomialsoverGF(2)arerepresentedinbinary,onebitpercoefficient,withthelowestpowersinthemostsignificantbit.Thenaddingpolynomialsisjustexclusive-or,andmultiplyingapolynomialbyxisarightshiftbyone.Ifwecalltheabovepolynomialp,andrepresentabyteasthepolynomialq,alsowiththelowestpowerinthemostsignificantbit(sothebyte0xb1isthepolynomialx^7+x^3+x+1),thentheCRCis(q*x^32)modp,whereamodbmeanstheremainderafterdividingabyb.Thiscalculationisdoneusingtheshift-registermethodofmultiplyingandtakingtheremainder.Theregisterisinitializedtozero,andforeachincomingbit,x^32isaddedmodptotheregisterifthebitisaone(wherex^32modpisp+x^32=x^26+...+1),andtheregisterismultipliedmodpbyx(whichisshiftingrightbyoneandaddingx^32modpifthebitshiftedoutisaone).Westartwiththehighestpower(leastsignificantbit)ofqandrepeatforalleightbitsofq.ThetableissimplytheCRCofallpossibleeightbitvalues.ThisisalltheinformationneededtogenerateCRC'sondataabyteatatimeforallcombinationsofCRCregistervaluesandincomingbytes.

StrangeCRC Bzip2checksumalgorithm

SeeAlsoIChecksumMembers|ICSharpCode.SharpZipLib.ChecksumsNamespace

IChecksumoverview

PublicInstancePropertiesValue Returnsthedatachecksum

computedsofar.

PublicInstanceMethodsReset Resetsthedatachecksumasif

noupdatewasevercalled.

SeeAlsoIChecksumInterface|ICSharpCode.SharpZipLib.ChecksumsNamespace

IChecksumMembers

ThepropertiesoftheIChecksuminterfacearelistedbelow.ForacompletelistofIChecksuminterfacemembers,seetheIChecksumMemberstopic.

PublicInstancePropertiesValue Returnsthedatachecksum

computedsofar.

IChecksumProperties

Returnsthedatachecksumcomputedsofar.

longValue{get;}

IChecksum.ValueProperty

ThemethodsoftheIChecksuminterfacearelistedbelow.ForacompletelistofIChecksuminterfacemembers,seetheIChecksumMemberstopic.

PublicInstanceMethodsReset Resetsthedatachecksumasif

noupdatewasevercalled.

IChecksumMethods

Resetsthedatachecksumasifnoupdatewasevercalled.

voidReset();

IChecksum.ResetMethod

Updatesthedatachecksumwiththebytestakenfromthearray.

OverloadListUpdatesthedatachecksumwiththebytestakenfromthearray.

voidUpdate(byte[]);

voidUpdate(byte[],int,int);

Addsonebytetothedatachecksum.

voidUpdate(int);

IChecksum.UpdateMethod

Updatesthedatachecksumwiththebytestakenfromthearray.

voidUpdate(

byte[]buffer

Parametersbuffer

bufferanarrayofbytes

SeeAlsoIChecksumInterface|ICSharpCode.SharpZipLib.ChecksumsNamespace|IChecksum.UpdateOverloadList

IChecksum.UpdateMethod(Byte[])

voidUpdate(

byte[]buf,

intoff,

intlen

Parametersbuf

thebufferwhichcontainsthedata

offtheoffsetinthebufferwherethedatastarts

lenthelengthofthedata

IChecksum.UpdateMethod(Byte[],Int32,Int32)

Addsonebytetothedatachecksum.

voidUpdate(

intbval

Parametersbval

thedatavaluetoadd.Thehighbyteoftheintisignored.

IChecksum.UpdateMethod(Int32)

Bzip2checksumalgorithm

Foralistofallmembersofthistype,seeStrangeCRCMembers.

System.ObjectICSharpCode.SharpZipLib.Checksums.StrangeCRC

publicclassStrangeCRC:IChecksum

SeeAlsoStrangeCRCMembers|ICSharpCode.SharpZipLib.ChecksumsNamespace

StrangeCRCClass

StrangeCRCoverview

PublicInstanceConstructorsStrangeCRCConstructor Initialiseadefaultinstanceof

StrangeCRC

PublicInstancePropertiesValue GetthecurrentCrcvalue.

Reset ResetthestateofCrc.

Update Overloaded.UpdateCrcbasedonaportionofablockofdata

StrangeCRCMembers

SeeAlsoStrangeCRCClass|ICSharpCode.SharpZipLib.ChecksumsNamespace

InitialiseadefaultinstanceofStrangeCRC

publicStrangeCRC();

StrangeCRCConstructor

ThepropertiesoftheStrangeCRCclassarelistedbelow.ForacompletelistofStrangeCRCclassmembers,seetheStrangeCRCMemberstopic.

PublicInstancePropertiesValue GetthecurrentCrcvalue.

StrangeCRCProperties

GetthecurrentCrcvalue.

publiclongValue{get;}

StrangeCRC.ValueProperty

ThemethodsoftheStrangeCRCclassarelistedbelow.ForacompletelistofStrangeCRCclassmembers,seetheStrangeCRCMemberstopic.

Reset ResetthestateofCrc.

Update Overloaded.UpdateCrcbasedonaportionofablockofdata

StrangeCRCMethods

ResetthestateofCrc.

publicvoidReset();

StrangeCRC.ResetMethod

UpdateCrcbasedonablockofdata

OverloadListUpdateCrcbasedonablockofdata

UpdateCrcbasedonaportionofablockofdata

UpdatetheCrcvalue.

StrangeCRC.UpdateMethod

UpdateCrcbasedonablockofdata

publicvoidUpdate(

byte[]buf

SeeAlsoStrangeCRCClass|ICSharpCode.SharpZipLib.ChecksumsNamespace|StrangeCRC.UpdateOverloadList

StrangeCRC.UpdateMethod(Byte[])

UpdateCrcbasedonaportionofablockofdata

publicvoidUpdate(

byte[]buf,

intoff,

intlen

Parametersbuf

blockofdata

offindexoffirstbytetouse

lennumberofbytestouse

StrangeCRC.UpdateMethod(Byte[],Int32,Int32)

UpdatetheCrcvalue.

publicvoidUpdate(

intinCh

ParametersinCh

dataupdateisbasedon

StrangeCRC.UpdateMethod(Int32)

Namespacehierarchy

ClassesClass DescriptionDirectoryEventArgs Eventargumentsfordirectories.

FileSystemScanner FileSystemScannerprovidesfacilitiesscanningoffilesanddirectories.

NameAndSizeFilter NameAnsSizeFilterfiltersbasedonnameandfilesize.

NameFilter NameFilterisastringmatchingclasswhichallowsforbothpositiveandnegativematching.AfilterisasequenceofindependantRegexregularexpressionsseparatedbysemi-colons';'Eachexpressioncanbeprefixedbyaplus'+'signoraminus'-'signtodenotetheexpressionisintendedtoincludeorexcludenames.IfneitheraplusorminussignisfoundincludeisthedefaultAgivennameistestedforinclusionbeforecheckingexclusions.Onlynamesmatchinganincludespecandnotmatchinganexcludespecaredeemedtomatchthefilter.Anemptyfiltermatchesanyname.

PathFilter PathFilterfiltersdirectoriesandfilesbyfullpathname.

ICSharpCode.SharpZipLib.CoreNamespace

ScanEventArgs Eventargumentsforscanning.

ScanFailureEventArgs Argumentspassedwhenscanfailuresaredetected.

InterfacesInterface DescriptionINameTransform INameTransformdefineshow

filesystemnamesaretransformedforusewitharchives.

IScanFilter Scanningfilterssupporttheseoperations.

DelegatesDelegate DescriptionDirectoryFailureDelegate Delegateinvokedwhena

directoryfailureisdetected.

FileFailureDelegate Delegateinvokedwhenafilefailureisdetected.

ProcessDirectoryDelegate Delegateinvokkedwhenadirectoryisprocessed.

ProcessFileDelegate Delegateinvokedwhenafileisprocessed.

Eventargumentsfordirectories.

Foralistofallmembersofthistype,seeDirectoryEventArgsMembers.

System.ObjectSystem.EventArgsICSharpCode.SharpZipLib.Core.ScanEventArgsICSharpCode.SharpZipLib.Core.DirectoryEventArgs

publicclassDirectoryEventArgs:

ScanEventArgs

RequirementsNamespace:ICSharpCode.SharpZipLib.CoreAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoDirectoryEventArgsMembers|ICSharpCode.SharpZipLib.CoreNamespace

DirectoryEventArgsClass

DirectoryEventArgsoverview

PublicInstanceConstructorsDirectoryEventArgs

ConstructorInitializeaninstanceofDirectoryEventArgs.

PublicInstancePropertiesContinueRunning(inherited

fromScanEventArgs)Getsetavalueindicatingifscanningshouldcontinueornot.

HasMatchingFiles Getavalueindicatingifthedirectorycontainsanymatchingfilesornot.

Name(inheritedfromScanEventArgs)

Thenameforthisevent.

Object)AllowsanObjecttoattempttofreeresourcesandperform

DirectoryEventArgsMembers

othercleanupoperationsbeforetheObjectisreclaimedbygarbagecollection.

SeeAlsoDirectoryEventArgsClass|ICSharpCode.SharpZipLib.CoreNamespace

InitializeaninstanceofDirectoryEventArgs.

publicDirectoryEventArgs(

stringname,

boolhasMatchingFiles

Parametersname

Thenameforthisdirectory.

hasMatchingFilesFlagvalueindicatingifanymatchingfilesarecontainedinthisdirectory.

DirectoryEventArgsConstructor

ThepropertiesoftheDirectoryEventArgsclassarelistedbelow.ForacompletelistofDirectoryEventArgsclassmembers,seetheDirectoryEventArgsMemberstopic.

PublicInstancePropertiesContinueRunning(inherited

fromScanEventArgs)Getsetavalueindicatingifscanningshouldcontinueornot.

HasMatchingFiles Getavalueindicatingifthedirectorycontainsanymatchingfilesornot.

Name(inheritedfromScanEventArgs)

DirectoryEventArgsProperties

Getavalueindicatingifthedirectorycontainsanymatchingfilesornot.

publicboolHasMatchingFiles{get;}

DirectoryEventArgs.HasMatchingFilesProperty

Delegateinvokedwhenadirectoryfailureisdetected.

publicdelegatevoidDirectoryFailureDelegate(

objectsender,

ScanFailureEventArgse

SeeAlsoICSharpCode.SharpZipLib.CoreNamespace

DirectoryFailureDelegateDelegate

Delegateinvokedwhenafilefailureisdetected.

publicdelegatevoidFileFailureDelegate(

objectsender,

ScanFailureEventArgse

FileFailureDelegateDelegate

FileSystemScannerprovidesfacilitiesscanningoffilesanddirectories.

Foralistofallmembersofthistype,seeFileSystemScannerMembers.

System.ObjectICSharpCode.SharpZipLib.Core.FileSystemScanner

publicclassFileSystemScanner

SeeAlsoFileSystemScannerMembers|ICSharpCode.SharpZipLib.CoreNamespace

FileSystemScannerClass

FileSystemScanneroverview

PublicInstanceConstructorsFileSystemScanner Overloaded.Initializesanew

instanceoftheFileSystemScannerclass.

PublicInstanceFieldsDirectoryFailure Delegatetoinvokewhena

FileFailure Delegatetoinvokewhenafilefailureisdetected.

ProcessDirectory Delegatetoinvokewhenadirectoryisprocessed.

ProcessFile Delegatetoinvokewhenafileisprocessed.

OnDirectoryFailure RaisetheDirectoryFailureevent.

OnFileFailure RaisetheFileFailureevent.

OnProcessDirectory RaisetheProcessDirectory

FileSystemScannerMembers

event.

OnProcessFile RaisetheProcessFileevent.

Scan Scanadirectory.

SeeAlsoFileSystemScannerClass|ICSharpCode.SharpZipLib.CoreNamespace

InitialiseanewinstanceofFileSystemScanner

OverloadListInitialiseanewinstanceofFileSystemScanner

publicFileSystemScanner(IScanFilter);

publicFileSystemScanner(IScanFilter,IScanFilter);

publicFileSystemScanner(string);

publicFileSystemScanner(string,string);

FileSystemScannerConstructor

publicFileSystemScanner(

stringfilter

Parametersfilter

Thefilefiltertoapplywhenscanning.

SeeAlsoFileSystemScannerClass|ICSharpCode.SharpZipLib.CoreNamespace|FileSystemScannerConstructorOverloadList

FileSystemScannerConstructor(String)

stringfileFilter,

stringdirectoryFilter

ParametersfileFilter

ThefileNameFilterfiltertoapply.

directoryFilterThedirectoryNameFilterfiltertoapply.

FileSystemScannerConstructor(String,String)

IScanFilterfileFilter

ThefileNameFilterfiltertoapply.

FileSystemScannerConstructor(IScanFilter)

IScanFilterfileFilter,

IScanFilterdirectoryFilter

ThefileIScanFilterfiltertoapply.

directoryFilterThedirectoryIScanFilterfiltertoapply.

FileSystemScannerConstructor(IScanFilter,IScanFilter)

ThefieldsoftheFileSystemScannerclassarelistedbelow.ForacompletelistofFileSystemScannerclassmembers,seetheFileSystemScannerMemberstopic.

PublicInstanceFieldsDirectoryFailure Delegatetoinvokewhena

FileFailure Delegatetoinvokewhenafilefailureisdetected.

ProcessDirectory Delegatetoinvokewhenadirectoryisprocessed.

ProcessFile Delegatetoinvokewhenafileisprocessed.

FileSystemScannerFields

Delegatetoinvokewhenadirectoryfailureisdetected.

publicDirectoryFailureDelegateDirectoryFailure;

FileSystemScanner.DirectoryFailureField

Delegatetoinvokewhenafilefailureisdetected.

publicFileFailureDelegateFileFailure;

FileSystemScanner.FileFailureField

Delegatetoinvokewhenadirectoryisprocessed.

publicProcessDirectoryDelegateProcessDirectory;

FileSystemScanner.ProcessDirectoryField

Delegatetoinvokewhenafileisprocessed.

publicProcessFileDelegateProcessFile;

FileSystemScanner.ProcessFileField

ThemethodsoftheFileSystemScannerclassarelistedbelow.ForacompletelistofFileSystemScannerclassmembers,seetheFileSystemScannerMemberstopic.

OnDirectoryFailure RaisetheDirectoryFailureevent.

OnFileFailure RaisetheFileFailureevent.

OnProcessDirectory RaisetheProcessDirectoryevent.

OnProcessFile RaisetheProcessFileevent.

Scan Scanadirectory.

MemberwiseClone(inherited Createsashallowcopyofthe

FileSystemScannerMethods

fromObject) currentObject.

RaisetheDirectoryFailureevent.

publicvoidOnDirectoryFailure(

stringdirectory,

Exceptione

Parametersdirectory

Rhedirectoryname.

eTheexceptiondetected.

FileSystemScanner.OnDirectoryFailureMethod

RaisetheFileFailureevent.

publicvoidOnFileFailure(

stringfile,

Exceptione

Parametersfile

Thefilename.

eTheexceptiondetected.

FileSystemScanner.OnFileFailureMethod

RaisetheProcessDirectoryevent.

publicvoidOnProcessDirectory(

stringdirectory,

Parametersdirectory

Thedirectoryname.

hasMatchingFilesFlagindicatingifthedirectoryhasmatchingfiles.

FileSystemScanner.OnProcessDirectoryMethod

RaisetheProcessFileevent.

publicvoidOnProcessFile(

stringfile

Parametersfile

Thefilename.

FileSystemScanner.OnProcessFileMethod

Scanadirectory.

publicvoidScan(

stringdirectory,

boolrecurse

Parametersdirectory

Thebasedirectorytoscan.

recurseTruetorecursesubdirectories,falsetodoasingledirectory.

FileSystemScanner.ScanMethod

INameTransformdefineshowfilesystemnamesaretransformedforusewitharchives.

Foralistofallmembersofthistype,seeINameTransformMembers.

publicinterfaceINameTransform

TypesthatimplementINameTransformType DescriptionZipNameTransform ZipNameTransformtransforms

nameaspertheZipfileconvention.

SeeAlsoINameTransformMembers|ICSharpCode.SharpZipLib.CoreNamespace

INameTransformInterface

INameTransformoverview

PublicInstanceMethodsTransformDirectory Givenadirectoryname

determinethetransformedequivalent.

TransformFile Givenafilenamedeterminethetransformedequivalent.

SeeAlsoINameTransformInterface|ICSharpCode.SharpZipLib.CoreNamespace

INameTransformMembers

ThemethodsoftheINameTransforminterfacearelistedbelow.ForacompletelistofINameTransforminterfacemembers,seetheINameTransformMemberstopic.

PublicInstanceMethodsTransformDirectory Givenadirectoryname

determinethetransformedequivalent.

TransformFile Givenafilenamedeterminethetransformedequivalent.

INameTransformMethods

Givenadirectorynamedeterminethetransformedequivalent.

stringTransformDirectory(

stringname

Parametersname

Thenametotransform.

ReturnValueThetransformeddirectoryname

INameTransform.TransformDirectoryMethod

Givenafilenamedeterminethetransformedequivalent.

stringTransformFile(

stringname

Parametersname

Thenametotransform.

ReturnValueThetransformedname.

INameTransform.TransformFileMethod

Scanningfilterssupporttheseoperations.

Foralistofallmembersofthistype,seeIScanFilterMembers.

publicinterfaceIScanFilter

TypesthatimplementIScanFilterType DescriptionNameAndSizeFilter NameAnsSizeFilterfiltersbased

onnameandfilesize.

PathFilter PathFilterfiltersdirectoriesandfilesbyfullpathname.

SeeAlsoIScanFilterMembers|ICSharpCode.SharpZipLib.CoreNamespace

IScanFilterInterface

IScanFilteroverview

PublicInstanceMethodsIsMatch Testanametoseeifis

'matches'thefilter.

SeeAlsoIScanFilterInterface|ICSharpCode.SharpZipLib.CoreNamespace

IScanFilterMembers

ThemethodsoftheIScanFilterinterfacearelistedbelow.ForacompletelistofIScanFilterinterfacemembers,seetheIScanFilterMemberstopic.

PublicInstanceMethodsIsMatch Testanametoseeifis

'matches'thefilter.

IScanFilterMethods

Testanametoseeifis'matches'thefilter.

boolIsMatch(

stringname

Parametersname

Thenametotest.

ReturnValueReturnstrueifthenamematchesthefilter,falseifitdoesnotmatch.

IScanFilter.IsMatchMethod

NameAnsSizeFilterfiltersbasedonnameandfilesize.

Foralistofallmembersofthistype,seeNameAndSizeFilterMembers.

System.ObjectICSharpCode.SharpZipLib.Core.PathFilterICSharpCode.SharpZipLib.Core.NameAndSizeFilter

publicclassNameAndSizeFilter:

PathFilter

SeeAlsoNameAndSizeFilterMembers|ICSharpCode.SharpZipLib.CoreNamespace

NameAndSizeFilterClass

NameAndSizeFilteroverview

PublicInstanceConstructorsNameAndSizeFilter

ConstructorInitialiseanewinstanceofNameAndSizeFilter.

PublicInstancePropertiesMaxSize Themaximumsizeforafilethat

willmatchthisfilter.

MinSize Theminimumsizeforafilethatwillmatchthisfilter.

IsMatch Testafilenametoseeifitmatchesthefilter.

Object)AllowsanObjecttoattempttofreeresourcesandperformothercleanupoperationsbeforetheObjectisreclaimedby

NameAndSizeFilterMembers

garbagecollection.

SeeAlsoNameAndSizeFilterClass|ICSharpCode.SharpZipLib.CoreNamespace

InitialiseanewinstanceofNameAndSizeFilter.

publicNameAndSizeFilter(

stringfilter,

longminSize,

longmaxSize

Parametersfilter

Thefiltertoapply.

minSizeTheminimumfilesizetoinclude.

maxSizeThemaximumfilesizetoinclude.

NameAndSizeFilterConstructor

ThepropertiesoftheNameAndSizeFilterclassarelistedbelow.ForacompletelistofNameAndSizeFilterclassmembers,seetheNameAndSizeFilterMemberstopic.

PublicInstancePropertiesMaxSize Themaximumsizeforafilethat

willmatchthisfilter.

MinSize Theminimumsizeforafilethatwillmatchthisfilter.

NameAndSizeFilterProperties

Themaximumsizeforafilethatwillmatchthisfilter.

publiclongMaxSize{get;set;}

NameAndSizeFilter.MaxSizeProperty

Theminimumsizeforafilethatwillmatchthisfilter.

publiclongMinSize{get;set;}

NameAndSizeFilter.MinSizeProperty

ThemethodsoftheNameAndSizeFilterclassarelistedbelow.ForacompletelistofNameAndSizeFilterclassmembers,seetheNameAndSizeFilterMemberstopic.

IsMatch Testafilenametoseeifitmatchesthefilter.

NameAndSizeFilterMethods

Testafilenametoseeifitmatchesthefilter.

publicoverrideboolIsMatch(

stringfileName

ParametersfileName

Thefilenametotest.

ReturnValueTrueifthefiltermatches,falseotherwise.

ImplementsIScanFilter.IsMatch

NameAndSizeFilter.IsMatchMethod

NameFilterisastringmatchingclasswhichallowsforbothpositiveandnegativematching.AfilterisasequenceofindependantRegexregularexpressionsseparatedbysemi-colons';'Eachexpressioncanbeprefixedbyaplus'+'signoraminus'-'signtodenotetheexpressionisintendedtoincludeorexcludenames.IfneitheraplusorminussignisfoundincludeisthedefaultAgivennameistestedforinclusionbeforecheckingexclusions.Onlynamesmatchinganincludespecandnotmatchinganexcludespecaredeemedtomatchthefilter.Anemptyfiltermatchesanyname.

Foralistofallmembersofthistype,seeNameFilterMembers.

System.ObjectICSharpCode.SharpZipLib.Core.NameFilter

publicclassNameFilter

SeeAlsoNameFilterMembers|ICSharpCode.SharpZipLib.CoreNamespace

NameFilterClass

NameFilteroverview

PublicStaticMethodsIsValidExpression Testastringtoseeifitisavalid

regularexpression.

IsValidFilterExpression Testanexpressiontoseeifitisvalidasafilter.

PublicInstanceConstructorsNameFilterConstructor Constructaninstancebasedon

thefilterexpressionpassed

IsExcluded Testavaluetoseeifitisexcludedbythefilter.

IsIncluded Testavaluetoseeifitisincludedbythefilter.

IsMatch Testavaluetoseeifitmatchesthefilter.

ToString Convertthisfiltertoitsstringequivalent.

NameFilterMembers

SeeAlsoNameFilterClass|ICSharpCode.SharpZipLib.CoreNamespace

Constructaninstancebasedonthefilterexpressionpassed

publicNameFilter(

stringfilter

Parametersfilter

Thefilterexpression.

NameFilterConstructor

ThemethodsoftheNameFilterclassarelistedbelow.ForacompletelistofNameFilterclassmembers,seetheNameFilterMemberstopic.

PublicStaticMethodsIsValidExpression Testastringtoseeifitisavalid

regularexpression.

IsValidFilterExpression Testanexpressiontoseeifitisvalidasafilter.

IsExcluded Testavaluetoseeifitisexcludedbythefilter.

IsIncluded Testavaluetoseeifitisincludedbythefilter.

IsMatch Testavaluetoseeifitmatchesthefilter.

ToString Convertthisfiltertoitsstringequivalent.

NameFilterMethods

Testavaluetoseeifitisexcludedbythefilter.

publicboolIsExcluded(

stringtestValue

ParameterstestValue

Thevaluetotest.

ReturnValueTrueifthevalueisexcluded,falseotherwise.

NameFilter.IsExcludedMethod

Testavaluetoseeifitisincludedbythefilter.

publicboolIsIncluded(

stringtestValue

ParameterstestValue

Thevaluetotest.

ReturnValueTrueifthevalueisincluded,falseotherwise.

NameFilter.IsIncludedMethod

Testavaluetoseeifitmatchesthefilter.

publicboolIsMatch(

stringtestValue

ParameterstestValue

Thevaluetotest.

ReturnValueTrueifthevaluematches,falseotherwise.

NameFilter.IsMatchMethod

Testastringtoseeifitisavalidregularexpression.

publicstaticboolIsValidExpression(

stringe

Parameterse

Theexpressiontotest.

ReturnValueTrueifexpressionisavalidRegexfalseotherwise.

NameFilter.IsValidExpressionMethod

Testanexpressiontoseeifitisvalidasafilter.

publicstaticboolIsValidFilterExpression(

stringtoTest

ParameterstoTest

Thefilterexpressiontotest.

ReturnValueTrueiftheexpressionisvalid,falseotherwise.

NameFilter.IsValidFilterExpressionMethod

Convertthisfiltertoitsstringequivalent.

publicoverridestringToString();

ReturnValueThestringequivalentforthisfilter.

NameFilter.ToStringMethod

PathFilterfiltersdirectoriesandfilesbyfullpathname.

Foralistofallmembersofthistype,seePathFilterMembers.

System.ObjectICSharpCode.SharpZipLib.Core.PathFilterICSharpCode.SharpZipLib.Core.NameAndSizeFilter

publicclassPathFilter:IScanFilter

SeeAlsoPathFilterMembers|ICSharpCode.SharpZipLib.CoreNamespace

PathFilterClass

PathFilteroverview

PublicInstanceConstructorsPathFilterConstructor Initialiseanewinstanceof

PathFilter.

IsMatch Testanametoseeifitmatchesthefilter.

SeeAlsoPathFilterClass|ICSharpCode.SharpZipLib.CoreNamespace

PathFilterMembers

InitialiseanewinstanceofPathFilter.

publicPathFilter(

stringfilter

Parametersfilter

TheNameFilterfilterexpressiontoapply.

PathFilterConstructor

ThemethodsofthePathFilterclassarelistedbelow.ForacompletelistofPathFilterclassmembers,seethePathFilterMemberstopic.

IsMatch Testanametoseeifitmatchesthefilter.

PathFilterMethods

Testanametoseeifitmatchesthefilter.

publicvirtualboolIsMatch(

stringname

Parametersname

Thenametotest.

ReturnValueTrueifthenamematches,falseotherwise.

ImplementsIScanFilter.IsMatch

PathFilter.IsMatchMethod

Delegateinvokkedwhenadirectoryisprocessed.

publicdelegatevoidProcessDirectoryDelegate(

objectSender,

DirectoryEventArgse

ProcessDirectoryDelegateDelegate

Delegateinvokedwhenafileisprocessed.

publicdelegatevoidProcessFileDelegate(

objectsender,

ScanEventArgse

ProcessFileDelegateDelegate

Eventargumentsforscanning.

Foralistofallmembersofthistype,seeScanEventArgsMembers.

System.ObjectSystem.EventArgsICSharpCode.SharpZipLib.Core.ScanEventArgsICSharpCode.SharpZipLib.Core.DirectoryEventArgs

publicclassScanEventArgs:EventArgs

SeeAlsoScanEventArgsMembers|ICSharpCode.SharpZipLib.CoreNamespace

ScanEventArgsClass

ScanEventArgsoverview

PublicInstanceConstructorsScanEventArgsConstructor Initialiseanewinstanceof

ScanEventArgs

PublicInstancePropertiesContinueRunning Getsetavalueindicatingif

scanningshouldcontinueornot.

Name Thenameforthisevent.

ScanEventArgsMembers

SeeAlsoScanEventArgsClass|ICSharpCode.SharpZipLib.CoreNamespace

InitialiseanewinstanceofScanEventArgs

publicScanEventArgs(

stringname

Parametersname

ScanEventArgsConstructor

ThepropertiesoftheScanEventArgsclassarelistedbelow.ForacompletelistofScanEventArgsclassmembers,seetheScanEventArgsMemberstopic.

PublicInstancePropertiesContinueRunning Getsetavalueindicatingif

scanningshouldcontinueornot.

Name Thenameforthisevent.

ScanEventArgsProperties

Getsetavalueindicatingifscanningshouldcontinueornot.

publicboolContinueRunning{get;set;}

ScanEventArgs.ContinueRunningProperty

publicstringName{get;}

ScanEventArgs.NameProperty

Argumentspassedwhenscanfailuresaredetected.

Foralistofallmembersofthistype,seeScanFailureEventArgsMembers.

System.ObjectICSharpCode.SharpZipLib.Core.ScanFailureEventArgs

publicclassScanFailureEventArgs

SeeAlsoScanFailureEventArgsMembers|ICSharpCode.SharpZipLib.CoreNamespace

ScanFailureEventArgsClass

ScanFailureEventArgsoverview

PublicInstanceConstructorsScanFailureEventArgs

ConstructorInitialiseanewinstanceofScanFailureEventArgs

PublicInstancePropertiesContinueRunning Get/setavalueindicating

wetherscanningshouldcontinue.

Exception Theapplicableexception.

Name Theapplicablename.

ScanFailureEventArgsMembers

SeeAlsoScanFailureEventArgsClass|ICSharpCode.SharpZipLib.CoreNamespace

InitialiseanewinstanceofScanFailureEventArgs

publicScanFailureEventArgs(

stringname,

Exceptione

Parametersname

Thenametoapply.

eTheexceptiontouse.

ScanFailureEventArgsConstructor

ThepropertiesoftheScanFailureEventArgsclassarelistedbelow.ForacompletelistofScanFailureEventArgsclassmembers,seetheScanFailureEventArgsMemberstopic.

PublicInstancePropertiesContinueRunning Get/setavalueindicating

wetherscanningshouldcontinue.

Exception Theapplicableexception.

Name Theapplicablename.

ScanFailureEventArgsProperties

Get/setavalueindicatingwetherscanningshouldcontinue.

publicboolContinueRunning{get;set;}

ScanFailureEventArgs.ContinueRunningProperty

Theapplicableexception.

publicSystem.ExceptionException{get;}

ScanFailureEventArgs.ExceptionProperty

Theapplicablename.

ScanFailureEventArgs.NameProperty

Namespacehierarchy

ClassesClass DescriptionPkzipClassic PkzipClassicembodiesthe

classicororiginalencryptionfacilitiesusedinPkziparchives.Whileithasbeensupercededbymorerecentandmorepowerfulalgorithms,itsstillinuseandisviableforpreventingcasualsnooping

PkzipClassicManaged DefinesawrapperobjecttoaccessthePkzipalgorithm.Thisclasscannotbeinherited.

ICSharpCode.SharpZipLib.EncryptionNamespace

PkzipClassicembodiestheclassicororiginalencryptionfacilitiesusedinPkziparchives.Whileithasbeensupercededbymorerecentandmorepowerfulalgorithms,itsstillinuseandisviableforpreventingcasualsnooping

Foralistofallmembersofthistype,seePkzipClassicMembers.

System.ObjectSystem.Security.Cryptography.SymmetricAlgorithmICSharpCode.SharpZipLib.Encryption.PkzipClassicICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged

publicabstractclassPkzipClassic:

SymmetricAlgorithm

RequirementsNamespace:ICSharpCode.SharpZipLib.EncryptionAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoPkzipClassicMembers|ICSharpCode.SharpZipLib.EncryptionNamespace

PkzipClassicClass

PkzipClassicoverview

PublicStaticMethodsGenerateKeys Generatesnewencryptionkeys

basedongivenseed

PublicInstancePropertiesBlockSize(inheritedfrom

SymmetricAlgorithm)Getsorsetstheblocksizeofthecryptographicoperationinbits.

FeedbackSize(inheritedfromSymmetricAlgorithm)

Getsorsetsthefeedbacksizeofthecryptographicoperationinbits.

IV(inheritedfromSymmetricAlgorithm)

Getsorsetstheinitializationvector(IV)forthesymmetricalgorithm.

Key(inheritedfromSymmetricAlgorithm)

Getsorsetsthesecretkeyforthesymmetricalgorithm.

KeySize(inheritedfromSymmetricAlgorithm)

Getsorsetsthesizeofthesecretkeyusedbythesymmetricalgorithminbits.

LegalBlockSizes(inheritedfromSymmetricAlgorithm)

Getstheblocksizesthataresupportedbythesymmetricalgorithm.

LegalKeySizes(inheritedfromSymmetricAlgorithm)

Getsthekeysizesthataresupportedbythesymmetricalgorithm.

Mode(inheritedfromSymmetricAlgorithm)

Getsorsetsthemodeforoperationofthesymmetricalgorithm.

Padding(inheritedfromSymmetricAlgorithm)

Getsorsetsthepaddingmodeusedinthesymmetric

PkzipClassicMembers

algorithm.

PublicInstanceMethodsClear(inheritedfrom

SymmetricAlgorithm)ReleasesallresourcesusedbytheSymmetricAlgorithm.

CreateDecryptor(inheritedfromSymmetricAlgorithm)

Overloaded.Whenoverriddeninaderivedclass,createsasymmetricdecryptorobjectwiththespecifiedKeyandinitializationvector(IV).

CreateEncryptor(inheritedfromSymmetricAlgorithm)

Overloaded.Whenoverriddeninaderivedclass,createsasymmetricencryptorobjectwiththespecifiedKeyandinitializationvector(IV).

GenerateIV(inheritedfromSymmetricAlgorithm)

Whenoverriddeninaderivedclass,generatesarandominitializationvector(IV)tobeusedforthealgorithm.

GenerateKey(inheritedfromSymmetricAlgorithm)

Whenoverriddeninaderivedclass,generatesarandomKeytobeusedforthealgorithm.

ValidKeySize(inheritedfrom Determineswhetherthe

SymmetricAlgorithm) specifiedkeysizeisvalidforthecurrentalgorithm.

ProtectedInstanceConstructorsPkzipClassicConstructor Initializesanewinstanceofthe

PkzipClassicclass.

ProtectedInstanceFieldsBlockSizeValue(inherited

fromSymmetricAlgorithm)Representstheblocksizeofthecryptographicoperationinbits.

FeedbackSizeValue(inheritedfromSymmetricAlgorithm)

Representsthefeedbacksizeofthecryptographicoperationinbits.

IVValue(inheritedfromSymmetricAlgorithm)

Representstheinitializationvector(IV)forthesymmetricalgorithm.

KeySizeValue(inheritedfromSymmetricAlgorithm)

Representsthesizeofthesecretkeyusedbythesymmetricalgorithminbits.

KeyValue(inheritedfromSymmetricAlgorithm)

Representsthesecretkeyforthesymmetricalgorithm.

LegalBlockSizesValue(inheritedfromSymmetricAlgorithm)

Specifiestheblocksizesthataresupportedbythesymmetricalgorithm.

LegalKeySizesValue(inheritedfromSymmetricAlgorithm)

Specifiesthekeysizesthataresupportedbythesymmetricalgorithm.

ModeValue(inheritedfromSymmetricAlgorithm)

Representstheciphermodeusedinthesymmetricalgorithm.

PaddingValue(inheritedfromSymmetricAlgorithm)

Representsthepaddingmodeusedinthesymmetricalgorithm.

ProtectedInstanceMethodsDispose(inheritedfrom

SymmetricAlgorithm)ReleasestheunmanagedresourcesusedbytheSymmetricAlgorithmandoptionallyreleasesthemanagedresources.

Finalize(inheritedfromSymmetricAlgorithm)

ReleasestheunmanagedresourcesusedbytheSymmetricAlgorithm.

SeeAlsoPkzipClassicClass|ICSharpCode.SharpZipLib.EncryptionNamespace

InitializesanewinstanceofthePkzipClassicclass.

protectedPkzipClassic();

PkzipClassicConstructor

ThemethodsofthePkzipClassicclassarelistedbelow.ForacompletelistofPkzipClassicclassmembers,seethePkzipClassicMemberstopic.

PublicStaticMethodsGenerateKeys Generatesnewencryptionkeys

basedongivenseed

Overloaded.Whenoverriddeninaderivedclass,createsasymmetricdecryptorobjectwiththespecifiedKeyandinitializationvector(IV).

Overloaded.Whenoverriddeninaderivedclass,createsasymmetricencryptorobjectwiththespecifiedKeyandinitializationvector(IV).

GenerateIV(inheritedfromSymmetricAlgorithm)

Whenoverriddeninaderivedclass,generatesarandominitializationvector(IV)tobeusedforthealgorithm.

GenerateKey(inheritedfromSymmetricAlgorithm)

Whenoverriddeninaderivedclass,generatesarandomKeytobeusedforthealgorithm.

Servesasahashfunctionforaparticulartype,suitableforuse

PkzipClassicMethods

inhashingalgorithmsanddatastructureslikeahashtable.

ValidKeySize(inheritedfromSymmetricAlgorithm)

Determineswhetherthespecifiedkeysizeisvalidforthecurrentalgorithm.

ProtectedInstanceMethodsDispose(inheritedfrom

SymmetricAlgorithm)ReleasestheunmanagedresourcesusedbytheSymmetricAlgorithmandoptionallyreleasesthemanagedresources.

Finalize(inheritedfromSymmetricAlgorithm)

ReleasestheunmanagedresourcesusedbytheSymmetricAlgorithm.

Generatesnewencryptionkeysbasedongivenseed

publicstaticbyte[]GenerateKeys(

byte[]seed

PkzipClassic.GenerateKeysMethod

DefinesawrapperobjecttoaccessthePkzipalgorithm.Thisclasscannotbeinherited.

Foralistofallmembersofthistype,seePkzipClassicManagedMembers.

System.ObjectSystem.Security.Cryptography.SymmetricAlgorithmICSharpCode.SharpZipLib.Encryption.PkzipClassicICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged

publicsealedclassPkzipClassicManaged:

PkzipClassic

RequirementsNamespace:ICSharpCode.SharpZipLib.EncryptionAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoPkzipClassicManagedMembers|ICSharpCode.SharpZipLib.EncryptionNamespace

PkzipClassicManagedClass

PkzipClassicManagedoverview

PublicInstanceConstructorsPkzipClassicManaged

ConstructorInitializesanewinstanceofthePkzipClassicManagedclass.

PublicInstancePropertiesBlockSize Get/settheapplicableblock

Key Get/setthekeyvalueapplicable.

LegalBlockSizes Getanarrayoflegalblocksizes.

LegalKeySizes Getanarrayoflegalkeysizes.

Getsorsetsthepaddingmodeusedinthesymmetricalgorithm.

PublicInstanceMethods

PkzipClassicManagedMembers

Clear(inheritedfromSymmetricAlgorithm)

ReleasesallresourcesusedbytheSymmetricAlgorithm.

CreateDecryptor Overloaded.Createadecryptor.

Overloaded.CreatesasymmetricdecryptorobjectwiththecurrentKeyandinitializationvector(IV).

CreateEncryptor Overloaded.Createanencryptor.

Overloaded.CreatesasymmetricencryptorobjectwiththecurrentKeyandinitializationvector(IV).

GenerateIV Generateaninitialvector.

GenerateKey Generateanewrandomkey.

SeeAlsoPkzipClassicManagedClass|ICSharpCode.SharpZipLib.EncryptionNamespace

InitializesanewinstanceofthePkzipClassicManagedclass.

publicPkzipClassicManaged();

PkzipClassicManagedConstructor

ThepropertiesofthePkzipClassicManagedclassarelistedbelow.ForacompletelistofPkzipClassicManagedclassmembers,seethePkzipClassicManagedMemberstopic.

PublicInstancePropertiesBlockSize Get/settheapplicableblock

Key Get/setthekeyvalueapplicable.

LegalBlockSizes Getanarrayoflegalblocksizes.

LegalKeySizes Getanarrayoflegalkeysizes.

Getsorsetsthepaddingmodeusedinthesymmetricalgorithm.

PkzipClassicManagedProperties

Get/settheapplicableblocksize.

publicoverrideintBlockSize{get;set;}

RemarksTheonlyvalidblocksizeis8.

PkzipClassicManaged.BlockSizeProperty

Get/setthekeyvalueapplicable.

publicoverridebyte[]Key{get;set;}

PkzipClassicManaged.KeyProperty

Getanarrayoflegalblocksizes.

publicoverrideSystem.Security.Cryptography.KeySizes[]

PkzipClassicManaged.LegalBlockSizesProperty

Getanarrayoflegalkeysizes.

publicoverrideSystem.Security.Cryptography.KeySizes[]

PkzipClassicManaged.LegalKeySizesProperty

ThemethodsofthePkzipClassicManagedclassarelistedbelow.ForacompletelistofPkzipClassicManagedclassmembers,seethePkzipClassicManagedMemberstopic.

CreateDecryptor Overloaded.Createadecryptor.

Overloaded.CreatesasymmetricdecryptorobjectwiththecurrentKeyandinitializationvector(IV).

CreateEncryptor Overloaded.Createanencryptor.

Overloaded.CreatesasymmetricencryptorobjectwiththecurrentKeyandinitializationvector(IV).

GenerateIV Generateaninitialvector.

GenerateKey Generateanewrandomkey.

PkzipClassicManagedMethods

Createadecryptor.

OverloadListInheritedfromSymmetricAlgorithm.

publicvirtualICryptoTransformCreateDecryptor();

Createadecryptor.

publicoverrideICryptoTransformCreateDecryptor(byte[],byte[]);

PkzipClassicManaged.CreateDecryptorMethod

Createadecryptor.

publicoverrideICryptoTransformCreateDecryptor(

byte[]rgbKey,

byte[]rgbIV

ParametersrgbKey

Keystouseforthisnewdecryptor.

rgbIVInitialisationvectorforthenewdecryptor.

ReturnValueReturnsanewdecryptor.

SeeAlsoPkzipClassicManagedClass|ICSharpCode.SharpZipLib.EncryptionNamespace|PkzipClassicManaged.CreateDecryptorOverloadList

PkzipClassicManaged.CreateDecryptorMethod(Byte[],Byte[])

Createanencryptor.

OverloadListInheritedfromSymmetricAlgorithm.

publicvirtualICryptoTransformCreateEncryptor();

Createanencryptor.

publicoverrideICryptoTransformCreateEncryptor(byte[],byte[]);

PkzipClassicManaged.CreateEncryptorMethod

Createanencryptor.

publicoverrideICryptoTransformCreateEncryptor(

byte[]rgbKey,

byte[]rgbIV

ParametersrgbKey

Thekeytouseforthisencryptor.

rgbIVInitialisationvectorforthenewencryptor.

ReturnValueReturnsanewPkzipClassicencryptor

SeeAlsoPkzipClassicManagedClass|ICSharpCode.SharpZipLib.EncryptionNamespace|PkzipClassicManaged.CreateEncryptorOverloadList

PkzipClassicManaged.CreateEncryptorMethod(Byte[],Byte[])

Generateaninitialvector.

publicoverridevoidGenerateIV();

PkzipClassicManaged.GenerateIVMethod

Generateanewrandomkey.

publicoverridevoidGenerateKey();

PkzipClassicManaged.GenerateKeyMethod

Namespacehierarchy

ClassesClass DescriptionGZipConstants Thisclasscontainsconstants

usedforgzip.

GZipException GZipExceptionrepresentsaGzipspecificexception

GZipInputStream Thisfilterstreamisusedtodecompressa"GZIP"formatstream.The"GZIP"formatisdescribedbaseInputStreamRFC1952.authoroftheoriginaljavaversion:JohnLeuner

GZipOutputStream Thisfilterstreamisusedtocompressastreamintoa"GZIP"stream.The"GZIP"formatisdescribedinRFC1952.authoroftheoriginaljavaversion:JohnLeuner

ICSharpCode.SharpZipLib.GZipNamespace

Thisclasscontainsconstantsusedforgzip.

Foralistofallmembersofthistype,seeGZipConstantsMembers.

System.ObjectICSharpCode.SharpZipLib.GZip.GZipConstants

publicclassGZipConstants

RequirementsNamespace:ICSharpCode.SharpZipLib.GZipAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoGZipConstantsMembers|ICSharpCode.SharpZipLib.GZipNamespace

GZipConstantsClass

GZipConstantsoverview

PublicStaticFieldsFCOMMENT flagbitmaskindicating

commentispresent

FEXTRA Flagbitmaskforextra

FHCRC FlagbitmaskforCrc

FNAME flagbitmaskforname

FTEXT Flagbitmaskfortext

GZIP_MAGIC MagicnumberfoundatstartofGZIPheader

GZipConstantsMembers

SeeAlsoGZipConstantsClass|ICSharpCode.SharpZipLib.GZipNamespace

ThefieldsoftheGZipConstantsclassarelistedbelow.ForacompletelistofGZipConstantsclassmembers,seetheGZipConstantsMemberstopic.

PublicStaticFieldsFCOMMENT flagbitmaskindicating

commentispresent

FEXTRA Flagbitmaskforextra

FHCRC FlagbitmaskforCrc

FNAME flagbitmaskforname

FTEXT Flagbitmaskfortext

GZIP_MAGIC MagicnumberfoundatstartofGZIPheader

GZipConstantsFields

flagbitmaskindicatingcommentispresent

publicconstintFCOMMENT=16;

GZipConstants.FCOMMENTField

Flagbitmaskforextra

publicconstintFEXTRA=4;

GZipConstants.FEXTRAField

FlagbitmaskforCrc

publicconstintFHCRC=2;

GZipConstants.FHCRCField

flagbitmaskforname

publicconstintFNAME=8;

GZipConstants.FNAMEField

Flagbitmaskfortext

publicconstintFTEXT=1;

GZipConstants.FTEXTField

MagicnumberfoundatstartofGZIPheader

publicstaticreadonlyintGZIP_MAGIC;

GZipConstants.GZIP_MAGICField

GZipExceptionrepresentsaGzipspecificexception

Foralistofallmembersofthistype,seeGZipExceptionMembers.

System.ObjectSystem.ExceptionSystem.ApplicationExceptionICSharpCode.SharpZipLib.SharpZipBaseExceptionICSharpCode.SharpZipLib.GZip.GZipException

publicclassGZipException:

SeeAlsoGZipExceptionMembers|ICSharpCode.SharpZipLib.GZipNamespace

GZipExceptionClass

GZipExceptionoverview

PublicInstanceConstructorsGZipException Overloaded.Initializesanew

instanceoftheGZipExceptionclass.

GZipExceptionMembers

SeeAlsoGZipExceptionClass|ICSharpCode.SharpZipLib.GZipNamespace

InitialiseanewinstanceofGZipException

OverloadListInitialiseanewinstanceofGZipException

publicGZipException();

InitialiseanewinstanceofGZipExceptionwithitsmessagestring.

publicGZipException(string);

SeeAlsoGZipExceptionClass|ICSharpCode.SharpZipLib.GZipNamespace

GZipExceptionConstructor

InitialiseanewinstanceofGZipException

publicGZipException();

SeeAlsoGZipExceptionClass|ICSharpCode.SharpZipLib.GZipNamespace|GZipExceptionConstructorOverloadList

GZipExceptionConstructor()

InitialiseanewinstanceofGZipExceptionwithitsmessagestring.

publicGZipException(

stringmessage

Parametersmessage

AStringstringthatdescribestheerror.

SeeAlsoGZipExceptionClass|ICSharpCode.SharpZipLib.GZipNamespace|GZipExceptionConstructorOverloadList

GZipExceptionConstructor(String)

Thisfilterstreamisusedtodecompressa"GZIP"formatstream.The"GZIP"formatisdescribedbaseInputStreamRFC1952.authoroftheoriginaljavaversion:JohnLeuner

Foralistofallmembersofthistype,seeGZipInputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStreamICSharpCode.SharpZipLib.GZip.GZipInputStream

publicclassGZipInputStream:

InflaterInputStream

ExampleThissampleshowshowtounzipagzippedfile

usingSystem;

usingSystem.IO;

usingICSharpCode.SharpZipLib.GZip;

classMainClass

publicstaticvoidMain(string[]args)

Streams=newGZipInputStream(File.OpenRead(args[0]));

FileStreamfs=File.Create(Path.GetFileNameWithoutExtension(args[0]));

intsize=2048;

byte[]writeData=newbyte[2048];

GZipInputStreamClass

while(true){

size=s.Read(writeData,0,size);

if(size>0){

fs.Write(writeData,0,size);

}else{

break;

s.Close();

SeeAlsoGZipInputStreamMembers|ICSharpCode.SharpZipLib.GZipNamespace

GZipInputStreamoverview

PublicInstanceConstructorsGZipInputStream Overloaded.Initializesanew

instanceoftheGZipInputStreamclass.

PublicInstancePropertiesAvailable(inheritedfrom

InflaterInputStream)Returns0oncetheendofthestream(EOF)hasbeenreached.Otherwisereturns1.

CanRead(inheritedfromInflaterInputStream)

CanSeek(inheritedfromInflaterInputStream)

Getsavalueoffalseindicatingseekingisnotsupportedforthisstream.

CanWrite(inheritedfromInflaterInputStream)

Getsavalueoffalseindicatingthatthisstreamisnotwriteable.

IsStreamOwner(inheritedfromInflaterInputStream)

Get/setflagindicatingownershipofunderlyingstream.WhentheflagistrueClosewillclosetheunderlyingstreamalso.

Length(inheritedfromInflaterInputStream)

Avaluerepresentingthelengthofthestreaminbytes.

Position(inheritedfromInflaterInputStream)

Thecurrentpositionwithinthestream.ThrowsaNotSupportedExceptionwhenattemptingtosettheposition

GZipInputStreamMembers

BeginRead(inheritedfromStream)

Beginsanasynchronousreadoperation.

BeginWrite(inheritedfromInflaterInputStream)

Entrypointtobeginanasynchronouswrite.AlwaysthrowsaNotSupportedException.

Close(inheritedfromInflaterInputStream)

Closestheinputstream.WhenIsStreamOwneristruetheunderlyingstreamisalsoclosed.

Flush(inheritedfromInflaterInputStream)

FlushesthebaseInputStream

Read Readsuncompresseddataintoanarrayofbytes

ReadByte(inheritedfromStream)

Readsabytefromthestreamandadvancesthepositionwithinthestreambyonebyte,orreturns-1ifattheendofthestream.

Seek(inheritedfromInflaterInputStream)

SetsthepositionwithinthecurrentstreamAlwaysthrowsaNotSupportedException

SetLength(inheritedfromInflaterInputStream)

SetthelengthofthecurrentstreamAlwaysthrowsaNotSupportedException

Skip(inheritedfromInflaterInputStream)

Skipspecifiednumberofbytesofuncompresseddata

Write(inheritedfromInflaterInputStream)

WritesasequenceofbytestostreamandadvancesthecurrentpositionThismethodalwaysthrowsaNotSupportedException

WriteByte(inheritedfromInflaterInputStream)

WritesonebytetothecurrentstreamandadvancesthecurrentpositionAlwaysthrowsaNotSupportedException

ProtectedInstanceFieldsbaseInputStream(inherited

fromInflaterInputStream)Basestreamtheinflaterreadsfrom.

crc CRC-32valuefor

uncompresseddata

csize(inheritedfromInflaterInputStream)

Thecompressedsize

eos Indicatesendofstream

inf(inheritedfromInflaterInputStream)

Decompressorforthisstream

inputBuffer(inheritedfromInflaterInputStream)

Inputbufferforthisstream.

Fill(inheritedfromInflaterInputStream)

Fillsthebufferwithmoredatatodecompress.

StopDecrypting(inheritedfromInflaterInputStream)

Clearanycryptographicstate.

SeeAlsoGZipInputStreamClass|ICSharpCode.SharpZipLib.GZipNamespace

CreatesaGzipInputStreamwiththedefaultbuffersize

OverloadListCreatesaGzipInputStreamwiththedefaultbuffersize

publicGZipInputStream(Stream);

CreatesaGZIPInputStreamwiththespecifiedbuffersize

publicGZipInputStream(Stream,int);

GZipInputStreamConstructor

CreatesaGzipInputStreamwiththedefaultbuffersize

publicGZipInputStream(

StreambaseInputStream

ParametersbaseInputStream

Thestreamtoreadcompresseddatafrom(baseInputStreamGZIPformat)

SeeAlsoGZipInputStreamClass|ICSharpCode.SharpZipLib.GZipNamespace|GZipInputStreamConstructorOverloadList

GZipInputStreamConstructor(Stream)

CreatesaGZIPInputStreamwiththespecifiedbuffersize

publicGZipInputStream(

StreambaseInputStream,

intsize

Thestreamtoreadcompresseddatafrom(baseInputStreamGZIPformat)

sizeSizeofthebuffertouse

SeeAlsoGZipInputStreamClass|ICSharpCode.SharpZipLib.GZipNamespace|GZipInputStreamConstructorOverloadList

GZipInputStreamConstructor(Stream,Int32)

ThefieldsoftheGZipInputStreamclassarelistedbelow.ForacompletelistofGZipInputStreamclassmembers,seetheGZipInputStreamMemberstopic.

ProtectedInstanceFieldsbaseInputStream(inherited

fromInflaterInputStream)Basestreamtheinflaterreadsfrom.

crc CRC-32valueforuncompresseddata

Thecompressedsize

eos Indicatesendofstream

GZipInputStreamFields

CRC-32valueforuncompresseddata

protectedCrc32crc;

GZipInputStream.crcField

Indicatesendofstream

protectedbooleos;

GZipInputStream.eosField

ThemethodsoftheGZipInputStreamclassarelistedbelow.ForacompletelistofGZipInputStreamclassmembers,seetheGZipInputStreamMemberstopic.

Close(inheritedfromInflaterInputStream)

Servesasahashfunctionforaparticulartype,suitableforuseinhashingalgorithmsanddata

GZipInputStreamMethods

structureslikeahashtable.

Read Readsuncompresseddataintoanarrayofbytes

Writesonebytetothecurrentstreamandadvancesthe

currentpositionAlwaysthrowsaNotSupportedException

Readsuncompresseddataintoanarrayofbytes

byte[]buf,

intoffset,

intlen

Parametersbuf

Thebuffertoreaduncompresseddatainto

offsetTheoffsetindicatingwherethedatashouldbeplaced

lenThenumberofuncompressedbytestoberead

GZipInputStream.ReadMethod

Thisfilterstreamisusedtocompressastreamintoa"GZIP"stream.The"GZIP"formatisdescribedinRFC1952.authoroftheoriginaljavaversion:JohnLeuner

Foralistofallmembersofthistype,seeGZipOutputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStreamICSharpCode.SharpZipLib.GZip.GZipOutputStream

publicclassGZipOutputStream:

DeflaterOutputStream

ExampleThissampleshowshowtogzipafile

usingSystem;

usingSystem.IO;

usingICSharpCode.SharpZipLib.GZip;

classMainClass

Streams=newGZipOutputStream(File.Create(args[0]+".gz"));

FileStreamfs=File.OpenRead(args[0]);

byte[]writeData=newbyte[fs.Length];

fs.Read(writeData,0,(int)fs.Length);

GZipOutputStreamClass

s.Write(writeData,0,writeData.Length);

s.Close();

SeeAlsoGZipOutputStreamMembers|ICSharpCode.SharpZipLib.GZipNamespace

GZipOutputStreamoverview

PublicInstanceConstructorsGZipOutputStream Overloaded.Initializesanew

instanceoftheGZipOutputStreamclass.

PublicInstancePropertiesCanPatchEntries

(inheritedfromDeflaterOutputStream)

Allowsclienttodetermineifanentrycanbepatchedafteritsadded

CanRead(inheritedfromDeflaterOutputStream)

Getsvalueindicatingstreamcanbereadfrom

CanSeek(inheritedfromDeflaterOutputStream)

GetsavalueindicatingifseekingissupportedforthisstreamThispropertyalwaysreturnsfalse

CanWrite(inheritedfromDeflaterOutputStream)

Getvalueindicatingifthisstreamsupportswriting

IsStreamOwner(inheritedfromDeflaterOutputStream)

Length(inheritedfromDeflaterOutputStream)

Getcurrentlengthofstream

Password(inheritedfromDeflaterOutputStream)

Get/setthepasswordusedforencryption.Whennullnoencryptionisperformed

Position(inheritedfromDeflaterOutputStream)

Thecurrentpositionwithinthestream.AlwaysthrowsaNotSupportedExceptionNotSupportedException

GZipOutputStreamMembers

DeflaterOutputStream)AsynchronousreadsarenotsupportedaNotSupportedExceptionisalwaysthrown

BeginWrite(inheritedfromDeflaterOutputStream)

Asynchronouswritesarentsupported,aNotSupportedExceptionisalwaysthrown

Close Writesremainingcompressedoutputdatatotheoutputstreamandclosesit.

Finish Finishcompressionandwriteanyfooterinformationrequiredtostream

Flush(inheritedfromDeflaterOutputStream)

Flushesthestreambycallingflush()onthedeflaterandthenontheunderlyingstream.Thisensuresthatallbytesareflushed.

Servesasahashfunctionforaparticulartype,suitableforuse

inhashingalgorithmsanddatastructureslikeahashtable.

GetLevel Getthecurrentcompressionlevel.

Read(inheritedfromDeflaterOutputStream)

Readablockofbytesfromstream

ReadByte(inheritedfromDeflaterOutputStream)

Readabytefromstreamadvancingpositionbyone

Seek(inheritedfromDeflaterOutputStream)

Setsthecurrentpositionofthisstreamtothegivenvalue.Notsupportedbythisclass!

SetLength(inheritedfromDeflaterOutputStream)

Setsthelengthofthisstreamtothegivenvalue.Notsupportedbythisclass!

SetLevel Setstheactivecompressionlevel(1-9).Thenewlevelwillbeactivatedimmediately.

Write Writegivenbuffertooutputupdatingcrc

WriteByte(inheritedfromDeflaterOutputStream)

Writesasinglebytetothecompressedoutputstream.

ProtectedInstanceFields

baseOutputStream(inheritedfromDeflaterOutputStream)

Basestreamthedeflaterdependson.

buf(inheritedfromDeflaterOutputStream)

Thisbufferisusedtemporarilytoretrievethebytesfromthedeflaterandwritethemtotheunderlyingoutputstream.

def(inheritedfromDeflaterOutputStream)

Thedeflaterwhichisusedtodeflatethestream.

Deflate(inheritedfromDeflaterOutputStream)

Deflateseverythingintheinputbuffers.Thiswillcall

def.deflate()

untilallbytesfromtheinputbuffersareprocessed.

EncryptBlock(inheritedfromDeflaterOutputStream)

Encryptablockofdata

EncryptByte(inheritedfromDeflaterOutputStream)

Encryptasinglebyte

InitializePassword(inheritedfromDeflaterOutputStream)

Initializesencryptionkeysbasedongivenpassword

UpdateKeys(inheritedfromDeflaterOutputStream)

Updateencryptionkeys

SeeAlsoGZipOutputStreamClass|ICSharpCode.SharpZipLib.GZipNamespace

CreatesaGzipOutputStreamwiththedefaultbuffersize

OverloadListCreatesaGzipOutputStreamwiththedefaultbuffersize

publicGZipOutputStream(Stream);

CreatesaGZipOutputStreamwiththespecifiedbuffersize

publicGZipOutputStream(Stream,int);

GZipOutputStreamConstructor

CreatesaGzipOutputStreamwiththedefaultbuffersize

publicGZipOutputStream(

StreambaseOutputStream

ParametersbaseOutputStream

Thestreamtoreaddata(tobecompressed)from

SeeAlsoGZipOutputStreamClass|ICSharpCode.SharpZipLib.GZipNamespace|GZipOutputStreamConstructorOverloadList

GZipOutputStreamConstructor(Stream)

CreatesaGZipOutputStreamwiththespecifiedbuffersize

publicGZipOutputStream(

StreambaseOutputStream,

intsize

Thestreamtoreaddata(tobecompressed)from

sizeSizeofthebuffertouse

SeeAlsoGZipOutputStreamClass|ICSharpCode.SharpZipLib.GZipNamespace|GZipOutputStreamConstructorOverloadList

GZipOutputStreamConstructor(Stream,Int32)

ThefieldsoftheGZipOutputStreamclassarelistedbelow.ForacompletelistofGZipOutputStreamclassmembers,seetheGZipOutputStreamMemberstopic.

ProtectedInstanceFieldsbaseOutputStream(inherited

fromDeflaterOutputStream)Basestreamthedeflaterdependson.

GZipOutputStreamFields

CRC-32valueforuncompresseddata

protectedCrc32crc;

GZipOutputStream.crcField

ThemethodsoftheGZipOutputStreamclassarelistedbelow.ForacompletelistofGZipOutputStreamclassmembers,seetheGZipOutputStreamMemberstopic.

Close Writesremainingcompressedoutputdatatotheoutputstreamandclosesit.

Finish Finishcompressionandwriteanyfooterinformationrequiredtostream

Flush(inheritedfrom Flushesthestreambycalling

GZipOutputStreamMethods

DeflaterOutputStream) flush()onthedeflaterandthenontheunderlyingstream.Thisensuresthatallbytesareflushed.

GetLevel Getthecurrentcompressionlevel.

SetLevel Setstheactivecompressionlevel(1-9).Thenewlevelwillbeactivatedimmediately.

Write Writegivenbuffertooutputupdatingcrc

def.deflate()

Encryptablockofdata

Encryptasinglebyte

Writesremainingcompressedoutputdatatotheoutputstreamandclosesit.

GZipOutputStream.CloseMethod

Finishcompressionandwriteanyfooterinformationrequiredtostream

publicoverridevoidFinish();

GZipOutputStream.FinishMethod

Getthecurrentcompressionlevel.

publicintGetLevel();

ReturnValueThecurrentcompressionlevel.

GZipOutputStream.GetLevelMethod

Setstheactivecompressionlevel(1-9).Thenewlevelwillbeactivatedimmediately.

publicvoidSetLevel(

intlevel

ExceptionsExceptionType ConditionArgumentOutOfRangeException Levelspecifiedisnotsupported.

GZipOutputStream.SetLevelMethod

Writegivenbuffertooutputupdatingcrc

byte[]buf,

intoff,

intlen

Parametersbuf

Buffertowrite

offOffsetoffirstbyteinbuftowrite

lenNumberofbytestowrite

GZipOutputStream.WriteMethod

Namespacehierarchy

ClassesClass DescriptionInvalidHeaderException Thisexceptionisusedtoindicate

thatthereisaproblemwithaTARarchiveheader.

TarArchive TheTarArchiveclassimplementstheconceptofa'TapeArchive'.Atararchiveisaseriesofentries,eachofwhichrepresentsafilesystemobject.Eachentryinthearchiveconsistsofaheaderblockfollowedby0ormoredatablocks.Directoryentriesconsistonlyoftheheaderblock,andarefollowedbyentriesforthedirectory'scontents.Fileentriesconsistofaheaderfollowedbythenumberofblocksneededtocontainthefile'scontents.Allentriesarewrittenonblockboundaries.Blocksare512byteslong.TarArchivesareinstantiatedineitherreadorwritemode,baseduponwhethertheyareinstantiatedwithanInputStreamoranOutputStream.OnceinstantiatedTarArchivesread/writemodecannotbechanged.Thereiscurrentlynosupportforrandomaccesstotararchives.However,itseemsthatsubclassingTarArchive,andusingthe

ICSharpCode.SharpZipLib.TarNamespace

TarBuffer.getCurrentRecordNum()andTarBuffer.getCurrentBlockNum()methods,thiswouldberathertrvial.

TarBuffer TheTarBufferclassimplementsthetararchiveconceptofabufferedinputstream.Thisconceptgoesbacktothedaysofblockedtapedrivesandspecialiodevices.IntheC#universe,theonlyrealfunctionthatthisclassperformsistoensurethatfileshavethecorrect"record"size,orothertarswillcomplain.

Youshouldneverhaveaneedtoaccessthisclassdirectly.TarBuffersarecreatedbyTarIOStreams.

TarEntry ThisclassrepresentsanentryinaTararchive.Itconsistsoftheentry'sheader,aswellastheentry'sFile.Entriescanbeinstantiatedinoneofthreeways,dependingonhowtheyaretobeused.

TarEntriesthatarecreatedfromtheheaderbytesreadfromanarchiveareinstantiatedwiththeTarEntry(byte[])constructor.Theseentrieswillbeusedwhenextractingfromorlistingthecontentsofanarchive.Theseentrieshavetheirheaderfilledinusingtheheaderbytes.TheyalsosettheFiletonull,sincethey

referenceanarchiveentrynotafile.

TarEntriesthatarecreatedfromfilesthataretobewrittenintoanarchiveareinstantiatedwiththeCreateEntryFromFile(string)pseudoconstructor.TheseentrieshavetheirheaderfilledinusingtheFile'sinformation.TheyalsokeepareferencetotheFileforconveniencewhenwritingentries.

Finally,TarEntriescanbeconstructedfromnothingbutaname.Thisallowstheprogrammertoconstructtheentrybyhand,forinstancewhenonlyanInputStreamisavailableforwritingtothearchive,andtheheaderinformationisconstructedfromotherinformation.InthiscasetheheaderfieldsaresettodefaultsandtheFileissettonull.

TarHeader

TarException TarExceptionsareusedforexceptionsspecifictotarclassesandcode.

TarHeader ThisclassencapsulatestheTarEntryHeaderusedinTarArchives.Theclassalsoholdsanumberoftarconstants,usedmostlyinheaders.

TarInputStream TheTarInputStreamreadsaUNIXtararchiveasanInputStream.methodsareprovidedtopositionateach

successiveentryinthearchive,andthereadeachentryasanormalinputstreamusingread().

TarInputStream.EntryFactoryAdapter StandardentryfactoryclasscreatinginstancesoftheclassTarEntry

TarOutputStream TheTarOutputStreamwritesaUNIXtararchiveasanOutputStream.Methodsareprovidedtoputentries,andthenwritetheircontentsbywritingtothisstreamusingwrite().

InterfacesInterface DescriptionTarInputStream.IEntryFactory Thisinterfaceisprovided,along

withthemethodsetEntryFactory(),toallowtheprogrammertohavetheirownTarEntrysubclassinstantiatedfortheentriesreturnfromgetNextEntry().

DelegatesDelegate DescriptionProgressMessageHandler Usedtoadviseclientsof

'events'whileprocessingarchives

ThisexceptionisusedtoindicatethatthereisaproblemwithaTARarchiveheader.

Foralistofallmembersofthistype,seeInvalidHeaderExceptionMembers.

System.ObjectSystem.ExceptionSystem.ApplicationExceptionICSharpCode.SharpZipLib.SharpZipBaseExceptionICSharpCode.SharpZipLib.Tar.TarExceptionICSharpCode.SharpZipLib.Tar.InvalidHeaderException

publicclassInvalidHeaderException:

TarException

RequirementsNamespace:ICSharpCode.SharpZipLib.TarAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoInvalidHeaderExceptionMembers|ICSharpCode.SharpZipLib.TarNamespace

InvalidHeaderExceptionClass

InvalidHeaderExceptionoverview

PublicInstanceConstructorsInvalidHeaderException Overloaded.Initializesanew

instanceoftheInvalidHeaderExceptionclass.

InvalidHeaderExceptionMembers

SeeAlsoInvalidHeaderExceptionClass|ICSharpCode.SharpZipLib.TarNamespace

InitialiseanewinstanceoftheInvalidHeaderExceptionclass.

OverloadListInitialiseanewinstanceoftheInvalidHeaderExceptionclass.

publicInvalidHeaderException();

InitialisesanewinstanceoftheInvalidHeaderExceptionclasswithaspecifiedmessage.

publicInvalidHeaderException(string);

SeeAlsoInvalidHeaderExceptionClass|ICSharpCode.SharpZipLib.TarNamespace

InvalidHeaderExceptionConstructor

InitialiseanewinstanceoftheInvalidHeaderExceptionclass.

publicInvalidHeaderException();

SeeAlsoInvalidHeaderExceptionClass|ICSharpCode.SharpZipLib.TarNamespace|InvalidHeaderExceptionConstructorOverloadList

InvalidHeaderExceptionConstructor()

InitialisesanewinstanceoftheInvalidHeaderExceptionclasswithaspecifiedmessage.

publicInvalidHeaderException(

stringmsg

SeeAlsoInvalidHeaderExceptionClass|ICSharpCode.SharpZipLib.TarNamespace|InvalidHeaderExceptionConstructorOverloadList

InvalidHeaderExceptionConstructor(String)

Usedtoadviseclientsof'events'whileprocessingarchives

publicdelegatevoidProgressMessageHandler(

TarArchivearchive,

TarEntryentry,

stringmessage

SeeAlsoICSharpCode.SharpZipLib.TarNamespace

ProgressMessageHandlerDelegate

TheTarArchiveclassimplementstheconceptofa'TapeArchive'.Atararchiveisaseriesofentries,eachofwhichrepresentsafilesystemobject.Eachentryinthearchiveconsistsofaheaderblockfollowedby0ormoredatablocks.Directoryentriesconsistonlyoftheheaderblock,andarefollowedbyentriesforthedirectory'scontents.Fileentriesconsistofaheaderfollowedbythenumberofblocksneededtocontainthefile'scontents.Allentriesarewrittenonblockboundaries.Blocksare512byteslong.TarArchivesareinstantiatedineitherreadorwritemode,baseduponwhethertheyareinstantiatedwithanInputStreamoranOutputStream.OnceinstantiatedTarArchivesread/writemodecannotbechanged.Thereiscurrentlynosupportforrandomaccesstotararchives.However,itseemsthatsubclassingTarArchive,andusingtheTarBuffer.getCurrentRecordNum()andTarBuffer.getCurrentBlockNum()methods,thiswouldberathertrvial.

Foralistofallmembersofthistype,seeTarArchiveMembers.

System.ObjectICSharpCode.SharpZipLib.Tar.TarArchive

publicclassTarArchive

SeeAlsoTarArchiveMembers|ICSharpCode.SharpZipLib.TarNamespace

TarArchiveClass

TarArchiveoverview

PublicStaticMethodsCreateInputTarArchive Overloaded.TheInputStream

basedconstructorscreateaTarArchiveforthepurposesofextractingorlistingatararchive.Thus,usetheseconstructorswhenyouwishtoextractfilesfromorlistthecontentsofanexistingtararchive.

CreateOutputTarArchive Overloaded.CreateaTarArchiveforwritingto,usingthedefaultblockingfactor

PublicInstancePropertiesApplyUserInfoOverrides Getorsetavalueindicatingif

overridesdefinedbySetUserInfoshouldbeapplied.

GroupId Getthearchivegroupid.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

GroupName Getthearchivegroupname.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

PathPrefix PathPrefixisaddedtoentrynamesastheyarewrittenifthevalueisnotnull.AslashcharacterisappendedafterPathPrefix

TarArchiveMembers

RecordSize Getthearchive'srecordsize.Becauseofitshistory,tarsupportstheconceptofbufferedIOconsistingofRECORDSofBLOCKS.ThisallowedtartomatchtheIOcharacteristicsofthephysicaldevicebeingused.Ofcourse,intheC#world,thismakesnosense,WITHONEEXCEPTION-archivesareexpectedtobeproperly"blocked".Thus,allofthehorribleTarBuffersupportboilsdowntosimplygettingthe"boundaries"correct.

RootPath RootPathisremovedfromentrynamesifitisfoundatthebeginningofthename.

UserId Getthearchiveuserid.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

UserName Getthearchiveusername.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

PublicInstanceMethodsCloseArchive Closethearchive.Thissimply

callstheunderlyingtarstream'sclose()method.

ExtractContents Performthe"extract"commandandextractthecontentsofthe

archive.

ListContents Performthe"list"commandforthearchivecontents.NOTEThatthismethodusestheprogresseventtoactuallylistthecontents.Iftheprogressdisplayeventisnotset,nothingwillbelisted!

SetAsciiTranslation Settheasciifiletranslationflag.Ifasciifiletranslationistrue,thenthefileischeckedtoseeifitabinaryfileornot.Iftheflagistrueandthetestindicatesitisasciitextfile,itwillbetranslated.Thetranslationconvertsthelocaloperatingsystem'sconceptoflineendsintotheUNIXlineend,'\n',whichisthedefactostandardforaTARarchive.ThismakestextfilescompatiblewithUNIX.

SetKeepOldFiles Settheflagthatdetermineswhetherexistingfilesarekept,oroverwrittenduringextraction.

SetUserInfo Setuserandgroupinformationthatwillbeusedtofillinthetararchive'sentryheaders.Thisinformationbasedonthatavailableforthelinuxoperatingsystem,whichisnotalways

availableonotheroperatingsystems.TarArchiveallowstheprogrammertospecifyvaluestobeusedintheirplace.

WriteEntry Writeanentrytothearchive.ThismethodwillcalltheputNextEntryandthenwritethecontentsoftheentry,andfinallycallcloseEntry()forentriesthatarefiles.Fordirectories,itwillcallputNextEntry(),andthen,iftherecurseflagistrue,processeachentrythatisachildofthedirectory.

PublicInstanceEventsProgressMessageEvent Clienthookallowingdetailed

informationtobereportedduringprocessing

ProtectedInstanceConstructorsTarArchiveConstructor ConstructorforaTarArchive.

OnProgressMessageEvent RaisestheProgressMessageevent

SeeAlsoTarArchiveClass|ICSharpCode.SharpZipLib.TarNamespace

ConstructorforaTarArchive.

protectedTarArchive();

TarArchiveConstructor

ThepropertiesoftheTarArchiveclassarelistedbelow.ForacompletelistofTarArchiveclassmembers,seetheTarArchiveMemberstopic.

PublicInstancePropertiesApplyUserInfoOverrides Getorsetavalueindicatingif

overridesdefinedbySetUserInfoshouldbeapplied.

GroupId Getthearchivegroupid.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

GroupName Getthearchivegroupname.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

PathPrefix PathPrefixisaddedtoentrynamesastheyarewrittenifthevalueisnotnull.AslashcharacterisappendedafterPathPrefix

RecordSize Getthearchive'srecordsize.Becauseofitshistory,tarsupportstheconceptofbufferedIOconsistingofRECORDSofBLOCKS.ThisallowedtartomatchtheIOcharacteristicsofthephysicaldevicebeingused.Ofcourse,intheC#world,thismakesnosense,WITHONEEXCEPTION-archivesareexpectedtobeproperly"blocked".Thus,allofthehorribleTarBuffersupportboils

TarArchiveProperties

downtosimplygettingthe"boundaries"correct.

RootPath RootPathisremovedfromentrynamesifitisfoundatthebeginningofthename.

UserId Getthearchiveuserid.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

UserName Getthearchiveusername.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

GetorsetavalueindicatingifoverridesdefinedbySetUserInfoshouldbeapplied.

publicboolApplyUserInfoOverrides{get;set;}

RemarksIfoverridesarenotappliedthenthevaluesassetineachheaderwillbeused.

TarArchive.ApplyUserInfoOverridesProperty

Getthearchivegroupid.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

publicintGroupId{get;}

TarArchive.GroupIdProperty

Getthearchivegroupname.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

publicstringGroupName{get;}

TarArchive.GroupNameProperty

PathPrefixisaddedtoentrynamesastheyarewrittenifthevalueisnotnull.AslashcharacterisappendedafterPathPrefix

publicstringPathPrefix{get;set;}

TarArchive.PathPrefixProperty

Getthearchive'srecordsize.Becauseofitshistory,tarsupportstheconceptofbufferedIOconsistingofRECORDSofBLOCKS.ThisallowedtartomatchtheIOcharacteristicsofthephysicaldevicebeingused.Ofcourse,intheC#world,thismakesnosense,WITHONEEXCEPTION-archivesareexpectedtobeproperly"blocked".Thus,allofthehorribleTarBuffersupportboilsdowntosimplygettingthe"boundaries"correct.

publicintRecordSize{get;}

TarArchive.RecordSizeProperty

RootPathisremovedfromentrynamesifitisfoundatthebeginningofthename.

publicstringRootPath{get;set;}

TarArchive.RootPathProperty

Getthearchiveuserid.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

publicintUserId{get;}

TarArchive.UserIdProperty

Getthearchiveusername.SeeApplyUserInfoOverridesfordetailonhowtoallowsettingvaluesonaperentrybasis.

publicstringUserName{get;}

TarArchive.UserNameProperty

ThemethodsoftheTarArchiveclassarelistedbelow.ForacompletelistofTarArchiveclassmembers,seetheTarArchiveMemberstopic.

PublicStaticMethodsCreateInputTarArchive Overloaded.TheInputStream

basedconstructorscreateaTarArchiveforthepurposesofextractingorlistingatararchive.Thus,usetheseconstructorswhenyouwishtoextractfilesfromorlistthecontentsofanexistingtararchive.

CreateOutputTarArchive Overloaded.CreateaTarArchiveforwritingto,usingthedefaultblockingfactor

PublicInstanceMethodsCloseArchive Closethearchive.Thissimply

callstheunderlyingtarstream'sclose()method.

ExtractContents Performthe"extract"commandandextractthecontentsofthearchive.

GetType(inheritedfrom GetstheTypeofthecurrent

TarArchiveMethods

Object) instance.

ListContents Performthe"list"commandforthearchivecontents.NOTEThatthismethodusestheprogresseventtoactuallylistthecontents.Iftheprogressdisplayeventisnotset,nothingwillbelisted!

SetAsciiTranslation Settheasciifiletranslationflag.Ifasciifiletranslationistrue,thenthefileischeckedtoseeifitabinaryfileornot.Iftheflagistrueandthetestindicatesitisasciitextfile,itwillbetranslated.Thetranslationconvertsthelocaloperatingsystem'sconceptoflineendsintotheUNIXlineend,'\n',whichisthedefactostandardforaTARarchive.ThismakestextfilescompatiblewithUNIX.

SetKeepOldFiles Settheflagthatdetermineswhetherexistingfilesarekept,oroverwrittenduringextraction.

SetUserInfo Setuserandgroupinformationthatwillbeusedtofillinthetararchive'sentryheaders.Thisinformationbasedonthatavailableforthelinuxoperatingsystem,whichisnotalwaysavailableonotheroperatingsystems.TarArchiveallowstheprogrammertospecifyvaluestobeusedintheirplace.

WriteEntry Writeanentrytothearchive.ThismethodwillcalltheputNextEntryandthenwritethecontentsoftheentry,andfinallycallcloseEntry()forentriesthatarefiles.Fordirectories,itwillcallputNextEntry(),andthen,iftherecurseflagistrue,processeachentrythatisachildofthedirectory.

OnProgressMessageEvent RaisestheProgressMessageevent

Closethearchive.Thissimplycallstheunderlyingtarstream'sclose()method.

publicvoidCloseArchive();

TarArchive.CloseArchiveMethod

TheInputStreambasedconstructorscreateaTarArchiveforthepurposesofextractingorlistingatararchive.Thus,usetheseconstructorswhenyouwishtoextractfilesfromorlistthecontentsofanexistingtararchive.

OverloadListTheInputStreambasedconstructorscreateaTarArchiveforthepurposesofextractingorlistingatararchive.Thus,usetheseconstructorswhenyouwishtoextractfilesfromorlistthecontentsofanexistingtararchive.

publicstaticTarArchiveCreateInputTarArchive(Stream);

CreateTarArchiveforreadingsettingblockfactor

publicstaticTarArchiveCreateInputTarArchive(Stream,int);

TarArchive.CreateInputTarArchiveMethod

TheInputStreambasedconstructorscreateaTarArchiveforthepurposesofextractingorlistingatararchive.Thus,usetheseconstructorswhenyouwishtoextractfilesfromorlistthecontentsofanexistingtararchive.

publicstaticTarArchiveCreateInputTarArchive(

StreaminputStream

SeeAlsoTarArchiveClass|ICSharpCode.SharpZipLib.TarNamespace|TarArchive.CreateInputTarArchiveOverloadList

TarArchive.CreateInputTarArchiveMethod(Stream)

CreateTarArchiveforreadingsettingblockfactor

publicstaticTarArchiveCreateInputTarArchive(

StreaminputStream,

intblockFactor

ParametersinputStream

Streamfortararchivecontents

blockFactorTheblockingfactortoapply

ReturnValueTarArchive

SeeAlsoTarArchiveClass|ICSharpCode.SharpZipLib.TarNamespace|TarArchive.CreateInputTarArchiveOverloadList

TarArchive.CreateInputTarArchiveMethod(Stream,Int32)

CreateaTarArchiveforwritingto,usingthedefaultblockingfactor

OverloadListCreateaTarArchiveforwritingto,usingthedefaultblockingfactor

publicstaticTarArchiveCreateOutputTarArchive(Stream);

CreateaTarArchiveforwritingto

publicstaticTarArchiveCreateOutputTarArchive(Stream,int);

TarArchive.CreateOutputTarArchiveMethod

CreateaTarArchiveforwritingto,usingthedefaultblockingfactor

publicstaticTarArchiveCreateOutputTarArchive(

StreamoutputStream

ParametersoutputStream

Streamtowriteto

SeeAlsoTarArchiveClass|ICSharpCode.SharpZipLib.TarNamespace|TarArchive.CreateOutputTarArchiveOverloadList

TarArchive.CreateOutputTarArchiveMethod(Stream)

CreateaTarArchiveforwritingto

publicstaticTarArchiveCreateOutputTarArchive(

StreamoutputStream,

intblockFactor

Thestreamtowriteto

blockFactorTheblockingfactortouseforbuffering.

SeeAlsoTarArchiveClass|ICSharpCode.SharpZipLib.TarNamespace|TarArchive.CreateOutputTarArchiveOverloadList

TarArchive.CreateOutputTarArchiveMethod(Stream,Int32)

Performthe"extract"commandandextractthecontentsofthearchive.

publicvoidExtractContents(

stringdestDir

ParametersdestDir

Thedestinationdirectoryintowhichtoextract.

TarArchive.ExtractContentsMethod

Performthe"list"commandforthearchivecontents.NOTEThatthismethodusestheprogresseventtoactuallylistthecontents.Iftheprogressdisplayeventisnotset,nothingwillbelisted!

publicvoidListContents();

TarArchive.ListContentsMethod

RaisestheProgressMessageevent

protectedvirtualvoidOnProgressMessageEvent(

TarEntryentry,

stringmessage

Parametersentry

TarEntryforthisevent

messagemessageforthisevent.Nullisnomessage

TarArchive.OnProgressMessageEventMethod

Settheasciifiletranslationflag.Ifasciifiletranslationistrue,thenthefileischeckedtoseeifitabinaryfileornot.Iftheflagistrueandthetestindicatesitisasciitextfile,itwillbetranslated.Thetranslationconvertsthelocaloperatingsystem'sconceptoflineendsintotheUNIXlineend,'\n',whichisthedefactostandardforaTARarchive.ThismakestextfilescompatiblewithUNIX.

publicvoidSetAsciiTranslation(

boolasciiTranslate

ParametersasciiTranslate

Iftrue,translateasciitextfiles.

TarArchive.SetAsciiTranslationMethod

Settheflagthatdetermineswhetherexistingfilesarekept,oroverwrittenduringextraction.

publicvoidSetKeepOldFiles(

boolkeepOldFiles

ParameterskeepOldFiles

Iftrue,donotoverwriteexistingfiles.

TarArchive.SetKeepOldFilesMethod

Setuserandgroupinformationthatwillbeusedtofillinthetararchive'sentryheaders.Thisinformationbasedonthatavailableforthelinuxoperatingsystem,whichisnotalwaysavailableonotheroperatingsystems.TarArchiveallowstheprogrammertospecifyvaluestobeusedintheirplace.

publicvoidSetUserInfo(

intuserId,

stringuserName,

intgroupId,

stringgroupName

ParametersuserId

Theuseridtouseintheheaders.

userNameTheusernametouseintheheaders.

groupIdThegroupidtouseintheheaders.

groupNameThegroupnametouseintheheaders.

TarArchive.SetUserInfoMethod

Writeanentrytothearchive.ThismethodwillcalltheputNextEntryandthenwritethecontentsoftheentry,andfinallycallcloseEntry()forentriesthatarefiles.Fordirectories,itwillcallputNextEntry(),andthen,iftherecurseflagistrue,processeachentrythatisachildofthedirectory.

publicvoidWriteEntry(

TarEntrysourceEntry,

boolrecurse

ParameterssourceEntry

TheTarEntryrepresentingtheentrytowritetothearchive.

recurseIftrue,processthechildrenofdirectoryentries.

TarArchive.WriteEntryMethod

TheeventsoftheTarArchiveclassarelistedbelow.ForacompletelistofTarArchiveclassmembers,seetheTarArchiveMemberstopic.

PublicInstanceEventsProgressMessageEvent Clienthookallowingdetailed

informationtobereportedduringprocessing

TarArchiveEvents

Clienthookallowingdetailedinformationtobereportedduringprocessing

publiceventProgressMessageHandlerProgressMessageEvent;

TarArchive.ProgressMessageEventEvent

TheTarBufferclassimplementsthetararchiveconceptofabufferedinputstream.Thisconceptgoesbacktothedaysofblockedtapedrivesandspecialiodevices.IntheC#universe,theonlyrealfunctionthatthisclassperformsistoensurethatfileshavethecorrect"record"size,orothertarswillcomplain.

Youshouldneverhaveaneedtoaccessthisclassdirectly.TarBuffersarecreatedbyTarIOStreams.

Foralistofallmembersofthistype,seeTarBufferMembers.

System.ObjectICSharpCode.SharpZipLib.Tar.TarBuffer

publicclassTarBuffer

SeeAlsoTarBufferMembers|ICSharpCode.SharpZipLib.TarNamespace

TarBufferClass

TarBufferoverview

PublicStaticFieldsBlockSize Thesizeofablockinatar

archiveinbytes.

DefaultBlockFactor Thenumberofblocksinadefaultrecord.

DefaultRecordSize Thesizeinbytesofadefaultrecord.

PublicStaticMethodsCreateInputTarBuffer Overloaded.CreateTarBuffer

forreadingwithdefaultBlockFactor

CreateOutputTarBuffer Overloaded.ConstructTarBufferforwritingwithdefaultBlockFactor

PublicInstancePropertiesBlockFactor GettheBlockingfactorforthe

buffer

RecordSize Gettherecordsizeforthisbuffer

PublicInstanceMethodsClose ClosetheTarBuffer.Ifthisisan

outputbuffer,alsoflushthecurrentblockbeforeclosing.

TarBufferMembers

GetBlockFactor GettheTARBuffer'sblockfactor

GetCurrentBlockNum Getthecurrentblocknumber,withinthecurrentrecord,zerobased.

GetCurrentRecordNum Getthecurrentrecordnumber.

GetRecordSize GettheTARBuffer'srecordsize.

IsEOFBlock DetermineifanarchiveblockindicatesEndofArchive.Endofarchiveisindicatedbyablockthatconsistsentirelyofnullbytes.Allremainingblocksfortherecordshouldalsobenull'sHoweversomeoldertarsonlydoacoupleofnullblocks(OldGNUtarforone)andalsopartialrecords

ReadBlock Readablockfromtheinputstream.

SkipBlock Skipoverablockontheinputstream.

WriteBlock Overloaded.Writeablockofdatatothearchive.

ProtectedInstanceConstructors

TarBufferConstructor ConstructadefaultTarBuffer

SeeAlsoTarBufferClass|ICSharpCode.SharpZipLib.TarNamespace

ConstructadefaultTarBuffer

protectedTarBuffer();

TarBufferConstructor

ThefieldsoftheTarBufferclassarelistedbelow.ForacompletelistofTarBufferclassmembers,seetheTarBufferMemberstopic.

PublicStaticFieldsBlockSize Thesizeofablockinatar

archiveinbytes.

DefaultBlockFactor Thenumberofblocksinadefaultrecord.

DefaultRecordSize Thesizeinbytesofadefaultrecord.

TarBufferFields

Thesizeofablockinatararchiveinbytes.

publicconstintBlockSize=512;

RemarksThisis512bytes.

TarBuffer.BlockSizeField

Thenumberofblocksinadefaultrecord.

publicconstintDefaultBlockFactor=20;

RemarksThedefaultvalueis20blockperrecord.

TarBuffer.DefaultBlockFactorField

Thesizeinbytesofadefaultrecord.

publicconstintDefaultRecordSize=

10240;

RemarksThedefaultsizeis10KB.

TarBuffer.DefaultRecordSizeField

ThepropertiesoftheTarBufferclassarelistedbelow.ForacompletelistofTarBufferclassmembers,seetheTarBufferMemberstopic.

PublicInstancePropertiesBlockFactor GettheBlockingfactorforthe

buffer

RecordSize Gettherecordsizeforthisbuffer

TarBufferProperties

GettheBlockingfactorforthebuffer

publicintBlockFactor{get;}

TarBuffer.BlockFactorProperty

Gettherecordsizeforthisbuffer

publicintRecordSize{get;}

TarBuffer.RecordSizeProperty

ThemethodsoftheTarBufferclassarelistedbelow.ForacompletelistofTarBufferclassmembers,seetheTarBufferMemberstopic.

PublicStaticMethodsCreateInputTarBuffer Overloaded.CreateTarBuffer

forreadingwithdefaultBlockFactor

CreateOutputTarBuffer Overloaded.ConstructTarBufferforwritingwithdefaultBlockFactor

PublicInstanceMethodsClose ClosetheTarBuffer.Ifthisisan

outputbuffer,alsoflushthecurrentblockbeforeclosing.

GetBlockFactor GettheTARBuffer'sblockfactor

GetCurrentBlockNum Getthecurrentblocknumber,withinthecurrentrecord,zerobased.

GetCurrentRecordNum Getthecurrentrecordnumber.

GetRecordSize GettheTARBuffer'srecordsize.

TarBufferMethods

IsEOFBlock DetermineifanarchiveblockindicatesEndofArchive.Endofarchiveisindicatedbyablockthatconsistsentirelyofnullbytes.Allremainingblocksfortherecordshouldalsobenull'sHoweversomeoldertarsonlydoacoupleofnullblocks(OldGNUtarforone)andalsopartialrecords

ReadBlock Readablockfromtheinputstream.

SkipBlock Skipoverablockontheinputstream.

WriteBlock Overloaded.Writeablockofdatatothearchive.

ClosetheTarBuffer.Ifthisisanoutputbuffer,alsoflushthecurrentblockbeforeclosing.

publicvoidClose();

TarBuffer.CloseMethod

CreateTarBufferforreadingwithdefaultBlockFactor

OverloadListCreateTarBufferforreadingwithdefaultBlockFactor

publicstaticTarBufferCreateInputTarBuffer(Stream);

ConstructTarBufferforreadinginputStreamsettingBlockFactor

publicstaticTarBufferCreateInputTarBuffer(Stream,int);

TarBuffer.CreateInputTarBufferMethod

CreateTarBufferforreadingwithdefaultBlockFactor

publicstaticTarBufferCreateInputTarBuffer(

StreaminputStream

Streamtobuffer

ReturnValueTarBuffer

SeeAlsoTarBufferClass|ICSharpCode.SharpZipLib.TarNamespace|TarBuffer.CreateInputTarBufferOverloadList

TarBuffer.CreateInputTarBufferMethod(Stream)

ConstructTarBufferforreadinginputStreamsettingBlockFactor

publicstaticTarBufferCreateInputTarBuffer(

StreaminputStream,

intblockFactor

Streamtobuffer

blockFactorBlockingfactortoapply

SeeAlsoTarBufferClass|ICSharpCode.SharpZipLib.TarNamespace|TarBuffer.CreateInputTarBufferOverloadList

TarBuffer.CreateInputTarBufferMethod(Stream,Int32)

ConstructTarBufferforwritingwithdefaultBlockFactor

OverloadListConstructTarBufferforwritingwithdefaultBlockFactor

publicstaticTarBufferCreateOutputTarBuffer(Stream);

ConstructTarBufferforwritingTaroutputtostreams.

publicstaticTarBufferCreateOutputTarBuffer(Stream,int);

TarBuffer.CreateOutputTarBufferMethod

ConstructTarBufferforwritingwithdefaultBlockFactor

publicstaticTarBufferCreateOutputTarBuffer(

StreamoutputStream

outputstreamforbuffer

SeeAlsoTarBufferClass|ICSharpCode.SharpZipLib.TarNamespace|TarBuffer.CreateOutputTarBufferOverloadList

TarBuffer.CreateOutputTarBufferMethod(Stream)

ConstructTarBufferforwritingTaroutputtostreams.

publicstaticTarBufferCreateOutputTarBuffer(

StreamoutputStream,

intblockFactor

Outputstreamtowriteto.

blockFactorBlockingfactortoapply

SeeAlsoTarBufferClass|ICSharpCode.SharpZipLib.TarNamespace|TarBuffer.CreateOutputTarBufferOverloadList

TarBuffer.CreateOutputTarBufferMethod(Stream,Int32)

GettheTARBuffer'sblockfactor

publicintGetBlockFactor();

TarBuffer.GetBlockFactorMethod

Getthecurrentblocknumber,withinthecurrentrecord,zerobased.

publicintGetCurrentBlockNum();

ReturnValueThecurrentzerobasedblocknumber.

RemarksTheabsoluteblocknumber=(recordnumber*blockfactor)+blocknumber.

TarBuffer.GetCurrentBlockNumMethod

Getthecurrentrecordnumber.

publicintGetCurrentRecordNum();

ReturnValueThecurrentzerobasedrecordnumber.

TarBuffer.GetCurrentRecordNumMethod

GettheTARBuffer'srecordsize.

publicintGetRecordSize();

TarBuffer.GetRecordSizeMethod

DetermineifanarchiveblockindicatesEndofArchive.Endofarchiveisindicatedbyablockthatconsistsentirelyofnullbytes.Allremainingblocksfortherecordshouldalsobenull'sHoweversomeoldertarsonlydoacoupleofnullblocks(OldGNUtarforone)andalsopartialrecords

publicboolIsEOFBlock(

byte[]block

Parametersblock

Thedatablocktocheck.

TarBuffer.IsEOFBlockMethod

Readablockfromtheinputstream.

publicbyte[]ReadBlock();

ReturnValueTheblockofdataread.

TarBuffer.ReadBlockMethod

Skipoverablockontheinputstream.

publicvoidSkipBlock();

TarBuffer.SkipBlockMethod

Writeablockofdatatothearchive.

OverloadListWriteablockofdatatothearchive.

publicvoidWriteBlock(byte[]);

Writeanarchiverecordtothearchive,wheretherecordmaybeinsideofalargerarraybuffer.Thebuffermustbe"offsetplusrecordsize"long.

publicvoidWriteBlock(byte[],int);

TarBuffer.WriteBlockMethod

Writeablockofdatatothearchive.

publicvoidWriteBlock(

byte[]block

Parametersblock

Thedatatowritetothearchive.

SeeAlsoTarBufferClass|ICSharpCode.SharpZipLib.TarNamespace|TarBuffer.WriteBlockOverloadList

TarBuffer.WriteBlockMethod(Byte[])

Writeanarchiverecordtothearchive,wheretherecordmaybeinsideofalargerarraybuffer.Thebuffermustbe"offsetplusrecordsize"long.

byte[]buf,

intoffset

Parametersbuf

Thebuffercontainingtherecorddatatowrite.

offsetTheoffsetoftherecorddatawithinbuf.

SeeAlsoTarBufferClass|ICSharpCode.SharpZipLib.TarNamespace|TarBuffer.WriteBlockOverloadList

TarBuffer.WriteBlockMethod(Byte[],Int32)

ThisclassrepresentsanentryinaTararchive.Itconsistsoftheentry'sheader,aswellastheentry'sFile.Entriescanbeinstantiatedinoneofthreeways,dependingonhowtheyaretobeused.

TarEntriesthatarecreatedfromtheheaderbytesreadfromanarchiveareinstantiatedwiththeTarEntry(byte[])constructor.Theseentrieswillbeusedwhenextractingfromorlistingthecontentsofanarchive.Theseentrieshavetheirheaderfilledinusingtheheaderbytes.TheyalsosettheFiletonull,sincetheyreferenceanarchiveentrynotafile.

TarEntriesthatarecreatedfromfilesthataretobewrittenintoanarchiveareinstantiatedwiththeCreateEntryFromFile(string)pseudoconstructor.TheseentrieshavetheirheaderfilledinusingtheFile'sinformation.TheyalsokeepareferencetotheFileforconveniencewhenwritingentries.

Finally,TarEntriescanbeconstructedfromnothingbutaname.Thisallowstheprogrammertoconstructtheentrybyhand,forinstancewhenonlyanInputStreamisavailableforwritingtothearchive,andtheheaderinformationisconstructedfromotherinformation.InthiscasetheheaderfieldsaresettodefaultsandtheFileissettonull.

TarHeader

Foralistofallmembersofthistype,seeTarEntryMembers.

System.ObjectICSharpCode.SharpZipLib.Tar.TarEntry

publicclassTarEntry:ICloneable

RequirementsNamespace:ICSharpCode.SharpZipLib.TarAssembly:ICSharpCode.SharpZipLib(in

TarEntryClass

ICSharpCode.SharpZipLib.dll)

SeeAlsoTarEntryMembers|ICSharpCode.SharpZipLib.TarNamespace

TarEntryoverview

PublicStaticMethodsCreateEntryFromFile Constructanentryforafile.File

issettofile,andtheheaderisconstructedfrominformationfromthefile.

CreateTarEntry Constructanentrywithonlyaname.Thisallowstheprogrammertoconstructtheentry'sheader"byhand".

PublicInstanceConstructorsTarEntry Overloaded.Initializesanew

instanceoftheTarEntryclass.

PublicInstancePropertiesFile Getthisentry'sfile.

GroupId Get/setthisentry'sgroupid.

GroupName Get/setthisentry'sgroupname.

IsDirectory Returntrueifthisentryrepresentsadirectory,falseotherwise

ModTime Get/Setthemodificationtimeforthisentry

Name Get/Setthisentry'sname.

Size Get/setthisentry'srecordedfilesize.

TarHeader Getthisentry'sheader.

UserId Get/setthisentry'suserid.

TarEntryMembers

UserName Get/setthisentry'susername.

PublicInstanceMethodsAdjustEntryName Conveniencemethodthatwill

modifyanentry'snamedirectlyinplaceinanentryheaderbufferbytearray.

Clone Clonethistarentry.

Equals Determineifthetwoentriesareequal.Equalityisdeterminedbytheheadernamesbeingequal.

GetDirectoryEntries Getentriesforallfilespresentinthisentriesdirectory.Ifthisentrydoesntrepresentadirectoryzeroentriesarereturned.

GetFileTarHeader FillinaTarHeaderwithinformationfromaFile.

GetHashCode MustbeoverriddenwhenyouoverrideEquals.

IsDescendent Determineifthegivenentryisadescendantofthisentry.Descendancyisdeterminedbythenameofthedescendantstartingwiththisentry'sname.

NameTarHeader FillinaTarHeadergivenonlytheentry'sname.

SetIds Conveniencemethodtosetthisentry'sgroupanduserids.

SetNames Conveniencemethodtosetthisentry'sgroupandusernames.

ToString(inheritedfrom ReturnsaStringthatrepresents

Object) thecurrentObject.

WriteEntryHeader Writeanentry'sheaderinformationtoaheaderbuffer.

SeeAlsoTarEntryClass|ICSharpCode.SharpZipLib.TarNamespace

Constructanentryfromanarchive'sheaderbytes.Fileissettonull.

OverloadListConstructaTarEntryusingtheheaderprovided

publicTarEntry(TarHeader);

publicTarEntry(byte[]);

TarEntryConstructor

publicTarEntry(

byte[]headerBuf

ParametersheaderBuf

Theheaderbytesfromatararchiveentry.

SeeAlsoTarEntryClass|ICSharpCode.SharpZipLib.TarNamespace|TarEntryConstructorOverloadList

TarEntryConstructor(Byte[])

ConstructaTarEntryusingtheheaderprovided

publicTarEntry(

TarHeaderheader

Parametersheader

Headerdetailsforentry

SeeAlsoTarEntryClass|ICSharpCode.SharpZipLib.TarNamespace|TarEntryConstructorOverloadList

TarEntryConstructor(TarHeader)

ThepropertiesoftheTarEntryclassarelistedbelow.ForacompletelistofTarEntryclassmembers,seetheTarEntryMemberstopic.

PublicInstancePropertiesFile Getthisentry'sfile.

GroupId Get/setthisentry'sgroupid.

GroupName Get/setthisentry'sgroupname.

IsDirectory Returntrueifthisentryrepresentsadirectory,falseotherwise

ModTime Get/Setthemodificationtimeforthisentry

Name Get/Setthisentry'sname.

Size Get/setthisentry'srecordedfilesize.

TarHeader Getthisentry'sheader.

UserId Get/setthisentry'suserid.

UserName Get/setthisentry'susername.

TarEntryProperties

Getthisentry'sfile.

publicstringFile{get;}

TarEntry.FileProperty

Get/setthisentry'sgroupid.

publicintGroupId{get;set;}

TarEntry.GroupIdProperty

Get/setthisentry'sgroupname.

publicstringGroupName{get;set;}

TarEntry.GroupNameProperty

Returntrueifthisentryrepresentsadirectory,falseotherwise

publicboolIsDirectory{get;}

TarEntry.IsDirectoryProperty

Get/Setthemodificationtimeforthisentry

publicSystem.DateTimeModTime{get;set;}

TarEntry.ModTimeProperty

Get/Setthisentry'sname.

publicstringName{get;set;}

TarEntry.NameProperty

Get/setthisentry'srecordedfilesize.

publiclongSize{get;set;}

TarEntry.SizeProperty

Getthisentry'sheader.

publicTarHeaderTarHeader{get;}

TarEntry.TarHeaderProperty

Get/setthisentry'suserid.

publicintUserId{get;set;}

TarEntry.UserIdProperty

Get/setthisentry'susername.

publicstringUserName{get;set;}

TarEntry.UserNameProperty

ThemethodsoftheTarEntryclassarelistedbelow.ForacompletelistofTarEntryclassmembers,seetheTarEntryMemberstopic.

PublicStaticMethodsCreateEntryFromFile Constructanentryforafile.File

issettofile,andtheheaderisconstructedfrominformationfromthefile.

CreateTarEntry Constructanentrywithonlyaname.Thisallowstheprogrammertoconstructtheentry'sheader"byhand".

PublicInstanceMethodsAdjustEntryName Conveniencemethodthatwill

modifyanentry'snamedirectlyinplaceinanentryheaderbufferbytearray.

Clone Clonethistarentry.

Equals Determineifthetwoentriesareequal.Equalityisdeterminedbytheheadernamesbeingequal.

GetDirectoryEntries Getentriesforallfilespresentinthisentriesdirectory.Ifthisentrydoesntrepresentadirectoryzeroentriesarereturned.

GetFileTarHeader FillinaTarHeaderwithinformationfromaFile.

GetHashCode MustbeoverriddenwhenyouoverrideEquals.

TarEntryMethods

IsDescendent Determineifthegivenentryisadescendantofthisentry.Descendancyisdeterminedbythenameofthedescendantstartingwiththisentry'sname.

NameTarHeader FillinaTarHeadergivenonlytheentry'sname.

SetIds Conveniencemethodtosetthisentry'sgroupanduserids.

SetNames Conveniencemethodtosetthisentry'sgroupandusernames.

WriteEntryHeader Writeanentry'sheaderinformationtoaheaderbuffer.

Conveniencemethodthatwillmodifyanentry'snamedirectlyinplaceinanentryheaderbufferbytearray.

publicvoidAdjustEntryName(

byte[]outbuf,

stringnewName

Parametersoutbuf

Thebuffercontainingtheentryheadertomodify.

newNameThenewnametoplaceintotheheaderbuffer.

TarEntry.AdjustEntryNameMethod

Clonethistarentry.

publicobjectClone();

ReturnValueReturnsacloneofthisentry.

ImplementsICloneable.Clone

TarEntry.CloneMethod

Constructanentryforafile.Fileissettofile,andtheheaderisconstructedfrominformationfromthefile.

publicstaticTarEntryCreateEntryFromFile(

stringfileName

ParametersfileName

Thefilethattheentryrepresents.

TarEntry.CreateEntryFromFileMethod

Constructanentrywithonlyaname.Thisallowstheprogrammertoconstructtheentry'sheader"byhand".

publicstaticTarEntryCreateTarEntry(

stringname

TarEntry.CreateTarEntryMethod

Determineifthetwoentriesareequal.Equalityisdeterminedbytheheadernamesbeingequal.

publicoverrideboolEquals(

objectit

ReturnValueTrueiftheentriesareequal.

TarEntry.EqualsMethod

Getentriesforallfilespresentinthisentriesdirectory.Ifthisentrydoesntrepresentadirectoryzeroentriesarereturned.

publicTarEntry[]GetDirectoryEntries();

ReturnValueAnarrayofTarEntry'sforthisentry'schildren.

TarEntry.GetDirectoryEntriesMethod

FillinaTarHeaderwithinformationfromaFile.

publicvoidGetFileTarHeader(

TarHeaderhdr,

stringfile

Parametershdr

TheTarHeadertofillin.

fileThefilefromwhichtogettheheaderinformation.

TarEntry.GetFileTarHeaderMethod

MustbeoverriddenwhenyouoverrideEquals.

publicoverrideintGetHashCode();

TarEntry.GetHashCodeMethod

Determineifthegivenentryisadescendantofthisentry.Descendancyisdeterminedbythenameofthedescendantstartingwiththisentry'sname.

publicboolIsDescendent(

TarEntrydesc

Parametersdesc

Entrytobecheckedasadescendentofthis.

ReturnValueTrueifentryisadescendantofthis.

TarEntry.IsDescendentMethod

FillinaTarHeadergivenonlytheentry'sname.

publicvoidNameTarHeader(

TarHeaderhdr,

stringname

Parametershdr

TheTarHeadertofillin.

nameThetarentryname.

TarEntry.NameTarHeaderMethod

Conveniencemethodtosetthisentry'sgroupanduserids.

publicvoidSetIds(

intuserId,

intgroupId

ParametersuserId

Thisentry'snewuserid.

groupIdThisentry'snewgroupid.

TarEntry.SetIdsMethod

Conveniencemethodtosetthisentry'sgroupandusernames.

publicvoidSetNames(

stringuserName,

stringgroupName

ParametersuserName

Thisentry'snewusername.

groupNameThisentry'snewgroupname.

TarEntry.SetNamesMethod

Writeanentry'sheaderinformationtoaheaderbuffer.

publicvoidWriteEntryHeader(

byte[]outbuf

Parametersoutbuf

Thetarentryheaderbuffertofillin.

TarEntry.WriteEntryHeaderMethod

TarExceptionsareusedforexceptionsspecifictotarclassesandcode.

Foralistofallmembersofthistype,seeTarExceptionMembers.

System.ObjectSystem.ExceptionSystem.ApplicationExceptionICSharpCode.SharpZipLib.SharpZipBaseExceptionICSharpCode.SharpZipLib.Tar.TarExceptionICSharpCode.SharpZipLib.Tar.InvalidHeaderException

publicclassTarException:

SeeAlsoTarExceptionMembers|ICSharpCode.SharpZipLib.TarNamespace

TarExceptionClass

TarExceptionoverview

PublicInstanceConstructorsTarException Overloaded.Initializesanew

instanceoftheTarExceptionclass.

TarExceptionMembers

SeeAlsoTarExceptionClass|ICSharpCode.SharpZipLib.TarNamespace

InitialisesanewinstanceoftheTarExceptionclass.

OverloadListInitialisesanewinstanceoftheTarExceptionclass.

publicTarException();

InitialisesanewinstanceoftheTarExceptionclasswithaspecifiedmessage.

publicTarException(string);

SeeAlsoTarExceptionClass|ICSharpCode.SharpZipLib.TarNamespace

TarExceptionConstructor

InitialisesanewinstanceoftheTarExceptionclass.

publicTarException();

SeeAlsoTarExceptionClass|ICSharpCode.SharpZipLib.TarNamespace|TarExceptionConstructorOverloadList

TarExceptionConstructor()

InitialisesanewinstanceoftheTarExceptionclasswithaspecifiedmessage.

publicTarException(

stringmessage

Parametersmessage

Themessagethatdescribestheerror.

SeeAlsoTarExceptionClass|ICSharpCode.SharpZipLib.TarNamespace|TarExceptionConstructorOverloadList

TarExceptionConstructor(String)

ThisclassencapsulatestheTarEntryHeaderusedinTarArchives.Theclassalsoholdsanumberoftarconstants,usedmostlyinheaders.

Foralistofallmembersofthistype,seeTarHeaderMembers.

System.ObjectICSharpCode.SharpZipLib.Tar.TarHeader

publicclassTarHeader:ICloneable

SeeAlsoTarHeaderMembers|ICSharpCode.SharpZipLib.TarNamespace

TarHeaderClass

TarHeaderoverview

PublicStaticFieldsCHKSUMLEN Thelengthofthechecksum

fieldinaheaderbuffer.

CHKSUMOFS Offsetofchecksuminaheaderbuffer.

DEVLEN Thelengthofthedevicesfieldinaheaderbuffer.

GIDLEN Thelengthofthegroupidfieldinaheaderbuffer.

GNAMELEN Thelengthofthegroupnamefieldinaheaderbuffer.

GNU_TMAGIC ThemagictagrepresentinganoldGNUtararchivewhereversionisincludedinmagicandoverwritesit

LF_ACL Solarisaccesscontrollistfiletype

LF_BLK Blockdevicefiletype.

LF_CHR Characterdevicefiletype.

LF_CONTIG Contiguousfiletype.

LF_DIR Directoryfiletype.

LF_EXTATTR SolarisExtendedAttributeFile

LF_FIFO FIFO(pipe)filetype.

LF_GHDR Posix.12001globalextendedheader

LF_GNU_DUMPDIR GNUdirdumpfiletypeThisisadirentrythatcontainsthenamesoffilesthatwereinthe

TarHeaderMembers

diratthetimethedumpwasmade

LF_GNU_LONGLINK Identifiesthenextfileonthetapeashavingalonglinkname

LF_GNU_LONGNAME Identifiesthenextfileonthetapeashavingalongname

LF_GNU_MULTIVOL Continuationofafilethatbeganonanothervolume

LF_GNU_NAMES Forstoringfilenamesthatdontfitinthemainheader(oldGNU)

LF_GNU_SPARSE GNUSparsefile

LF_GNU_VOLHDR GNUTape/volumeheaderignoreonextraction

LF_LINK Linkfiletype.

LF_META Inode(metadataonly)nofilecontent

LF_NORMAL Normalfiletype.

LF_OLDNORM The"oldway"ofindicatinganormalfile.

LF_SYMLINK Symboliclinkfiletype.

LF_XHDR Posix.12001extendedheader

MAGICLEN Thelengthofthemagicfieldinaheaderbuffer.

MODELEN Thelengthofthemodefieldinaheaderbuffer.

MODTIMELEN Thelengthofthemodificationtimefieldinaheaderbuffer.

NAMELEN Thelengthofthenamefieldinaheaderbuffer.

SIZELEN Thelengthofthesizefieldinaheaderbuffer.

TMAGIC ThemagictagrepresentingaPOSIXtararchive.(includestrailingNULL)

UIDLEN Thelengthoftheuseridfieldinaheaderbuffer.

UNAMELEN Thelengthoftheusernamefieldinaheaderbuffer.

VERSIONLEN Thelengthoftheversionfieldinaheaderbuffer.

PublicStaticMethodsGetAsciiBytes Addastringtoabufferasa

collectionofasciibytes.

GetLongOctalBytes Putanoctalrepresentationofavalueintoabuffer

GetNameBytes Overloaded.Addnametothebufferasacollectionofbytes

GetOctalBytes Putanoctalrepresentationofavalueintoabuffer

ParseName Parseanamefromaheaderbuffer.

ParseOctal Parseanoctalstringfromaheaderbuffer.

ResetValueDefaults Resetvaluedefaultstoinitialvalues.

SetValueDefaults SetdefaultsforvaluesusedwhenconstructingaTarHeaderinstance.

PublicInstanceConstructorsTarHeaderConstructor InitialiseadefaultTarHeader

instance

PublicInstancePropertiesChecksum Gettheentry'schecksum.This

isonlyvalid/updatedafterwritingorreadinganentry.

DevMajor Get/settheentry'smajordevicenumber.

DevMinor Get/settheentry'sminordevicenumber.

GroupId Get/settheentry'sgroupid.

GroupName Get/settheentry'sgroupname.

IsChecksumValid Getvalueoftrueiftheheaderchecksumisvalid,falseotherwise.

LinkName Theentry'slinkname.

Magic Get/settheentry'smagictag.

Mode Get/settheentry'sUnixstylepermissionmode.

ModTime Get/settheentry'smodificationtime.

Name Get/setthenameforthistarentry.

Size Get/settheentry'ssize.

TypeFlag Get/settheentry'stypeflag.

UserId Theentry'suserid.

UserName Theentry'susername.

Version Theentry'sversion.

PublicInstanceMethodsClone CloneaTARheader.

Equals Determinesifthisinstanceis

equaltothespecifiedobject.

GetHashCode Getahashcodeforthecurrentobject.

GetName Obsolete.Getthenameofthisentry.

ParseBuffer ParseTarHeaderinformationfromaheaderbuffer.

WriteHeader 'Write'headerinformationtobufferprovided,updatingthechecksum.

SeeAlsoTarHeaderClass|ICSharpCode.SharpZipLib.TarNamespace

InitialiseadefaultTarHeaderinstance

publicTarHeader();

TarHeaderConstructor

ThefieldsoftheTarHeaderclassarelistedbelow.ForacompletelistofTarHeaderclassmembers,seetheTarHeaderMemberstopic.

PublicStaticFieldsCHKSUMLEN Thelengthofthechecksum

fieldinaheaderbuffer.

CHKSUMOFS Offsetofchecksuminaheaderbuffer.

DEVLEN Thelengthofthedevicesfieldinaheaderbuffer.

GIDLEN Thelengthofthegroupidfieldinaheaderbuffer.

GNAMELEN Thelengthofthegroupnamefieldinaheaderbuffer.

GNU_TMAGIC ThemagictagrepresentinganoldGNUtararchivewhereversionisincludedinmagicandoverwritesit

LF_ACL Solarisaccesscontrollistfiletype

LF_BLK Blockdevicefiletype.

LF_CHR Characterdevicefiletype.

LF_CONTIG Contiguousfiletype.

LF_DIR Directoryfiletype.

LF_EXTATTR SolarisExtendedAttributeFile

LF_FIFO FIFO(pipe)filetype.

LF_GHDR Posix.12001globalextendedheader

LF_GNU_DUMPDIR GNUdirdumpfiletypeThisisadirentrythatcontainsthe

TarHeaderFields

namesoffilesthatwereinthediratthetimethedumpwasmade

LF_GNU_LONGLINK Identifiesthenextfileonthetapeashavingalonglinkname

LF_GNU_LONGNAME Identifiesthenextfileonthetapeashavingalongname

LF_GNU_MULTIVOL Continuationofafilethatbeganonanothervolume

LF_GNU_NAMES Forstoringfilenamesthatdontfitinthemainheader(oldGNU)

LF_GNU_SPARSE GNUSparsefile

LF_GNU_VOLHDR GNUTape/volumeheaderignoreonextraction

LF_LINK Linkfiletype.

LF_META Inode(metadataonly)nofilecontent

LF_NORMAL Normalfiletype.

LF_OLDNORM The"oldway"ofindicatinganormalfile.

LF_SYMLINK Symboliclinkfiletype.

LF_XHDR Posix.12001extendedheader

MAGICLEN Thelengthofthemagicfieldinaheaderbuffer.

MODELEN Thelengthofthemodefieldinaheaderbuffer.

MODTIMELEN Thelengthofthemodificationtimefieldinaheaderbuffer.

NAMELEN Thelengthofthenamefieldinaheaderbuffer.

SIZELEN Thelengthofthesizefieldina

headerbuffer.

TMAGIC ThemagictagrepresentingaPOSIXtararchive.(includestrailingNULL)

UIDLEN Thelengthoftheuseridfieldinaheaderbuffer.

UNAMELEN Thelengthoftheusernamefieldinaheaderbuffer.

VERSIONLEN Thelengthoftheversionfieldinaheaderbuffer.

Thelengthofthechecksumfieldinaheaderbuffer.

publicstaticreadonlyintCHKSUMLEN;

TarHeader.CHKSUMLENField

Offsetofchecksuminaheaderbuffer.

publicconstintCHKSUMOFS=148;

TarHeader.CHKSUMOFSField

Thelengthofthedevicesfieldinaheaderbuffer.

publicstaticreadonlyintDEVLEN;

TarHeader.DEVLENField

Thelengthofthegroupidfieldinaheaderbuffer.

publicstaticreadonlyintGIDLEN;

TarHeader.GIDLENField

Thelengthofthegroupnamefieldinaheaderbuffer.

publicstaticreadonlyintGNAMELEN;

TarHeader.GNAMELENField

ThemagictagrepresentinganoldGNUtararchivewhereversionisincludedinmagicandoverwritesit

publicstaticreadonlystringGNU_TMAGIC;

TarHeader.GNU_TMAGICField

Solarisaccesscontrollistfiletype

publicconstbyteLF_ACL=65;

TarHeader.LF_ACLField

Blockdevicefiletype.

publicconstbyteLF_BLK=52;

TarHeader.LF_BLKField

Characterdevicefiletype.

publicconstbyteLF_CHR=51;

TarHeader.LF_CHRField

Contiguousfiletype.

publicconstbyteLF_CONTIG=55;

TarHeader.LF_CONTIGField

Directoryfiletype.

publicconstbyteLF_DIR=53;

TarHeader.LF_DIRField

SolarisExtendedAttributeFile

publicconstbyteLF_EXTATTR=69;

TarHeader.LF_EXTATTRField

FIFO(pipe)filetype.

publicconstbyteLF_FIFO=54;

TarHeader.LF_FIFOField

Posix.12001globalextendedheader

publicconstbyteLF_GHDR=103;

TarHeader.LF_GHDRField

GNUdirdumpfiletypeThisisadirentrythatcontainsthenamesoffilesthatwereinthediratthetimethedumpwasmade

publicconstbyteLF_GNU_DUMPDIR=68;

TarHeader.LF_GNU_DUMPDIRField

Identifiesthenextfileonthetapeashavingalonglinkname

publicconstbyteLF_GNU_LONGLINK=75;

TarHeader.LF_GNU_LONGLINKField

Identifiesthenextfileonthetapeashavingalongname

publicconstbyteLF_GNU_LONGNAME=76;

TarHeader.LF_GNU_LONGNAMEField

Continuationofafilethatbeganonanothervolume

publicconstbyteLF_GNU_MULTIVOL=77;

TarHeader.LF_GNU_MULTIVOLField

Forstoringfilenamesthatdontfitinthemainheader(oldGNU)

publicconstbyteLF_GNU_NAMES=78;

TarHeader.LF_GNU_NAMESField

GNUSparsefile

publicconstbyteLF_GNU_SPARSE=83;

TarHeader.LF_GNU_SPARSEField

GNUTape/volumeheaderignoreonextraction

publicconstbyteLF_GNU_VOLHDR=86;

TarHeader.LF_GNU_VOLHDRField

Linkfiletype.

publicconstbyteLF_LINK=49;

TarHeader.LF_LINKField

Inode(metadataonly)nofilecontent

publicconstbyteLF_META=73;

TarHeader.LF_METAField

Normalfiletype.

publicconstbyteLF_NORMAL=48;

TarHeader.LF_NORMALField

The"oldway"ofindicatinganormalfile.

publicconstbyteLF_OLDNORM=0;

TarHeader.LF_OLDNORMField

Symboliclinkfiletype.

publicconstbyteLF_SYMLINK=50;

TarHeader.LF_SYMLINKField

Posix.12001extendedheader

publicstaticreadonlybyteLF_XHDR;

TarHeader.LF_XHDRField

Thelengthofthemagicfieldinaheaderbuffer.

publicstaticreadonlyintMAGICLEN;

TarHeader.MAGICLENField

Thelengthofthemodefieldinaheaderbuffer.

publicstaticreadonlyintMODELEN;

TarHeader.MODELENField

Thelengthofthemodificationtimefieldinaheaderbuffer.

publicstaticreadonlyintMODTIMELEN;

TarHeader.MODTIMELENField

Thelengthofthenamefieldinaheaderbuffer.

publicstaticreadonlyintNAMELEN;

TarHeader.NAMELENField

Thelengthofthesizefieldinaheaderbuffer.

publicstaticreadonlyintSIZELEN;

TarHeader.SIZELENField

ThemagictagrepresentingaPOSIXtararchive.(includestrailingNULL)

publicstaticreadonlystringTMAGIC;

TarHeader.TMAGICField

Thelengthoftheuseridfieldinaheaderbuffer.

publicstaticreadonlyintUIDLEN;

TarHeader.UIDLENField

Thelengthoftheusernamefieldinaheaderbuffer.

publicstaticreadonlyintUNAMELEN;

TarHeader.UNAMELENField

Thelengthoftheversionfieldinaheaderbuffer.

publicstaticreadonlyintVERSIONLEN;

TarHeader.VERSIONLENField

ThepropertiesoftheTarHeaderclassarelistedbelow.ForacompletelistofTarHeaderclassmembers,seetheTarHeaderMemberstopic.

PublicInstancePropertiesChecksum Gettheentry'schecksum.This

isonlyvalid/updatedafterwritingorreadinganentry.

DevMajor Get/settheentry'smajordevicenumber.

DevMinor Get/settheentry'sminordevicenumber.

GroupId Get/settheentry'sgroupid.

GroupName Get/settheentry'sgroupname.

IsChecksumValid Getvalueoftrueiftheheaderchecksumisvalid,falseotherwise.

LinkName Theentry'slinkname.

Magic Get/settheentry'smagictag.

Mode Get/settheentry'sUnixstylepermissionmode.

ModTime Get/settheentry'smodificationtime.

Name Get/setthenameforthistarentry.

Size Get/settheentry'ssize.

TypeFlag Get/settheentry'stypeflag.

UserId Theentry'suserid.

UserName Theentry'susername.

TarHeaderProperties

Version Theentry'sversion.

Gettheentry'schecksum.Thisisonlyvalid/updatedafterwritingorreadinganentry.

publicintChecksum{get;}

TarHeader.ChecksumProperty

Get/settheentry'smajordevicenumber.

publicintDevMajor{get;set;}

TarHeader.DevMajorProperty

Get/settheentry'sminordevicenumber.

publicintDevMinor{get;set;}

TarHeader.DevMinorProperty

Get/settheentry'sgroupid.

publicintGroupId{get;set;}

RemarksThisisonlydirectlyrelevanttolinux/unixsystems.Thedefaultvalueiszero.

TarHeader.GroupIdProperty

Get/settheentry'sgroupname.

publicstringGroupName{get;set;}

RemarksThisisonlydirectlyrelevanttounixsystems.

TarHeader.GroupNameProperty

Getvalueoftrueiftheheaderchecksumisvalid,falseotherwise.

publicboolIsChecksumValid{get;}

TarHeader.IsChecksumValidProperty

Theentry'slinkname.

publicstringLinkName{get;set;}

ExceptionsExceptionType ConditionArgumentNullException Thrownwhenattemptingtoset

LinkNametonull.

TarHeader.LinkNameProperty

Get/settheentry'smagictag.

publicstringMagic{get;set;}

Magictonull.

TarHeader.MagicProperty

Get/settheentry'sUnixstylepermissionmode.

publicintMode{get;set;}

TarHeader.ModeProperty

Get/settheentry'smodificationtime.

publicSystem.DateTimeModTime{get;set;}

RemarksThemodificationtimeisonlyaccuratetowithinasecond.

ExceptionsExceptionType ConditionArgumentOutOfRangeException Thrownwhensettingthedate

timetolessthan1/1/1970.

TarHeader.ModTimeProperty

Get/setthenameforthistarentry.

publicstringName{get;set;}

thepropertytonull.

TarHeader.NameProperty

Get/settheentry'ssize.

ExceptionsExceptionType ConditionArgumentOutOfRangeException Thrownwhensettingthesizeto

lessthanzero.

TarHeader.SizeProperty

Get/settheentry'stypeflag.

publicbyteTypeFlag{get;set;}

TarHeader.TypeFlagProperty

Theentry'suserid.

publicintUserId{get;set;}

RemarksThisisonlydirectlyrelevanttounixsystems.Thedefaultiszero.

TarHeader.UserIdProperty

Theentry'susername.

publicstringUserName{get;set;}

RemarksSeeResetValueDefaultsfordetailonhowthisvalueisderived.

TarHeader.UserNameProperty

Theentry'sversion.

publicstringVersion{get;set;}

Versiontonull.

TarHeader.VersionProperty

ThemethodsoftheTarHeaderclassarelistedbelow.ForacompletelistofTarHeaderclassmembers,seetheTarHeaderMemberstopic.

PublicStaticMethodsGetAsciiBytes Addastringtoabufferasa

collectionofasciibytes.

GetLongOctalBytes Putanoctalrepresentationofavalueintoabuffer

GetNameBytes Overloaded.Addnametothebufferasacollectionofbytes

GetOctalBytes Putanoctalrepresentationofavalueintoabuffer

ParseName Parseanamefromaheaderbuffer.

ParseOctal Parseanoctalstringfromaheaderbuffer.

ResetValueDefaults Resetvaluedefaultstoinitialvalues.

SetValueDefaults SetdefaultsforvaluesusedwhenconstructingaTarHeaderinstance.

PublicInstanceMethodsClone CloneaTARheader.

Equals Determinesifthisinstanceisequaltothespecifiedobject.

GetHashCode Getahashcodeforthecurrentobject.

GetName Obsolete.Getthenameofthisentry.

TarHeaderMethods

ParseBuffer ParseTarHeaderinformationfromaheaderbuffer.

WriteHeader 'Write'headerinformationtobufferprovided,updatingthechecksum.

CloneaTARheader.

TarHeader.CloneMethod

Determinesifthisinstanceisequaltothespecifiedobject.

publicoverrideboolEquals(

objectobj

Parametersobj

Theobjecttocomparewith.

ReturnValuetrueiftheobjectsareequal,falseotherwise.

TarHeader.EqualsMethod

Addastringtoabufferasacollectionofasciibytes.

publicstaticintGetAsciiBytes(

stringtoAdd,

intnameOffset,

byte[]buffer,

intbufferOffset,

intlength

ParameterstoAdd

Thestringtoadd

nameOffsetTheoffsetofthefirstcharactertoadd.

bufferThebuffertoaddto.

bufferOffsetTheoffsettostartaddingat.

lengthThenumberofasciicharacterstoadd.

ReturnValueThenextfreeindexinthebuffer.

TarHeader.GetAsciiBytesMethod

Getahashcodeforthecurrentobject.

publicoverrideintGetHashCode();

ReturnValueAhashcodeforthecurrentobject.

TarHeader.GetHashCodeMethod

Putanoctalrepresentationofavalueintoabuffer

publicstaticintGetLongOctalBytes(

longval,

byte[]buf,

intoffset,

intlength

Parametersval

Valuetobeconverttooctal

bufThebuffertoupdate

offsetTheoffsetintothebuffertostorethevalue

lengthThelengthoftheoctalstring

ReturnValueIndexofnextbyte

TarHeader.GetLongOctalBytesMethod

NOTE:Thismethodisnowobsolete.

Getthenameofthisentry.

publicstringGetName();

ReturnValueTheentry'sname.

RemarksThisisobsoleteusetheNamepropertyinstead.

TarHeader.GetNameMethod

Addanentrynametothebuffer

OverloadListAddanentrynametothebuffer

publicstaticintGetNameBytes(string,byte[],int,int);

Addnametothebufferasacollectionofbytes

publicstaticintGetNameBytes(string,int,byte[],int,int);

publicstaticintGetNameBytes(StringBuilder,byte[],int,int);

publicstaticintGetNameBytes(StringBuilder,int,byte[],int,int);

TarHeader.GetNameBytesMethod

publicstaticintGetNameBytes(

stringname,

byte[]buf,

intoffset,

intlength

Parametersname

Thenametoadd

bufThebuffertoaddto

offsetTheoffsetintothebufferfromwhichtostartadding

lengthThenumberofheaderbytestoadd

ReturnValueTheindexofthenextfreebyteinthebuffer

SeeAlsoTarHeaderClass|ICSharpCode.SharpZipLib.TarNamespace|TarHeader.GetNameBytesOverloadList

TarHeader.GetNameBytesMethod(String,Byte[],Int32,Int32)

stringname,

intnameOffset,

byte[]buf,

intbufferOffset,

intlength

Parametersname

Thenametoadd

nameOffsetTheoffsetofthefirstcharacter

bufThebuffertoaddto

bufferOffsetTheindexofthefirstbytetoadd

lengthThenumberofcharacters/bytestoadd

ReturnValueThenextfreeindexinthebuf

TarHeader.GetNameBytesMethod(String,Int32,Byte[],Int32,Int32)

StringBuildername,

byte[]buf,

intoffset,

intlength

Parametersname

Thenametoadd

bufThebuffertoaddto

offsetTheoffsetintothebufferfromwhichtostartadding

lengthThenumberofheaderbytestoadd

ReturnValueTheindexofthenextfreebyteinthebuffer

TarHeader.GetNameBytesMethod(StringBuilder,Byte[],Int32,Int32)

StringBuildername,

intnameOffset,

byte[]buf,

intbufferOffset,

intlength

Parametersname

Thenametoadd

nameOffsetTheoffsetofthefirstcharacter

bufThebuffertoaddto

bufferOffsetTheindexofthefirstbytetoadd

lengthThenumberofcharacters/bytestoadd

ReturnValueThenextfreeindexinthebuf

TarHeader.GetNameBytesMethod(StringBuilder,Int32,Byte[],Int32,Int32)

Putanoctalrepresentationofavalueintoabuffer

publicstaticintGetOctalBytes(

longval,

byte[]buf,

intoffset,

intlength

Parametersval

thevaluetobeconvertedtooctal

bufbuffertostoretheoctalstring

offsetTheoffsetintothebufferwherethevaluestarts

lengthThelengthoftheoctalstringtocreate

ReturnValueTheoffsetofthecharacternextbyteaftertheoctalstring

TarHeader.GetOctalBytesMethod

ParseTarHeaderinformationfromaheaderbuffer.

publicvoidParseBuffer(

byte[]header

Parametersheader

Thetarentryheaderbuffertogetinformationfrom.

TarHeader.ParseBufferMethod

Parseanamefromaheaderbuffer.

publicstaticStringBuilderParseName(

byte[]header,

intoffset,

intlength

Parametersheader

Theheaderbufferfromwhichtoparse.

offsetTheoffsetintothebufferfromwhichtoparse.

lengthThenumberofheaderbytestoparse.

ReturnValueThenameparsed.

TarHeader.ParseNameMethod

Parseanoctalstringfromaheaderbuffer.

publicstaticlongParseOctal(

byte[]header,

intoffset,

intlength

Parametersheader

Theheaderbufferfromwhichtoparse.

offsetTheoffsetintothebufferfromwhichtoparse.

lengthThenumberofheaderbytestoparse.

ReturnValueThelongequivalentoftheoctalstring.

TarHeader.ParseOctalMethod

Resetvaluedefaultstoinitialvalues.

publicstaticvoidResetValueDefaults();

RemarksThedefaultvaluesareuserid=0,groupid=0,groupname="None",username=null.WhenthedefaultusernameisnullthevaluefromEnvironment.UserNameisused.Or"PocketPC"fortheCompactframework.Whenthedefaultgroupnameisnullthevalue"None"isused.

TarHeader.ResetValueDefaultsMethod

SetdefaultsforvaluesusedwhenconstructingaTarHeaderinstance.

publicstaticvoidSetValueDefaults(

intuserId,

stringuserName,

intgroupId,

stringgroupName

ParametersuserId

ValuetoapplyasadefaultforuserId.

userNameValuetoapplyasadefaultforuserName.

groupIdValuetoapplyasadefaultforgroupId.

groupNameValuetoapplyasadefaultforgroupName.

TarHeader.SetValueDefaultsMethod

'Write'headerinformationtobufferprovided,updatingthechecksum.

publicvoidWriteHeader(

byte[]outbuf

Parametersoutbuf

outputbufferforheaderinformation

TarHeader.WriteHeaderMethod

TheTarInputStreamreadsaUNIXtararchiveasanInputStream.methodsareprovidedtopositionateachsuccessiveentryinthearchive,andthereadeachentryasanormalinputstreamusingread().

Foralistofallmembersofthistype,seeTarInputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.Tar.TarInputStream

publicclassTarInputStream:Stream

SeeAlsoTarInputStreamMembers|ICSharpCode.SharpZipLib.TarNamespace

TarInputStreamClass

TarInputStreamoverview

PublicInstanceConstructorsTarInputStream Overloaded.Initializesanew

instanceoftheTarInputStreamclass.

PublicInstancePropertiesAvailable Gettheavailabledatathatcanbereadfrom

thecurrententryinthearchive.Thisdoesnotindicatehowmuchdataisleftintheentirearchive,onlyinthecurrententry.Thisvalueisdeterminedfromtheentry'ssizeheaderfieldandtheamountofdataalreadyreadfromthecurrententry.

CanRead Getsavalueindicatingwhetherthecurrentstreamsupportsreading

CanSeek GetsavalueindicatingwhetherthecurrentstreamsupportsseekingThispropertyalwaysreturnsfalse.

CanWrite Getsavalueindicatingifthestreamsupportswriting.Thispropertyalwaysreturnsfalse.

IsMarkSupportedSincewedonotsupportmarkingjustyet,wereturnfalse.

Length Thelengthinbytesofthestream

Position Getsorsetsthepositionwithinthestream.SettingthePositionisnotsupportedandthrowsaNotSupportedExceptionNotSupportedException

PublicInstanceMethodsBeginRead(inheritedfrom Beginsanasynchronousread

TarInputStreamMembers

Stream) operation.

Close Closesthisstream.CallstheTarBuffer'sclose()method.TheunderlyingstreamisclosedbytheTarBuffer.

CopyEntryContents Copiesthecontentsofthecurrenttararchiveentrydirectlyintoanoutputstream.

Flush FlushesthebaseInputStream

GetNextEntry Getthenextentryinthistararchive.Thiswillskipoveranyremainingdatainthecurrent

entry,ifthereisone,andplacetheinputstreamattheheaderofthenextentry,andreadtheheaderandinstantiateanewTarEntryfromtheheaderbytesandreturnthatentry.Iftherearenomoreentriesinthearchive,nullwillbereturnedtoindicatethattheendofthearchivehasbeenreached.

GetRecordSize Gettherecordsizebeingusedbythisstream'sTarBuffer.

Mark Sincewedonotsupportmarkingjustyet,wedonothing.

Read Readsbytesfromthecurrenttararchiveentry.Thismethodisawareoftheboundariesofthecurrententryinthearchiveandwilldealwiththemappropriately

ReadByte Readsabytefromthecurrenttararchiveentry.Thismethodsimplycallsread(byte[],int,int).

Reset Sincewedonotsupportmarkingjustyet,wedonothing.

SetEntryFactory Settheentryfactoryforthis

instance.

SetLength SetsthelengthofthestreamThisoperationisnotsupportedandwillthrowaNotSupportedException

Skip Skipbytesintheinputbuffer.Thisskipsbytesinthecurrententry'sdata,nottheentirearchive,andwillstopattheendofthecurrententry'sdataifthenumbertoskipextendsbeyondthatpoint.

ProtectedInstanceFieldsbuffer Workingbuffer

currEntry Currententrybeingread

eFactory FactoryusedtocreateTarEntryordescendantclassinstance

entryOffset Numberofbytesreadforthisentrysofar

entrySize Sizeofthisentryasrecordedinheader

hasHitEOF Flagsetwhenlastblockhasbeenread

readBuf Bufferusedwithcallsto

Read()

SeeAlsoTarInputStreamClass|ICSharpCode.SharpZipLib.TarNamespace

ConstructaTarInputStreamwithdefaultblockfactor

OverloadListConstructaTarInputStreamwithdefaultblockfactor

publicTarInputStream(Stream);

ConstructaTarInputStreamwithuserspecifiedblockfactor

publicTarInputStream(Stream,int);

TarInputStreamConstructor

ConstructaTarInputStreamwithdefaultblockfactor

publicTarInputStream(

StreaminputStream

streamtosourcedatafrom

SeeAlsoTarInputStreamClass|ICSharpCode.SharpZipLib.TarNamespace|TarInputStreamConstructorOverloadList

TarInputStreamConstructor(Stream)

ConstructaTarInputStreamwithuserspecifiedblockfactor

publicTarInputStream(

StreaminputStream,

intblockFactor

streamtosourcedatafrom

blockFactorblockfactortoapplytoarchive

SeeAlsoTarInputStreamClass|ICSharpCode.SharpZipLib.TarNamespace|TarInputStreamConstructorOverloadList

TarInputStreamConstructor(Stream,Int32)

ThefieldsoftheTarInputStreamclassarelistedbelow.ForacompletelistofTarInputStreamclassmembers,seetheTarInputStreamMemberstopic.

ProtectedInstanceFieldsbuffer Workingbuffer

currEntry Currententrybeingread

eFactory FactoryusedtocreateTarEntryordescendantclassinstance

entryOffset Numberofbytesreadforthisentrysofar

entrySize Sizeofthisentryasrecordedinheader

hasHitEOF Flagsetwhenlastblockhasbeenread

readBuf Bufferusedwithcallsto

Read()

TarInputStreamFields

Workingbuffer

protectedTarBufferbuffer;

TarInputStream.bufferField

Currententrybeingread

protectedTarEntrycurrEntry;

TarInputStream.currEntryField

FactoryusedtocreateTarEntryordescendantclassinstance

protectedIEntryFactoryeFactory;

TarInputStream.eFactoryField

Numberofbytesreadforthisentrysofar

protectedlongentryOffset;

TarInputStream.entryOffsetField

Sizeofthisentryasrecordedinheader

protectedlongentrySize;

TarInputStream.entrySizeField

Flagsetwhenlastblockhasbeenread

protectedboolhasHitEOF;

TarInputStream.hasHitEOFField

Bufferusedwithcallsto

Read()

protectedbyte[]readBuf;

TarInputStream.readBufField

ThepropertiesoftheTarInputStreamclassarelistedbelow.ForacompletelistofTarInputStreamclassmembers,seetheTarInputStreamMemberstopic.

PublicInstancePropertiesAvailable Gettheavailabledatathatcanbereadfrom

thecurrententryinthearchive.Thisdoesnotindicatehowmuchdataisleftintheentirearchive,onlyinthecurrententry.Thisvalueisdeterminedfromtheentry'ssizeheaderfieldandtheamountofdataalreadyreadfromthecurrententry.

CanSeek GetsavalueindicatingwhetherthecurrentstreamsupportsseekingThispropertyalwaysreturnsfalse.

CanWrite Getsavalueindicatingifthestreamsupportswriting.Thispropertyalwaysreturnsfalse.

IsMarkSupportedSincewedonotsupportmarkingjustyet,wereturnfalse.

Length Thelengthinbytesofthestream

Position Getsorsetsthepositionwithinthestream.SettingthePositionisnotsupportedandthrowsaNotSupportedExceptionNotSupportedException

TarInputStreamProperties

Gettheavailabledatathatcanbereadfromthecurrententryinthearchive.Thisdoesnotindicatehowmuchdataisleftintheentirearchive,onlyinthecurrententry.Thisvalueisdeterminedfromtheentry'ssizeheaderfieldandtheamountofdataalreadyreadfromthecurrententry.

publiclongAvailable{get;}

TarInputStream.AvailableProperty

TarInputStream.CanReadProperty

GetsavalueindicatingwhetherthecurrentstreamsupportsseekingThispropertyalwaysreturnsfalse.

TarInputStream.CanSeekProperty

Getsavalueindicatingifthestreamsupportswriting.Thispropertyalwaysreturnsfalse.

TarInputStream.CanWriteProperty

Sincewedonotsupportmarkingjustyet,wereturnfalse.

publicboolIsMarkSupported{get;}

TarInputStream.IsMarkSupportedProperty

Thelengthinbytesofthestream

TarInputStream.LengthProperty

Getsorsetsthepositionwithinthestream.SettingthePositionisnotsupportedandthrowsaNotSupportedExceptionNotSupportedException

ExceptionsExceptionType ConditionNotSupportedException Anyattempttosetposition

TarInputStream.PositionProperty

ThemethodsoftheTarInputStreamclassarelistedbelow.ForacompletelistofTarInputStreamclassmembers,seetheTarInputStreamMemberstopic.

Close Closesthisstream.CallstheTarBuffer'sclose()method.TheunderlyingstreamisclosedbytheTarBuffer.

CopyEntryContents Copiesthecontentsofthecurrenttararchiveentrydirectlyintoanoutputstream.

Servesasahashfunctionforaparticulartype,suitableforuseinhashingalgorithmsanddata

TarInputStreamMethods

structureslikeahashtable.

GetNextEntry Getthenextentryinthistararchive.Thiswillskipoveranyremainingdatainthecurrententry,ifthereisone,andplacetheinputstreamattheheaderofthenextentry,andreadtheheaderandinstantiateanewTarEntryfromtheheaderbytesandreturnthatentry.Iftherearenomoreentriesinthearchive,nullwillbereturnedtoindicatethattheendofthearchivehasbeenreached.

Mark Sincewedonotsupportmarkingjustyet,wedonothing.

Read Readsbytesfromthecurrenttararchiveentry.Thismethodisawareoftheboundariesofthecurrententryinthearchiveandwilldealwiththemappropriately

ReadByte Readsabytefromthecurrenttararchiveentry.Thismethodsimplycallsread(byte[],int,int).

Reset Sincewedonotsupportmarkingjustyet,wedonothing.

SetEntryFactory Settheentryfactoryforthisinstance.

SetLength SetsthelengthofthestreamThisoperationisnotsupportedandwillthrowaNotSupportedException

Skip Skipbytesintheinputbuffer.Thisskipsbytesinthecurrententry'sdata,nottheentirearchive,andwillstopattheendofthecurrententry'sdataifthenumbertoskipextendsbeyondthatpoint.

Closesthisstream.CallstheTarBuffer'sclose()method.TheunderlyingstreamisclosedbytheTarBuffer.

TarInputStream.CloseMethod

Copiesthecontentsofthecurrenttararchiveentrydirectlyintoanoutputstream.

publicvoidCopyEntryContents(

StreamoutputStream

TheOutputStreamintowhichtowritetheentry'sdata.

TarInputStream.CopyEntryContentsMethod

TarInputStream.FlushMethod

Getthenextentryinthistararchive.Thiswillskipoveranyremainingdatainthecurrententry,ifthereisone,andplacetheinputstreamattheheaderofthenextentry,andreadtheheaderandinstantiateanewTarEntryfromtheheaderbytesandreturnthatentry.Iftherearenomoreentriesinthearchive,nullwillbereturnedtoindicatethattheendofthearchivehasbeenreached.

publicTarEntryGetNextEntry();

ReturnValueThenextTarEntryinthearchive,ornull.

TarInputStream.GetNextEntryMethod

Gettherecordsizebeingusedbythisstream'sTarBuffer.

ReturnValueTarBufferrecordsize.

TarInputStream.GetRecordSizeMethod

Sincewedonotsupportmarkingjustyet,wedonothing.

publicvoidMark(

intmarkLimit

ParametersmarkLimit

Thelimittomark.

TarInputStream.MarkMethod

Readsbytesfromthecurrenttararchiveentry.Thismethodisawareoftheboundariesofthecurrententryinthearchiveandwilldealwiththemappropriately

byte[]outputBuffer,

intoffset,

intcount

ParametersoutputBuffer

Thebufferintowhichtoplacebytesread.

offsetTheoffsetatwhichtoplacebytesread.

countThenumberofbytestoread.

ReturnValueThenumberofbytesread,or0atendofstream/EOF.

TarInputStream.ReadMethod

Readsabytefromthecurrenttararchiveentry.Thismethodsimplycallsread(byte[],int,int).

TarInputStream.ReadByteMethod

Sincewedonotsupportmarkingjustyet,wedonothing.

publicvoidReset();

TarInputStream.ResetMethod

Setthestreamsposition.ThisoperationisnotsupportedandwillthrowaNotSupportedException

longoffset,

SeekOriginorigin

TarInputStream.SeekMethod

Settheentryfactoryforthisinstance.

publicvoidSetEntryFactory(

IEntryFactoryfactory

Parametersfactory

Thefactoryforcreatingnewentries

TarInputStream.SetEntryFactoryMethod

SetsthelengthofthestreamThisoperationisnotsupportedandwillthrowaNotSupportedException

longval

TarInputStream.SetLengthMethod

Skipbytesintheinputbuffer.Thisskipsbytesinthecurrententry'sdata,nottheentirearchive,andwillstopattheendofthecurrententry'sdataifthenumbertoskipextendsbeyondthatpoint.

publicvoidSkip(

longnumToSkip

ParametersnumToSkip

Thenumberofbytestoskip.

TarInputStream.SkipMethod

Writesablockofbytestothisstreamusingdatafromabuffer.ThisoperationisnotsupportedandwillthrowaNotSupportedException

byte[]array,

intoffset,

intcount

TarInputStream.WriteMethod

Writesabytetothecurrentpositioninthefilestream.ThisoperationisnotsupportedandwillthrowaNotSupportedException

byteval

TarInputStream.WriteByteMethod

StandardentryfactoryclasscreatinginstancesoftheclassTarEntry

Foralistofallmembersofthistype,seeTarInputStream.EntryFactoryAdapterMembers.

System.ObjectICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter

publicclassTarInputStream.EntryFactoryAdapter

:IEntryFactory

SeeAlsoTarInputStream.EntryFactoryAdapterMembers|ICSharpCode.SharpZipLib.TarNamespace

TarInputStream.EntryFactoryAdapterClass

TarInputStream.EntryFactoryAdapteroverview

PublicInstanceConstructors

TarInputStream.EntryFactoryAdapterConstructor

InitializesanewinstanceoftheTarInputStream.EntryFactoryAdapterclass.

PublicInstanceMethodsCreateEntry Overloaded.Createandentry

basedondetailsinheaderBuf

CreateEntryFromFile CreateatarentrywithdetailsobtainedfromfileName

TarInputStream.EntryFactoryAdapterMembers

SeeAlsoTarInputStream.EntryFactoryAdapterClass|ICSharpCode.SharpZipLib.TarNamespace

InitializesanewinstanceoftheTarInputStream.EntryFactoryAdapterclass.

publicTarInputStream.EntryFactoryAdapter();

TarInputStream.EntryFactoryAdapterConstructor

ThemethodsoftheTarInputStream.EntryFactoryAdapterclassarelistedbelow.ForacompletelistofTarInputStream.EntryFactoryAdapterclassmembers,seetheTarInputStream.EntryFactoryAdapterMemberstopic.

PublicInstanceMethodsCreateEntry Overloaded.Createandentry

basedondetailsinheaderBuf

CreateEntryFromFile CreateatarentrywithdetailsobtainedfromfileName

SeeAlso

TarInputStream.EntryFactoryAdapterMethods

TarInputStream.EntryFactoryAdapterClass|ICSharpCode.SharpZipLib.TarNamespace

CreateandentrybasedondetailsinheaderBuf

OverloadListCreateandentrybasedondetailsinheaderBuf

publicTarEntryCreateEntry(byte[]);

CreateaTarEntrybasedonnamed

publicTarEntryCreateEntry(string);

TarInputStream.EntryFactoryAdapter.CreateEntryMethod

CreateandentrybasedondetailsinheaderBuf

publicTarEntryCreateEntry(

byte[]headerBuf

ImplementsIEntryFactory.CreateEntry

SeeAlsoTarInputStream.EntryFactoryAdapterClass|ICSharpCode.SharpZipLib.TarNamespace|TarInputStream.EntryFactoryAdapter.CreateEntryOverloadList

TarInputStream.EntryFactoryAdapter.CreateEntryMethod(Byte[])

CreateaTarEntrybasedonnamed

publicTarEntryCreateEntry(

stringname

ImplementsIEntryFactory.CreateEntry

SeeAlsoTarInputStream.EntryFactoryAdapterClass|ICSharpCode.SharpZipLib.TarNamespace|TarInputStream.EntryFactoryAdapter.CreateEntryOverloadList

TarInputStream.EntryFactoryAdapter.CreateEntryMethod(String)

CreateatarentrywithdetailsobtainedfromfileName

publicTarEntryCreateEntryFromFile(

stringfileName

ImplementsIEntryFactory.CreateEntryFromFile

TarInputStream.EntryFactoryAdapter.CreateEntryFromFileMethod

Thisinterfaceisprovided,alongwiththemethodsetEntryFactory(),toallowtheprogrammertohavetheirownTarEntrysubclassinstantiatedfortheentriesreturnfromgetNextEntry().

Foralistofallmembersofthistype,seeTarInputStream.IEntryFactoryMembers.

publicinterfaceTarInputStream.IEntryFactory

TypesthatimplementTarInputStream.IEntryFactoryType DescriptionTarInputStream.EntryFactoryAdapter Standardentryfactoryclass

creatinginstancesoftheclassTarEntry

SeeAlsoTarInputStream.IEntryFactoryMembers|ICSharpCode.SharpZipLib.TarNamespace

TarInputStream.IEntryFactoryInterface

TarInputStream.IEntryFactoryoverview

PublicInstanceMethodsCreateEntry Overloaded.Createatarentry

basedontheheaderinformationpassed

CreateEntryFromFile Createaninstancebasedonanactualfile

SeeAlsoTarInputStream.IEntryFactoryInterface|ICSharpCode.SharpZipLib.TarNamespace

TarInputStream.IEntryFactoryMembers

ThemethodsoftheTarInputStream.IEntryFactoryinterfacearelistedbelow.ForacompletelistofTarInputStream.IEntryFactoryinterfacemembers,seetheTarInputStream.IEntryFactoryMemberstopic.

PublicInstanceMethodsCreateEntry Overloaded.Createatarentry

basedontheheaderinformationpassed

CreateEntryFromFile Createaninstancebasedonanactualfile

TarInputStream.IEntryFactoryMethods

Createatarentrybasedontheheaderinformationpassed

OverloadListCreateatarentrybasedontheheaderinformationpassed

TarEntryCreateEntry(byte[]);

Createanentrybasedonnamealone

TarEntryCreateEntry(string);

TarInputStream.IEntryFactory.CreateEntryMethod

Createatarentrybasedontheheaderinformationpassed

TarEntryCreateEntry(

byte[]headerBuf

ParametersheaderBuf

Buffercontainingheaderinformationtobaseentryon

ReturnValueCreatedTarEntryordescendantclass

SeeAlsoTarInputStream.IEntryFactoryInterface|ICSharpCode.SharpZipLib.TarNamespace|TarInputStream.IEntryFactory.CreateEntryOverloadList

TarInputStream.IEntryFactory.CreateEntryMethod(Byte[])

Createanentrybasedonnamealone

TarEntryCreateEntry(

stringname

Parametersname

NameofthenewEntryPointNotFoundExceptiontocreate

ReturnValuecreatedTarEntryordescendantclass

SeeAlsoTarInputStream.IEntryFactoryInterface|ICSharpCode.SharpZipLib.TarNamespace|TarInputStream.IEntryFactory.CreateEntryOverloadList

TarInputStream.IEntryFactory.CreateEntryMethod(String)

Createaninstancebasedonanactualfile

TarEntryCreateEntryFromFile(

stringfileName

ParametersfileName

Nameoffiletorepresentintheentry

ReturnValueCreatedTarEntryordescendantclass

TarInputStream.IEntryFactory.CreateEntryFromFileMethod

TheTarOutputStreamwritesaUNIXtararchiveasanOutputStream.Methodsareprovidedtoputentries,andthenwritetheircontentsbywritingtothisstreamusingwrite().

Foralistofallmembersofthistype,seeTarOutputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.Tar.TarOutputStream

publicclassTarOutputStream:Stream

SeeAlsoTarOutputStreamMembers|ICSharpCode.SharpZipLib.TarNamespace

TarOutputStreamClass

TarOutputStreamoverview

PublicInstanceConstructorsTarOutputStream Overloaded.Initializesanew

instanceoftheTarOutputStreamclass.

PublicInstancePropertiesCanRead trueifthestreamsupports

reading;otherwise,false.

CanSeek trueifthestreamsupportsseeking;otherwise,false.

CanWrite trueifstreamsupportswriting;otherwise,false.

Length lengthofstreaminbytes

Position getsorsetsthepositionwithinthecurrentstream.

Close EndstheTARarchiveandclosestheunderlyingOutputStream.Thismeansthatfinish()iscalledfollowedbycallingtheTarBuffer'sclose().

CloseEntry Closeanentry.ThismethodMUSTbecalledforallfileentriesthatcontaindata.Thereasonisthatwemustbuffer

TarOutputStreamMembers

datawrittentothestreaminordertosatisfythebuffer'sblockbasedwrites.Thus,theremaybedatafragmentsstillbeingassembledthatmustbewrittentotheoutputstreambeforethisentryisclosedandthenextentrywritten.

Finish EndstheTARarchivewithoutclosingtheunderlyingOutputStream.TheresultisthattheEOFrecordofnullsiswritten.

Flush Allbuffereddataiswrittentodestination

PutNextEntry Putanentryontheoutputstream.Thiswritestheentry'sheaderandpositionstheoutputstreamforwritingthecontentsoftheentry.Oncethismethodiscalled,thestreamisreadyforcallstowrite()towritetheentry'scontents.Oncethecontentsarewritten,closeEntry()MUSTbecalledtoensurethatallbuffereddataiscompletelywrittentotheoutputstream.

Read readbytesfromthecurrentstreamandadvancethepositionwithinthestreambythenumberofbytesread.

ReadByte Readabytefromthestreamandadvancethepositionwithinthestreambyonebyteorreturns-1ifattheendofthestream.

Seek setthepositionwithinthecurrentstream

SetLength setthelengthofthecurrentstream

Write Writesbytestothecurrenttararchiveentry.Thismethodisawareofthecurrententryandwillthrowanexceptionifyouattempttowritebytespastthelengthspecifiedforthecurrententry.Themethodisalso(painfully)awareoftherecordbufferingrequiredbyTarBuffer,andmanagesbuffersthatarenotamultipleofrecordsizeinlength,includingassemblingrecordsfromsmallbuffers.

WriteByte Writesabytetothecurrenttararchiveentry.ThismethodsimplycallsWrite(byte[],int,int).

ProtectedInstanceFieldsassemBuf 'Assembly'bufferusedto

assmbledatabeforewriting

assemLen current'Assembly'bufferlength

blockBuf singleblockworkingbuffer

buffer TarBufferusedtoprovidecorrectblockingfactor

currBytes byteswrittenforthisentrysofar

currSize Sizeforthecurrententry

debug flagindicatingdebuggingcodeshouldbeactivatedornot

outputStream thedestinationstreamforthearchivecontents

ProtectedInstanceMethodsCreateWaitHandle(inherited AllocatesaWaitHandleobject.

fromStream)

SeeAlsoTarOutputStreamClass|ICSharpCode.SharpZipLib.TarNamespace

ConstructTarOutputStreamusingdefaultblockfactor

OverloadListConstructTarOutputStreamusingdefaultblockfactor

publicTarOutputStream(Stream);

ConstructTarOutputStreamwithuserspecifiedblockfactor

publicTarOutputStream(Stream,int);

TarOutputStreamConstructor

ConstructTarOutputStreamusingdefaultblockfactor

publicTarOutputStream(

StreamoutputStream

streamtowriteto

SeeAlsoTarOutputStreamClass|ICSharpCode.SharpZipLib.TarNamespace|TarOutputStreamConstructorOverloadList

TarOutputStreamConstructor(Stream)

ConstructTarOutputStreamwithuserspecifiedblockfactor

publicTarOutputStream(

StreamoutputStream,

intblockFactor

streamtowriteto

blockFactorblockingfactor

SeeAlsoTarOutputStreamClass|ICSharpCode.SharpZipLib.TarNamespace|TarOutputStreamConstructorOverloadList

TarOutputStreamConstructor(Stream,Int32)

ThefieldsoftheTarOutputStreamclassarelistedbelow.ForacompletelistofTarOutputStreamclassmembers,seetheTarOutputStreamMemberstopic.

ProtectedInstanceFieldsassemBuf 'Assembly'bufferusedto

assmbledatabeforewriting

assemLen current'Assembly'bufferlength

blockBuf singleblockworkingbuffer

buffer TarBufferusedtoprovidecorrectblockingfactor

currBytes byteswrittenforthisentrysofar

currSize Sizeforthecurrententry

debug flagindicatingdebuggingcodeshouldbeactivatedornot

outputStream thedestinationstreamforthearchivecontents

TarOutputStreamFields

'Assembly'bufferusedtoassmbledatabeforewriting

protectedbyte[]assemBuf;

TarOutputStream.assemBufField

current'Assembly'bufferlength

protectedintassemLen;

TarOutputStream.assemLenField

singleblockworkingbuffer

protectedbyte[]blockBuf;

TarOutputStream.blockBufField

TarBufferusedtoprovidecorrectblockingfactor

protectedTarBufferbuffer;

TarOutputStream.bufferField

byteswrittenforthisentrysofar

protectedlongcurrBytes;

TarOutputStream.currBytesField

Sizeforthecurrententry

protectedlongcurrSize;

TarOutputStream.currSizeField

flagindicatingdebuggingcodeshouldbeactivatedornot

protectedbooldebug;

TarOutputStream.debugField

thedestinationstreamforthearchivecontents

protectedStreamoutputStream;

TarOutputStream.outputStreamField

ThepropertiesoftheTarOutputStreamclassarelistedbelow.ForacompletelistofTarOutputStreamclassmembers,seetheTarOutputStreamMemberstopic.

PublicInstancePropertiesCanRead trueifthestreamsupports

reading;otherwise,false.

CanSeek trueifthestreamsupportsseeking;otherwise,false.

CanWrite trueifstreamsupportswriting;otherwise,false.

Length lengthofstreaminbytes

Position getsorsetsthepositionwithinthecurrentstream.

TarOutputStreamProperties

trueifthestreamsupportsreading;otherwise,false.

TarOutputStream.CanReadProperty

trueifthestreamsupportsseeking;otherwise,false.

TarOutputStream.CanSeekProperty

trueifstreamsupportswriting;otherwise,false.

TarOutputStream.CanWriteProperty

lengthofstreaminbytes

TarOutputStream.LengthProperty

getsorsetsthepositionwithinthecurrentstream.

TarOutputStream.PositionProperty

ThemethodsoftheTarOutputStreamclassarelistedbelow.ForacompletelistofTarOutputStreamclassmembers,seetheTarOutputStreamMemberstopic.

Close EndstheTARarchiveandclosestheunderlyingOutputStream.Thismeansthatfinish()iscalledfollowedbycallingtheTarBuffer'sclose().

CloseEntry Closeanentry.ThismethodMUSTbecalledforallfileentriesthatcontaindata.Thereasonisthatwemustbufferdatawrittentothestreaminordertosatisfythebuffer'sblockbasedwrites.Thus,theremaybedatafragmentsstillbeingassembledthatmustbewrittentotheoutputstreambeforethisentryisclosedandthenextentrywritten.

TarOutputStreamMethods

Finish EndstheTARarchivewithoutclosingtheunderlyingOutputStream.TheresultisthattheEOFrecordofnullsiswritten.

Flush Allbuffereddataiswrittentodestination

PutNextEntry Putanentryontheoutputstream.Thiswritestheentry'sheaderandpositionstheoutputstreamforwritingthecontentsoftheentry.Oncethismethodiscalled,thestreamisreadyforcallstowrite()towritetheentry'scontents.Oncethe

contentsarewritten,closeEntry()MUSTbecalledtoensurethatallbuffereddataiscompletelywrittentotheoutputstream.

Read readbytesfromthecurrentstreamandadvancethepositionwithinthestreambythenumberofbytesread.

ReadByte Readabytefromthestreamandadvancethepositionwithinthestreambyonebyteorreturns-1ifattheendofthestream.

Seek setthepositionwithinthecurrentstream

SetLength setthelengthofthecurrentstream

Write Writesbytestothecurrenttararchiveentry.Thismethodisawareofthecurrententryandwillthrowanexceptionifyouattempttowritebytespastthelengthspecifiedforthecurrententry.Themethodisalso(painfully)awareoftherecordbufferingrequiredbyTarBuffer,andmanagesbuffersthatarenotamultipleofrecordsizeinlength,includingassemblingrecordsfromsmallbuffers.

WriteByte Writesabytetothecurrenttararchiveentry.Thismethod

simplycallsWrite(byte[],int,int).

EndstheTARarchiveandclosestheunderlyingOutputStream.Thismeansthatfinish()iscalledfollowedbycallingtheTarBuffer'sclose().

TarOutputStream.CloseMethod

Closeanentry.ThismethodMUSTbecalledforallfileentriesthatcontaindata.Thereasonisthatwemustbufferdatawrittentothestreaminordertosatisfythebuffer'sblockbasedwrites.Thus,theremaybedatafragmentsstillbeingassembledthatmustbewrittentotheoutputstreambeforethisentryisclosedandthenextentrywritten.

publicvoidCloseEntry();

TarOutputStream.CloseEntryMethod

EndstheTARarchivewithoutclosingtheunderlyingOutputStream.TheresultisthattheEOFrecordofnullsiswritten.

publicvoidFinish();

TarOutputStream.FinishMethod

Allbuffereddataiswrittentodestination

TarOutputStream.FlushMethod

Gettherecordsizebeingusedbythisstream'sTarBuffer.

ReturnValueTheTarBufferrecordsize.

TarOutputStream.GetRecordSizeMethod

Putanentryontheoutputstream.Thiswritestheentry'sheaderandpositionstheoutputstreamforwritingthecontentsoftheentry.Oncethismethodiscalled,thestreamisreadyforcallstowrite()towritetheentry'scontents.Oncethecontentsarewritten,closeEntry()MUSTbecalledtoensurethatallbuffereddataiscompletelywrittentotheoutputstream.

publicvoidPutNextEntry(

TarEntryentry

Parametersentry

TheTarEntrytobewrittentothearchive.

TarOutputStream.PutNextEntryMethod

readbytesfromthecurrentstreamandadvancethepositionwithinthestreambythenumberofbytesread.

byte[]b,

intoff,

intlen

ReturnValueThetotalnumberofbytesread,orzeroifattheendofthestream

TarOutputStream.ReadMethod

Readabytefromthestreamandadvancethepositionwithinthestreambyonebyteorreturns-1ifattheendofthestream.

ReturnValueThebytevalueor-1ifatendofstream

TarOutputStream.ReadByteMethod

setthepositionwithinthecurrentstream

longoffset,

SeekOriginorigin

TarOutputStream.SeekMethod

setthelengthofthecurrentstream

longval

TarOutputStream.SetLengthMethod

Writesbytestothecurrenttararchiveentry.Thismethodisawareofthecurrententryandwillthrowanexceptionifyouattempttowritebytespastthelengthspecifiedforthecurrententry.Themethodisalso(painfully)awareoftherecordbufferingrequiredbyTarBuffer,andmanagesbuffersthatarenotamultipleofrecordsizeinlength,includingassemblingrecordsfromsmallbuffers.

byte[]wBuf,

intwOffset,

intnumToWrite

ParameterswBuf

Thebuffertowritetothearchive.

wOffsetTheoffsetinthebufferfromwhichtogetbytes.

numToWriteThenumberofbytestowrite.

TarOutputStream.WriteMethod

Writesabytetothecurrenttararchiveentry.ThismethodsimplycallsWrite(byte[],int,int).

Parametersb

Thebytetobewritten.

TarOutputStream.WriteByteMethod

Namespacehierarchy

ClassesClass DescriptionFastZip FastZipprovidesfacilitiesfor

creatingandextractingzipfiles.Onlyrelativepathsaresupported.

FastZipEvents FastZipEventssupportsalleventsapplicabletoFastZipoperations.

KeysRequiredEventArgs ArgumentsusedwithKeysRequiredEvent

ZipConstants ThisclasscontainsconstantsusedforZipformatfiles

ZipEntry Thisclassrepresentsanentryinaziparchive.ThiscanbeafileoradirectoryZipFileandZipInputStreamwillgiveyouinstancesofthisclassasinformationaboutthemembersinanarchive.ZipOutputStreamusesaninstanceofthisclasswhencreatinganentryinaZipfile.

Authoroftheoriginaljavaversion:JochenHoenicke

ZipException RepresentserrorsspecifictoZipfilehandling

ZipFile ThisclassrepresentsaZiparchive.Youcanaskforthecontainedentries,orgetan

ICSharpCode.SharpZipLib.ZipNamespace

inputstreamforafileentry.Theentryisautomaticallydecompressed.Thisclassisthreadsafe:Youcanopeninputstreamsforarbitraryentriesindifferentthreads.

ZipInputStream ThisisanInflaterInputStreamthatreadsthefilesbaseInputStreamanziparchiveoneafteranother.Ithasaspecialmethodtogetthezipentryofthenextfile.Thezipentrycontainsinformationaboutthefilenamesize,compressedsize,Crc,etc.ItincludessupportforStoredandDeflatedentries.

ZipNameTransform ZipNameTransformtransformsnameaspertheZipfileconvention.

ZipOutputStream ThisisaDeflaterOutputStreamthatwritesthefilesintoaziparchiveoneafteranother.Ithasaspecialmethodtostartanewzipentry.Thezipentriescontainsinformationaboutthefilenamesize,compressedsize,CRC,etc.ItincludessupportforStoredandDeflatedentries.Thisclassisnotthreadsafe.

DelegatesDelegate DescriptionFastZip.ConfirmOverwriteDelegate Delegatecalledwhen

confirmingoverwritingoffiles.

ZipFile.KeysRequiredEventHandler Delegateforhandlingkeys/passwordsettingduringcompresion/decompression.

EnumerationsEnumeration DescriptionCompressionMethod Thekindofcompressionused

foranentryinanarchive

FastZip.Overwrite Definesthedesiredhandlingwhenoverwritingfiles.

Thekindofcompressionusedforanentryinanarchive

publicenumCompressionMethod

MembersMemberName DescriptionStored Adirectcopyofthefilecontents

isheldinthearchive

Deflated CommonZipcompressionmethodusingaslidingdictionaryofupto32KBandsecondarycompressionfromHuffman/Shannon-Fanotrees

Deflate64 Anextensiontodeflatewitha64KBwindow.Notsupportedby#Zip

BZip2 Notsupportedby#Zip

WinZipAES WinZipspecialforAESencryption,Notsupportedby#Zip

RequirementsNamespace:ICSharpCode.SharpZipLib.ZipAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoICSharpCode.SharpZipLib.ZipNamespace

CompressionMethodEnumeration

FastZipprovidesfacilitiesforcreatingandextractingzipfiles.Onlyrelativepathsaresupported.

Foralistofallmembersofthistype,seeFastZipMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.FastZip

publicclassFastZip

SeeAlsoFastZipMembers|ICSharpCode.SharpZipLib.ZipNamespace

FastZipClass

FastZipoverview

PublicInstanceConstructorsFastZip Overloaded.Initializesanew

instanceoftheFastZipclass.

PublicInstancePropertiesCreateEmptyDirectories Get/setavalueindicating

wetheremptydirectoriesshouldbecreated.

NameTransform GetorsettheactivewhencreatingZipfiles.

PublicInstanceMethodsCreateZip Overloaded.Createazipfile.

ExtractZip Overloaded.Extractthecontentsofazipfile.

ProtectedInstanceMethodsFinalize(inheritedfrom AllowsanObjecttoattemptto

FastZipMembers

Object) freeresourcesandperformothercleanupoperationsbeforetheObjectisreclaimedbygarbagecollection.

SeeAlsoFastZipClass|ICSharpCode.SharpZipLib.ZipNamespace

InitializeadefaultinstanceofFastZip.

OverloadListInitializeadefaultinstanceofFastZip.

publicFastZip();

InitialiseanewinstanceofFastZip

publicFastZip(FastZipEvents);

FastZipConstructor

InitializeadefaultinstanceofFastZip.

publicFastZip();

SeeAlsoFastZipClass|ICSharpCode.SharpZipLib.ZipNamespace|FastZipConstructorOverloadList

FastZipConstructor()

InitialiseanewinstanceofFastZip

publicFastZip(

FastZipEventsevents

Parametersevents

SeeAlsoFastZipClass|ICSharpCode.SharpZipLib.ZipNamespace|FastZipConstructorOverloadList

FastZipConstructor(FastZipEvents)

ThepropertiesoftheFastZipclassarelistedbelow.ForacompletelistofFastZipclassmembers,seetheFastZipMemberstopic.

PublicInstancePropertiesCreateEmptyDirectories Get/setavalueindicating

wetheremptydirectoriesshouldbecreated.

NameTransform GetorsettheactivewhencreatingZipfiles.

FastZipProperties

Get/setavalueindicatingwetheremptydirectoriesshouldbecreated.

publicboolCreateEmptyDirectories{get;set;}

FastZip.CreateEmptyDirectoriesProperty

GetorsettheactivewhencreatingZipfiles.

publicZipNameTransformNameTransform{get;set;}

FastZip.NameTransformProperty

ThemethodsoftheFastZipclassarelistedbelow.ForacompletelistofFastZipclassmembers,seetheFastZipMemberstopic.

PublicInstanceMethodsCreateZip Overloaded.Createazipfile.

ExtractZip Overloaded.Extractthecontentsofazipfile.

FastZipMethods

Createazipfile/archive.

OverloadListCreateazipfile/archive.

publicvoidCreateZip(string,string,bool,string);

Createazipfile.

publicvoidCreateZip(string,string,bool,string,string);

FastZip.CreateZipMethod

Createazipfile/archive.

publicvoidCreateZip(

stringzipFileName,

stringsourceDirectory,

boolrecurse,

stringfileFilter

ParameterszipFileName

Thenameofthezipfiletocreate.

sourceDirectoryThedirectorytoobtainfilesanddirectoriesfrom.

recurseTruetorecursedirectories,falsefornorecursion.

fileFilterThefilefiltertoapply.

SeeAlsoFastZipClass|ICSharpCode.SharpZipLib.ZipNamespace|FastZip.CreateZipOverloadList

FastZip.CreateZipMethod(String,String,Boolean,String)

Createazipfile.

publicvoidCreateZip(

stringzipFileName,

stringsourceDirectory,

boolrecurse,

stringfileFilter,

Thenameofthezipfiletocreate.

sourceDirectoryThedirectorytosourcefilesfrom.

recurseTruetorecursedirectories,falsefornorecursion.

fileFilterThefilefiltertoapply.

directoryFilterThedirectoryfiltertoapply.

SeeAlsoFastZipClass|ICSharpCode.SharpZipLib.ZipNamespace|FastZip.CreateZipOverloadList

FastZip.CreateZipMethod(String,String,Boolean,String,String)

Exatractthecontentsofazipfile.

OverloadListExatractthecontentsofazipfile.

publicvoidExtractZip(string,string,Overwrite,ConfirmOverwriteDelegate,string,string);

Extractthecontentsofazipfile.

publicvoidExtractZip(string,string,string);

FastZip.ExtractZipMethod

Exatractthecontentsofazipfile.

publicvoidExtractZip(

stringzipFileName,

stringtargetDirectory,

Overwriteoverwrite,

ConfirmOverwriteDelegateconfirmDelegate,

stringfileFilter,

Thezipfiletoextractfrom.

targetDirectoryThedirectorytosaveextractedinformationin.

overwriteThestyleofoverwritingtoapply.

confirmDelegateAdelegatetoinvokewhenconfirmingoverwriting.

fileFilterAfiltertoapplytofiles.

directoryFilterAfiltertoapplytodirectories.

SeeAlsoFastZipClass|ICSharpCode.SharpZipLib.ZipNamespace|FastZip.ExtractZipOverloadList

FastZip.ExtractZipMethod(String,String,Overwrite,ConfirmOverwriteDelegate,String,String)

Extractthecontentsofazipfile.

publicvoidExtractZip(

stringzipFileName,

stringtargetDirectory,

stringfileFilter

Thezipfiletoextractfrom.

targetDirectoryThedirectorytosaveextractedinformationin.

fileFilterAfiltertoapplytofiles.

SeeAlsoFastZipClass|ICSharpCode.SharpZipLib.ZipNamespace|FastZip.ExtractZipOverloadList

FastZip.ExtractZipMethod(String,String,String)

Delegatecalledwhenconfirmingoverwritingoffiles.

publicdelegateboolFastZip.ConfirmOverwriteDelegate(

stringfileName

FastZip.ConfirmOverwriteDelegateDelegate

Definesthedesiredhandlingwhenoverwritingfiles.

publicenumFastZip.Overwrite

MembersMemberName DescriptionPrompt Prompttheusertoconfirm

overwriting

Never Neveroverwritefiles.

Always Alwaysoverwritefiles.

FastZip.OverwriteEnumeration

FastZipEventssupportsalleventsapplicabletoFastZipoperations.

Foralistofallmembersofthistype,seeFastZipEventsMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.FastZipEvents

publicclassFastZipEvents

SeeAlsoFastZipEventsMembers|ICSharpCode.SharpZipLib.ZipNamespace

FastZipEventsClass

FastZipEventsoverview

PublicInstanceConstructorsFastZipEventsConstructor Initializesanewinstanceofthe

FastZipEventsclass.

PublicInstanceFieldsDirectoryFailure Delegatetoinvokewhen

processingdirectoryfailures.

FileFailure Delegatetoinvokewhenprocessingfilefailures.

ProcessDirectory Delegatetoinvokewhenprocessingdirectories.

ProcessFile Delegatetoinvokewhenprocessingfiles.

OnDirectoryFailure Raisethedirectoryfailureevent.

OnFileFailure Raisesthefilefailureevent.

OnProcessDirectory RaisestheProcessDirectoryEvent.

OnProcessFile RaisestheProcessFileEvent.

FastZipEventsMembers

SeeAlsoFastZipEventsClass|ICSharpCode.SharpZipLib.ZipNamespace

InitializesanewinstanceoftheFastZipEventsclass.

publicFastZipEvents();

FastZipEventsConstructor

ThefieldsoftheFastZipEventsclassarelistedbelow.ForacompletelistofFastZipEventsclassmembers,seetheFastZipEventsMemberstopic.

PublicInstanceFieldsDirectoryFailure Delegatetoinvokewhen

processingdirectoryfailures.

FileFailure Delegatetoinvokewhenprocessingfilefailures.

ProcessDirectory Delegatetoinvokewhenprocessingdirectories.

ProcessFile Delegatetoinvokewhenprocessingfiles.

FastZipEventsFields

Delegatetoinvokewhenprocessingdirectoryfailures.

publicDirectoryFailureDelegateDirectoryFailure;

FastZipEvents.DirectoryFailureField

Delegatetoinvokewhenprocessingfilefailures.

publicFileFailureDelegateFileFailure;

FastZipEvents.FileFailureField

Delegatetoinvokewhenprocessingdirectories.

publicProcessDirectoryDelegateProcessDirectory;

FastZipEvents.ProcessDirectoryField

Delegatetoinvokewhenprocessingfiles.

publicProcessFileDelegateProcessFile;

FastZipEvents.ProcessFileField

ThemethodsoftheFastZipEventsclassarelistedbelow.ForacompletelistofFastZipEventsclassmembers,seetheFastZipEventsMemberstopic.

OnDirectoryFailure Raisethedirectoryfailureevent.

OnFileFailure Raisesthefilefailureevent.

OnProcessDirectory RaisestheProcessDirectoryEvent.

OnProcessFile RaisestheProcessFileEvent.

SeeAlso

FastZipEventsMethods

FastZipEventsClass|ICSharpCode.SharpZipLib.ZipNamespace

Raisethedirectoryfailureevent.

publicvoidOnDirectoryFailure(

stringdirectory,

Exceptione

Parametersdirectory

Thedirectory.

eTheexceptionforthisevent.

FastZipEvents.OnDirectoryFailureMethod

Raisesthefilefailureevent.

publicvoidOnFileFailure(

stringfile,

Exceptione

Parametersfile

Thefileforthisevent.

eTheexceptionforthisevent.

FastZipEvents.OnFileFailureMethod

RaisestheProcessDirectoryEvent.

publicvoidOnProcessDirectory(

stringdirectory,

Parametersdirectory

Thedirectoryforthisevent.

hasMatchingFilesFlagindicatingifdirectoryhasmatchingfilesasdeterminedbythecurrentfilter.

FastZipEvents.OnProcessDirectoryMethod

RaisestheProcessFileEvent.

publicvoidOnProcessFile(

stringfile

Parametersfile

Thefileforthisevent.

FastZipEvents.OnProcessFileMethod

ArgumentsusedwithKeysRequiredEvent

Foralistofallmembersofthistype,seeKeysRequiredEventArgsMembers.

System.ObjectSystem.EventArgsICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs

publicclassKeysRequiredEventArgs:

EventArgs

SeeAlsoKeysRequiredEventArgsMembers|ICSharpCode.SharpZipLib.ZipNamespace

KeysRequiredEventArgsClass

KeysRequiredEventArgsoverview

PublicInstanceConstructorsKeysRequiredEventArgs Overloaded.Initializesanew

instanceoftheKeysRequiredEventArgsclass.

PublicInstancePropertiesFileName Getthenameofthefilefor

whichkeysarerequired.

Key Get/setthekeyvalue

KeysRequiredEventArgsMembers

SeeAlsoKeysRequiredEventArgsClass|ICSharpCode.SharpZipLib.ZipNamespace

InitialiseanewinstanceofKeysRequiredEventArgs

OverloadListInitialiseanewinstanceofKeysRequiredEventArgs

publicKeysRequiredEventArgs(string);

publicKeysRequiredEventArgs(string,byte[]);

KeysRequiredEventArgsConstructor

publicKeysRequiredEventArgs(

stringname

Parametersname

Thenameofthefileforwhichkeysarerequired.

SeeAlsoKeysRequiredEventArgsClass|ICSharpCode.SharpZipLib.ZipNamespace|KeysRequiredEventArgsConstructorOverloadList

KeysRequiredEventArgsConstructor(String)

publicKeysRequiredEventArgs(

stringname,

byte[]keyValue

Parametersname

Thenameofthefileforwhichkeysarerequired.

keyValueThecurrentkeyvalue.

SeeAlsoKeysRequiredEventArgsClass|ICSharpCode.SharpZipLib.ZipNamespace|KeysRequiredEventArgsConstructorOverloadList

KeysRequiredEventArgsConstructor(String,Byte[])

ThepropertiesoftheKeysRequiredEventArgsclassarelistedbelow.ForacompletelistofKeysRequiredEventArgsclassmembers,seetheKeysRequiredEventArgsMemberstopic.

PublicInstancePropertiesFileName Getthenameofthefilefor

whichkeysarerequired.

Key Get/setthekeyvalue

KeysRequiredEventArgsProperties

Getthenameofthefileforwhichkeysarerequired.

publicstringFileName{get;}

KeysRequiredEventArgs.FileNameProperty

Get/setthekeyvalue

publicbyte[]Key{get;set;}

KeysRequiredEventArgs.KeyProperty

ThisclasscontainsconstantsusedforZipformatfiles

Foralistofallmembersofthistype,seeZipConstantsMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.ZipConstants

publicsealedclassZipConstants

SeeAlsoZipConstantsMembers|ICSharpCode.SharpZipLib.ZipNamespace

ZipConstantsClass

ZipConstantsoverview

PublicStaticFieldsCENATT Offsetofinternalfile

attributesincentralfileheader

CENATX Offsetofexternalfileattributesincentralfileheader

CENCOM Offsetoffilecommentlengthincentralfileheader

CENCRC Offsetofcrc-32incentralfileheader

CENDIGITALSIG Centralheaderdigitialsignature

CENDSK Offsetofdiskstartnumberincentralfileheader

CENEXT Offsetofextrafieldlengthincentralfileheader

CENFLG Offsetofgeneralpurposebitflagincentralfileheader

CENHDR Sizeofcentralheaderentry

CENHOW Offsetofcompressionmethodincentralfileheader

CENLEN Offsetofuncompressedsizeincentralfileheader

CENNAM Offsetoffilenamelengthincentralfileheader

CENOFF Offsetofrelativeoffsetof

ZipConstantsMembers

localheaderincentralfileheader

CENSIG Signatureforcentralheader

CENSIG64 SignatureforZip64centralfileheader

CENSIZ Offsetofcompressedsizeincentralfileheader

CENTIM Offsetoftime/dateincentralfileheader

CENVEM Offsetofversionmadebyincentralfileheader

CENVER Offsetofversionneededtoextractincentralfileheader

CRYPTO_HEADER_SIZE Sizeofcryptographicheaderstoredbeforeentrydata

ENDCOM OffsetofZIPfilecommentlength

ENDDCD Offsetofnumberofdiskwithstartofcentraldirectory

ENDHDR Sizeofendofcentralrecord(excludingvariablefields)

ENDNRD Offsetofnumberofthisdisk

ENDOFF Offsetofoffsetofstartofcentraldirectorywithrespecttostartingdisknumber

ENDSIG Endofcentraldirectory

recordsignature

ENDSIZ Offsetofsizeofcentraldirectory

ENDSUB Offsetofnumberofentriesinthecentraldirectoryofthisdisk

ENDTOT Offsetoftotalnumberofentriesinthecentraldirectory

EXTCRC Offsetofcrc-32indatadescriptor

EXTHDR Sizeofdatadescriptor

EXTLEN Offsetofuncompressedlengthindatadescriptor

EXTSIG Signaturefordatadescriptor

EXTSIZ Offsetofcompressedsizeindatadescriptor

LOCCRC Offsetofcrc-32inlocalentryheader

LOCEXT Offsetofextrafieldlengthinlocalentryheader

LOCFLG Offsetofgeneralpurposeflagsinlocalentryheader

LOCHDR Sizeoflocalentryheader(excludingvariablelengthfieldsatend)

LOCHOW Offsetofcompressionmethodinlocalentryheader

LOCLEN Offsetofuncompressedsizeinlocalentryheader

LOCNAM Offsetoffilenamelengthinlocalentryheader

LOCSIG Signatureforlocalentryheader

LOCSIZ Offsetofcompressedsizeinlocalentryheader

LOCTIM Offsetoflastmodfiletime+dateinlocalentryheader

LOCVER Offsetofversiontoextractinlocalentryheader

SPANNINGSIG Signatureforspanningentry

SPANTEMPSIG Signaturefortemporaryspanningentry

VERSION_MADE_BY Theversionmadebyfieldforentriesinthecentralheaderwhencreatedbythislibrary

VERSION_STRONG_ENCRYPTIONTheminimumversionrequiredtosupportstrongencryption

PublicStaticPropertiesDefaultCodePage Defaultencodingusedforstring

conversion.0givesthedefaultsystemAnsicodepage.DontuseunicodeencodingsifyouwanttobeZipcompatible!Usingthedefaultcodepageisntthefullsolutionneccessarilytherearemanyvariablefactors,codepage850isoftenagoodchoiceforEuropeanusers,howeverbecarefulabout

compatability.

PublicStaticMethodsConvertToArray Convertastringtoabytearray

ConvertToString Overloaded.Convertaportionofabytearraytoastring.

PublicInstanceConstructorsZipConstantsConstructor Initializesanewinstanceofthe

ZipConstantsclass.

SeeAlsoZipConstantsClass|ICSharpCode.SharpZipLib.ZipNamespace

InitializesanewinstanceoftheZipConstantsclass.

publicZipConstants();

ZipConstantsConstructor

ThefieldsoftheZipConstantsclassarelistedbelow.ForacompletelistofZipConstantsclassmembers,seetheZipConstantsMemberstopic.

PublicStaticFieldsCENATT Offsetofinternalfile

attributesincentralfileheader

CENATX Offsetofexternalfileattributesincentralfileheader

CENCOM Offsetoffilecommentlengthincentralfileheader

CENCRC Offsetofcrc-32incentralfileheader

CENDIGITALSIG Centralheaderdigitialsignature

CENDSK Offsetofdiskstartnumberincentralfileheader

CENEXT Offsetofextrafieldlengthincentralfileheader

CENFLG Offsetofgeneralpurposebitflagincentralfileheader

CENHDR Sizeofcentralheaderentry

CENHOW Offsetofcompressionmethodincentralfileheader

CENLEN Offsetofuncompressedsizeincentralfileheader

CENNAM Offsetoffilenamelengthincentralfileheader

ZipConstantsFields

CENOFF Offsetofrelativeoffsetoflocalheaderincentralfileheader

CENSIG Signatureforcentralheader

CENSIG64 SignatureforZip64centralfileheader

CENSIZ Offsetofcompressedsizeincentralfileheader

CENTIM Offsetoftime/dateincentralfileheader

CENVEM Offsetofversionmadebyincentralfileheader

CENVER Offsetofversionneededtoextractincentralfileheader

CRYPTO_HEADER_SIZE Sizeofcryptographicheaderstoredbeforeentrydata

ENDCOM OffsetofZIPfilecommentlength

ENDDCD Offsetofnumberofdiskwithstartofcentraldirectory

ENDHDR Sizeofendofcentralrecord(excludingvariablefields)

ENDNRD Offsetofnumberofthisdisk

ENDOFF Offsetofoffsetofstartofcentraldirectorywithrespecttostartingdisknumber

ENDSIG Endofcentraldirectoryrecordsignature

ENDSIZ Offsetofsizeofcentraldirectory

ENDSUB Offsetofnumberofentriesinthecentraldirectoryofthisdisk

ENDTOT Offsetoftotalnumberofentriesinthecentraldirectory

EXTCRC Offsetofcrc-32indatadescriptor

EXTHDR Sizeofdatadescriptor

EXTLEN Offsetofuncompressedlengthindatadescriptor

EXTSIG Signaturefordatadescriptor

EXTSIZ Offsetofcompressedsizeindatadescriptor

LOCCRC Offsetofcrc-32inlocalentryheader

LOCEXT Offsetofextrafieldlengthinlocalentryheader

LOCFLG Offsetofgeneralpurposeflagsinlocalentryheader

LOCHDR Sizeoflocalentryheader(excludingvariablelengthfieldsatend)

LOCHOW Offsetofcompressionmethodinlocalentryheader

LOCLEN Offsetofuncompressed

sizeinlocalentryheader

LOCNAM Offsetoffilenamelengthinlocalentryheader

LOCSIG Signatureforlocalentryheader

LOCSIZ Offsetofcompressedsizeinlocalentryheader

LOCTIM Offsetoflastmodfiletime+dateinlocalentryheader

LOCVER Offsetofversiontoextractinlocalentryheader

SPANNINGSIG Signatureforspanningentry

SPANTEMPSIG Signaturefortemporaryspanningentry

VERSION_MADE_BY Theversionmadebyfieldforentriesinthecentralheaderwhencreatedbythislibrary

VERSION_STRONG_ENCRYPTIONTheminimumversionrequiredtosupportstrongencryption

Offsetofinternalfileattributesincentralfileheader

publicconstintCENATT=36;

ZipConstants.CENATTField

Offsetofexternalfileattributesincentralfileheader

publicconstintCENATX=38;

ZipConstants.CENATXField

Offsetoffilecommentlengthincentralfileheader

publicconstintCENCOM=32;

ZipConstants.CENCOMField

Offsetofcrc-32incentralfileheader

publicconstintCENCRC=16;

ZipConstants.CENCRCField

Centralheaderdigitialsignature

publicconstintCENDIGITALSIG=84233040;

ZipConstants.CENDIGITALSIGField

Offsetofdiskstartnumberincentralfileheader

publicconstintCENDSK=34;

ZipConstants.CENDSKField

Offsetofextrafieldlengthincentralfileheader

publicconstintCENEXT=30;

ZipConstants.CENEXTField

Offsetofgeneralpurposebitflagincentralfileheader

publicconstintCENFLG=8;

ZipConstants.CENFLGField

Sizeofcentralheaderentry

publicconstintCENHDR=46;

ZipConstants.CENHDRField

Offsetofcompressionmethodincentralfileheader

publicconstintCENHOW=10;

ZipConstants.CENHOWField

Offsetofuncompressedsizeincentralfileheader

publicconstintCENLEN=24;

ZipConstants.CENLENField

Offsetoffilenamelengthincentralfileheader

publicconstintCENNAM=28;

ZipConstants.CENNAMField

Offsetofrelativeoffsetoflocalheaderincentralfileheader

publicconstintCENOFF=42;

ZipConstants.CENOFFField

Signatureforcentralheader

publicconstintCENSIG=33639248;

ZipConstants.CENSIGField

SignatureforZip64centralfileheader

publicconstintCENSIG64=101075792;

ZipConstants.CENSIG64Field

Offsetofcompressedsizeincentralfileheader

publicconstintCENSIZ=20;

ZipConstants.CENSIZField

Offsetoftime/dateincentralfileheader

publicconstintCENTIM=12;

ZipConstants.CENTIMField

Offsetofversionmadebyincentralfileheader

publicconstintCENVEM=4;

ZipConstants.CENVEMField

Offsetofversionneededtoextractincentralfileheader

publicconstintCENVER=6;

ZipConstants.CENVERField

Sizeofcryptographicheaderstoredbeforeentrydata

publicconstintCRYPTO_HEADER_SIZE=12;

ZipConstants.CRYPTO_HEADER_SIZEField

OffsetofZIPfilecommentlength

publicconstintENDCOM=20;

ZipConstants.ENDCOMField

Offsetofnumberofdiskwithstartofcentraldirectory

publicconstintENDDCD=6;

ZipConstants.ENDDCDField

Sizeofendofcentralrecord(excludingvariablefields)

publicconstintENDHDR=22;

ZipConstants.ENDHDRField

Offsetofnumberofthisdisk

publicconstintENDNRD=4;

ZipConstants.ENDNRDField

Offsetofoffsetofstartofcentraldirectorywithrespecttostartingdisknumber

publicconstintENDOFF=16;

ZipConstants.ENDOFFField

Endofcentraldirectoryrecordsignature

publicconstintENDSIG=101010256;

ZipConstants.ENDSIGField

Offsetofsizeofcentraldirectory

publicconstintENDSIZ=12;

ZipConstants.ENDSIZField

Offsetofnumberofentriesinthecentraldirectoryofthisdisk

publicconstintENDSUB=8;

ZipConstants.ENDSUBField

Offsetoftotalnumberofentriesinthecentraldirectory

publicconstintENDTOT=10;

ZipConstants.ENDTOTField

Offsetofcrc-32indatadescriptor

publicconstintEXTCRC=4;

ZipConstants.EXTCRCField

Sizeofdatadescriptor

publicconstintEXTHDR=16;

ZipConstants.EXTHDRField

Offsetofuncompressedlengthindatadescriptor

publicconstintEXTLEN=12;

ZipConstants.EXTLENField

Signaturefordatadescriptor

publicconstintEXTSIG=134695760;

RemarksThisisonlyusedwherethelength,Crc,orcompressedsizeisntknownwhentheentryiscreatedandtheoutputstreamdoesntsupportseeking.Thelocalentrycannotbe'patched'withthecorrectvaluesinthiscasesothevaluesarerecordedafterthedataprefixedbythisheader,aswellasinthecentraldirectory.

ZipConstants.EXTSIGField

Offsetofcompressedsizeindatadescriptor

publicconstintEXTSIZ=8;

ZipConstants.EXTSIZField

Offsetofcrc-32inlocalentryheader

publicconstintLOCCRC=14;

ZipConstants.LOCCRCField

Offsetofextrafieldlengthinlocalentryheader

publicconstintLOCEXT=28;

ZipConstants.LOCEXTField

Offsetofgeneralpurposeflagsinlocalentryheader

publicconstintLOCFLG=6;

ZipConstants.LOCFLGField

Sizeoflocalentryheader(excludingvariablelengthfieldsatend)

publicconstintLOCHDR=30;

ZipConstants.LOCHDRField

Offsetofcompressionmethodinlocalentryheader

publicconstintLOCHOW=8;

ZipConstants.LOCHOWField

Offsetofuncompressedsizeinlocalentryheader

publicconstintLOCLEN=22;

ZipConstants.LOCLENField

Offsetoffilenamelengthinlocalentryheader

publicconstintLOCNAM=26;

ZipConstants.LOCNAMField

Signatureforlocalentryheader

publicconstintLOCSIG=67324752;

ZipConstants.LOCSIGField

Offsetofcompressedsizeinlocalentryheader

publicconstintLOCSIZ=18;

ZipConstants.LOCSIZField

Offsetoflastmodfiletime+dateinlocalentryheader

publicconstintLOCTIM=10;

ZipConstants.LOCTIMField

Offsetofversiontoextractinlocalentryheader

publicconstintLOCVER=4;

ZipConstants.LOCVERField

Signatureforspanningentry

publicconstintSPANNINGSIG=134695760;

ZipConstants.SPANNINGSIGField

Signaturefortemporaryspanningentry

publicconstintSPANTEMPSIG=808471376;

ZipConstants.SPANTEMPSIGField

Theversionmadebyfieldforentriesinthecentralheaderwhencreatedbythislibrary

publicconstintVERSION_MADE_BY=20;

RemarksThisisalsotheZipversionforthelibrarywhencomparingagainsttheversionrequiredtoextractforanentry.SeeZipInputStream.CanDecompressEntry.

ZipConstants.VERSION_MADE_BYField

Theminimumversionrequiredtosupportstrongencryption

publicconstintVERSION_STRONG_ENCRYPTION

ZipConstants.VERSION_STRONG_ENCRYPTIONField

ThepropertiesoftheZipConstantsclassarelistedbelow.ForacompletelistofZipConstantsclassmembers,seetheZipConstantsMemberstopic.

PublicStaticPropertiesDefaultCodePage Defaultencodingusedforstring

conversion.0givesthedefaultsystemAnsicodepage.DontuseunicodeencodingsifyouwanttobeZipcompatible!Usingthedefaultcodepageisntthefullsolutionneccessarilytherearemanyvariablefactors,codepage850isoftenagoodchoiceforEuropeanusers,howeverbecarefulaboutcompatability.

ZipConstantsProperties

Defaultencodingusedforstringconversion.0givesthedefaultsystemAnsicodepage.DontuseunicodeencodingsifyouwanttobeZipcompatible!Usingthedefaultcodepageisntthefullsolutionneccessarilytherearemanyvariablefactors,codepage850isoftenagoodchoiceforEuropeanusers,howeverbecarefulaboutcompatability.

publicstaticintDefaultCodePage{get;set;}

ZipConstants.DefaultCodePageProperty

ThemethodsoftheZipConstantsclassarelistedbelow.ForacompletelistofZipConstantsclassmembers,seetheZipConstantsMemberstopic.

PublicStaticMethodsConvertToArray Convertastringtoabytearray

ConvertToString Overloaded.Convertaportionofabytearraytoastring.

ZipConstantsMethods

Convertastringtoabytearray

publicstaticbyte[]ConvertToArray(

stringstr

Parametersstr

Stringtoconverttoanarray

ReturnValueConvertedarray

ZipConstants.ConvertToArrayMethod

Convertbytearraytostring

OverloadListConvertbytearraytostring

publicstaticstringConvertToString(byte[]);

Convertaportionofabytearraytoastring.

publicstaticstringConvertToString(byte[],int);

ZipConstants.ConvertToStringMethod

Convertbytearraytostring

publicstaticstringConvertToString(

byte[]data

Parametersdata

Bytearraytoconvert

ReturnValuedataconvertedtoastring

SeeAlsoZipConstantsClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipConstants.ConvertToStringOverloadList

ZipConstants.ConvertToStringMethod(Byte[])

Convertaportionofabytearraytoastring.

publicstaticstringConvertToString(

byte[]data,

intlength

Parametersdata

Datatoconverttostring

lengthNumberofbytestoconvertstartingfromindex0

ReturnValuedata[0]..data[length-1]convertedtoastring

SeeAlsoZipConstantsClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipConstants.ConvertToStringOverloadList

ZipConstants.ConvertToStringMethod(Byte[],Int32)

Thisclassrepresentsanentryinaziparchive.ThiscanbeafileoradirectoryZipFileandZipInputStreamwillgiveyouinstancesofthisclassasinformationaboutthemembersinanarchive.ZipOutputStreamusesaninstanceofthisclasswhencreatinganentryinaZipfile.

Foralistofallmembersofthistype,seeZipEntryMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.ZipEntry

publicclassZipEntry:ICloneable

SeeAlsoZipEntryMembers|ICSharpCode.SharpZipLib.ZipNamespace

ZipEntryClass

ZipEntryoverview

PublicStaticMethodsCleanName Overloaded.Cleansaname

makingitconformtoZipfileconventions.Devicesnames('c:\')andUNCsharenames('\\server\share')areremovedandforwardslashes('\')areconvertedtobackslashes('/').

PublicInstanceConstructorsZipEntry Overloaded.Initializesanew

instanceoftheZipEntryclass.

PublicInstancePropertiesComment Gets/Setstheentrycomment.

CompressedSize Gets/Setsthesizeofthecompresseddata.

CompressionMethod Gets/Setsthecompressionmethod.OnlyDeflatedandStoredaresupported.

Crc Gets/Setsthecrcoftheuncompresseddata.

DateTime Gets/Setsthetimeoflastmodificationoftheentry.

DosTime Get/SetDosTime

ExternalFileAttributes Get/Setexternalfileattributesasaninteger.ThevaluesofthisareoperatingsystemdependantseeHostSystemfordetails

ExtraData Gets/Setstheextradata.

ZipEntryMembers

Flags Get/Setgeneralpurposebitflagforentry

HostSystem GetsthecompatabilityinformationfortheexternalfileattributeIftheexternalfileattributesarecompatiblewithMS-DOSandcanbereadbyPKZIPforDOSversion2.04gthenthisvaluewillbezero.Otherwisethevaluewillbenon-zeroandidentifythehostsystemonwhichtheattributesarecompatible.

IsCrypted Get/Setflagindicatingifentryisencrypted.Asimplehelperroutinetoaidinterpretationofflags

IsDirectory Getsavalueindicatingoftheiftheentryisadirectory.Adirectoryisdeterminedbyanentrynamewithatrailingslash'/'.Theexternalfileattributescanalsomarkafileasadirectory.Thetrailingslashconventionshouldalwaysbefollowedhowever.

IsFile Getavalueoftrueiftheentryappearstobeafile;falseotherwise

Name Returnstheentryname.Thepathcomponentsintheentryshouldalwaysseparatedbyslashes('/').DosdevicenameslikeC:shouldalsoberemoved.SeeCleanName.

Offset Get/setoffsetforuseincentralheader

RequiresZip64 GetsavalueindicatingiftheentryrequiresZip64extensionstobestored

Size Gets/Setsthesizeoftheuncompresseddata.

Version GetminimumZipfeatureversionrequiredtoextractthisentry

VersionMadeBy Gettheversionmadebyforthisentryorzeroifunknown.Thevalue/10indicatesthemajorversionnumber,andthevaluemod10istheminorversionnumber

ZipFileIndex Get/SetindexofthisentryinZipfile

PublicInstanceMethodsClone Createsacopyofthiszipentry.

ToString GetsthestringrepresentationofthisZipEntry.

ProtectedInstanceMethods

SeeAlsoZipEntryClass|ICSharpCode.SharpZipLib.ZipNamespace

Createsazipentrywiththegivenname.

OverloadListCreatesacopyofthegivenzipentry.

publicZipEntry(ZipEntry);

publicZipEntry(string);

ZipEntryConstructor

publicZipEntry(

stringname

Parametersname

Thenameforthisentry.Canincludedirectorycomponents.Theconventionfornamesis'unix'stylepathswithnodevicenamesandpathelementsseparatedby'/'characters.ThisisnotenforcedseeCleanNameonhowtoensurenamesarevalidifthisisdesired.

ExceptionsExceptionType ConditionArgumentNullException Thenamepassedisnull

SeeAlsoZipEntryClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipEntryConstructorOverloadList

ZipEntryConstructor(String)

Createsacopyofthegivenzipentry.

publicZipEntry(

ZipEntrye

Parameterse

Theentrytocopy.

SeeAlsoZipEntryClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipEntryConstructorOverloadList

ZipEntryConstructor(ZipEntry)

ThepropertiesoftheZipEntryclassarelistedbelow.ForacompletelistofZipEntryclassmembers,seetheZipEntryMemberstopic.

PublicInstancePropertiesComment Gets/Setstheentrycomment.

CompressedSize Gets/Setsthesizeofthecompresseddata.

CompressionMethod Gets/Setsthecompressionmethod.OnlyDeflatedandStoredaresupported.

Crc Gets/Setsthecrcoftheuncompresseddata.

DateTime Gets/Setsthetimeoflastmodificationoftheentry.

DosTime Get/SetDosTime

ExternalFileAttributes Get/Setexternalfileattributesasaninteger.ThevaluesofthisareoperatingsystemdependantseeHostSystemfordetails

ExtraData Gets/Setstheextradata.

Flags Get/Setgeneralpurposebitflagforentry

HostSystem GetsthecompatabilityinformationfortheexternalfileattributeIftheexternalfileattributesarecompatiblewithMS-DOSandcanbereadbyPKZIPforDOSversion2.04gthenthisvaluewillbezero.Otherwisethevaluewillbenon-zeroandidentifythehost

ZipEntryProperties

systemonwhichtheattributesarecompatible.

IsCrypted Get/Setflagindicatingifentryisencrypted.Asimplehelperroutinetoaidinterpretationofflags

IsDirectory Getsavalueindicatingoftheiftheentryisadirectory.Adirectoryisdeterminedbyanentrynamewithatrailingslash'/'.Theexternalfileattributescanalsomarkafileasadirectory.Thetrailingslashconventionshouldalwaysbefollowedhowever.

IsFile Getavalueoftrueiftheentryappearstobeafile;falseotherwise

Name Returnstheentryname.Thepathcomponentsintheentryshouldalwaysseparatedbyslashes('/').DosdevicenameslikeC:shouldalsoberemoved.SeeCleanName.

Offset Get/setoffsetforuseincentralheader

RequiresZip64 GetsavalueindicatingiftheentryrequiresZip64extensionstobestored

Size Gets/Setsthesizeoftheuncompresseddata.

Version GetminimumZipfeatureversionrequiredtoextractthisentry

VersionMadeBy Gettheversionmadebyforthisentryorzeroifunknown.Thevalue/10indicatesthemajorversionnumber,andthevaluemod10istheminorversionnumber

ZipFileIndex Get/SetindexofthisentryinZipfile

Gets/Setstheentrycomment.

publicstringComment{get;set;}

ExceptionsExceptionType ConditionArgumentOutOfRangeException Ifcommentislongerthan0xffff.

ZipEntry.CommentProperty

Gets/Setsthesizeofthecompresseddata.

publiclongCompressedSize{get;set;}

ExceptionsExceptionType ConditionArgumentOutOfRangeException Sizeisnotintherange

0..0xffffffff

ZipEntry.CompressedSizeProperty

Gets/Setsthecompressionmethod.OnlyDeflatedandStoredaresupported.

publicCompressionMethodCompressionMethod{get;set;}

ZipEntry.CompressionMethodProperty

Gets/Setsthecrcoftheuncompresseddata.

publiclongCrc{get;set;}

ExceptionsExceptionType ConditionArgumentOutOfRangeException Crcisnotintherange

0..0xffffffffL

ZipEntry.CrcProperty

Gets/Setsthetimeoflastmodificationoftheentry.

publicSystem.DateTimeDateTime{get;set;}

ZipEntry.DateTimeProperty

Get/SetDosTime

publiclongDosTime{get;set;}

ZipEntry.DosTimeProperty

Get/Setexternalfileattributesasaninteger.ThevaluesofthisareoperatingsystemdependantseeHostSystemfordetails

publicintExternalFileAttributes{get;set;}

ZipEntry.ExternalFileAttributesProperty

Gets/Setstheextradata.

publicbyte[]ExtraData{get;set;}

ExceptionsExceptionType ConditionArgumentOutOfRangeException Extradataislongerthan0xffff

bytes.

ZipEntry.ExtraDataProperty

Get/Setgeneralpurposebitflagforentry

publicintFlags{get;set;}

RemarksGeneralpurposebitflagBit0:Ifset,indicatesthefileisencryptedBit1-2Onlyusedforcompressiontype6Imploding,and8,9deflatingImploding:Bit1ifsetindicatesan8Kslidingdictionarywasused.Ifcleara4kdictionarywasusedBit2ifsetindicates3Shannon-Fannotreeswereusedtoencodetheslidingdictionary,2otherwise

Deflating:Bit2Bit100Normalcompressionwasused01Maximumcompressionwasused10Fastcompressionwasused11Superfastcompressionwasused

Bit3:Ifset,thefieldscrc-32,compressedsizeanduncompressedsizearewerenotabletobewrittenduringzipfilecreationThecorrectvaluesareheldinadatadescriptorimmediatelyfollowingthecompresseddata.Bit4:ReservedforusebyPKZIPforenhanceddeflatingBit5:IfsetindicatesthefilecontainscompressedpatchdataBit6:Ifsetindicatesstrongencryptionwasused.Bit7-15:Unusedorreserved

ZipEntry.FlagsProperty

GetsthecompatabilityinformationfortheexternalfileattributeIftheexternalfileattributesarecompatiblewithMS-DOSandcanbereadbyPKZIPforDOSversion2.04gthenthisvaluewillbezero.Otherwisethevaluewillbenon-zeroandidentifythehostsystemonwhichtheattributesarecompatible.

publicintHostSystem{get;}

RemarksThevaluesforthisasdefinedintheZipFileformatandbyothersareshownbelow.Thevaluesaresomewhatmisleadinginsomecasesastheyarenotallusedasshown.Youshouldconsulttherelevantdocumentationtoobtainuptodateandcorrectinformation.Themodifiedappnotebytheinfozipgroupisparticularlyhelpfulasitdocumentsalotofpeculiarities.Thedocumentishoweveralittledated.0-MS-DOSandOS/2(FAT/VFAT/FAT32filesystems)1-Amiga2-OpenVMS3-Unix4-VM/CMS5-AtariST6-OS/2HPFS7-Macintosh8-Z-System9-CP/M10-WindowsNTFS11-MVS(OS/390-Z/OS)12-VSE13-AcornRisc14-VFAT15-AlternateMVS16-BeOS17-Tandem18-OS/40019-OS/X(Darwin)99-WinZipAESremainder-unused

ZipEntry.HostSystemProperty

Get/Setflagindicatingifentryisencrypted.Asimplehelperroutinetoaidinterpretationofflags

publicboolIsCrypted{get;set;}

ZipEntry.IsCryptedProperty

Getsavalueindicatingoftheiftheentryisadirectory.Adirectoryisdeterminedbyanentrynamewithatrailingslash'/'.Theexternalfileattributescanalsomarkafileasadirectory.Thetrailingslashconventionshouldalwaysbefollowedhowever.

publicboolIsDirectory{get;}

ZipEntry.IsDirectoryProperty

Getavalueoftrueiftheentryappearstobeafile;falseotherwise

publicboolIsFile{get;}

RemarksThisonlytakesaccountWindowsattributes.Otheroperatingsystemsareignored.Forlinuxandotherstheresultmaybeincorrect.

ZipEntry.IsFileProperty

Returnstheentryname.Thepathcomponentsintheentryshouldalwaysseparatedbyslashes('/').DosdevicenameslikeC:shouldalsoberemoved.SeeCleanName.

ZipEntry.NameProperty

Get/setoffsetforuseincentralheader

publicintOffset{get;set;}

ZipEntry.OffsetProperty

GetsavalueindicatingiftheentryrequiresZip64extensionstobestored

publicboolRequiresZip64{get;}

ZipEntry.RequiresZip64Property

Gets/Setsthesizeoftheuncompresseddata.

ExceptionsExceptionType ConditionArgumentOutOfRangeException Ifthesizeisnotintherange

0..0xffffffffL

ZipEntry.SizeProperty

GetminimumZipfeatureversionrequiredtoextractthisentry

publicintVersion{get;}

RemarksMinimumfeaturesaredefinedas:1.0-Defaultvalue1.1-Fileisavolumelabel2.0-Fileisafolder/directory2.0-FileiscompressedusingDeflatecompression2.0-Fileisencryptedusingtraditionalencryption2.1-FileiscompressedusingDeflate642.5-FileiscompressedusingPKWAREDCLImplode2.7-Fileisapatchdataset4.5-FileusesZip64formatextensions4.6-FileiscompressedusingBZIP2compression5.0-FileisencryptedusingDES5.0-Fileisencryptedusing3DES5.0-FileisencryptedusingoriginalRC2encryption5.0-FileisencryptedusingRC4encryption5.1-FileisencryptedusingAESencryption5.1-FileisencryptedusingcorrectedRC2encryption5.1-FileisencryptedusingcorrectedRC2-64encryption6.1-Fileisencryptedusingnon-OAEPkeywrapping6.2-Centraldirectoryencryption(notconfirmedyet)

ZipEntry.VersionProperty

Gettheversionmadebyforthisentryorzeroifunknown.Thevalue/10indicatesthemajorversionnumber,andthevaluemod10istheminorversionnumber

publicintVersionMadeBy{get;}

ZipEntry.VersionMadeByProperty

Get/SetindexofthisentryinZipfile

publicintZipFileIndex{get;set;}

ZipEntry.ZipFileIndexProperty

ThemethodsoftheZipEntryclassarelistedbelow.ForacompletelistofZipEntryclassmembers,seetheZipEntryMemberstopic.

PublicStaticMethodsCleanName Overloaded.Cleansaname

makingitconformtoZipfileconventions.Devicesnames('c:\')andUNCsharenames('\\server\share')areremovedandforwardslashes('\')areconvertedtobackslashes('/').

PublicInstanceMethodsClone Createsacopyofthiszipentry.

ToString GetsthestringrepresentationofthisZipEntry.

ZipEntryMethods

CleansanamemakingitconformtoZipfileconventions.Devicesnames('c:\')andUNCsharenames('\\server\share')areremovedandforwardslashes('\')areconvertedtobackslashes('/').NamesaremaderelativebytrimmingleadingslasheswhichiscompatiblewithWindows-XPsbuiltinZipfilehandling.

OverloadListCleansanamemakingitconformtoZipfileconventions.Devicesnames('c:\')andUNCsharenames('\\server\share')areremovedandforwardslashes('\')areconvertedtobackslashes('/').NamesaremaderelativebytrimmingleadingslasheswhichiscompatiblewithWindows-XPsbuiltinZipfilehandling.

publicstaticstringCleanName(string);

CleansanamemakingitconformtoZipfileconventions.Devicesnames('c:\')andUNCsharenames('\\server\share')areremovedandforwardslashes('\')areconvertedtobackslashes('/').

publicstaticstringCleanName(string,bool);

ZipEntry.CleanNameMethod

CleansanamemakingitconformtoZipfileconventions.Devicesnames('c:\')andUNCsharenames('\\server\share')areremovedandforwardslashes('\')areconvertedtobackslashes('/').NamesaremaderelativebytrimmingleadingslasheswhichiscompatiblewithWindows-XPsbuiltinZipfilehandling.

publicstaticstringCleanName(

stringname

Parametersname

Nametoclean

SeeAlsoZipEntryClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipEntry.CleanNameOverloadList

ZipEntry.CleanNameMethod(String)

CleansanamemakingitconformtoZipfileconventions.Devicesnames('c:\')andUNCsharenames('\\server\share')areremovedandforwardslashes('\')areconvertedtobackslashes('/').

publicstaticstringCleanName(

stringname,

boolrelativePath

Parametersname

Nametoclean

relativePathMakenamesrelativeiftrueorabsoluteiffalse

SeeAlsoZipEntryClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipEntry.CleanNameOverloadList

ZipEntry.CleanNameMethod(String,Boolean)

Createsacopyofthiszipentry.

ZipEntry.CloneMethod

GetsthestringrepresentationofthisZipEntry.

publicoverridestringToString();

ZipEntry.ToStringMethod

RepresentserrorsspecifictoZipfilehandling

Foralistofallmembersofthistype,seeZipExceptionMembers.

System.ObjectSystem.ExceptionSystem.ApplicationExceptionICSharpCode.SharpZipLib.SharpZipBaseExceptionICSharpCode.SharpZipLib.Zip.ZipException

publicclassZipException:

SeeAlsoZipExceptionMembers|ICSharpCode.SharpZipLib.ZipNamespace

ZipExceptionClass

ZipExceptionoverview

PublicInstanceConstructorsZipException Overloaded.Initializesanew

instanceoftheZipExceptionclass.

ZipExceptionMembers

SeeAlsoZipExceptionClass|ICSharpCode.SharpZipLib.ZipNamespace

InitializesanewinstanceoftheZipExceptionclass.

OverloadListInitializesanewinstanceoftheZipExceptionclass.

publicZipException();

InitializesanewinstanceoftheZipExceptionclasswithaspecifiederrormessage.

publicZipException(string);

SeeAlsoZipExceptionClass|ICSharpCode.SharpZipLib.ZipNamespace

ZipExceptionConstructor

InitializesanewinstanceoftheZipExceptionclass.

publicZipException();

SeeAlsoZipExceptionClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipExceptionConstructorOverloadList

ZipExceptionConstructor()

InitializesanewinstanceoftheZipExceptionclasswithaspecifiederrormessage.

publicZipException(

stringmsg

SeeAlsoZipExceptionClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipExceptionConstructorOverloadList

ZipExceptionConstructor(String)

ThisclassrepresentsaZiparchive.Youcanaskforthecontainedentries,orgetaninputstreamforafileentry.Theentryisautomaticallydecompressed.Thisclassisthreadsafe:Youcanopeninputstreamsforarbitraryentriesindifferentthreads.

Foralistofallmembersofthistype,seeZipFileMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.ZipFile

publicclassZipFile:IEnumerable

Example

usingSystem;

usingSystem.Text;

usingSystem.Collections;

usingSystem.IO;

usingICSharpCode.SharpZipLib.Zip;

classMainClass

staticpublicvoidMain(string[]args)

ZipFilezFile=newZipFile(args[0]);

Console.WriteLine("Listingof:"+zFile.Name);

Console.WriteLine("");

Console.WriteLine("RawSizeSizeDateTimeName");

Console.WriteLine("---------------------------------------");

ZipFileClass

foreach(ZipEntryeinzFile){

DateTimed=e.DateTime;

Console.WriteLine("{0,-10}{1,-10}{2}{3}{4}",e.Size,e.CompressedSize,

d.ToString("dd-MM-yy"),d.ToString("t"),

e.Name);

SeeAlsoZipFileMembers|ICSharpCode.SharpZipLib.ZipNamespace

ZipFileoverview

PublicInstanceConstructorsZipFile Overloaded.Initializesanew

instanceoftheZipFileclass.

PublicInstanceFieldsKeysRequired Eventhandlerforhandling

encryptionkeys.

PublicInstancePropertiesEntryByIndex IndexerpropertyforZipEntries

Name Getsthenameofthiszipfile.

Password Passwordtobeusedforencrypting/decryptingfiles.

Size Getsthenumberofentriesinthiszipfile.

ZipFileComment Getsthecommentforthezipfile.

PublicInstanceMethodsClose ClosestheZipFile.Ifthestream

isIsStreamOwnerthenthisalsoclosestheunderlyinginputstream.Onceclosed,nofurtherinstancemethodsshouldbecalled.

FindEntry Returntheindexoftheentry

ZipFileMembers

withamatchingname

GetEntry Searchesforazipentryinthisarchivewiththegivenname.Stringcomparisonsarecaseinsensitive

GetEnumerator ReturnsanenumeratorfortheZipentriesinthisZipfile.

GetInputStream Overloaded.Createsaninputstreamreadingthegivenzipentryasuncompresseddata.NormallyzipentryshouldbeanentryreturnedbyGetEntry().

TestArchive Testanarchiveforintegrity/validity

SeeAlsoZipFileClass|ICSharpCode.SharpZipLib.ZipNamespace

OpensaZipfilewiththegivennameforreading.

OverloadListOpensaZipfilereadingthegivenFileStream

publicZipFile(FileStream);

OpensaZipfilereadingthegivenStream

publicZipFile(Stream);

publicZipFile(string);

ZipFileConstructor

publicZipFile(

stringname

ExceptionsExceptionType ConditionIOException Ani/oerroroccurs

ZipException Thefiledoesn'tcontainavalidziparchive.

SeeAlsoZipFileClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipFileConstructorOverloadList

ZipFileConstructor(String)

OpensaZipfilereadingthegivenFileStream

publicZipFile(

FileStreamfile

ExceptionsExceptionType ConditionIOException Ani/oerroroccurs.

ZipException Thefiledoesn'tcontainavalidziparchive.

ZipFileConstructor(FileStream)

OpensaZipfilereadingthegivenStream

publicZipFile(

StreambaseStream

ExceptionsExceptionType ConditionIOException Ani/oerroroccurs

ZipException Thefiledoesn'tcontainavalidziparchive.Thestreamprovidedcannotseek

ZipFileConstructor(Stream)

ThefieldsoftheZipFileclassarelistedbelow.ForacompletelistofZipFileclassmembers,seetheZipFileMemberstopic.

PublicInstanceFieldsKeysRequired Eventhandlerforhandling

encryptionkeys.

ZipFileFields

Eventhandlerforhandlingencryptionkeys.

publicKeysRequiredEventHandlerKeysRequired;

ZipFile.KeysRequiredField

ThepropertiesoftheZipFileclassarelistedbelow.ForacompletelistofZipFileclassmembers,seetheZipFileMemberstopic.

PublicInstancePropertiesEntryByIndex IndexerpropertyforZipEntries

Name Getsthenameofthiszipfile.

Password Passwordtobeusedforencrypting/decryptingfiles.

Size Getsthenumberofentriesinthiszipfile.

ZipFileComment Getsthecommentforthezipfile.

ZipFileProperties

IndexerpropertyforZipEntries

publicZipEntrythis[

intindex

]{get;}

ZipFile.EntryByIndexProperty

Getsthenameofthiszipfile.

ZipFile.NameProperty

Passwordtobeusedforencrypting/decryptingfiles.

publicstringPassword{set;}

RemarksSettonullifnopasswordisrequired.

ZipFile.PasswordProperty

Getsthenumberofentriesinthiszipfile.

publicintSize{get;}

ExceptionsExceptionType ConditionInvalidOperationException TheZipfilehasbeenclosed.

ZipFile.SizeProperty

Getsthecommentforthezipfile.

publicstringZipFileComment{get;}

ZipFile.ZipFileCommentProperty

ThemethodsoftheZipFileclassarelistedbelow.ForacompletelistofZipFileclassmembers,seetheZipFileMemberstopic.

PublicInstanceMethodsClose ClosestheZipFile.Ifthestream

isIsStreamOwnerthenthisalsoclosestheunderlyinginputstream.Onceclosed,nofurtherinstancemethodsshouldbecalled.

FindEntry Returntheindexoftheentrywithamatchingname

GetEntry Searchesforazipentryinthisarchivewiththegivenname.Stringcomparisonsarecaseinsensitive

GetEnumerator ReturnsanenumeratorfortheZipentriesinthisZipfile.

GetInputStream Overloaded.Createsaninputstreamreadingthegivenzipentryasuncompresseddata.NormallyzipentryshouldbeanentryreturnedbyGetEntry().

ZipFileMethods

TestArchive Testanarchiveforintegrity/validity

ClosestheZipFile.IfthestreamisIsStreamOwnerthenthisalsoclosestheunderlyinginputstream.Onceclosed,nofurtherinstancemethodsshouldbecalled.

publicvoidClose();

ExceptionsExceptionType ConditionIOException Ani/oerroroccurs.

ZipFile.CloseMethod

Returntheindexoftheentrywithamatchingname

publicintFindEntry(

stringname,

boolignoreCase

Parametersname

Entrynametofind

ignoreCaseIftruethecomparisoniscaseinsensitive

ReturnValueTheindexpositionofthematchingentryor-1ifnotfound

ZipFile.FindEntryMethod

Searchesforazipentryinthisarchivewiththegivenname.Stringcomparisonsarecaseinsensitive

publicZipEntryGetEntry(

stringname

Parametersname

Thenametofind.Maycontaindirectorycomponentsseparatedbyslashes('/').

ReturnValueThezipentry,ornullifnoentrywiththatnameexists.

ZipFile.GetEntryMethod

ReturnsanenumeratorfortheZipentriesinthisZipfile.

publicIEnumeratorGetEnumerator();

ImplementsIEnumerable.GetEnumerator

ZipFile.GetEnumeratorMethod

Createsaninputstreamreadingthegivenzipentryasuncompresseddata.NormallyzipentryshouldbeanentryreturnedbyGetEntry().

OverloadListCreatesaninputstreamreadingthegivenzipentryasuncompresseddata.NormallyzipentryshouldbeanentryreturnedbyGetEntry().

publicStreamGetInputStream(ZipEntry);

Createsaninputstreamreadingazipentry

publicStreamGetInputStream(int);

ZipFile.GetInputStreamMethod

Createsaninputstreamreadingthegivenzipentryasuncompresseddata.NormallyzipentryshouldbeanentryreturnedbyGetEntry().

publicStreamGetInputStream(

ZipEntryentry

ReturnValuetheinputstream.

ExceptionsExceptionType ConditionInvalidOperationException TheZipFilehasalreadybeen

closed

ZipException Thecompressionmethodfortheentryisunknown

IndexOutOfRangeException TheentryisnotfoundintheZipFile

SeeAlsoZipFileClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipFile.GetInputStreamOverloadList

ZipFile.GetInputStreamMethod(ZipEntry)

Createsaninputstreamreadingazipentry

publicStreamGetInputStream(

intentryIndex

ParametersentryIndex

Theindexoftheentrytoobtainaninputstreamfor.

ReturnValueAninputstream.

ExceptionsExceptionType ConditionInvalidOperationException TheZipFilehasalreadybeen

closed

ZipException Thecompressionmethodfortheentryisunknown

IndexOutOfRangeException TheentryisnotfoundintheZipFile

SeeAlsoZipFileClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipFile.GetInputStreamOverloadList

ZipFile.GetInputStreamMethod(Int32)

Testanarchiveforintegrity/validity

publicboolTestArchive(

booltestData

ParameterstestData

PerformlowleveldataCrccheck

ReturnValuetrueiffthetestpasses,falseotherwise

ZipFile.TestArchiveMethod

Delegateforhandlingkeys/passwordsettingduringcompresion/decompression.

publicdelegatevoidZipFile.KeysRequiredEventHandler(

objectsender,

KeysRequiredEventArgse

ZipFile.KeysRequiredEventHandlerDelegate

ThisisanInflaterInputStreamthatreadsthefilesbaseInputStreamanziparchiveoneafteranother.Ithasaspecialmethodtogetthezipentryofthenextfile.Thezipentrycontainsinformationaboutthefilenamesize,compressedsize,Crc,etc.ItincludessupportforStoredandDeflatedentries.

Foralistofallmembersofthistype,seeZipInputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStreamICSharpCode.SharpZipLib.Zip.ZipInputStream

publicclassZipInputStream:

InflaterInputStream

ExampleThissampleshowshowtoreadazipfile

usingSystem;

usingSystem.Text;

usingSystem.IO;

classMainClass

ZipInputStreamClass

ZipInputStreams=newZipInputStream(File.OpenRead(args[0]));

ZipEntrytheEntry;

while((theEntry=s.GetNextEntry())!=null){

intsize=2048;

byte[]data=newbyte[2048];

Console.Write("Showcontents(y/n)?");

if(Console.ReadLine()=="y"){

while(true){

size=s.Read(data,0,data.Length);

if(size>0){

Console.Write(newASCIIEncoding().GetString(data,0,size));

}else{

break;

s.Close();

SeeAlsoZipInputStreamMembers|ICSharpCode.SharpZipLib.ZipNamespace

ZipInputStreamoverview

PublicInstanceConstructorsZipInputStreamConstructor CreatesanewZipinputstream,

forreadingaziparchive.

PublicInstancePropertiesAvailable Returns1ifthereisanentry

availableOtherwisereturns0.

CanDecompressEntry Getsavalueindicatingiftheentrycanbedecompressed

Password Optionalpasswordusedforencryptionwhennon-null

ZipInputStreamMembers

BodyRead Readsablockofbytesfromthecurrentzipentry.

Close Closesthezipinputstream

CloseEntry Closesthecurrentzipentryandmovestothenextone.

Retrievesthecurrentlifetimeserviceobjectthatcontrolsthe

lifetimepolicyforthisinstance.

GetNextEntry Advancestothenextentryinthearchive

Read Readablockofbytesfromthestream.

ReadByte Readsabytefromthecurrentzipentry.

ProtectedInstanceFields

baseInputStream(inheritedfromInflaterInputStream)

Basestreamtheinflaterreadsfrom.

Thecompressedsize

SeeAlsoZipInputStreamClass|ICSharpCode.SharpZipLib.ZipNamespace

CreatesanewZipinputstream,forreadingaziparchive.

publicZipInputStream(

ZipInputStreamConstructor

ThepropertiesoftheZipInputStreamclassarelistedbelow.ForacompletelistofZipInputStreamclassmembers,seetheZipInputStreamMemberstopic.

PublicInstancePropertiesAvailable Returns1ifthereisanentry

availableOtherwisereturns0.

CanDecompressEntry Getsavalueindicatingiftheentrycanbedecompressed

Password Optionalpasswordusedforencryptionwhennon-null

SeeAlso

ZipInputStreamProperties

ZipInputStreamClass|ICSharpCode.SharpZipLib.ZipNamespace

Returns1ifthereisanentryavailableOtherwisereturns0.

publicoverrideintAvailable{get;}

ZipInputStream.AvailableProperty

Getsavalueindicatingiftheentrycanbedecompressed

publicboolCanDecompressEntry{get;}

RemarksTheentrycanonlybedecompressedifthelibrarysupportsthezipfeaturesrequiredtoextractit.SeetheZipEntryVersionpropertyformoredetails.

ZipInputStream.CanDecompressEntryProperty

Optionalpasswordusedforencryptionwhennon-null

publicstringPassword{get;set;}

ZipInputStream.PasswordProperty

ThemethodsoftheZipInputStreamclassarelistedbelow.ForacompletelistofZipInputStreamclassmembers,seetheZipInputStreamMemberstopic.

BodyRead Readsablockofbytesfromthecurrentzipentry.

Close Closesthezipinputstream

CloseEntry Closesthecurrentzipentryandmovestothenextone.

GetHashCode(inheritedfrom Servesasahashfunctionfora

ZipInputStreamMethods

Object) particulartype,suitableforuseinhashingalgorithmsanddatastructureslikeahashtable.

GetNextEntry Advancestothenextentryinthearchive

Read Readablockofbytesfromthestream.

ReadByte Readsabytefromthecurrentzipentry.

WriteByte(inheritedfrom Writesonebytetothecurrent

InflaterInputStream) streamandadvancesthecurrentpositionAlwaysthrowsaNotSupportedException

Readsablockofbytesfromthecurrentzipentry.

publicintBodyRead(

byte[]b,

intoff,

intlen

ReturnValueThenumberofbytesread(thismaybelessthanthelengthrequested,evenbeforetheendofstream),or0onendofstream.

ExceptionsExceptionType ConditionZipException Thedeflatedstreamis

corrupted.

InvalidOperationException Thestreamisnotopen.

Ani/oerroroccured.

ZipInputStream.BodyReadMethod

Closesthezipinputstream

ZipInputStream.CloseMethod

Closesthecurrentzipentryandmovestothenextone.

ExceptionsExceptionType ConditionInvalidOperationException Thestreamisclosed

ZipException TheZipstreamendsearly

ZipInputStream.CloseEntryMethod

Advancestothenextentryinthearchive

publicZipEntryGetNextEntry();

ReturnValueThenextentryinthearchiveornulliftherearenomoreentries.

RemarksIfthepreviousentryisstillopenCloseEntryiscalled.

ExceptionsExceptionType ConditionInvalidOperationException Inputstreamisclosed

ZipException Passwordisnotset,passwordisinvalid,compressionmethodisinvalid,versionrequiredtoextractisnotsupported

ZipInputStream.GetNextEntryMethod

Readablockofbytesfromthestream.

byte[]destination,

intindex,

intcount

Parametersdestination

Thedestinationforthebytes.

indexTheindextostartstoringdata.

countThenumberofbytestoattempttoread.

ReturnValueReturnsthenumberofbytesread.

RemarksZerobytesreadmeansendofstream.

ZipInputStream.ReadMethod

Readsabytefromthecurrentzipentry.

ReturnValueThebyteor-1ifendofstreamisreached.

ExceptionsExceptionType Condition

Thedeflatedstreamiscorrupted.

Ani/oerroroccured.

ZipInputStream.ReadByteMethod

ZipNameTransformtransformsnameaspertheZipfileconvention.

Foralistofallmembersofthistype,seeZipNameTransformMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.ZipNameTransform

publicclassZipNameTransform:

INameTransform

SeeAlsoZipNameTransformMembers|ICSharpCode.SharpZipLib.ZipNamespace

ZipNameTransformClass

ZipNameTransformoverview

PublicInstanceConstructorsZipNameTransform Overloaded.Initializesanew

instanceoftheZipNameTransformclass.

PublicInstancePropertiesTrimPrefix Get/setthepathprefixtobe

trimmedfrompathsifpresent.

TransformDirectory TransformadirectorynameaccordingtotheZipfilenamingconventions.

TransformFile TransformafilenameaccordingtotheZipfilenamingconventions.

ProtectedInstanceMethodsFinalize(inheritedfrom AllowsanObjecttoattemptto

ZipNameTransformMembers

Object) freeresourcesandperformothercleanupoperationsbeforetheObjectisreclaimedbygarbagecollection.

SeeAlsoZipNameTransformClass|ICSharpCode.SharpZipLib.ZipNamespace

InitializeanewinstanceofZipNameTransform

OverloadListInitializeanewinstanceofZipNameTransform

publicZipNameTransform();

publicZipNameTransform(bool);

publicZipNameTransform(bool,string);

ZipNameTransformConstructor

publicZipNameTransform();

RemarksRelativepathsdefaulttotruewiththisconstructor.

SeeAlsoZipNameTransformClass|ICSharpCode.SharpZipLib.ZipNamespace|ZipNameTransformConstructorOverloadList

ZipNameTransformConstructor()

publicZipNameTransform(

booluseRelativePaths

ParametersuseRelativePaths

Iftruerelativepathsarecreated,iffalseabsolutepathsarecreated.

ZipNameTransformConstructor(Boolean)

publicZipNameTransform(

booluseRelativePaths,

stringtrimPrefix

ParametersuseRelativePaths

Iftruerelativepathsarecreated,iffalseabsolutepathsarecreated.

trimPrefixThestringtotrimfromfrontofpathsiffound.

ZipNameTransformConstructor(Boolean,String)

ThepropertiesoftheZipNameTransformclassarelistedbelow.ForacompletelistofZipNameTransformclassmembers,seetheZipNameTransformMemberstopic.

PublicInstancePropertiesTrimPrefix Get/setthepathprefixtobe

trimmedfrompathsifpresent.

ZipNameTransformProperties

Get/setthepathprefixtobetrimmedfrompathsifpresent.

publicstringTrimPrefix{get;set;}

ZipNameTransform.TrimPrefixProperty

ThemethodsoftheZipNameTransformclassarelistedbelow.ForacompletelistofZipNameTransformclassmembers,seetheZipNameTransformMemberstopic.

TransformDirectory TransformadirectorynameaccordingtotheZipfilenamingconventions.

TransformFile TransformafilenameaccordingtotheZipfilenamingconventions.

SeeAlso

ZipNameTransformMethods

ZipNameTransformClass|ICSharpCode.SharpZipLib.ZipNamespace

TransformadirectorynameaccordingtotheZipfilenamingconventions.

publicstringTransformDirectory(

stringname

Parametersname

Thedirectorynametotransform.

ImplementsINameTransform.TransformDirectory

ZipNameTransform.TransformDirectoryMethod

TransformafilenameaccordingtotheZipfilenamingconventions.

publicstringTransformFile(

stringname

Parametersname

Thefilenametotransform.

ImplementsINameTransform.TransformFile

ZipNameTransform.TransformFileMethod

ThisisaDeflaterOutputStreamthatwritesthefilesintoaziparchiveoneafteranother.Ithasaspecialmethodtostartanewzipentry.Thezipentriescontainsinformationaboutthefilenamesize,compressedsize,CRC,etc.ItincludessupportforStoredandDeflatedentries.Thisclassisnotthreadsafe.

Foralistofallmembersofthistype,seeZipOutputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStreamICSharpCode.SharpZipLib.Zip.ZipOutputStream

publicclassZipOutputStream:

DeflaterOutputStream

ExampleThissampleshowshowtocreateazipfile

usingSystem;

usingSystem.IO;

classMainClass

ZipOutputStreamClass

string[]filenames=Directory.GetFiles(args[0]);

ZipOutputStreams=newZipOutputStream(File.Create(args[1]));

s.SetLevel(5);//0-storeonlyto9-meansbestcompression

foreach(stringfileinfilenames){

FileStreamfs=File.OpenRead(file);

byte[]buffer=newbyte[fs.Length];

fs.Read(buffer,0,buffer.Length);

ZipEntryentry=newZipEntry(file);

s.PutNextEntry(entry);

s.Write(buffer,0,buffer.Length);

s.Finish();

s.Close();

SeeAlsoZipOutputStreamMembers|ICSharpCode.SharpZipLib.ZipNamespace

ZipOutputStreamoverview

PublicInstanceConstructorsZipOutputStreamConstructor CreatesanewZipoutput

stream,writingaziparchive.

IsFinished Getsbooleanindicatingcentralheaderhasbeenaddedforthisarchive...Nofurtherentriescanbeaddedoncethishasbeendone.

Position(inheritedfrom

Thecurrentpositionwithinthestream.Alwaysthrowsa

ZipOutputStreamMembers

DeflaterOutputStream) NotSupportedExceptionNotSupportedException

Close(inheritedfromDeflaterOutputStream)

Callsfinish()andclosestheunderlyingstreamwhenIsStreamOwneristrue.

CloseEntry Closesthecurrententry,updatingheaderandfooterinformationasrequired

Finish Finishesthestream.Thiswillwritethecentraldirectoryattheendofthezipfileandflushthestream.

Flush(inheritedfrom Flushesthestreambycalling

DeflaterOutputStream) flush()onthedeflaterandthenontheunderlyingstream.Thisensuresthatallbytesareflushed.

GetLevel Getthecurrentdeflatecompressionlevel

PutNextEntry StartsanewZipentry.Itautomaticallyclosesthepreviousentryifpresent.Allentryelementsbarnameareoptional,butmustbecorrectifpresent.Ifthecompressionmethodisstoredandtheoutputisnotpatchablethecompressionforthatentryisautomaticallychangedtodeflatelevel0

Seek(inheritedfrom Setsthecurrentpositionofthis

DeflaterOutputStream) streamtothegivenvalue.Notsupportedbythisclass!

SetComment Setthezipfilecomment.

SetLevel Setsdefaultcompressionlevel.Thenewlevelwillbeactivatedimmediately.

Write Writesthegivenbuffertothecurrententry.

ProtectedInstanceFieldsbaseOutputStream(inherited

fromDeflaterOutputStream)Basestreamthedeflaterdependson.

def.deflate()

Encryptablockofdata

Encryptasinglebyte

SeeAlsoZipOutputStreamClass|ICSharpCode.SharpZipLib.ZipNamespace

CreatesanewZipoutputstream,writingaziparchive.

publicZipOutputStream(

Theoutputstreamtowhichthearchivecontentsarewritten.

ZipOutputStreamConstructor

ThepropertiesoftheZipOutputStreamclassarelistedbelow.ForacompletelistofZipOutputStreamclassmembers,seetheZipOutputStreamMemberstopic.

IsFinished Getsbooleanindicatingcentralheaderhasbeenaddedforthisarchive...Nofurtherentriescanbeaddedoncethishasbeendone.

Position(inheritedfromDeflaterOutputStream)

ZipOutputStreamProperties

Getsbooleanindicatingcentralheaderhasbeenaddedforthisarchive...Nofurtherentriescanbeaddedoncethishasbeendone.

publicboolIsFinished{get;}

ZipOutputStream.IsFinishedProperty

ThemethodsoftheZipOutputStreamclassarelistedbelow.ForacompletelistofZipOutputStreamclassmembers,seetheZipOutputStreamMemberstopic.

Close(inheritedfromDeflaterOutputStream)

CloseEntry Closesthecurrententry,updatingheaderandfooterinformationasrequired

Finish Finishesthestream.Thiswill

ZipOutputStreamMethods

writethecentraldirectoryattheendofthezipfileandflushthestream.

Flush(inheritedfromDeflaterOutputStream)

GetLevel Getthecurrentdeflatecompressionlevel

PutNextEntry StartsanewZipentry.Itautomaticallyclosesthepreviousentryifpresent.Allentryelementsbarnameareoptional,butmustbecorrectifpresent.Ifthecompressionmethodisstoredandtheoutputisnotpatchablethecompressionforthatentryisautomaticallychangedtodeflatelevel0

SetComment Setthezipfilecomment.

SetLevel Setsdefaultcompressionlevel.Thenewlevelwillbeactivatedimmediately.

Write Writesthegivenbuffertothecurrententry.

def.deflate()

Encryptablockofdata

Encryptasinglebyte

Closesthecurrententry,updatingheaderandfooterinformationasrequired

ExceptionsExceptionType ConditionIOException AnI/Oerroroccurs.

InvalidOperationException Noentryisactive.

ZipOutputStream.CloseEntryMethod

Finishesthestream.Thiswillwritethecentraldirectoryattheendofthezipfileandflushthestream.

publicoverridevoidFinish();

RemarksThisisautomaticallycalledwhenthestreamisclosed.

ExceptionsExceptionType ConditionIOException AnI/Oerroroccurs.

ZipException CommentexceedsthemaximumlengthEntrynameexceedsthemaximumlength

ZipOutputStream.FinishMethod

Getthecurrentdeflatecompressionlevel

ReturnValueThecurrentcompressionlevel

ZipOutputStream.GetLevelMethod

StartsanewZipentry.Itautomaticallyclosesthepreviousentryifpresent.Allentryelementsbarnameareoptional,butmustbecorrectifpresent.Ifthecompressionmethodisstoredandtheoutputisnotpatchablethecompressionforthatentryisautomaticallychangedtodeflatelevel0

publicvoidPutNextEntry(

ZipEntryentry

Parametersentry

theentry.

ExceptionsExceptionType ConditionIOException ifanI/Oerroroccured.

InvalidOperationException ifstreamwasfinished

ZipException ToomanyentriesintheZipfileEntrynameistoolongFinishhasalreadybeencalled

ZipOutputStream.PutNextEntryMethod

Setthezipfilecomment.

publicvoidSetComment(

stringcomment

Parameterscomment

Thecommentstring

Encodingofcommentislongerthan0xffffbytes.

ZipOutputStream.SetCommentMethod

Setsdefaultcompressionlevel.Thenewlevelwillbeactivatedimmediately.

publicvoidSetLevel(

intlevel

ExceptionsExceptionType ConditionArgumentOutOfRangeException Levelspecifiedisnotsupported.

ZipOutputStream.SetLevelMethod

Writesthegivenbuffertothecurrententry.

byte[]b,

intoff,

intlen

ExceptionsExceptionType ConditionZipException Archivesizeisinvalid

InvalidOperationException Noentryisactive.

ZipOutputStream.WriteMethod

Namespacehierarchy

ClassesClass DescriptionDeflater ThisistheDeflaterclass.Thedeflater

classcompressesinputwiththedeflatealgorithmdescribedinRFC1951.Ithasseveralcompressionlevelsandthreedifferentstrategiesdescribedbelow.Thisclassisnotthreadsafe.ThisisinherentintheAPI,duetothesplitofdeflateandsetInput.authoroftheoriginaljavaversion:JochenHoenicke

DeflaterConstants Thisclasscontainsconstantsusedfordeflation.

DeflaterEngine Lowlevelcompressionenginefordeflatealgorithmwhichusesa32KslidingwindowwithsecondarycompressionfromHuffman/Shannon-Fanocodes.

DeflaterHuffman ThisistheDeflaterHuffmanclass.Thisclassisnotthreadsafe.ThisisinherentintheAPI,duetothesplitofdeflateandsetInput.authoroftheoriginaljavaversion:JochenHoenicke

DeflaterHuffman.Tree Notdocumented

DeflaterPending ThisclassstoresthependingoutputoftheDeflater.authoroftheoriginaljavaversion:JochenHoenicke

Inflater Inflaterisusedtodecompressdatathathasbeencompressedaccordingtothe"deflate"standarddescribedinrfc1951.BydefaultZlib(rfc1950)headersandfootersareexpectedintheinput.Youcan

ICSharpCode.SharpZipLib.Zip.CompressionNamespace

useconstructor

publicInflater(boolnoHeader)

passingtrueifthereisnoZlibheaderinformationTheusageisasfollowing.Firstyouhavetosetsomeinputwith

setInput()

,theninflate()it.Ifinflatedoesn'tinflateanybytestheremaybethreereasons:

needsInput()returnstruebecausetheinputbufferisempty.Youhavetoprovidemoreinputwith

setInput()

.NOTE:needsInput()alsoreturnstruewhen,thestreamisfinished.

needsDictionary()returnstrue,youhavetoprovideapresetdictionarywith

setDictionary()

finished()returnstrue,theinflaterhasfinished.

Oncethefirstoutputbyteisproduced,adictionarywillnotbeneededatalaterstage.authoroftheoriginaljavaversion:JohnLeuner,JochenHoenicke

InflaterHuffmanTree Huffmantreeusedforinflation

PendingBuffer Thisclassisgeneralpurposeclassforwritingdatatoabuffer.ItallowsyoutowritebitsaswellasbytesBasedon

DeflaterPending.javaauthoroftheoriginaljavaversion:JochenHoenicke

EnumerationsEnumeration DescriptionDeflateStrategy Strategiesfordeflater

ThisistheDeflaterclass.ThedeflaterclasscompressesinputwiththedeflatealgorithmdescribedinRFC1951.Ithasseveralcompressionlevelsandthreedifferentstrategiesdescribedbelow.Thisclassisnotthreadsafe.ThisisinherentintheAPI,duetothesplitofdeflateandsetInput.authoroftheoriginaljavaversion:JochenHoenicke

Foralistofallmembersofthistype,seeDeflaterMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.Deflater

publicclassDeflater

RequirementsNamespace:ICSharpCode.SharpZipLib.Zip.CompressionAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoDeflaterMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

DeflaterClass

Deflateroverview

PublicStaticFieldsBEST_COMPRESSION Thebestandslowest

compressionlevel.Thistriestofindverylonganddistantstringrepetitions.

BEST_SPEED Theworstbutfastestcompressionlevel.

DEFAULT_COMPRESSION Thedefaultcompressionlevel.

DEFLATED Thecompressionmethod.Thisistheonlymethodsupportedsofar.Thereisnoneedtousethisconstantatall.

NO_COMPRESSION Thislevelwon'tcompressatallbutoutputuncompressedblocks.

PublicInstanceConstructorsDeflater Overloaded.Initializesanew

instanceoftheDeflaterclass.

PublicInstancePropertiesAdler Getsthecurrentadler

checksumofthedatathatwasprocessedsofar.

IsFinished Returnstrueifthestreamwasfinishedandnomoreoutputbytesareavailable.

IsNeedingInput Returnstrue,iftheinputbufferisempty.YoushouldthencallsetInput().NOTE:Thismethod

DeflaterMembers

canalsoreturntruewhenthestreamwasfinished.

TotalIn Getsthenumberofinputbytesprocessedsofar.

TotalOut Getsthenumberofoutputbytessofar.

PublicInstanceMethodsDeflate Overloaded.Deflatesthecurrentinputblockwith

tothegivenarray.

Finish Finishesthedeflaterwiththecurrentinputblock.Itisanerrortogivemoreinputafterthismethodwascalled.Thismethodmustbecalledtoforceallbytestobeflushed.

Flush Flushesthecurrentinputblock.Furthercallstodeflate()willproduceenoughoutputtoinflateeverythinginthecurrentinputblock.ThisisnotpartofSun'sJDKsoIhavemadeitpackageprivate.ItisusedbyDeflaterOutputStreamtoimplementflush().

GetLevel Getcurrentcompressionlevel

Reset Resetsthedeflater.Thedeflateractsafterwardsasifitwasjustcreatedwiththesamecompressionlevelandstrategyasithadbefore.

SetDictionary Overloaded.Setsthedictionarywhichshouldbeusedinthedeflateprocess.Thiscallisequivalentto

setDictionary(dict,0,dict.Length)

SetInput Overloaded.Setsthedatawhichshouldbecompressednext.ThisshouldbeonlycalledwhenneedsInputindicatesthatmoreinputisneeded.IfyoucallsetInputwhenneedsInput()returnsfalse,thepreviousinputthatisstillpendingwillbethrownaway.Thegivenbytearrayshouldnotbechanged,beforeneedsInput()returnstrueagain.Thiscallisequivalentto

setInput(input,0,input.length)

SetLevel Setsthecompressionlevel.Thereisnoguaranteeoftheexactpositionofthechange,butifyoucallthiswhenneedsInputistruethechangeofcompressionlevelwilloccursomewherenearbeforetheendofthesofargiveninput.

SetStrategy Setsthecompressionstrategy.StrategyisoneofDEFAULT_STRATEGY,HUFFMAN_ONLYandFILTERED.Fortheexactpositionwherethestrategyischanged,thesameasforsetLevel()applies.

SeeAlsoDeflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

Createsanewdeflaterwithdefaultcompressionlevel.

OverloadListCreatesanewdeflaterwithdefaultcompressionlevel.

publicDeflater();

Createsanewdeflaterwithgivencompressionlevel.

publicDeflater(int);

publicDeflater(int,bool);

DeflaterConstructor

Createsanewdeflaterwithdefaultcompressionlevel.

publicDeflater();

SeeAlsoDeflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|DeflaterConstructorOverloadList

DeflaterConstructor()

publicDeflater(

intlvl

Parameterslvl

thecompressionlevel,avaluebetweenNO_COMPRESSIONandBEST_COMPRESSION,orDEFAULT_COMPRESSION.

ExceptionsExceptionType ConditionArgumentOutOfRangeException iflvlisoutofrange.

DeflaterConstructor(Int32)

publicDeflater(

intlevel,

boolnoZlibHeaderOrFooter

Parameterslevel

thecompressionlevel,avaluebetweenNO_COMPRESSIONandBEST_COMPRESSION.

noZlibHeaderOrFootertrue,ifweshouldsuppresstheZlib/RFC1950headeratthebeginningandtheadlerchecksumattheendoftheoutput.ThisisusefulfortheGZIP/PKZIPformats.

ExceptionsExceptionType ConditionArgumentOutOfRangeException iflvlisoutofrange.

DeflaterConstructor(Int32,Boolean)

ThefieldsoftheDeflaterclassarelistedbelow.ForacompletelistofDeflaterclassmembers,seetheDeflaterMemberstopic.

PublicStaticFieldsBEST_COMPRESSION Thebestandslowest

compressionlevel.Thistriestofindverylonganddistantstringrepetitions.

BEST_SPEED Theworstbutfastestcompressionlevel.

DEFAULT_COMPRESSION Thedefaultcompressionlevel.

DEFLATED Thecompressionmethod.Thisistheonlymethodsupportedsofar.Thereisnoneedtousethisconstantatall.

NO_COMPRESSION Thislevelwon'tcompressatallbutoutputuncompressedblocks.

DeflaterFields

Thebestandslowestcompressionlevel.Thistriestofindverylonganddistantstringrepetitions.

publicstaticintBEST_COMPRESSION;

Deflater.BEST_COMPRESSIONField

Theworstbutfastestcompressionlevel.

publicstaticintBEST_SPEED;

Deflater.BEST_SPEEDField

Thedefaultcompressionlevel.

publicstaticintDEFAULT_COMPRESSION;

Deflater.DEFAULT_COMPRESSIONField

Thecompressionmethod.Thisistheonlymethodsupportedsofar.Thereisnoneedtousethisconstantatall.

publicstaticintDEFLATED;

Deflater.DEFLATEDField

Thislevelwon'tcompressatallbutoutputuncompressedblocks.

publicstaticintNO_COMPRESSION;

Deflater.NO_COMPRESSIONField

ThepropertiesoftheDeflaterclassarelistedbelow.ForacompletelistofDeflaterclassmembers,seetheDeflaterMemberstopic.

PublicInstancePropertiesAdler Getsthecurrentadler

checksumofthedatathatwasprocessedsofar.

IsFinished Returnstrueifthestreamwasfinishedandnomoreoutputbytesareavailable.

IsNeedingInput Returnstrue,iftheinputbufferisempty.YoushouldthencallsetInput().NOTE:Thismethodcanalsoreturntruewhenthestreamwasfinished.

TotalIn Getsthenumberofinputbytesprocessedsofar.

TotalOut Getsthenumberofoutputbytessofar.

DeflaterProperties

Getsthecurrentadlerchecksumofthedatathatwasprocessedsofar.

publicintAdler{get;}

Deflater.AdlerProperty

Returnstrueifthestreamwasfinishedandnomoreoutputbytesareavailable.

Deflater.IsFinishedProperty

Returnstrue,iftheinputbufferisempty.YoushouldthencallsetInput().NOTE:Thismethodcanalsoreturntruewhenthestreamwasfinished.

publicboolIsNeedingInput{get;}

Deflater.IsNeedingInputProperty

Getsthenumberofinputbytesprocessedsofar.

publicintTotalIn{get;}

Deflater.TotalInProperty

Getsthenumberofoutputbytessofar.

publiclongTotalOut{get;}

Deflater.TotalOutProperty

ThemethodsoftheDeflaterclassarelistedbelow.ForacompletelistofDeflaterclassmembers,seetheDeflaterMemberstopic.

PublicInstanceMethodsDeflate Overloaded.Deflatesthecurrentinputblockwith

tothegivenarray.

Finish Finishesthedeflaterwiththecurrentinputblock.Itisanerrortogivemoreinputafterthismethodwascalled.Thismethodmustbecalledtoforceallbytestobeflushed.

Flush Flushesthecurrentinputblock.Furthercallstodeflate()willproduceenoughoutputtoinflateeverythinginthecurrentinputblock.ThisisnotpartofSun'sJDKsoIhavemadeitpackageprivate.ItisusedbyDeflaterOutputStreamtoimplementflush().

GetLevel Getcurrentcompressionlevel

Reset Resetsthedeflater.Thedeflateractsafterwardsasifitwasjustcreatedwiththesamecompressionlevelandstrategyasithadbefore.

SetDictionary Overloaded.Setsthedictionarywhichshouldbeusedinthedeflateprocess.Thiscallisequivalentto

DeflaterMethods

SetInput Overloaded.Setsthedatawhichshouldbecompressednext.ThisshouldbeonlycalledwhenneedsInputindicatesthatmoreinputisneeded.IfyoucallsetInputwhenneedsInput()returnsfalse,thepreviousinputthatisstillpendingwillbethrownaway.Thegivenbytearrayshouldnotbechanged,beforeneedsInput()returnstrueagain.Thiscallisequivalentto

SetLevel Setsthecompressionlevel.Thereisnoguaranteeoftheexactpositionofthechange,butifyoucallthiswhenneedsInputistruethechangeofcompressionlevelwilloccursomewherenearbeforetheendofthesofargiveninput.

SetStrategy Setsthecompressionstrategy.StrategyisoneofDEFAULT_STRATEGY,HUFFMAN_ONLYandFILTERED.Fortheexactpositionwherethestrategyischanged,thesameasforsetLevel()applies.

Deflatesthecurrentinputblockwithtothegivenarray.

OverloadListDeflatesthecurrentinputblockwithtothegivenarray.

publicintDeflate(byte[]);

Deflatesthecurrentinputblocktothegivenarray.

publicintDeflate(byte[],int,int);

Deflater.DeflateMethod

Deflatesthecurrentinputblockwithtothegivenarray.

publicintDeflate(

byte[]output

Parametersoutput

Thebufferwherecompresseddataisstored

ReturnValueThenumberofcompressedbytesaddedtotheoutput,or0ifeitherneedsInput()orfinished()returnstrueorlengthiszero.

SeeAlsoDeflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Deflater.DeflateOverloadList

Deflater.DeflateMethod(Byte[])

Deflatesthecurrentinputblocktothegivenarray.

publicintDeflate(

byte[]output,

intoffset,

intlength

Parametersoutput

Buffertostorethecompresseddata.

offsetOffsetintotheoutputarray.

lengthThemaximumnumberofbytesthatmaybestored.

ReturnValueThenumberofcompressedbytesaddedtotheoutput,or0ifeitherneedsInput()orfinished()returnstrueorlengthiszero.

ExceptionsExceptionType ConditionInvalidOperationException Ifend()waspreviouslycalled.

ArgumentOutOfRangeException Ifoffsetand/orlengthdon'tmatchthearraylength.

SeeAlsoDeflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Deflater.DeflateOverloadList

Deflater.DeflateMethod(Byte[],Int32,Int32)

Finishesthedeflaterwiththecurrentinputblock.Itisanerrortogivemoreinputafterthismethodwascalled.Thismethodmustbecalledtoforceallbytestobeflushed.

publicvoidFinish();

Deflater.FinishMethod

Flushesthecurrentinputblock.Furthercallstodeflate()willproduceenoughoutputtoinflateeverythinginthecurrentinputblock.ThisisnotpartofSun'sJDKsoIhavemadeitpackageprivate.ItisusedbyDeflaterOutputStreamtoimplementflush().

publicvoidFlush();

Deflater.FlushMethod

Getcurrentcompressionlevel

ReturnValueReturnsthecurrentcompressionlevel

Deflater.GetLevelMethod

Resetsthedeflater.Thedeflateractsafterwardsasifitwasjustcreatedwiththesamecompressionlevelandstrategyasithadbefore.

publicvoidReset();

Deflater.ResetMethod

Setsthedictionarywhichshouldbeusedinthedeflateprocess.Thiscallisequivalentto

OverloadListSetsthedictionarywhichshouldbeusedinthedeflateprocess.Thiscallisequivalentto

publicvoidSetDictionary(byte[]);

Setsthedictionarywhichshouldbeusedinthedeflateprocess.Thedictionaryisabytearraycontainingstringsthatarelikelytooccurinthedatawhichshouldbecompressed.Thedictionaryisnotstoredinthecompressedoutput,onlyachecksum.Todecompresstheoutputyouneedtosupplythesamedictionaryagain.

publicvoidSetDictionary(byte[],int,int);

Deflater.SetDictionaryMethod

Setsthedictionarywhichshouldbeusedinthedeflateprocess.Thiscallisequivalentto

publicvoidSetDictionary(

byte[]dict

Parametersdict

thedictionary.

ExceptionsExceptionType ConditionInvalidOperationException ifsetInput()ordeflate()were

alreadycalledoranotherdictionarywasalreadyset.

SeeAlsoDeflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Deflater.SetDictionaryOverloadList

Deflater.SetDictionaryMethod(Byte[])

Setsthedictionarywhichshouldbeusedinthedeflateprocess.Thedictionaryisabytearraycontainingstringsthatarelikelytooccurinthedatawhichshouldbecompressed.Thedictionaryisnotstoredinthecompressedoutput,onlyachecksum.Todecompresstheoutputyouneedtosupplythesamedictionaryagain.

byte[]dict,

intoffset,

intlength

Parametersdict

Thedictionarydata

offsetAnoffsetintothedictionary.

lengthThelengthofthedictionarydatatouse

ExceptionsExceptionType ConditionInvalidOperationException IfsetInput()ordeflate()were

alreadycalledoranotherdictionarywasalreadyset.

SeeAlsoDeflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Deflater.SetDictionaryOverloadList

Deflater.SetDictionaryMethod(Byte[],Int32,Int32)

Setsthedatawhichshouldbecompressednext.ThisshouldbeonlycalledwhenneedsInputindicatesthatmoreinputisneeded.IfyoucallsetInputwhenneedsInput()returnsfalse,thepreviousinputthatisstillpendingwillbethrownaway.Thegivenbytearrayshouldnotbechanged,beforeneedsInput()returnstrueagain.Thiscallisequivalentto

OverloadListSetsthedatawhichshouldbecompressednext.ThisshouldbeonlycalledwhenneedsInputindicatesthatmoreinputisneeded.IfyoucallsetInputwhenneedsInput()returnsfalse,thepreviousinputthatisstillpendingwillbethrownaway.Thegivenbytearrayshouldnotbechanged,beforeneedsInput()returnstrueagain.Thiscallisequivalentto

publicvoidSetInput(byte[]);

Setsthedatawhichshouldbecompressednext.ThisshouldbeonlycalledwhenneedsInputindicatesthatmoreinputisneeded.Thegivenbytearrayshouldnotbechanged,beforeneedsInput()returnstrueagain.

publicvoidSetInput(byte[],int,int);

Deflater.SetInputMethod

Setsthedatawhichshouldbecompressednext.ThisshouldbeonlycalledwhenneedsInputindicatesthatmoreinputisneeded.IfyoucallsetInputwhenneedsInput()returnsfalse,thepreviousinputthatisstillpendingwillbethrownaway.Thegivenbytearrayshouldnotbechanged,beforeneedsInput()returnstrueagain.Thiscallisequivalentto

publicvoidSetInput(

byte[]input

Parametersinput

thebuffercontainingtheinputdata.

ExceptionsExceptionType ConditionInvalidOperationException ifthebufferwasfinished()or

ended().

SeeAlsoDeflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Deflater.SetInputOverloadList

Deflater.SetInputMethod(Byte[])

Setsthedatawhichshouldbecompressednext.ThisshouldbeonlycalledwhenneedsInputindicatesthatmoreinputisneeded.Thegivenbytearrayshouldnotbechanged,beforeneedsInput()returnstrueagain.

publicvoidSetInput(

byte[]input,

intoff,

intlen

Parametersinput

thebuffercontainingtheinputdata.

offthestartofthedata.

lenthelengthofthedata.

ExceptionsExceptionType ConditionInvalidOperationException ifthebufferwasfinished()or

ended()orifpreviousinputisstillpending.

SeeAlsoDeflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Deflater.SetInputOverloadList

Deflater.SetInputMethod(Byte[],Int32,Int32)

Setsthecompressionlevel.Thereisnoguaranteeoftheexactpositionofthechange,butifyoucallthiswhenneedsInputistruethechangeofcompressionlevelwilloccursomewherenearbeforetheendofthesofargiveninput.

publicvoidSetLevel(

intlvl

Parameterslvl

thenewcompressionlevel.

Deflater.SetLevelMethod

Setsthecompressionstrategy.StrategyisoneofDEFAULT_STRATEGY,HUFFMAN_ONLYandFILTERED.Fortheexactpositionwherethestrategyischanged,thesameasforsetLevel()applies.

publicvoidSetStrategy(

DeflateStrategystrategy

Parametersstrategy

Thenewcompressionstrategy.

Deflater.SetStrategyMethod

Thisclasscontainsconstantsusedfordeflation.

Foralistofallmembersofthistype,seeDeflaterConstantsMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstantsICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine

publicclassDeflaterConstants

SeeAlsoDeflaterConstantsMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

DeflaterConstantsClass

DeflaterConstantsoverview

PublicStaticFieldsCOMPR_FUNC Internalcompressionengine

constant

DEBUGGING Settotruetoenabledebugging

DEFAULT_MEM_LEVEL SetsinternalbuffersizesforHuffmanencoding

DEFLATE_FAST Internalcompressionengineconstant

DEFLATE_SLOW Internalcompressionengineconstant

DEFLATE_STORED Internalcompressionengineconstant

DYN_TREES IdentifiesdynamictreeinZipfile

GOOD_LENGTH Internalcompressionengineconstant

HASH_BITS Internalcompressionengineconstant

HASH_MASK Internalcompressionengineconstant

HASH_SHIFT Internalcompressionengineconstant

HASH_SIZE Internalcompressionengineconstant

MAX_BLOCK_SIZE Internalcompressionengineconstant

MAX_CHAIN Internalcompressionengineconstant

MAX_DIST Internalcompressionengine

DeflaterConstantsMembers

constant

MAX_LAZY Internalcompressionengineconstant

MAX_MATCH Internalcompressionengineconstant

MAX_WBITS Internalcompressionengineconstant

MIN_LOOKAHEAD Internalcompressionengineconstant

MIN_MATCH Internalcompressionengineconstant

NICE_LENGTH Internalcompressionengineconstant

PENDING_BUF_SIZE Internalcompressionengineconstant

PRESET_DICT Headerflagindicatingapresetdictionaryfordeflation

STATIC_TREES IdentifiesstatictreeinZipfile

STORED_BLOCK WrittentoZipfiletoidentifyastoredblock

WMASK Internalcompressionengineconstant

WSIZE Internalcompressionengineconstant

PublicInstanceConstructorsDeflaterConstants

ConstructorInitializesanewinstanceoftheDeflaterConstantsclass.

specifiedObjectisequaltothe

currentObject.GetHashCode(inheritedfrom

Object)Servesasahashfunctionforaparticulartype,suitableforuseinhashingalgorithmsanddatastructureslikeahashtable.

SeeAlsoDeflaterConstantsClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

InitializesanewinstanceoftheDeflaterConstantsclass.

publicDeflaterConstants();

DeflaterConstantsConstructor

ThefieldsoftheDeflaterConstantsclassarelistedbelow.ForacompletelistofDeflaterConstantsclassmembers,seetheDeflaterConstantsMemberstopic.

PublicStaticFieldsCOMPR_FUNC Internalcompressionengine

constant

DEBUGGING Settotruetoenabledebugging

DEFAULT_MEM_LEVEL SetsinternalbuffersizesforHuffmanencoding

DEFLATE_FAST Internalcompressionengineconstant

DEFLATE_SLOW Internalcompressionengineconstant

DEFLATE_STORED Internalcompressionengineconstant

DYN_TREES IdentifiesdynamictreeinZipfile

GOOD_LENGTH Internalcompressionengineconstant

HASH_BITS Internalcompressionengineconstant

HASH_MASK Internalcompressionengineconstant

HASH_SHIFT Internalcompressionengineconstant

HASH_SIZE Internalcompressionengineconstant

MAX_BLOCK_SIZE Internalcompressionengineconstant

MAX_CHAIN Internalcompressionengine

DeflaterConstantsFields

constant

MAX_DIST Internalcompressionengineconstant

MAX_LAZY Internalcompressionengineconstant

MAX_MATCH Internalcompressionengineconstant

MAX_WBITS Internalcompressionengineconstant

MIN_LOOKAHEAD Internalcompressionengineconstant

MIN_MATCH Internalcompressionengineconstant

NICE_LENGTH Internalcompressionengineconstant

PENDING_BUF_SIZE Internalcompressionengineconstant

PRESET_DICT Headerflagindicatingapresetdictionaryfordeflation

STATIC_TREES IdentifiesstatictreeinZipfile

STORED_BLOCK WrittentoZipfiletoidentifyastoredblock

WMASK Internalcompressionengineconstant

WSIZE Internalcompressionengineconstant

Internalcompressionengineconstant

publicstaticint[]COMPR_FUNC;

DeflaterConstants.COMPR_FUNCField

Settotruetoenabledebugging

publicconstboolDEBUGGING=False;

DeflaterConstants.DEBUGGINGField

SetsinternalbuffersizesforHuffmanencoding

publicconstintDEFAULT_MEM_LEVEL=8;

DeflaterConstants.DEFAULT_MEM_LEVELField

publicconstintDEFLATE_FAST=1;

DeflaterConstants.DEFLATE_FASTField

publicconstintDEFLATE_SLOW=2;

DeflaterConstants.DEFLATE_SLOWField

publicconstintDEFLATE_STORED=0;

DeflaterConstants.DEFLATE_STOREDField

IdentifiesdynamictreeinZipfile

publicconstintDYN_TREES=2;

DeflaterConstants.DYN_TREESField

publicstaticint[]GOOD_LENGTH;

DeflaterConstants.GOOD_LENGTHField

publicconstintHASH_BITS=15;

DeflaterConstants.HASH_BITSField

publicconstintHASH_MASK=32767;

DeflaterConstants.HASH_MASKField

publicconstintHASH_SHIFT=5;

DeflaterConstants.HASH_SHIFTField

publicconstintHASH_SIZE=32768;

DeflaterConstants.HASH_SIZEField

publicstaticintMAX_BLOCK_SIZE;

DeflaterConstants.MAX_BLOCK_SIZEField

publicstaticint[]MAX_CHAIN;

DeflaterConstants.MAX_CHAINField

publicconstintMAX_DIST=32506;

DeflaterConstants.MAX_DISTField

publicstaticint[]MAX_LAZY;

DeflaterConstants.MAX_LAZYField

publicconstintMAX_MATCH=258;

DeflaterConstants.MAX_MATCHField

publicconstintMAX_WBITS=15;

DeflaterConstants.MAX_WBITSField

publicconstintMIN_LOOKAHEAD=262;

DeflaterConstants.MIN_LOOKAHEADField

publicconstintMIN_MATCH=3;

DeflaterConstants.MIN_MATCHField

publicstaticint[]NICE_LENGTH;

DeflaterConstants.NICE_LENGTHField

publicconstintPENDING_BUF_SIZE=65536;

DeflaterConstants.PENDING_BUF_SIZEField

Headerflagindicatingapresetdictionaryfordeflation

publicconstintPRESET_DICT=32;

DeflaterConstants.PRESET_DICTField

IdentifiesstatictreeinZipfile

publicconstintSTATIC_TREES=1;

DeflaterConstants.STATIC_TREESField

WrittentoZipfiletoidentifyastoredblock

publicconstintSTORED_BLOCK=0;

DeflaterConstants.STORED_BLOCKField

publicconstintWMASK=32767;

DeflaterConstants.WMASKField

publicconstintWSIZE=32768;

DeflaterConstants.WSIZEField

Lowlevelcompressionenginefordeflatealgorithmwhichusesa32KslidingwindowwithsecondarycompressionfromHuffman/Shannon-Fanocodes.

Foralistofallmembersofthistype,seeDeflaterEngineMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstantsICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine

publicclassDeflaterEngine:

DeflaterConstants

SeeAlsoDeflaterEngineMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

DeflaterEngineClass

DeflaterEngineoverview

PublicInstanceConstructorsDeflaterEngineConstructor Constructinstancewithpending

buffer

PublicInstancePropertiesAdler GetcurrentvalueofAdler

checksum

Strategy Get/setthedeflatestrategy

TotalIn Totaldataprocessed

PublicInstanceMethodsDeflate Deflatedrivesactual

compressionofdata

FillWindow Fillthewindow

NeedsInput ReturntrueifinputisneededviaSetInput

Reset Resetinternalstate

ResetAdler ResetAdlerchecksum

SetDictionary Setcompressiondictionary

DeflaterEngineMembers

SetInput Setsinputdatatobedeflated.Shouldonlybecalledwhen

NeedsInput()

returnstrue

SetLevel Setthedeflatelevel(0-9)

SeeAlsoDeflaterEngineClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

Constructinstancewithpendingbuffer

publicDeflaterEngine(

DeflaterPendingpending

Parameterspending

Pendingbuffertouse

DeflaterEngineConstructor

ThepropertiesoftheDeflaterEngineclassarelistedbelow.ForacompletelistofDeflaterEngineclassmembers,seetheDeflaterEngineMemberstopic.

PublicInstancePropertiesAdler GetcurrentvalueofAdler

checksum

Strategy Get/setthedeflatestrategy

TotalIn Totaldataprocessed

DeflaterEngineProperties

GetcurrentvalueofAdlerchecksum

DeflaterEngine.AdlerProperty

Get/setthedeflatestrategy

publicDeflateStrategyStrategy{get;set;}

DeflaterEngine.StrategyProperty

Totaldataprocessed

DeflaterEngine.TotalInProperty

ThemethodsoftheDeflaterEngineclassarelistedbelow.ForacompletelistofDeflaterEngineclassmembers,seetheDeflaterEngineMemberstopic.

PublicInstanceMethodsDeflate Deflatedrivesactual

compressionofdata

FillWindow Fillthewindow

NeedsInput ReturntrueifinputisneededviaSetInput

ResetAdler ResetAdlerchecksum

SetDictionary Setcompressiondictionary

SetInput Setsinputdatatobedeflated.Shouldonlybecalledwhen

NeedsInput()

returnstrue

SetLevel Setthedeflatelevel(0-9)

DeflaterEngineMethods

Deflatedrivesactualcompressionofdata

publicboolDeflate(

boolflush,

boolfinish

DeflaterEngine.DeflateMethod

Fillthewindow

publicvoidFillWindow();

DeflaterEngine.FillWindowMethod

ReturntrueifinputisneededviaSetInput

publicboolNeedsInput();

DeflaterEngine.NeedsInputMethod

Resetinternalstate

publicvoidReset();

DeflaterEngine.ResetMethod

ResetAdlerchecksum

publicvoidResetAdler();

DeflaterEngine.ResetAdlerMethod

Setcompressiondictionary

byte[]buffer,

intoffset,

intlength

DeflaterEngine.SetDictionaryMethod

Setsinputdatatobedeflated.Shouldonlybecalledwhen

NeedsInput()

returnstrue

publicvoidSetInput(

byte[]buf,

intoff,

intlen

Parametersbuf

Thebuffercontaininginputdata.

offTheindexofthefirstbyteofdata.

lenThenumberofbytesofdatatouseasinput.

DeflaterEngine.SetInputMethod

Setthedeflatelevel(0-9)

publicvoidSetLevel(

intlvl

DeflaterEngine.SetLevelMethod

ThisistheDeflaterHuffmanclass.Thisclassisnotthreadsafe.ThisisinherentintheAPI,duetothesplitofdeflateandsetInput.authoroftheoriginaljavaversion:JochenHoenicke

Foralistofallmembersofthistype,seeDeflaterHuffmanMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman

publicclassDeflaterHuffman

SeeAlsoDeflaterHuffmanMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

DeflaterHuffmanClass

DeflaterHuffmanoverview

PublicStaticMethodsBitReverse Reversethebitsofa16bit

value.

PublicInstanceConstructorsDeflaterHuffmanConstructor Constructinstancewithpending

buffer

PublicInstanceFieldspending Pendingbuffertouse

PublicInstanceMethodsCompressBlock Compresscurrentbufferwriting

datatopendingbuffer

FlushBlock Flushblocktooutputwithcompression

FlushStoredBlock Flushblocktooutputwithnocompression

IsFull Getvalueindicatingifinternalbufferisfull

DeflaterHuffmanMembers

SendAllTrees Writealltreestopendingbuffer

TallyDist Adddistancecodeandlengthtoliteralanddistancetrees

TallyLit Addliteraltobuffer

SeeAlsoDeflaterHuffmanClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

Constructinstancewithpendingbuffer

publicDeflaterHuffman(

DeflaterPendingpending

Parameterspending

Pendingbuffertouse

DeflaterHuffmanConstructor

ThefieldsoftheDeflaterHuffmanclassarelistedbelow.ForacompletelistofDeflaterHuffmanclassmembers,seetheDeflaterHuffmanMemberstopic.

PublicInstanceFieldspending Pendingbuffertouse

DeflaterHuffmanFields

Pendingbuffertouse

publicDeflaterPendingpending;

DeflaterHuffman.pendingField

ThemethodsoftheDeflaterHuffmanclassarelistedbelow.ForacompletelistofDeflaterHuffmanclassmembers,seetheDeflaterHuffmanMemberstopic.

PublicStaticMethodsBitReverse Reversethebitsofa16bit

value.

PublicInstanceMethodsCompressBlock Compresscurrentbufferwriting

datatopendingbuffer

FlushBlock Flushblocktooutputwithcompression

FlushStoredBlock Flushblocktooutputwithnocompression

IsFull Getvalueindicatingifinternalbufferisfull

SendAllTrees Writealltreestopendingbuffer

TallyDist Adddistancecodeandlengthtoliteralanddistancetrees

TallyLit Addliteraltobuffer

DeflaterHuffmanMethods

Reversethebitsofa16bitvalue.

publicstaticshortBitReverse(

inttoReverse

ParameterstoReverse

Valuetoreversebits

ReturnValueValuewithbitsreversed

DeflaterHuffman.BitReverseMethod

Compresscurrentbufferwritingdatatopendingbuffer

publicvoidCompressBlock();

DeflaterHuffman.CompressBlockMethod

Flushblocktooutputwithcompression

publicvoidFlushBlock(

byte[]stored,

intstoredOffset,

intstoredLength,

boollastBlock

Parametersstored

Datatoflush

storedOffsetIndexoffirstbytetoflush

storedLengthCountofbytestoflush

lastBlockTrueifthisisthelastblock

DeflaterHuffman.FlushBlockMethod

Flushblocktooutputwithnocompression

publicvoidFlushStoredBlock(

byte[]stored,

intstoredOffset,

intstoredLength,

boollastBlock

Parametersstored

Datatowrite

storedOffsetIndexoffirstbytetowrite

storedLengthCountofbytestowrite

lastBlockTrueifthisisthelastblock

DeflaterHuffman.FlushStoredBlockMethod

Getvalueindicatingifinternalbufferisfull

publicboolIsFull();

ReturnValuetrueifbufferisfull

DeflaterHuffman.IsFullMethod

Resetinternalstate

publicvoidReset();

DeflaterHuffman.ResetMethod

Writealltreestopendingbuffer

publicvoidSendAllTrees(

intblTreeCodes

DeflaterHuffman.SendAllTreesMethod

Adddistancecodeandlengthtoliteralanddistancetrees

publicboolTallyDist(

intdist,

intlen

Parametersdist

Distancecode

lenLength

ReturnValueValueindicatingifinternalbufferisfull

DeflaterHuffman.TallyDistMethod

Addliteraltobuffer

publicboolTallyLit(

intlit

Parameterslit

ReturnValueValueindicatinginternalbufferisfull

DeflaterHuffman.TallyLitMethod

Notdocumented

Foralistofallmembersofthistype,seeDeflaterHuffman.TreeMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree

publicclassDeflaterHuffman.Tree

SeeAlsoDeflaterHuffman.TreeMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

DeflaterHuffman.TreeClass

DeflaterHuffman.Treeoverview

PublicInstanceConstructorsDeflaterHuffman.Tree

ConstructorNotdocumented

PublicInstanceFieldsfreqs Notdocumented

length Notdocumented

minNumCodes Notdocumented

numCodes Notdocumented

PublicInstanceMethodsBuildCodes Builddynamiccodesand

lengths

BuildTree Notdocumented

CalcBLFreq Notdocumented

CheckEmpty Checkthatatleastonefrequencyisnon-zero

GetEncodedLength Getencodedlength

Reset Resetstheinternalstateofthe

DeflaterHuffman.TreeMembers

SetStaticCodes Setstaticcodesandlength

WriteSymbol Notdocumented

WriteTree Writetreevalues

SeeAlsoDeflaterHuffman.TreeClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

Notdocumented

publicDeflaterHuffman.Tree(

DeflaterHuffmandh,

intelems,

intminCodes,

intmaxLength

DeflaterHuffman.TreeConstructor

ThefieldsoftheDeflaterHuffman.Treeclassarelistedbelow.ForacompletelistofDeflaterHuffman.Treeclassmembers,seetheDeflaterHuffman.TreeMemberstopic.

PublicInstanceFieldsfreqs Notdocumented

length Notdocumented

minNumCodes Notdocumented

numCodes Notdocumented

DeflaterHuffman.TreeFields

Notdocumented

publicshort[]freqs;

DeflaterHuffman.Tree.freqsField

Notdocumented

publicbyte[]length;

DeflaterHuffman.Tree.lengthField

Notdocumented

publicintminNumCodes;

DeflaterHuffman.Tree.minNumCodesField

Notdocumented

publicintnumCodes;

DeflaterHuffman.Tree.numCodesField

ThemethodsoftheDeflaterHuffman.Treeclassarelistedbelow.ForacompletelistofDeflaterHuffman.Treeclassmembers,seetheDeflaterHuffman.TreeMemberstopic.

PublicInstanceMethodsBuildCodes Builddynamiccodesand

lengths

BuildTree Notdocumented

CalcBLFreq Notdocumented

CheckEmpty Checkthatatleastonefrequencyisnon-zero

GetEncodedLength Getencodedlength

Reset Resetstheinternalstateofthetree

SetStaticCodes Setstaticcodesandlength

WriteSymbol Notdocumented

WriteTree Writetreevalues

DeflaterHuffman.TreeMethods

Builddynamiccodesandlengths

publicvoidBuildCodes();

DeflaterHuffman.Tree.BuildCodesMethod

Notdocumented

publicvoidBuildTree();

DeflaterHuffman.Tree.BuildTreeMethod

Notdocumented

publicvoidCalcBLFreq(

TreeblTree

DeflaterHuffman.Tree.CalcBLFreqMethod

Checkthatatleastonefrequencyisnon-zero

publicvoidCheckEmpty();

ExceptionsExceptionType ConditionSharpZipBaseException Nofrequenciesarenon-zero

DeflaterHuffman.Tree.CheckEmptyMethod

Getencodedlength

publicintGetEncodedLength();

ReturnValueEncodedlength,thesumoffrequencies*lengths

DeflaterHuffman.Tree.GetEncodedLengthMethod

Resetstheinternalstateofthetree

publicvoidReset();

DeflaterHuffman.Tree.ResetMethod

Setstaticcodesandlength

publicvoidSetStaticCodes(

short[]stCodes,

byte[]stLength

ParametersstCodes

newcodes

stLengthlengthfornewcodes

DeflaterHuffman.Tree.SetStaticCodesMethod

Notdocumented

publicvoidWriteSymbol(

intcode

DeflaterHuffman.Tree.WriteSymbolMethod

Writetreevalues

publicvoidWriteTree(

TreeblTree

ParametersblTree

Treetowrite

DeflaterHuffman.Tree.WriteTreeMethod

ThisclassstoresthependingoutputoftheDeflater.authoroftheoriginaljavaversion:JochenHoenicke

Foralistofallmembersofthistype,seeDeflaterPendingMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.PendingBufferICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending

publicclassDeflaterPending:

PendingBuffer

SeeAlsoDeflaterPendingMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

DeflaterPendingClass

DeflaterPendingoverview

PublicInstanceConstructorsDeflaterPendingConstructor Constructinstancewithdefault

buffersize

PublicInstancePropertiesBitCount(inheritedfrom

PendingBuffer)Thenumberofbitswrittentothebuffer

IsFlushed(inheritedfromPendingBuffer)

Indicatesifbufferhasbeenflushed

PublicInstanceMethodsAlignToByte(inheritedfrom

PendingBuffer)Aligninternalbufferonabyteboundary

Flush(inheritedfromPendingBuffer)

Flushesthependingbufferintothegivenoutputarray.Iftheoutputarrayistosmall,onlyapartialflushisdone.

Reset(inheritedfromPendingBuffer)

Clearinternalstate/buffers

ToByteArray(inheritedfromPendingBuffer)

Convertinternalbuffertobytearray.Bufferisemptyon

DeflaterPendingMembers

completion

WriteBits(inheritedfromPendingBuffer)

Writebitstointernalbuffer

WriteBlock(inheritedfromPendingBuffer)

Writeablockofdatatobuffer

WriteByte(inheritedfromPendingBuffer)

writeabytetobuffer

WriteInt(inheritedfromPendingBuffer)

writeanintegerLSBfirst

WriteShort(inheritedfromPendingBuffer)

WriteashortvaluetobufferLSBfirst

WriteShortMSB(inheritedfromPendingBuffer)

Writeashortvaluetointernalbuffermostsignificantbytefirst

ProtectedInstanceFieldsbuf(inheritedfrom

PendingBuffer)Internalworkbuffer

SeeAlsoDeflaterPendingClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

Constructinstancewithdefaultbuffersize

publicDeflaterPending();

SeeAlsoDeflaterPendingClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

DeflaterPendingConstructor

Strategiesfordeflater

publicenumDeflateStrategy

MembersMemberName DescriptionDefault Thedefaultstrategy

Filtered Thisstrategywillonlyallowlongerstringrepetitions.Itisusefulforrandomdatawithasmallcharacterset.

HuffmanOnly Thisstrategywillnotlookforstringrepetitionsatall.ItonlyencodeswithHuffmantrees(whichmeans,thatmorecommoncharactersgetasmallerencoding.

SeeAlsoICSharpCode.SharpZipLib.Zip.CompressionNamespace

DeflateStrategyEnumeration

Inflaterisusedtodecompressdatathathasbeencompressedaccordingtothe"deflate"standarddescribedinrfc1951.BydefaultZlib(rfc1950)headersandfootersareexpectedintheinput.Youcanuseconstructor

publicInflater(boolnoHeader)

passingtrueifthereisnoZlibheaderinformationTheusageisasfollowing.Firstyouhavetosetsomeinputwith

setInput()

,theninflate()it.Ifinflatedoesn'tinflateanybytestheremaybethreereasons:

needsInput()returnstruebecausetheinputbufferisempty.Youhavetoprovidemoreinputwith

setInput()

.NOTE:needsInput()alsoreturnstruewhen,thestreamisfinished.

needsDictionary()returnstrue,youhavetoprovideapresetdictionarywith

setDictionary()

finished()returnstrue,theinflaterhasfinished.

Oncethefirstoutputbyteisproduced,adictionarywillnotbeneededatalaterstage.authoroftheoriginaljavaversion:JohnLeuner,JochenHoenicke

Foralistofallmembersofthistype,seeInflaterMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.Inflater

publicclassInflater

InflaterClass

SeeAlsoInflaterMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

Inflateroverview

PublicInstanceConstructorsInflater Overloaded.Initializesanew

instanceoftheInflaterclass.

PublicInstancePropertiesAdler Getstheadlerchecksum.This

iseitherthechecksumofalluncompressedbytesreturnedbyinflate(),orifneedsDictionary()returnstrue(andthusnooutputwasyetproduced)thisistheadlerchecksumoftheexpecteddictionary.

IsFinished Returnstrue,iftheinflaterhasfinished.Thismeans,thatnoinputisneededandnooutputcanbeproduced.

IsNeedingDictionary Returnstrue,ifapresetdictionaryisneededtoinflatetheinput.

IsNeedingInput Returnstrue,iftheinputbufferisempty.YoushouldthencallsetInput().NOTE:Thismethodalsoreturnstruewhenthestreamisfinished.

RemainingInput Getsthenumberofunprocessedinputbytes.Useful,iftheendofthestreamisreachedandyouwanttofurtherprocessthebytesafterthedeflatestream.

InflaterMembers

TotalIn Getsthetotalnumberofprocessedcompressedinputbytes.

TotalOut Getsthetotalnumberofoutputbytesreturnedbyinflate().

Inflate Overloaded.Inflatesthecompressedstreamtotheoutputbuffer.Ifthisreturns0,youshouldcheck,whetherneedsDictionary(),needsInput()orfinished()returnstrue,todeterminewhynofurtheroutputisproduced.

Reset Resetstheinflatersothatanewstreamcanbedecompressed.Allpendinginputandoutputwillbediscarded.

SetDictionary Overloaded.Setsthepresetdictionary.Thisshouldonlybecalled,ifneedsDictionary()returnstrueanditshouldsetthesamedictionary,thatwasusedfordeflating.ThegetAdler()functionreturnsthechecksum

ofthedictionaryneeded.

SetInput Overloaded.Setstheinput.Thisshouldonlybecalled,ifneedsInput()returnstrue.

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

CreatesanewinflaterorRFC1951decompressorRFC1950/Zlibheadersandfooterswillbeexpectedintheinputdata

OverloadListCreatesanewinflaterorRFC1951decompressorRFC1950/Zlibheadersandfooterswillbeexpectedintheinputdata

publicInflater();

Createsanewinflater.

publicInflater(bool);

InflaterConstructor

CreatesanewinflaterorRFC1951decompressorRFC1950/Zlibheadersandfooterswillbeexpectedintheinputdata

publicInflater();

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|InflaterConstructorOverloadList

InflaterConstructor()

Createsanewinflater.

publicInflater(

boolnoHeader

ParametersnoHeader

TrueifnoRFC1950/ZlibheaderandfooterfieldsareexpectedintheinputdataThisisusedforGZIPed/Zippedinput.ForcompatibilitywithSunJDKyoushouldprovideonebyteofinputmorethanneededinthiscase.

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|InflaterConstructorOverloadList

InflaterConstructor(Boolean)

ThepropertiesoftheInflaterclassarelistedbelow.ForacompletelistofInflaterclassmembers,seetheInflaterMemberstopic.

PublicInstancePropertiesAdler Getstheadlerchecksum.This

iseitherthechecksumofalluncompressedbytesreturnedbyinflate(),orifneedsDictionary()returnstrue(andthusnooutputwasyetproduced)thisistheadlerchecksumoftheexpecteddictionary.

IsFinished Returnstrue,iftheinflaterhasfinished.Thismeans,thatnoinputisneededandnooutputcanbeproduced.

IsNeedingDictionary Returnstrue,ifapresetdictionaryisneededtoinflatetheinput.

IsNeedingInput Returnstrue,iftheinputbufferisempty.YoushouldthencallsetInput().NOTE:Thismethodalsoreturnstruewhenthestreamisfinished.

RemainingInput Getsthenumberofunprocessedinputbytes.Useful,iftheendofthestreamisreachedandyouwanttofurtherprocessthebytesafterthedeflatestream.

TotalIn Getsthetotalnumberofprocessedcompressedinputbytes.

InflaterProperties

TotalOut Getsthetotalnumberofoutputbytesreturnedbyinflate().

Getstheadlerchecksum.Thisiseitherthechecksumofalluncompressedbytesreturnedbyinflate(),orifneedsDictionary()returnstrue(andthusnooutputwasyetproduced)thisistheadlerchecksumoftheexpecteddictionary.

Inflater.AdlerProperty

Returnstrue,iftheinflaterhasfinished.Thismeans,thatnoinputisneededandnooutputcanbeproduced.

Inflater.IsFinishedProperty

Returnstrue,ifapresetdictionaryisneededtoinflatetheinput.

publicboolIsNeedingDictionary{get;}

Inflater.IsNeedingDictionaryProperty

Returnstrue,iftheinputbufferisempty.YoushouldthencallsetInput().NOTE:Thismethodalsoreturnstruewhenthestreamisfinished.

Inflater.IsNeedingInputProperty

Getsthenumberofunprocessedinputbytes.Useful,iftheendofthestreamisreachedandyouwanttofurtherprocessthebytesafterthedeflatestream.

publicintRemainingInput{get;}

Inflater.RemainingInputProperty

Getsthetotalnumberofprocessedcompressedinputbytes.

Inflater.TotalInProperty

Getsthetotalnumberofoutputbytesreturnedbyinflate().

publicintTotalOut{get;}

Inflater.TotalOutProperty

ThemethodsoftheInflaterclassarelistedbelow.ForacompletelistofInflaterclassmembers,seetheInflaterMemberstopic.

Inflate Overloaded.Inflatesthecompressedstreamtotheoutputbuffer.Ifthisreturns0,youshouldcheck,whetherneedsDictionary(),needsInput()orfinished()returnstrue,todeterminewhynofurtheroutputisproduced.

Reset Resetstheinflatersothatanewstreamcanbedecompressed.Allpendinginputandoutputwillbediscarded.

SetDictionary Overloaded.Setsthepresetdictionary.Thisshouldonlybecalled,ifneedsDictionary()returnstrueanditshouldsetthesamedictionary,thatwasusedfordeflating.ThegetAdler()functionreturnsthechecksumofthedictionaryneeded.

InflaterMethods

SetInput Overloaded.Setstheinput.Thisshouldonlybecalled,ifneedsInput()returnstrue.

Inflatesthecompressedstreamtotheoutputbuffer.Ifthisreturns0,youshouldcheck,whetherneedsDictionary(),needsInput()orfinished()returnstrue,todeterminewhynofurtheroutputisproduced.

OverloadListInflatesthecompressedstreamtotheoutputbuffer.Ifthisreturns0,youshouldcheck,whetherneedsDictionary(),needsInput()orfinished()returnstrue,todeterminewhynofurtheroutputisproduced.

publicintInflate(byte[]);

publicintInflate(byte[],int,int);

Inflater.InflateMethod

publicintInflate(

byte[]buf

Parametersbuf

theoutputbuffer.

ReturnValuethenumberofbyteswrittentothebuffer,0ifnofurtheroutputcanbeproduced.

ExceptionsExceptionType ConditionArgumentOutOfRangeException ifbufhaslength0.

FormatException ifdeflatedstreamisinvalid.

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Inflater.InflateOverloadList

Inflater.InflateMethod(Byte[])

publicintInflate(

byte[]buf,

intoffset,

intlen

Parametersbuf

theoutputbuffer.

offsettheoffsetintobufferwheretheoutputshouldstart.

lenthemaximumlengthoftheoutput.

ReturnValuethenumberofbyteswrittentothebuffer,0ifnofurtheroutputcanbeproduced.

ExceptionsExceptionType ConditionArgumentOutOfRangeException iflenis<=0.

ArgumentOutOfRangeException iftheoffsetand/orlenarewrong.

FormatException ifdeflatedstreamisinvalid.

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.Compression

Inflater.InflateMethod(Byte[],Int32,Int32)

Namespace|Inflater.InflateOverloadList

Resetstheinflatersothatanewstreamcanbedecompressed.Allpendinginputandoutputwillbediscarded.

publicvoidReset();

Inflater.ResetMethod

Setsthepresetdictionary.Thisshouldonlybecalled,ifneedsDictionary()returnstrueanditshouldsetthesamedictionary,thatwasusedfordeflating.ThegetAdler()functionreturnsthechecksumofthedictionaryneeded.

OverloadListSetsthepresetdictionary.Thisshouldonlybecalled,ifneedsDictionary()returnstrueanditshouldsetthesamedictionary,thatwasusedfordeflating.ThegetAdler()functionreturnsthechecksumofthedictionaryneeded.

publicvoidSetDictionary(byte[]);

publicvoidSetDictionary(byte[],int,int);

Inflater.SetDictionaryMethod

byte[]buffer

Parametersbuffer

Thedictionary.

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Inflater.SetDictionaryOverloadList

Inflater.SetDictionaryMethod(Byte[])

byte[]buffer,

intoffset,

intlen

Parametersbuffer

Thedictionary.

offsetTheoffsetintobufferwherethedictionarystarts.

lenThelengthofthedictionary.

ExceptionsExceptionType ConditionInvalidOperationException Nodictionaryisneeded.

SharpZipBaseException Theadlerchecksumforthebufferisinvalid

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Inflater.SetDictionaryOverloadList

Inflater.SetDictionaryMethod(Byte[],Int32,Int32)

Setstheinput.Thisshouldonlybecalled,ifneedsInput()returnstrue.

OverloadListSetstheinput.Thisshouldonlybecalled,ifneedsInput()returnstrue.

publicvoidSetInput(byte[]);

publicvoidSetInput(byte[],int,int);

Inflater.SetInputMethod

publicvoidSetInput(

byte[]buf

Parametersbuf

theinput.

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Inflater.SetInputOverloadList

Inflater.SetInputMethod(Byte[])

publicvoidSetInput(

byte[]buffer,

intoffset,

intlength

Parametersbuffer

Thesourceofinputdata

offsetTheoffsetintobufferwheretheinputstarts.

lengthThenumberofbytesofinputtouse.

ExceptionsExceptionType ConditionInvalidOperationException Noinputisneeded.

ArgumentOutOfRangeException Theoffand/orlenarewrong.

SeeAlsoInflaterClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|Inflater.SetInputOverloadList

Inflater.SetInputMethod(Byte[],Int32,Int32)

Huffmantreeusedforinflation

Foralistofallmembersofthistype,seeInflaterHuffmanTreeMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree

publicclassInflaterHuffmanTree

SeeAlsoInflaterHuffmanTreeMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

InflaterHuffmanTreeClass

InflaterHuffmanTreeoverview

PublicStaticFieldsdefDistTree Distancetree

defLitLenTree Literallengthtree

PublicInstanceConstructorsInflaterHuffmanTree

ConstructorConstructsaHuffmantreefromthearrayofcodelengths.

GetSymbol Readsthenextsymbolfrominput.Thesymbolisencodedusingthehuffmantree.

InflaterHuffmanTreeMembers

SeeAlsoInflaterHuffmanTreeClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

ConstructsaHuffmantreefromthearrayofcodelengths.

publicInflaterHuffmanTree(

byte[]codeLengths

ParameterscodeLengths

thearrayofcodelengths

InflaterHuffmanTreeConstructor

ThefieldsoftheInflaterHuffmanTreeclassarelistedbelow.ForacompletelistofInflaterHuffmanTreeclassmembers,seetheInflaterHuffmanTreeMemberstopic.

PublicStaticFieldsdefDistTree Distancetree

defLitLenTree Literallengthtree

InflaterHuffmanTreeFields

Distancetree

publicstaticInflaterHuffmanTreedefDistTree;

InflaterHuffmanTree.defDistTreeField

Literallengthtree

publicstaticInflaterHuffmanTreedefLitLenTree;

InflaterHuffmanTree.defLitLenTreeField

ThemethodsoftheInflaterHuffmanTreeclassarelistedbelow.ForacompletelistofInflaterHuffmanTreeclassmembers,seetheInflaterHuffmanTreeMemberstopic.

GetSymbol Readsthenextsymbolfrominput.Thesymbolisencodedusingthehuffmantree.

InflaterHuffmanTreeMethods

Readsthenextsymbolfrominput.Thesymbolisencodedusingthehuffmantree.

publicintGetSymbol(

StreamManipulatorinput

Parametersinput

inputtheinputsource.

ReturnValuethenextsymbol,or-1ifnotenoughinputisavailable.

InflaterHuffmanTree.GetSymbolMethod

Thisclassisgeneralpurposeclassforwritingdatatoabuffer.ItallowsyoutowritebitsaswellasbytesBasedonDeflaterPending.javaauthoroftheoriginaljavaversion:JochenHoenicke

Foralistofallmembersofthistype,seePendingBufferMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.PendingBufferICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending

publicclassPendingBuffer

SeeAlsoPendingBufferMembers|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

PendingBufferClass

PendingBufferoverview

PublicInstanceConstructorsPendingBuffer Overloaded.Initializesanew

instanceofthePendingBufferclass.

PublicInstancePropertiesBitCount Thenumberofbitswrittentothe

buffer

IsFlushed Indicatesifbufferhasbeenflushed

PublicInstanceMethodsAlignToByte Aligninternalbufferonabyte

boundary

Flush Flushesthependingbufferintothegivenoutputarray.Iftheoutputarrayistosmall,onlyapartialflushisdone.

Reset Clearinternalstate/buffers

ToByteArray Convertinternalbuffertobytearray.Bufferisemptyon

PendingBufferMembers

completion

WriteBits Writebitstointernalbuffer

WriteBlock Writeablockofdatatobuffer

WriteByte writeabytetobuffer

WriteInt writeanintegerLSBfirst

WriteShort WriteashortvaluetobufferLSBfirst

WriteShortMSB Writeashortvaluetointernalbuffermostsignificantbytefirst

ProtectedInstanceFieldsbuf Internalworkbuffer

SeeAlsoPendingBufferClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace

constructinstanceusingdefaultbuffersizeof4096

OverloadListconstructinstanceusingdefaultbuffersizeof4096

publicPendingBuffer();

constructinstanceusingspecifiedbuffersize

publicPendingBuffer(int);

PendingBufferConstructor

constructinstanceusingdefaultbuffersizeof4096

publicPendingBuffer();

SeeAlsoPendingBufferClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|PendingBufferConstructorOverloadList

PendingBufferConstructor()

constructinstanceusingspecifiedbuffersize

publicPendingBuffer(

intbufsize

Parametersbufsize

sizetouseforinternalbuffer

SeeAlsoPendingBufferClass|ICSharpCode.SharpZipLib.Zip.CompressionNamespace|PendingBufferConstructorOverloadList

PendingBufferConstructor(Int32)

ThefieldsofthePendingBufferclassarelistedbelow.ForacompletelistofPendingBufferclassmembers,seethePendingBufferMemberstopic.

ProtectedInstanceFieldsbuf Internalworkbuffer

PendingBufferFields

Internalworkbuffer

protectedbyte[]buf;

PendingBuffer.bufField

ThepropertiesofthePendingBufferclassarelistedbelow.ForacompletelistofPendingBufferclassmembers,seethePendingBufferMemberstopic.

PublicInstancePropertiesBitCount Thenumberofbitswrittentothe

buffer

IsFlushed Indicatesifbufferhasbeenflushed

PendingBufferProperties

Thenumberofbitswrittentothebuffer

publicintBitCount{get;}

PendingBuffer.BitCountProperty

Indicatesifbufferhasbeenflushed

publicboolIsFlushed{get;}

PendingBuffer.IsFlushedProperty

ThemethodsofthePendingBufferclassarelistedbelow.ForacompletelistofPendingBufferclassmembers,seethePendingBufferMemberstopic.

PublicInstanceMethodsAlignToByte Aligninternalbufferonabyte

boundary

Flush Flushesthependingbufferintothegivenoutputarray.Iftheoutputarrayistosmall,onlyapartialflushisdone.

Reset Clearinternalstate/buffers

ToByteArray Convertinternalbuffertobytearray.Bufferisemptyoncompletion

WriteBits Writebitstointernalbuffer

WriteBlock Writeablockofdatatobuffer

WriteByte writeabytetobuffer

WriteInt writeanintegerLSBfirst

PendingBufferMethods

WriteShort WriteashortvaluetobufferLSBfirst

WriteShortMSB Writeashortvaluetointernalbuffermostsignificantbytefirst

Aligninternalbufferonabyteboundary

publicvoidAlignToByte();

PendingBuffer.AlignToByteMethod

Flushesthependingbufferintothegivenoutputarray.Iftheoutputarrayistosmall,onlyapartialflushisdone.

publicintFlush(

byte[]output,

intoffset,

intlength

Parametersoutput

theoutputarray;

offsettheoffsetintooutputarray;

lengthlengththemaximumnumberofbytestostore;

IndexOutOfBoundsExceptionifoffsetorlengthareinvalid.

PendingBuffer.FlushMethod

Clearinternalstate/buffers

publicvoidReset();

PendingBuffer.ResetMethod

Convertinternalbuffertobytearray.Bufferisemptyoncompletion

publicbyte[]ToByteArray();

ReturnValueconvertedbuffercontentscontents

PendingBuffer.ToByteArrayMethod

Writebitstointernalbuffer

publicvoidWriteBits(

intcount

Parametersb

sourceofbits

countnumberofbitstowrite

PendingBuffer.WriteBitsMethod

Writeablockofdatatobuffer

byte[]block,

intoffset,

intlen

Parametersblock

datatowrite

offsetoffsetoffirstbytetowrite

lennumberofbytestowrite

PendingBuffer.WriteBlockMethod

writeabytetobuffer

publicvoidWriteByte(

Parametersb

valuetowrite

PendingBuffer.WriteByteMethod

writeanintegerLSBfirst

publicvoidWriteInt(

Parameterss

valuetowrite

PendingBuffer.WriteIntMethod

WriteashortvaluetobufferLSBfirst

publicvoidWriteShort(

Parameterss

valuetowrite

PendingBuffer.WriteShortMethod

Writeashortvaluetointernalbuffermostsignificantbytefirst

publicvoidWriteShortMSB(

Parameterss

valuetowrite

PendingBuffer.WriteShortMSBMethod

Namespacehierarchy

ClassesClass DescriptionDeflaterOutputStream Aspecialstreamdeflatingor

compressingthebytesthatarewrittentoit.ItusesaDeflatertoperformactualdeflating.Authorsoftheoriginaljavaversion:TomTromey,JochenHoenicke

InflaterInputBuffer AninputbuffercustomisedforusebyInflaterInputStream

InflaterInputStream Thisfilterstreamisusedtodecompressdatacompressedusingthe"deflate"format.The"deflate"formatisdescribedinRFC1951.Thisstreammayformthebasisforotherdecompressionfilters,suchastheGZipInputStream.Authoroftheoriginaljavaversion:JohnLeuner.

OutputWindow ContainstheoutputfromtheInflationprocess.Weneedtohaveawindowsothatwecanreferbackwardsintotheoutputstreamtorepeatstuff.Authoroftheoriginaljavaversion:JohnLeuner

StreamManipulator Thisclassallowsustoretrieveaspecifiednumberofbitsfrom

ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

theinputbuffer,aswellascopybigbyteblocks.Itusesanintbuffertostoreupto31bitsfordirectmanipulation.Thisguaranteesthatwecangetatleast16bits,butweonlyneedatmost15,sothisisallsafe.Therearesomeoptimizationsinthisclass,forexample,youmustneverpeekmorethan8bitsmorethanneeded,andyoumustfirstpeekbitsbeforeyoumaydropthem.ThisisnotageneralpurposeclassbutoptimizedforthebehaviouroftheInflater.authorsoftheoriginaljavaversion:JohnLeuner,JochenHoenicke

Aspecialstreamdeflatingorcompressingthebytesthatarewrittentoit.ItusesaDeflatertoperformactualdeflating.Authorsoftheoriginaljavaversion:TomTromey,JochenHoenicke

Foralistofallmembersofthistype,seeDeflaterOutputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStreamICSharpCode.SharpZipLib.GZip.GZipOutputStreamICSharpCode.SharpZipLib.Zip.ZipOutputStream

publicclassDeflaterOutputStream:Stream

RequirementsNamespace:ICSharpCode.SharpZipLib.Zip.Compression.StreamsAssembly:ICSharpCode.SharpZipLib(inICSharpCode.SharpZipLib.dll)

SeeAlsoDeflaterOutputStreamMembers|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

DeflaterOutputStreamClass

DeflaterOutputStreamoverview

PublicInstanceConstructorsDeflaterOutputStream Overloaded.Initializesanew

instanceoftheDeflaterOutputStreamclass.

PublicInstanceProperties

CanPatchEntriesAllowsclienttodetermineifanentrycanbepatchedafteritsadded

CanRead Getsvalueindicatingstreamcanbereadfrom

CanSeek GetsavalueindicatingifseekingissupportedforthisstreamThispropertyalwaysreturnsfalse

CanWrite Getvalueindicatingifthisstreamsupportswriting

IsStreamOwnerGet/setflagindicatingownershipofunderlyingstream.WhentheflagistrueClosewillclosetheunderlyingstreamalso.

Length Getcurrentlengthofstream

Password Get/setthepasswordusedforencryption.Whennullnoencryptionisperformed

Position Thecurrentpositionwithinthestream.AlwaysthrowsaNotSupportedExceptionNotSupportedException

PublicInstanceMethodsBeginRead Asynchronousreadsarenot

supportedaNotSupportedExceptionisalwaysthrown

DeflaterOutputStreamMembers

BeginWrite Asynchronouswritesarentsupported,aNotSupportedExceptionisalwaysthrown

Close Callsfinish()andclosestheunderlyingstreamwhenIsStreamOwneristrue.

Finish Finishesthestreambycallingfinish()onthedeflater.

Flush Flushesthestreambycallingflush()onthedeflaterandthenontheunderlyingstream.Thisensuresthatallbytesareflushed.

Object) instance.

Read Readablockofbytesfromstream

ReadByte Readabytefromstreamadvancingpositionbyone

Seek Setsthecurrentpositionofthisstreamtothegivenvalue.Notsupportedbythisclass!

SetLength Setsthelengthofthisstreamtothegivenvalue.Notsupportedbythisclass!

Write Writesbytesfromanarraytothecompressedstream.

WriteByte Writesasinglebytetothecompressedoutputstream.

ProtectedInstanceFieldsbaseOutputStream Basestreamthedeflater

dependson.

buf Thisbufferisusedtemporarilytoretrievethebytesfromthedeflaterandwritethemtotheunderlyingoutputstream.

def Thedeflaterwhichisusedtodeflatethestream.

ProtectedInstanceMethodsCreateWaitHandle(inherited AllocatesaWaitHandleobject.

fromStream)

Deflate Deflateseverythingintheinputbuffers.Thiswillcall

def.deflate()

EncryptBlock Encryptablockofdata

EncryptByte Encryptasinglebyte

InitializePassword Initializesencryptionkeysbasedongivenpassword

UpdateKeys Updateencryptionkeys

SeeAlsoDeflaterOutputStreamClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

CreatesanewDeflaterOutputStreamwithadefaultDeflateranddefaultbuffersize.

OverloadListCreatesanewDeflaterOutputStreamwithadefaultDeflateranddefaultbuffersize.

publicDeflaterOutputStream(Stream);

CreatesanewDeflaterOutputStreamwiththegivenDeflateranddefaultbuffersize.

publicDeflaterOutputStream(Stream,Deflater);

CreatesanewDeflaterOutputStreamwiththegivenDeflaterandbuffersize.

publicDeflaterOutputStream(Stream,Deflater,int);

DeflaterOutputStreamConstructor

CreatesanewDeflaterOutputStreamwithadefaultDeflateranddefaultbuffersize.

publicDeflaterOutputStream(

theoutputstreamwheredeflatedoutputshouldbewritten.

SeeAlsoDeflaterOutputStreamClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace|DeflaterOutputStreamConstructorOverloadList

DeflaterOutputStreamConstructor(Stream)

CreatesanewDeflaterOutputStreamwiththegivenDeflateranddefaultbuffersize.

Deflaterdefl

theoutputstreamwheredeflatedoutputshouldbewritten.

defltheunderlyingdeflater.

DeflaterOutputStreamConstructor(Stream,Deflater)

CreatesanewDeflaterOutputStreamwiththegivenDeflaterandbuffersize.

Deflaterdeflater,

intbufsize

Theoutputstreamwheredeflatedoutputiswritten.

deflaterTheunderlyingdeflatertouse

bufsizeThebuffersizetousewhendeflating

ExceptionsExceptionType ConditionArgumentOutOfRangeException bufsizeislessthanorequalto

ArgumentException baseOutputStreamdoesnotsupportwriting

ArgumentNullException deflaterinstanceisnull

DeflaterOutputStreamConstructor(Stream,Deflater,Int32)

ThefieldsoftheDeflaterOutputStreamclassarelistedbelow.ForacompletelistofDeflaterOutputStreamclassmembers,seetheDeflaterOutputStreamMemberstopic.

ProtectedInstanceFieldsbaseOutputStream Basestreamthedeflater

dependson.

buf Thisbufferisusedtemporarilytoretrievethebytesfromthedeflaterandwritethemtotheunderlyingoutputstream.

def Thedeflaterwhichisusedtodeflatethestream.

DeflaterOutputStreamFields

Basestreamthedeflaterdependson.

protectedStreambaseOutputStream;

DeflaterOutputStream.baseOutputStreamField

protectedbyte[]buf;

DeflaterOutputStream.bufField

protectedDeflaterdef;

DeflaterOutputStream.defField

ThepropertiesoftheDeflaterOutputStreamclassarelistedbelow.ForacompletelistofDeflaterOutputStreamclassmembers,seetheDeflaterOutputStreamMemberstopic.

PublicInstanceProperties

CanPatchEntriesAllowsclienttodetermineifanentrycanbepatchedafteritsadded

CanRead Getsvalueindicatingstreamcanbereadfrom

CanSeek GetsavalueindicatingifseekingissupportedforthisstreamThispropertyalwaysreturnsfalse

CanWrite Getvalueindicatingifthisstreamsupportswriting

IsStreamOwnerGet/setflagindicatingownershipofunderlyingstream.WhentheflagistrueClosewillclosetheunderlyingstreamalso.

Length Getcurrentlengthofstream

Password Get/setthepasswordusedforencryption.Whennullnoencryptionisperformed

Position Thecurrentpositionwithinthestream.AlwaysthrowsaNotSupportedExceptionNotSupportedException

DeflaterOutputStreamProperties

publicboolCanPatchEntries{get;}

DeflaterOutputStream.CanPatchEntriesProperty

DeflaterOutputStream.CanReadProperty

DeflaterOutputStream.CanSeekProperty

DeflaterOutputStream.CanWriteProperty

publicboolIsStreamOwner{get;set;}

DeflaterOutputStream.IsStreamOwnerProperty

DeflaterOutputStream.LengthProperty

publicstringPassword{get;set;}

DeflaterOutputStream.PasswordProperty

ExceptionsExceptionType ConditionNotSupportedException Anyattempttosetposition

DeflaterOutputStream.PositionProperty

ThemethodsoftheDeflaterOutputStreamclassarelistedbelow.ForacompletelistofDeflaterOutputStreamclassmembers,seetheDeflaterOutputStreamMemberstopic.

PublicInstanceMethodsBeginRead Asynchronousreadsarenot

supportedaNotSupportedExceptionisalwaysthrown

BeginWrite Asynchronouswritesarentsupported,aNotSupportedExceptionisalwaysthrown

Close Callsfinish()andclosestheunderlyingstreamwhenIsStreamOwneristrue.

Finish Finishesthestreambycallingfinish()onthedeflater.

Flush Flushesthestreambycallingflush()onthedeflaterandthen

DeflaterOutputStreamMethods

ontheunderlyingstream.Thisensuresthatallbytesareflushed.

Read Readablockofbytesfromstream

ReadByte Readabytefromstreamadvancingpositionbyone

Seek Setsthecurrentpositionofthisstreamtothegivenvalue.Notsupportedbythisclass!

SetLength Setsthelengthofthisstreamtothegivenvalue.Notsupportedbythisclass!

Write Writesbytesfromanarraytothecompressedstream.

WriteByte Writesasinglebytetothecompressedoutputstream.

CreateWaitHandle(inheritedfromStream)

AllocatesaWaitHandleobject.

Deflate Deflateseverythingintheinputbuffers.Thiswillcall

def.deflate()

EncryptBlock Encryptablockofdata

EncryptByte Encryptasinglebyte

InitializePassword Initializesencryptionkeysbasedongivenpassword

UpdateKeys Updateencryptionkeys

AsynchronousreadsarenotsupportedaNotSupportedExceptionisalwaysthrown

publicoverrideIAsyncResultBeginRead(

byte[]buffer,

intoffset,

intcount,

AsyncCallbackcallback,

objectstate

Parametersbuffer

offset

callback

ReturnValue

DeflaterOutputStream.BeginReadMethod

publicoverrideIAsyncResultBeginWrite(

byte[]buffer,

intoffset,

intcount,

objectstate

Parametersbuffer

offset

callback

ReturnValue

DeflaterOutputStream.BeginWriteMethod

DeflaterOutputStream.CloseMethod

def.deflate()

protectedvoidDeflate();

DeflaterOutputStream.DeflateMethod

Encryptablockofdata

protectedvoidEncryptBlock(

byte[]buffer,

intoffset,

intlength

Parametersbuffer

Datatoencrypt.NOTEtheoriginalcontentsofthebufferarelost

offsetOffsetoffirstbyteinbuffertoencrypt

lengthNumberofbytesinbuffertoencrypt

DeflaterOutputStream.EncryptBlockMethod

Encryptasinglebyte

protectedbyteEncryptByte();

ReturnValueTheencryptedvalue

DeflaterOutputStream.EncryptByteMethod

Finishesthestreambycallingfinish()onthedeflater.

publicvirtualvoidFinish();

ExceptionsExceptionType ConditionSharpZipBaseException Notallinputisdeflated

DeflaterOutputStream.FinishMethod

DeflaterOutputStream.FlushMethod

protectedvoidInitializePassword(

stringpassword

DeflaterOutputStream.InitializePasswordMethod

byte[]b,

intoff,

intlen

DeflaterOutputStream.ReadMethod

DeflaterOutputStream.ReadByteMethod

longoffset,

SeekOriginorigin

DeflaterOutputStream.SeekMethod

longval

DeflaterOutputStream.SetLengthMethod

protectedvoidUpdateKeys(

bytech

DeflaterOutputStream.UpdateKeysMethod

Writesbytesfromanarraytothecompressedstream.

byte[]buf,

intoff,

intlen

Parametersbuf

Thebytearray

offTheoffsetintothebytearraywheretostart.

lenThenumberofbytestowrite.

DeflaterOutputStream.WriteMethod

bytebval

Parametersbval

Thebytevalue.

DeflaterOutputStream.WriteByteMethod

AninputbuffercustomisedforusebyInflaterInputStream

Foralistofallmembersofthistype,seeInflaterInputBufferMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer

publicclassInflaterInputBuffer

RemarksThebuffersupportsdecryptionofincomingdata.

SeeAlsoInflaterInputBufferMembers|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

InflaterInputBufferClass

InflaterInputBufferoverview

PublicInstanceConstructorsInflaterInputBuffer

ConstructorInitialiseanewinstanceofInflaterInputBuffer

PublicInstancePropertiesAvailable Get/setthenumberofbytes

available

ClearText Getthecontentsofthecleartextbuffer.

ClearTextLength GetthenumberofuseablebytesinClearText

CryptoTransform Get/settheICryptoTransformtoapplytoanydata.

RawData Getthecontentsoftherawdatabuffer.

RawLength GetthelengthofbytesbytesintheRawData

Fill Fillthebufferfromtheunderlyinginputstream.

InflaterInputBufferMembers

Object) instance.

ReadClearTextBuffer Readcleartextdatafromtheinputstream.

ReadLeByte Readabytefromtheinputstream.

ReadLeInt Readanintinlittleendianbyteorder.

ReadLeLong ReadanintbaseInputStreamlittleendianbyteorder.

ReadLeShort Readanunsignedshortinlittleendianbyteorder.

ReadRawBuffer Overloaded.Readabufferdirectlyfromtheinputstream

SetInflaterInput CallSetInputpassingthecurrentcleartextbuffercontents.

SeeAlsoInflaterInputBufferClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

InitialiseanewinstanceofInflaterInputBuffer

publicInflaterInputBuffer(

Streamstream

Parametersstream

Thestreamtobuffer.

InflaterInputBufferConstructor

ThepropertiesoftheInflaterInputBufferclassarelistedbelow.ForacompletelistofInflaterInputBufferclassmembers,seetheInflaterInputBufferMemberstopic.

PublicInstancePropertiesAvailable Get/setthenumberofbytes

available

ClearText Getthecontentsofthecleartextbuffer.

ClearTextLength GetthenumberofuseablebytesinClearText

CryptoTransform Get/settheICryptoTransformtoapplytoanydata.

RawData Getthecontentsoftherawdatabuffer.

RawLength GetthelengthofbytesbytesintheRawData

InflaterInputBufferProperties

Get/setthenumberofbytesavailable

publicintAvailable{get;set;}

InflaterInputBuffer.AvailableProperty

Getthecontentsofthecleartextbuffer.

publicbyte[]ClearText{get;}

InflaterInputBuffer.ClearTextProperty

GetthenumberofuseablebytesinClearText

publicintClearTextLength{get;}

InflaterInputBuffer.ClearTextLengthProperty

Get/settheICryptoTransformtoapplytoanydata.

publicSystem.Security.Cryptography.ICryptoTransform

RemarksSetthisvaluetonulltohavenotransformapplied.

InflaterInputBuffer.CryptoTransformProperty

Getthecontentsoftherawdatabuffer.

publicbyte[]RawData{get;}

RemarksThismaycontainencrypteddata.

InflaterInputBuffer.RawDataProperty

GetthelengthofbytesbytesintheRawData

publicintRawLength{get;}

InflaterInputBuffer.RawLengthProperty

ThemethodsoftheInflaterInputBufferclassarelistedbelow.ForacompletelistofInflaterInputBufferclassmembers,seetheInflaterInputBufferMemberstopic.

Fill Fillthebufferfromtheunderlyinginputstream.

ReadClearTextBuffer Readcleartextdatafromtheinputstream.

ReadLeByte Readabytefromtheinputstream.

ReadLeInt Readanintinlittleendianbyteorder.

ReadLeLong ReadanintbaseInputStreamlittleendianbyteorder.

ReadLeShort Readanunsignedshortinlittleendianbyteorder.

ReadRawBuffer Overloaded.Readabufferdirectlyfromtheinputstream

SetInflaterInput CallSetInputpassingthecurrentcleartextbuffercontents.

InflaterInputBufferMethods

Fillthebufferfromtheunderlyinginputstream.

publicvoidFill();

InflaterInputBuffer.FillMethod

Readcleartextdatafromtheinputstream.

publicintReadClearTextBuffer(

byte[]outBuffer,

intoffset,

intlength

ParametersoutBuffer

Thebuffertoadddatato.

offsetTheoffsettostartaddingdataat.

lengthThenumberofbytestoread.

ReturnValueReturnsthenumberofbytesactuallyread.

InflaterInputBuffer.ReadClearTextBufferMethod

Readabytefromtheinputstream.

publicintReadLeByte();

ReturnValueReturnsthebyteread.

InflaterInputBuffer.ReadLeByteMethod

Readanintinlittleendianbyteorder.

publicintReadLeInt();

InflaterInputBuffer.ReadLeIntMethod

ReadanintbaseInputStreamlittleendianbyteorder.

publiclongReadLeLong();

InflaterInputBuffer.ReadLeLongMethod

Readanunsignedshortinlittleendianbyteorder.

publicintReadLeShort();

InflaterInputBuffer.ReadLeShortMethod

Readabufferdirectlyfromtheinputstream

OverloadListReadabufferdirectlyfromtheinputstream

publicintReadRawBuffer(byte[]);

publicintReadRawBuffer(byte[],int,int);

InflaterInputBuffer.ReadRawBufferMethod

publicintReadRawBuffer(

byte[]buffer

Parametersbuffer

Thebuffertofill

SeeAlsoInflaterInputBufferClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace|InflaterInputBuffer.ReadRawBufferOverloadList

InflaterInputBuffer.ReadRawBufferMethod(Byte[])

publicintReadRawBuffer(

byte[]outBuffer,

intoffset,

intlength

ParametersoutBuffer

Thebuffertoreadinto

offsetTheoffsettostartreadingdatainto.

lengthThenumberofbytestoread.

SeeAlsoInflaterInputBufferClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace|InflaterInputBuffer.ReadRawBufferOverloadList

InflaterInputBuffer.ReadRawBufferMethod(Byte[],Int32,Int32)

CallSetInputpassingthecurrentcleartextbuffercontents.

publicvoidSetInflaterInput(

Inflaterinflater

Parametersinflater

Theinflatertosetinputfor.

InflaterInputBuffer.SetInflaterInputMethod

Thisfilterstreamisusedtodecompressdatacompressedusingthe"deflate"format.The"deflate"formatisdescribedinRFC1951.Thisstreammayformthebasisforotherdecompressionfilters,suchastheGZipInputStream.Authoroftheoriginaljavaversion:JohnLeuner.

Foralistofallmembersofthistype,seeInflaterInputStreamMembers.

System.ObjectSystem.MarshalByRefObjectSystem.IO.StreamICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStreamICSharpCode.SharpZipLib.GZip.GZipInputStreamICSharpCode.SharpZipLib.Zip.ZipInputStream

publicclassInflaterInputStream:Stream

SeeAlsoInflaterInputStreamMembers|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

InflaterInputStreamClass

InflaterInputStreamoverview

PublicInstanceConstructorsInflaterInputStream Overloaded.Initializesanew

instanceoftheInflaterInputStreamclass.

PublicInstancePropertiesAvailable Returns0oncetheendofthe

stream(EOF)hasbeenreached.Otherwisereturns1.

CanSeek Getsavalueoffalseindicatingseekingisnotsupportedforthisstream.

CanWrite Getsavalueoffalseindicatingthatthisstreamisnotwriteable.

IsStreamOwner Get/setflagindicatingownershipofunderlyingstream.WhentheflagistrueClosewillclosetheunderlyingstreamalso.

Length Avaluerepresentingthelengthofthestreaminbytes.

Position Thecurrentpositionwithinthestream.ThrowsaNotSupportedExceptionwhenattemptingtosettheposition

InflaterInputStreamMembers

BeginRead(inheritedfromStream)

Beginsanasynchronousreadoperation.

BeginWrite Entrypointtobeginanasynchronouswrite.AlwaysthrowsaNotSupportedException.

Close Closestheinputstream.WhenIsStreamOwneristruetheunderlyingstreamisalsoclosed.

InitializeLifetimeService Obtainsalifetimeserviceobject

(inheritedfromMarshalByRefObject)

tocontrolthelifetimepolicyforthisinstance.

Read Decompressesdataintothebytearray

Seek SetsthepositionwithinthecurrentstreamAlwaysthrowsaNotSupportedException

SetLength SetthelengthofthecurrentstreamAlwaysthrowsaNotSupportedException

Skip Skipspecifiednumberofbytesofuncompresseddata

Write WritesasequenceofbytestostreamandadvancesthecurrentpositionThismethodalwaysthrowsaNotSupportedException

WriteByte WritesonebytetothecurrentstreamandadvancesthecurrentpositionAlwaysthrowsaNotSupportedException

ProtectedInstanceFieldsbaseInputStream Basestreamtheinflaterreads

csize Thecompressedsize

inf Decompressorforthisstream

inputBuffer Inputbufferforthisstream.

Fill Fillsthebufferwithmoredatatodecompress.

StopDecrypting Clearanycryptographicstate.

SeeAlsoInflaterInputStreamClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

CreateanInflaterInputStreamwiththedefaultdecompressorandadefaultbuffersizeof4KB.

OverloadListCreateanInflaterInputStreamwiththedefaultdecompressorandadefaultbuffersizeof4KB.

publicInflaterInputStream(Stream);

CreateanInflaterInputStreamwiththespecifieddecompressorandadefaultbuffersizeof4KB.

publicInflaterInputStream(Stream,Inflater);

CreateanInflaterInputStreamwiththespecifieddecompressorandthespecifiedbuffersize.

publicInflaterInputStream(Stream,Inflater,int);

InflaterInputStreamConstructor

CreateanInflaterInputStreamwiththedefaultdecompressorandadefaultbuffersizeof4KB.

publicInflaterInputStream(

TheInputStreamtoreadbytesfrom

SeeAlsoInflaterInputStreamClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace|InflaterInputStreamConstructorOverloadList

InflaterInputStreamConstructor(Stream)

CreateanInflaterInputStreamwiththespecifieddecompressorandadefaultbuffersizeof4KB.

Inflaterinf

Thesourceofinputdata

infThedecompressorusedtodecompressdatareadfrombaseInputStream

InflaterInputStreamConstructor(Stream,Inflater)

CreateanInflaterInputStreamwiththespecifieddecompressorandthespecifiedbuffersize.

Inflaterinflater,

intbufferSize

TheInputStreamtoreadbytesfrom

inflaterThedecompressortouse

bufferSizeSizeofthebuffertouse

InflaterInputStreamConstructor(Stream,Inflater,Int32)

ThefieldsoftheInflaterInputStreamclassarelistedbelow.ForacompletelistofInflaterInputStreamclassmembers,seetheInflaterInputStreamMemberstopic.

ProtectedInstanceFieldsbaseInputStream Basestreamtheinflaterreads

csize Thecompressedsize

inf Decompressorforthisstream

inputBuffer Inputbufferforthisstream.

InflaterInputStreamFields

Basestreamtheinflaterreadsfrom.

protectedStreambaseInputStream;

InflaterInputStream.baseInputStreamField

Thecompressedsize

protectedlongcsize;

InflaterInputStream.csizeField

protectedInflaterinf;

InflaterInputStream.infField

protectedInflaterInputBufferinputBuffer;

InflaterInputStream.inputBufferField

ThepropertiesoftheInflaterInputStreamclassarelistedbelow.ForacompletelistofInflaterInputStreamclassmembers,seetheInflaterInputStreamMemberstopic.

PublicInstancePropertiesAvailable Returns0oncetheendofthe

stream(EOF)hasbeenreached.Otherwisereturns1.

CanSeek Getsavalueoffalseindicatingseekingisnotsupportedforthisstream.

CanWrite Getsavalueoffalseindicatingthatthisstreamisnotwriteable.

IsStreamOwner Get/setflagindicatingownershipofunderlyingstream.WhentheflagistrueClosewillclosetheunderlyingstreamalso.

Length Avaluerepresentingthelengthofthestreaminbytes.

Position Thecurrentpositionwithinthestream.ThrowsaNotSupportedExceptionwhenattemptingtosettheposition

InflaterInputStreamProperties

Returns0oncetheendofthestream(EOF)hasbeenreached.Otherwisereturns1.

publicvirtualintAvailable{get;}

InflaterInputStream.AvailableProperty

InflaterInputStream.CanReadProperty

InflaterInputStream.CanSeekProperty

InflaterInputStream.CanWriteProperty

publicboolIsStreamOwner{get;set;}

RemarksThedefaultvalueistrue.

InflaterInputStream.IsStreamOwnerProperty

InflaterInputStream.LengthProperty

ExceptionsExceptionType ConditionNotSupportedException Attemptingtosettheposition

InflaterInputStream.PositionProperty

ThemethodsoftheInflaterInputStreamclassarelistedbelow.ForacompletelistofInflaterInputStreamclassmembers,seetheInflaterInputStreamMemberstopic.

BeginWrite Entrypointtobeginanasynchronouswrite.AlwaysthrowsaNotSupportedException.

Close Closestheinputstream.WhenIsStreamOwneristruetheunderlyingstreamisalsoclosed.

InflaterInputStreamMethods

Read Decompressesdataintothebytearray

Seek SetsthepositionwithinthecurrentstreamAlwaysthrowsaNotSupportedException

SetLength SetthelengthofthecurrentstreamAlwaysthrowsaNotSupportedException

Skip Skipspecifiednumberofbytesofuncompresseddata

Write WritesasequenceofbytestostreamandadvancesthecurrentpositionThismethodalwaysthrowsaNotSupportedException

WriteByte WritesonebytetothecurrentstreamandadvancesthecurrentpositionAlwaysthrowsaNotSupportedException

Fill Fillsthebufferwithmoredatatodecompress.

StopDecrypting Clearanycryptographicstate.

publicoverrideIAsyncResultBeginWrite(

byte[]buffer,

intoffset,

intcount,

objectstate

Parametersbuffer

Thebuffertowritedatafrom

offsetOffsetoffirstbytetowrite

countThemaximumnumberofbytestowrite

callbackThemethodtobecalledwhentheasynchronouswriteoperationiscompleted

stateAuser-providedobjectthatdistinguishesthisparticularasynchronouswriterequestfromotherrequests

ReturnValueAnIAsyncResultthatreferencestheasynchronouswrite

SeeAlso

InflaterInputStream.BeginWriteMethod

InflaterInputStreamClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

InflaterInputStream.CloseMethod

protectedvoidFill();

ExceptionsExceptionType ConditionSharpZipBaseException Streamendsearly

InflaterInputStream.FillMethod

InflaterInputStream.FlushMethod

Decompressesdataintothebytearray

byte[]b,

intoff,

intlen

Parametersb

Thearraytoreadanddecompressdatainto

offTheoffsetindicatingwherethedatashouldbeplaced

lenThenumberofbytestodecompress

ReturnValueThenumberofbytesread.Zerosignalstheendofstream

ExceptionsExceptionType ConditionSharpZipBaseException Inflaterneedsadictionary

InflaterInputStream.ReadMethod

longoffset,

SeekOriginorigin

InflaterInputStream.SeekMethod

longval

InflaterInputStream.SetLengthMethod

publiclongSkip(

Parametersn

Numberofbytestoskip

ReturnValueThenumberofbytesskipped,zeroiftheendofstreamhasbeenreached

ExceptionsExceptionType ConditionArgumentOutOfRangeException Numberofbytestoskipiszero

orless

InflaterInputStream.SkipMethod

protectedvoidStopDecrypting();

InflaterInputStream.StopDecryptingMethod

byte[]array,

intoffset,

intcount

InflaterInputStream.WriteMethod

byteval

InflaterInputStream.WriteByteMethod

ContainstheoutputfromtheInflationprocess.Weneedtohaveawindowsothatwecanreferbackwardsintotheoutputstreamtorepeatstuff.Authoroftheoriginaljavaversion:JohnLeuner

Foralistofallmembersofthistype,seeOutputWindowMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow

publicclassOutputWindow

SeeAlsoOutputWindowMembers|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

OutputWindowClass

OutputWindowoverview

PublicInstanceConstructorsOutputWindowConstructor Initializesanewinstanceofthe

OutputWindowclass.

PublicInstanceMethodsCopyDict Copydictionarytowindow

CopyOutput Copycontentsofwindowtooutput

CopyStored Copyfrominputmanipulatortointernalwindow

GetAvailable Getbytesavailableforoutputinwindow

GetFreeSpace Getremainingunfilledspaceinwindow

Repeat Appendabytepatternalreadyinthewindowitself

Reset ResetbyclearingwindowsoGetAvailablereturns0

OutputWindowMembers

Write Writeabytetothisoutputwindow

SeeAlsoOutputWindowClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

InitializesanewinstanceoftheOutputWindowclass.

publicOutputWindow();

OutputWindowConstructor

ThemethodsoftheOutputWindowclassarelistedbelow.ForacompletelistofOutputWindowclassmembers,seetheOutputWindowMemberstopic.

PublicInstanceMethodsCopyDict Copydictionarytowindow

CopyOutput Copycontentsofwindowtooutput

CopyStored Copyfrominputmanipulatortointernalwindow

GetAvailable Getbytesavailableforoutputinwindow

GetFreeSpace Getremainingunfilledspaceinwindow

Repeat Appendabytepatternalreadyinthewindowitself

Reset ResetbyclearingwindowsoGetAvailablereturns0

Write Writeabytetothisoutputwindow

OutputWindowMethods

Copydictionarytowindow

publicvoidCopyDict(

byte[]dict,

intoffset,

intlen

Parametersdict

sourcedictionary

offsetoffsetofstartinsourcedictionary

lenlengthofdictionary

ExceptionsExceptionType ConditionInvalidOperationException Ifwindowisntempty

OutputWindow.CopyDictMethod

Copycontentsofwindowtooutput

publicintCopyOutput(

byte[]output,

intoffset,

intlen

Parametersoutput

buffertocopyto

offsetoffsettostartat

lennumberofbytestocount

ReturnValueThenumberofbytescopied

ExceptionsExceptionType ConditionInvalidOperationException Ifawindowunderflowoccurs

OutputWindow.CopyOutputMethod

Copyfrominputmanipulatortointernalwindow

publicintCopyStored(

StreamManipulatorinput,

intlen

Parametersinput

sourceofdata

lenlengthofdatatocopy

ReturnValuethenumberofbytescopied

OutputWindow.CopyStoredMethod

Getbytesavailableforoutputinwindow

publicintGetAvailable();

ReturnValueNumberofbytesfilled

OutputWindow.GetAvailableMethod

Getremainingunfilledspaceinwindow

publicintGetFreeSpace();

ReturnValueNumberofbytesleftinwindow

OutputWindow.GetFreeSpaceMethod

Appendabytepatternalreadyinthewindowitself

publicvoidRepeat(

intlen,

intdist

Parameterslen

lengthofpatterntocopy

distdistancefromendofwindowpatternoccurs

ExceptionsExceptionType ConditionInvalidOperationException Iftherepeateddataoverflows

thewindow

OutputWindow.RepeatMethod

ResetbyclearingwindowsoGetAvailablereturns0

publicvoidReset();

OutputWindow.ResetMethod

Writeabytetothisoutputwindow

publicvoidWrite(

intabyte

Parametersabyte

valuetowrite

ExceptionsExceptionType ConditionInvalidOperationException ifwindowisfull

OutputWindow.WriteMethod

Thisclassallowsustoretrieveaspecifiednumberofbitsfromtheinputbuffer,aswellascopybigbyteblocks.Itusesanintbuffertostoreupto31bitsfordirectmanipulation.Thisguaranteesthatwecangetatleast16bits,butweonlyneedatmost15,sothisisallsafe.Therearesomeoptimizationsinthisclass,forexample,youmustneverpeekmorethan8bitsmorethanneeded,andyoumustfirstpeekbitsbeforeyoumaydropthem.ThisisnotageneralpurposeclassbutoptimizedforthebehaviouroftheInflater.authorsoftheoriginaljavaversion:JohnLeuner,JochenHoenicke

Foralistofallmembersofthistype,seeStreamManipulatorMembers.

System.ObjectICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator

publicclassStreamManipulator

SeeAlsoStreamManipulatorMembers|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

StreamManipulatorClass

StreamManipulatoroverview

PublicInstanceConstructorsStreamManipulator

ConstructorConstructsadefaultStreamManipulatorwithallbuffersempty

PublicInstancePropertiesAvailableBits Getsthenumberofbits

availableinthebitbuffer.ThismustbeonlycalledwhenapreviousPeekBits()returned-1.

AvailableBytes Getsthenumberofbytesavailable.

IsNeedingInput ReturnstruewhenSetInputcanbecalled

PublicInstanceMethodsCopyBytes Copieslengthbytesfrominput

buffertooutputbufferstartingatoutput[offset].Youhavetomakesure,thatthebufferisbytealigned.Ifnotenoughbytesareavailable,copiesfewerbytes.

DropBits Dropsthenextnbitsfromtheinput.YoushouldhavecalledPeekBitswithabiggerorequalnbefore,tomakesurethatenoughbitsareinthebitbuffer.

GetBits Getsthenextnbitsand

StreamManipulatorMembers

increasesinputpointer.ThisisequivalenttoPeekBitsfollowedbydropBits,exceptforcorrecterrorhandling.

PeekBits Getthenextnbitsbutdon'tincreaseinputpointer.nmustbelessorequal16andifthiscallsucceeds,youmustdropatleastn-8bitsinthenextcall.

Reset resetsstateandemptiesinternalbuffers

SetInput Addmoreinputforconsumption.OnlycallwhenIsNeedingInputreturnstrue

SkipToByteBoundary Skipstothenextbyteboundary.

SeeAlso

StreamManipulatorClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

ConstructsadefaultStreamManipulatorwithallbuffersempty

publicStreamManipulator();

SeeAlsoStreamManipulatorClass|ICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

StreamManipulatorConstructor

ThepropertiesoftheStreamManipulatorclassarelistedbelow.ForacompletelistofStreamManipulatorclassmembers,seetheStreamManipulatorMemberstopic.

PublicInstancePropertiesAvailableBits Getsthenumberofbits

availableinthebitbuffer.ThismustbeonlycalledwhenapreviousPeekBits()returned-1.

AvailableBytes Getsthenumberofbytesavailable.

IsNeedingInput ReturnstruewhenSetInputcanbecalled

StreamManipulatorProperties

Getsthenumberofbitsavailableinthebitbuffer.ThismustbeonlycalledwhenapreviousPeekBits()returned-1.

publicintAvailableBits{get;}

StreamManipulator.AvailableBitsProperty

Getsthenumberofbytesavailable.

publicintAvailableBytes{get;}

StreamManipulator.AvailableBytesProperty

ReturnstruewhenSetInputcanbecalled

StreamManipulator.IsNeedingInputProperty

ThemethodsoftheStreamManipulatorclassarelistedbelow.ForacompletelistofStreamManipulatorclassmembers,seetheStreamManipulatorMemberstopic.

PublicInstanceMethodsCopyBytes Copieslengthbytesfrominput

buffertooutputbufferstartingatoutput[offset].Youhavetomakesure,thatthebufferisbytealigned.Ifnotenoughbytesareavailable,copiesfewerbytes.

DropBits Dropsthenextnbitsfromtheinput.YoushouldhavecalledPeekBitswithabiggerorequalnbefore,tomakesurethatenoughbitsareinthebitbuffer.

GetBits Getsthenextnbitsandincreasesinputpointer.ThisisequivalenttoPeekBitsfollowedbydropBits,exceptforcorrecterrorhandling.

PeekBits Getthenextnbitsbutdon'tincreaseinputpointer.nmustbelessorequal16andifthis

StreamManipulatorMethods

callsucceeds,youmustdropatleastn-8bitsinthenextcall.

Reset resetsstateandemptiesinternalbuffers

SetInput Addmoreinputforconsumption.OnlycallwhenIsNeedingInputreturnstrue

SkipToByteBoundary Skipstothenextbyteboundary.

Copieslengthbytesfrominputbuffertooutputbufferstartingatoutput[offset].Youhavetomakesure,thatthebufferisbytealigned.Ifnotenoughbytesareavailable,copiesfewerbytes.

publicintCopyBytes(

byte[]output,

intoffset,

intlength

Parametersoutput

Thebuffertocopybytesto.

offsetTheoffsetinthebufferatwhichcopyingstarts

lengthThelengthtocopy,0isallowed.

ReturnValueThenumberofbytescopied,0ifnobyteswereavailable.

ExceptionsExceptionType ConditionArgumentOutOfRangeException Lengthislessthanzero

InvalidOperationException Bitbufferisntbytealigned

StreamManipulator.CopyBytesMethod

Dropsthenextnbitsfromtheinput.YoushouldhavecalledPeekBitswithabiggerorequalnbefore,tomakesurethatenoughbitsareinthebitbuffer.

publicvoidDropBits(

StreamManipulator.DropBitsMethod

Getsthenextnbitsandincreasesinputpointer.ThisisequivalenttoPeekBitsfollowedbydropBits,exceptforcorrecterrorhandling.

publicintGetBits(

ReturnValuethevalueofthebits,or-1ifnotenoughbitsavailable.

StreamManipulator.GetBitsMethod

Getthenextnbitsbutdon'tincreaseinputpointer.nmustbelessorequal16andifthiscallsucceeds,youmustdropatleastn-8bitsinthenextcall.

publicintPeekBits(

ReturnValuethevalueofthebits,or-1ifnotenoughbitsavailable.*/

StreamManipulator.PeekBitsMethod

resetsstateandemptiesinternalbuffers

publicvoidReset();

StreamManipulator.ResetMethod

Addmoreinputforconsumption.OnlycallwhenIsNeedingInputreturnstrue

publicvoidSetInput(

byte[]buf,

intoff,

intlen

Parametersbuf

datatobeinput

offoffsetoffirstbyteofinput

lenlengthofinput

StreamManipulator.SetInputMethod

Skipstothenextbyteboundary.

publicvoidSkipToByteBoundary();

StreamManipulator.SkipToByteBoundaryMethod

System.Object

System.Exception----System.Runtime.Serialization.ISerializable

System.ApplicationException

ICSharpCode.SharpZipLib.SharpZipBaseException

SeeAlsoICSharpCode.SharpZipLibNamespace

ICSharpCode.SharpZipLibHierarchy

System.Object

ICSharpCode.SharpZipLib.BZip2.BZip2

ICSharpCode.SharpZipLib.BZip2.BZip2Constants

ICSharpCode.SharpZipLib.BZip2.BZip2Exception

System.MarshalByRefObject

System.IO.Stream----System.IDisposable

ICSharpCode.SharpZipLib.BZip2.BZip2InputStream

ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream

SeeAlsoICSharpCode.SharpZipLib.BZip2Namespace

ICSharpCode.SharpZipLib.BZip2Hierarchy

System.Object

ICSharpCode.SharpZipLib.Checksums.Adler32----ICSharpCode.SharpZipLib.Checksums.IChecksum

ICSharpCode.SharpZipLib.Checksums.Crc32----ICSharpCode.SharpZipLib.Checksums.IChecksum

ICSharpCode.SharpZipLib.Checksums.IChecksum

ICSharpCode.SharpZipLib.Checksums.StrangeCRC----ICSharpCode.SharpZipLib.Checksums.IChecksum

SeeAlsoICSharpCode.SharpZipLib.ChecksumsNamespace

ICSharpCode.SharpZipLib.ChecksumsHierarchy

System.Object

ICSharpCode.SharpZipLib.Core.FileSystemScanner

ICSharpCode.SharpZipLib.Core.INameTransform

ICSharpCode.SharpZipLib.Core.IScanFilter

ICSharpCode.SharpZipLib.Core.NameFilter

ICSharpCode.SharpZipLib.Core.PathFilter----ICSharpCode.SharpZipLib.Core.IScanFilter

ICSharpCode.SharpZipLib.Core.NameAndSizeFilter

ICSharpCode.SharpZipLib.Core.ScanFailureEventArgs

System.Delegate----System.ICloneable,System.Runtime.Serialization.ISerializable

System.MulticastDelegate

ICSharpCode.SharpZipLib.Core.DirectoryFailureDelegate

ICSharpCode.SharpZipLib.Core.FileFailureDelegate

ICSharpCode.SharpZipLib.Core.ProcessDirectoryDelegate

ICSharpCode.SharpZipLib.Core.ProcessFileDelegate

System.EventArgs

ICSharpCode.SharpZipLib.Core.ScanEventArgs

ICSharpCode.SharpZipLib.Core.DirectoryEventArgs

ICSharpCode.SharpZipLib.CoreHierarchy

System.Object

System.Security.Cryptography.SymmetricAlgorithm----System.IDisposable

ICSharpCode.SharpZipLib.Encryption.PkzipClassic

ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged

SeeAlsoICSharpCode.SharpZipLib.EncryptionNamespace

ICSharpCode.SharpZipLib.EncryptionHierarchy

System.Object

ICSharpCode.SharpZipLib.GZip.GZipConstants

ICSharpCode.SharpZipLib.GZip.GZipException

ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream

ICSharpCode.SharpZipLib.GZip.GZipOutputStream

ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream

ICSharpCode.SharpZipLib.GZip.GZipInputStream

SeeAlsoICSharpCode.SharpZipLib.GZipNamespace

ICSharpCode.SharpZipLib.GZipHierarchy

System.Object

ICSharpCode.SharpZipLib.Tar.TarArchive

ICSharpCode.SharpZipLib.Tar.TarBuffer

ICSharpCode.SharpZipLib.Tar.TarEntry----System.ICloneable

ICSharpCode.SharpZipLib.Tar.TarHeader----System.ICloneable

ICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter----ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory

ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory

ICSharpCode.SharpZipLib.Tar.ProgressMessageHandler

ICSharpCode.SharpZipLib.Tar.TarException

ICSharpCode.SharpZipLib.Tar.InvalidHeaderException

ICSharpCode.SharpZipLib.Tar.TarInputStream

ICSharpCode.SharpZipLib.Tar.TarOutputStream

SeeAlsoICSharpCode.SharpZipLib.TarNamespace

ICSharpCode.SharpZipLib.TarHierarchy

System.Object

ICSharpCode.SharpZipLib.Zip.FastZip

ICSharpCode.SharpZipLib.Zip.FastZipEvents

ICSharpCode.SharpZipLib.Zip.ZipConstants

ICSharpCode.SharpZipLib.Zip.ZipEntry----System.ICloneable

ICSharpCode.SharpZipLib.Zip.ZipFile----System.Collections.IEnumerable

ICSharpCode.SharpZipLib.Zip.ZipNameTransform----ICSharpCode.SharpZipLib.Core.INameTransform

ICSharpCode.SharpZipLib.Zip.FastZip.ConfirmOverwriteDelegate

ICSharpCode.SharpZipLib.Zip.ZipFile.KeysRequiredEventHandler

System.EventArgs

ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs

ICSharpCode.SharpZipLib.Zip.ZipException

ICSharpCode.SharpZipLib.Zip.ZipOutputStream

ICSharpCode.SharpZipLib.Zip.ZipInputStream

System.ValueType

ICSharpCode.SharpZipLib.ZipHierarchy

System.Enum----System.IComparable,System.IConvertible,System.IFormattable

ICSharpCode.SharpZipLib.Zip.CompressionMethod

ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite

System.Object

ICSharpCode.SharpZipLib.Zip.Compression.Deflater

ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants

ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine

ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman

ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree

ICSharpCode.SharpZipLib.Zip.Compression.Inflater

ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree

ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer

ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending

System.ValueType

System.Enum----System.IComparable,System.IConvertible,System.IFormattable

ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy

SeeAlsoICSharpCode.SharpZipLib.Zip.CompressionNamespace

ICSharpCode.SharpZipLib.Zip.CompressionHierarchy

System.Object

ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer

ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow

ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator

SeeAlsoICSharpCode.SharpZipLib.Zip.Compression.StreamsNamespace

ICSharpCode.SharpZipLib.Zip.Compression.StreamsHierarchy

SharpZip Compression LibraryCompress Compress instream sending result to outputstream Decompress...

Documents

Status of Instream Flow Science in the Southeastern US Mary M. Davis, Ph.D., Technical Advisor Southern Instream Flow Network

The Texas Instream Flow Program

Rock Filter Dams (Instream)

Monitoring the Effectiveness of Instream Substrate

· Web view244 Instream Flow Council – Instream flow and stream ecology literature – Octobrt 10, 2016 - HB Instream Flow Council – Instream flow and stream ecology ... Aadland,

Instream Flow Requirements Anadromous …Instream Flow Requirements, Anadromous Salmonids Spawning and Rearing Lagunitas Creek, Marin County, I/ By Gary E. Smith 2 Abstract The Instream

DeCompress: tissue compartment deconvolution of targeted … · 2020. 8. 14. · 1 DeCompress: tissue compartment deconvolution of targeted mRNA expression 2 panels using compressed

Lecture 12 - Instream Water Quality 1

Flow Guidelines for Instream Values

Utilization of Rehab Services to Decompress Referrals to Specialization Clinics

EyeWonder Flash Instream Framework Specification

Instream technology for georgia 100 mw

Colorado’s Instream Flow Program at 40

InStream Tech Con 2012 - Radio Festival

INSTREAM PROJECT DESIGN CHECKLIST

TIBCO Foresight® Instream

25k w instream-turbine-technical-specifications

Not “tree cover,” but instream physical structure Instream Cover or Stucture

Instream Flows in the Spokane River

Lower Saluda River Instream Flow Study