暫無描述
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ICSharpCode.SharpZipLib.xml 577KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ICSharpCode.SharpZipLib</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2">
  8. <summary>
  9. An example class to demonstrate compression and decompression of BZip2 streams.
  10. </summary>
  11. </member>
  12. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2.Decompress(System.IO.Stream,System.IO.Stream,System.Boolean)">
  13. <summary>
  14. Decompress the <paramref name="inStream">input</paramref> writing
  15. uncompressed data to the <paramref name="outStream">output stream</paramref>
  16. </summary>
  17. <param name="inStream">The readable stream containing data to decompress.</param>
  18. <param name="outStream">The output stream to receive the decompressed data.</param>
  19. <param name="isStreamOwner">Both streams are closed on completion if true.</param>
  20. </member>
  21. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2.Compress(System.IO.Stream,System.IO.Stream,System.Boolean,System.Int32)">
  22. <summary>
  23. Compress the <paramref name="inStream">input stream</paramref> sending
  24. result data to <paramref name="outStream">output stream</paramref>
  25. </summary>
  26. <param name="inStream">The readable stream to compress.</param>
  27. <param name="outStream">The output stream to receive the compressed data.</param>
  28. <param name="isStreamOwner">Both streams are closed on completion if true.</param>
  29. <param name="level">Block size acts as compression level (1 to 9) with 1 giving
  30. the lowest compression and 9 the highest.</param>
  31. </member>
  32. <member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2Constants">
  33. <summary>
  34. Defines internal values for both compression and decompression
  35. </summary>
  36. </member>
  37. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.RandomNumbers">
  38. <summary>
  39. Random numbers used to randomise repetitive blocks
  40. </summary>
  41. </member>
  42. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.BaseBlockSize">
  43. <summary>
  44. When multiplied by compression parameter (1-9) gives the block size for compression
  45. 9 gives the best compression but uses the most memory.
  46. </summary>
  47. </member>
  48. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.MaximumAlphaSize">
  49. <summary>
  50. Backend constant
  51. </summary>
  52. </member>
  53. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.MaximumCodeLength">
  54. <summary>
  55. Backend constant
  56. </summary>
  57. </member>
  58. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.RunA">
  59. <summary>
  60. Backend constant
  61. </summary>
  62. </member>
  63. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.RunB">
  64. <summary>
  65. Backend constant
  66. </summary>
  67. </member>
  68. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.GroupCount">
  69. <summary>
  70. Backend constant
  71. </summary>
  72. </member>
  73. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.GroupSize">
  74. <summary>
  75. Backend constant
  76. </summary>
  77. </member>
  78. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.NumberOfIterations">
  79. <summary>
  80. Backend constant
  81. </summary>
  82. </member>
  83. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.MaximumSelectors">
  84. <summary>
  85. Backend constant
  86. </summary>
  87. </member>
  88. <member name="F:ICSharpCode.SharpZipLib.BZip2.BZip2Constants.OvershootBytes">
  89. <summary>
  90. Backend constant
  91. </summary>
  92. </member>
  93. <member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2Exception">
  94. <summary>
  95. BZip2Exception represents exceptions specific to BZip2 classes and code.
  96. </summary>
  97. </member>
  98. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2Exception.#ctor">
  99. <summary>
  100. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.BZip2.BZip2Exception" />.
  101. </summary>
  102. </member>
  103. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2Exception.#ctor(System.String)">
  104. <summary>
  105. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.BZip2.BZip2Exception" /> with its message string.
  106. </summary>
  107. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  108. </member>
  109. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2Exception.#ctor(System.String,System.Exception)">
  110. <summary>
  111. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.BZip2.BZip2Exception" />.
  112. </summary>
  113. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  114. <param name="innerException">The <see cref="T:System.Exception"/> that caused this exception.</param>
  115. </member>
  116. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2Exception.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  117. <summary>
  118. Initializes a new instance of the BZip2Exception class with serialized data.
  119. </summary>
  120. <param name="info">
  121. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  122. object data about the exception being thrown.
  123. </param>
  124. <param name="context">
  125. The System.Runtime.Serialization.StreamingContext that contains contextual information
  126. about the source or destination.
  127. </param>
  128. </member>
  129. <member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream">
  130. <summary>
  131. An input stream that decompresses files in the BZip2 format
  132. </summary>
  133. </member>
  134. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.#ctor(System.IO.Stream)">
  135. <summary>
  136. Construct instance for reading from stream
  137. </summary>
  138. <param name="stream">Data source</param>
  139. </member>
  140. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.IsStreamOwner">
  141. <summary>
  142. Get/set flag indicating ownership of underlying stream.
  143. When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
  144. </summary>
  145. </member>
  146. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.CanRead">
  147. <summary>
  148. Gets a value indicating if the stream supports reading
  149. </summary>
  150. </member>
  151. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.CanSeek">
  152. <summary>
  153. Gets a value indicating whether the current stream supports seeking.
  154. </summary>
  155. </member>
  156. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.CanWrite">
  157. <summary>
  158. Gets a value indicating whether the current stream supports writing.
  159. This property always returns false
  160. </summary>
  161. </member>
  162. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.Length">
  163. <summary>
  164. Gets the length in bytes of the stream.
  165. </summary>
  166. </member>
  167. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.Position">
  168. <summary>
  169. Gets the current position of the stream.
  170. Setting the position is not supported and will throw a NotSupportException.
  171. </summary>
  172. <exception cref="T:System.NotSupportedException">Any attempt to set the position.</exception>
  173. </member>
  174. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.Flush">
  175. <summary>
  176. Flushes the stream.
  177. </summary>
  178. </member>
  179. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  180. <summary>
  181. Set the streams position. This operation is not supported and will throw a NotSupportedException
  182. </summary>
  183. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  184. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  185. <returns>The new position of the stream.</returns>
  186. <exception cref="T:System.NotSupportedException">Any access</exception>
  187. </member>
  188. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.SetLength(System.Int64)">
  189. <summary>
  190. Sets the length of this stream to the given value.
  191. This operation is not supported and will throw a NotSupportedExceptionortedException
  192. </summary>
  193. <param name="value">The new length for the stream.</param>
  194. <exception cref="T:System.NotSupportedException">Any access</exception>
  195. </member>
  196. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.Write(System.Byte[],System.Int32,System.Int32)">
  197. <summary>
  198. Writes a block of bytes to this stream using data from a buffer.
  199. This operation is not supported and will throw a NotSupportedException
  200. </summary>
  201. <param name="buffer">The buffer to source data from.</param>
  202. <param name="offset">The offset to start obtaining data from.</param>
  203. <param name="count">The number of bytes of data to write.</param>
  204. <exception cref="T:System.NotSupportedException">Any access</exception>
  205. </member>
  206. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.WriteByte(System.Byte)">
  207. <summary>
  208. Writes a byte to the current position in the file stream.
  209. This operation is not supported and will throw a NotSupportedException
  210. </summary>
  211. <param name="value">The value to write.</param>
  212. <exception cref="T:System.NotSupportedException">Any access</exception>
  213. </member>
  214. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.Read(System.Byte[],System.Int32,System.Int32)">
  215. <summary>
  216. Read a sequence of bytes and advances the read position by one byte.
  217. </summary>
  218. <param name="buffer">Array of bytes to store values in</param>
  219. <param name="offset">Offset in array to begin storing data</param>
  220. <param name="count">The maximum number of bytes to read</param>
  221. <returns>The total number of bytes read into the buffer. This might be less
  222. than the number of bytes requested if that number of bytes are not
  223. currently available or zero if the end of the stream is reached.
  224. </returns>
  225. </member>
  226. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.Dispose(System.Boolean)">
  227. <summary>
  228. Closes the stream, releasing any associated resources.
  229. </summary>
  230. </member>
  231. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2InputStream.ReadByte">
  232. <summary>
  233. Read a byte from stream advancing position
  234. </summary>
  235. <returns>byte read or -1 on end of stream</returns>
  236. </member>
  237. <member name="T:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream">
  238. <summary>
  239. An output stream that compresses into the BZip2 format
  240. including file header chars into another stream.
  241. </summary>
  242. </member>
  243. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.#ctor(System.IO.Stream)">
  244. <summary>
  245. Construct a default output stream with maximum block size
  246. </summary>
  247. <param name="stream">The stream to write BZip data onto.</param>
  248. </member>
  249. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.#ctor(System.IO.Stream,System.Int32)">
  250. <summary>
  251. Initialise a new instance of the <see cref="T:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream"></see>
  252. for the specified stream, using the given blocksize.
  253. </summary>
  254. <param name="stream">The stream to write compressed data to.</param>
  255. <param name="blockSize">The block size to use.</param>
  256. <remarks>
  257. Valid block sizes are in the range 1..9, with 1 giving
  258. the lowest compression and 9 the highest.
  259. </remarks>
  260. </member>
  261. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Finalize">
  262. <summary>
  263. Ensures that resources are freed and other cleanup operations
  264. are performed when the garbage collector reclaims the BZip2OutputStream.
  265. </summary>
  266. </member>
  267. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.IsStreamOwner">
  268. <summary>
  269. Gets or sets a flag indicating ownership of underlying stream.
  270. When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
  271. </summary>
  272. <remarks>The default value is true.</remarks>
  273. </member>
  274. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.CanRead">
  275. <summary>
  276. Gets a value indicating whether the current stream supports reading
  277. </summary>
  278. </member>
  279. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.CanSeek">
  280. <summary>
  281. Gets a value indicating whether the current stream supports seeking
  282. </summary>
  283. </member>
  284. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.CanWrite">
  285. <summary>
  286. Gets a value indicating whether the current stream supports writing
  287. </summary>
  288. </member>
  289. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Length">
  290. <summary>
  291. Gets the length in bytes of the stream
  292. </summary>
  293. </member>
  294. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Position">
  295. <summary>
  296. Gets or sets the current position of this stream.
  297. </summary>
  298. </member>
  299. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  300. <summary>
  301. Sets the current position of this stream to the given value.
  302. </summary>
  303. <param name="offset">The point relative to the offset from which to being seeking.</param>
  304. <param name="origin">The reference point from which to begin seeking.</param>
  305. <returns>The new position in the stream.</returns>
  306. </member>
  307. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.SetLength(System.Int64)">
  308. <summary>
  309. Sets the length of this stream to the given value.
  310. </summary>
  311. <param name="value">The new stream length.</param>
  312. </member>
  313. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.ReadByte">
  314. <summary>
  315. Read a byte from the stream advancing the position.
  316. </summary>
  317. <returns>The byte read cast to an int; -1 if end of stream.</returns>
  318. </member>
  319. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Read(System.Byte[],System.Int32,System.Int32)">
  320. <summary>
  321. Read a block of bytes
  322. </summary>
  323. <param name="buffer">The buffer to read into.</param>
  324. <param name="offset">The offset in the buffer to start storing data at.</param>
  325. <param name="count">The maximum number of bytes to read.</param>
  326. <returns>The total number of bytes read. This might be less than the number of bytes
  327. requested if that number of bytes are not currently available, or zero
  328. if the end of the stream is reached.</returns>
  329. </member>
  330. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  331. <summary>
  332. Write a block of bytes to the stream
  333. </summary>
  334. <param name="buffer">The buffer containing data to write.</param>
  335. <param name="offset">The offset of the first byte to write.</param>
  336. <param name="count">The number of bytes to write.</param>
  337. </member>
  338. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.WriteByte(System.Byte)">
  339. <summary>
  340. Write a byte to the stream.
  341. </summary>
  342. <param name="value">The byte to write to the stream.</param>
  343. </member>
  344. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.WriteRun">
  345. <summary>
  346. Get the number of bytes written to output.
  347. </summary>
  348. </member>
  349. <member name="P:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.BytesWritten">
  350. <summary>
  351. Get the number of bytes written to the output.
  352. </summary>
  353. </member>
  354. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Dispose(System.Boolean)">
  355. <summary>
  356. Releases the unmanaged resources used by the <see cref="T:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream"/> and optionally releases the managed resources.
  357. </summary>
  358. <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  359. </member>
  360. <member name="M:ICSharpCode.SharpZipLib.BZip2.BZip2OutputStream.Flush">
  361. <summary>
  362. Flush output buffers
  363. </summary>
  364. </member>
  365. <member name="T:ICSharpCode.SharpZipLib.Checksum.Adler32">
  366. <summary>
  367. Computes Adler32 checksum for a stream of data. An Adler32
  368. checksum is not as reliable as a CRC32 checksum, but a lot faster to
  369. compute.
  370. The specification for Adler32 may be found in RFC 1950.
  371. ZLIB Compressed Data Format Specification version 3.3)
  372. From that document:
  373. "ADLER32 (Adler-32 checksum)
  374. This contains a checksum value of the uncompressed data
  375. (excluding any dictionary data) computed according to Adler-32
  376. algorithm. This algorithm is a 32-bit extension and improvement
  377. of the Fletcher algorithm, used in the ITU-T X.224 / ISO 8073
  378. standard.
  379. Adler-32 is composed of two sums accumulated per byte: s1 is
  380. the sum of all bytes, s2 is the sum of all s1 values. Both sums
  381. are done modulo 65521. s1 is initialized to 1, s2 to zero. The
  382. Adler-32 checksum is stored as s2*65536 + s1 in most-
  383. significant-byte first (network) order."
  384. "8.2. The Adler-32 algorithm
  385. The Adler-32 algorithm is much faster than the CRC32 algorithm yet
  386. still provides an extremely low probability of undetected errors.
  387. The modulo on unsigned long accumulators can be delayed for 5552
  388. bytes, so the modulo operation time is negligible. If the bytes
  389. are a, b, c, the second sum is 3a + 2b + c + 3, and so is position
  390. and order sensitive, unlike the first sum, which is just a
  391. checksum. That 65521 is prime is important to avoid a possible
  392. large class of two-byte errors that leave the check unchanged.
  393. (The Fletcher checksum uses 255, which is not prime and which also
  394. makes the Fletcher check insensitive to single byte changes 0 -
  395. 255.)
  396. The sum s1 is initialized to 1 instead of zero to make the length
  397. of the sequence part of s2, so that the length does not have to be
  398. checked separately. (Any sequence of zeroes has a Fletcher
  399. checksum of zero.)"
  400. </summary>
  401. <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream"/>
  402. <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream"/>
  403. </member>
  404. <member name="F:ICSharpCode.SharpZipLib.Checksum.Adler32.BASE">
  405. <summary>
  406. largest prime smaller than 65536
  407. </summary>
  408. </member>
  409. <member name="F:ICSharpCode.SharpZipLib.Checksum.Adler32.checkValue">
  410. <summary>
  411. The CRC data checksum so far.
  412. </summary>
  413. </member>
  414. <member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.#ctor">
  415. <summary>
  416. Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Checksum.Adler32"></see>
  417. </summary>
  418. </member>
  419. <member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.Reset">
  420. <summary>
  421. Resets the Adler32 data checksum as if no update was ever called.
  422. </summary>
  423. </member>
  424. <member name="P:ICSharpCode.SharpZipLib.Checksum.Adler32.Value">
  425. <summary>
  426. Returns the Adler32 data checksum computed so far.
  427. </summary>
  428. </member>
  429. <member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.Update(System.Int32)">
  430. <summary>
  431. Updates the checksum with the byte b.
  432. </summary>
  433. <param name="bval">
  434. The data value to add. The high byte of the int is ignored.
  435. </param>
  436. </member>
  437. <member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.Update(System.Byte[])">
  438. <summary>
  439. Updates the Adler32 data checksum with the bytes taken from
  440. a block of data.
  441. </summary>
  442. <param name="buffer">Contains the data to update the checksum with.</param>
  443. </member>
  444. <member name="M:ICSharpCode.SharpZipLib.Checksum.Adler32.Update(System.ArraySegment{System.Byte})">
  445. <summary>
  446. Update Adler32 data checksum based on a portion of a block of data
  447. </summary>
  448. <param name = "segment">
  449. The chunk of data to add
  450. </param>
  451. </member>
  452. <member name="T:ICSharpCode.SharpZipLib.Checksum.BZip2Crc">
  453. <summary>
  454. CRC-32 with unreversed data and reversed output
  455. </summary>
  456. <remarks>
  457. Generate a table for a byte-wise 32-bit CRC calculation on the polynomial:
  458. x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x^1+x^0.
  459. Polynomials over GF(2) are represented in binary, one bit per coefficient,
  460. with the lowest powers in the most significant bit. Then adding polynomials
  461. is just exclusive-or, and multiplying a polynomial by x is a right shift by
  462. one. If we call the above polynomial p, and represent a byte as the
  463. polynomial q, also with the lowest power in the most significant bit (so the
  464. byte 0xb1 is the polynomial x^7+x^3+x+1), then the CRC is (q*x^32) mod p,
  465. where a mod b means the remainder after dividing a by b.
  466. This calculation is done using the shift-register method of multiplying and
  467. taking the remainder. The register is initialized to zero, and for each
  468. incoming bit, x^32 is added mod p to the register if the bit is a one (where
  469. x^32 mod p is p+x^32 = x^26+...+1), and the register is multiplied mod p by
  470. x (which is shifting right by one and adding x^32 mod p if the bit shifted
  471. out is a one). We start with the highest power (least significant bit) of
  472. q and repeat for all eight bits of q.
  473. This implementation uses sixteen lookup tables stored in one linear array
  474. to implement the slicing-by-16 algorithm, a variant of the slicing-by-8
  475. algorithm described in this Intel white paper:
  476. https://web.archive.org/web/20120722193753/http://download.intel.com/technology/comms/perfnet/download/slicing-by-8.pdf
  477. The first lookup table is simply the CRC of all possible eight bit values.
  478. Each successive lookup table is derived from the original table generated
  479. by Sarwate's algorithm. Slicing a 16-bit input and XORing the outputs
  480. together will produce the same output as a byte-by-byte CRC loop with
  481. fewer arithmetic and bit manipulation operations, at the cost of increased
  482. memory consumed by the lookup tables. (Slicing-by-16 requires a 16KB table,
  483. which is still small enough to fit in most processors' L1 cache.)
  484. </remarks>
  485. </member>
  486. <member name="F:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.checkValue">
  487. <summary>
  488. The CRC data checksum so far.
  489. </summary>
  490. </member>
  491. <member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.#ctor">
  492. <summary>
  493. Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Checksum.BZip2Crc"></see>
  494. </summary>
  495. </member>
  496. <member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Reset">
  497. <summary>
  498. Resets the CRC data checksum as if no update was ever called.
  499. </summary>
  500. </member>
  501. <member name="P:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Value">
  502. <summary>
  503. Returns the CRC data checksum computed so far.
  504. </summary>
  505. <remarks>Reversed Out = true</remarks>
  506. </member>
  507. <member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Update(System.Int32)">
  508. <summary>
  509. Updates the checksum with the int bval.
  510. </summary>
  511. <param name = "bval">
  512. the byte is taken as the lower 8 bits of bval
  513. </param>
  514. <remarks>Reversed Data = false</remarks>
  515. </member>
  516. <member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Update(System.Byte[])">
  517. <summary>
  518. Updates the CRC data checksum with the bytes taken from
  519. a block of data.
  520. </summary>
  521. <param name="buffer">Contains the data to update the CRC with.</param>
  522. </member>
  523. <member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Update(System.ArraySegment{System.Byte})">
  524. <summary>
  525. Update CRC data checksum based on a portion of a block of data
  526. </summary>
  527. <param name = "segment">
  528. The chunk of data to add
  529. </param>
  530. </member>
  531. <member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.Update(System.Byte[],System.Int32,System.Int32)">
  532. <summary>
  533. Internal helper function for updating a block of data using slicing.
  534. </summary>
  535. <param name="data">The array containing the data to add</param>
  536. <param name="offset">Range start for <paramref name="data"/> (inclusive)</param>
  537. <param name="count">The number of bytes to checksum starting from <paramref name="offset"/></param>
  538. </member>
  539. <member name="M:ICSharpCode.SharpZipLib.Checksum.BZip2Crc.SlowUpdateLoop(System.Byte[],System.Int32,System.Int32)">
  540. <summary>
  541. A non-inlined function for updating data that doesn't fit in a 16-byte
  542. block. We don't expect to enter this function most of the time, and when
  543. we do we're not here for long, so disabling inlining here improves
  544. performance overall.
  545. </summary>
  546. <param name="data">The array containing the data to add</param>
  547. <param name="offset">Range start for <paramref name="data"/> (inclusive)</param>
  548. <param name="end">Range end for <paramref name="data"/> (exclusive)</param>
  549. </member>
  550. <member name="T:ICSharpCode.SharpZipLib.Checksum.Crc32">
  551. <summary>
  552. CRC-32 with reversed data and unreversed output
  553. </summary>
  554. <remarks>
  555. Generate a table for a byte-wise 32-bit CRC calculation on the polynomial:
  556. x^32+x^26+x^23+x^22+x^16+x^12+x^11+x^10+x^8+x^7+x^5+x^4+x^2+x^1+x^0.
  557. Polynomials over GF(2) are represented in binary, one bit per coefficient,
  558. with the lowest powers in the most significant bit. Then adding polynomials
  559. is just exclusive-or, and multiplying a polynomial by x is a right shift by
  560. one. If we call the above polynomial p, and represent a byte as the
  561. polynomial q, also with the lowest power in the most significant bit (so the
  562. byte 0xb1 is the polynomial x^7+x^3+x+1), then the CRC is (q*x^32) mod p,
  563. where a mod b means the remainder after dividing a by b.
  564. This calculation is done using the shift-register method of multiplying and
  565. taking the remainder. The register is initialized to zero, and for each
  566. incoming bit, x^32 is added mod p to the register if the bit is a one (where
  567. x^32 mod p is p+x^32 = x^26+...+1), and the register is multiplied mod p by
  568. x (which is shifting right by one and adding x^32 mod p if the bit shifted
  569. out is a one). We start with the highest power (least significant bit) of
  570. q and repeat for all eight bits of q.
  571. This implementation uses sixteen lookup tables stored in one linear array
  572. to implement the slicing-by-16 algorithm, a variant of the slicing-by-8
  573. algorithm described in this Intel white paper:
  574. https://web.archive.org/web/20120722193753/http://download.intel.com/technology/comms/perfnet/download/slicing-by-8.pdf
  575. The first lookup table is simply the CRC of all possible eight bit values.
  576. Each successive lookup table is derived from the original table generated
  577. by Sarwate's algorithm. Slicing a 16-bit input and XORing the outputs
  578. together will produce the same output as a byte-by-byte CRC loop with
  579. fewer arithmetic and bit manipulation operations, at the cost of increased
  580. memory consumed by the lookup tables. (Slicing-by-16 requires a 16KB table,
  581. which is still small enough to fit in most processors' L1 cache.)
  582. </remarks>
  583. </member>
  584. <member name="F:ICSharpCode.SharpZipLib.Checksum.Crc32.checkValue">
  585. <summary>
  586. The CRC data checksum so far.
  587. </summary>
  588. </member>
  589. <member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.#ctor">
  590. <summary>
  591. Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Checksum.Crc32"></see>
  592. </summary>
  593. </member>
  594. <member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Reset">
  595. <summary>
  596. Resets the CRC data checksum as if no update was ever called.
  597. </summary>
  598. </member>
  599. <member name="P:ICSharpCode.SharpZipLib.Checksum.Crc32.Value">
  600. <summary>
  601. Returns the CRC data checksum computed so far.
  602. </summary>
  603. <remarks>Reversed Out = false</remarks>
  604. </member>
  605. <member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Update(System.Int32)">
  606. <summary>
  607. Updates the checksum with the int bval.
  608. </summary>
  609. <param name = "bval">
  610. the byte is taken as the lower 8 bits of bval
  611. </param>
  612. <remarks>Reversed Data = true</remarks>
  613. </member>
  614. <member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Update(System.Byte[])">
  615. <summary>
  616. Updates the CRC data checksum with the bytes taken from
  617. a block of data.
  618. </summary>
  619. <param name="buffer">Contains the data to update the CRC with.</param>
  620. </member>
  621. <member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Update(System.ArraySegment{System.Byte})">
  622. <summary>
  623. Update CRC data checksum based on a portion of a block of data
  624. </summary>
  625. <param name = "segment">
  626. The chunk of data to add
  627. </param>
  628. </member>
  629. <member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.Update(System.Byte[],System.Int32,System.Int32)">
  630. <summary>
  631. Internal helper function for updating a block of data using slicing.
  632. </summary>
  633. <param name="data">The array containing the data to add</param>
  634. <param name="offset">Range start for <paramref name="data"/> (inclusive)</param>
  635. <param name="count">The number of bytes to checksum starting from <paramref name="offset"/></param>
  636. </member>
  637. <member name="M:ICSharpCode.SharpZipLib.Checksum.Crc32.SlowUpdateLoop(System.Byte[],System.Int32,System.Int32)">
  638. <summary>
  639. A non-inlined function for updating data that doesn't fit in a 16-byte
  640. block. We don't expect to enter this function most of the time, and when
  641. we do we're not here for long, so disabling inlining here improves
  642. performance overall.
  643. </summary>
  644. <param name="data">The array containing the data to add</param>
  645. <param name="offset">Range start for <paramref name="data"/> (inclusive)</param>
  646. <param name="end">Range end for <paramref name="data"/> (exclusive)</param>
  647. </member>
  648. <member name="F:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.SlicingDegree">
  649. <summary>
  650. The number of slicing lookup tables to generate.
  651. </summary>
  652. </member>
  653. <member name="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.GenerateSlicingLookupTable(System.UInt32,System.Boolean)">
  654. <summary>
  655. Generates multiple CRC lookup tables for a given polynomial, stored
  656. in a linear array of uints. The first block (i.e. the first 256
  657. elements) is the same as the byte-by-byte CRC lookup table.
  658. </summary>
  659. <param name="polynomial">The generating CRC polynomial</param>
  660. <param name="isReversed">Whether the polynomial is in reversed bit order</param>
  661. <returns>A linear array of 256 * <see cref="F:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.SlicingDegree"/> elements</returns>
  662. <remarks>
  663. This table could also be generated as a rectangular array, but the
  664. JIT compiler generates slower code than if we use a linear array.
  665. Known issue, see: https://github.com/dotnet/runtime/issues/30275
  666. </remarks>
  667. </member>
  668. <member name="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataForNormalPoly(System.Byte[],System.Int32,System.UInt32[],System.UInt32)">
  669. <summary>
  670. Mixes the first four bytes of input with <paramref name="checkValue"/>
  671. using normal ordering before calling <see cref="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataCommon(System.Byte[],System.Int32,System.UInt32[],System.Byte,System.Byte,System.Byte,System.Byte)"/>.
  672. </summary>
  673. <param name="input">Array of data to checksum</param>
  674. <param name="offset">Offset to start reading <paramref name="input"/> from</param>
  675. <param name="crcTable">The table to use for slicing-by-16 lookup</param>
  676. <param name="checkValue">Checksum state before this update call</param>
  677. <returns>A new unfinalized checksum value</returns>
  678. <seealso cref="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataForReversedPoly(System.Byte[],System.Int32,System.UInt32[],System.UInt32)"/>
  679. <remarks>
  680. Assumes input[offset]..input[offset + 15] are valid array indexes.
  681. For performance reasons, this must be checked by the caller.
  682. </remarks>
  683. </member>
  684. <member name="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataForReversedPoly(System.Byte[],System.Int32,System.UInt32[],System.UInt32)">
  685. <summary>
  686. Mixes the first four bytes of input with <paramref name="checkValue"/>
  687. using reflected ordering before calling <see cref="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataCommon(System.Byte[],System.Int32,System.UInt32[],System.Byte,System.Byte,System.Byte,System.Byte)"/>.
  688. </summary>
  689. <param name="input">Array of data to checksum</param>
  690. <param name="offset">Offset to start reading <paramref name="input"/> from</param>
  691. <param name="crcTable">The table to use for slicing-by-16 lookup</param>
  692. <param name="checkValue">Checksum state before this update call</param>
  693. <returns>A new unfinalized checksum value</returns>
  694. <seealso cref="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataForNormalPoly(System.Byte[],System.Int32,System.UInt32[],System.UInt32)"/>
  695. <remarks>
  696. Assumes input[offset]..input[offset + 15] are valid array indexes.
  697. For performance reasons, this must be checked by the caller.
  698. </remarks>
  699. </member>
  700. <member name="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataCommon(System.Byte[],System.Int32,System.UInt32[],System.Byte,System.Byte,System.Byte,System.Byte)">
  701. <summary>
  702. A shared method for updating an unfinalized CRC checksum using slicing-by-16.
  703. </summary>
  704. <param name="input">Array of data to checksum</param>
  705. <param name="offset">Offset to start reading <paramref name="input"/> from</param>
  706. <param name="crcTable">The table to use for slicing-by-16 lookup</param>
  707. <param name="x1">First byte of input after mixing with the old CRC</param>
  708. <param name="x2">Second byte of input after mixing with the old CRC</param>
  709. <param name="x3">Third byte of input after mixing with the old CRC</param>
  710. <param name="x4">Fourth byte of input after mixing with the old CRC</param>
  711. <returns>A new unfinalized checksum value</returns>
  712. <remarks>
  713. <para>
  714. Even though the first four bytes of input are fed in as arguments,
  715. <paramref name="offset"/> should be the same value passed to this
  716. function's caller (either <see cref="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataForNormalPoly(System.Byte[],System.Int32,System.UInt32[],System.UInt32)"/> or
  717. <see cref="M:ICSharpCode.SharpZipLib.Checksum.CrcUtilities.UpdateDataForReversedPoly(System.Byte[],System.Int32,System.UInt32[],System.UInt32)"/>). This method will get inlined
  718. into both functions, so using the same offset produces faster code.
  719. </para>
  720. <para>
  721. Because most processors running C# have some kind of instruction-level
  722. parallelism, the order of XOR operations can affect performance. This
  723. ordering assumes that the assembly code generated by the just-in-time
  724. compiler will emit a bunch of arithmetic operations for checking array
  725. bounds. Then it opportunistically XORs a1 and a2 to keep the processor
  726. busy while those other parts of the pipeline handle the range check
  727. calculations.
  728. </para>
  729. </remarks>
  730. </member>
  731. <member name="T:ICSharpCode.SharpZipLib.Checksum.IChecksum">
  732. <summary>
  733. Interface to compute a data checksum used by checked input/output streams.
  734. A data checksum can be updated by one byte or with a byte array. After each
  735. update the value of the current checksum can be returned by calling
  736. <code>getValue</code>. The complete checksum object can also be reset
  737. so it can be used again with new data.
  738. </summary>
  739. </member>
  740. <member name="M:ICSharpCode.SharpZipLib.Checksum.IChecksum.Reset">
  741. <summary>
  742. Resets the data checksum as if no update was ever called.
  743. </summary>
  744. </member>
  745. <member name="P:ICSharpCode.SharpZipLib.Checksum.IChecksum.Value">
  746. <summary>
  747. Returns the data checksum computed so far.
  748. </summary>
  749. </member>
  750. <member name="M:ICSharpCode.SharpZipLib.Checksum.IChecksum.Update(System.Int32)">
  751. <summary>
  752. Adds one byte to the data checksum.
  753. </summary>
  754. <param name = "bval">
  755. the data value to add. The high byte of the int is ignored.
  756. </param>
  757. </member>
  758. <member name="M:ICSharpCode.SharpZipLib.Checksum.IChecksum.Update(System.Byte[])">
  759. <summary>
  760. Updates the data checksum with the bytes taken from the array.
  761. </summary>
  762. <param name="buffer">
  763. buffer an array of bytes
  764. </param>
  765. </member>
  766. <member name="M:ICSharpCode.SharpZipLib.Checksum.IChecksum.Update(System.ArraySegment{System.Byte})">
  767. <summary>
  768. Adds the byte array to the data checksum.
  769. </summary>
  770. <param name = "segment">
  771. The chunk of data to add
  772. </param>
  773. </member>
  774. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.ReadLEShort(System.IO.Stream)">
  775. <summary> Read an unsigned short in little endian byte order. </summary>
  776. </member>
  777. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.ReadLEInt(System.IO.Stream)">
  778. <summary> Read an int in little endian byte order. </summary>
  779. </member>
  780. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.ReadLELong(System.IO.Stream)">
  781. <summary> Read a long in little endian byte order. </summary>
  782. </member>
  783. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEShort(System.IO.Stream,System.Int32)">
  784. <summary> Write an unsigned short in little endian byte order. </summary>
  785. </member>
  786. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEShortAsync(System.IO.Stream,System.Int32,System.Threading.CancellationToken)">
  787. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEShort(System.IO.Stream,System.Int32)"/>
  788. </member>
  789. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUshort(System.IO.Stream,System.UInt16)">
  790. <summary> Write a ushort in little endian byte order. </summary>
  791. </member>
  792. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUshortAsync(System.IO.Stream,System.UInt16,System.Threading.CancellationToken)">
  793. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUshort(System.IO.Stream,System.UInt16)"/>
  794. </member>
  795. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEInt(System.IO.Stream,System.Int32)">
  796. <summary> Write an int in little endian byte order. </summary>
  797. </member>
  798. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEIntAsync(System.IO.Stream,System.Int32,System.Threading.CancellationToken)">
  799. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEInt(System.IO.Stream,System.Int32)"/>
  800. </member>
  801. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUint(System.IO.Stream,System.UInt32)">
  802. <summary> Write a uint in little endian byte order. </summary>
  803. </member>
  804. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUintAsync(System.IO.Stream,System.UInt32,System.Threading.CancellationToken)">
  805. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUint(System.IO.Stream,System.UInt32)"/>
  806. </member>
  807. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLELong(System.IO.Stream,System.Int64)">
  808. <summary> Write a long in little endian byte order. </summary>
  809. </member>
  810. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLELongAsync(System.IO.Stream,System.Int64,System.Threading.CancellationToken)">
  811. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLELong(System.IO.Stream,System.Int64)"/>
  812. </member>
  813. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUlong(System.IO.Stream,System.UInt64)">
  814. <summary> Write a ulong in little endian byte order. </summary>
  815. </member>
  816. <member name="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUlongAsync(System.IO.Stream,System.UInt64,System.Threading.CancellationToken)">
  817. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Core.ByteOrderStreamExtensions.WriteLEUlong(System.IO.Stream,System.UInt64)"/>
  818. </member>
  819. <member name="T:ICSharpCode.SharpZipLib.Core.ExactMemoryPool`1">
  820. <summary>
  821. A MemoryPool that will return a Memory which is exactly the length asked for using the bufferSize parameter.
  822. This is in contrast to the default ArrayMemoryPool which will return a Memory of equal size to the underlying
  823. array which at least as long as the minBufferSize parameter.
  824. Note: The underlying array may be larger than the slice of Memory
  825. </summary>
  826. <typeparam name="T"></typeparam>
  827. </member>
  828. <member name="T:ICSharpCode.SharpZipLib.Core.ScanEventArgs">
  829. <summary>
  830. Event arguments for scanning.
  831. </summary>
  832. </member>
  833. <member name="M:ICSharpCode.SharpZipLib.Core.ScanEventArgs.#ctor(System.String)">
  834. <summary>
  835. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.ScanEventArgs"/>
  836. </summary>
  837. <param name="name">The file or directory name.</param>
  838. </member>
  839. <member name="P:ICSharpCode.SharpZipLib.Core.ScanEventArgs.Name">
  840. <summary>
  841. The file or directory name for this event.
  842. </summary>
  843. </member>
  844. <member name="P:ICSharpCode.SharpZipLib.Core.ScanEventArgs.ContinueRunning">
  845. <summary>
  846. Get set a value indicating if scanning should continue or not.
  847. </summary>
  848. </member>
  849. <member name="T:ICSharpCode.SharpZipLib.Core.ProgressEventArgs">
  850. <summary>
  851. Event arguments during processing of a single file or directory.
  852. </summary>
  853. </member>
  854. <member name="M:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.#ctor(System.String,System.Int64,System.Int64)">
  855. <summary>
  856. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.ScanEventArgs"/>
  857. </summary>
  858. <param name="name">The file or directory name if known.</param>
  859. <param name="processed">The number of bytes processed so far</param>
  860. <param name="target">The total number of bytes to process, 0 if not known</param>
  861. </member>
  862. <member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.Name">
  863. <summary>
  864. The name for this event if known.
  865. </summary>
  866. </member>
  867. <member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.ContinueRunning">
  868. <summary>
  869. Get set a value indicating whether scanning should continue or not.
  870. </summary>
  871. </member>
  872. <member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.PercentComplete">
  873. <summary>
  874. Get a percentage representing how much of the <see cref="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.Target"></see> has been processed
  875. </summary>
  876. <value>0.0 to 100.0 percent; 0 if target is not known.</value>
  877. </member>
  878. <member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.Processed">
  879. <summary>
  880. The number of bytes processed so far
  881. </summary>
  882. </member>
  883. <member name="P:ICSharpCode.SharpZipLib.Core.ProgressEventArgs.Target">
  884. <summary>
  885. The number of bytes to process.
  886. </summary>
  887. <remarks>Target may be 0 or negative if the value isnt known.</remarks>
  888. </member>
  889. <member name="T:ICSharpCode.SharpZipLib.Core.DirectoryEventArgs">
  890. <summary>
  891. Event arguments for directories.
  892. </summary>
  893. </member>
  894. <member name="M:ICSharpCode.SharpZipLib.Core.DirectoryEventArgs.#ctor(System.String,System.Boolean)">
  895. <summary>
  896. Initialize an instance of <see cref="T:ICSharpCode.SharpZipLib.Core.DirectoryEventArgs"></see>.
  897. </summary>
  898. <param name="name">The name for this directory.</param>
  899. <param name="hasMatchingFiles">Flag value indicating if any matching files are contained in this directory.</param>
  900. </member>
  901. <member name="P:ICSharpCode.SharpZipLib.Core.DirectoryEventArgs.HasMatchingFiles">
  902. <summary>
  903. Get a value indicating if the directory contains any matching files or not.
  904. </summary>
  905. </member>
  906. <member name="T:ICSharpCode.SharpZipLib.Core.ScanFailureEventArgs">
  907. <summary>
  908. Arguments passed when scan failures are detected.
  909. </summary>
  910. </member>
  911. <member name="M:ICSharpCode.SharpZipLib.Core.ScanFailureEventArgs.#ctor(System.String,System.Exception)">
  912. <summary>
  913. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.ScanFailureEventArgs"></see>
  914. </summary>
  915. <param name="name">The name to apply.</param>
  916. <param name="e">The exception to use.</param>
  917. </member>
  918. <member name="P:ICSharpCode.SharpZipLib.Core.ScanFailureEventArgs.Name">
  919. <summary>
  920. The applicable name.
  921. </summary>
  922. </member>
  923. <member name="P:ICSharpCode.SharpZipLib.Core.ScanFailureEventArgs.Exception">
  924. <summary>
  925. The applicable exception.
  926. </summary>
  927. </member>
  928. <member name="P:ICSharpCode.SharpZipLib.Core.ScanFailureEventArgs.ContinueRunning">
  929. <summary>
  930. Get / set a value indicating whether scanning should continue.
  931. </summary>
  932. </member>
  933. <member name="T:ICSharpCode.SharpZipLib.Core.ProcessFileHandler">
  934. <summary>
  935. Delegate invoked before starting to process a file.
  936. </summary>
  937. <param name="sender">The source of the event</param>
  938. <param name="e">The event arguments.</param>
  939. </member>
  940. <member name="T:ICSharpCode.SharpZipLib.Core.ProgressHandler">
  941. <summary>
  942. Delegate invoked during processing of a file or directory
  943. </summary>
  944. <param name="sender">The source of the event</param>
  945. <param name="e">The event arguments.</param>
  946. </member>
  947. <member name="T:ICSharpCode.SharpZipLib.Core.CompletedFileHandler">
  948. <summary>
  949. Delegate invoked when a file has been completely processed.
  950. </summary>
  951. <param name="sender">The source of the event</param>
  952. <param name="e">The event arguments.</param>
  953. </member>
  954. <member name="T:ICSharpCode.SharpZipLib.Core.DirectoryFailureHandler">
  955. <summary>
  956. Delegate invoked when a directory failure is detected.
  957. </summary>
  958. <param name="sender">The source of the event</param>
  959. <param name="e">The event arguments.</param>
  960. </member>
  961. <member name="T:ICSharpCode.SharpZipLib.Core.FileFailureHandler">
  962. <summary>
  963. Delegate invoked when a file failure is detected.
  964. </summary>
  965. <param name="sender">The source of the event</param>
  966. <param name="e">The event arguments.</param>
  967. </member>
  968. <member name="T:ICSharpCode.SharpZipLib.Core.FileSystemScanner">
  969. <summary>
  970. FileSystemScanner provides facilities scanning of files and directories.
  971. </summary>
  972. </member>
  973. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.#ctor(System.String)">
  974. <summary>
  975. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.FileSystemScanner"></see>
  976. </summary>
  977. <param name="filter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">file filter</see> to apply when scanning.</param>
  978. </member>
  979. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.#ctor(System.String,System.String)">
  980. <summary>
  981. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.FileSystemScanner"></see>
  982. </summary>
  983. <param name="fileFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">file filter</see> to apply.</param>
  984. <param name="directoryFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter"> directory filter</see> to apply.</param>
  985. </member>
  986. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.#ctor(ICSharpCode.SharpZipLib.Core.IScanFilter)">
  987. <summary>
  988. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.FileSystemScanner"></see>
  989. </summary>
  990. <param name="fileFilter">The file <see cref="T:ICSharpCode.SharpZipLib.Core.IScanFilter">filter</see> to apply.</param>
  991. </member>
  992. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.#ctor(ICSharpCode.SharpZipLib.Core.IScanFilter,ICSharpCode.SharpZipLib.Core.IScanFilter)">
  993. <summary>
  994. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.FileSystemScanner"></see>
  995. </summary>
  996. <param name="fileFilter">The file <see cref="T:ICSharpCode.SharpZipLib.Core.IScanFilter">filter</see> to apply.</param>
  997. <param name="directoryFilter">The directory <see cref="T:ICSharpCode.SharpZipLib.Core.IScanFilter">filter</see> to apply.</param>
  998. </member>
  999. <member name="E:ICSharpCode.SharpZipLib.Core.FileSystemScanner.ProcessDirectory">
  1000. <summary>
  1001. Delegate to invoke when a directory is processed.
  1002. </summary>
  1003. </member>
  1004. <member name="F:ICSharpCode.SharpZipLib.Core.FileSystemScanner.ProcessFile">
  1005. <summary>
  1006. Delegate to invoke when a file is processed.
  1007. </summary>
  1008. </member>
  1009. <member name="F:ICSharpCode.SharpZipLib.Core.FileSystemScanner.CompletedFile">
  1010. <summary>
  1011. Delegate to invoke when processing for a file has finished.
  1012. </summary>
  1013. </member>
  1014. <member name="F:ICSharpCode.SharpZipLib.Core.FileSystemScanner.DirectoryFailure">
  1015. <summary>
  1016. Delegate to invoke when a directory failure is detected.
  1017. </summary>
  1018. </member>
  1019. <member name="F:ICSharpCode.SharpZipLib.Core.FileSystemScanner.FileFailure">
  1020. <summary>
  1021. Delegate to invoke when a file failure is detected.
  1022. </summary>
  1023. </member>
  1024. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.OnDirectoryFailure(System.String,System.Exception)">
  1025. <summary>
  1026. Raise the DirectoryFailure event.
  1027. </summary>
  1028. <param name="directory">The directory name.</param>
  1029. <param name="e">The exception detected.</param>
  1030. </member>
  1031. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.OnFileFailure(System.String,System.Exception)">
  1032. <summary>
  1033. Raise the FileFailure event.
  1034. </summary>
  1035. <param name="file">The file name.</param>
  1036. <param name="e">The exception detected.</param>
  1037. </member>
  1038. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.OnProcessFile(System.String)">
  1039. <summary>
  1040. Raise the ProcessFile event.
  1041. </summary>
  1042. <param name="file">The file name.</param>
  1043. </member>
  1044. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.OnCompleteFile(System.String)">
  1045. <summary>
  1046. Raise the complete file event
  1047. </summary>
  1048. <param name="file">The file name</param>
  1049. </member>
  1050. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.OnProcessDirectory(System.String,System.Boolean)">
  1051. <summary>
  1052. Raise the ProcessDirectory event.
  1053. </summary>
  1054. <param name="directory">The directory name.</param>
  1055. <param name="hasMatchingFiles">Flag indicating if the directory has matching files.</param>
  1056. </member>
  1057. <member name="M:ICSharpCode.SharpZipLib.Core.FileSystemScanner.Scan(System.String,System.Boolean)">
  1058. <summary>
  1059. Scan a directory.
  1060. </summary>
  1061. <param name="directory">The base directory to scan.</param>
  1062. <param name="recurse">True to recurse subdirectories, false to scan a single directory.</param>
  1063. </member>
  1064. <member name="F:ICSharpCode.SharpZipLib.Core.FileSystemScanner.fileFilter_">
  1065. <summary>
  1066. The file filter currently in use.
  1067. </summary>
  1068. </member>
  1069. <member name="F:ICSharpCode.SharpZipLib.Core.FileSystemScanner.directoryFilter_">
  1070. <summary>
  1071. The directory filter currently in use.
  1072. </summary>
  1073. </member>
  1074. <member name="F:ICSharpCode.SharpZipLib.Core.FileSystemScanner.alive_">
  1075. <summary>
  1076. Flag indicating if scanning should continue running.
  1077. </summary>
  1078. </member>
  1079. <member name="T:ICSharpCode.SharpZipLib.Core.INameTransform">
  1080. <summary>
  1081. INameTransform defines how file system names are transformed for use with archives, or vice versa.
  1082. </summary>
  1083. </member>
  1084. <member name="M:ICSharpCode.SharpZipLib.Core.INameTransform.TransformFile(System.String)">
  1085. <summary>
  1086. Given a file name determine the transformed value.
  1087. </summary>
  1088. <param name="name">The name to transform.</param>
  1089. <returns>The transformed file name.</returns>
  1090. </member>
  1091. <member name="M:ICSharpCode.SharpZipLib.Core.INameTransform.TransformDirectory(System.String)">
  1092. <summary>
  1093. Given a directory name determine the transformed value.
  1094. </summary>
  1095. <param name="name">The name to transform.</param>
  1096. <returns>The transformed directory name</returns>
  1097. </member>
  1098. <member name="T:ICSharpCode.SharpZipLib.Core.InvalidNameException">
  1099. <summary>
  1100. InvalidNameException is thrown for invalid names such as directory traversal paths and names with invalid characters
  1101. </summary>
  1102. </member>
  1103. <member name="M:ICSharpCode.SharpZipLib.Core.InvalidNameException.#ctor">
  1104. <summary>
  1105. Initializes a new instance of the InvalidNameException class with a default error message.
  1106. </summary>
  1107. </member>
  1108. <member name="M:ICSharpCode.SharpZipLib.Core.InvalidNameException.#ctor(System.String)">
  1109. <summary>
  1110. Initializes a new instance of the InvalidNameException class with a specified error message.
  1111. </summary>
  1112. <param name="message">A message describing the exception.</param>
  1113. </member>
  1114. <member name="M:ICSharpCode.SharpZipLib.Core.InvalidNameException.#ctor(System.String,System.Exception)">
  1115. <summary>
  1116. Initializes a new instance of the InvalidNameException class with a specified
  1117. error message and a reference to the inner exception that is the cause of this exception.
  1118. </summary>
  1119. <param name="message">A message describing the exception.</param>
  1120. <param name="innerException">The inner exception</param>
  1121. </member>
  1122. <member name="M:ICSharpCode.SharpZipLib.Core.InvalidNameException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1123. <summary>
  1124. Initializes a new instance of the InvalidNameException class with serialized data.
  1125. </summary>
  1126. <param name="info">
  1127. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  1128. object data about the exception being thrown.
  1129. </param>
  1130. <param name="context">
  1131. The System.Runtime.Serialization.StreamingContext that contains contextual information
  1132. about the source or destination.
  1133. </param>
  1134. </member>
  1135. <member name="T:ICSharpCode.SharpZipLib.Core.IScanFilter">
  1136. <summary>
  1137. Scanning filters support filtering of names.
  1138. </summary>
  1139. </member>
  1140. <member name="M:ICSharpCode.SharpZipLib.Core.IScanFilter.IsMatch(System.String)">
  1141. <summary>
  1142. Test a name to see if it 'matches' the filter.
  1143. </summary>
  1144. <param name="name">The name to test.</param>
  1145. <returns>Returns true if the name matches the filter, false if it does not match.</returns>
  1146. </member>
  1147. <member name="T:ICSharpCode.SharpZipLib.Core.NameFilter">
  1148. <summary>
  1149. NameFilter is a string matching class which allows for both positive and negative
  1150. matching.
  1151. A filter is a sequence of independant <see cref="T:System.Text.RegularExpressions.Regex">regular expressions</see> separated by semi-colons ';'.
  1152. To include a semi-colon it may be quoted as in \;. Each expression can be prefixed by a plus '+' sign or
  1153. a minus '-' sign to denote the expression is intended to include or exclude names.
  1154. If neither a plus or minus sign is found include is the default.
  1155. A given name is tested for inclusion before checking exclusions. Only names matching an include spec
  1156. and not matching an exclude spec are deemed to match the filter.
  1157. An empty filter matches any name.
  1158. </summary>
  1159. <example>The following expression includes all name ending in '.dat' with the exception of 'dummy.dat'
  1160. "+\.dat$;-^dummy\.dat$"
  1161. </example>
  1162. </member>
  1163. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.#ctor(System.String)">
  1164. <summary>
  1165. Construct an instance based on the filter expression passed
  1166. </summary>
  1167. <param name="filter">The filter expression.</param>
  1168. </member>
  1169. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsValidExpression(System.String)">
  1170. <summary>
  1171. Test a string to see if it is a valid regular expression.
  1172. </summary>
  1173. <param name="expression">The expression to test.</param>
  1174. <returns>True if expression is a valid <see cref="T:System.Text.RegularExpressions.Regex"/> false otherwise.</returns>
  1175. </member>
  1176. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsValidFilterExpression(System.String)">
  1177. <summary>
  1178. Test an expression to see if it is valid as a filter.
  1179. </summary>
  1180. <param name="toTest">The filter expression to test.</param>
  1181. <returns>True if the expression is valid, false otherwise.</returns>
  1182. </member>
  1183. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.SplitQuoted(System.String)">
  1184. <summary>
  1185. Split a string into its component pieces
  1186. </summary>
  1187. <param name="original">The original string</param>
  1188. <returns>Returns an array of <see cref="T:System.String"/> values containing the individual filter elements.</returns>
  1189. </member>
  1190. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.ToString">
  1191. <summary>
  1192. Convert this filter to its string equivalent.
  1193. </summary>
  1194. <returns>The string equivalent for this filter.</returns>
  1195. </member>
  1196. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsIncluded(System.String)">
  1197. <summary>
  1198. Test a value to see if it is included by the filter.
  1199. </summary>
  1200. <param name="name">The value to test.</param>
  1201. <returns>True if the value is included, false otherwise.</returns>
  1202. </member>
  1203. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsExcluded(System.String)">
  1204. <summary>
  1205. Test a value to see if it is excluded by the filter.
  1206. </summary>
  1207. <param name="name">The value to test.</param>
  1208. <returns>True if the value is excluded, false otherwise.</returns>
  1209. </member>
  1210. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.IsMatch(System.String)">
  1211. <summary>
  1212. Test a value to see if it matches the filter.
  1213. </summary>
  1214. <param name="name">The value to test.</param>
  1215. <returns>True if the value matches, false otherwise.</returns>
  1216. </member>
  1217. <member name="M:ICSharpCode.SharpZipLib.Core.NameFilter.Compile">
  1218. <summary>
  1219. Compile this filter.
  1220. </summary>
  1221. </member>
  1222. <member name="T:ICSharpCode.SharpZipLib.Core.PathFilter">
  1223. <summary>
  1224. PathFilter filters directories and files using a form of <see cref="T:System.Text.RegularExpressions.Regex">regular expressions</see>
  1225. by full path name.
  1226. See <see cref="T:ICSharpCode.SharpZipLib.Core.NameFilter">NameFilter</see> for more detail on filtering.
  1227. </summary>
  1228. </member>
  1229. <member name="M:ICSharpCode.SharpZipLib.Core.PathFilter.#ctor(System.String)">
  1230. <summary>
  1231. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter"></see>.
  1232. </summary>
  1233. <param name="filter">The <see cref="T:ICSharpCode.SharpZipLib.Core.NameFilter">filter</see> expression to apply.</param>
  1234. </member>
  1235. <member name="M:ICSharpCode.SharpZipLib.Core.PathFilter.IsMatch(System.String)">
  1236. <summary>
  1237. Test a name to see if it matches the filter.
  1238. </summary>
  1239. <param name="name">The name to test.</param>
  1240. <returns>True if the name matches, false otherwise.</returns>
  1241. <remarks><see cref="M:System.IO.Path.GetFullPath(System.String)"/> is used to get the full path before matching.</remarks>
  1242. </member>
  1243. <member name="T:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter">
  1244. <summary>
  1245. ExtendedPathFilter filters based on name, file size, and the last write time of the file.
  1246. </summary>
  1247. <remarks>Provides an example of how to customise filtering.</remarks>
  1248. </member>
  1249. <member name="M:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.#ctor(System.String,System.Int64,System.Int64)">
  1250. <summary>
  1251. Initialise a new instance of ExtendedPathFilter.
  1252. </summary>
  1253. <param name="filter">The filter to apply.</param>
  1254. <param name="minSize">The minimum file size to include.</param>
  1255. <param name="maxSize">The maximum file size to include.</param>
  1256. </member>
  1257. <member name="M:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.#ctor(System.String,System.DateTime,System.DateTime)">
  1258. <summary>
  1259. Initialise a new instance of ExtendedPathFilter.
  1260. </summary>
  1261. <param name="filter">The filter to apply.</param>
  1262. <param name="minDate">The minimum <see cref="T:System.DateTime"/> to include.</param>
  1263. <param name="maxDate">The maximum <see cref="T:System.DateTime"/> to include.</param>
  1264. </member>
  1265. <member name="M:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.#ctor(System.String,System.Int64,System.Int64,System.DateTime,System.DateTime)">
  1266. <summary>
  1267. Initialise a new instance of ExtendedPathFilter.
  1268. </summary>
  1269. <param name="filter">The filter to apply.</param>
  1270. <param name="minSize">The minimum file size to include.</param>
  1271. <param name="maxSize">The maximum file size to include.</param>
  1272. <param name="minDate">The minimum <see cref="T:System.DateTime"/> to include.</param>
  1273. <param name="maxDate">The maximum <see cref="T:System.DateTime"/> to include.</param>
  1274. </member>
  1275. <member name="M:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.IsMatch(System.String)">
  1276. <summary>
  1277. Test a filename to see if it matches the filter.
  1278. </summary>
  1279. <param name="name">The filename to test.</param>
  1280. <returns>True if the filter matches, false otherwise.</returns>
  1281. <exception cref="T:System.IO.FileNotFoundException">The <see paramref="fileName"/> doesnt exist</exception>
  1282. </member>
  1283. <member name="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MinSize">
  1284. <summary>
  1285. Get/set the minimum size/length for a file that will match this filter.
  1286. </summary>
  1287. <remarks>The default value is zero.</remarks>
  1288. <exception cref="T:System.ArgumentOutOfRangeException">value is less than zero; greater than <see cref="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MaxSize"/></exception>
  1289. </member>
  1290. <member name="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MaxSize">
  1291. <summary>
  1292. Get/set the maximum size/length for a file that will match this filter.
  1293. </summary>
  1294. <remarks>The default value is <see cref="F:System.Int64.MaxValue"/></remarks>
  1295. <exception cref="T:System.ArgumentOutOfRangeException">value is less than zero or less than <see cref="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MinSize"/></exception>
  1296. </member>
  1297. <member name="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MinDate">
  1298. <summary>
  1299. Get/set the minimum <see cref="T:System.DateTime"/> value that will match for this filter.
  1300. </summary>
  1301. <remarks>Files with a LastWrite time less than this value are excluded by the filter.</remarks>
  1302. </member>
  1303. <member name="P:ICSharpCode.SharpZipLib.Core.ExtendedPathFilter.MaxDate">
  1304. <summary>
  1305. Get/set the maximum <see cref="T:System.DateTime"/> value that will match for this filter.
  1306. </summary>
  1307. <remarks>Files with a LastWrite time greater than this value are excluded by the filter.</remarks>
  1308. </member>
  1309. <member name="T:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter">
  1310. <summary>
  1311. NameAndSizeFilter filters based on name and file size.
  1312. </summary>
  1313. <remarks>A sample showing how filters might be extended.</remarks>
  1314. </member>
  1315. <member name="M:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter.#ctor(System.String,System.Int64,System.Int64)">
  1316. <summary>
  1317. Initialise a new instance of NameAndSizeFilter.
  1318. </summary>
  1319. <param name="filter">The filter to apply.</param>
  1320. <param name="minSize">The minimum file size to include.</param>
  1321. <param name="maxSize">The maximum file size to include.</param>
  1322. </member>
  1323. <member name="M:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter.IsMatch(System.String)">
  1324. <summary>
  1325. Test a filename to see if it matches the filter.
  1326. </summary>
  1327. <param name="name">The filename to test.</param>
  1328. <returns>True if the filter matches, false otherwise.</returns>
  1329. </member>
  1330. <member name="P:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter.MinSize">
  1331. <summary>
  1332. Get/set the minimum size for a file that will match this filter.
  1333. </summary>
  1334. </member>
  1335. <member name="P:ICSharpCode.SharpZipLib.Core.NameAndSizeFilter.MaxSize">
  1336. <summary>
  1337. Get/set the maximum size for a file that will match this filter.
  1338. </summary>
  1339. </member>
  1340. <member name="T:ICSharpCode.SharpZipLib.Core.PathUtils">
  1341. <summary>
  1342. PathUtils provides simple utilities for handling paths.
  1343. </summary>
  1344. </member>
  1345. <member name="M:ICSharpCode.SharpZipLib.Core.PathUtils.DropPathRoot(System.String)">
  1346. <summary>
  1347. Remove any path root present in the path
  1348. </summary>
  1349. <param name="path">A <see cref="T:System.String"/> containing path information.</param>
  1350. <returns>The path with the root removed if it was present; path otherwise.</returns>
  1351. </member>
  1352. <member name="M:ICSharpCode.SharpZipLib.Core.PathUtils.GetTempFileName(System.String)">
  1353. <summary>
  1354. Returns a random file name in the users temporary directory, or in directory of <paramref name="original"/> if specified
  1355. </summary>
  1356. <param name="original">If specified, used as the base file name for the temporary file</param>
  1357. <returns>Returns a temporary file name</returns>
  1358. </member>
  1359. <member name="T:ICSharpCode.SharpZipLib.Core.StreamUtils">
  1360. <summary>
  1361. Provides simple <see cref="T:System.IO.Stream"/>" utilities.
  1362. </summary>
  1363. </member>
  1364. <member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.ReadFully(System.IO.Stream,System.Byte[])">
  1365. <summary>
  1366. Read from a <see cref="T:System.IO.Stream"/> ensuring all the required data is read.
  1367. </summary>
  1368. <param name="stream">The stream to read.</param>
  1369. <param name="buffer">The buffer to fill.</param>
  1370. <seealso cref="M:ICSharpCode.SharpZipLib.Core.StreamUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)"/>
  1371. </member>
  1372. <member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  1373. <summary>
  1374. Read from a <see cref="T:System.IO.Stream"/>" ensuring all the required data is read.
  1375. </summary>
  1376. <param name="stream">The stream to read data from.</param>
  1377. <param name="buffer">The buffer to store data in.</param>
  1378. <param name="offset">The offset at which to begin storing data.</param>
  1379. <param name="count">The number of bytes of data to store.</param>
  1380. <exception cref="T:System.ArgumentNullException">Required parameter is null</exception>
  1381. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset"/> and or <paramref name="count"/> are invalid.</exception>
  1382. <exception cref="T:System.IO.EndOfStreamException">End of stream is encountered before all the data has been read.</exception>
  1383. </member>
  1384. <member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.ReadRequestedBytes(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  1385. <summary>
  1386. Read as much data as possible from a <see cref="T:System.IO.Stream"/>", up to the requested number of bytes
  1387. </summary>
  1388. <param name="stream">The stream to read data from.</param>
  1389. <param name="buffer">The buffer to store data in.</param>
  1390. <param name="offset">The offset at which to begin storing data.</param>
  1391. <param name="count">The number of bytes of data to store.</param>
  1392. <exception cref="T:System.ArgumentNullException">Required parameter is null</exception>
  1393. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="offset"/> and or <paramref name="count"/> are invalid.</exception>
  1394. </member>
  1395. <member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.Copy(System.IO.Stream,System.IO.Stream,System.Byte[])">
  1396. <summary>
  1397. Copy the contents of one <see cref="T:System.IO.Stream"/> to another.
  1398. </summary>
  1399. <param name="source">The stream to source data from.</param>
  1400. <param name="destination">The stream to write data to.</param>
  1401. <param name="buffer">The buffer to use during copying.</param>
  1402. </member>
  1403. <member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.Copy(System.IO.Stream,System.IO.Stream,System.Byte[],ICSharpCode.SharpZipLib.Core.ProgressHandler,System.TimeSpan,System.Object,System.String)">
  1404. <summary>
  1405. Copy the contents of one <see cref="T:System.IO.Stream"/> to another.
  1406. </summary>
  1407. <param name="source">The stream to source data from.</param>
  1408. <param name="destination">The stream to write data to.</param>
  1409. <param name="buffer">The buffer to use during copying.</param>
  1410. <param name="progressHandler">The <see cref="T:ICSharpCode.SharpZipLib.Core.ProgressHandler">progress handler delegate</see> to use.</param>
  1411. <param name="updateInterval">The minimum <see cref="T:System.TimeSpan"/> between progress updates.</param>
  1412. <param name="sender">The source for this event.</param>
  1413. <param name="name">The name to use with the event.</param>
  1414. <remarks>This form is specialised for use within #Zip to support events during archive operations.</remarks>
  1415. </member>
  1416. <member name="M:ICSharpCode.SharpZipLib.Core.StreamUtils.Copy(System.IO.Stream,System.IO.Stream,System.Byte[],ICSharpCode.SharpZipLib.Core.ProgressHandler,System.TimeSpan,System.Object,System.String,System.Int64)">
  1417. <summary>
  1418. Copy the contents of one <see cref="T:System.IO.Stream"/> to another.
  1419. </summary>
  1420. <param name="source">The stream to source data from.</param>
  1421. <param name="destination">The stream to write data to.</param>
  1422. <param name="buffer">The buffer to use during copying.</param>
  1423. <param name="progressHandler">The <see cref="T:ICSharpCode.SharpZipLib.Core.ProgressHandler">progress handler delegate</see> to use.</param>
  1424. <param name="updateInterval">The minimum <see cref="T:System.TimeSpan"/> between progress updates.</param>
  1425. <param name="sender">The source for this event.</param>
  1426. <param name="name">The name to use with the event.</param>
  1427. <param name="fixedTarget">A predetermined fixed target value to use with progress updates.
  1428. If the value is negative the target is calculated by looking at the stream.</param>
  1429. <remarks>This form is specialised for use within #Zip to support events during archive operations.</remarks>
  1430. </member>
  1431. <member name="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  1432. <summary>
  1433. SharpZipBaseException is the base exception class for SharpZipLib.
  1434. All library exceptions are derived from this.
  1435. </summary>
  1436. <remarks>NOTE: Not all exceptions thrown will be derived from this class.
  1437. A variety of other exceptions are possible for example <see cref="T:System.ArgumentNullException"></see></remarks>
  1438. </member>
  1439. <member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor">
  1440. <summary>
  1441. Initializes a new instance of the SharpZipBaseException class.
  1442. </summary>
  1443. </member>
  1444. <member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor(System.String)">
  1445. <summary>
  1446. Initializes a new instance of the SharpZipBaseException class with a specified error message.
  1447. </summary>
  1448. <param name="message">A message describing the exception.</param>
  1449. </member>
  1450. <member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor(System.String,System.Exception)">
  1451. <summary>
  1452. Initializes a new instance of the SharpZipBaseException class with a specified
  1453. error message and a reference to the inner exception that is the cause of this exception.
  1454. </summary>
  1455. <param name="message">A message describing the exception.</param>
  1456. <param name="innerException">The inner exception</param>
  1457. </member>
  1458. <member name="M:ICSharpCode.SharpZipLib.SharpZipBaseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1459. <summary>
  1460. Initializes a new instance of the SharpZipBaseException class with serialized data.
  1461. </summary>
  1462. <param name="info">
  1463. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  1464. object data about the exception being thrown.
  1465. </param>
  1466. <param name="context">
  1467. The System.Runtime.Serialization.StreamingContext that contains contextual information
  1468. about the source or destination.
  1469. </param>
  1470. </member>
  1471. <member name="T:ICSharpCode.SharpZipLib.StreamDecodingException">
  1472. <summary>
  1473. Indicates that an error occurred during decoding of a input stream due to corrupt
  1474. data or (unintentional) library incompatibility.
  1475. </summary>
  1476. </member>
  1477. <member name="M:ICSharpCode.SharpZipLib.StreamDecodingException.#ctor">
  1478. <summary>
  1479. Initializes a new instance of the StreamDecodingException with a generic message
  1480. </summary>
  1481. </member>
  1482. <member name="M:ICSharpCode.SharpZipLib.StreamDecodingException.#ctor(System.String)">
  1483. <summary>
  1484. Initializes a new instance of the StreamDecodingException class with a specified error message.
  1485. </summary>
  1486. <param name="message">A message describing the exception.</param>
  1487. </member>
  1488. <member name="M:ICSharpCode.SharpZipLib.StreamDecodingException.#ctor(System.String,System.Exception)">
  1489. <summary>
  1490. Initializes a new instance of the StreamDecodingException class with a specified
  1491. error message and a reference to the inner exception that is the cause of this exception.
  1492. </summary>
  1493. <param name="message">A message describing the exception.</param>
  1494. <param name="innerException">The inner exception</param>
  1495. </member>
  1496. <member name="M:ICSharpCode.SharpZipLib.StreamDecodingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1497. <summary>
  1498. Initializes a new instance of the StreamDecodingException class with serialized data.
  1499. </summary>
  1500. <param name="info">
  1501. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  1502. object data about the exception being thrown.
  1503. </param>
  1504. <param name="context">
  1505. The System.Runtime.Serialization.StreamingContext that contains contextual information
  1506. about the source or destination.
  1507. </param>
  1508. </member>
  1509. <member name="T:ICSharpCode.SharpZipLib.StreamUnsupportedException">
  1510. <summary>
  1511. Indicates that the input stream could not decoded due to known library incompability or missing features
  1512. </summary>
  1513. </member>
  1514. <member name="M:ICSharpCode.SharpZipLib.StreamUnsupportedException.#ctor">
  1515. <summary>
  1516. Initializes a new instance of the StreamUnsupportedException with a generic message
  1517. </summary>
  1518. </member>
  1519. <member name="M:ICSharpCode.SharpZipLib.StreamUnsupportedException.#ctor(System.String)">
  1520. <summary>
  1521. Initializes a new instance of the StreamUnsupportedException class with a specified error message.
  1522. </summary>
  1523. <param name="message">A message describing the exception.</param>
  1524. </member>
  1525. <member name="M:ICSharpCode.SharpZipLib.StreamUnsupportedException.#ctor(System.String,System.Exception)">
  1526. <summary>
  1527. Initializes a new instance of the StreamUnsupportedException class with a specified
  1528. error message and a reference to the inner exception that is the cause of this exception.
  1529. </summary>
  1530. <param name="message">A message describing the exception.</param>
  1531. <param name="innerException">The inner exception</param>
  1532. </member>
  1533. <member name="M:ICSharpCode.SharpZipLib.StreamUnsupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1534. <summary>
  1535. Initializes a new instance of the StreamUnsupportedException class with serialized data.
  1536. </summary>
  1537. <param name="info">
  1538. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  1539. object data about the exception being thrown.
  1540. </param>
  1541. <param name="context">
  1542. The System.Runtime.Serialization.StreamingContext that contains contextual information
  1543. about the source or destination.
  1544. </param>
  1545. </member>
  1546. <member name="T:ICSharpCode.SharpZipLib.UnexpectedEndOfStreamException">
  1547. <summary>
  1548. Indicates that the input stream could not decoded due to the stream ending before enough data had been provided
  1549. </summary>
  1550. </member>
  1551. <member name="M:ICSharpCode.SharpZipLib.UnexpectedEndOfStreamException.#ctor">
  1552. <summary>
  1553. Initializes a new instance of the UnexpectedEndOfStreamException with a generic message
  1554. </summary>
  1555. </member>
  1556. <member name="M:ICSharpCode.SharpZipLib.UnexpectedEndOfStreamException.#ctor(System.String)">
  1557. <summary>
  1558. Initializes a new instance of the UnexpectedEndOfStreamException class with a specified error message.
  1559. </summary>
  1560. <param name="message">A message describing the exception.</param>
  1561. </member>
  1562. <member name="M:ICSharpCode.SharpZipLib.UnexpectedEndOfStreamException.#ctor(System.String,System.Exception)">
  1563. <summary>
  1564. Initializes a new instance of the UnexpectedEndOfStreamException class with a specified
  1565. error message and a reference to the inner exception that is the cause of this exception.
  1566. </summary>
  1567. <param name="message">A message describing the exception.</param>
  1568. <param name="innerException">The inner exception</param>
  1569. </member>
  1570. <member name="M:ICSharpCode.SharpZipLib.UnexpectedEndOfStreamException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1571. <summary>
  1572. Initializes a new instance of the UnexpectedEndOfStreamException class with serialized data.
  1573. </summary>
  1574. <param name="info">
  1575. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  1576. object data about the exception being thrown.
  1577. </param>
  1578. <param name="context">
  1579. The System.Runtime.Serialization.StreamingContext that contains contextual information
  1580. about the source or destination.
  1581. </param>
  1582. </member>
  1583. <member name="T:ICSharpCode.SharpZipLib.ValueOutOfRangeException">
  1584. <summary>
  1585. Indicates that a value was outside of the expected range when decoding an input stream
  1586. </summary>
  1587. </member>
  1588. <member name="M:ICSharpCode.SharpZipLib.ValueOutOfRangeException.#ctor(System.String)">
  1589. <summary>
  1590. Initializes a new instance of the ValueOutOfRangeException class naming the causing variable
  1591. </summary>
  1592. <param name="nameOfValue">Name of the variable, use: nameof()</param>
  1593. </member>
  1594. <member name="M:ICSharpCode.SharpZipLib.ValueOutOfRangeException.#ctor(System.String,System.Int64,System.Int64,System.Int64)">
  1595. <summary>
  1596. Initializes a new instance of the ValueOutOfRangeException class naming the causing variable,
  1597. it's current value and expected range.
  1598. </summary>
  1599. <param name="nameOfValue">Name of the variable, use: nameof()</param>
  1600. <param name="value">The invalid value</param>
  1601. <param name="maxValue">Expected maximum value</param>
  1602. <param name="minValue">Expected minimum value</param>
  1603. </member>
  1604. <member name="M:ICSharpCode.SharpZipLib.ValueOutOfRangeException.#ctor(System.String,System.String,System.String,System.String)">
  1605. <summary>
  1606. Initializes a new instance of the ValueOutOfRangeException class naming the causing variable,
  1607. it's current value and expected range.
  1608. </summary>
  1609. <param name="nameOfValue">Name of the variable, use: nameof()</param>
  1610. <param name="value">The invalid value</param>
  1611. <param name="maxValue">Expected maximum value</param>
  1612. <param name="minValue">Expected minimum value</param>
  1613. </member>
  1614. <member name="M:ICSharpCode.SharpZipLib.ValueOutOfRangeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1615. <summary>
  1616. Initializes a new instance of the ValueOutOfRangeException class with serialized data.
  1617. </summary>
  1618. <param name="info">
  1619. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  1620. object data about the exception being thrown.
  1621. </param>
  1622. <param name="context">
  1623. The System.Runtime.Serialization.StreamingContext that contains contextual information
  1624. about the source or destination.
  1625. </param>
  1626. </member>
  1627. <member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassic">
  1628. <summary>
  1629. PkzipClassic embodies the classic or original encryption facilities used in Pkzip archives.
  1630. While it has been superseded by more recent and more powerful algorithms, its still in use and
  1631. is viable for preventing casual snooping
  1632. </summary>
  1633. </member>
  1634. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassic.GenerateKeys(System.Byte[])">
  1635. <summary>
  1636. Generates new encryption keys based on given seed
  1637. </summary>
  1638. <param name="seed">The seed value to initialise keys with.</param>
  1639. <returns>A new key value.</returns>
  1640. </member>
  1641. <member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase">
  1642. <summary>
  1643. PkzipClassicCryptoBase provides the low level facilities for encryption
  1644. and decryption using the PkzipClassic algorithm.
  1645. </summary>
  1646. </member>
  1647. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase.TransformByte">
  1648. <summary>
  1649. Transform a single byte
  1650. </summary>
  1651. <returns>
  1652. The transformed value
  1653. </returns>
  1654. </member>
  1655. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase.SetKeys(System.Byte[])">
  1656. <summary>
  1657. Set the key schedule for encryption/decryption.
  1658. </summary>
  1659. <param name="keyData">The data use to set the keys from.</param>
  1660. </member>
  1661. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase.UpdateKeys(System.Byte)">
  1662. <summary>
  1663. Update encryption keys
  1664. </summary>
  1665. </member>
  1666. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicCryptoBase.Reset">
  1667. <summary>
  1668. Reset the internal state.
  1669. </summary>
  1670. </member>
  1671. <member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform">
  1672. <summary>
  1673. PkzipClassic CryptoTransform for encryption.
  1674. </summary>
  1675. </member>
  1676. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.#ctor(System.Byte[])">
  1677. <summary>
  1678. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform"></see>
  1679. </summary>
  1680. <param name="keyBlock">The key block to use.</param>
  1681. </member>
  1682. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.TransformFinalBlock(System.Byte[],System.Int32,System.Int32)">
  1683. <summary>
  1684. Transforms the specified region of the specified byte array.
  1685. </summary>
  1686. <param name="inputBuffer">The input for which to compute the transform.</param>
  1687. <param name="inputOffset">The offset into the byte array from which to begin using data.</param>
  1688. <param name="inputCount">The number of bytes in the byte array to use as data.</param>
  1689. <returns>The computed transform.</returns>
  1690. </member>
  1691. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.TransformBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  1692. <summary>
  1693. Transforms the specified region of the input byte array and copies
  1694. the resulting transform to the specified region of the output byte array.
  1695. </summary>
  1696. <param name="inputBuffer">The input for which to compute the transform.</param>
  1697. <param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
  1698. <param name="inputCount">The number of bytes in the input byte array to use as data.</param>
  1699. <param name="outputBuffer">The output to which to write the transform.</param>
  1700. <param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
  1701. <returns>The number of bytes written.</returns>
  1702. </member>
  1703. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.CanReuseTransform">
  1704. <summary>
  1705. Gets a value indicating whether the current transform can be reused.
  1706. </summary>
  1707. </member>
  1708. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.InputBlockSize">
  1709. <summary>
  1710. Gets the size of the input data blocks in bytes.
  1711. </summary>
  1712. </member>
  1713. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.OutputBlockSize">
  1714. <summary>
  1715. Gets the size of the output data blocks in bytes.
  1716. </summary>
  1717. </member>
  1718. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.CanTransformMultipleBlocks">
  1719. <summary>
  1720. Gets a value indicating whether multiple blocks can be transformed.
  1721. </summary>
  1722. </member>
  1723. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicEncryptCryptoTransform.Dispose">
  1724. <summary>
  1725. Cleanup internal state.
  1726. </summary>
  1727. </member>
  1728. <member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform">
  1729. <summary>
  1730. PkzipClassic CryptoTransform for decryption.
  1731. </summary>
  1732. </member>
  1733. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.#ctor(System.Byte[])">
  1734. <summary>
  1735. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform"></see>.
  1736. </summary>
  1737. <param name="keyBlock">The key block to decrypt with.</param>
  1738. </member>
  1739. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.TransformFinalBlock(System.Byte[],System.Int32,System.Int32)">
  1740. <summary>
  1741. Transforms the specified region of the specified byte array.
  1742. </summary>
  1743. <param name="inputBuffer">The input for which to compute the transform.</param>
  1744. <param name="inputOffset">The offset into the byte array from which to begin using data.</param>
  1745. <param name="inputCount">The number of bytes in the byte array to use as data.</param>
  1746. <returns>The computed transform.</returns>
  1747. </member>
  1748. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.TransformBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  1749. <summary>
  1750. Transforms the specified region of the input byte array and copies
  1751. the resulting transform to the specified region of the output byte array.
  1752. </summary>
  1753. <param name="inputBuffer">The input for which to compute the transform.</param>
  1754. <param name="inputOffset">The offset into the input byte array from which to begin using data.</param>
  1755. <param name="inputCount">The number of bytes in the input byte array to use as data.</param>
  1756. <param name="outputBuffer">The output to which to write the transform.</param>
  1757. <param name="outputOffset">The offset into the output byte array from which to begin writing data.</param>
  1758. <returns>The number of bytes written.</returns>
  1759. </member>
  1760. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.CanReuseTransform">
  1761. <summary>
  1762. Gets a value indicating whether the current transform can be reused.
  1763. </summary>
  1764. </member>
  1765. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.InputBlockSize">
  1766. <summary>
  1767. Gets the size of the input data blocks in bytes.
  1768. </summary>
  1769. </member>
  1770. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.OutputBlockSize">
  1771. <summary>
  1772. Gets the size of the output data blocks in bytes.
  1773. </summary>
  1774. </member>
  1775. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.CanTransformMultipleBlocks">
  1776. <summary>
  1777. Gets a value indicating whether multiple blocks can be transformed.
  1778. </summary>
  1779. </member>
  1780. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicDecryptCryptoTransform.Dispose">
  1781. <summary>
  1782. Cleanup internal state.
  1783. </summary>
  1784. </member>
  1785. <member name="T:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged">
  1786. <summary>
  1787. Defines a wrapper object to access the Pkzip algorithm.
  1788. This class cannot be inherited.
  1789. </summary>
  1790. </member>
  1791. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.BlockSize">
  1792. <summary>
  1793. Get / set the applicable block size in bits.
  1794. </summary>
  1795. <remarks>The only valid block size is 8.</remarks>
  1796. </member>
  1797. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.LegalKeySizes">
  1798. <summary>
  1799. Get an array of legal <see cref="T:System.Security.Cryptography.KeySizes">key sizes.</see>
  1800. </summary>
  1801. </member>
  1802. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.GenerateIV">
  1803. <summary>
  1804. Generate an initial vector.
  1805. </summary>
  1806. </member>
  1807. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.LegalBlockSizes">
  1808. <summary>
  1809. Get an array of legal <see cref="T:System.Security.Cryptography.KeySizes">block sizes</see>.
  1810. </summary>
  1811. </member>
  1812. <member name="P:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.Key">
  1813. <summary>
  1814. Get / set the key value applicable.
  1815. </summary>
  1816. </member>
  1817. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.GenerateKey">
  1818. <summary>
  1819. Generate a new random key.
  1820. </summary>
  1821. </member>
  1822. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.CreateEncryptor(System.Byte[],System.Byte[])">
  1823. <summary>
  1824. Create an encryptor.
  1825. </summary>
  1826. <param name="rgbKey">The key to use for this encryptor.</param>
  1827. <param name="rgbIV">Initialisation vector for the new encryptor.</param>
  1828. <returns>Returns a new PkzipClassic encryptor</returns>
  1829. </member>
  1830. <member name="M:ICSharpCode.SharpZipLib.Encryption.PkzipClassicManaged.CreateDecryptor(System.Byte[],System.Byte[])">
  1831. <summary>
  1832. Create a decryptor.
  1833. </summary>
  1834. <param name="rgbKey">Keys to use for this new decryptor.</param>
  1835. <param name="rgbIV">Initialisation vector for the new decryptor.</param>
  1836. <returns>Returns a new decryptor.</returns>
  1837. </member>
  1838. <member name="T:ICSharpCode.SharpZipLib.Encryption.ZipAESStream">
  1839. <summary>
  1840. Encrypts and decrypts AES ZIP
  1841. </summary>
  1842. <remarks>
  1843. Based on information from http://www.winzip.com/aes_info.htm
  1844. and http://www.gladman.me.uk/cryptography_technology/fileencrypt/
  1845. </remarks>
  1846. </member>
  1847. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Encryption.ZipAESTransform,System.Security.Cryptography.CryptoStreamMode)">
  1848. <summary>
  1849. Constructor
  1850. </summary>
  1851. <param name="stream">The stream on which to perform the cryptographic transformation.</param>
  1852. <param name="transform">Instance of ZipAESTransform</param>
  1853. <param name="mode">Read or Write</param>
  1854. </member>
  1855. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESStream.Read(System.Byte[],System.Int32,System.Int32)">
  1856. <summary>
  1857. Reads a sequence of bytes from the current CryptoStream into buffer,
  1858. and advances the position within the stream by the number of bytes read.
  1859. </summary>
  1860. </member>
  1861. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  1862. <inheritdoc/>
  1863. </member>
  1864. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESStream.Write(System.Byte[],System.Int32,System.Int32)">
  1865. <summary>
  1866. Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
  1867. </summary>
  1868. <param name="buffer">An array of bytes. This method copies count bytes from buffer to the current stream. </param>
  1869. <param name="offset">The byte offset in buffer at which to begin copying bytes to the current stream. </param>
  1870. <param name="count">The number of bytes to be written to the current stream. </param>
  1871. </member>
  1872. <member name="T:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform">
  1873. <summary>
  1874. Transforms stream using AES in CTR mode
  1875. </summary>
  1876. </member>
  1877. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.#ctor(System.String,System.Byte[],System.Int32,System.Boolean)">
  1878. <summary>
  1879. Constructor.
  1880. </summary>
  1881. <param name="key">Password string</param>
  1882. <param name="saltBytes">Random bytes, length depends on encryption strength.
  1883. 128 bits = 8 bytes, 192 bits = 12 bytes, 256 bits = 16 bytes.</param>
  1884. <param name="blockSize">The encryption strength, in bytes eg 16 for 128 bits.</param>
  1885. <param name="writeMode">True when creating a zip, false when reading. For the AuthCode.</param>
  1886. </member>
  1887. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.TransformBlock(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  1888. <summary>
  1889. Implement the ICryptoTransform method.
  1890. </summary>
  1891. </member>
  1892. <member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.PwdVerifier">
  1893. <summary>
  1894. Returns the 2 byte password verifier
  1895. </summary>
  1896. </member>
  1897. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.GetAuthCode">
  1898. <summary>
  1899. Returns the 10 byte AUTH CODE to be checked or appended immediately following the AES data stream.
  1900. </summary>
  1901. </member>
  1902. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.TransformFinalBlock(System.Byte[],System.Int32,System.Int32)">
  1903. <summary>
  1904. Transform final block and read auth code
  1905. </summary>
  1906. </member>
  1907. <member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.InputBlockSize">
  1908. <summary>
  1909. Gets the size of the input data blocks in bytes.
  1910. </summary>
  1911. </member>
  1912. <member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.OutputBlockSize">
  1913. <summary>
  1914. Gets the size of the output data blocks in bytes.
  1915. </summary>
  1916. </member>
  1917. <member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.CanTransformMultipleBlocks">
  1918. <summary>
  1919. Gets a value indicating whether multiple blocks can be transformed.
  1920. </summary>
  1921. </member>
  1922. <member name="P:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.CanReuseTransform">
  1923. <summary>
  1924. Gets a value indicating whether the current transform can be reused.
  1925. </summary>
  1926. </member>
  1927. <member name="M:ICSharpCode.SharpZipLib.Encryption.ZipAESTransform.Dispose">
  1928. <summary>
  1929. Cleanup internal state.
  1930. </summary>
  1931. </member>
  1932. <member name="T:ICSharpCode.SharpZipLib.GZip.GZip">
  1933. <summary>
  1934. An example class to demonstrate compression and decompression of GZip streams.
  1935. </summary>
  1936. </member>
  1937. <member name="M:ICSharpCode.SharpZipLib.GZip.GZip.Decompress(System.IO.Stream,System.IO.Stream,System.Boolean)">
  1938. <summary>
  1939. Decompress the <paramref name="inStream">input</paramref> writing
  1940. uncompressed data to the <paramref name="outStream">output stream</paramref>
  1941. </summary>
  1942. <param name="inStream">The readable stream containing data to decompress.</param>
  1943. <param name="outStream">The output stream to receive the decompressed data.</param>
  1944. <param name="isStreamOwner">Both streams are closed on completion if true.</param>
  1945. <exception cref="T:System.ArgumentNullException">Input or output stream is null</exception>
  1946. </member>
  1947. <member name="M:ICSharpCode.SharpZipLib.GZip.GZip.Compress(System.IO.Stream,System.IO.Stream,System.Boolean,System.Int32,System.Int32)">
  1948. <summary>
  1949. Compress the <paramref name="inStream">input stream</paramref> sending
  1950. result data to <paramref name="outStream">output stream</paramref>
  1951. </summary>
  1952. <param name="inStream">The readable stream to compress.</param>
  1953. <param name="outStream">The output stream to receive the compressed data.</param>
  1954. <param name="isStreamOwner">Both streams are closed on completion if true.</param>
  1955. <param name="bufferSize">Deflate buffer size, minimum 512</param>
  1956. <param name="level">Deflate compression level, 0-9</param>
  1957. <exception cref="T:System.ArgumentNullException">Input or output stream is null</exception>
  1958. <exception cref="T:System.ArgumentOutOfRangeException">Buffer Size is smaller than 512</exception>
  1959. <exception cref="T:System.ArgumentOutOfRangeException">Compression level outside 0-9</exception>
  1960. </member>
  1961. <member name="T:ICSharpCode.SharpZipLib.GZip.GZipConstants">
  1962. <summary>
  1963. This class contains constants used for gzip.
  1964. </summary>
  1965. </member>
  1966. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipConstants.ID1">
  1967. <summary>
  1968. First GZip identification byte
  1969. </summary>
  1970. </member>
  1971. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipConstants.ID2">
  1972. <summary>
  1973. Second GZip identification byte
  1974. </summary>
  1975. </member>
  1976. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipConstants.CompressionMethodDeflate">
  1977. <summary>
  1978. Deflate compression method
  1979. </summary>
  1980. </member>
  1981. <member name="P:ICSharpCode.SharpZipLib.GZip.GZipConstants.Encoding">
  1982. <summary>
  1983. Get the GZip specified encoding (CP-1252 if supported, otherwise ASCII)
  1984. </summary>
  1985. </member>
  1986. <member name="T:ICSharpCode.SharpZipLib.GZip.GZipFlags">
  1987. <summary>
  1988. GZip header flags
  1989. </summary>
  1990. </member>
  1991. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipFlags.FTEXT">
  1992. <summary>
  1993. Text flag hinting that the file is in ASCII
  1994. </summary>
  1995. </member>
  1996. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipFlags.FHCRC">
  1997. <summary>
  1998. CRC flag indicating that a CRC16 preceeds the data
  1999. </summary>
  2000. </member>
  2001. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipFlags.FEXTRA">
  2002. <summary>
  2003. Extra flag indicating that extra fields are present
  2004. </summary>
  2005. </member>
  2006. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipFlags.FNAME">
  2007. <summary>
  2008. Filename flag indicating that the original filename is present
  2009. </summary>
  2010. </member>
  2011. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipFlags.FCOMMENT">
  2012. <summary>
  2013. Flag bit mask indicating that a comment is present
  2014. </summary>
  2015. </member>
  2016. <member name="T:ICSharpCode.SharpZipLib.GZip.GZipException">
  2017. <summary>
  2018. GZipException represents exceptions specific to GZip classes and code.
  2019. </summary>
  2020. </member>
  2021. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipException.#ctor">
  2022. <summary>
  2023. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.GZip.GZipException" />.
  2024. </summary>
  2025. </member>
  2026. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipException.#ctor(System.String)">
  2027. <summary>
  2028. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.GZip.GZipException" /> with its message string.
  2029. </summary>
  2030. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  2031. </member>
  2032. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipException.#ctor(System.String,System.Exception)">
  2033. <summary>
  2034. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.GZip.GZipException" />.
  2035. </summary>
  2036. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  2037. <param name="innerException">The <see cref="T:System.Exception"/> that caused this exception.</param>
  2038. </member>
  2039. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2040. <summary>
  2041. Initializes a new instance of the GZipException class with serialized data.
  2042. </summary>
  2043. <param name="info">
  2044. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  2045. object data about the exception being thrown.
  2046. </param>
  2047. <param name="context">
  2048. The System.Runtime.Serialization.StreamingContext that contains contextual information
  2049. about the source or destination.
  2050. </param>
  2051. </member>
  2052. <member name="T:ICSharpCode.SharpZipLib.GZip.GZipInputStream">
  2053. <summary>
  2054. This filter stream is used to decompress a "GZIP" format stream.
  2055. The "GZIP" format is described baseInputStream RFC 1952.
  2056. author of the original java version : John Leuner
  2057. </summary>
  2058. <example> This sample shows how to unzip a gzipped file
  2059. <code>
  2060. using System;
  2061. using System.IO;
  2062. using ICSharpCode.SharpZipLib.Core;
  2063. using ICSharpCode.SharpZipLib.GZip;
  2064. class MainClass
  2065. {
  2066. public static void Main(string[] args)
  2067. {
  2068. using (Stream inStream = new GZipInputStream(File.OpenRead(args[0])))
  2069. using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
  2070. byte[] buffer = new byte[4096];
  2071. StreamUtils.Copy(inStream, outStream, buffer);
  2072. }
  2073. }
  2074. }
  2075. </code>
  2076. </example>
  2077. </member>
  2078. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipInputStream.crc">
  2079. <summary>
  2080. CRC-32 value for uncompressed data
  2081. </summary>
  2082. </member>
  2083. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipInputStream.readGZIPHeader">
  2084. <summary>
  2085. Flag to indicate if we've read the GZIP header yet for the current member (block of compressed data).
  2086. This is tracked per-block as the file is parsed.
  2087. </summary>
  2088. </member>
  2089. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipInputStream.completedLastBlock">
  2090. <summary>
  2091. Flag to indicate if at least one block in a stream with concatenated blocks was read successfully.
  2092. This allows us to exit gracefully if downstream data is not in gzip format.
  2093. </summary>
  2094. </member>
  2095. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipInputStream.#ctor(System.IO.Stream)">
  2096. <summary>
  2097. Creates a GZipInputStream with the default buffer size
  2098. </summary>
  2099. <param name="baseInputStream">
  2100. The stream to read compressed data from (baseInputStream GZIP format)
  2101. </param>
  2102. </member>
  2103. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipInputStream.#ctor(System.IO.Stream,System.Int32)">
  2104. <summary>
  2105. Creates a GZIPInputStream with the specified buffer size
  2106. </summary>
  2107. <param name="baseInputStream">
  2108. The stream to read compressed data from (baseInputStream GZIP format)
  2109. </param>
  2110. <param name="size">
  2111. Size of the buffer to use
  2112. </param>
  2113. </member>
  2114. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  2115. <summary>
  2116. Reads uncompressed data into an array of bytes
  2117. </summary>
  2118. <param name="buffer">
  2119. The buffer to read uncompressed data into
  2120. </param>
  2121. <param name="offset">
  2122. The offset indicating where the data should be placed
  2123. </param>
  2124. <param name="count">
  2125. The number of uncompressed bytes to be read
  2126. </param>
  2127. <returns>Returns the number of bytes actually read.</returns>
  2128. </member>
  2129. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipInputStream.GetFilename">
  2130. <summary>
  2131. Retrieves the filename header field for the block last read
  2132. </summary>
  2133. <returns></returns>
  2134. </member>
  2135. <member name="T:ICSharpCode.SharpZipLib.GZip.GZipOutputStream">
  2136. <summary>
  2137. This filter stream is used to compress a stream into a "GZIP" stream.
  2138. The "GZIP" format is described in RFC 1952.
  2139. author of the original java version : John Leuner
  2140. </summary>
  2141. <example> This sample shows how to gzip a file
  2142. <code>
  2143. using System;
  2144. using System.IO;
  2145. using ICSharpCode.SharpZipLib.GZip;
  2146. using ICSharpCode.SharpZipLib.Core;
  2147. class MainClass
  2148. {
  2149. public static void Main(string[] args)
  2150. {
  2151. using (Stream s = new GZipOutputStream(File.Create(args[0] + ".gz")))
  2152. using (FileStream fs = File.OpenRead(args[0])) {
  2153. byte[] writeData = new byte[4096];
  2154. Streamutils.Copy(s, fs, writeData);
  2155. }
  2156. }
  2157. }
  2158. }
  2159. </code>
  2160. </example>
  2161. </member>
  2162. <member name="F:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.crc">
  2163. <summary>
  2164. CRC-32 value for uncompressed data
  2165. </summary>
  2166. </member>
  2167. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.#ctor(System.IO.Stream)">
  2168. <summary>
  2169. Creates a GzipOutputStream with the default buffer size
  2170. </summary>
  2171. <param name="baseOutputStream">
  2172. The stream to read data (to be compressed) from
  2173. </param>
  2174. </member>
  2175. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.#ctor(System.IO.Stream,System.Int32)">
  2176. <summary>
  2177. Creates a GZipOutputStream with the specified buffer size
  2178. </summary>
  2179. <param name="baseOutputStream">
  2180. The stream to read data (to be compressed) from
  2181. </param>
  2182. <param name="size">
  2183. Size of the buffer to use
  2184. </param>
  2185. </member>
  2186. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.SetLevel(System.Int32)">
  2187. <summary>
  2188. Sets the active compression level (0-9). The new level will be activated
  2189. immediately.
  2190. </summary>
  2191. <param name="level">The compression level to set.</param>
  2192. <exception cref="T:System.ArgumentOutOfRangeException">
  2193. Level specified is not supported.
  2194. </exception>
  2195. <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater"/>
  2196. </member>
  2197. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.GetLevel">
  2198. <summary>
  2199. Get the current compression level.
  2200. </summary>
  2201. <returns>The current compression level.</returns>
  2202. </member>
  2203. <member name="P:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.FileName">
  2204. <summary>
  2205. Original filename
  2206. </summary>
  2207. </member>
  2208. <member name="P:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.ModifiedTime">
  2209. <summary>
  2210. If defined, will use this time instead of the current for the output header
  2211. </summary>
  2212. </member>
  2213. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  2214. <summary>
  2215. Write given buffer to output updating crc
  2216. </summary>
  2217. <param name="buffer">Buffer to write</param>
  2218. <param name="offset">Offset of first byte in buf to write</param>
  2219. <param name="count">Number of bytes to write</param>
  2220. </member>
  2221. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  2222. <summary>
  2223. Asynchronously write given buffer to output updating crc
  2224. </summary>
  2225. <param name="buffer">Buffer to write</param>
  2226. <param name="offset">Offset of first byte in buf to write</param>
  2227. <param name="count">Number of bytes to write</param>
  2228. <param name="ct">The token to monitor for cancellation requests</param>
  2229. </member>
  2230. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Dispose(System.Boolean)">
  2231. <summary>
  2232. Writes remaining compressed output data to the output stream
  2233. and closes it.
  2234. </summary>
  2235. </member>
  2236. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.DisposeAsync">
  2237. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Dispose(System.Boolean)"/>
  2238. </member>
  2239. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Flush">
  2240. <summary>
  2241. Flushes the stream by ensuring the header is written, and then calling <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Flush">Flush</see>
  2242. on the deflater.
  2243. </summary>
  2244. </member>
  2245. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.FlushAsync(System.Threading.CancellationToken)">
  2246. <inheritdoc cref="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Flush"/>
  2247. </member>
  2248. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Finish">
  2249. <summary>
  2250. Finish compression and write any footer information required to stream
  2251. </summary>
  2252. </member>
  2253. <member name="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.FinishAsync(System.Threading.CancellationToken)">
  2254. <inheritdoc cref="M:ICSharpCode.SharpZipLib.GZip.GZipOutputStream.Finish"/>
  2255. </member>
  2256. <member name="T:ICSharpCode.SharpZipLib.Lzw.LzwConstants">
  2257. <summary>
  2258. This class contains constants used for LZW
  2259. </summary>
  2260. </member>
  2261. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwConstants.MAGIC">
  2262. <summary>
  2263. Magic number found at start of LZW header: 0x1f 0x9d
  2264. </summary>
  2265. </member>
  2266. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwConstants.MAX_BITS">
  2267. <summary>
  2268. Maximum number of bits per code
  2269. </summary>
  2270. </member>
  2271. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwConstants.BIT_MASK">
  2272. <summary>
  2273. Mask for 'number of compression bits'
  2274. </summary>
  2275. </member>
  2276. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwConstants.EXTENDED_MASK">
  2277. <summary>
  2278. Indicates the presence of a fourth header byte
  2279. </summary>
  2280. </member>
  2281. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwConstants.RESERVED_MASK">
  2282. <summary>
  2283. Reserved bits
  2284. </summary>
  2285. </member>
  2286. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwConstants.BLOCK_MODE_MASK">
  2287. <summary>
  2288. Block compression: if table is full and compression rate is dropping,
  2289. clear the dictionary.
  2290. </summary>
  2291. </member>
  2292. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwConstants.HDR_SIZE">
  2293. <summary>
  2294. LZW file header size (in bytes)
  2295. </summary>
  2296. </member>
  2297. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwConstants.INIT_BITS">
  2298. <summary>
  2299. Initial number of bits per code
  2300. </summary>
  2301. </member>
  2302. <member name="T:ICSharpCode.SharpZipLib.Lzw.LzwException">
  2303. <summary>
  2304. LzwException represents exceptions specific to LZW classes and code.
  2305. </summary>
  2306. </member>
  2307. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwException.#ctor">
  2308. <summary>
  2309. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Lzw.LzwException" />.
  2310. </summary>
  2311. </member>
  2312. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwException.#ctor(System.String)">
  2313. <summary>
  2314. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Lzw.LzwException" /> with its message string.
  2315. </summary>
  2316. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  2317. </member>
  2318. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwException.#ctor(System.String,System.Exception)">
  2319. <summary>
  2320. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Lzw.LzwException" />.
  2321. </summary>
  2322. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  2323. <param name="innerException">The <see cref="T:System.Exception"/> that caused this exception.</param>
  2324. </member>
  2325. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2326. <summary>
  2327. Initializes a new instance of the LzwException class with serialized data.
  2328. </summary>
  2329. <param name="info">
  2330. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  2331. object data about the exception being thrown.
  2332. </param>
  2333. <param name="context">
  2334. The System.Runtime.Serialization.StreamingContext that contains contextual information
  2335. about the source or destination.
  2336. </param>
  2337. </member>
  2338. <member name="T:ICSharpCode.SharpZipLib.Lzw.LzwInputStream">
  2339. <summary>
  2340. This filter stream is used to decompress a LZW format stream.
  2341. Specifically, a stream that uses the LZC compression method.
  2342. This file format is usually associated with the .Z file extension.
  2343. See http://en.wikipedia.org/wiki/Compress
  2344. See http://wiki.wxwidgets.org/Development:_Z_File_Format
  2345. The file header consists of 3 (or optionally 4) bytes. The first two bytes
  2346. contain the magic marker "0x1f 0x9d", followed by a byte of flags.
  2347. Based on Java code by Ronald Tschalar, which in turn was based on the unlzw.c
  2348. code in the gzip package.
  2349. </summary>
  2350. <example> This sample shows how to unzip a compressed file
  2351. <code>
  2352. using System;
  2353. using System.IO;
  2354. using ICSharpCode.SharpZipLib.Core;
  2355. using ICSharpCode.SharpZipLib.LZW;
  2356. class MainClass
  2357. {
  2358. public static void Main(string[] args)
  2359. {
  2360. using (Stream inStream = new LzwInputStream(File.OpenRead(args[0])))
  2361. using (FileStream outStream = File.Create(Path.GetFileNameWithoutExtension(args[0]))) {
  2362. byte[] buffer = new byte[4096];
  2363. StreamUtils.Copy(inStream, outStream, buffer);
  2364. // OR
  2365. inStream.Read(buffer, 0, buffer.Length);
  2366. // now do something with the buffer
  2367. }
  2368. }
  2369. }
  2370. </code>
  2371. </example>
  2372. </member>
  2373. <member name="P:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.IsStreamOwner">
  2374. <summary>
  2375. Gets or sets a flag indicating ownership of underlying stream.
  2376. When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
  2377. </summary>
  2378. <remarks>The default value is true.</remarks>
  2379. </member>
  2380. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.#ctor(System.IO.Stream)">
  2381. <summary>
  2382. Creates a LzwInputStream
  2383. </summary>
  2384. <param name="baseInputStream">
  2385. The stream to read compressed data from (baseInputStream LZW format)
  2386. </param>
  2387. </member>
  2388. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.ReadByte">
  2389. <summary>
  2390. See <see cref="M:System.IO.Stream.ReadByte"/>
  2391. </summary>
  2392. <returns></returns>
  2393. </member>
  2394. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  2395. <summary>
  2396. Reads decompressed data into the provided buffer byte array
  2397. </summary>
  2398. <param name ="buffer">
  2399. The array to read and decompress data into
  2400. </param>
  2401. <param name ="offset">
  2402. The offset indicating where the data should be placed
  2403. </param>
  2404. <param name ="count">
  2405. The number of bytes to decompress
  2406. </param>
  2407. <returns>The number of bytes read. Zero signals the end of stream</returns>
  2408. </member>
  2409. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.ResetBuf(System.Int32)">
  2410. <summary>
  2411. Moves the unread data in the buffer to the beginning and resets
  2412. the pointers.
  2413. </summary>
  2414. <param name="bitPosition"></param>
  2415. <returns></returns>
  2416. </member>
  2417. <member name="P:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.CanRead">
  2418. <summary>
  2419. Gets a value indicating whether the current stream supports reading
  2420. </summary>
  2421. </member>
  2422. <member name="P:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.CanSeek">
  2423. <summary>
  2424. Gets a value of false indicating seeking is not supported for this stream.
  2425. </summary>
  2426. </member>
  2427. <member name="P:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.CanWrite">
  2428. <summary>
  2429. Gets a value of false indicating that this stream is not writeable.
  2430. </summary>
  2431. </member>
  2432. <member name="P:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.Length">
  2433. <summary>
  2434. A value representing the length of the stream in bytes.
  2435. </summary>
  2436. </member>
  2437. <member name="P:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.Position">
  2438. <summary>
  2439. The current position within the stream.
  2440. Throws a NotSupportedException when attempting to set the position
  2441. </summary>
  2442. <exception cref="T:System.NotSupportedException">Attempting to set the position</exception>
  2443. </member>
  2444. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.Flush">
  2445. <summary>
  2446. Flushes the baseInputStream
  2447. </summary>
  2448. </member>
  2449. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  2450. <summary>
  2451. Sets the position within the current stream
  2452. Always throws a NotSupportedException
  2453. </summary>
  2454. <param name="offset">The relative offset to seek to.</param>
  2455. <param name="origin">The <see cref="T:System.IO.SeekOrigin"/> defining where to seek from.</param>
  2456. <returns>The new position in the stream.</returns>
  2457. <exception cref="T:System.NotSupportedException">Any access</exception>
  2458. </member>
  2459. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.SetLength(System.Int64)">
  2460. <summary>
  2461. Set the length of the current stream
  2462. Always throws a NotSupportedException
  2463. </summary>
  2464. <param name="value">The new length value for the stream.</param>
  2465. <exception cref="T:System.NotSupportedException">Any access</exception>
  2466. </member>
  2467. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.Write(System.Byte[],System.Int32,System.Int32)">
  2468. <summary>
  2469. Writes a sequence of bytes to stream and advances the current position
  2470. This method always throws a NotSupportedException
  2471. </summary>
  2472. <param name="buffer">The buffer containing data to write.</param>
  2473. <param name="offset">The offset of the first byte to write.</param>
  2474. <param name="count">The number of bytes to write.</param>
  2475. <exception cref="T:System.NotSupportedException">Any access</exception>
  2476. </member>
  2477. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.WriteByte(System.Byte)">
  2478. <summary>
  2479. Writes one byte to the current stream and advances the current position
  2480. Always throws a NotSupportedException
  2481. </summary>
  2482. <param name="value">The byte to write.</param>
  2483. <exception cref="T:System.NotSupportedException">Any access</exception>
  2484. </member>
  2485. <member name="M:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.Dispose(System.Boolean)">
  2486. <summary>
  2487. Closes the input stream. When <see cref="P:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.IsStreamOwner"></see>
  2488. is true the underlying stream is also closed.
  2489. </summary>
  2490. </member>
  2491. <member name="F:ICSharpCode.SharpZipLib.Lzw.LzwInputStream.isClosed">
  2492. <summary>
  2493. Flag indicating wether this instance has been closed or not.
  2494. </summary>
  2495. </member>
  2496. <member name="T:ICSharpCode.SharpZipLib.Tar.InvalidHeaderException">
  2497. <summary>
  2498. This exception is used to indicate that there is a problem
  2499. with a TAR archive header.
  2500. </summary>
  2501. </member>
  2502. <member name="M:ICSharpCode.SharpZipLib.Tar.InvalidHeaderException.#ctor">
  2503. <summary>
  2504. Initialise a new instance of the InvalidHeaderException class.
  2505. </summary>
  2506. </member>
  2507. <member name="M:ICSharpCode.SharpZipLib.Tar.InvalidHeaderException.#ctor(System.String)">
  2508. <summary>
  2509. Initialises a new instance of the InvalidHeaderException class with a specified message.
  2510. </summary>
  2511. <param name="message">Message describing the exception cause.</param>
  2512. </member>
  2513. <member name="M:ICSharpCode.SharpZipLib.Tar.InvalidHeaderException.#ctor(System.String,System.Exception)">
  2514. <summary>
  2515. Initialise a new instance of InvalidHeaderException
  2516. </summary>
  2517. <param name="message">Message describing the problem.</param>
  2518. <param name="exception">The exception that is the cause of the current exception.</param>
  2519. </member>
  2520. <member name="M:ICSharpCode.SharpZipLib.Tar.InvalidHeaderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2521. <summary>
  2522. Initializes a new instance of the InvalidHeaderException class with serialized data.
  2523. </summary>
  2524. <param name="info">
  2525. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  2526. object data about the exception being thrown.
  2527. </param>
  2528. <param name="context">
  2529. The System.Runtime.Serialization.StreamingContext that contains contextual information
  2530. about the source or destination.
  2531. </param>
  2532. </member>
  2533. <member name="T:ICSharpCode.SharpZipLib.Tar.ProgressMessageHandler">
  2534. <summary>
  2535. Used to advise clients of 'events' while processing archives
  2536. </summary>
  2537. </member>
  2538. <member name="T:ICSharpCode.SharpZipLib.Tar.TarArchive">
  2539. <summary>
  2540. The TarArchive class implements the concept of a
  2541. 'Tape Archive'. A tar archive is a series of entries, each of
  2542. which represents a file system object. Each entry in
  2543. the archive consists of a header block followed by 0 or more data blocks.
  2544. Directory entries consist only of the header block, and are followed by entries
  2545. for the directory's contents. File entries consist of a
  2546. header followed by the number of blocks needed to
  2547. contain the file's contents. All entries are written on
  2548. block boundaries. Blocks are 512 bytes long.
  2549. TarArchives are instantiated in either read or write mode,
  2550. based upon whether they are instantiated with an InputStream
  2551. or an OutputStream. Once instantiated TarArchives read/write
  2552. mode can not be changed.
  2553. There is currently no support for random access to tar archives.
  2554. However, it seems that subclassing TarArchive, and using the
  2555. TarBuffer.CurrentRecord and TarBuffer.CurrentBlock
  2556. properties, this would be rather trivial.
  2557. </summary>
  2558. </member>
  2559. <member name="E:ICSharpCode.SharpZipLib.Tar.TarArchive.ProgressMessageEvent">
  2560. <summary>
  2561. Client hook allowing detailed information to be reported during processing
  2562. </summary>
  2563. </member>
  2564. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.OnProgressMessageEvent(ICSharpCode.SharpZipLib.Tar.TarEntry,System.String)">
  2565. <summary>
  2566. Raises the ProgressMessage event
  2567. </summary>
  2568. <param name="entry">The <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry">TarEntry</see> for this event</param>
  2569. <param name="message">message for this event. Null is no message</param>
  2570. </member>
  2571. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.#ctor">
  2572. <summary>
  2573. Constructor for a default <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/>.
  2574. </summary>
  2575. </member>
  2576. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.#ctor(ICSharpCode.SharpZipLib.Tar.TarInputStream)">
  2577. <summary>
  2578. Initialise a TarArchive for input.
  2579. </summary>
  2580. <param name="stream">The <see cref="T:ICSharpCode.SharpZipLib.Tar.TarInputStream"/> to use for input.</param>
  2581. </member>
  2582. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.#ctor(ICSharpCode.SharpZipLib.Tar.TarOutputStream)">
  2583. <summary>
  2584. Initialise a TarArchive for output.
  2585. </summary>
  2586. <param name="stream">The <see cref="T:ICSharpCode.SharpZipLib.Tar.TarOutputStream"/> to use for output.</param>
  2587. </member>
  2588. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateInputTarArchive(System.IO.Stream)">
  2589. <summary>
  2590. The InputStream based constructors create a TarArchive for the
  2591. purposes of extracting or listing a tar archive. Thus, use
  2592. these constructors when you wish to extract files from or list
  2593. the contents of an existing tar archive.
  2594. </summary>
  2595. <param name="inputStream">The stream to retrieve archive data from.</param>
  2596. <returns>Returns a new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for reading from.</returns>
  2597. </member>
  2598. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateInputTarArchive(System.IO.Stream,System.Text.Encoding)">
  2599. <summary>
  2600. The InputStream based constructors create a TarArchive for the
  2601. purposes of extracting or listing a tar archive. Thus, use
  2602. these constructors when you wish to extract files from or list
  2603. the contents of an existing tar archive.
  2604. </summary>
  2605. <param name="inputStream">The stream to retrieve archive data from.</param>
  2606. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  2607. <returns>Returns a new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for reading from.</returns>
  2608. </member>
  2609. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateInputTarArchive(System.IO.Stream,System.Int32)">
  2610. <summary>
  2611. Create TarArchive for reading setting block factor
  2612. </summary>
  2613. <param name="inputStream">A stream containing the tar archive contents</param>
  2614. <param name="blockFactor">The blocking factor to apply</param>
  2615. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for reading.</returns>
  2616. </member>
  2617. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateInputTarArchive(System.IO.Stream,System.Int32,System.Text.Encoding)">
  2618. <summary>
  2619. Create TarArchive for reading setting block factor
  2620. </summary>
  2621. <param name="inputStream">A stream containing the tar archive contents</param>
  2622. <param name="blockFactor">The blocking factor to apply</param>
  2623. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  2624. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for reading.</returns>
  2625. </member>
  2626. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateOutputTarArchive(System.IO.Stream,System.Text.Encoding)">
  2627. <summary>
  2628. Create a TarArchive for writing to, using the default blocking factor
  2629. </summary>
  2630. <param name="outputStream">The <see cref="T:System.IO.Stream"/> to write to</param>
  2631. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  2632. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for writing.</returns>
  2633. </member>
  2634. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateOutputTarArchive(System.IO.Stream)">
  2635. <summary>
  2636. Create a TarArchive for writing to, using the default blocking factor
  2637. </summary>
  2638. <param name="outputStream">The <see cref="T:System.IO.Stream"/> to write to</param>
  2639. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for writing.</returns>
  2640. </member>
  2641. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateOutputTarArchive(System.IO.Stream,System.Int32)">
  2642. <summary>
  2643. Create a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive">tar archive</see> for writing.
  2644. </summary>
  2645. <param name="outputStream">The stream to write to</param>
  2646. <param name="blockFactor">The blocking factor to use for buffering.</param>
  2647. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for writing.</returns>
  2648. </member>
  2649. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CreateOutputTarArchive(System.IO.Stream,System.Int32,System.Text.Encoding)">
  2650. <summary>
  2651. Create a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive">tar archive</see> for writing.
  2652. </summary>
  2653. <param name="outputStream">The stream to write to</param>
  2654. <param name="blockFactor">The blocking factor to use for buffering.</param>
  2655. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  2656. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/> suitable for writing.</returns>
  2657. </member>
  2658. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.SetKeepOldFiles(System.Boolean)">
  2659. <summary>
  2660. Set the flag that determines whether existing files are
  2661. kept, or overwritten during extraction.
  2662. </summary>
  2663. <param name="keepExistingFiles">
  2664. If true, do not overwrite existing files.
  2665. </param>
  2666. </member>
  2667. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.AsciiTranslate">
  2668. <summary>
  2669. Get/set the ascii file translation flag. If ascii file translation
  2670. is true, then the file is checked to see if it a binary file or not.
  2671. If the flag is true and the test indicates it is ascii text
  2672. file, it will be translated. The translation converts the local
  2673. operating system's concept of line ends into the UNIX line end,
  2674. '\n', which is the defacto standard for a TAR archive. This makes
  2675. text files compatible with UNIX.
  2676. </summary>
  2677. </member>
  2678. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.SetAsciiTranslation(System.Boolean)">
  2679. <summary>
  2680. Set the ascii file translation flag.
  2681. </summary>
  2682. <param name= "translateAsciiFiles">
  2683. If true, translate ascii text files.
  2684. </param>
  2685. </member>
  2686. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.PathPrefix">
  2687. <summary>
  2688. PathPrefix is added to entry names as they are written if the value is not null.
  2689. A slash character is appended after PathPrefix
  2690. </summary>
  2691. </member>
  2692. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.RootPath">
  2693. <summary>
  2694. RootPath is removed from entry names if it is found at the
  2695. beginning of the name.
  2696. </summary>
  2697. </member>
  2698. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.SetUserInfo(System.Int32,System.String,System.Int32,System.String)">
  2699. <summary>
  2700. Set user and group information that will be used to fill in the
  2701. tar archive's entry headers. This information is based on that available
  2702. for the linux operating system, which is not always available on other
  2703. operating systems. TarArchive allows the programmer to specify values
  2704. to be used in their place.
  2705. <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides"/> is set to true by this call.
  2706. </summary>
  2707. <param name="userId">
  2708. The user id to use in the headers.
  2709. </param>
  2710. <param name="userName">
  2711. The user name to use in the headers.
  2712. </param>
  2713. <param name="groupId">
  2714. The group id to use in the headers.
  2715. </param>
  2716. <param name="groupName">
  2717. The group name to use in the headers.
  2718. </param>
  2719. </member>
  2720. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">
  2721. <summary>
  2722. Get or set a value indicating if overrides defined by <see cref="M:ICSharpCode.SharpZipLib.Tar.TarArchive.SetUserInfo(System.Int32,System.String,System.Int32,System.String)">SetUserInfo</see> should be applied.
  2723. </summary>
  2724. <remarks>If overrides are not applied then the values as set in each header will be used.</remarks>
  2725. </member>
  2726. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.UserId">
  2727. <summary>
  2728. Get the archive user id.
  2729. See <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">ApplyUserInfoOverrides</see> for detail
  2730. on how to allow setting values on a per entry basis.
  2731. </summary>
  2732. <returns>
  2733. The current user id.
  2734. </returns>
  2735. </member>
  2736. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.UserName">
  2737. <summary>
  2738. Get the archive user name.
  2739. See <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">ApplyUserInfoOverrides</see> for detail
  2740. on how to allow setting values on a per entry basis.
  2741. </summary>
  2742. <returns>
  2743. The current user name.
  2744. </returns>
  2745. </member>
  2746. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.GroupId">
  2747. <summary>
  2748. Get the archive group id.
  2749. See <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">ApplyUserInfoOverrides</see> for detail
  2750. on how to allow setting values on a per entry basis.
  2751. </summary>
  2752. <returns>
  2753. The current group id.
  2754. </returns>
  2755. </member>
  2756. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.GroupName">
  2757. <summary>
  2758. Get the archive group name.
  2759. See <see cref="P:ICSharpCode.SharpZipLib.Tar.TarArchive.ApplyUserInfoOverrides">ApplyUserInfoOverrides</see> for detail
  2760. on how to allow setting values on a per entry basis.
  2761. </summary>
  2762. <returns>
  2763. The current group name.
  2764. </returns>
  2765. </member>
  2766. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.RecordSize">
  2767. <summary>
  2768. Get the archive's record size. Tar archives are composed of
  2769. a series of RECORDS each containing a number of BLOCKS.
  2770. This allowed tar archives to match the IO characteristics of
  2771. the physical device being used. Archives are expected
  2772. to be properly "blocked".
  2773. </summary>
  2774. <returns>
  2775. The record size this archive is using.
  2776. </returns>
  2777. </member>
  2778. <member name="P:ICSharpCode.SharpZipLib.Tar.TarArchive.IsStreamOwner">
  2779. <summary>
  2780. Sets the IsStreamOwner property on the underlying stream.
  2781. Set this to false to prevent the Close of the TarArchive from closing the stream.
  2782. </summary>
  2783. </member>
  2784. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.CloseArchive">
  2785. <summary>
  2786. Close the archive.
  2787. </summary>
  2788. </member>
  2789. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.ListContents">
  2790. <summary>
  2791. Perform the "list" command for the archive contents.
  2792. NOTE That this method uses the <see cref="E:ICSharpCode.SharpZipLib.Tar.TarArchive.ProgressMessageEvent"> progress event</see> to actually list
  2793. the contents. If the progress display event is not set, nothing will be listed!
  2794. </summary>
  2795. </member>
  2796. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.ExtractContents(System.String)">
  2797. <summary>
  2798. Perform the "extract" command and extract the contents of the archive.
  2799. </summary>
  2800. <param name="destinationDirectory">
  2801. The destination directory into which to extract.
  2802. </param>
  2803. </member>
  2804. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.ExtractContents(System.String,System.Boolean)">
  2805. <summary>
  2806. Perform the "extract" command and extract the contents of the archive.
  2807. </summary>
  2808. <param name="destinationDirectory">
  2809. The destination directory into which to extract.
  2810. </param>
  2811. <param name="allowParentTraversal">Allow parent directory traversal in file paths (e.g. ../file)</param>
  2812. </member>
  2813. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.ExtractEntry(System.String,ICSharpCode.SharpZipLib.Tar.TarEntry,System.Boolean)">
  2814. <summary>
  2815. Extract an entry from the archive. This method assumes that the
  2816. tarIn stream has been properly set with a call to GetNextEntry().
  2817. </summary>
  2818. <param name="destDir">
  2819. The destination directory into which to extract.
  2820. </param>
  2821. <param name="entry">
  2822. The TarEntry returned by tarIn.GetNextEntry().
  2823. </param>
  2824. <param name="allowParentTraversal">Allow parent directory traversal in file paths (e.g. ../file)</param>
  2825. </member>
  2826. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.WriteEntry(ICSharpCode.SharpZipLib.Tar.TarEntry,System.Boolean)">
  2827. <summary>
  2828. Write an entry to the archive. This method will call the putNextEntry
  2829. and then write the contents of the entry, and finally call closeEntry()
  2830. for entries that are files. For directories, it will call putNextEntry(),
  2831. and then, if the recurse flag is true, process each entry that is a
  2832. child of the directory.
  2833. </summary>
  2834. <param name="sourceEntry">
  2835. The TarEntry representing the entry to write to the archive.
  2836. </param>
  2837. <param name="recurse">
  2838. If true, process the children of directory entries.
  2839. </param>
  2840. </member>
  2841. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.WriteEntryCore(ICSharpCode.SharpZipLib.Tar.TarEntry,System.Boolean)">
  2842. <summary>
  2843. Write an entry to the archive. This method will call the putNextEntry
  2844. and then write the contents of the entry, and finally call closeEntry()
  2845. for entries that are files. For directories, it will call putNextEntry(),
  2846. and then, if the recurse flag is true, process each entry that is a
  2847. child of the directory.
  2848. </summary>
  2849. <param name="sourceEntry">
  2850. The TarEntry representing the entry to write to the archive.
  2851. </param>
  2852. <param name="recurse">
  2853. If true, process the children of directory entries.
  2854. </param>
  2855. </member>
  2856. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.Dispose">
  2857. <summary>
  2858. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  2859. </summary>
  2860. </member>
  2861. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.Dispose(System.Boolean)">
  2862. <summary>
  2863. Releases the unmanaged resources used by the FileStream and optionally releases the managed resources.
  2864. </summary>
  2865. <param name="disposing">true to release both managed and unmanaged resources;
  2866. false to release only unmanaged resources.</param>
  2867. </member>
  2868. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.Close">
  2869. <summary>
  2870. Closes the archive and releases any associated resources.
  2871. </summary>
  2872. </member>
  2873. <member name="M:ICSharpCode.SharpZipLib.Tar.TarArchive.Finalize">
  2874. <summary>
  2875. Ensures that resources are freed and other cleanup operations are performed
  2876. when the garbage collector reclaims the <see cref="T:ICSharpCode.SharpZipLib.Tar.TarArchive"/>.
  2877. </summary>
  2878. </member>
  2879. <member name="T:ICSharpCode.SharpZipLib.Tar.TarBuffer">
  2880. <summary>
  2881. The TarBuffer class implements the tar archive concept
  2882. of a buffered input stream. This concept goes back to the
  2883. days of blocked tape drives and special io devices. In the
  2884. C# universe, the only real function that this class
  2885. performs is to ensure that files have the correct "record"
  2886. size, or other tars will complain.
  2887. <p>
  2888. You should never have a need to access this class directly.
  2889. TarBuffers are created by Tar IO Streams.
  2890. </p>
  2891. </summary>
  2892. </member>
  2893. <member name="F:ICSharpCode.SharpZipLib.Tar.TarBuffer.BlockSize">
  2894. <summary>
  2895. The size of a block in a tar archive in bytes.
  2896. </summary>
  2897. <remarks>This is 512 bytes.</remarks>
  2898. </member>
  2899. <member name="F:ICSharpCode.SharpZipLib.Tar.TarBuffer.DefaultBlockFactor">
  2900. <summary>
  2901. The number of blocks in a default record.
  2902. </summary>
  2903. <remarks>
  2904. The default value is 20 blocks per record.
  2905. </remarks>
  2906. </member>
  2907. <member name="F:ICSharpCode.SharpZipLib.Tar.TarBuffer.DefaultRecordSize">
  2908. <summary>
  2909. The size in bytes of a default record.
  2910. </summary>
  2911. <remarks>
  2912. The default size is 10KB.
  2913. </remarks>
  2914. </member>
  2915. <member name="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.RecordSize">
  2916. <summary>
  2917. Get the record size for this buffer
  2918. </summary>
  2919. <value>The record size in bytes.
  2920. This is equal to the <see cref="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.BlockFactor"/> multiplied by the <see cref="F:ICSharpCode.SharpZipLib.Tar.TarBuffer.BlockSize"/></value>
  2921. </member>
  2922. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.GetRecordSize">
  2923. <summary>
  2924. Get the TAR Buffer's record size.
  2925. </summary>
  2926. <returns>The record size in bytes.
  2927. This is equal to the <see cref="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.BlockFactor"/> multiplied by the <see cref="F:ICSharpCode.SharpZipLib.Tar.TarBuffer.BlockSize"/></returns>
  2928. </member>
  2929. <member name="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.BlockFactor">
  2930. <summary>
  2931. Get the Blocking factor for the buffer
  2932. </summary>
  2933. <value>This is the number of blocks in each record.</value>
  2934. </member>
  2935. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.GetBlockFactor">
  2936. <summary>
  2937. Get the TAR Buffer's block factor
  2938. </summary>
  2939. <returns>The block factor; the number of blocks per record.</returns>
  2940. </member>
  2941. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.#ctor">
  2942. <summary>
  2943. Construct a default TarBuffer
  2944. </summary>
  2945. </member>
  2946. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.CreateInputTarBuffer(System.IO.Stream)">
  2947. <summary>
  2948. Create TarBuffer for reading with default BlockFactor
  2949. </summary>
  2950. <param name="inputStream">Stream to buffer</param>
  2951. <returns>A new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarBuffer"/> suitable for input.</returns>
  2952. </member>
  2953. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.CreateInputTarBuffer(System.IO.Stream,System.Int32)">
  2954. <summary>
  2955. Construct TarBuffer for reading inputStream setting BlockFactor
  2956. </summary>
  2957. <param name="inputStream">Stream to buffer</param>
  2958. <param name="blockFactor">Blocking factor to apply</param>
  2959. <returns>A new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarBuffer"/> suitable for input.</returns>
  2960. </member>
  2961. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.CreateOutputTarBuffer(System.IO.Stream)">
  2962. <summary>
  2963. Construct TarBuffer for writing with default BlockFactor
  2964. </summary>
  2965. <param name="outputStream">output stream for buffer</param>
  2966. <returns>A new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarBuffer"/> suitable for output.</returns>
  2967. </member>
  2968. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.CreateOutputTarBuffer(System.IO.Stream,System.Int32)">
  2969. <summary>
  2970. Construct TarBuffer for writing Tar output to streams.
  2971. </summary>
  2972. <param name="outputStream">Output stream to write to.</param>
  2973. <param name="blockFactor">Blocking factor to apply</param>
  2974. <returns>A new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarBuffer"/> suitable for output.</returns>
  2975. </member>
  2976. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.Initialize(System.Int32)">
  2977. <summary>
  2978. Initialization common to all constructors.
  2979. </summary>
  2980. </member>
  2981. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.IsEOFBlock(System.Byte[])">
  2982. <summary>
  2983. Determine if an archive block indicates End of Archive. End of
  2984. archive is indicated by a block that consists entirely of null bytes.
  2985. All remaining blocks for the record should also be null's
  2986. However some older tars only do a couple of null blocks (Old GNU tar for one)
  2987. and also partial records
  2988. </summary>
  2989. <param name = "block">The data block to check.</param>
  2990. <returns>Returns true if the block is an EOF block; false otherwise.</returns>
  2991. </member>
  2992. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.IsEndOfArchiveBlock(System.Byte[])">
  2993. <summary>
  2994. Determine if an archive block indicates the End of an Archive has been reached.
  2995. End of archive is indicated by a block that consists entirely of null bytes.
  2996. All remaining blocks for the record should also be null's
  2997. However some older tars only do a couple of null blocks (Old GNU tar for one)
  2998. and also partial records
  2999. </summary>
  3000. <param name = "block">The data block to check.</param>
  3001. <returns>Returns true if the block is an EOF block; false otherwise.</returns>
  3002. </member>
  3003. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.SkipBlock">
  3004. <summary>
  3005. Skip over a block on the input stream.
  3006. </summary>
  3007. </member>
  3008. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.SkipBlockAsync(System.Threading.CancellationToken)">
  3009. <summary>
  3010. Skip over a block on the input stream.
  3011. </summary>
  3012. </member>
  3013. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.ReadBlock">
  3014. <summary>
  3015. Read a block from the input stream.
  3016. </summary>
  3017. <returns>
  3018. The block of data read.
  3019. </returns>
  3020. </member>
  3021. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.ReadRecordAsync(System.Threading.CancellationToken,System.Boolean)">
  3022. <summary>
  3023. Read a record from data stream.
  3024. </summary>
  3025. <returns>
  3026. false if End-Of-File, else true.
  3027. </returns>
  3028. </member>
  3029. <member name="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.CurrentBlock">
  3030. <summary>
  3031. Get the current block number, within the current record, zero based.
  3032. </summary>
  3033. <remarks>Block numbers are zero based values</remarks>
  3034. <seealso cref="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.RecordSize"/>
  3035. </member>
  3036. <member name="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.IsStreamOwner">
  3037. <summary>
  3038. Gets or sets a flag indicating ownership of underlying stream.
  3039. When the flag is true <see cref="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.Close" /> will close the underlying stream also.
  3040. </summary>
  3041. <remarks>The default value is true.</remarks>
  3042. </member>
  3043. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.GetCurrentBlockNum">
  3044. <summary>
  3045. Get the current block number, within the current record, zero based.
  3046. </summary>
  3047. <returns>
  3048. The current zero based block number.
  3049. </returns>
  3050. <remarks>
  3051. The absolute block number = (<see cref="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.GetCurrentRecordNum">record number</see> * <see cref="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.BlockFactor">block factor</see>) + <see cref="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.GetCurrentBlockNum">block number</see>.
  3052. </remarks>
  3053. </member>
  3054. <member name="P:ICSharpCode.SharpZipLib.Tar.TarBuffer.CurrentRecord">
  3055. <summary>
  3056. Get the current record number.
  3057. </summary>
  3058. <returns>
  3059. The current zero based record number.
  3060. </returns>
  3061. </member>
  3062. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.GetCurrentRecordNum">
  3063. <summary>
  3064. Get the current record number.
  3065. </summary>
  3066. <returns>
  3067. The current zero based record number.
  3068. </returns>
  3069. </member>
  3070. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.WriteBlockAsync(System.Byte[],System.Threading.CancellationToken)">
  3071. <summary>
  3072. Write a block of data to the archive.
  3073. </summary>
  3074. <param name="block">
  3075. The data to write to the archive.
  3076. </param>
  3077. <param name="ct"></param>
  3078. </member>
  3079. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.WriteBlock(System.Byte[])">
  3080. <summary>
  3081. Write a block of data to the archive.
  3082. </summary>
  3083. <param name="block">
  3084. The data to write to the archive.
  3085. </param>
  3086. </member>
  3087. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.WriteBlockAsync(System.Byte[],System.Int32,System.Threading.CancellationToken)">
  3088. <summary>
  3089. Write an archive record to the archive, where the record may be
  3090. inside of a larger array buffer. The buffer must be "offset plus
  3091. record size" long.
  3092. </summary>
  3093. <param name="buffer">
  3094. The buffer containing the record data to write.
  3095. </param>
  3096. <param name="offset">
  3097. The offset of the record data within buffer.
  3098. </param>
  3099. <param name="ct"></param>
  3100. </member>
  3101. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.WriteBlock(System.Byte[],System.Int32)">
  3102. <summary>
  3103. Write an archive record to the archive, where the record may be
  3104. inside of a larger array buffer. The buffer must be "offset plus
  3105. record size" long.
  3106. </summary>
  3107. <param name="buffer">
  3108. The buffer containing the record data to write.
  3109. </param>
  3110. <param name="offset">
  3111. The offset of the record data within buffer.
  3112. </param>
  3113. </member>
  3114. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.WriteRecordAsync(System.Threading.CancellationToken,System.Boolean)">
  3115. <summary>
  3116. Write a TarBuffer record to the archive.
  3117. </summary>
  3118. </member>
  3119. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.WriteFinalRecordAsync(System.Threading.CancellationToken,System.Boolean)">
  3120. <summary>
  3121. WriteFinalRecord writes the current record buffer to output any unwritten data is present.
  3122. </summary>
  3123. <remarks>Any trailing bytes are set to zero which is by definition correct behaviour
  3124. for the end of a tar stream.</remarks>
  3125. </member>
  3126. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.Close">
  3127. <summary>
  3128. Close the TarBuffer. If this is an output buffer, also flush the
  3129. current block before closing.
  3130. </summary>
  3131. </member>
  3132. <member name="M:ICSharpCode.SharpZipLib.Tar.TarBuffer.CloseAsync(System.Threading.CancellationToken)">
  3133. <summary>
  3134. Close the TarBuffer. If this is an output buffer, also flush the
  3135. current block before closing.
  3136. </summary>
  3137. </member>
  3138. <member name="T:ICSharpCode.SharpZipLib.Tar.TarEntry">
  3139. <summary>
  3140. This class represents an entry in a Tar archive. It consists
  3141. of the entry's header, as well as the entry's File. Entries
  3142. can be instantiated in one of three ways, depending on how
  3143. they are to be used.
  3144. <p>
  3145. TarEntries that are created from the header bytes read from
  3146. an archive are instantiated with the TarEntry( byte[] )
  3147. constructor. These entries will be used when extracting from
  3148. or listing the contents of an archive. These entries have their
  3149. header filled in using the header bytes. They also set the File
  3150. to null, since they reference an archive entry not a file.</p>
  3151. <p>
  3152. TarEntries that are created from files that are to be written
  3153. into an archive are instantiated with the CreateEntryFromFile(string)
  3154. pseudo constructor. These entries have their header filled in using
  3155. the File's information. They also keep a reference to the File
  3156. for convenience when writing entries.</p>
  3157. <p>
  3158. Finally, TarEntries can be constructed from nothing but a name.
  3159. This allows the programmer to construct the entry by hand, for
  3160. instance when only an InputStream is available for writing to
  3161. the archive, and the header information is constructed from
  3162. other information. In this case the header fields are set to
  3163. defaults and the File is set to null.</p>
  3164. <see cref="P:ICSharpCode.SharpZipLib.Tar.TarEntry.TarHeader"/>
  3165. </summary>
  3166. </member>
  3167. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.#ctor">
  3168. <summary>
  3169. Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry"/>.
  3170. </summary>
  3171. </member>
  3172. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.#ctor(System.Byte[])">
  3173. <summary>
  3174. Construct an entry from an archive's header bytes. File is set
  3175. to null.
  3176. </summary>
  3177. <param name = "headerBuffer">
  3178. The header bytes from a tar archive entry.
  3179. </param>
  3180. </member>
  3181. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.#ctor(System.Byte[],System.Text.Encoding)">
  3182. <summary>
  3183. Construct an entry from an archive's header bytes. File is set
  3184. to null.
  3185. </summary>
  3186. <param name = "headerBuffer">
  3187. The header bytes from a tar archive entry.
  3188. </param>
  3189. <param name = "nameEncoding">
  3190. The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only
  3191. </param>
  3192. </member>
  3193. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.#ctor(ICSharpCode.SharpZipLib.Tar.TarHeader)">
  3194. <summary>
  3195. Construct a TarEntry using the <paramref name="header">header</paramref> provided
  3196. </summary>
  3197. <param name="header">Header details for entry</param>
  3198. </member>
  3199. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.Clone">
  3200. <summary>
  3201. Clone this tar entry.
  3202. </summary>
  3203. <returns>Returns a clone of this entry.</returns>
  3204. </member>
  3205. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.CreateTarEntry(System.String)">
  3206. <summary>
  3207. Construct an entry with only a <paramref name="name">name</paramref>.
  3208. This allows the programmer to construct the entry's header "by hand".
  3209. </summary>
  3210. <param name="name">The name to use for the entry</param>
  3211. <returns>Returns the newly created <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry"/></returns>
  3212. </member>
  3213. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.CreateEntryFromFile(System.String)">
  3214. <summary>
  3215. Construct an entry for a file. File is set to file, and the
  3216. header is constructed from information from the file.
  3217. </summary>
  3218. <param name = "fileName">The file name that the entry represents.</param>
  3219. <returns>Returns the newly created <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry"/></returns>
  3220. </member>
  3221. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.Equals(System.Object)">
  3222. <summary>
  3223. Determine if the two entries are equal. Equality is determined
  3224. by the header names being equal.
  3225. </summary>
  3226. <param name="obj">The <see cref="T:System.Object"/> to compare with the current Object.</param>
  3227. <returns>
  3228. True if the entries are equal; false if not.
  3229. </returns>
  3230. </member>
  3231. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.GetHashCode">
  3232. <summary>
  3233. Derive a Hash value for the current <see cref="T:System.Object"/>
  3234. </summary>
  3235. <returns>A Hash code for the current <see cref="T:System.Object"/></returns>
  3236. </member>
  3237. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.IsDescendent(ICSharpCode.SharpZipLib.Tar.TarEntry)">
  3238. <summary>
  3239. Determine if the given entry is a descendant of this entry.
  3240. Descendancy is determined by the name of the descendant
  3241. starting with this entry's name.
  3242. </summary>
  3243. <param name = "toTest">
  3244. Entry to be checked as a descendent of this.
  3245. </param>
  3246. <returns>
  3247. True if entry is a descendant of this.
  3248. </returns>
  3249. </member>
  3250. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.TarHeader">
  3251. <summary>
  3252. Get this entry's header.
  3253. </summary>
  3254. <returns>
  3255. This entry's TarHeader.
  3256. </returns>
  3257. </member>
  3258. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.Name">
  3259. <summary>
  3260. Get/Set this entry's name.
  3261. </summary>
  3262. </member>
  3263. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.UserId">
  3264. <summary>
  3265. Get/set this entry's user id.
  3266. </summary>
  3267. </member>
  3268. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.GroupId">
  3269. <summary>
  3270. Get/set this entry's group id.
  3271. </summary>
  3272. </member>
  3273. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.UserName">
  3274. <summary>
  3275. Get/set this entry's user name.
  3276. </summary>
  3277. </member>
  3278. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.GroupName">
  3279. <summary>
  3280. Get/set this entry's group name.
  3281. </summary>
  3282. </member>
  3283. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.SetIds(System.Int32,System.Int32)">
  3284. <summary>
  3285. Convenience method to set this entry's group and user ids.
  3286. </summary>
  3287. <param name="userId">
  3288. This entry's new user id.
  3289. </param>
  3290. <param name="groupId">
  3291. This entry's new group id.
  3292. </param>
  3293. </member>
  3294. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.SetNames(System.String,System.String)">
  3295. <summary>
  3296. Convenience method to set this entry's group and user names.
  3297. </summary>
  3298. <param name="userName">
  3299. This entry's new user name.
  3300. </param>
  3301. <param name="groupName">
  3302. This entry's new group name.
  3303. </param>
  3304. </member>
  3305. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.ModTime">
  3306. <summary>
  3307. Get/Set the modification time for this entry
  3308. </summary>
  3309. </member>
  3310. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.File">
  3311. <summary>
  3312. Get this entry's file.
  3313. </summary>
  3314. <returns>
  3315. This entry's file.
  3316. </returns>
  3317. </member>
  3318. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.Size">
  3319. <summary>
  3320. Get/set this entry's recorded file size.
  3321. </summary>
  3322. </member>
  3323. <member name="P:ICSharpCode.SharpZipLib.Tar.TarEntry.IsDirectory">
  3324. <summary>
  3325. Return true if this entry represents a directory, false otherwise
  3326. </summary>
  3327. <returns>
  3328. True if this entry is a directory.
  3329. </returns>
  3330. </member>
  3331. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.GetFileTarHeader(ICSharpCode.SharpZipLib.Tar.TarHeader,System.String)">
  3332. <summary>
  3333. Fill in a TarHeader with information from a File.
  3334. </summary>
  3335. <param name="header">
  3336. The TarHeader to fill in.
  3337. </param>
  3338. <param name="file">
  3339. The file from which to get the header information.
  3340. </param>
  3341. </member>
  3342. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.GetDirectoryEntries">
  3343. <summary>
  3344. Get entries for all files present in this entries directory.
  3345. If this entry doesnt represent a directory zero entries are returned.
  3346. </summary>
  3347. <returns>
  3348. An array of TarEntry's for this entry's children.
  3349. </returns>
  3350. </member>
  3351. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.WriteEntryHeader(System.Byte[])">
  3352. <summary>
  3353. Write an entry's header information to a header buffer.
  3354. </summary>
  3355. <param name = "outBuffer">
  3356. The tar entry header buffer to fill in.
  3357. </param>
  3358. </member>
  3359. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.WriteEntryHeader(System.Byte[],System.Text.Encoding)">
  3360. <summary>
  3361. Write an entry's header information to a header buffer.
  3362. </summary>
  3363. <param name = "outBuffer">
  3364. The tar entry header buffer to fill in.
  3365. </param>
  3366. <param name = "nameEncoding">
  3367. The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only
  3368. </param>
  3369. </member>
  3370. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.AdjustEntryName(System.Byte[],System.String)">
  3371. <summary>
  3372. Convenience method that will modify an entry's name directly
  3373. in place in an entry header buffer byte array.
  3374. </summary>
  3375. <param name="buffer">
  3376. The buffer containing the entry header to modify.
  3377. </param>
  3378. <param name="newName">
  3379. The new name to place into the header buffer.
  3380. </param>
  3381. </member>
  3382. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.AdjustEntryName(System.Byte[],System.String,System.Text.Encoding)">
  3383. <summary>
  3384. Convenience method that will modify an entry's name directly
  3385. in place in an entry header buffer byte array.
  3386. </summary>
  3387. <param name="buffer">
  3388. The buffer containing the entry header to modify.
  3389. </param>
  3390. <param name="newName">
  3391. The new name to place into the header buffer.
  3392. </param>
  3393. <param name="nameEncoding">
  3394. The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only
  3395. </param>
  3396. </member>
  3397. <member name="M:ICSharpCode.SharpZipLib.Tar.TarEntry.NameTarHeader(System.String)">
  3398. <summary>
  3399. Fill in a TarHeader given only the entry's name.
  3400. </summary>
  3401. <param name="name">
  3402. The tar entry name.
  3403. </param>
  3404. </member>
  3405. <member name="F:ICSharpCode.SharpZipLib.Tar.TarEntry.file">
  3406. <summary>
  3407. The name of the file this entry represents or null if the entry is not based on a file.
  3408. </summary>
  3409. </member>
  3410. <member name="F:ICSharpCode.SharpZipLib.Tar.TarEntry.header">
  3411. <summary>
  3412. The entry's header information.
  3413. </summary>
  3414. </member>
  3415. <member name="T:ICSharpCode.SharpZipLib.Tar.TarException">
  3416. <summary>
  3417. TarException represents exceptions specific to Tar classes and code.
  3418. </summary>
  3419. </member>
  3420. <member name="M:ICSharpCode.SharpZipLib.Tar.TarException.#ctor">
  3421. <summary>
  3422. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Tar.TarException" />.
  3423. </summary>
  3424. </member>
  3425. <member name="M:ICSharpCode.SharpZipLib.Tar.TarException.#ctor(System.String)">
  3426. <summary>
  3427. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Tar.TarException" /> with its message string.
  3428. </summary>
  3429. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  3430. </member>
  3431. <member name="M:ICSharpCode.SharpZipLib.Tar.TarException.#ctor(System.String,System.Exception)">
  3432. <summary>
  3433. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Tar.TarException" />.
  3434. </summary>
  3435. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  3436. <param name="innerException">The <see cref="T:System.Exception"/> that caused this exception.</param>
  3437. </member>
  3438. <member name="M:ICSharpCode.SharpZipLib.Tar.TarException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3439. <summary>
  3440. Initializes a new instance of the TarException class with serialized data.
  3441. </summary>
  3442. <param name="info">
  3443. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  3444. object data about the exception being thrown.
  3445. </param>
  3446. <param name="context">
  3447. The System.Runtime.Serialization.StreamingContext that contains contextual information
  3448. about the source or destination.
  3449. </param>
  3450. </member>
  3451. <member name="T:ICSharpCode.SharpZipLib.Tar.TarExtendedHeaderReader">
  3452. <summary>
  3453. Reads the extended header of a Tar stream
  3454. </summary>
  3455. </member>
  3456. <member name="M:ICSharpCode.SharpZipLib.Tar.TarExtendedHeaderReader.#ctor">
  3457. <summary>
  3458. Creates a new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarExtendedHeaderReader"/>.
  3459. </summary>
  3460. </member>
  3461. <member name="M:ICSharpCode.SharpZipLib.Tar.TarExtendedHeaderReader.Read(System.Byte[],System.Int32)">
  3462. <summary>
  3463. Read <paramref name="length"/> bytes from <paramref name="buffer"/>
  3464. </summary>
  3465. <param name="buffer"></param>
  3466. <param name="length"></param>
  3467. </member>
  3468. <member name="P:ICSharpCode.SharpZipLib.Tar.TarExtendedHeaderReader.Headers">
  3469. <summary>
  3470. Returns the parsed headers as key-value strings
  3471. </summary>
  3472. </member>
  3473. <member name="T:ICSharpCode.SharpZipLib.Tar.TarHeader">
  3474. <summary>
  3475. This class encapsulates the Tar Entry Header used in Tar Archives.
  3476. The class also holds a number of tar constants, used mostly in headers.
  3477. </summary>
  3478. <remarks>
  3479. The tar format and its POSIX successor PAX have a long history which makes for compatability
  3480. issues when creating and reading files.
  3481. This is further complicated by a large number of programs with variations on formats
  3482. One common issue is the handling of names longer than 100 characters.
  3483. GNU style long names are currently supported.
  3484. This is the ustar (Posix 1003.1) header.
  3485. struct header
  3486. {
  3487. char t_name[100]; // 0 Filename
  3488. char t_mode[8]; // 100 Permissions
  3489. char t_uid[8]; // 108 Numerical User ID
  3490. char t_gid[8]; // 116 Numerical Group ID
  3491. char t_size[12]; // 124 Filesize
  3492. char t_mtime[12]; // 136 st_mtime
  3493. char t_chksum[8]; // 148 Checksum
  3494. char t_typeflag; // 156 Type of File
  3495. char t_linkname[100]; // 157 Target of Links
  3496. char t_magic[6]; // 257 "ustar" or other...
  3497. char t_version[2]; // 263 Version fixed to 00
  3498. char t_uname[32]; // 265 User Name
  3499. char t_gname[32]; // 297 Group Name
  3500. char t_devmajor[8]; // 329 Major for devices
  3501. char t_devminor[8]; // 337 Minor for devices
  3502. char t_prefix[155]; // 345 Prefix for t_name
  3503. char t_mfill[12]; // 500 Filler up to 512
  3504. };
  3505. </remarks>
  3506. </member>
  3507. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.NAMELEN">
  3508. <summary>
  3509. The length of the name field in a header buffer.
  3510. </summary>
  3511. </member>
  3512. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.MODELEN">
  3513. <summary>
  3514. The length of the mode field in a header buffer.
  3515. </summary>
  3516. </member>
  3517. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.UIDLEN">
  3518. <summary>
  3519. The length of the user id field in a header buffer.
  3520. </summary>
  3521. </member>
  3522. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.GIDLEN">
  3523. <summary>
  3524. The length of the group id field in a header buffer.
  3525. </summary>
  3526. </member>
  3527. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.CHKSUMLEN">
  3528. <summary>
  3529. The length of the checksum field in a header buffer.
  3530. </summary>
  3531. </member>
  3532. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.CHKSUMOFS">
  3533. <summary>
  3534. Offset of checksum in a header buffer.
  3535. </summary>
  3536. </member>
  3537. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.SIZELEN">
  3538. <summary>
  3539. The length of the size field in a header buffer.
  3540. </summary>
  3541. </member>
  3542. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.MAGICLEN">
  3543. <summary>
  3544. The length of the magic field in a header buffer.
  3545. </summary>
  3546. </member>
  3547. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.VERSIONLEN">
  3548. <summary>
  3549. The length of the version field in a header buffer.
  3550. </summary>
  3551. </member>
  3552. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.MODTIMELEN">
  3553. <summary>
  3554. The length of the modification time field in a header buffer.
  3555. </summary>
  3556. </member>
  3557. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.UNAMELEN">
  3558. <summary>
  3559. The length of the user name field in a header buffer.
  3560. </summary>
  3561. </member>
  3562. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.GNAMELEN">
  3563. <summary>
  3564. The length of the group name field in a header buffer.
  3565. </summary>
  3566. </member>
  3567. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.DEVLEN">
  3568. <summary>
  3569. The length of the devices field in a header buffer.
  3570. </summary>
  3571. </member>
  3572. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.PREFIXLEN">
  3573. <summary>
  3574. The length of the name prefix field in a header buffer.
  3575. </summary>
  3576. </member>
  3577. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_OLDNORM">
  3578. <summary>
  3579. The "old way" of indicating a normal file.
  3580. </summary>
  3581. </member>
  3582. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_NORMAL">
  3583. <summary>
  3584. Normal file type.
  3585. </summary>
  3586. </member>
  3587. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_LINK">
  3588. <summary>
  3589. Link file type.
  3590. </summary>
  3591. </member>
  3592. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_SYMLINK">
  3593. <summary>
  3594. Symbolic link file type.
  3595. </summary>
  3596. </member>
  3597. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_CHR">
  3598. <summary>
  3599. Character device file type.
  3600. </summary>
  3601. </member>
  3602. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_BLK">
  3603. <summary>
  3604. Block device file type.
  3605. </summary>
  3606. </member>
  3607. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_DIR">
  3608. <summary>
  3609. Directory file type.
  3610. </summary>
  3611. </member>
  3612. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_FIFO">
  3613. <summary>
  3614. FIFO (pipe) file type.
  3615. </summary>
  3616. </member>
  3617. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_CONTIG">
  3618. <summary>
  3619. Contiguous file type.
  3620. </summary>
  3621. </member>
  3622. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_GHDR">
  3623. <summary>
  3624. Posix.1 2001 global extended header
  3625. </summary>
  3626. </member>
  3627. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_XHDR">
  3628. <summary>
  3629. Posix.1 2001 extended header
  3630. </summary>
  3631. </member>
  3632. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_ACL">
  3633. <summary>
  3634. Solaris access control list file type
  3635. </summary>
  3636. </member>
  3637. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_GNU_DUMPDIR">
  3638. <summary>
  3639. GNU dir dump file type
  3640. This is a dir entry that contains the names of files that were in the
  3641. dir at the time the dump was made
  3642. </summary>
  3643. </member>
  3644. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_EXTATTR">
  3645. <summary>
  3646. Solaris Extended Attribute File
  3647. </summary>
  3648. </member>
  3649. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_META">
  3650. <summary>
  3651. Inode (metadata only) no file content
  3652. </summary>
  3653. </member>
  3654. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_GNU_LONGLINK">
  3655. <summary>
  3656. Identifies the next file on the tape as having a long link name
  3657. </summary>
  3658. </member>
  3659. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_GNU_LONGNAME">
  3660. <summary>
  3661. Identifies the next file on the tape as having a long name
  3662. </summary>
  3663. </member>
  3664. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_GNU_MULTIVOL">
  3665. <summary>
  3666. Continuation of a file that began on another volume
  3667. </summary>
  3668. </member>
  3669. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_GNU_NAMES">
  3670. <summary>
  3671. For storing filenames that dont fit in the main header (old GNU)
  3672. </summary>
  3673. </member>
  3674. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_GNU_SPARSE">
  3675. <summary>
  3676. GNU Sparse file
  3677. </summary>
  3678. </member>
  3679. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.LF_GNU_VOLHDR">
  3680. <summary>
  3681. GNU Tape/volume header ignore on extraction
  3682. </summary>
  3683. </member>
  3684. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.TMAGIC">
  3685. <summary>
  3686. The magic tag representing a POSIX tar archive. (would be written with a trailing NULL)
  3687. </summary>
  3688. </member>
  3689. <member name="F:ICSharpCode.SharpZipLib.Tar.TarHeader.GNU_TMAGIC">
  3690. <summary>
  3691. The magic tag representing an old GNU tar archive where version is included in magic and overwrites it
  3692. </summary>
  3693. </member>
  3694. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.#ctor">
  3695. <summary>
  3696. Initialise a default TarHeader instance
  3697. </summary>
  3698. </member>
  3699. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.Name">
  3700. <summary>
  3701. Get/set the name for this tar entry.
  3702. </summary>
  3703. <exception cref="T:System.ArgumentNullException">Thrown when attempting to set the property to null.</exception>
  3704. </member>
  3705. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetName">
  3706. <summary>
  3707. Get the name of this entry.
  3708. </summary>
  3709. <returns>The entry's name.</returns>
  3710. </member>
  3711. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.Mode">
  3712. <summary>
  3713. Get/set the entry's Unix style permission mode.
  3714. </summary>
  3715. </member>
  3716. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.UserId">
  3717. <summary>
  3718. The entry's user id.
  3719. </summary>
  3720. <remarks>
  3721. This is only directly relevant to unix systems.
  3722. The default is zero.
  3723. </remarks>
  3724. </member>
  3725. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.GroupId">
  3726. <summary>
  3727. Get/set the entry's group id.
  3728. </summary>
  3729. <remarks>
  3730. This is only directly relevant to linux/unix systems.
  3731. The default value is zero.
  3732. </remarks>
  3733. </member>
  3734. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.Size">
  3735. <summary>
  3736. Get/set the entry's size.
  3737. </summary>
  3738. <exception cref="T:System.ArgumentOutOfRangeException">Thrown when setting the size to less than zero.</exception>
  3739. </member>
  3740. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.ModTime">
  3741. <summary>
  3742. Get/set the entry's modification time.
  3743. </summary>
  3744. <remarks>
  3745. The modification time is only accurate to within a second.
  3746. </remarks>
  3747. <exception cref="T:System.ArgumentOutOfRangeException">Thrown when setting the date time to less than 1/1/1970.</exception>
  3748. </member>
  3749. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.Checksum">
  3750. <summary>
  3751. Get the entry's checksum. This is only valid/updated after writing or reading an entry.
  3752. </summary>
  3753. </member>
  3754. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.IsChecksumValid">
  3755. <summary>
  3756. Get value of true if the header checksum is valid, false otherwise.
  3757. </summary>
  3758. </member>
  3759. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.TypeFlag">
  3760. <summary>
  3761. Get/set the entry's type flag.
  3762. </summary>
  3763. </member>
  3764. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.LinkName">
  3765. <summary>
  3766. The entry's link name.
  3767. </summary>
  3768. <exception cref="T:System.ArgumentNullException">Thrown when attempting to set LinkName to null.</exception>
  3769. </member>
  3770. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.Magic">
  3771. <summary>
  3772. Get/set the entry's magic tag.
  3773. </summary>
  3774. <exception cref="T:System.ArgumentNullException">Thrown when attempting to set Magic to null.</exception>
  3775. </member>
  3776. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.Version">
  3777. <summary>
  3778. The entry's version.
  3779. </summary>
  3780. <exception cref="T:System.ArgumentNullException">Thrown when attempting to set Version to null.</exception>
  3781. </member>
  3782. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.UserName">
  3783. <summary>
  3784. The entry's user name.
  3785. </summary>
  3786. </member>
  3787. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.GroupName">
  3788. <summary>
  3789. Get/set the entry's group name.
  3790. </summary>
  3791. <remarks>
  3792. This is only directly relevant to unix systems.
  3793. </remarks>
  3794. </member>
  3795. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.DevMajor">
  3796. <summary>
  3797. Get/set the entry's major device number.
  3798. </summary>
  3799. </member>
  3800. <member name="P:ICSharpCode.SharpZipLib.Tar.TarHeader.DevMinor">
  3801. <summary>
  3802. Get/set the entry's minor device number.
  3803. </summary>
  3804. </member>
  3805. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.Clone">
  3806. <summary>
  3807. Create a new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarHeader"/> that is a copy of the current instance.
  3808. </summary>
  3809. <returns>A new <see cref="T:System.Object"/> that is a copy of the current instance.</returns>
  3810. </member>
  3811. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.ParseBuffer(System.Byte[],System.Text.Encoding)">
  3812. <summary>
  3813. Parse TarHeader information from a header buffer.
  3814. </summary>
  3815. <param name = "header">
  3816. The tar entry header buffer to get information from.
  3817. </param>
  3818. <param name = "nameEncoding">
  3819. The <see cref="T:System.Text.Encoding"/> used for the Name field, or null for ASCII only
  3820. </param>
  3821. </member>
  3822. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.ParseBuffer(System.Byte[])">
  3823. <summary>
  3824. Parse TarHeader information from a header buffer.
  3825. </summary>
  3826. <param name = "header">
  3827. The tar entry header buffer to get information from.
  3828. </param>
  3829. </member>
  3830. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.WriteHeader(System.Byte[])">
  3831. <summary>
  3832. 'Write' header information to buffer provided, updating the <see cref="P:ICSharpCode.SharpZipLib.Tar.TarHeader.Checksum">check sum</see>.
  3833. </summary>
  3834. <param name="outBuffer">output buffer for header information</param>
  3835. </member>
  3836. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.WriteHeader(System.Byte[],System.Text.Encoding)">
  3837. <summary>
  3838. 'Write' header information to buffer provided, updating the <see cref="P:ICSharpCode.SharpZipLib.Tar.TarHeader.Checksum">check sum</see>.
  3839. </summary>
  3840. <param name="outBuffer">output buffer for header information</param>
  3841. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name field, or null for ASCII only</param>
  3842. </member>
  3843. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetHashCode">
  3844. <summary>
  3845. Get a hash code for the current object.
  3846. </summary>
  3847. <returns>A hash code for the current object.</returns>
  3848. </member>
  3849. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.Equals(System.Object)">
  3850. <summary>
  3851. Determines if this instance is equal to the specified object.
  3852. </summary>
  3853. <param name="obj">The object to compare with.</param>
  3854. <returns>true if the objects are equal, false otherwise.</returns>
  3855. </member>
  3856. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.SetValueDefaults(System.Int32,System.String,System.Int32,System.String)">
  3857. <summary>
  3858. Set defaults for values used when constructing a TarHeader instance.
  3859. </summary>
  3860. <param name="userId">Value to apply as a default for userId.</param>
  3861. <param name="userName">Value to apply as a default for userName.</param>
  3862. <param name="groupId">Value to apply as a default for groupId.</param>
  3863. <param name="groupName">Value to apply as a default for groupName.</param>
  3864. </member>
  3865. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.ParseOctal(System.Byte[],System.Int32,System.Int32)">
  3866. <summary>
  3867. Parse an octal string from a header buffer.
  3868. </summary>
  3869. <param name = "header">The header buffer from which to parse.</param>
  3870. <param name = "offset">The offset into the buffer from which to parse.</param>
  3871. <param name = "length">The number of header bytes to parse.</param>
  3872. <returns>The long equivalent of the octal string.</returns>
  3873. </member>
  3874. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.ParseName(System.Byte[],System.Int32,System.Int32)">
  3875. <summary>
  3876. Parse a name from a header buffer.
  3877. </summary>
  3878. <param name="header">
  3879. The header buffer from which to parse.
  3880. </param>
  3881. <param name="offset">
  3882. The offset into the buffer from which to parse.
  3883. </param>
  3884. <param name="length">
  3885. The number of header bytes to parse.
  3886. </param>
  3887. <returns>
  3888. The name parsed.
  3889. </returns>
  3890. </member>
  3891. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.ParseName(System.ReadOnlySpan{System.Byte},System.Text.Encoding)">
  3892. <summary>
  3893. Parse a name from a header buffer.
  3894. </summary>
  3895. <param name="header">
  3896. The header buffer from which to parse.
  3897. </param>
  3898. <param name="encoding">
  3899. name encoding, or null for ASCII only
  3900. </param>
  3901. <returns>
  3902. The name parsed.
  3903. </returns>
  3904. </member>
  3905. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetNameBytes(System.Text.StringBuilder,System.Int32,System.Byte[],System.Int32,System.Int32)">
  3906. <summary>
  3907. Add <paramref name="name">name</paramref> to the buffer as a collection of bytes
  3908. </summary>
  3909. <param name="name">The name to add</param>
  3910. <param name="nameOffset">The offset of the first character</param>
  3911. <param name="buffer">The buffer to add to</param>
  3912. <param name="bufferOffset">The index of the first byte to add</param>
  3913. <param name="length">The number of characters/bytes to add</param>
  3914. <returns>The next free index in the <paramref name="buffer"/></returns>
  3915. </member>
  3916. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetNameBytes(System.String,System.Int32,System.Byte[],System.Int32,System.Int32)">
  3917. <summary>
  3918. Add <paramref name="name">name</paramref> to the buffer as a collection of bytes
  3919. </summary>
  3920. <param name="name">The name to add</param>
  3921. <param name="nameOffset">The offset of the first character</param>
  3922. <param name="buffer">The buffer to add to</param>
  3923. <param name="bufferOffset">The index of the first byte to add</param>
  3924. <param name="length">The number of characters/bytes to add</param>
  3925. <returns>The next free index in the <paramref name="buffer"/></returns>
  3926. </member>
  3927. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetNameBytes(System.String,System.Int32,System.Byte[],System.Int32,System.Int32,System.Text.Encoding)">
  3928. <summary>
  3929. Add <paramref name="name">name</paramref> to the buffer as a collection of bytes
  3930. </summary>
  3931. <param name="name">The name to add</param>
  3932. <param name="nameOffset">The offset of the first character</param>
  3933. <param name="buffer">The buffer to add to</param>
  3934. <param name="bufferOffset">The index of the first byte to add</param>
  3935. <param name="length">The number of characters/bytes to add</param>
  3936. <param name="encoding">name encoding, or null for ASCII only</param>
  3937. <returns>The next free index in the <paramref name="buffer"/></returns>
  3938. </member>
  3939. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetNameBytes(System.Text.StringBuilder,System.Byte[],System.Int32,System.Int32)">
  3940. <summary>
  3941. Add an entry name to the buffer
  3942. </summary>
  3943. <param name="name">
  3944. The name to add
  3945. </param>
  3946. <param name="buffer">
  3947. The buffer to add to
  3948. </param>
  3949. <param name="offset">
  3950. The offset into the buffer from which to start adding
  3951. </param>
  3952. <param name="length">
  3953. The number of header bytes to add
  3954. </param>
  3955. <returns>
  3956. The index of the next free byte in the buffer
  3957. </returns>
  3958. TODO: what should be default behavior?(omit upper byte or UTF8?)
  3959. </member>
  3960. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetNameBytes(System.Text.StringBuilder,System.Byte[],System.Int32,System.Int32,System.Text.Encoding)">
  3961. <summary>
  3962. Add an entry name to the buffer
  3963. </summary>
  3964. <param name="name">
  3965. The name to add
  3966. </param>
  3967. <param name="buffer">
  3968. The buffer to add to
  3969. </param>
  3970. <param name="offset">
  3971. The offset into the buffer from which to start adding
  3972. </param>
  3973. <param name="length">
  3974. The number of header bytes to add
  3975. </param>
  3976. <param name="encoding">
  3977. </param>
  3978. <returns>
  3979. The index of the next free byte in the buffer
  3980. </returns>
  3981. </member>
  3982. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetNameBytes(System.String,System.Byte[],System.Int32,System.Int32)">
  3983. <summary>
  3984. Add an entry name to the buffer
  3985. </summary>
  3986. <param name="name">The name to add</param>
  3987. <param name="buffer">The buffer to add to</param>
  3988. <param name="offset">The offset into the buffer from which to start adding</param>
  3989. <param name="length">The number of header bytes to add</param>
  3990. <returns>The index of the next free byte in the buffer</returns>
  3991. TODO: what should be default behavior?(omit upper byte or UTF8?)
  3992. </member>
  3993. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetNameBytes(System.String,System.Byte[],System.Int32,System.Int32,System.Text.Encoding)">
  3994. <summary>
  3995. Add an entry name to the buffer
  3996. </summary>
  3997. <param name="name">The name to add</param>
  3998. <param name="buffer">The buffer to add to</param>
  3999. <param name="offset">The offset into the buffer from which to start adding</param>
  4000. <param name="length">The number of header bytes to add</param>
  4001. <param name="encoding"></param>
  4002. <returns>The index of the next free byte in the buffer</returns>
  4003. </member>
  4004. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetAsciiBytes(System.String,System.Int32,System.Byte[],System.Int32,System.Int32)">
  4005. <summary>
  4006. Add a string to a buffer as a collection of ascii bytes.
  4007. </summary>
  4008. <param name="toAdd">The string to add</param>
  4009. <param name="nameOffset">The offset of the first character to add.</param>
  4010. <param name="buffer">The buffer to add to.</param>
  4011. <param name="bufferOffset">The offset to start adding at.</param>
  4012. <param name="length">The number of ascii characters to add.</param>
  4013. <returns>The next free index in the buffer.</returns>
  4014. </member>
  4015. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetAsciiBytes(System.String,System.Int32,System.Byte[],System.Int32,System.Int32,System.Text.Encoding)">
  4016. <summary>
  4017. Add a string to a buffer as a collection of ascii bytes.
  4018. </summary>
  4019. <param name="toAdd">The string to add</param>
  4020. <param name="nameOffset">The offset of the first character to add.</param>
  4021. <param name="buffer">The buffer to add to.</param>
  4022. <param name="bufferOffset">The offset to start adding at.</param>
  4023. <param name="length">The number of ascii characters to add.</param>
  4024. <param name="encoding">String encoding, or null for ASCII only</param>
  4025. <returns>The next free index in the buffer.</returns>
  4026. </member>
  4027. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetOctalBytes(System.Int64,System.Byte[],System.Int32,System.Int32)">
  4028. <summary>
  4029. Put an octal representation of a value into a buffer
  4030. </summary>
  4031. <param name = "value">
  4032. the value to be converted to octal
  4033. </param>
  4034. <param name = "buffer">
  4035. buffer to store the octal string
  4036. </param>
  4037. <param name = "offset">
  4038. The offset into the buffer where the value starts
  4039. </param>
  4040. <param name = "length">
  4041. The length of the octal string to create
  4042. </param>
  4043. <returns>
  4044. The offset of the character next byte after the octal string
  4045. </returns>
  4046. </member>
  4047. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetBinaryOrOctalBytes(System.Int64,System.Byte[],System.Int32,System.Int32)">
  4048. <summary>
  4049. Put an octal or binary representation of a value into a buffer
  4050. </summary>
  4051. <param name = "value">Value to be convert to octal</param>
  4052. <param name = "buffer">The buffer to update</param>
  4053. <param name = "offset">The offset into the buffer to store the value</param>
  4054. <param name = "length">The length of the octal string. Must be 12.</param>
  4055. <returns>Index of next byte</returns>
  4056. </member>
  4057. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.GetCheckSumOctalBytes(System.Int64,System.Byte[],System.Int32,System.Int32)">
  4058. <summary>
  4059. Add the checksum integer to header buffer.
  4060. </summary>
  4061. <param name = "value"></param>
  4062. <param name = "buffer">The header buffer to set the checksum for</param>
  4063. <param name = "offset">The offset into the buffer for the checksum</param>
  4064. <param name = "length">The number of header bytes to update.
  4065. It's formatted differently from the other fields: it has 6 digits, a
  4066. null, then a space -- rather than digits, a space, then a null.
  4067. The final space is already there, from checksumming
  4068. </param>
  4069. <returns>The modified buffer offset</returns>
  4070. </member>
  4071. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.ComputeCheckSum(System.Byte[])">
  4072. <summary>
  4073. Compute the checksum for a tar entry header.
  4074. The checksum field must be all spaces prior to this happening
  4075. </summary>
  4076. <param name = "buffer">The tar entry's header buffer.</param>
  4077. <returns>The computed checksum.</returns>
  4078. </member>
  4079. <member name="M:ICSharpCode.SharpZipLib.Tar.TarHeader.MakeCheckSum(System.Byte[])">
  4080. <summary>
  4081. Make a checksum for a tar entry ignoring the checksum contents.
  4082. </summary>
  4083. <param name = "buffer">The tar entry's header buffer.</param>
  4084. <returns>The checksum for the buffer</returns>
  4085. </member>
  4086. <member name="T:ICSharpCode.SharpZipLib.Tar.TarInputStream">
  4087. <summary>
  4088. The TarInputStream reads a UNIX tar archive as an InputStream.
  4089. methods are provided to position at each successive entry in
  4090. the archive, and the read each entry as a normal input stream
  4091. using read().
  4092. </summary>
  4093. </member>
  4094. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.#ctor(System.IO.Stream)">
  4095. <summary>
  4096. Construct a TarInputStream with default block factor
  4097. </summary>
  4098. <param name="inputStream">stream to source data from</param>
  4099. </member>
  4100. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.#ctor(System.IO.Stream,System.Text.Encoding)">
  4101. <summary>
  4102. Construct a TarInputStream with default block factor
  4103. </summary>
  4104. <param name="inputStream">stream to source data from</param>
  4105. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  4106. </member>
  4107. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.#ctor(System.IO.Stream,System.Int32)">
  4108. <summary>
  4109. Construct a TarInputStream with user specified block factor
  4110. </summary>
  4111. <param name="inputStream">stream to source data from</param>
  4112. <param name="blockFactor">block factor to apply to archive</param>
  4113. </member>
  4114. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.#ctor(System.IO.Stream,System.Int32,System.Text.Encoding)">
  4115. <summary>
  4116. Construct a TarInputStream with user specified block factor
  4117. </summary>
  4118. <param name="inputStream">stream to source data from</param>
  4119. <param name="blockFactor">block factor to apply to archive</param>
  4120. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  4121. </member>
  4122. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.IsStreamOwner">
  4123. <summary>
  4124. Gets or sets a flag indicating ownership of underlying stream.
  4125. When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
  4126. </summary>
  4127. <remarks>The default value is true.</remarks>
  4128. </member>
  4129. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.CanRead">
  4130. <summary>
  4131. Gets a value indicating whether the current stream supports reading
  4132. </summary>
  4133. </member>
  4134. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.CanSeek">
  4135. <summary>
  4136. Gets a value indicating whether the current stream supports seeking
  4137. This property always returns false.
  4138. </summary>
  4139. </member>
  4140. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.CanWrite">
  4141. <summary>
  4142. Gets a value indicating if the stream supports writing.
  4143. This property always returns false.
  4144. </summary>
  4145. </member>
  4146. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.Length">
  4147. <summary>
  4148. The length in bytes of the stream
  4149. </summary>
  4150. </member>
  4151. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.Position">
  4152. <summary>
  4153. Gets or sets the position within the stream.
  4154. Setting the Position is not supported and throws a NotSupportedExceptionNotSupportedException
  4155. </summary>
  4156. <exception cref="T:System.NotSupportedException">Any attempt to set position</exception>
  4157. </member>
  4158. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.Flush">
  4159. <summary>
  4160. Flushes the baseInputStream
  4161. </summary>
  4162. </member>
  4163. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.FlushAsync(System.Threading.CancellationToken)">
  4164. <summary>
  4165. Flushes the baseInputStream
  4166. </summary>
  4167. <param name="cancellationToken"></param>
  4168. </member>
  4169. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  4170. <summary>
  4171. Set the streams position. This operation is not supported and will throw a NotSupportedException
  4172. </summary>
  4173. <param name="offset">The offset relative to the origin to seek to.</param>
  4174. <param name="origin">The <see cref="T:System.IO.SeekOrigin"/> to start seeking from.</param>
  4175. <returns>The new position in the stream.</returns>
  4176. <exception cref="T:System.NotSupportedException">Any access</exception>
  4177. </member>
  4178. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.SetLength(System.Int64)">
  4179. <summary>
  4180. Sets the length of the stream
  4181. This operation is not supported and will throw a NotSupportedException
  4182. </summary>
  4183. <param name="value">The new stream length.</param>
  4184. <exception cref="T:System.NotSupportedException">Any access</exception>
  4185. </member>
  4186. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.Write(System.Byte[],System.Int32,System.Int32)">
  4187. <summary>
  4188. Writes a block of bytes to this stream using data from a buffer.
  4189. This operation is not supported and will throw a NotSupportedException
  4190. </summary>
  4191. <param name="buffer">The buffer containing bytes to write.</param>
  4192. <param name="offset">The offset in the buffer of the frist byte to write.</param>
  4193. <param name="count">The number of bytes to write.</param>
  4194. <exception cref="T:System.NotSupportedException">Any access</exception>
  4195. </member>
  4196. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.WriteByte(System.Byte)">
  4197. <summary>
  4198. Writes a byte to the current position in the file stream.
  4199. This operation is not supported and will throw a NotSupportedException
  4200. </summary>
  4201. <param name="value">The byte value to write.</param>
  4202. <exception cref="T:System.NotSupportedException">Any access</exception>
  4203. </member>
  4204. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.ReadByte">
  4205. <summary>
  4206. Reads a byte from the current tar archive entry.
  4207. </summary>
  4208. <returns>A byte cast to an int; -1 if the at the end of the stream.</returns>
  4209. </member>
  4210. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  4211. <summary>
  4212. Reads bytes from the current tar archive entry.
  4213. This method is aware of the boundaries of the current
  4214. entry in the archive and will deal with them appropriately
  4215. </summary>
  4216. <param name="buffer">
  4217. The buffer into which to place bytes read.
  4218. </param>
  4219. <param name="offset">
  4220. The offset at which to place bytes read.
  4221. </param>
  4222. <param name="count">
  4223. The number of bytes to read.
  4224. </param>
  4225. <param name="cancellationToken"></param>
  4226. <returns>
  4227. The number of bytes read, or 0 at end of stream/EOF.
  4228. </returns>
  4229. </member>
  4230. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.ReadAsync(System.Memory{System.Byte},System.Threading.CancellationToken)">
  4231. <summary>
  4232. Reads bytes from the current tar archive entry.
  4233. This method is aware of the boundaries of the current
  4234. entry in the archive and will deal with them appropriately
  4235. </summary>
  4236. <param name="buffer">
  4237. The buffer into which to place bytes read.
  4238. </param>
  4239. <param name="cancellationToken"></param>
  4240. <returns>
  4241. The number of bytes read, or 0 at end of stream/EOF.
  4242. </returns>
  4243. </member>
  4244. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  4245. <summary>
  4246. Reads bytes from the current tar archive entry.
  4247. This method is aware of the boundaries of the current
  4248. entry in the archive and will deal with them appropriately
  4249. </summary>
  4250. <param name="buffer">
  4251. The buffer into which to place bytes read.
  4252. </param>
  4253. <param name="offset">
  4254. The offset at which to place bytes read.
  4255. </param>
  4256. <param name="count">
  4257. The number of bytes to read.
  4258. </param>
  4259. <returns>
  4260. The number of bytes read, or 0 at end of stream/EOF.
  4261. </returns>
  4262. </member>
  4263. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.Dispose(System.Boolean)">
  4264. <summary>
  4265. Closes this stream. Calls the TarBuffer's close() method.
  4266. The underlying stream is closed by the TarBuffer.
  4267. </summary>
  4268. </member>
  4269. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.DisposeAsync">
  4270. <summary>
  4271. Closes this stream. Calls the TarBuffer's close() method.
  4272. The underlying stream is closed by the TarBuffer.
  4273. </summary>
  4274. </member>
  4275. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.SetEntryFactory(ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory)">
  4276. <summary>
  4277. Set the entry factory for this instance.
  4278. </summary>
  4279. <param name="factory">The factory for creating new entries</param>
  4280. </member>
  4281. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.RecordSize">
  4282. <summary>
  4283. Get the record size being used by this stream's TarBuffer.
  4284. </summary>
  4285. </member>
  4286. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.GetRecordSize">
  4287. <summary>
  4288. Get the record size being used by this stream's TarBuffer.
  4289. </summary>
  4290. <returns>
  4291. TarBuffer record size.
  4292. </returns>
  4293. </member>
  4294. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.Available">
  4295. <summary>
  4296. Get the available data that can be read from the current
  4297. entry in the archive. This does not indicate how much data
  4298. is left in the entire archive, only in the current entry.
  4299. This value is determined from the entry's size header field
  4300. and the amount of data already read from the current entry.
  4301. </summary>
  4302. <returns>
  4303. The number of available bytes for the current entry.
  4304. </returns>
  4305. </member>
  4306. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.SkipAsync(System.Int64,System.Threading.CancellationToken)">
  4307. <summary>
  4308. Skip bytes in the input buffer. This skips bytes in the
  4309. current entry's data, not the entire archive, and will
  4310. stop at the end of the current entry's data if the number
  4311. to skip extends beyond that point.
  4312. </summary>
  4313. <param name="skipCount">
  4314. The number of bytes to skip.
  4315. </param>
  4316. <param name="ct"></param>
  4317. </member>
  4318. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.Skip(System.Int64)">
  4319. <summary>
  4320. Skip bytes in the input buffer. This skips bytes in the
  4321. current entry's data, not the entire archive, and will
  4322. stop at the end of the current entry's data if the number
  4323. to skip extends beyond that point.
  4324. </summary>
  4325. <param name="skipCount">
  4326. The number of bytes to skip.
  4327. </param>
  4328. </member>
  4329. <member name="P:ICSharpCode.SharpZipLib.Tar.TarInputStream.IsMarkSupported">
  4330. <summary>
  4331. Return a value of true if marking is supported; false otherwise.
  4332. </summary>
  4333. <remarks>Currently marking is not supported, the return value is always false.</remarks>
  4334. </member>
  4335. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.Mark(System.Int32)">
  4336. <summary>
  4337. Since we do not support marking just yet, we do nothing.
  4338. </summary>
  4339. <param name ="markLimit">
  4340. The limit to mark.
  4341. </param>
  4342. </member>
  4343. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.Reset">
  4344. <summary>
  4345. Since we do not support marking just yet, we do nothing.
  4346. </summary>
  4347. </member>
  4348. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.GetNextEntryAsync(System.Threading.CancellationToken)">
  4349. <summary>
  4350. Get the next entry in this tar archive. This will skip
  4351. over any remaining data in the current entry, if there
  4352. is one, and place the input stream at the header of the
  4353. next entry, and read the header and instantiate a new
  4354. TarEntry from the header bytes and return that entry.
  4355. If there are no more entries in the archive, null will
  4356. be returned to indicate that the end of the archive has
  4357. been reached.
  4358. </summary>
  4359. <returns>
  4360. The next TarEntry in the archive, or null.
  4361. </returns>
  4362. </member>
  4363. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.GetNextEntry">
  4364. <summary>
  4365. Get the next entry in this tar archive. This will skip
  4366. over any remaining data in the current entry, if there
  4367. is one, and place the input stream at the header of the
  4368. next entry, and read the header and instantiate a new
  4369. TarEntry from the header bytes and return that entry.
  4370. If there are no more entries in the archive, null will
  4371. be returned to indicate that the end of the archive has
  4372. been reached.
  4373. </summary>
  4374. <returns>
  4375. The next TarEntry in the archive, or null.
  4376. </returns>
  4377. </member>
  4378. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.CopyEntryContentsAsync(System.IO.Stream,System.Threading.CancellationToken)">
  4379. <summary>
  4380. Copies the contents of the current tar archive entry directly into
  4381. an output stream.
  4382. </summary>
  4383. <param name="outputStream">
  4384. The OutputStream into which to write the entry's data.
  4385. </param>
  4386. <param name="ct"></param>
  4387. </member>
  4388. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.CopyEntryContents(System.IO.Stream)">
  4389. <summary>
  4390. Copies the contents of the current tar archive entry directly into
  4391. an output stream.
  4392. </summary>
  4393. <param name="outputStream">
  4394. The OutputStream into which to write the entry's data.
  4395. </param>
  4396. </member>
  4397. <member name="T:ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory">
  4398. <summary>
  4399. This interface is provided, along with the method <see cref="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.SetEntryFactory(ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory)"/>, to allow
  4400. the programmer to have their own <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry"/> subclass instantiated for the
  4401. entries return from <see cref="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.GetNextEntry"/>.
  4402. </summary>
  4403. </member>
  4404. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory.CreateEntry(System.String)">
  4405. <summary>
  4406. Create an entry based on name alone
  4407. </summary>
  4408. <param name="name">
  4409. Name of the new EntryPointNotFoundException to create
  4410. </param>
  4411. <returns>created TarEntry or descendant class</returns>
  4412. </member>
  4413. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory.CreateEntryFromFile(System.String)">
  4414. <summary>
  4415. Create an instance based on an actual file
  4416. </summary>
  4417. <param name="fileName">
  4418. Name of file to represent in the entry
  4419. </param>
  4420. <returns>
  4421. Created TarEntry or descendant class
  4422. </returns>
  4423. </member>
  4424. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.IEntryFactory.CreateEntry(System.Byte[])">
  4425. <summary>
  4426. Create a tar entry based on the header information passed
  4427. </summary>
  4428. <param name="headerBuffer">
  4429. Buffer containing header information to create an entry from.
  4430. </param>
  4431. <returns>
  4432. Created TarEntry or descendant class
  4433. </returns>
  4434. </member>
  4435. <member name="T:ICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter">
  4436. <summary>
  4437. Standard entry factory class creating instances of the class TarEntry
  4438. </summary>
  4439. </member>
  4440. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter.#ctor">
  4441. <summary>
  4442. Construct standard entry factory class with ASCII name encoding
  4443. </summary>
  4444. </member>
  4445. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter.#ctor(System.Text.Encoding)">
  4446. <summary>
  4447. Construct standard entry factory with name encoding
  4448. </summary>
  4449. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  4450. </member>
  4451. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter.CreateEntry(System.String)">
  4452. <summary>
  4453. Create a <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry"/> based on named
  4454. </summary>
  4455. <param name="name">The name to use for the entry</param>
  4456. <returns>A new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry"/></returns>
  4457. </member>
  4458. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter.CreateEntryFromFile(System.String)">
  4459. <summary>
  4460. Create a tar entry with details obtained from <paramref name="fileName">file</paramref>
  4461. </summary>
  4462. <param name="fileName">The name of the file to retrieve details from.</param>
  4463. <returns>A new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry"/></returns>
  4464. </member>
  4465. <member name="M:ICSharpCode.SharpZipLib.Tar.TarInputStream.EntryFactoryAdapter.CreateEntry(System.Byte[])">
  4466. <summary>
  4467. Create an entry based on details in <paramref name="headerBuffer">header</paramref>
  4468. </summary>
  4469. <param name="headerBuffer">The buffer containing entry details.</param>
  4470. <returns>A new <see cref="T:ICSharpCode.SharpZipLib.Tar.TarEntry"/></returns>
  4471. </member>
  4472. <member name="F:ICSharpCode.SharpZipLib.Tar.TarInputStream.hasHitEOF">
  4473. <summary>
  4474. Flag set when last block has been read
  4475. </summary>
  4476. </member>
  4477. <member name="F:ICSharpCode.SharpZipLib.Tar.TarInputStream.entrySize">
  4478. <summary>
  4479. Size of this entry as recorded in header
  4480. </summary>
  4481. </member>
  4482. <member name="F:ICSharpCode.SharpZipLib.Tar.TarInputStream.entryOffset">
  4483. <summary>
  4484. Number of bytes read for this entry so far
  4485. </summary>
  4486. </member>
  4487. <member name="F:ICSharpCode.SharpZipLib.Tar.TarInputStream.readBuffer">
  4488. <summary>
  4489. Buffer used with calls to <code>Read()</code>
  4490. </summary>
  4491. </member>
  4492. <member name="F:ICSharpCode.SharpZipLib.Tar.TarInputStream.tarBuffer">
  4493. <summary>
  4494. Working buffer
  4495. </summary>
  4496. </member>
  4497. <member name="F:ICSharpCode.SharpZipLib.Tar.TarInputStream.currentEntry">
  4498. <summary>
  4499. Current entry being read
  4500. </summary>
  4501. </member>
  4502. <member name="F:ICSharpCode.SharpZipLib.Tar.TarInputStream.entryFactory">
  4503. <summary>
  4504. Factory used to create TarEntry or descendant class instance
  4505. </summary>
  4506. </member>
  4507. <member name="F:ICSharpCode.SharpZipLib.Tar.TarInputStream.inputStream">
  4508. <summary>
  4509. Stream used as the source of input data.
  4510. </summary>
  4511. </member>
  4512. <member name="T:ICSharpCode.SharpZipLib.Tar.TarOutputStream">
  4513. <summary>
  4514. The TarOutputStream writes a UNIX tar archive as an OutputStream.
  4515. Methods are provided to put entries, and then write their contents
  4516. by writing to this stream using write().
  4517. </summary>
  4518. public
  4519. </member>
  4520. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.#ctor(System.IO.Stream)">
  4521. <summary>
  4522. Construct TarOutputStream using default block factor
  4523. </summary>
  4524. <param name="outputStream">stream to write to</param>
  4525. </member>
  4526. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.#ctor(System.IO.Stream,System.Text.Encoding)">
  4527. <summary>
  4528. Construct TarOutputStream using default block factor
  4529. </summary>
  4530. <param name="outputStream">stream to write to</param>
  4531. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  4532. </member>
  4533. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.#ctor(System.IO.Stream,System.Int32)">
  4534. <summary>
  4535. Construct TarOutputStream with user specified block factor
  4536. </summary>
  4537. <param name="outputStream">stream to write to</param>
  4538. <param name="blockFactor">blocking factor</param>
  4539. </member>
  4540. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.#ctor(System.IO.Stream,System.Int32,System.Text.Encoding)">
  4541. <summary>
  4542. Construct TarOutputStream with user specified block factor
  4543. </summary>
  4544. <param name="outputStream">stream to write to</param>
  4545. <param name="blockFactor">blocking factor</param>
  4546. <param name="nameEncoding">The <see cref="T:System.Text.Encoding"/> used for the Name fields, or null for ASCII only</param>
  4547. </member>
  4548. <member name="P:ICSharpCode.SharpZipLib.Tar.TarOutputStream.IsStreamOwner">
  4549. <summary>
  4550. Gets or sets a flag indicating ownership of underlying stream.
  4551. When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
  4552. </summary>
  4553. <remarks>The default value is true.</remarks>
  4554. </member>
  4555. <member name="P:ICSharpCode.SharpZipLib.Tar.TarOutputStream.CanRead">
  4556. <summary>
  4557. true if the stream supports reading; otherwise, false.
  4558. </summary>
  4559. </member>
  4560. <member name="P:ICSharpCode.SharpZipLib.Tar.TarOutputStream.CanSeek">
  4561. <summary>
  4562. true if the stream supports seeking; otherwise, false.
  4563. </summary>
  4564. </member>
  4565. <member name="P:ICSharpCode.SharpZipLib.Tar.TarOutputStream.CanWrite">
  4566. <summary>
  4567. true if stream supports writing; otherwise, false.
  4568. </summary>
  4569. </member>
  4570. <member name="P:ICSharpCode.SharpZipLib.Tar.TarOutputStream.Length">
  4571. <summary>
  4572. length of stream in bytes
  4573. </summary>
  4574. </member>
  4575. <member name="P:ICSharpCode.SharpZipLib.Tar.TarOutputStream.Position">
  4576. <summary>
  4577. gets or sets the position within the current stream.
  4578. </summary>
  4579. </member>
  4580. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  4581. <summary>
  4582. set the position within the current stream
  4583. </summary>
  4584. <param name="offset">The offset relative to the <paramref name="origin"/> to seek to</param>
  4585. <param name="origin">The <see cref="T:System.IO.SeekOrigin"/> to seek from.</param>
  4586. <returns>The new position in the stream.</returns>
  4587. </member>
  4588. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.SetLength(System.Int64)">
  4589. <summary>
  4590. Set the length of the current stream
  4591. </summary>
  4592. <param name="value">The new stream length.</param>
  4593. </member>
  4594. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.ReadByte">
  4595. <summary>
  4596. Read a byte from the stream and advance the position within the stream
  4597. by one byte or returns -1 if at the end of the stream.
  4598. </summary>
  4599. <returns>The byte value or -1 if at end of stream</returns>
  4600. </member>
  4601. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.Read(System.Byte[],System.Int32,System.Int32)">
  4602. <summary>
  4603. read bytes from the current stream and advance the position within the
  4604. stream by the number of bytes read.
  4605. </summary>
  4606. <param name="buffer">The buffer to store read bytes in.</param>
  4607. <param name="offset">The index into the buffer to being storing bytes at.</param>
  4608. <param name="count">The desired number of bytes to read.</param>
  4609. <returns>The total number of bytes read, or zero if at the end of the stream.
  4610. The number of bytes may be less than the <paramref name="count">count</paramref>
  4611. requested if data is not available.</returns>
  4612. </member>
  4613. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.ReadAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  4614. <summary>
  4615. read bytes from the current stream and advance the position within the
  4616. stream by the number of bytes read.
  4617. </summary>
  4618. <param name="buffer">The buffer to store read bytes in.</param>
  4619. <param name="offset">The index into the buffer to being storing bytes at.</param>
  4620. <param name="count">The desired number of bytes to read.</param>
  4621. <param name="cancellationToken"></param>
  4622. <returns>The total number of bytes read, or zero if at the end of the stream.
  4623. The number of bytes may be less than the <paramref name="count">count</paramref>
  4624. requested if data is not available.</returns>
  4625. </member>
  4626. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.Flush">
  4627. <summary>
  4628. All buffered data is written to destination
  4629. </summary>
  4630. </member>
  4631. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.FlushAsync(System.Threading.CancellationToken)">
  4632. <summary>
  4633. All buffered data is written to destination
  4634. </summary>
  4635. </member>
  4636. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.Finish">
  4637. <summary>
  4638. Ends the TAR archive without closing the underlying OutputStream.
  4639. The result is that the EOF block of nulls is written.
  4640. </summary>
  4641. </member>
  4642. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.FinishAsync(System.Threading.CancellationToken)">
  4643. <summary>
  4644. Ends the TAR archive without closing the underlying OutputStream.
  4645. The result is that the EOF block of nulls is written.
  4646. </summary>
  4647. </member>
  4648. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.Dispose(System.Boolean)">
  4649. <summary>
  4650. Ends the TAR archive and closes the underlying OutputStream.
  4651. </summary>
  4652. <remarks>This means that Finish() is called followed by calling the
  4653. TarBuffer's Close().</remarks>
  4654. </member>
  4655. <member name="P:ICSharpCode.SharpZipLib.Tar.TarOutputStream.RecordSize">
  4656. <summary>
  4657. Get the record size being used by this stream's TarBuffer.
  4658. </summary>
  4659. </member>
  4660. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.GetRecordSize">
  4661. <summary>
  4662. Get the record size being used by this stream's TarBuffer.
  4663. </summary>
  4664. <returns>
  4665. The TarBuffer record size.
  4666. </returns>
  4667. </member>
  4668. <member name="P:ICSharpCode.SharpZipLib.Tar.TarOutputStream.IsEntryOpen">
  4669. <summary>
  4670. Get a value indicating whether an entry is open, requiring more data to be written.
  4671. </summary>
  4672. </member>
  4673. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.PutNextEntryAsync(ICSharpCode.SharpZipLib.Tar.TarEntry,System.Threading.CancellationToken)">
  4674. <summary>
  4675. Put an entry on the output stream. This writes the entry's
  4676. header and positions the output stream for writing
  4677. the contents of the entry. Once this method is called, the
  4678. stream is ready for calls to write() to write the entry's
  4679. contents. Once the contents are written, closeEntry()
  4680. <B>MUST</B> be called to ensure that all buffered data
  4681. is completely written to the output stream.
  4682. </summary>
  4683. <param name="entry">
  4684. The TarEntry to be written to the archive.
  4685. </param>
  4686. <param name="cancellationToken"></param>
  4687. </member>
  4688. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.PutNextEntry(ICSharpCode.SharpZipLib.Tar.TarEntry)">
  4689. <summary>
  4690. Put an entry on the output stream. This writes the entry's
  4691. header and positions the output stream for writing
  4692. the contents of the entry. Once this method is called, the
  4693. stream is ready for calls to write() to write the entry's
  4694. contents. Once the contents are written, closeEntry()
  4695. <B>MUST</B> be called to ensure that all buffered data
  4696. is completely written to the output stream.
  4697. </summary>
  4698. <param name="entry">
  4699. The TarEntry to be written to the archive.
  4700. </param>
  4701. </member>
  4702. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.CloseEntryAsync(System.Threading.CancellationToken)">
  4703. <summary>
  4704. Close an entry. This method MUST be called for all file
  4705. entries that contain data. The reason is that we must
  4706. buffer data written to the stream in order to satisfy
  4707. the buffer's block based writes. Thus, there may be
  4708. data fragments still being assembled that must be written
  4709. to the output stream before this entry is closed and the
  4710. next entry written.
  4711. </summary>
  4712. </member>
  4713. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.CloseEntry">
  4714. <summary>
  4715. Close an entry. This method MUST be called for all file
  4716. entries that contain data. The reason is that we must
  4717. buffer data written to the stream in order to satisfy
  4718. the buffer's block based writes. Thus, there may be
  4719. data fragments still being assembled that must be written
  4720. to the output stream before this entry is closed and the
  4721. next entry written.
  4722. </summary>
  4723. </member>
  4724. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.WriteByte(System.Byte)">
  4725. <summary>
  4726. Writes a byte to the current tar archive entry.
  4727. This method simply calls Write(byte[], int, int).
  4728. </summary>
  4729. <param name="value">
  4730. The byte to be written.
  4731. </param>
  4732. </member>
  4733. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  4734. <summary>
  4735. Writes bytes to the current tar archive entry. This method
  4736. is aware of the current entry and will throw an exception if
  4737. you attempt to write bytes past the length specified for the
  4738. current entry. The method is also (painfully) aware of the
  4739. record buffering required by TarBuffer, and manages buffers
  4740. that are not a multiple of recordsize in length, including
  4741. assembling records from small buffers.
  4742. </summary>
  4743. <param name = "buffer">
  4744. The buffer to write to the archive.
  4745. </param>
  4746. <param name = "offset">
  4747. The offset in the buffer from which to get bytes.
  4748. </param>
  4749. <param name = "count">
  4750. The number of bytes to write.
  4751. </param>
  4752. </member>
  4753. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  4754. <summary>
  4755. Writes bytes to the current tar archive entry. This method
  4756. is aware of the current entry and will throw an exception if
  4757. you attempt to write bytes past the length specified for the
  4758. current entry. The method is also (painfully) aware of the
  4759. record buffering required by TarBuffer, and manages buffers
  4760. that are not a multiple of recordsize in length, including
  4761. assembling records from small buffers.
  4762. </summary>
  4763. <param name = "buffer">
  4764. The buffer to write to the archive.
  4765. </param>
  4766. <param name = "offset">
  4767. The offset in the buffer from which to get bytes.
  4768. </param>
  4769. <param name = "count">
  4770. The number of bytes to write.
  4771. </param>
  4772. <param name="cancellationToken"></param>
  4773. </member>
  4774. <member name="M:ICSharpCode.SharpZipLib.Tar.TarOutputStream.WriteEofBlockAsync(System.Threading.CancellationToken,System.Boolean)">
  4775. <summary>
  4776. Write an EOF (end of archive) block to the tar archive.
  4777. The end of the archive is indicated by two blocks consisting entirely of zero bytes.
  4778. </summary>
  4779. </member>
  4780. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.currBytes">
  4781. <summary>
  4782. bytes written for this entry so far
  4783. </summary>
  4784. </member>
  4785. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.assemblyBufferLength">
  4786. <summary>
  4787. current 'Assembly' buffer length
  4788. </summary>
  4789. </member>
  4790. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.isClosed">
  4791. <summary>
  4792. Flag indicating whether this instance has been closed or not.
  4793. </summary>
  4794. </member>
  4795. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.currSize">
  4796. <summary>
  4797. Size for the current entry
  4798. </summary>
  4799. </member>
  4800. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.blockBuffer">
  4801. <summary>
  4802. single block working buffer
  4803. </summary>
  4804. </member>
  4805. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.assemblyBuffer">
  4806. <summary>
  4807. 'Assembly' buffer used to assemble data before writing
  4808. </summary>
  4809. </member>
  4810. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.buffer">
  4811. <summary>
  4812. TarBuffer used to provide correct blocking factor
  4813. </summary>
  4814. </member>
  4815. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.outputStream">
  4816. <summary>
  4817. the destination stream for the archive contents
  4818. </summary>
  4819. </member>
  4820. <member name="F:ICSharpCode.SharpZipLib.Tar.TarOutputStream.nameEncoding">
  4821. <summary>
  4822. name encoding
  4823. </summary>
  4824. </member>
  4825. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater">
  4826. <summary>
  4827. This is the Deflater class. The deflater class compresses input
  4828. with the deflate algorithm described in RFC 1951. It has several
  4829. compression levels and three different strategies described below.
  4830. This class is <i>not</i> thread safe. This is inherent in the API, due
  4831. to the split of deflate and setInput.
  4832. author of the original java version : Jochen Hoenicke
  4833. </summary>
  4834. </member>
  4835. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.BEST_COMPRESSION">
  4836. <summary>
  4837. The best and slowest compression level. This tries to find very
  4838. long and distant string repetitions.
  4839. </summary>
  4840. </member>
  4841. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.BEST_SPEED">
  4842. <summary>
  4843. The worst but fastest compression level.
  4844. </summary>
  4845. </member>
  4846. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.DEFAULT_COMPRESSION">
  4847. <summary>
  4848. The default compression level.
  4849. </summary>
  4850. </member>
  4851. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.NO_COMPRESSION">
  4852. <summary>
  4853. This level won't compress at all but output uncompressed blocks.
  4854. </summary>
  4855. </member>
  4856. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.DEFLATED">
  4857. <summary>
  4858. The compression method. This is the only method supported so far.
  4859. There is no need to use this constant at all.
  4860. </summary>
  4861. </member>
  4862. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel">
  4863. <summary>
  4864. Compression Level as an enum for safer use
  4865. </summary>
  4866. </member>
  4867. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.BEST_COMPRESSION">
  4868. <summary>
  4869. The best and slowest compression level. This tries to find very
  4870. long and distant string repetitions.
  4871. </summary>
  4872. </member>
  4873. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.BEST_SPEED">
  4874. <summary>
  4875. The worst but fastest compression level.
  4876. </summary>
  4877. </member>
  4878. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.DEFAULT_COMPRESSION">
  4879. <summary>
  4880. The default compression level.
  4881. </summary>
  4882. </member>
  4883. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.NO_COMPRESSION">
  4884. <summary>
  4885. This level won't compress at all but output uncompressed blocks.
  4886. </summary>
  4887. </member>
  4888. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.CompressionLevel.DEFLATED">
  4889. <summary>
  4890. The compression method. This is the only method supported so far.
  4891. There is no need to use this constant at all.
  4892. </summary>
  4893. </member>
  4894. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.#ctor">
  4895. <summary>
  4896. Creates a new deflater with default compression level.
  4897. </summary>
  4898. </member>
  4899. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.#ctor(System.Int32)">
  4900. <summary>
  4901. Creates a new deflater with given compression level.
  4902. </summary>
  4903. <param name="level">
  4904. the compression level, a value between NO_COMPRESSION
  4905. and BEST_COMPRESSION, or DEFAULT_COMPRESSION.
  4906. </param>
  4907. <exception cref="T:System.ArgumentOutOfRangeException">if lvl is out of range.</exception>
  4908. </member>
  4909. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.#ctor(System.Int32,System.Boolean)">
  4910. <summary>
  4911. Creates a new deflater with given compression level.
  4912. </summary>
  4913. <param name="level">
  4914. the compression level, a value between NO_COMPRESSION
  4915. and BEST_COMPRESSION.
  4916. </param>
  4917. <param name="noZlibHeaderOrFooter">
  4918. true, if we should suppress the Zlib/RFC1950 header at the
  4919. beginning and the adler checksum at the end of the output. This is
  4920. useful for the GZIP/PKZIP formats.
  4921. </param>
  4922. <exception cref="T:System.ArgumentOutOfRangeException">if lvl is out of range.</exception>
  4923. </member>
  4924. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Reset">
  4925. <summary>
  4926. Resets the deflater. The deflater acts afterwards as if it was
  4927. just created with the same compression level and strategy as it
  4928. had before.
  4929. </summary>
  4930. </member>
  4931. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Adler">
  4932. <summary>
  4933. Gets the current adler checksum of the data that was processed so far.
  4934. </summary>
  4935. </member>
  4936. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.TotalIn">
  4937. <summary>
  4938. Gets the number of input bytes processed so far.
  4939. </summary>
  4940. </member>
  4941. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.TotalOut">
  4942. <summary>
  4943. Gets the number of output bytes so far.
  4944. </summary>
  4945. </member>
  4946. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Flush">
  4947. <summary>
  4948. Flushes the current input block. Further calls to deflate() will
  4949. produce enough output to inflate everything in the current input
  4950. block. This is not part of Sun's JDK so I have made it package
  4951. private. It is used by DeflaterOutputStream to implement
  4952. flush().
  4953. </summary>
  4954. </member>
  4955. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Finish">
  4956. <summary>
  4957. Finishes the deflater with the current input block. It is an error
  4958. to give more input after this method was called. This method must
  4959. be called to force all bytes to be flushed.
  4960. </summary>
  4961. </member>
  4962. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.IsFinished">
  4963. <summary>
  4964. Returns true if the stream was finished and no more output bytes
  4965. are available.
  4966. </summary>
  4967. </member>
  4968. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.IsNeedingInput">
  4969. <summary>
  4970. Returns true, if the input buffer is empty.
  4971. You should then call setInput().
  4972. NOTE: This method can also return true when the stream
  4973. was finished.
  4974. </summary>
  4975. </member>
  4976. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetInput(System.Byte[])">
  4977. <summary>
  4978. Sets the data which should be compressed next. This should be only
  4979. called when needsInput indicates that more input is needed.
  4980. If you call setInput when needsInput() returns false, the
  4981. previous input that is still pending will be thrown away.
  4982. The given byte array should not be changed, before needsInput() returns
  4983. true again.
  4984. This call is equivalent to <code>setInput(input, 0, input.length)</code>.
  4985. </summary>
  4986. <param name="input">
  4987. the buffer containing the input data.
  4988. </param>
  4989. <exception cref="T:System.InvalidOperationException">
  4990. if the buffer was finished() or ended().
  4991. </exception>
  4992. </member>
  4993. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetInput(System.Byte[],System.Int32,System.Int32)">
  4994. <summary>
  4995. Sets the data which should be compressed next. This should be
  4996. only called when needsInput indicates that more input is needed.
  4997. The given byte array should not be changed, before needsInput() returns
  4998. true again.
  4999. </summary>
  5000. <param name="input">
  5001. the buffer containing the input data.
  5002. </param>
  5003. <param name="offset">
  5004. the start of the data.
  5005. </param>
  5006. <param name="count">
  5007. the number of data bytes of input.
  5008. </param>
  5009. <exception cref="T:System.InvalidOperationException">
  5010. if the buffer was Finish()ed or if previous input is still pending.
  5011. </exception>
  5012. </member>
  5013. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetLevel(System.Int32)">
  5014. <summary>
  5015. Sets the compression level. There is no guarantee of the exact
  5016. position of the change, but if you call this when needsInput is
  5017. true the change of compression level will occur somewhere near
  5018. before the end of the so far given input.
  5019. </summary>
  5020. <param name="level">
  5021. the new compression level.
  5022. </param>
  5023. </member>
  5024. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.GetLevel">
  5025. <summary>
  5026. Get current compression level
  5027. </summary>
  5028. <returns>Returns the current compression level</returns>
  5029. </member>
  5030. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetStrategy(ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy)">
  5031. <summary>
  5032. Sets the compression strategy. Strategy is one of
  5033. DEFAULT_STRATEGY, HUFFMAN_ONLY and FILTERED. For the exact
  5034. position where the strategy is changed, the same as for
  5035. SetLevel() applies.
  5036. </summary>
  5037. <param name="strategy">
  5038. The new compression strategy.
  5039. </param>
  5040. </member>
  5041. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Deflate(System.Byte[])">
  5042. <summary>
  5043. Deflates the current input block with to the given array.
  5044. </summary>
  5045. <param name="output">
  5046. The buffer where compressed data is stored
  5047. </param>
  5048. <returns>
  5049. The number of compressed bytes added to the output, or 0 if either
  5050. IsNeedingInput() or IsFinished returns true or length is zero.
  5051. </returns>
  5052. </member>
  5053. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.Deflate(System.Byte[],System.Int32,System.Int32)">
  5054. <summary>
  5055. Deflates the current input block to the given array.
  5056. </summary>
  5057. <param name="output">
  5058. Buffer to store the compressed data.
  5059. </param>
  5060. <param name="offset">
  5061. Offset into the output array.
  5062. </param>
  5063. <param name="length">
  5064. The maximum number of bytes that may be stored.
  5065. </param>
  5066. <returns>
  5067. The number of compressed bytes added to the output, or 0 if either
  5068. needsInput() or finished() returns true or length is zero.
  5069. </returns>
  5070. <exception cref="T:System.InvalidOperationException">
  5071. If Finish() was previously called.
  5072. </exception>
  5073. <exception cref="T:System.ArgumentOutOfRangeException">
  5074. If offset or length don't match the array length.
  5075. </exception>
  5076. </member>
  5077. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetDictionary(System.Byte[])">
  5078. <summary>
  5079. Sets the dictionary which should be used in the deflate process.
  5080. This call is equivalent to <code>setDictionary(dict, 0, dict.Length)</code>.
  5081. </summary>
  5082. <param name="dictionary">
  5083. the dictionary.
  5084. </param>
  5085. <exception cref="T:System.InvalidOperationException">
  5086. if SetInput () or Deflate () were already called or another dictionary was already set.
  5087. </exception>
  5088. </member>
  5089. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.SetDictionary(System.Byte[],System.Int32,System.Int32)">
  5090. <summary>
  5091. Sets the dictionary which should be used in the deflate process.
  5092. The dictionary is a byte array containing strings that are
  5093. likely to occur in the data which should be compressed. The
  5094. dictionary is not stored in the compressed output, only a
  5095. checksum. To decompress the output you need to supply the same
  5096. dictionary again.
  5097. </summary>
  5098. <param name="dictionary">
  5099. The dictionary data
  5100. </param>
  5101. <param name="index">
  5102. The index where dictionary information commences.
  5103. </param>
  5104. <param name="count">
  5105. The number of bytes in the dictionary.
  5106. </param>
  5107. <exception cref="T:System.InvalidOperationException">
  5108. If SetInput () or Deflate() were already called or another dictionary was already set.
  5109. </exception>
  5110. </member>
  5111. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.level">
  5112. <summary>
  5113. Compression level.
  5114. </summary>
  5115. </member>
  5116. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.noZlibHeaderOrFooter">
  5117. <summary>
  5118. If true no Zlib/RFC1950 headers or footers are generated
  5119. </summary>
  5120. </member>
  5121. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.state">
  5122. <summary>
  5123. The current state.
  5124. </summary>
  5125. </member>
  5126. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.totalOut">
  5127. <summary>
  5128. The total bytes of output written.
  5129. </summary>
  5130. </member>
  5131. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.pending">
  5132. <summary>
  5133. The pending output.
  5134. </summary>
  5135. </member>
  5136. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Deflater.engine">
  5137. <summary>
  5138. The deflater engine.
  5139. </summary>
  5140. </member>
  5141. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants">
  5142. <summary>
  5143. This class contains constants used for deflation.
  5144. </summary>
  5145. </member>
  5146. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEBUGGING">
  5147. <summary>
  5148. Set to true to enable debugging
  5149. </summary>
  5150. </member>
  5151. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.STORED_BLOCK">
  5152. <summary>
  5153. Written to Zip file to identify a stored block
  5154. </summary>
  5155. </member>
  5156. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.STATIC_TREES">
  5157. <summary>
  5158. Identifies static tree in Zip file
  5159. </summary>
  5160. </member>
  5161. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DYN_TREES">
  5162. <summary>
  5163. Identifies dynamic tree in Zip file
  5164. </summary>
  5165. </member>
  5166. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.PRESET_DICT">
  5167. <summary>
  5168. Header flag indicating a preset dictionary for deflation
  5169. </summary>
  5170. </member>
  5171. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFAULT_MEM_LEVEL">
  5172. <summary>
  5173. Sets internal buffer sizes for Huffman encoding
  5174. </summary>
  5175. </member>
  5176. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_MATCH">
  5177. <summary>
  5178. Internal compression engine constant
  5179. </summary>
  5180. </member>
  5181. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MIN_MATCH">
  5182. <summary>
  5183. Internal compression engine constant
  5184. </summary>
  5185. </member>
  5186. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_WBITS">
  5187. <summary>
  5188. Internal compression engine constant
  5189. </summary>
  5190. </member>
  5191. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.WSIZE">
  5192. <summary>
  5193. Internal compression engine constant
  5194. </summary>
  5195. </member>
  5196. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.WMASK">
  5197. <summary>
  5198. Internal compression engine constant
  5199. </summary>
  5200. </member>
  5201. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_BITS">
  5202. <summary>
  5203. Internal compression engine constant
  5204. </summary>
  5205. </member>
  5206. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_SIZE">
  5207. <summary>
  5208. Internal compression engine constant
  5209. </summary>
  5210. </member>
  5211. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_MASK">
  5212. <summary>
  5213. Internal compression engine constant
  5214. </summary>
  5215. </member>
  5216. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.HASH_SHIFT">
  5217. <summary>
  5218. Internal compression engine constant
  5219. </summary>
  5220. </member>
  5221. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MIN_LOOKAHEAD">
  5222. <summary>
  5223. Internal compression engine constant
  5224. </summary>
  5225. </member>
  5226. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_DIST">
  5227. <summary>
  5228. Internal compression engine constant
  5229. </summary>
  5230. </member>
  5231. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.PENDING_BUF_SIZE">
  5232. <summary>
  5233. Internal compression engine constant
  5234. </summary>
  5235. </member>
  5236. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_BLOCK_SIZE">
  5237. <summary>
  5238. Internal compression engine constant
  5239. </summary>
  5240. </member>
  5241. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_STORED">
  5242. <summary>
  5243. Internal compression engine constant
  5244. </summary>
  5245. </member>
  5246. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_FAST">
  5247. <summary>
  5248. Internal compression engine constant
  5249. </summary>
  5250. </member>
  5251. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.DEFLATE_SLOW">
  5252. <summary>
  5253. Internal compression engine constant
  5254. </summary>
  5255. </member>
  5256. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.GOOD_LENGTH">
  5257. <summary>
  5258. Internal compression engine constant
  5259. </summary>
  5260. </member>
  5261. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_LAZY">
  5262. <summary>
  5263. Internal compression engine constant
  5264. </summary>
  5265. </member>
  5266. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.NICE_LENGTH">
  5267. <summary>
  5268. Internal compression engine constant
  5269. </summary>
  5270. </member>
  5271. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.MAX_CHAIN">
  5272. <summary>
  5273. Internal compression engine constant
  5274. </summary>
  5275. </member>
  5276. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterConstants.COMPR_FUNC">
  5277. <summary>
  5278. Internal compression engine constant
  5279. </summary>
  5280. </member>
  5281. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy">
  5282. <summary>
  5283. Strategies for deflater
  5284. </summary>
  5285. </member>
  5286. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy.Default">
  5287. <summary>
  5288. The default strategy
  5289. </summary>
  5290. </member>
  5291. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy.Filtered">
  5292. <summary>
  5293. This strategy will only allow longer string repetitions. It is
  5294. useful for random data with a small character set.
  5295. </summary>
  5296. </member>
  5297. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy.HuffmanOnly">
  5298. <summary>
  5299. This strategy will not look for string repetitions at all. It
  5300. only encodes with Huffman trees (which means, that more common
  5301. characters get a smaller encoding.
  5302. </summary>
  5303. </member>
  5304. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine">
  5305. <summary>
  5306. Low level compression engine for deflate algorithm which uses a 32K sliding window
  5307. with secondary compression from Huffman/Shannon-Fano codes.
  5308. </summary>
  5309. </member>
  5310. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.#ctor(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending)">
  5311. <summary>
  5312. Construct instance with pending buffer
  5313. Adler calculation will be performed
  5314. </summary>
  5315. <param name="pending">
  5316. Pending buffer to use
  5317. </param>
  5318. </member>
  5319. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.#ctor(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending,System.Boolean)">
  5320. <summary>
  5321. Construct instance with pending buffer
  5322. </summary>
  5323. <param name="pending">
  5324. Pending buffer to use
  5325. </param>
  5326. <param name="noAdlerCalculation">
  5327. If no adler calculation should be performed
  5328. </param>
  5329. </member>
  5330. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.Deflate(System.Boolean,System.Boolean)">
  5331. <summary>
  5332. Deflate drives actual compression of data
  5333. </summary>
  5334. <param name="flush">True to flush input buffers</param>
  5335. <param name="finish">Finish deflation with the current input.</param>
  5336. <returns>Returns true if progress has been made.</returns>
  5337. </member>
  5338. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetInput(System.Byte[],System.Int32,System.Int32)">
  5339. <summary>
  5340. Sets input data to be deflated. Should only be called when <code>NeedsInput()</code>
  5341. returns true
  5342. </summary>
  5343. <param name="buffer">The buffer containing input data.</param>
  5344. <param name="offset">The offset of the first byte of data.</param>
  5345. <param name="count">The number of bytes of data to use as input.</param>
  5346. </member>
  5347. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.NeedsInput">
  5348. <summary>
  5349. Determines if more <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetInput(System.Byte[],System.Int32,System.Int32)">input</see> is needed.
  5350. </summary>
  5351. <returns>Return true if input is needed via <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetInput(System.Byte[],System.Int32,System.Int32)">SetInput</see></returns>
  5352. </member>
  5353. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetDictionary(System.Byte[],System.Int32,System.Int32)">
  5354. <summary>
  5355. Set compression dictionary
  5356. </summary>
  5357. <param name="buffer">The buffer containing the dictionary data</param>
  5358. <param name="offset">The offset in the buffer for the first byte of data</param>
  5359. <param name="length">The length of the dictionary data.</param>
  5360. </member>
  5361. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.Reset">
  5362. <summary>
  5363. Reset internal state
  5364. </summary>
  5365. </member>
  5366. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.ResetAdler">
  5367. <summary>
  5368. Reset Adler checksum
  5369. </summary>
  5370. </member>
  5371. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.Adler">
  5372. <summary>
  5373. Get current value of Adler checksum
  5374. </summary>
  5375. </member>
  5376. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.TotalIn">
  5377. <summary>
  5378. Total data processed
  5379. </summary>
  5380. </member>
  5381. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.Strategy">
  5382. <summary>
  5383. Get/set the <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflateStrategy">deflate strategy</see>
  5384. </summary>
  5385. </member>
  5386. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.SetLevel(System.Int32)">
  5387. <summary>
  5388. Set the deflate level (0-9)
  5389. </summary>
  5390. <param name="level">The value to set the level to.</param>
  5391. </member>
  5392. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.FillWindow">
  5393. <summary>
  5394. Fill the window
  5395. </summary>
  5396. </member>
  5397. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.InsertString">
  5398. <summary>
  5399. Inserts the current string in the head hash and returns the previous
  5400. value for this hash.
  5401. </summary>
  5402. <returns>The previous hash value</returns>
  5403. </member>
  5404. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.FindLongestMatch(System.Int32)">
  5405. <summary>
  5406. Find the best (longest) string in the window matching the
  5407. string starting at strstart.
  5408. Preconditions:
  5409. <code>
  5410. strstart + DeflaterConstants.MAX_MATCH &lt;= window.length.</code>
  5411. </summary>
  5412. <param name="curMatch"></param>
  5413. <returns>True if a match greater than the minimum length is found</returns>
  5414. </member>
  5415. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.head">
  5416. <summary>
  5417. Hashtable, hashing three characters to an index for window, so
  5418. that window[index]..window[index+2] have this hash code.
  5419. Note that the array should really be unsigned short, so you need
  5420. to and the values with 0xffff.
  5421. </summary>
  5422. </member>
  5423. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.prev">
  5424. <summary>
  5425. <code>prev[index &amp; WMASK]</code> points to the previous index that has the
  5426. same hash code as the string starting at index. This way
  5427. entries with the same hash code are in a linked list.
  5428. Note that the array should really be unsigned short, so you need
  5429. to and the values with 0xffff.
  5430. </summary>
  5431. </member>
  5432. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.strstart">
  5433. <summary>
  5434. Points to the current character in the window.
  5435. </summary>
  5436. </member>
  5437. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.lookahead">
  5438. <summary>
  5439. lookahead is the number of characters starting at strstart in
  5440. window that are valid.
  5441. So window[strstart] until window[strstart+lookahead-1] are valid
  5442. characters.
  5443. </summary>
  5444. </member>
  5445. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.window">
  5446. <summary>
  5447. This array contains the part of the uncompressed stream that
  5448. is of relevance. The current character is indexed by strstart.
  5449. </summary>
  5450. </member>
  5451. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.compressionFunction">
  5452. <summary>
  5453. The current compression function.
  5454. </summary>
  5455. </member>
  5456. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.inputBuf">
  5457. <summary>
  5458. The input data for compression.
  5459. </summary>
  5460. </member>
  5461. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.totalIn">
  5462. <summary>
  5463. The total bytes of input read.
  5464. </summary>
  5465. </member>
  5466. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.inputOff">
  5467. <summary>
  5468. The offset into inputBuf, where input data starts.
  5469. </summary>
  5470. </member>
  5471. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.inputEnd">
  5472. <summary>
  5473. The end offset of the input data.
  5474. </summary>
  5475. </member>
  5476. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterEngine.adler">
  5477. <summary>
  5478. The adler checksum
  5479. </summary>
  5480. </member>
  5481. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman">
  5482. <summary>
  5483. This is the DeflaterHuffman class.
  5484. This class is <i>not</i> thread safe. This is inherent in the API, due
  5485. to the split of Deflate and SetInput.
  5486. author of the original java version : Jochen Hoenicke
  5487. </summary>
  5488. </member>
  5489. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.Reset">
  5490. <summary>
  5491. Resets the internal state of the tree
  5492. </summary>
  5493. </member>
  5494. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.CheckEmpty">
  5495. <summary>
  5496. Check that all frequencies are zero
  5497. </summary>
  5498. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  5499. At least one frequency is non-zero
  5500. </exception>
  5501. </member>
  5502. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.SetStaticCodes(System.Int16[],System.Byte[])">
  5503. <summary>
  5504. Set static codes and length
  5505. </summary>
  5506. <param name="staticCodes">new codes</param>
  5507. <param name="staticLengths">length for new codes</param>
  5508. </member>
  5509. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.BuildCodes">
  5510. <summary>
  5511. Build dynamic codes and lengths
  5512. </summary>
  5513. </member>
  5514. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.GetEncodedLength">
  5515. <summary>
  5516. Get encoded length
  5517. </summary>
  5518. <returns>Encoded length, the sum of frequencies * lengths</returns>
  5519. </member>
  5520. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.CalcBLFreq(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree)">
  5521. <summary>
  5522. Scan a literal or distance tree to determine the frequencies of the codes
  5523. in the bit length tree.
  5524. </summary>
  5525. </member>
  5526. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree.WriteTree(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Tree)">
  5527. <summary>
  5528. Write tree values
  5529. </summary>
  5530. <param name="blTree">Tree to write</param>
  5531. </member>
  5532. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.pending">
  5533. <summary>
  5534. Pending buffer to use
  5535. </summary>
  5536. </member>
  5537. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.#ctor(ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending)">
  5538. <summary>
  5539. Construct instance with pending buffer
  5540. </summary>
  5541. <param name="pending">Pending buffer to use</param>
  5542. </member>
  5543. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.Reset">
  5544. <summary>
  5545. Reset internal state
  5546. </summary>
  5547. </member>
  5548. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.SendAllTrees(System.Int32)">
  5549. <summary>
  5550. Write all trees to pending buffer
  5551. </summary>
  5552. <param name="blTreeCodes">The number/rank of treecodes to send.</param>
  5553. </member>
  5554. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.CompressBlock">
  5555. <summary>
  5556. Compress current buffer writing data to pending buffer
  5557. </summary>
  5558. </member>
  5559. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.FlushStoredBlock(System.Byte[],System.Int32,System.Int32,System.Boolean)">
  5560. <summary>
  5561. Flush block to output with no compression
  5562. </summary>
  5563. <param name="stored">Data to write</param>
  5564. <param name="storedOffset">Index of first byte to write</param>
  5565. <param name="storedLength">Count of bytes to write</param>
  5566. <param name="lastBlock">True if this is the last block</param>
  5567. </member>
  5568. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.FlushBlock(System.Byte[],System.Int32,System.Int32,System.Boolean)">
  5569. <summary>
  5570. Flush block to output with compression
  5571. </summary>
  5572. <param name="stored">Data to flush</param>
  5573. <param name="storedOffset">Index of first byte to flush</param>
  5574. <param name="storedLength">Count of bytes to flush</param>
  5575. <param name="lastBlock">True if this is the last block</param>
  5576. </member>
  5577. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.IsFull">
  5578. <summary>
  5579. Get value indicating if internal buffer is full
  5580. </summary>
  5581. <returns>true if buffer is full</returns>
  5582. </member>
  5583. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.TallyLit(System.Int32)">
  5584. <summary>
  5585. Add literal to buffer
  5586. </summary>
  5587. <param name="literal">Literal value to add to buffer.</param>
  5588. <returns>Value indicating internal buffer is full</returns>
  5589. </member>
  5590. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.TallyDist(System.Int32,System.Int32)">
  5591. <summary>
  5592. Add distance code and length to literal and distance trees
  5593. </summary>
  5594. <param name="distance">Distance code</param>
  5595. <param name="length">Length</param>
  5596. <returns>Value indicating if internal buffer is full</returns>
  5597. </member>
  5598. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterHuffman.BitReverse(System.Int32)">
  5599. <summary>
  5600. Reverse the bits of a 16 bit value.
  5601. </summary>
  5602. <param name="toReverse">Value to reverse bits</param>
  5603. <returns>Value with bits reversed</returns>
  5604. </member>
  5605. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending">
  5606. <summary>
  5607. This class stores the pending output of the Deflater.
  5608. author of the original java version : Jochen Hoenicke
  5609. </summary>
  5610. </member>
  5611. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.DeflaterPending.#ctor">
  5612. <summary>
  5613. Construct instance with default buffer size
  5614. </summary>
  5615. </member>
  5616. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Inflater">
  5617. <summary>
  5618. Inflater is used to decompress data that has been compressed according
  5619. to the "deflate" standard described in rfc1951.
  5620. By default Zlib (rfc1950) headers and footers are expected in the input.
  5621. You can use constructor <code> public Inflater(bool noHeader)</code> passing true
  5622. if there is no Zlib header information
  5623. The usage is as following. First you have to set some input with
  5624. <code>SetInput()</code>, then Inflate() it. If inflate doesn't
  5625. inflate any bytes there may be three reasons:
  5626. <ul>
  5627. <li>IsNeedingInput() returns true because the input buffer is empty.
  5628. You have to provide more input with <code>SetInput()</code>.
  5629. NOTE: IsNeedingInput() also returns true when, the stream is finished.
  5630. </li>
  5631. <li>IsNeedingDictionary() returns true, you have to provide a preset
  5632. dictionary with <code>SetDictionary()</code>.</li>
  5633. <li>IsFinished returns true, the inflater has finished.</li>
  5634. </ul>
  5635. Once the first output byte is produced, a dictionary will not be
  5636. needed at a later stage.
  5637. author of the original java version : John Leuner, Jochen Hoenicke
  5638. </summary>
  5639. </member>
  5640. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.CPLENS">
  5641. <summary>
  5642. Copy lengths for literal codes 257..285
  5643. </summary>
  5644. </member>
  5645. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.CPLEXT">
  5646. <summary>
  5647. Extra bits for literal codes 257..285
  5648. </summary>
  5649. </member>
  5650. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.CPDIST">
  5651. <summary>
  5652. Copy offsets for distance codes 0..29
  5653. </summary>
  5654. </member>
  5655. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.CPDEXT">
  5656. <summary>
  5657. Extra bits for distance codes
  5658. </summary>
  5659. </member>
  5660. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DECODE_HEADER">
  5661. <summary>
  5662. These are the possible states for an inflater
  5663. </summary>
  5664. </member>
  5665. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.mode">
  5666. <summary>
  5667. This variable contains the current state.
  5668. </summary>
  5669. </member>
  5670. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.readAdler">
  5671. <summary>
  5672. The adler checksum of the dictionary or of the decompressed
  5673. stream, as it is written in the header resp. footer of the
  5674. compressed stream.
  5675. Only valid if mode is DECODE_DICT or DECODE_CHKSUM.
  5676. </summary>
  5677. </member>
  5678. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.neededBits">
  5679. <summary>
  5680. The number of bits needed to complete the current state. This
  5681. is valid, if mode is DECODE_DICT, DECODE_CHKSUM,
  5682. DECODE_HUFFMAN_LENBITS or DECODE_HUFFMAN_DISTBITS.
  5683. </summary>
  5684. </member>
  5685. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.isLastBlock">
  5686. <summary>
  5687. True, if the last block flag was set in the last block of the
  5688. inflated stream. This means that the stream ends after the
  5689. current block.
  5690. </summary>
  5691. </member>
  5692. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.totalOut">
  5693. <summary>
  5694. The total number of inflated bytes.
  5695. </summary>
  5696. </member>
  5697. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.totalIn">
  5698. <summary>
  5699. The total number of bytes set with setInput(). This is not the
  5700. value returned by the TotalIn property, since this also includes the
  5701. unprocessed input.
  5702. </summary>
  5703. </member>
  5704. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.noHeader">
  5705. <summary>
  5706. This variable stores the noHeader flag that was given to the constructor.
  5707. True means, that the inflated stream doesn't contain a Zlib header or
  5708. footer.
  5709. </summary>
  5710. </member>
  5711. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.#ctor">
  5712. <summary>
  5713. Creates a new inflater or RFC1951 decompressor
  5714. RFC1950/Zlib headers and footers will be expected in the input data
  5715. </summary>
  5716. </member>
  5717. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.#ctor(System.Boolean)">
  5718. <summary>
  5719. Creates a new inflater.
  5720. </summary>
  5721. <param name="noHeader">
  5722. True if no RFC1950/Zlib header and footer fields are expected in the input data
  5723. This is used for GZIPed/Zipped input.
  5724. For compatibility with
  5725. Sun JDK you should provide one byte of input more than needed in
  5726. this case.
  5727. </param>
  5728. </member>
  5729. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Reset">
  5730. <summary>
  5731. Resets the inflater so that a new stream can be decompressed. All
  5732. pending input and output will be discarded.
  5733. </summary>
  5734. </member>
  5735. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DecodeHeader">
  5736. <summary>
  5737. Decodes a zlib/RFC1950 header.
  5738. </summary>
  5739. <returns>
  5740. False if more input is needed.
  5741. </returns>
  5742. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  5743. The header is invalid.
  5744. </exception>
  5745. </member>
  5746. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DecodeDict">
  5747. <summary>
  5748. Decodes the dictionary checksum after the deflate header.
  5749. </summary>
  5750. <returns>
  5751. False if more input is needed.
  5752. </returns>
  5753. </member>
  5754. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DecodeHuffman">
  5755. <summary>
  5756. Decodes the huffman encoded symbols in the input stream.
  5757. </summary>
  5758. <returns>
  5759. false if more input is needed, true if output window is
  5760. full or the current block ends.
  5761. </returns>
  5762. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  5763. if deflated stream is invalid.
  5764. </exception>
  5765. </member>
  5766. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.DecodeChksum">
  5767. <summary>
  5768. Decodes the adler checksum after the deflate stream.
  5769. </summary>
  5770. <returns>
  5771. false if more input is needed.
  5772. </returns>
  5773. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  5774. If checksum doesn't match.
  5775. </exception>
  5776. </member>
  5777. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Decode">
  5778. <summary>
  5779. Decodes the deflated stream.
  5780. </summary>
  5781. <returns>
  5782. false if more input is needed, or if finished.
  5783. </returns>
  5784. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  5785. if deflated stream is invalid.
  5786. </exception>
  5787. </member>
  5788. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetDictionary(System.Byte[])">
  5789. <summary>
  5790. Sets the preset dictionary. This should only be called, if
  5791. needsDictionary() returns true and it should set the same
  5792. dictionary, that was used for deflating. The getAdler()
  5793. function returns the checksum of the dictionary needed.
  5794. </summary>
  5795. <param name="buffer">
  5796. The dictionary.
  5797. </param>
  5798. </member>
  5799. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetDictionary(System.Byte[],System.Int32,System.Int32)">
  5800. <summary>
  5801. Sets the preset dictionary. This should only be called, if
  5802. needsDictionary() returns true and it should set the same
  5803. dictionary, that was used for deflating. The getAdler()
  5804. function returns the checksum of the dictionary needed.
  5805. </summary>
  5806. <param name="buffer">
  5807. The dictionary.
  5808. </param>
  5809. <param name="index">
  5810. The index into buffer where the dictionary starts.
  5811. </param>
  5812. <param name="count">
  5813. The number of bytes in the dictionary.
  5814. </param>
  5815. <exception cref="T:System.InvalidOperationException">
  5816. No dictionary is needed.
  5817. </exception>
  5818. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  5819. The adler checksum for the buffer is invalid
  5820. </exception>
  5821. </member>
  5822. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetInput(System.Byte[])">
  5823. <summary>
  5824. Sets the input. This should only be called, if needsInput()
  5825. returns true.
  5826. </summary>
  5827. <param name="buffer">
  5828. the input.
  5829. </param>
  5830. </member>
  5831. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetInput(System.Byte[],System.Int32,System.Int32)">
  5832. <summary>
  5833. Sets the input. This should only be called, if needsInput()
  5834. returns true.
  5835. </summary>
  5836. <param name="buffer">
  5837. The source of input data
  5838. </param>
  5839. <param name="index">
  5840. The index into buffer where the input starts.
  5841. </param>
  5842. <param name="count">
  5843. The number of bytes of input to use.
  5844. </param>
  5845. <exception cref="T:System.InvalidOperationException">
  5846. No input is needed.
  5847. </exception>
  5848. <exception cref="T:System.ArgumentOutOfRangeException">
  5849. The index and/or count are wrong.
  5850. </exception>
  5851. </member>
  5852. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Inflate(System.Byte[])">
  5853. <summary>
  5854. Inflates the compressed stream to the output buffer. If this
  5855. returns 0, you should check, whether IsNeedingDictionary(),
  5856. IsNeedingInput() or IsFinished() returns true, to determine why no
  5857. further output is produced.
  5858. </summary>
  5859. <param name="buffer">
  5860. the output buffer.
  5861. </param>
  5862. <returns>
  5863. The number of bytes written to the buffer, 0 if no further
  5864. output can be produced.
  5865. </returns>
  5866. <exception cref="T:System.ArgumentOutOfRangeException">
  5867. if buffer has length 0.
  5868. </exception>
  5869. <exception cref="T:System.FormatException">
  5870. if deflated stream is invalid.
  5871. </exception>
  5872. </member>
  5873. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Inflate(System.Byte[],System.Int32,System.Int32)">
  5874. <summary>
  5875. Inflates the compressed stream to the output buffer. If this
  5876. returns 0, you should check, whether needsDictionary(),
  5877. needsInput() or finished() returns true, to determine why no
  5878. further output is produced.
  5879. </summary>
  5880. <param name="buffer">
  5881. the output buffer.
  5882. </param>
  5883. <param name="offset">
  5884. the offset in buffer where storing starts.
  5885. </param>
  5886. <param name="count">
  5887. the maximum number of bytes to output.
  5888. </param>
  5889. <returns>
  5890. the number of bytes written to the buffer, 0 if no further output can be produced.
  5891. </returns>
  5892. <exception cref="T:System.ArgumentOutOfRangeException">
  5893. if count is less than 0.
  5894. </exception>
  5895. <exception cref="T:System.ArgumentOutOfRangeException">
  5896. if the index and / or count are wrong.
  5897. </exception>
  5898. <exception cref="T:System.FormatException">
  5899. if deflated stream is invalid.
  5900. </exception>
  5901. </member>
  5902. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.IsNeedingInput">
  5903. <summary>
  5904. Returns true, if the input buffer is empty.
  5905. You should then call setInput().
  5906. NOTE: This method also returns true when the stream is finished.
  5907. </summary>
  5908. </member>
  5909. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.IsNeedingDictionary">
  5910. <summary>
  5911. Returns true, if a preset dictionary is needed to inflate the input.
  5912. </summary>
  5913. </member>
  5914. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.IsFinished">
  5915. <summary>
  5916. Returns true, if the inflater has finished. This means, that no
  5917. input is needed and no output can be produced.
  5918. </summary>
  5919. </member>
  5920. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.Adler">
  5921. <summary>
  5922. Gets the adler checksum. This is either the checksum of all
  5923. uncompressed bytes returned by inflate(), or if needsDictionary()
  5924. returns true (and thus no output was yet produced) this is the
  5925. adler checksum of the expected dictionary.
  5926. </summary>
  5927. <returns>
  5928. the adler checksum.
  5929. </returns>
  5930. </member>
  5931. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.TotalOut">
  5932. <summary>
  5933. Gets the total number of output bytes returned by Inflate().
  5934. </summary>
  5935. <returns>
  5936. the total number of output bytes.
  5937. </returns>
  5938. </member>
  5939. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.TotalIn">
  5940. <summary>
  5941. Gets the total number of processed compressed input bytes.
  5942. </summary>
  5943. <returns>
  5944. The total number of bytes of processed input bytes.
  5945. </returns>
  5946. </member>
  5947. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.RemainingInput">
  5948. <summary>
  5949. Gets the number of unprocessed input bytes. Useful, if the end of the
  5950. stream is reached and you want to further process the bytes after
  5951. the deflate stream.
  5952. </summary>
  5953. <returns>
  5954. The number of bytes of the input which have not been processed.
  5955. </returns>
  5956. </member>
  5957. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.AttemptRead">
  5958. <summary>
  5959. Continue decoding header from <see cref="F:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.input"/> until more bits are needed or decoding has been completed
  5960. </summary>
  5961. <returns>Returns whether decoding could be completed</returns>
  5962. </member>
  5963. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.LiteralLengthTree">
  5964. <summary>
  5965. Get literal/length huffman tree, must not be used before <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.AttemptRead"/> has returned true
  5966. </summary>
  5967. <exception cref="T:ICSharpCode.SharpZipLib.StreamDecodingException">If hader has not been successfully read by the state machine</exception>
  5968. </member>
  5969. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.DistanceTree">
  5970. <summary>
  5971. Get distance huffman tree, must not be used before <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterDynHeader.AttemptRead"/> has returned true
  5972. </summary>
  5973. <exception cref="T:ICSharpCode.SharpZipLib.StreamDecodingException">If hader has not been successfully read by the state machine</exception>
  5974. </member>
  5975. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree">
  5976. <summary>
  5977. Huffman tree used for inflation
  5978. </summary>
  5979. </member>
  5980. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.defLitLenTree">
  5981. <summary>
  5982. Literal length tree
  5983. </summary>
  5984. </member>
  5985. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.defDistTree">
  5986. <summary>
  5987. Distance tree
  5988. </summary>
  5989. </member>
  5990. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.#ctor(System.Collections.Generic.IList{System.Byte})">
  5991. <summary>
  5992. Constructs a Huffman tree from the array of code lengths.
  5993. </summary>
  5994. <param name = "codeLengths">
  5995. the array of code lengths
  5996. </param>
  5997. </member>
  5998. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.InflaterHuffmanTree.GetSymbol(ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator)">
  5999. <summary>
  6000. Reads the next symbol from input. The symbol is encoded using the
  6001. huffman tree.
  6002. </summary>
  6003. <param name="input">
  6004. input the input source.
  6005. </param>
  6006. <returns>
  6007. the next symbol, or -1 if not enough input is available.
  6008. </returns>
  6009. </member>
  6010. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer">
  6011. <summary>
  6012. This class is general purpose class for writing data to a buffer.
  6013. It allows you to write bits as well as bytes
  6014. Based on DeflaterPending.java
  6015. author of the original java version : Jochen Hoenicke
  6016. </summary>
  6017. </member>
  6018. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.buffer">
  6019. <summary>
  6020. Internal work buffer
  6021. </summary>
  6022. </member>
  6023. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.#ctor">
  6024. <summary>
  6025. construct instance using default buffer size of 4096
  6026. </summary>
  6027. </member>
  6028. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.#ctor(System.Int32)">
  6029. <summary>
  6030. construct instance using specified buffer size
  6031. </summary>
  6032. <param name="bufferSize">
  6033. size to use for internal buffer
  6034. </param>
  6035. </member>
  6036. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.Reset">
  6037. <summary>
  6038. Clear internal state/buffers
  6039. </summary>
  6040. </member>
  6041. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteByte(System.Int32)">
  6042. <summary>
  6043. Write a byte to buffer
  6044. </summary>
  6045. <param name="value">
  6046. The value to write
  6047. </param>
  6048. </member>
  6049. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteShort(System.Int32)">
  6050. <summary>
  6051. Write a short value to buffer LSB first
  6052. </summary>
  6053. <param name="value">
  6054. The value to write.
  6055. </param>
  6056. </member>
  6057. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteInt(System.Int32)">
  6058. <summary>
  6059. write an integer LSB first
  6060. </summary>
  6061. <param name="value">The value to write.</param>
  6062. </member>
  6063. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteBlock(System.Byte[],System.Int32,System.Int32)">
  6064. <summary>
  6065. Write a block of data to buffer
  6066. </summary>
  6067. <param name="block">data to write</param>
  6068. <param name="offset">offset of first byte to write</param>
  6069. <param name="length">number of bytes to write</param>
  6070. </member>
  6071. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.BitCount">
  6072. <summary>
  6073. The number of bits written to the buffer
  6074. </summary>
  6075. </member>
  6076. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.AlignToByte">
  6077. <summary>
  6078. Align internal buffer on a byte boundary
  6079. </summary>
  6080. </member>
  6081. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteBits(System.Int32,System.Int32)">
  6082. <summary>
  6083. Write bits to internal buffer
  6084. </summary>
  6085. <param name="b">source of bits</param>
  6086. <param name="count">number of bits to write</param>
  6087. </member>
  6088. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.WriteShortMSB(System.Int32)">
  6089. <summary>
  6090. Write a short value to internal buffer most significant byte first
  6091. </summary>
  6092. <param name="s">value to write</param>
  6093. </member>
  6094. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.IsFlushed">
  6095. <summary>
  6096. Indicates if buffer has been flushed
  6097. </summary>
  6098. </member>
  6099. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.Flush(System.Byte[],System.Int32,System.Int32)">
  6100. <summary>
  6101. Flushes the pending buffer into the given output array. If the
  6102. output array is to small, only a partial flush is done.
  6103. </summary>
  6104. <param name="output">The output array.</param>
  6105. <param name="offset">The offset into output array.</param>
  6106. <param name="length">The maximum number of bytes to store.</param>
  6107. <returns>The number of bytes flushed.</returns>
  6108. </member>
  6109. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.PendingBuffer.ToByteArray">
  6110. <summary>
  6111. Convert internal buffer to byte array.
  6112. Buffer is empty on completion
  6113. </summary>
  6114. <returns>
  6115. The internal buffer contents converted to a byte array.
  6116. </returns>
  6117. </member>
  6118. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream">
  6119. <summary>
  6120. A special stream deflating or compressing the bytes that are
  6121. written to it. It uses a Deflater to perform actual deflating.<br/>
  6122. Authors of the original java version : Tom Tromey, Jochen Hoenicke
  6123. </summary>
  6124. </member>
  6125. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream)">
  6126. <summary>
  6127. Creates a new DeflaterOutputStream with a default Deflater and default buffer size.
  6128. </summary>
  6129. <param name="baseOutputStream">
  6130. the output stream where deflated output should be written.
  6131. </param>
  6132. </member>
  6133. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Deflater)">
  6134. <summary>
  6135. Creates a new DeflaterOutputStream with the given Deflater and
  6136. default buffer size.
  6137. </summary>
  6138. <param name="baseOutputStream">
  6139. the output stream where deflated output should be written.
  6140. </param>
  6141. <param name="deflater">
  6142. the underlying deflater.
  6143. </param>
  6144. </member>
  6145. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Deflater,System.Int32)">
  6146. <summary>
  6147. Creates a new DeflaterOutputStream with the given Deflater and
  6148. buffer size.
  6149. </summary>
  6150. <param name="baseOutputStream">
  6151. The output stream where deflated output is written.
  6152. </param>
  6153. <param name="deflater">
  6154. The underlying deflater to use
  6155. </param>
  6156. <param name="bufferSize">
  6157. The buffer size in bytes to use when deflating (minimum value 512)
  6158. </param>
  6159. <exception cref="T:System.ArgumentOutOfRangeException">
  6160. bufsize is less than or equal to zero.
  6161. </exception>
  6162. <exception cref="T:System.ArgumentException">
  6163. baseOutputStream does not support writing
  6164. </exception>
  6165. <exception cref="T:System.ArgumentNullException">
  6166. deflater instance is null
  6167. </exception>
  6168. </member>
  6169. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Finish">
  6170. <summary>
  6171. Finishes the stream by calling finish() on the deflater.
  6172. </summary>
  6173. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  6174. Not all input is deflated
  6175. </exception>
  6176. </member>
  6177. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.FinishAsync(System.Threading.CancellationToken)">
  6178. <summary>
  6179. Finishes the stream by calling finish() on the deflater.
  6180. </summary>
  6181. <param name="ct">The <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the operation.</param>
  6182. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  6183. Not all input is deflated
  6184. </exception>
  6185. </member>
  6186. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.IsStreamOwner">
  6187. <summary>
  6188. Gets or sets a flag indicating ownership of underlying stream.
  6189. When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
  6190. </summary>
  6191. <remarks>The default value is true.</remarks>
  6192. </member>
  6193. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanPatchEntries">
  6194. <summary>
  6195. Allows client to determine if an entry can be patched after its added
  6196. </summary>
  6197. </member>
  6198. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.cryptoTransform_">
  6199. <summary>
  6200. The CryptoTransform currently being used to encrypt the compressed data.
  6201. </summary>
  6202. </member>
  6203. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.AESAuthCode">
  6204. <summary>
  6205. Returns the 10 byte AUTH CODE to be appended immediately following the AES data stream.
  6206. </summary>
  6207. </member>
  6208. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.ZipCryptoEncoding">
  6209. <inheritdoc cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipCryptoEncoding"/>
  6210. </member>
  6211. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.EncryptBlock(System.Byte[],System.Int32,System.Int32)">
  6212. <summary>
  6213. Encrypt a block of data
  6214. </summary>
  6215. <param name="buffer">
  6216. Data to encrypt. NOTE the original contents of the buffer are lost
  6217. </param>
  6218. <param name="offset">
  6219. Offset of first byte in buffer to encrypt
  6220. </param>
  6221. <param name="length">
  6222. Number of bytes in buffer to encrypt
  6223. </param>
  6224. </member>
  6225. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Deflate">
  6226. <summary>
  6227. Deflates everything in the input buffers. This will call
  6228. <code>def.deflate()</code> until all bytes from the input buffers
  6229. are processed.
  6230. </summary>
  6231. </member>
  6232. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanRead">
  6233. <summary>
  6234. Gets value indicating stream can be read from
  6235. </summary>
  6236. </member>
  6237. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanSeek">
  6238. <summary>
  6239. Gets a value indicating if seeking is supported for this stream
  6240. This property always returns false
  6241. </summary>
  6242. </member>
  6243. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.CanWrite">
  6244. <summary>
  6245. Get value indicating if this stream supports writing
  6246. </summary>
  6247. </member>
  6248. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Length">
  6249. <summary>
  6250. Get current length of stream
  6251. </summary>
  6252. </member>
  6253. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Position">
  6254. <summary>
  6255. Gets the current position within the stream.
  6256. </summary>
  6257. <exception cref="T:System.NotSupportedException">Any attempt to set position</exception>
  6258. </member>
  6259. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  6260. <summary>
  6261. Sets the current position of this stream to the given value. Not supported by this class!
  6262. </summary>
  6263. <param name="offset">The offset relative to the <paramref name="origin"/> to seek.</param>
  6264. <param name="origin">The <see cref="T:System.IO.SeekOrigin"/> to seek from.</param>
  6265. <returns>The new position in the stream.</returns>
  6266. <exception cref="T:System.NotSupportedException">Any access</exception>
  6267. </member>
  6268. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.SetLength(System.Int64)">
  6269. <summary>
  6270. Sets the length of this stream to the given value. Not supported by this class!
  6271. </summary>
  6272. <param name="value">The new stream length.</param>
  6273. <exception cref="T:System.NotSupportedException">Any access</exception>
  6274. </member>
  6275. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.ReadByte">
  6276. <summary>
  6277. Read a byte from stream advancing position by one
  6278. </summary>
  6279. <returns>The byte read cast to an int. THe value is -1 if at the end of the stream.</returns>
  6280. <exception cref="T:System.NotSupportedException">Any access</exception>
  6281. </member>
  6282. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Read(System.Byte[],System.Int32,System.Int32)">
  6283. <summary>
  6284. Read a block of bytes from stream
  6285. </summary>
  6286. <param name="buffer">The buffer to store read data in.</param>
  6287. <param name="offset">The offset to start storing at.</param>
  6288. <param name="count">The maximum number of bytes to read.</param>
  6289. <returns>The actual number of bytes read. Zero if end of stream is detected.</returns>
  6290. <exception cref="T:System.NotSupportedException">Any access</exception>
  6291. </member>
  6292. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Flush">
  6293. <summary>
  6294. Flushes the stream by calling <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Flush">Flush</see> on the deflater and then
  6295. on the underlying stream. This ensures that all bytes are flushed.
  6296. </summary>
  6297. </member>
  6298. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.FlushAsync(System.Threading.CancellationToken)">
  6299. <inheritdoc/>
  6300. </member>
  6301. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Dispose(System.Boolean)">
  6302. <summary>
  6303. Calls <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Finish"/> and closes the underlying
  6304. stream when <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.IsStreamOwner"></see> is true.
  6305. </summary>
  6306. </member>
  6307. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.DisposeAsync">
  6308. <summary>
  6309. Calls <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.FinishAsync(System.Threading.CancellationToken)"/> and closes the underlying
  6310. stream when <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.IsStreamOwner"></see> is true.
  6311. </summary>
  6312. </member>
  6313. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.GetAuthCodeIfAES">
  6314. <summary>
  6315. Get the Auth code for AES encrypted entries
  6316. </summary>
  6317. </member>
  6318. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.WriteByte(System.Byte)">
  6319. <summary>
  6320. Writes a single byte to the compressed output stream.
  6321. </summary>
  6322. <param name="value">
  6323. The byte value.
  6324. </param>
  6325. </member>
  6326. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  6327. <summary>
  6328. Writes bytes from an array to the compressed stream.
  6329. </summary>
  6330. <param name="buffer">
  6331. The byte array
  6332. </param>
  6333. <param name="offset">
  6334. The offset into the byte array where to start.
  6335. </param>
  6336. <param name="count">
  6337. The number of bytes to write.
  6338. </param>
  6339. </member>
  6340. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  6341. <inheritdoc />
  6342. </member>
  6343. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.buffer_">
  6344. <summary>
  6345. This buffer is used temporarily to retrieve the bytes from the
  6346. deflater and write them to the underlying output stream.
  6347. </summary>
  6348. </member>
  6349. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.deflater_">
  6350. <summary>
  6351. The deflater which is used to deflate the stream.
  6352. </summary>
  6353. </member>
  6354. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.baseOutputStream_">
  6355. <summary>
  6356. Base stream the deflater depends on.
  6357. </summary>
  6358. </member>
  6359. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream._stringCodec">
  6360. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.StringCodec"/>
  6361. </member>
  6362. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer">
  6363. <summary>
  6364. An input buffer customised for use by <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream"/>
  6365. </summary>
  6366. <remarks>
  6367. The buffer supports decryption of incoming data.
  6368. </remarks>
  6369. </member>
  6370. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.#ctor(System.IO.Stream)">
  6371. <summary>
  6372. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer"/> with a default buffer size
  6373. </summary>
  6374. <param name="stream">The stream to buffer.</param>
  6375. </member>
  6376. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.#ctor(System.IO.Stream,System.Int32)">
  6377. <summary>
  6378. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer"/>
  6379. </summary>
  6380. <param name="stream">The stream to buffer.</param>
  6381. <param name="bufferSize">The size to use for the buffer</param>
  6382. <remarks>A minimum buffer size of 1KB is permitted. Lower sizes are treated as 1KB.</remarks>
  6383. </member>
  6384. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.RawLength">
  6385. <summary>
  6386. Get the length of bytes in the <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.RawData"/>
  6387. </summary>
  6388. </member>
  6389. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.RawData">
  6390. <summary>
  6391. Get the contents of the raw data buffer.
  6392. </summary>
  6393. <remarks>This may contain encrypted data.</remarks>
  6394. </member>
  6395. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ClearTextLength">
  6396. <summary>
  6397. Get the number of useable bytes in <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ClearText"/>
  6398. </summary>
  6399. </member>
  6400. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ClearText">
  6401. <summary>
  6402. Get the contents of the clear text buffer.
  6403. </summary>
  6404. </member>
  6405. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.Available">
  6406. <summary>
  6407. Get/set the number of bytes available
  6408. </summary>
  6409. </member>
  6410. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.SetInflaterInput(ICSharpCode.SharpZipLib.Zip.Compression.Inflater)">
  6411. <summary>
  6412. Call <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Inflater.SetInput(System.Byte[],System.Int32,System.Int32)"/> passing the current clear text buffer contents.
  6413. </summary>
  6414. <param name="inflater">The inflater to set input for.</param>
  6415. </member>
  6416. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.Fill">
  6417. <summary>
  6418. Fill the buffer from the underlying input stream.
  6419. </summary>
  6420. </member>
  6421. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadRawBuffer(System.Byte[])">
  6422. <summary>
  6423. Read a buffer directly from the input stream
  6424. </summary>
  6425. <param name="buffer">The buffer to fill</param>
  6426. <returns>Returns the number of bytes read.</returns>
  6427. </member>
  6428. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadRawBuffer(System.Byte[],System.Int32,System.Int32)">
  6429. <summary>
  6430. Read a buffer directly from the input stream
  6431. </summary>
  6432. <param name="outBuffer">The buffer to read into</param>
  6433. <param name="offset">The offset to start reading data into.</param>
  6434. <param name="length">The number of bytes to read.</param>
  6435. <returns>Returns the number of bytes read.</returns>
  6436. </member>
  6437. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadClearTextBuffer(System.Byte[],System.Int32,System.Int32)">
  6438. <summary>
  6439. Read clear text data from the input stream.
  6440. </summary>
  6441. <param name="outBuffer">The buffer to add data to.</param>
  6442. <param name="offset">The offset to start adding data at.</param>
  6443. <param name="length">The number of bytes to read.</param>
  6444. <returns>Returns the number of bytes actually read.</returns>
  6445. </member>
  6446. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadLeByte">
  6447. <summary>
  6448. Read a <see cref="T:System.Byte"/> from the input stream.
  6449. </summary>
  6450. <returns>Returns the byte read.</returns>
  6451. </member>
  6452. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadLeShort">
  6453. <summary>
  6454. Read an <see cref="T:System.Int16"/> in little endian byte order.
  6455. </summary>
  6456. <returns>The short value read case to an int.</returns>
  6457. </member>
  6458. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadLeInt">
  6459. <summary>
  6460. Read an <see cref="T:System.Int32"/> in little endian byte order.
  6461. </summary>
  6462. <returns>The int value read.</returns>
  6463. </member>
  6464. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.ReadLeLong">
  6465. <summary>
  6466. Read a <see cref="T:System.Int64"/> in little endian byte order.
  6467. </summary>
  6468. <returns>The long value read.</returns>
  6469. </member>
  6470. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer.CryptoTransform">
  6471. <summary>
  6472. Get/set the <see cref="T:System.Security.Cryptography.ICryptoTransform"/> to apply to any data.
  6473. </summary>
  6474. <remarks>Set this value to null to have no transform applied.</remarks>
  6475. </member>
  6476. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream">
  6477. <summary>
  6478. This filter stream is used to decompress data compressed using the "deflate"
  6479. format. The "deflate" format is described in RFC 1951.
  6480. This stream may form the basis for other decompression filters, such
  6481. as the <see cref="T:ICSharpCode.SharpZipLib.GZip.GZipInputStream">GZipInputStream</see>.
  6482. Author of the original java version : John Leuner.
  6483. </summary>
  6484. </member>
  6485. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream)">
  6486. <summary>
  6487. Create an InflaterInputStream with the default decompressor
  6488. and a default buffer size of 4KB.
  6489. </summary>
  6490. <param name = "baseInputStream">
  6491. The InputStream to read bytes from
  6492. </param>
  6493. </member>
  6494. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Inflater)">
  6495. <summary>
  6496. Create an InflaterInputStream with the specified decompressor
  6497. and a default buffer size of 4KB.
  6498. </summary>
  6499. <param name = "baseInputStream">
  6500. The source of input data
  6501. </param>
  6502. <param name = "inf">
  6503. The decompressor used to decompress data read from baseInputStream
  6504. </param>
  6505. </member>
  6506. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.Compression.Inflater,System.Int32)">
  6507. <summary>
  6508. Create an InflaterInputStream with the specified decompressor
  6509. and the specified buffer size.
  6510. </summary>
  6511. <param name = "baseInputStream">
  6512. The InputStream to read bytes from
  6513. </param>
  6514. <param name = "inflater">
  6515. The decompressor to use
  6516. </param>
  6517. <param name = "bufferSize">
  6518. Size of the buffer to use
  6519. </param>
  6520. </member>
  6521. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.IsStreamOwner">
  6522. <summary>
  6523. Gets or sets a flag indicating ownership of underlying stream.
  6524. When the flag is true <see cref="M:System.IO.Stream.Dispose" /> will close the underlying stream also.
  6525. </summary>
  6526. <remarks>The default value is true.</remarks>
  6527. </member>
  6528. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Skip(System.Int64)">
  6529. <summary>
  6530. Skip specified number of bytes of uncompressed data
  6531. </summary>
  6532. <param name ="count">
  6533. Number of bytes to skip
  6534. </param>
  6535. <returns>
  6536. The number of bytes skipped, zero if the end of
  6537. stream has been reached
  6538. </returns>
  6539. <exception cref="T:System.ArgumentOutOfRangeException">
  6540. <paramref name="count">The number of bytes</paramref> to skip is less than or equal to zero.
  6541. </exception>
  6542. </member>
  6543. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.StopDecrypting">
  6544. <summary>
  6545. Clear any cryptographic state.
  6546. </summary>
  6547. </member>
  6548. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Available">
  6549. <summary>
  6550. Returns 0 once the end of the stream (EOF) has been reached.
  6551. Otherwise returns 1.
  6552. </summary>
  6553. </member>
  6554. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Fill">
  6555. <summary>
  6556. Fills the buffer with more data to decompress.
  6557. </summary>
  6558. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  6559. Stream ends early
  6560. </exception>
  6561. </member>
  6562. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.CanRead">
  6563. <summary>
  6564. Gets a value indicating whether the current stream supports reading
  6565. </summary>
  6566. </member>
  6567. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.CanSeek">
  6568. <summary>
  6569. Gets a value of false indicating seeking is not supported for this stream.
  6570. </summary>
  6571. </member>
  6572. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.CanWrite">
  6573. <summary>
  6574. Gets a value of false indicating that this stream is not writeable.
  6575. </summary>
  6576. </member>
  6577. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Length">
  6578. <summary>
  6579. A value representing the length of the stream in bytes.
  6580. </summary>
  6581. </member>
  6582. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Position">
  6583. <summary>
  6584. The current position within the stream.
  6585. Throws a NotSupportedException when attempting to set the position
  6586. </summary>
  6587. <exception cref="T:System.NotSupportedException">Attempting to set the position</exception>
  6588. </member>
  6589. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Flush">
  6590. <summary>
  6591. Flushes the baseInputStream
  6592. </summary>
  6593. </member>
  6594. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  6595. <summary>
  6596. Sets the position within the current stream
  6597. Always throws a NotSupportedException
  6598. </summary>
  6599. <param name="offset">The relative offset to seek to.</param>
  6600. <param name="origin">The <see cref="T:System.IO.SeekOrigin"/> defining where to seek from.</param>
  6601. <returns>The new position in the stream.</returns>
  6602. <exception cref="T:System.NotSupportedException">Any access</exception>
  6603. </member>
  6604. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.SetLength(System.Int64)">
  6605. <summary>
  6606. Set the length of the current stream
  6607. Always throws a NotSupportedException
  6608. </summary>
  6609. <param name="value">The new length value for the stream.</param>
  6610. <exception cref="T:System.NotSupportedException">Any access</exception>
  6611. </member>
  6612. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Write(System.Byte[],System.Int32,System.Int32)">
  6613. <summary>
  6614. Writes a sequence of bytes to stream and advances the current position
  6615. This method always throws a NotSupportedException
  6616. </summary>
  6617. <param name="buffer">The buffer containing data to write.</param>
  6618. <param name="offset">The offset of the first byte to write.</param>
  6619. <param name="count">The number of bytes to write.</param>
  6620. <exception cref="T:System.NotSupportedException">Any access</exception>
  6621. </member>
  6622. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.WriteByte(System.Byte)">
  6623. <summary>
  6624. Writes one byte to the current stream and advances the current position
  6625. Always throws a NotSupportedException
  6626. </summary>
  6627. <param name="value">The byte to write.</param>
  6628. <exception cref="T:System.NotSupportedException">Any access</exception>
  6629. </member>
  6630. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Dispose(System.Boolean)">
  6631. <summary>
  6632. Closes the input stream. When <see cref="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.IsStreamOwner"></see>
  6633. is true the underlying stream is also closed.
  6634. </summary>
  6635. </member>
  6636. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  6637. <summary>
  6638. Reads decompressed data into the provided buffer byte array
  6639. </summary>
  6640. <param name ="buffer">
  6641. The array to read and decompress data into
  6642. </param>
  6643. <param name ="offset">
  6644. The offset indicating where the data should be placed
  6645. </param>
  6646. <param name ="count">
  6647. The number of bytes to decompress
  6648. </param>
  6649. <returns>The number of bytes read. Zero signals the end of stream</returns>
  6650. <exception cref="T:ICSharpCode.SharpZipLib.SharpZipBaseException">
  6651. Inflater needs a dictionary
  6652. </exception>
  6653. </member>
  6654. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.inf">
  6655. <summary>
  6656. Decompressor for this stream
  6657. </summary>
  6658. </member>
  6659. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.inputBuffer">
  6660. <summary>
  6661. <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputBuffer">Input buffer</see> for this stream.
  6662. </summary>
  6663. </member>
  6664. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.baseInputStream">
  6665. <summary>
  6666. Base stream the inflater reads from.
  6667. </summary>
  6668. </member>
  6669. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.csize">
  6670. <summary>
  6671. The compressed size
  6672. </summary>
  6673. </member>
  6674. <member name="F:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream.isClosed">
  6675. <summary>
  6676. Flag indicating whether this instance has been closed or not.
  6677. </summary>
  6678. </member>
  6679. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow">
  6680. <summary>
  6681. Contains the output from the Inflation process.
  6682. We need to have a window so that we can refer backwards into the output stream
  6683. to repeat stuff.<br/>
  6684. Author of the original java version : John Leuner
  6685. </summary>
  6686. </member>
  6687. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Write(System.Int32)">
  6688. <summary>
  6689. Write a byte to this output window
  6690. </summary>
  6691. <param name="value">value to write</param>
  6692. <exception cref="T:System.InvalidOperationException">
  6693. if window is full
  6694. </exception>
  6695. </member>
  6696. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Repeat(System.Int32,System.Int32)">
  6697. <summary>
  6698. Append a byte pattern already in the window itself
  6699. </summary>
  6700. <param name="length">length of pattern to copy</param>
  6701. <param name="distance">distance from end of window pattern occurs</param>
  6702. <exception cref="T:System.InvalidOperationException">
  6703. If the repeated data overflows the window
  6704. </exception>
  6705. </member>
  6706. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyStored(ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator,System.Int32)">
  6707. <summary>
  6708. Copy from input manipulator to internal window
  6709. </summary>
  6710. <param name="input">source of data</param>
  6711. <param name="length">length of data to copy</param>
  6712. <returns>the number of bytes copied</returns>
  6713. </member>
  6714. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyDict(System.Byte[],System.Int32,System.Int32)">
  6715. <summary>
  6716. Copy dictionary to window
  6717. </summary>
  6718. <param name="dictionary">source dictionary</param>
  6719. <param name="offset">offset of start in source dictionary</param>
  6720. <param name="length">length of dictionary</param>
  6721. <exception cref="T:System.InvalidOperationException">
  6722. If window isnt empty
  6723. </exception>
  6724. </member>
  6725. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetFreeSpace">
  6726. <summary>
  6727. Get remaining unfilled space in window
  6728. </summary>
  6729. <returns>Number of bytes left in window</returns>
  6730. </member>
  6731. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetAvailable">
  6732. <summary>
  6733. Get bytes available for output in window
  6734. </summary>
  6735. <returns>Number of bytes filled</returns>
  6736. </member>
  6737. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.CopyOutput(System.Byte[],System.Int32,System.Int32)">
  6738. <summary>
  6739. Copy contents of window to output
  6740. </summary>
  6741. <param name="output">buffer to copy to</param>
  6742. <param name="offset">offset to start at</param>
  6743. <param name="len">number of bytes to count</param>
  6744. <returns>The number of bytes copied</returns>
  6745. <exception cref="T:System.InvalidOperationException">
  6746. If a window underflow occurs
  6747. </exception>
  6748. </member>
  6749. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.Reset">
  6750. <summary>
  6751. Reset by clearing window so <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.OutputWindow.GetAvailable">GetAvailable</see> returns 0
  6752. </summary>
  6753. </member>
  6754. <member name="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator">
  6755. <summary>
  6756. This class allows us to retrieve a specified number of bits from
  6757. the input buffer, as well as copy big byte blocks.
  6758. It uses an int buffer to store up to 31 bits for direct
  6759. manipulation. This guarantees that we can get at least 16 bits,
  6760. but we only need at most 15, so this is all safe.
  6761. There are some optimizations in this class, for example, you must
  6762. never peek more than 8 bits more than needed, and you must first
  6763. peek bits before you may drop them. This is not a general purpose
  6764. class but optimized for the behaviour of the Inflater.
  6765. authors of the original java version : John Leuner, Jochen Hoenicke
  6766. </summary>
  6767. </member>
  6768. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.PeekBits(System.Int32)">
  6769. <summary>
  6770. Get the next sequence of bits but don't increase input pointer. bitCount must be
  6771. less or equal 16 and if this call succeeds, you must drop
  6772. at least n - 8 bits in the next call.
  6773. </summary>
  6774. <param name="bitCount">The number of bits to peek.</param>
  6775. <returns>
  6776. the value of the bits, or -1 if not enough bits available. */
  6777. </returns>
  6778. </member>
  6779. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.TryGetBits(System.Int32,System.Int32@,System.Int32)">
  6780. <summary>
  6781. Tries to grab the next <paramref name="bitCount"/> bits from the input and
  6782. sets <paramref name="output"/> to the value, adding <paramref name="outputOffset"/>.
  6783. </summary>
  6784. <returns>true if enough bits could be read, otherwise false</returns>
  6785. </member>
  6786. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.TryGetBits(System.Int32,System.Byte[]@,System.Int32)">
  6787. <summary>
  6788. Tries to grab the next <paramref name="bitCount"/> bits from the input and
  6789. sets <paramref name="index"/> of <paramref name="array"/> to the value.
  6790. </summary>
  6791. <returns>true if enough bits could be read, otherwise false</returns>
  6792. </member>
  6793. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.DropBits(System.Int32)">
  6794. <summary>
  6795. Drops the next n bits from the input. You should have called PeekBits
  6796. with a bigger or equal n before, to make sure that enough bits are in
  6797. the bit buffer.
  6798. </summary>
  6799. <param name="bitCount">The number of bits to drop.</param>
  6800. </member>
  6801. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.GetBits(System.Int32)">
  6802. <summary>
  6803. Gets the next n bits and increases input pointer. This is equivalent
  6804. to <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.PeekBits(System.Int32)"/> followed by <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.DropBits(System.Int32)"/>, except for correct error handling.
  6805. </summary>
  6806. <param name="bitCount">The number of bits to retrieve.</param>
  6807. <returns>
  6808. the value of the bits, or -1 if not enough bits available.
  6809. </returns>
  6810. </member>
  6811. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.AvailableBits">
  6812. <summary>
  6813. Gets the number of bits available in the bit buffer. This must be
  6814. only called when a previous PeekBits() returned -1.
  6815. </summary>
  6816. <returns>
  6817. the number of bits available.
  6818. </returns>
  6819. </member>
  6820. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.AvailableBytes">
  6821. <summary>
  6822. Gets the number of bytes available.
  6823. </summary>
  6824. <returns>
  6825. The number of bytes available.
  6826. </returns>
  6827. </member>
  6828. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.SkipToByteBoundary">
  6829. <summary>
  6830. Skips to the next byte boundary.
  6831. </summary>
  6832. </member>
  6833. <member name="P:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.IsNeedingInput">
  6834. <summary>
  6835. Returns true when SetInput can be called
  6836. </summary>
  6837. </member>
  6838. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.CopyBytes(System.Byte[],System.Int32,System.Int32)">
  6839. <summary>
  6840. Copies bytes from input buffer to output buffer starting
  6841. at output[offset]. You have to make sure, that the buffer is
  6842. byte aligned. If not enough bytes are available, copies fewer
  6843. bytes.
  6844. </summary>
  6845. <param name="output">
  6846. The buffer to copy bytes to.
  6847. </param>
  6848. <param name="offset">
  6849. The offset in the buffer at which copying starts
  6850. </param>
  6851. <param name="length">
  6852. The length to copy, 0 is allowed.
  6853. </param>
  6854. <returns>
  6855. The number of bytes copied, 0 if no bytes were available.
  6856. </returns>
  6857. <exception cref="T:System.ArgumentOutOfRangeException">
  6858. Length is less than zero
  6859. </exception>
  6860. <exception cref="T:System.InvalidOperationException">
  6861. Bit buffer isnt byte aligned
  6862. </exception>
  6863. </member>
  6864. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.Reset">
  6865. <summary>
  6866. Resets state and empties internal buffers
  6867. </summary>
  6868. </member>
  6869. <member name="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.StreamManipulator.SetInput(System.Byte[],System.Int32,System.Int32)">
  6870. <summary>
  6871. Add more input for consumption.
  6872. Only call when IsNeedingInput returns true
  6873. </summary>
  6874. <param name="buffer">data to be input</param>
  6875. <param name="offset">offset of first byte of input</param>
  6876. <param name="count">number of bytes of input to add.</param>
  6877. </member>
  6878. <member name="T:ICSharpCode.SharpZipLib.Zip.FastZipEvents">
  6879. <summary>
  6880. FastZipEvents supports all events applicable to <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip">FastZip</see> operations.
  6881. </summary>
  6882. </member>
  6883. <member name="E:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProcessDirectory">
  6884. <summary>
  6885. Delegate to invoke when processing directories.
  6886. </summary>
  6887. </member>
  6888. <member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProcessFile">
  6889. <summary>
  6890. Delegate to invoke when processing files.
  6891. </summary>
  6892. </member>
  6893. <member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.Progress">
  6894. <summary>
  6895. Delegate to invoke during processing of files.
  6896. </summary>
  6897. </member>
  6898. <member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.CompletedFile">
  6899. <summary>
  6900. Delegate to invoke when processing for a file has been completed.
  6901. </summary>
  6902. </member>
  6903. <member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.DirectoryFailure">
  6904. <summary>
  6905. Delegate to invoke when processing directory failures.
  6906. </summary>
  6907. </member>
  6908. <member name="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.FileFailure">
  6909. <summary>
  6910. Delegate to invoke when processing file failures.
  6911. </summary>
  6912. </member>
  6913. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnDirectoryFailure(System.String,System.Exception)">
  6914. <summary>
  6915. Raise the <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.DirectoryFailure">directory failure</see> event.
  6916. </summary>
  6917. <param name="directory">The directory causing the failure.</param>
  6918. <param name="e">The exception for this event.</param>
  6919. <returns>A boolean indicating if execution should continue or not.</returns>
  6920. </member>
  6921. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnFileFailure(System.String,System.Exception)">
  6922. <summary>
  6923. Fires the <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.FileFailure"> file failure handler delegate</see>.
  6924. </summary>
  6925. <param name="file">The file causing the failure.</param>
  6926. <param name="e">The exception for this failure.</param>
  6927. <returns>A boolean indicating if execution should continue or not.</returns>
  6928. </member>
  6929. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnProcessFile(System.String)">
  6930. <summary>
  6931. Fires the <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProcessFile">ProcessFile delegate</see>.
  6932. </summary>
  6933. <param name="file">The file being processed.</param>
  6934. <returns>A boolean indicating if execution should continue or not.</returns>
  6935. </member>
  6936. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnCompletedFile(System.String)">
  6937. <summary>
  6938. Fires the <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.CompletedFile"/> delegate
  6939. </summary>
  6940. <param name="file">The file whose processing has been completed.</param>
  6941. <returns>A boolean indicating if execution should continue or not.</returns>
  6942. </member>
  6943. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZipEvents.OnProcessDirectory(System.String,System.Boolean)">
  6944. <summary>
  6945. Fires the <see cref="E:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProcessDirectory">process directory</see> delegate.
  6946. </summary>
  6947. <param name="directory">The directory being processed.</param>
  6948. <param name="hasMatchingFiles">Flag indicating if the directory has matching files as determined by the current filter.</param>
  6949. <returns>A <see cref="T:System.Boolean"/> of true if the operation should continue; false otherwise.</returns>
  6950. </member>
  6951. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZipEvents.ProgressInterval">
  6952. <summary>
  6953. The minimum timespan between <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.Progress"/> events.
  6954. </summary>
  6955. <value>The minimum period of time between <see cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.Progress"/> events.</value>
  6956. <seealso cref="F:ICSharpCode.SharpZipLib.Zip.FastZipEvents.Progress"/>
  6957. <remarks>The default interval is three seconds.</remarks>
  6958. </member>
  6959. <member name="T:ICSharpCode.SharpZipLib.Zip.FastZip">
  6960. <summary>
  6961. FastZip provides facilities for creating and extracting zip files.
  6962. </summary>
  6963. </member>
  6964. <member name="T:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite">
  6965. <summary>
  6966. Defines the desired handling when overwriting files during extraction.
  6967. </summary>
  6968. </member>
  6969. <member name="F:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite.Prompt">
  6970. <summary>
  6971. Prompt the user to confirm overwriting
  6972. </summary>
  6973. </member>
  6974. <member name="F:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite.Never">
  6975. <summary>
  6976. Never overwrite files.
  6977. </summary>
  6978. </member>
  6979. <member name="F:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite.Always">
  6980. <summary>
  6981. Always overwrite files.
  6982. </summary>
  6983. </member>
  6984. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.#ctor">
  6985. <summary>
  6986. Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip"/>.
  6987. </summary>
  6988. </member>
  6989. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.#ctor(ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting)">
  6990. <summary>
  6991. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip"/> using the specified <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting"/>
  6992. </summary>
  6993. <param name="timeSetting">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting">time setting</see> to use when creating or extracting <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">Zip entries</see>.</param>
  6994. <remarks>Using <see cref="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.LastAccessTime">TimeSetting.LastAccessTime</see><see cref="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.LastAccessTimeUtc">[Utc]</see> when
  6995. creating an archive will set the file time to the moment of reading.
  6996. </remarks>
  6997. </member>
  6998. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.#ctor(System.DateTime)">
  6999. <summary>
  7000. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip"/> using the specified <see cref="T:System.DateTime"/>
  7001. </summary>
  7002. <param name="time">The time to set all <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DateTime"/> values for created or extracted <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">Zip Entries</see>.</param>
  7003. </member>
  7004. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.#ctor(ICSharpCode.SharpZipLib.Zip.FastZipEvents)">
  7005. <summary>
  7006. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip"/>
  7007. </summary>
  7008. <param name="events">The <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZipEvents">events</see> to use during operations.</param>
  7009. </member>
  7010. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.CreateEmptyDirectories">
  7011. <summary>
  7012. Get/set a value indicating whether empty directories should be created.
  7013. </summary>
  7014. </member>
  7015. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.Password">
  7016. <summary>
  7017. Get / set the password value.
  7018. </summary>
  7019. </member>
  7020. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.EntryEncryptionMethod">
  7021. <summary>
  7022. Get / set the method of encrypting entries.
  7023. </summary>
  7024. <remarks>
  7025. Only applies when <see cref="P:ICSharpCode.SharpZipLib.Zip.FastZip.Password"/> is set.
  7026. Defaults to ZipCrypto for backwards compatibility purposes.
  7027. </remarks>
  7028. </member>
  7029. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.NameTransform">
  7030. <summary>
  7031. Get or set the <see cref="T:ICSharpCode.SharpZipLib.Core.INameTransform"></see> active when creating Zip files.
  7032. </summary>
  7033. <seealso cref="P:ICSharpCode.SharpZipLib.Zip.FastZip.EntryFactory"></seealso>
  7034. </member>
  7035. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.EntryFactory">
  7036. <summary>
  7037. Get or set the <see cref="T:ICSharpCode.SharpZipLib.Zip.IEntryFactory"></see> active when creating Zip files.
  7038. </summary>
  7039. </member>
  7040. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.UseZip64">
  7041. <summary>
  7042. Gets or sets the setting for <see cref="P:ICSharpCode.SharpZipLib.Zip.FastZip.UseZip64">Zip64 handling when writing.</see>
  7043. </summary>
  7044. <remarks>
  7045. The default value is dynamic which is not backwards compatible with old
  7046. programs and can cause problems with XP's built in compression which cant
  7047. read Zip64 archives. However it does avoid the situation were a large file
  7048. is added and cannot be completed correctly.
  7049. NOTE: Setting the size for entries before they are added is the best solution!
  7050. By default the EntryFactory used by FastZip will set the file size.
  7051. </remarks>
  7052. </member>
  7053. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.RestoreDateTimeOnExtract">
  7054. <summary>
  7055. Get/set a value indicating whether file dates and times should
  7056. be restored when extracting files from an archive.
  7057. </summary>
  7058. <remarks>The default value is false.</remarks>
  7059. </member>
  7060. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.RestoreAttributesOnExtract">
  7061. <summary>
  7062. Get/set a value indicating whether file attributes should
  7063. be restored during extract operations
  7064. </summary>
  7065. </member>
  7066. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.CompressionLevel">
  7067. <summary>
  7068. Get/set the Compression Level that will be used
  7069. when creating the zip
  7070. </summary>
  7071. </member>
  7072. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.UseUnicode">
  7073. <summary>
  7074. Reflects the opposite of the internal <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ForceZipLegacyEncoding"/>, setting it to <c>false</c> overrides the encoding used for reading and writing zip entries
  7075. </summary>
  7076. </member>
  7077. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.LegacyCodePage">
  7078. <summary> Gets or sets the code page used for reading/writing zip file entries when unicode is disabled </summary>
  7079. </member>
  7080. <member name="P:ICSharpCode.SharpZipLib.Zip.FastZip.StringCodec">
  7081. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.StringCodec"/>
  7082. </member>
  7083. <member name="T:ICSharpCode.SharpZipLib.Zip.FastZip.ConfirmOverwriteDelegate">
  7084. <summary>
  7085. Delegate called when confirming overwriting of files.
  7086. </summary>
  7087. </member>
  7088. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.String,System.String,System.Boolean,System.String,System.String)">
  7089. <summary>
  7090. Create a zip file.
  7091. </summary>
  7092. <param name="zipFileName">The name of the zip file to create.</param>
  7093. <param name="sourceDirectory">The directory to source files from.</param>
  7094. <param name="recurse">True to recurse directories, false for no recursion.</param>
  7095. <param name="fileFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">file filter</see> to apply.</param>
  7096. <param name="directoryFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">directory filter</see> to apply.</param>
  7097. </member>
  7098. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.String,System.String,System.Boolean,System.String)">
  7099. <summary>
  7100. Create a zip file/archive.
  7101. </summary>
  7102. <param name="zipFileName">The name of the zip file to create.</param>
  7103. <param name="sourceDirectory">The directory to obtain files and directories from.</param>
  7104. <param name="recurse">True to recurse directories, false for no recursion.</param>
  7105. <param name="fileFilter">The file filter to apply.</param>
  7106. </member>
  7107. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.IO.Stream,System.String,System.Boolean,System.String,System.String)">
  7108. <summary>
  7109. Create a zip archive sending output to the <paramref name="outputStream"/> passed.
  7110. </summary>
  7111. <param name="outputStream">The stream to write archive data to.</param>
  7112. <param name="sourceDirectory">The directory to source files from.</param>
  7113. <param name="recurse">True to recurse directories, false for no recursion.</param>
  7114. <param name="fileFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">file filter</see> to apply.</param>
  7115. <param name="directoryFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">directory filter</see> to apply.</param>
  7116. <remarks>The <paramref name="outputStream"/> is closed after creation.</remarks>
  7117. </member>
  7118. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.IO.Stream,System.String,System.Boolean,System.String,System.String,System.Boolean)">
  7119. <summary>
  7120. Create a zip archive sending output to the <paramref name="outputStream"/> passed.
  7121. </summary>
  7122. <param name="outputStream">The stream to write archive data to.</param>
  7123. <param name="sourceDirectory">The directory to source files from.</param>
  7124. <param name="recurse">True to recurse directories, false for no recursion.</param>
  7125. <param name="fileFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">file filter</see> to apply.</param>
  7126. <param name="directoryFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.PathFilter">directory filter</see> to apply.</param>
  7127. <param name="leaveOpen">true to leave <paramref name="outputStream"/> open after the zip has been created, false to dispose it.</param>
  7128. </member>
  7129. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.String,System.String,System.Boolean,ICSharpCode.SharpZipLib.Core.IScanFilter,ICSharpCode.SharpZipLib.Core.IScanFilter)">
  7130. <summary>
  7131. Create a zip file.
  7132. </summary>
  7133. <param name="zipFileName">The name of the zip file to create.</param>
  7134. <param name="sourceDirectory">The directory to source files from.</param>
  7135. <param name="recurse">True to recurse directories, false for no recursion.</param>
  7136. <param name="fileFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.IScanFilter">file filter</see> to apply.</param>
  7137. <param name="directoryFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.IScanFilter">directory filter</see> to apply.</param>
  7138. </member>
  7139. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.IO.Stream,System.String,System.Boolean,ICSharpCode.SharpZipLib.Core.IScanFilter,ICSharpCode.SharpZipLib.Core.IScanFilter,System.Boolean)">
  7140. <summary>
  7141. Create a zip archive sending output to the <paramref name="outputStream"/> passed.
  7142. </summary>
  7143. <param name="outputStream">The stream to write archive data to.</param>
  7144. <param name="sourceDirectory">The directory to source files from.</param>
  7145. <param name="recurse">True to recurse directories, false for no recursion.</param>
  7146. <param name="fileFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.IScanFilter">file filter</see> to apply.</param>
  7147. <param name="directoryFilter">The <see cref="T:ICSharpCode.SharpZipLib.Core.IScanFilter">directory filter</see> to apply.</param>
  7148. <param name="leaveOpen">true to leave <paramref name="outputStream"/> open after the zip has been created, false to dispose it.</param>
  7149. </member>
  7150. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.CreateZip(System.IO.Stream,System.String,System.Boolean,ICSharpCode.SharpZipLib.Core.FileSystemScanner,System.Boolean)">
  7151. <summary>
  7152. Create a zip archive sending output to the <paramref name="outputStream"/> passed.
  7153. </summary>
  7154. <param name="outputStream">The stream to write archive data to.</param>
  7155. <param name="sourceDirectory">The directory to source files from.</param>
  7156. <param name="recurse">True to recurse directories, false for no recursion.</param>
  7157. <param name="scanner">For performing the actual file system scan</param>
  7158. <param name="leaveOpen">true to leave <paramref name="outputStream"/> open after the zip has been created, false to dispose it.</param>
  7159. <remarks>The <paramref name="outputStream"/> is closed after creation.</remarks>
  7160. </member>
  7161. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.ExtractZip(System.String,System.String,System.String)">
  7162. <summary>
  7163. Extract the contents of a zip file.
  7164. </summary>
  7165. <param name="zipFileName">The zip file to extract from.</param>
  7166. <param name="targetDirectory">The directory to save extracted information in.</param>
  7167. <param name="fileFilter">A filter to apply to files.</param>
  7168. </member>
  7169. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.ExtractZip(System.String,System.String,ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite,ICSharpCode.SharpZipLib.Zip.FastZip.ConfirmOverwriteDelegate,System.String,System.String,System.Boolean,System.Boolean)">
  7170. <summary>
  7171. Extract the contents of a zip file.
  7172. </summary>
  7173. <param name="zipFileName">The zip file to extract from.</param>
  7174. <param name="targetDirectory">The directory to save extracted information in.</param>
  7175. <param name="overwrite">The style of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite">overwriting</see> to apply.</param>
  7176. <param name="confirmDelegate">A delegate to invoke when confirming overwriting.</param>
  7177. <param name="fileFilter">A filter to apply to files.</param>
  7178. <param name="directoryFilter">A filter to apply to directories.</param>
  7179. <param name="restoreDateTime">Flag indicating whether to restore the date and time for extracted files.</param>
  7180. <param name="allowParentTraversal">Allow parent directory traversal in file paths (e.g. ../file)</param>
  7181. </member>
  7182. <member name="M:ICSharpCode.SharpZipLib.Zip.FastZip.ExtractZip(System.IO.Stream,System.String,ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite,ICSharpCode.SharpZipLib.Zip.FastZip.ConfirmOverwriteDelegate,System.String,System.String,System.Boolean,System.Boolean,System.Boolean)">
  7183. <summary>
  7184. Extract the contents of a zip file held in a stream.
  7185. </summary>
  7186. <param name="inputStream">The seekable input stream containing the zip to extract from.</param>
  7187. <param name="targetDirectory">The directory to save extracted information in.</param>
  7188. <param name="overwrite">The style of <see cref="T:ICSharpCode.SharpZipLib.Zip.FastZip.Overwrite">overwriting</see> to apply.</param>
  7189. <param name="confirmDelegate">A delegate to invoke when confirming overwriting.</param>
  7190. <param name="fileFilter">A filter to apply to files.</param>
  7191. <param name="directoryFilter">A filter to apply to directories.</param>
  7192. <param name="restoreDateTime">Flag indicating whether to restore the date and time for extracted files.</param>
  7193. <param name="isStreamOwner">Flag indicating whether the inputStream will be closed by this method.</param>
  7194. <param name="allowParentTraversal">Allow parent directory traversal in file paths (e.g. ../file)</param>
  7195. </member>
  7196. <member name="T:ICSharpCode.SharpZipLib.Zip.IEntryFactory">
  7197. <summary>
  7198. Defines factory methods for creating new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"></see> values.
  7199. </summary>
  7200. </member>
  7201. <member name="M:ICSharpCode.SharpZipLib.Zip.IEntryFactory.MakeFileEntry(System.String)">
  7202. <summary>
  7203. Create a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for a file given its name
  7204. </summary>
  7205. <param name="fileName">The name of the file to create an entry for.</param>
  7206. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">file entry</see> based on the <paramref name="fileName"/> passed.</returns>
  7207. </member>
  7208. <member name="M:ICSharpCode.SharpZipLib.Zip.IEntryFactory.MakeFileEntry(System.String,System.Boolean)">
  7209. <summary>
  7210. Create a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for a file given its name
  7211. </summary>
  7212. <param name="fileName">The name of the file to create an entry for.</param>
  7213. <param name="useFileSystem">If true get details from the file system if the file exists.</param>
  7214. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">file entry</see> based on the <paramref name="fileName"/> passed.</returns>
  7215. </member>
  7216. <member name="M:ICSharpCode.SharpZipLib.Zip.IEntryFactory.MakeFileEntry(System.String,System.String,System.Boolean)">
  7217. <summary>
  7218. Create a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for a file given its actual name and optional override name
  7219. </summary>
  7220. <param name="fileName">The name of the file to create an entry for.</param>
  7221. <param name="entryName">An alternative name to be used for the new entry. Null if not applicable.</param>
  7222. <param name="useFileSystem">If true get details from the file system if the file exists.</param>
  7223. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">file entry</see> based on the <paramref name="fileName"/> passed.</returns>
  7224. </member>
  7225. <member name="M:ICSharpCode.SharpZipLib.Zip.IEntryFactory.MakeDirectoryEntry(System.String)">
  7226. <summary>
  7227. Create a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for a directory given its name
  7228. </summary>
  7229. <param name="directoryName">The name of the directory to create an entry for.</param>
  7230. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">directory entry</see> based on the <paramref name="directoryName"/> passed.</returns>
  7231. </member>
  7232. <member name="M:ICSharpCode.SharpZipLib.Zip.IEntryFactory.MakeDirectoryEntry(System.String,System.Boolean)">
  7233. <summary>
  7234. Create a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for a directory given its name
  7235. </summary>
  7236. <param name="directoryName">The name of the directory to create an entry for.</param>
  7237. <param name="useFileSystem">If true get details from the file system for this directory if it exists.</param>
  7238. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">directory entry</see> based on the <paramref name="directoryName"/> passed.</returns>
  7239. </member>
  7240. <member name="P:ICSharpCode.SharpZipLib.Zip.IEntryFactory.NameTransform">
  7241. <summary>
  7242. Get/set the <see cref="T:ICSharpCode.SharpZipLib.Core.INameTransform"></see> applicable.
  7243. </summary>
  7244. </member>
  7245. <member name="P:ICSharpCode.SharpZipLib.Zip.IEntryFactory.Setting">
  7246. <summary>
  7247. Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting"/> in use.
  7248. </summary>
  7249. </member>
  7250. <member name="P:ICSharpCode.SharpZipLib.Zip.IEntryFactory.FixedDateTime">
  7251. <summary>
  7252. Get the <see cref="T:System.DateTime"/> value to use when <see cref="P:ICSharpCode.SharpZipLib.Zip.IEntryFactory.Setting"/> is set to <see cref="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.Fixed"/>,
  7253. or if not specified, the value of <see cref="P:System.DateTime.Now"/> when the class was the initialized
  7254. </summary>
  7255. </member>
  7256. <member name="T:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform">
  7257. <summary>
  7258. WindowsNameTransform transforms <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> names to windows compatible ones.
  7259. </summary>
  7260. </member>
  7261. <member name="F:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.MaxPath">
  7262. <summary>
  7263. The maximum windows path name permitted.
  7264. </summary>
  7265. <remarks>This may not valid for all windows systems - CE?, etc but I cant find the equivalent in the CLR.</remarks>
  7266. </member>
  7267. <member name="F:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.InvalidEntryChars">
  7268. <summary>
  7269. In this case we need Windows' invalid path characters.
  7270. Path.GetInvalidPathChars() only returns a subset invalid on all platforms.
  7271. </summary>
  7272. </member>
  7273. <member name="M:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.#ctor(System.String,System.Boolean)">
  7274. <summary>
  7275. Initialises a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform"/>
  7276. </summary>
  7277. <param name="baseDirectory"></param>
  7278. <param name="allowParentTraversal">Allow parent directory traversal in file paths (e.g. ../file)</param>
  7279. </member>
  7280. <member name="M:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.#ctor">
  7281. <summary>
  7282. Initialise a default instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform"/>
  7283. </summary>
  7284. </member>
  7285. <member name="P:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.BaseDirectory">
  7286. <summary>
  7287. Gets or sets a value containing the target directory to prefix values with.
  7288. </summary>
  7289. </member>
  7290. <member name="P:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.AllowParentTraversal">
  7291. <summary>
  7292. Allow parent directory traversal in file paths (e.g. ../file)
  7293. </summary>
  7294. </member>
  7295. <member name="P:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.TrimIncomingPaths">
  7296. <summary>
  7297. Gets or sets a value indicating whether paths on incoming values should be removed.
  7298. </summary>
  7299. </member>
  7300. <member name="M:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.TransformDirectory(System.String)">
  7301. <summary>
  7302. Transform a Zip directory name to a windows directory name.
  7303. </summary>
  7304. <param name="name">The directory name to transform.</param>
  7305. <returns>The transformed name.</returns>
  7306. </member>
  7307. <member name="M:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.TransformFile(System.String)">
  7308. <summary>
  7309. Transform a Zip format file name to a windows style one.
  7310. </summary>
  7311. <param name="name">The file name to transform.</param>
  7312. <returns>The transformed name.</returns>
  7313. </member>
  7314. <member name="M:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.IsValidName(System.String)">
  7315. <summary>
  7316. Test a name to see if it is a valid name for a windows filename as extracted from a Zip archive.
  7317. </summary>
  7318. <param name="name">The name to test.</param>
  7319. <returns>Returns true if the name is a valid zip name; false otherwise.</returns>
  7320. <remarks>The filename isnt a true windows path in some fundamental ways like no absolute paths, no rooted paths etc.</remarks>
  7321. </member>
  7322. <member name="M:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.MakeValidName(System.String,System.Char)">
  7323. <summary>
  7324. Force a name to be valid by replacing invalid characters with a fixed value
  7325. </summary>
  7326. <param name="name">The name to make valid</param>
  7327. <param name="replacement">The replacement character to use for any invalid characters.</param>
  7328. <returns>Returns a valid name</returns>
  7329. </member>
  7330. <member name="P:ICSharpCode.SharpZipLib.Zip.WindowsNameTransform.Replacement">
  7331. <summary>
  7332. Gets or set the character to replace invalid characters during transformations.
  7333. </summary>
  7334. </member>
  7335. <member name="T:ICSharpCode.SharpZipLib.Zip.UseZip64">
  7336. <summary>
  7337. Determines how entries are tested to see if they should use Zip64 extensions or not.
  7338. </summary>
  7339. </member>
  7340. <member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.Off">
  7341. <summary>
  7342. Zip64 will not be forced on entries during processing.
  7343. </summary>
  7344. <remarks>An entry can have this overridden if required <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ForceZip64"></see></remarks>
  7345. </member>
  7346. <member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.On">
  7347. <summary>
  7348. Zip64 should always be used.
  7349. </summary>
  7350. </member>
  7351. <member name="F:ICSharpCode.SharpZipLib.Zip.UseZip64.Dynamic">
  7352. <summary>
  7353. #ZipLib will determine use based on entry values when added to archive.
  7354. </summary>
  7355. </member>
  7356. <member name="T:ICSharpCode.SharpZipLib.Zip.CompressionMethod">
  7357. <summary>
  7358. The kind of compression used for an entry in an archive
  7359. </summary>
  7360. </member>
  7361. <member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Stored">
  7362. <summary>
  7363. A direct copy of the file contents is held in the archive
  7364. </summary>
  7365. </member>
  7366. <member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Deflated">
  7367. <summary>
  7368. Common Zip compression method using a sliding dictionary
  7369. of up to 32KB and secondary compression from Huffman/Shannon-Fano trees
  7370. </summary>
  7371. </member>
  7372. <member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Deflate64">
  7373. <summary>
  7374. An extension to deflate with a 64KB window. Not supported by #Zip currently
  7375. </summary>
  7376. </member>
  7377. <member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.BZip2">
  7378. <summary>
  7379. BZip2 compression. Not supported by #Zip.
  7380. </summary>
  7381. </member>
  7382. <member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.LZMA">
  7383. <summary>
  7384. LZMA compression. Not supported by #Zip.
  7385. </summary>
  7386. </member>
  7387. <member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.PPMd">
  7388. <summary>
  7389. PPMd compression. Not supported by #Zip.
  7390. </summary>
  7391. </member>
  7392. <member name="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.WinZipAES">
  7393. <summary>
  7394. WinZip special for AES encryption, Now supported by #Zip.
  7395. </summary>
  7396. </member>
  7397. <member name="T:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm">
  7398. <summary>
  7399. Identifies the encryption algorithm used for an entry
  7400. </summary>
  7401. </member>
  7402. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.None">
  7403. <summary>
  7404. No encryption has been used.
  7405. </summary>
  7406. </member>
  7407. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.PkzipClassic">
  7408. <summary>
  7409. Encrypted using PKZIP 2.0 or 'classic' encryption.
  7410. </summary>
  7411. </member>
  7412. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Des">
  7413. <summary>
  7414. DES encryption has been used.
  7415. </summary>
  7416. </member>
  7417. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC2">
  7418. <summary>
  7419. RC2 encryption has been used for encryption.
  7420. </summary>
  7421. </member>
  7422. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.TripleDes168">
  7423. <summary>
  7424. Triple DES encryption with 168 bit keys has been used for this entry.
  7425. </summary>
  7426. </member>
  7427. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.TripleDes112">
  7428. <summary>
  7429. Triple DES with 112 bit keys has been used for this entry.
  7430. </summary>
  7431. </member>
  7432. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes128">
  7433. <summary>
  7434. AES 128 has been used for encryption.
  7435. </summary>
  7436. </member>
  7437. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes192">
  7438. <summary>
  7439. AES 192 has been used for encryption.
  7440. </summary>
  7441. </member>
  7442. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Aes256">
  7443. <summary>
  7444. AES 256 has been used for encryption.
  7445. </summary>
  7446. </member>
  7447. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC2Corrected">
  7448. <summary>
  7449. RC2 corrected has been used for encryption.
  7450. </summary>
  7451. </member>
  7452. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Blowfish">
  7453. <summary>
  7454. Blowfish has been used for encryption.
  7455. </summary>
  7456. </member>
  7457. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Twofish">
  7458. <summary>
  7459. Twofish has been used for encryption.
  7460. </summary>
  7461. </member>
  7462. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.RC4">
  7463. <summary>
  7464. RC4 has been used for encryption.
  7465. </summary>
  7466. </member>
  7467. <member name="F:ICSharpCode.SharpZipLib.Zip.EncryptionAlgorithm.Unknown">
  7468. <summary>
  7469. An unknown algorithm has been used for encryption.
  7470. </summary>
  7471. </member>
  7472. <member name="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags">
  7473. <summary>
  7474. Defines the contents of the general bit flags field for an archive entry.
  7475. </summary>
  7476. </member>
  7477. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Encrypted">
  7478. <summary>
  7479. Bit 0 if set indicates that the file is encrypted
  7480. </summary>
  7481. </member>
  7482. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Method">
  7483. <summary>
  7484. Bits 1 and 2 - Two bits defining the compression method (only for Method 6 Imploding and 8,9 Deflating)
  7485. </summary>
  7486. </member>
  7487. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Descriptor">
  7488. <summary>
  7489. Bit 3 if set indicates a trailing data descriptor is appended to the entry data
  7490. </summary>
  7491. </member>
  7492. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPKware4">
  7493. <summary>
  7494. Bit 4 is reserved for use with method 8 for enhanced deflation
  7495. </summary>
  7496. </member>
  7497. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Patched">
  7498. <summary>
  7499. Bit 5 if set indicates the file contains Pkzip compressed patched data.
  7500. Requires version 2.7 or greater.
  7501. </summary>
  7502. </member>
  7503. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.StrongEncryption">
  7504. <summary>
  7505. Bit 6 if set indicates strong encryption has been used for this entry.
  7506. </summary>
  7507. </member>
  7508. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused7">
  7509. <summary>
  7510. Bit 7 is currently unused
  7511. </summary>
  7512. </member>
  7513. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused8">
  7514. <summary>
  7515. Bit 8 is currently unused
  7516. </summary>
  7517. </member>
  7518. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused9">
  7519. <summary>
  7520. Bit 9 is currently unused
  7521. </summary>
  7522. </member>
  7523. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Unused10">
  7524. <summary>
  7525. Bit 10 is currently unused
  7526. </summary>
  7527. </member>
  7528. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.UnicodeText">
  7529. <summary>
  7530. Bit 11 if set indicates the filename and
  7531. comment fields for this file must be encoded using UTF-8.
  7532. </summary>
  7533. </member>
  7534. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.EnhancedCompress">
  7535. <summary>
  7536. Bit 12 is documented as being reserved by PKware for enhanced compression.
  7537. </summary>
  7538. </member>
  7539. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.HeaderMasked">
  7540. <summary>
  7541. Bit 13 if set indicates that values in the local header are masked to hide
  7542. their actual values, and the central directory is encrypted.
  7543. </summary>
  7544. <remarks>
  7545. Used when encrypting the central directory contents.
  7546. </remarks>
  7547. </member>
  7548. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPkware14">
  7549. <summary>
  7550. Bit 14 is documented as being reserved for use by PKware
  7551. </summary>
  7552. </member>
  7553. <member name="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.ReservedPkware15">
  7554. <summary>
  7555. Bit 15 is documented as being reserved for use by PKware
  7556. </summary>
  7557. </member>
  7558. <member name="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlagsExtensions">
  7559. <summary>
  7560. Helpers for <see cref="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags"/>
  7561. </summary>
  7562. </member>
  7563. <member name="M:ICSharpCode.SharpZipLib.Zip.GeneralBitFlagsExtensions.Includes(ICSharpCode.SharpZipLib.Zip.GeneralBitFlags,ICSharpCode.SharpZipLib.Zip.GeneralBitFlags)">
  7564. <summary>
  7565. This is equivalent of <see cref="M:System.Enum.HasFlag(System.Enum)"/> in .NET Core, but since the .NET FW
  7566. version is really slow (due to un-/boxing and reflection) we use this wrapper.
  7567. </summary>
  7568. <param name="flagData"></param>
  7569. <param name="flag"></param>
  7570. <returns></returns>
  7571. </member>
  7572. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipConstants">
  7573. <summary>
  7574. This class contains constants used for Zip format files
  7575. </summary>
  7576. </member>
  7577. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionMadeBy">
  7578. <summary>
  7579. The version made by field for entries in the central header when created by this library
  7580. </summary>
  7581. <remarks>
  7582. This is also the Zip version for the library when comparing against the version required to extract
  7583. for an entry. See <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CanDecompress"/>.
  7584. </remarks>
  7585. </member>
  7586. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VERSION_MADE_BY">
  7587. <summary>
  7588. The version made by field for entries in the central header when created by this library
  7589. </summary>
  7590. <remarks>
  7591. This is also the Zip version for the library when comparing against the version required to extract
  7592. for an entry. See <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CanDecompressEntry">ZipInputStream.CanDecompressEntry</see>.
  7593. </remarks>
  7594. </member>
  7595. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionStrongEncryption">
  7596. <summary>
  7597. The minimum version required to support strong encryption
  7598. </summary>
  7599. </member>
  7600. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VERSION_STRONG_ENCRYPTION">
  7601. <summary>
  7602. The minimum version required to support strong encryption
  7603. </summary>
  7604. </member>
  7605. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VERSION_AES">
  7606. <summary>
  7607. Version indicating AES encryption
  7608. </summary>
  7609. </member>
  7610. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionZip64">
  7611. <summary>
  7612. The version required for Zip64 extensions (4.5 or higher)
  7613. </summary>
  7614. </member>
  7615. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.VersionBZip2">
  7616. <summary>
  7617. The version required for BZip2 compression (4.6 or higher)
  7618. </summary>
  7619. </member>
  7620. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LocalHeaderBaseSize">
  7621. <summary>
  7622. Size of local entry header (excluding variable length fields at end)
  7623. </summary>
  7624. </member>
  7625. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LOCHDR">
  7626. <summary>
  7627. Size of local entry header (excluding variable length fields at end)
  7628. </summary>
  7629. </member>
  7630. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64DataDescriptorSize">
  7631. <summary>
  7632. Size of Zip64 data descriptor
  7633. </summary>
  7634. </member>
  7635. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.DataDescriptorSize">
  7636. <summary>
  7637. Size of data descriptor
  7638. </summary>
  7639. </member>
  7640. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EXTHDR">
  7641. <summary>
  7642. Size of data descriptor
  7643. </summary>
  7644. </member>
  7645. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderBaseSize">
  7646. <summary>
  7647. Size of central header entry (excluding variable fields)
  7648. </summary>
  7649. </member>
  7650. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENHDR">
  7651. <summary>
  7652. Size of central header entry
  7653. </summary>
  7654. </member>
  7655. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EndOfCentralRecordBaseSize">
  7656. <summary>
  7657. Size of end of central record (excluding variable fields)
  7658. </summary>
  7659. </member>
  7660. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ENDHDR">
  7661. <summary>
  7662. Size of end of central record (excluding variable fields)
  7663. </summary>
  7664. </member>
  7665. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CryptoHeaderSize">
  7666. <summary>
  7667. Size of 'classic' cryptographic header stored before any entry data
  7668. </summary>
  7669. </member>
  7670. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CRYPTO_HEADER_SIZE">
  7671. <summary>
  7672. Size of cryptographic header stored before entry data
  7673. </summary>
  7674. </member>
  7675. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64EndOfCentralDirectoryLocatorSize">
  7676. <summary>
  7677. The size of the Zip64 central directory locator.
  7678. </summary>
  7679. </member>
  7680. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LocalHeaderSignature">
  7681. <summary>
  7682. Signature for local entry header
  7683. </summary>
  7684. </member>
  7685. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.LOCSIG">
  7686. <summary>
  7687. Signature for local entry header
  7688. </summary>
  7689. </member>
  7690. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SpanningSignature">
  7691. <summary>
  7692. Signature for spanning entry
  7693. </summary>
  7694. </member>
  7695. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SPANNINGSIG">
  7696. <summary>
  7697. Signature for spanning entry
  7698. </summary>
  7699. </member>
  7700. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SpanningTempSignature">
  7701. <summary>
  7702. Signature for temporary spanning entry
  7703. </summary>
  7704. </member>
  7705. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.SPANTEMPSIG">
  7706. <summary>
  7707. Signature for temporary spanning entry
  7708. </summary>
  7709. </member>
  7710. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.DataDescriptorSignature">
  7711. <summary>
  7712. Signature for data descriptor
  7713. </summary>
  7714. <remarks>
  7715. This is only used where the length, Crc, or compressed size isnt known when the
  7716. entry is created and the output stream doesnt support seeking.
  7717. The local entry cannot be 'patched' with the correct values in this case
  7718. so the values are recorded after the data prefixed by this header, as well as in the central directory.
  7719. </remarks>
  7720. </member>
  7721. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EXTSIG">
  7722. <summary>
  7723. Signature for data descriptor
  7724. </summary>
  7725. <remarks>
  7726. This is only used where the length, Crc, or compressed size isnt known when the
  7727. entry is created and the output stream doesnt support seeking.
  7728. The local entry cannot be 'patched' with the correct values in this case
  7729. so the values are recorded after the data prefixed by this header, as well as in the central directory.
  7730. </remarks>
  7731. </member>
  7732. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENSIG">
  7733. <summary>
  7734. Signature for central header
  7735. </summary>
  7736. </member>
  7737. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderSignature">
  7738. <summary>
  7739. Signature for central header
  7740. </summary>
  7741. </member>
  7742. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64CentralFileHeaderSignature">
  7743. <summary>
  7744. Signature for Zip64 central file header
  7745. </summary>
  7746. </member>
  7747. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENSIG64">
  7748. <summary>
  7749. Signature for Zip64 central file header
  7750. </summary>
  7751. </member>
  7752. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.Zip64CentralDirLocatorSignature">
  7753. <summary>
  7754. Signature for Zip64 central directory locator
  7755. </summary>
  7756. </member>
  7757. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ArchiveExtraDataSignature">
  7758. <summary>
  7759. Signature for archive extra data signature (were headers are encrypted).
  7760. </summary>
  7761. </member>
  7762. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CentralHeaderDigitalSignature">
  7763. <summary>
  7764. Central header digital signature
  7765. </summary>
  7766. </member>
  7767. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.CENDIGITALSIG">
  7768. <summary>
  7769. Central header digital signature
  7770. </summary>
  7771. </member>
  7772. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.EndOfCentralDirectorySignature">
  7773. <summary>
  7774. End of central directory record signature
  7775. </summary>
  7776. </member>
  7777. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipConstants.ENDSIG">
  7778. <summary>
  7779. End of central directory record signature
  7780. </summary>
  7781. </member>
  7782. <member name="T:ICSharpCode.SharpZipLib.Zip.GenericBitFlagsExtensions">
  7783. <summary>
  7784. GeneralBitFlags helper extensions
  7785. </summary>
  7786. </member>
  7787. <member name="M:ICSharpCode.SharpZipLib.Zip.GenericBitFlagsExtensions.HasAny(ICSharpCode.SharpZipLib.Zip.GeneralBitFlags,ICSharpCode.SharpZipLib.Zip.GeneralBitFlags)">
  7788. <summary>
  7789. Efficiently check if any of the <see cref="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags">flags</see> are set without enum un-/boxing
  7790. </summary>
  7791. <param name="target"></param>
  7792. <param name="flags"></param>
  7793. <returns>Returns whether any of flags are set</returns>
  7794. </member>
  7795. <member name="M:ICSharpCode.SharpZipLib.Zip.GenericBitFlagsExtensions.HasAll(ICSharpCode.SharpZipLib.Zip.GeneralBitFlags,ICSharpCode.SharpZipLib.Zip.GeneralBitFlags)">
  7796. <summary>
  7797. Efficiently check if all the <see cref="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags">flags</see> are set without enum un-/boxing
  7798. </summary>
  7799. <param name="target"></param>
  7800. <param name="flags"></param>
  7801. <returns>Returns whether the flags are all set</returns>
  7802. </member>
  7803. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipEncryptionMethod">
  7804. <summary>
  7805. The method of encrypting entries when creating zip archives.
  7806. </summary>
  7807. </member>
  7808. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEncryptionMethod.None">
  7809. <summary>
  7810. No encryption will be used.
  7811. </summary>
  7812. </member>
  7813. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEncryptionMethod.ZipCrypto">
  7814. <summary>
  7815. Encrypt entries with ZipCrypto.
  7816. </summary>
  7817. </member>
  7818. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEncryptionMethod.AES128">
  7819. <summary>
  7820. Encrypt entries with AES 128.
  7821. </summary>
  7822. </member>
  7823. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEncryptionMethod.AES256">
  7824. <summary>
  7825. Encrypt entries with AES 256.
  7826. </summary>
  7827. </member>
  7828. <member name="T:ICSharpCode.SharpZipLib.Zip.HostSystemID">
  7829. <summary>
  7830. Defines known values for the <see cref="T:ICSharpCode.SharpZipLib.Zip.HostSystemID"/> property.
  7831. </summary>
  7832. </member>
  7833. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Msdos">
  7834. <summary>
  7835. Host system = MSDOS
  7836. </summary>
  7837. </member>
  7838. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Amiga">
  7839. <summary>
  7840. Host system = Amiga
  7841. </summary>
  7842. </member>
  7843. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.OpenVms">
  7844. <summary>
  7845. Host system = Open VMS
  7846. </summary>
  7847. </member>
  7848. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Unix">
  7849. <summary>
  7850. Host system = Unix
  7851. </summary>
  7852. </member>
  7853. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.VMCms">
  7854. <summary>
  7855. Host system = VMCms
  7856. </summary>
  7857. </member>
  7858. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.AtariST">
  7859. <summary>
  7860. Host system = Atari ST
  7861. </summary>
  7862. </member>
  7863. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.OS2">
  7864. <summary>
  7865. Host system = OS2
  7866. </summary>
  7867. </member>
  7868. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Macintosh">
  7869. <summary>
  7870. Host system = Macintosh
  7871. </summary>
  7872. </member>
  7873. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.ZSystem">
  7874. <summary>
  7875. Host system = ZSystem
  7876. </summary>
  7877. </member>
  7878. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Cpm">
  7879. <summary>
  7880. Host system = Cpm
  7881. </summary>
  7882. </member>
  7883. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.WindowsNT">
  7884. <summary>
  7885. Host system = Windows NT
  7886. </summary>
  7887. </member>
  7888. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.MVS">
  7889. <summary>
  7890. Host system = MVS
  7891. </summary>
  7892. </member>
  7893. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Vse">
  7894. <summary>
  7895. Host system = VSE
  7896. </summary>
  7897. </member>
  7898. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.AcornRisc">
  7899. <summary>
  7900. Host system = Acorn RISC
  7901. </summary>
  7902. </member>
  7903. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Vfat">
  7904. <summary>
  7905. Host system = VFAT
  7906. </summary>
  7907. </member>
  7908. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.AlternateMvs">
  7909. <summary>
  7910. Host system = Alternate MVS
  7911. </summary>
  7912. </member>
  7913. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.BeOS">
  7914. <summary>
  7915. Host system = BEOS
  7916. </summary>
  7917. </member>
  7918. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.Tandem">
  7919. <summary>
  7920. Host system = Tandem
  7921. </summary>
  7922. </member>
  7923. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.OS400">
  7924. <summary>
  7925. Host system = OS400
  7926. </summary>
  7927. </member>
  7928. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.OSX">
  7929. <summary>
  7930. Host system = OSX
  7931. </summary>
  7932. </member>
  7933. <member name="F:ICSharpCode.SharpZipLib.Zip.HostSystemID.WinZipAES">
  7934. <summary>
  7935. Host system = WinZIP AES
  7936. </summary>
  7937. </member>
  7938. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">
  7939. <summary>
  7940. This class represents an entry in a zip archive. This can be a file
  7941. or a directory
  7942. ZipFile and ZipInputStream will give you instances of this class as
  7943. information about the members in an archive. ZipOutputStream
  7944. uses an instance of this class when creating an entry in a Zip file.
  7945. <br/>
  7946. <br/>Author of the original java version : Jochen Hoenicke
  7947. </summary>
  7948. </member>
  7949. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.#ctor(System.String)">
  7950. <summary>
  7951. Creates a zip entry with the given name.
  7952. </summary>
  7953. <param name="name">
  7954. The name for this entry. Can include directory components.
  7955. The convention for names is 'unix' style paths with relative names only.
  7956. There are with no device names and path elements are separated by '/' characters.
  7957. </param>
  7958. <exception cref="T:System.ArgumentNullException">
  7959. The name passed is null
  7960. </exception>
  7961. </member>
  7962. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.#ctor(System.String,System.Int32)">
  7963. <summary>
  7964. Creates a zip entry with the given name and version required to extract
  7965. </summary>
  7966. <param name="name">
  7967. The name for this entry. Can include directory components.
  7968. The convention for names is 'unix' style paths with no device names and
  7969. path elements separated by '/' characters. This is not enforced see <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.CleanName(System.String)">CleanName</see>
  7970. on how to ensure names are valid if this is desired.
  7971. </param>
  7972. <param name="versionRequiredToExtract">
  7973. The minimum 'feature version' required this entry
  7974. </param>
  7975. <exception cref="T:System.ArgumentNullException">
  7976. The name passed is null
  7977. </exception>
  7978. </member>
  7979. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.#ctor(System.String,System.Int32,System.Int32,ICSharpCode.SharpZipLib.Zip.CompressionMethod,System.Boolean)">
  7980. <summary>
  7981. Initializes an entry with the given name and made by information
  7982. </summary>
  7983. <param name="name">Name for this entry</param>
  7984. <param name="madeByInfo">Version and HostSystem Information</param>
  7985. <param name="versionRequiredToExtract">Minimum required zip feature version required to extract this entry</param>
  7986. <param name="method">Compression method for this entry.</param>
  7987. <param name="unicode">Whether the entry uses unicode for name and comment</param>
  7988. <exception cref="T:System.ArgumentNullException">
  7989. The name passed is null
  7990. </exception>
  7991. <exception cref="T:System.ArgumentOutOfRangeException">
  7992. versionRequiredToExtract should be 0 (auto-calculate) or > 10
  7993. </exception>
  7994. <remarks>
  7995. This constructor is used by the ZipFile class when reading from the central header
  7996. It is not generally useful, use the constructor specifying the name only.
  7997. </remarks>
  7998. </member>
  7999. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.#ctor(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  8000. <summary>
  8001. Creates a deep copy of the given zip entry.
  8002. </summary>
  8003. <param name="entry">
  8004. The entry to copy.
  8005. </param>
  8006. </member>
  8007. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.HasCrc">
  8008. <summary>
  8009. Get a value indicating whether the entry has a CRC value available.
  8010. </summary>
  8011. </member>
  8012. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCrypted">
  8013. <summary>
  8014. Get/Set flag indicating if entry is encrypted.
  8015. A simple helper routine to aid interpretation of <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Flags">flags</see>
  8016. </summary>
  8017. <remarks>This is an assistant that interprets the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Flags">flags</see> property.</remarks>
  8018. </member>
  8019. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsUnicodeText">
  8020. <summary>
  8021. Get / set a flag indicating whether entry name and comment text are
  8022. encoded in <a href="http://www.unicode.org">unicode UTF8</a>.
  8023. </summary>
  8024. <remarks>This is an assistant that interprets the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Flags">flags</see> property.</remarks>
  8025. </member>
  8026. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CryptoCheckValue">
  8027. <summary>
  8028. Value used during password checking for PKZIP 2.0 / 'classic' encryption.
  8029. </summary>
  8030. </member>
  8031. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Flags">
  8032. <summary>
  8033. Get/Set general purpose bit flag for entry
  8034. </summary>
  8035. <remarks>
  8036. General purpose bit flag<br/>
  8037. <br/>
  8038. Bit 0: If set, indicates the file is encrypted<br/>
  8039. Bit 1-2 Only used for compression type 6 Imploding, and 8, 9 deflating<br/>
  8040. Imploding:<br/>
  8041. Bit 1 if set indicates an 8K sliding dictionary was used. If clear a 4k dictionary was used<br/>
  8042. Bit 2 if set indicates 3 Shannon-Fanno trees were used to encode the sliding dictionary, 2 otherwise<br/>
  8043. <br/>
  8044. Deflating:<br/>
  8045. Bit 2 Bit 1<br/>
  8046. 0 0 Normal compression was used<br/>
  8047. 0 1 Maximum compression was used<br/>
  8048. 1 0 Fast compression was used<br/>
  8049. 1 1 Super fast compression was used<br/>
  8050. <br/>
  8051. Bit 3: If set, the fields crc-32, compressed size
  8052. and uncompressed size are were not able to be written during zip file creation
  8053. The correct values are held in a data descriptor immediately following the compressed data. <br/>
  8054. Bit 4: Reserved for use by PKZIP for enhanced deflating<br/>
  8055. Bit 5: If set indicates the file contains compressed patch data<br/>
  8056. Bit 6: If set indicates strong encryption was used.<br/>
  8057. Bit 7-10: Unused or reserved<br/>
  8058. Bit 11: If set the name and comments for this entry are in <a href="http://www.unicode.org">unicode</a>.<br/>
  8059. Bit 12-15: Unused or reserved<br/>
  8060. </remarks>
  8061. <seealso cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsUnicodeText"></seealso>
  8062. <seealso cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCrypted"></seealso>
  8063. </member>
  8064. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.ZipFileIndex">
  8065. <summary>
  8066. Get/Set index of this entry in Zip file
  8067. </summary>
  8068. <remarks>This is only valid when the entry is part of a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"></see></remarks>
  8069. </member>
  8070. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Offset">
  8071. <summary>
  8072. Get/set offset for use in central header
  8073. </summary>
  8074. </member>
  8075. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.ExternalFileAttributes">
  8076. <summary>
  8077. Get/Set external file attributes as an integer.
  8078. The values of this are operating system dependent see
  8079. <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.HostSystem">HostSystem</see> for details
  8080. </summary>
  8081. </member>
  8082. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.VersionMadeBy">
  8083. <summary>
  8084. Get the version made by for this entry or zero if unknown.
  8085. The value / 10 indicates the major version number, and
  8086. the value mod 10 is the minor version number
  8087. </summary>
  8088. </member>
  8089. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsDOSEntry">
  8090. <summary>
  8091. Get a value indicating this entry is for a DOS/Windows system.
  8092. </summary>
  8093. </member>
  8094. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.HasDosAttributes(System.Int32)">
  8095. <summary>
  8096. Test the external attributes for this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> to
  8097. see if the external attributes are Dos based (including WINNT and variants)
  8098. and match the values
  8099. </summary>
  8100. <param name="attributes">The attributes to test.</param>
  8101. <returns>Returns true if the external attributes are known to be DOS/Windows
  8102. based and have the same attributes set as the value passed.</returns>
  8103. </member>
  8104. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.HostSystem">
  8105. <summary>
  8106. Gets the compatibility information for the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.ExternalFileAttributes">external file attribute</see>
  8107. If the external file attributes are compatible with MS-DOS and can be read
  8108. by PKZIP for DOS version 2.04g then this value will be zero. Otherwise the value
  8109. will be non-zero and identify the host system on which the attributes are compatible.
  8110. </summary>
  8111. <remarks>
  8112. The values for this as defined in the Zip File format and by others are shown below. The values are somewhat
  8113. misleading in some cases as they are not all used as shown. You should consult the relevant documentation
  8114. to obtain up to date and correct information. The modified appnote by the infozip group is
  8115. particularly helpful as it documents a lot of peculiarities. The document is however a little dated.
  8116. <list type="table">
  8117. <item>0 - MS-DOS and OS/2 (FAT / VFAT / FAT32 file systems)</item>
  8118. <item>1 - Amiga</item>
  8119. <item>2 - OpenVMS</item>
  8120. <item>3 - Unix</item>
  8121. <item>4 - VM/CMS</item>
  8122. <item>5 - Atari ST</item>
  8123. <item>6 - OS/2 HPFS</item>
  8124. <item>7 - Macintosh</item>
  8125. <item>8 - Z-System</item>
  8126. <item>9 - CP/M</item>
  8127. <item>10 - Windows NTFS</item>
  8128. <item>11 - MVS (OS/390 - Z/OS)</item>
  8129. <item>12 - VSE</item>
  8130. <item>13 - Acorn Risc</item>
  8131. <item>14 - VFAT</item>
  8132. <item>15 - Alternate MVS</item>
  8133. <item>16 - BeOS</item>
  8134. <item>17 - Tandem</item>
  8135. <item>18 - OS/400</item>
  8136. <item>19 - OS/X (Darwin)</item>
  8137. <item>99 - WinZip AES</item>
  8138. <item>remainder - unused</item>
  8139. </list>
  8140. </remarks>
  8141. </member>
  8142. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Version">
  8143. <summary>
  8144. Get minimum Zip feature version required to extract this entry
  8145. </summary>
  8146. <remarks>
  8147. Minimum features are defined as:<br/>
  8148. 1.0 - Default value<br/>
  8149. 1.1 - File is a volume label<br/>
  8150. 2.0 - File is a folder/directory<br/>
  8151. 2.0 - File is compressed using Deflate compression<br/>
  8152. 2.0 - File is encrypted using traditional encryption<br/>
  8153. 2.1 - File is compressed using Deflate64<br/>
  8154. 2.5 - File is compressed using PKWARE DCL Implode<br/>
  8155. 2.7 - File is a patch data set<br/>
  8156. 4.5 - File uses Zip64 format extensions<br/>
  8157. 4.6 - File is compressed using BZIP2 compression<br/>
  8158. 5.0 - File is encrypted using DES<br/>
  8159. 5.0 - File is encrypted using 3DES<br/>
  8160. 5.0 - File is encrypted using original RC2 encryption<br/>
  8161. 5.0 - File is encrypted using RC4 encryption<br/>
  8162. 5.1 - File is encrypted using AES encryption<br/>
  8163. 5.1 - File is encrypted using corrected RC2 encryption<br/>
  8164. 5.1 - File is encrypted using corrected RC2-64 encryption<br/>
  8165. 6.1 - File is encrypted using non-OAEP key wrapping<br/>
  8166. 6.2 - Central directory encryption (not confirmed yet)<br/>
  8167. 6.3 - File is compressed using LZMA<br/>
  8168. 6.3 - File is compressed using PPMD+<br/>
  8169. 6.3 - File is encrypted using Blowfish<br/>
  8170. 6.3 - File is encrypted using Twofish<br/>
  8171. </remarks>
  8172. <seealso cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CanDecompress"></seealso>
  8173. </member>
  8174. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CanDecompress">
  8175. <summary>
  8176. Get a value indicating whether this entry can be decompressed by the library.
  8177. </summary>
  8178. <remarks>This is based on the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Version"></see> and
  8179. whether the <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCompressionMethodSupported">compression method</see> is supported.</remarks>
  8180. </member>
  8181. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ForceZip64">
  8182. <summary>
  8183. Force this entry to be recorded using Zip64 extensions.
  8184. </summary>
  8185. </member>
  8186. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsZip64Forced">
  8187. <summary>
  8188. Get a value indicating whether Zip64 extensions were forced.
  8189. </summary>
  8190. <returns>A <see cref="T:System.Boolean"/> value of true if Zip64 extensions have been forced on; false if not.</returns>
  8191. </member>
  8192. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.LocalHeaderRequiresZip64">
  8193. <summary>
  8194. Gets a value indicating if the entry requires Zip64 extensions
  8195. to store the full entry values.
  8196. </summary>
  8197. <value>A <see cref="T:System.Boolean"/> value of true if a local header requires Zip64 extensions; false if not.</value>
  8198. </member>
  8199. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CentralHeaderRequiresZip64">
  8200. <summary>
  8201. Get a value indicating whether the central directory entry requires Zip64 extensions to be stored.
  8202. </summary>
  8203. </member>
  8204. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DosTime">
  8205. <summary>
  8206. Get/Set DosTime value.
  8207. </summary>
  8208. <remarks>
  8209. The MS-DOS date format can only represent dates between 1/1/1980 and 12/31/2107.
  8210. </remarks>
  8211. </member>
  8212. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DateTime">
  8213. <summary>
  8214. Gets/Sets the time of last modification of the entry.
  8215. </summary>
  8216. <remarks>
  8217. The <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DosTime"></see> property is updated to match this as far as possible.
  8218. </remarks>
  8219. </member>
  8220. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Name">
  8221. <summary>
  8222. Returns the entry name.
  8223. </summary>
  8224. <remarks>
  8225. The unix naming convention is followed.
  8226. Path components in the entry should always separated by forward slashes ('/').
  8227. Dos device names like C: should also be removed.
  8228. See the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform"/> class, or <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.CleanName(System.String)"/>
  8229. </remarks>
  8230. </member>
  8231. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Size">
  8232. <summary>
  8233. Gets/Sets the size of the uncompressed data.
  8234. </summary>
  8235. <returns>
  8236. The size or -1 if unknown.
  8237. </returns>
  8238. <remarks>Setting the size before adding an entry to an archive can help
  8239. avoid compatibility problems with some archivers which don't understand Zip64 extensions.</remarks>
  8240. </member>
  8241. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CompressedSize">
  8242. <summary>
  8243. Gets/Sets the size of the compressed data.
  8244. </summary>
  8245. <returns>
  8246. The compressed entry size or -1 if unknown.
  8247. </returns>
  8248. </member>
  8249. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Crc">
  8250. <summary>
  8251. Gets/Sets the crc of the uncompressed data.
  8252. </summary>
  8253. <exception cref="T:System.ArgumentOutOfRangeException">
  8254. Crc is not in the range 0..0xffffffffL
  8255. </exception>
  8256. <returns>
  8257. The crc value or -1 if unknown.
  8258. </returns>
  8259. </member>
  8260. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CompressionMethod">
  8261. <summary>
  8262. Gets/Sets the compression method.
  8263. </summary>
  8264. <returns>
  8265. The compression method for this entry
  8266. </returns>
  8267. </member>
  8268. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CompressionMethodForHeader">
  8269. <summary>
  8270. Gets the compression method for outputting to the local or central header.
  8271. Returns same value as CompressionMethod except when AES encrypting, which
  8272. places 99 in the method and places the real method in the extra data.
  8273. </summary>
  8274. </member>
  8275. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.ExtraData">
  8276. <summary>
  8277. Gets/Sets the extra data.
  8278. </summary>
  8279. <exception cref="T:System.ArgumentOutOfRangeException">
  8280. Extra data is longer than 64KB (0xffff) bytes.
  8281. </exception>
  8282. <returns>
  8283. Extra data or null if not set.
  8284. </returns>
  8285. </member>
  8286. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.AESKeySize">
  8287. <summary>
  8288. For AES encrypted files returns or sets the number of bits of encryption (128, 192 or 256).
  8289. When setting, only 0 (off), 128 or 256 is supported.
  8290. </summary>
  8291. </member>
  8292. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.AESEncryptionStrength">
  8293. <summary>
  8294. AES Encryption strength for storage in extra data in entry header.
  8295. 1 is 128 bit, 2 is 192 bit, 3 is 256 bit.
  8296. </summary>
  8297. </member>
  8298. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.AESSaltLen">
  8299. <summary>
  8300. Returns the length of the salt, in bytes
  8301. </summary>
  8302. Key size -> Salt length: 128 bits = 8 bytes, 192 bits = 12 bytes, 256 bits = 16 bytes.
  8303. </member>
  8304. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.AESOverheadSize">
  8305. <summary>
  8306. Number of extra bytes required to hold the AES Header fields (Salt, Pwd verify, AuthCode)
  8307. </summary>
  8308. File format:
  8309. Bytes | Content
  8310. ---------+---------------------------
  8311. Variable | Salt value
  8312. 2 | Password verification value
  8313. Variable | Encrypted file data
  8314. 10 | Authentication code
  8315. </member>
  8316. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.EncryptionOverheadSize">
  8317. <summary>
  8318. Number of extra bytes required to hold the encryption header fields.
  8319. </summary>
  8320. </member>
  8321. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ProcessExtraData(System.Boolean)">
  8322. <summary>
  8323. Process extra data fields updating the entry based on the contents.
  8324. </summary>
  8325. <param name="localHeader">True if the extra data fields should be handled
  8326. for a local header, rather than for a central header.
  8327. </param>
  8328. </member>
  8329. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Comment">
  8330. <summary>
  8331. Gets/Sets the entry comment.
  8332. </summary>
  8333. <exception cref="T:System.ArgumentOutOfRangeException">
  8334. If comment is longer than 0xffff.
  8335. </exception>
  8336. <returns>
  8337. The comment or null if not set.
  8338. </returns>
  8339. <remarks>
  8340. A comment is only available for entries when read via the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> class.
  8341. The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream"/> class doesn't have the comment data available.
  8342. </remarks>
  8343. </member>
  8344. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsDirectory">
  8345. <summary>
  8346. Gets a value indicating if the entry is a directory.
  8347. however.
  8348. </summary>
  8349. <remarks>
  8350. A directory is determined by an entry name with a trailing slash '/'.
  8351. The external file attributes can also indicate an entry is for a directory.
  8352. Currently only dos/windows attributes are tested in this manner.
  8353. The trailing slash convention should always be followed.
  8354. </remarks>
  8355. </member>
  8356. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsFile">
  8357. <summary>
  8358. Get a value of true if the entry appears to be a file; false otherwise
  8359. </summary>
  8360. <remarks>
  8361. This only takes account of DOS/Windows attributes. Other operating systems are ignored.
  8362. For linux and others the result may be incorrect.
  8363. </remarks>
  8364. </member>
  8365. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCompressionMethodSupported">
  8366. <summary>
  8367. Test entry to see if data can be extracted.
  8368. </summary>
  8369. <returns>Returns true if data can be extracted for this entry; false otherwise.</returns>
  8370. </member>
  8371. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.Clone">
  8372. <summary>
  8373. Creates a copy of this zip entry.
  8374. </summary>
  8375. <returns>An <see cref="T:System.Object"/> that is a copy of the current instance.</returns>
  8376. </member>
  8377. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.ToString">
  8378. <summary>
  8379. Gets a string representation of this ZipEntry.
  8380. </summary>
  8381. <returns>A readable textual representation of this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/></returns>
  8382. </member>
  8383. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.IsCompressionMethodSupported(ICSharpCode.SharpZipLib.Zip.CompressionMethod)">
  8384. <summary>
  8385. Test a <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.CompressionMethod">compression method</see> to see if this library
  8386. supports extracting data compressed with that method
  8387. </summary>
  8388. <param name="method">The compression method to test.</param>
  8389. <returns>Returns true if the compression method is supported; false otherwise</returns>
  8390. </member>
  8391. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntry.CleanName(System.String)">
  8392. <summary>
  8393. Cleans a name making it conform to Zip file conventions.
  8394. Devices names ('c:\') and UNC share names ('\\server\share') are removed
  8395. and back slashes ('\') are converted to forward slashes ('/').
  8396. Names are made relative by trimming leading slashes which is compatible
  8397. with the ZIP naming convention.
  8398. </summary>
  8399. <param name="name">The name to clean</param>
  8400. <returns>The 'cleaned' name.</returns>
  8401. <remarks>
  8402. The <seealso cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform">Zip name transform</seealso> class is more flexible.
  8403. </remarks>
  8404. </member>
  8405. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipEntryExtensions">
  8406. <summary>
  8407. General ZipEntry helper extensions
  8408. </summary>
  8409. </member>
  8410. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryExtensions.HasFlag(ICSharpCode.SharpZipLib.Zip.ZipEntry,ICSharpCode.SharpZipLib.Zip.GeneralBitFlags)">
  8411. <summary>
  8412. Efficiently check if a <see cref="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags">flag</see> is set without enum un-/boxing
  8413. </summary>
  8414. <param name="entry"></param>
  8415. <param name="flag"></param>
  8416. <returns>Returns whether the flag was set</returns>
  8417. </member>
  8418. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryExtensions.SetFlag(ICSharpCode.SharpZipLib.Zip.ZipEntry,ICSharpCode.SharpZipLib.Zip.GeneralBitFlags,System.Boolean)">
  8419. <summary>
  8420. Efficiently set a <see cref="T:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags">flag</see> without enum un-/boxing
  8421. </summary>
  8422. <param name="entry"></param>
  8423. <param name="flag"></param>
  8424. <param name="enabled">Whether the passed flag should be set (1) or cleared (0)</param>
  8425. </member>
  8426. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory">
  8427. <summary>
  8428. Basic implementation of <see cref="T:ICSharpCode.SharpZipLib.Zip.IEntryFactory"></see>
  8429. </summary>
  8430. </member>
  8431. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting">
  8432. <summary>
  8433. Defines the possible values to be used for the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DateTime"/>.
  8434. </summary>
  8435. </member>
  8436. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.LastWriteTime">
  8437. <summary>
  8438. Use the recorded LastWriteTime value for the file.
  8439. </summary>
  8440. </member>
  8441. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.LastWriteTimeUtc">
  8442. <summary>
  8443. Use the recorded LastWriteTimeUtc value for the file
  8444. </summary>
  8445. </member>
  8446. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.CreateTime">
  8447. <summary>
  8448. Use the recorded CreateTime value for the file.
  8449. </summary>
  8450. </member>
  8451. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.CreateTimeUtc">
  8452. <summary>
  8453. Use the recorded CreateTimeUtc value for the file.
  8454. </summary>
  8455. </member>
  8456. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.LastAccessTime">
  8457. <summary>
  8458. Use the recorded LastAccessTime value for the file.
  8459. </summary>
  8460. </member>
  8461. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.LastAccessTimeUtc">
  8462. <summary>
  8463. Use the recorded LastAccessTimeUtc value for the file.
  8464. </summary>
  8465. </member>
  8466. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.Fixed">
  8467. <summary>
  8468. Use a fixed value.
  8469. </summary>
  8470. <remarks>The actual <see cref="T:System.DateTime"/> value used can be
  8471. specified via the <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.#ctor(System.DateTime)"/> constructor or
  8472. using the <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.#ctor(ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting)"/> with the setting set
  8473. to <see cref="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.Fixed"/> which will use the <see cref="T:System.DateTime"/> when this class was constructed.
  8474. The <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.FixedDateTime"/> property can also be used to set this value.</remarks>
  8475. </member>
  8476. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.#ctor">
  8477. <summary>
  8478. Initialise a new instance of the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory"/> class.
  8479. </summary>
  8480. <remarks>A default <see cref="T:ICSharpCode.SharpZipLib.Core.INameTransform"/>, and the LastWriteTime for files is used.</remarks>
  8481. </member>
  8482. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.#ctor(ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting)">
  8483. <summary>
  8484. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory"/> using the specified <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting"/>
  8485. </summary>
  8486. <param name="timeSetting">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting">time setting</see> to use when creating <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">Zip entries</see>.</param>
  8487. </member>
  8488. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.#ctor(System.DateTime)">
  8489. <summary>
  8490. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory"/> using the specified <see cref="T:System.DateTime"/>
  8491. </summary>
  8492. <param name="time">The time to set all <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.DateTime"/> values to.</param>
  8493. </member>
  8494. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.NameTransform">
  8495. <summary>
  8496. Get / set the <see cref="T:ICSharpCode.SharpZipLib.Core.INameTransform"/> to be used when creating new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> values.
  8497. </summary>
  8498. <remarks>
  8499. Setting this property to null will cause a default <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform">name transform</see> to be used.
  8500. </remarks>
  8501. </member>
  8502. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.Setting">
  8503. <summary>
  8504. Get / set the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting"/> in use.
  8505. </summary>
  8506. </member>
  8507. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.FixedDateTime">
  8508. <summary>
  8509. Get / set the <see cref="T:System.DateTime"/> value to use when <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.Setting"/> is set to <see cref="F:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.TimeSetting.Fixed"/>
  8510. </summary>
  8511. </member>
  8512. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.GetAttributes">
  8513. <summary>
  8514. A bitmask defining the attributes to be retrieved from the actual file.
  8515. </summary>
  8516. <remarks>The default is to get all possible attributes from the actual file.</remarks>
  8517. </member>
  8518. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.SetAttributes">
  8519. <summary>
  8520. A bitmask defining which attributes are to be set on.
  8521. </summary>
  8522. <remarks>By default no attributes are set on.</remarks>
  8523. </member>
  8524. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.IsUnicodeText">
  8525. <summary>
  8526. Get set a value indicating whether unicode text should be set on.
  8527. </summary>
  8528. </member>
  8529. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.MakeFileEntry(System.String)">
  8530. <summary>
  8531. Make a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for a file.
  8532. </summary>
  8533. <param name="fileName">The name of the file to create a new entry for.</param>
  8534. <returns>Returns a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> based on the <paramref name="fileName"/>.</returns>
  8535. </member>
  8536. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.MakeFileEntry(System.String,System.Boolean)">
  8537. <summary>
  8538. Make a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for a file.
  8539. </summary>
  8540. <param name="fileName">The name of the file to create a new entry for.</param>
  8541. <param name="useFileSystem">If true entry detail is retrieved from the file system if the file exists.</param>
  8542. <returns>Returns a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> based on the <paramref name="fileName"/>.</returns>
  8543. </member>
  8544. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.MakeFileEntry(System.String,System.String,System.Boolean)">
  8545. <summary>
  8546. Make a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> from a name.
  8547. </summary>
  8548. <param name="fileName">The name of the file to create a new entry for.</param>
  8549. <param name="entryName">An alternative name to be used for the new entry. Null if not applicable.</param>
  8550. <param name="useFileSystem">If true entry detail is retrieved from the file system if the file exists.</param>
  8551. <returns>Returns a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> based on the <paramref name="fileName"/>.</returns>
  8552. </member>
  8553. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.MakeDirectoryEntry(System.String)">
  8554. <summary>
  8555. Make a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"></see> for a directory.
  8556. </summary>
  8557. <param name="directoryName">The raw untransformed name for the new directory</param>
  8558. <returns>Returns a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"></see> representing a directory.</returns>
  8559. </member>
  8560. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipEntryFactory.MakeDirectoryEntry(System.String,System.Boolean)">
  8561. <summary>
  8562. Make a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"></see> for a directory.
  8563. </summary>
  8564. <param name="directoryName">The raw untransformed name for the new directory</param>
  8565. <param name="useFileSystem">If true entry detail is retrieved from the file system if the file exists.</param>
  8566. <returns>Returns a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"></see> representing a directory.</returns>
  8567. </member>
  8568. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  8569. <summary>
  8570. ZipException represents exceptions specific to Zip classes and code.
  8571. </summary>
  8572. </member>
  8573. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor">
  8574. <summary>
  8575. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipException" />.
  8576. </summary>
  8577. </member>
  8578. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor(System.String)">
  8579. <summary>
  8580. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipException" /> with its message string.
  8581. </summary>
  8582. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  8583. </member>
  8584. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor(System.String,System.Exception)">
  8585. <summary>
  8586. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipException" />.
  8587. </summary>
  8588. <param name="message">A <see cref="T:System.String"/> that describes the error.</param>
  8589. <param name="innerException">The <see cref="T:System.Exception"/> that caused this exception.</param>
  8590. </member>
  8591. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8592. <summary>
  8593. Initializes a new instance of the ZipException class with serialized data.
  8594. </summary>
  8595. <param name="info">
  8596. The System.Runtime.Serialization.SerializationInfo that holds the serialized
  8597. object data about the exception being thrown.
  8598. </param>
  8599. <param name="context">
  8600. The System.Runtime.Serialization.StreamingContext that contains contextual information
  8601. about the source or destination.
  8602. </param>
  8603. </member>
  8604. <member name="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">
  8605. <summary>
  8606. ExtraData tagged value interface.
  8607. </summary>
  8608. </member>
  8609. <member name="P:ICSharpCode.SharpZipLib.Zip.ITaggedData.TagID">
  8610. <summary>
  8611. Get the ID for this tagged data value.
  8612. </summary>
  8613. </member>
  8614. <member name="M:ICSharpCode.SharpZipLib.Zip.ITaggedData.SetData(System.Byte[],System.Int32,System.Int32)">
  8615. <summary>
  8616. Set the contents of this instance from the data passed.
  8617. </summary>
  8618. <param name="data">The data to extract contents from.</param>
  8619. <param name="offset">The offset to begin extracting data from.</param>
  8620. <param name="count">The number of bytes to extract.</param>
  8621. </member>
  8622. <member name="M:ICSharpCode.SharpZipLib.Zip.ITaggedData.GetData">
  8623. <summary>
  8624. Get the data representing this instance.
  8625. </summary>
  8626. <returns>Returns the data for this instance.</returns>
  8627. </member>
  8628. <member name="T:ICSharpCode.SharpZipLib.Zip.RawTaggedData">
  8629. <summary>
  8630. A raw binary tagged value
  8631. </summary>
  8632. </member>
  8633. <member name="M:ICSharpCode.SharpZipLib.Zip.RawTaggedData.#ctor(System.UInt16)">
  8634. <summary>
  8635. Initialise a new instance.
  8636. </summary>
  8637. <param name="tag">The tag ID.</param>
  8638. </member>
  8639. <member name="P:ICSharpCode.SharpZipLib.Zip.RawTaggedData.TagID">
  8640. <summary>
  8641. Get the ID for this tagged data value.
  8642. </summary>
  8643. </member>
  8644. <member name="M:ICSharpCode.SharpZipLib.Zip.RawTaggedData.SetData(System.Byte[],System.Int32,System.Int32)">
  8645. <summary>
  8646. Set the data from the raw values provided.
  8647. </summary>
  8648. <param name="data">The raw data to extract values from.</param>
  8649. <param name="offset">The index to start extracting values from.</param>
  8650. <param name="count">The number of bytes available.</param>
  8651. </member>
  8652. <member name="M:ICSharpCode.SharpZipLib.Zip.RawTaggedData.GetData">
  8653. <summary>
  8654. Get the binary data representing this instance.
  8655. </summary>
  8656. <returns>The raw binary data representing this instance.</returns>
  8657. </member>
  8658. <member name="P:ICSharpCode.SharpZipLib.Zip.RawTaggedData.Data">
  8659. <summary>
  8660. Get /set the binary data representing this instance.
  8661. </summary>
  8662. <returns>The raw binary data representing this instance.</returns>
  8663. </member>
  8664. <member name="F:ICSharpCode.SharpZipLib.Zip.RawTaggedData._tag">
  8665. <summary>
  8666. The tag ID for this instance.
  8667. </summary>
  8668. </member>
  8669. <member name="T:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData">
  8670. <summary>
  8671. Class representing extended unix date time values.
  8672. </summary>
  8673. </member>
  8674. <member name="T:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags">
  8675. <summary>
  8676. Flags indicate which values are included in this instance.
  8677. </summary>
  8678. </member>
  8679. <member name="F:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags.ModificationTime">
  8680. <summary>
  8681. The modification time is included
  8682. </summary>
  8683. </member>
  8684. <member name="F:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags.AccessTime">
  8685. <summary>
  8686. The access time is included
  8687. </summary>
  8688. </member>
  8689. <member name="F:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags.CreateTime">
  8690. <summary>
  8691. The create time is included.
  8692. </summary>
  8693. </member>
  8694. <member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.TagID">
  8695. <summary>
  8696. Get the ID
  8697. </summary>
  8698. </member>
  8699. <member name="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.SetData(System.Byte[],System.Int32,System.Int32)">
  8700. <summary>
  8701. Set the data from the raw values provided.
  8702. </summary>
  8703. <param name="data">The raw data to extract values from.</param>
  8704. <param name="index">The index to start extracting values from.</param>
  8705. <param name="count">The number of bytes available.</param>
  8706. </member>
  8707. <member name="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.GetData">
  8708. <summary>
  8709. Get the binary data representing this instance.
  8710. </summary>
  8711. <returns>The raw binary data representing this instance.</returns>
  8712. </member>
  8713. <member name="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.IsValidValue(System.DateTime)">
  8714. <summary>
  8715. Test a <see cref="T:System.DateTime"> value to see if is valid and can be represented here.</see>
  8716. </summary>
  8717. <param name="value">The <see cref="T:System.DateTime">value</see> to test.</param>
  8718. <returns>Returns true if the value is valid and can be represented; false if not.</returns>
  8719. <remarks>The standard Unix time is a signed integer data type, directly encoding the Unix time number,
  8720. which is the number of seconds since 1970-01-01.
  8721. Being 32 bits means the values here cover a range of about 136 years.
  8722. The minimum representable time is 1901-12-13 20:45:52,
  8723. and the maximum representable time is 2038-01-19 03:14:07.
  8724. </remarks>
  8725. </member>
  8726. <member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.ModificationTime">
  8727. <summary>
  8728. Get /set the Modification Time
  8729. </summary>
  8730. <exception cref="T:System.ArgumentOutOfRangeException"></exception>
  8731. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.IsValidValue(System.DateTime)"></seealso>
  8732. </member>
  8733. <member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.AccessTime">
  8734. <summary>
  8735. Get / set the Access Time
  8736. </summary>
  8737. <exception cref="T:System.ArgumentOutOfRangeException"></exception>
  8738. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.IsValidValue(System.DateTime)"></seealso>
  8739. </member>
  8740. <member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.CreateTime">
  8741. <summary>
  8742. Get / Set the Create Time
  8743. </summary>
  8744. <exception cref="T:System.ArgumentOutOfRangeException"></exception>
  8745. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.IsValidValue(System.DateTime)"></seealso>
  8746. </member>
  8747. <member name="P:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Include">
  8748. <summary>
  8749. Get/set the <see cref="T:ICSharpCode.SharpZipLib.Zip.ExtendedUnixData.Flags">values</see> to include.
  8750. </summary>
  8751. </member>
  8752. <member name="T:ICSharpCode.SharpZipLib.Zip.NTTaggedData">
  8753. <summary>
  8754. Class handling NT date time values.
  8755. </summary>
  8756. </member>
  8757. <member name="P:ICSharpCode.SharpZipLib.Zip.NTTaggedData.TagID">
  8758. <summary>
  8759. Get the ID for this tagged data value.
  8760. </summary>
  8761. </member>
  8762. <member name="M:ICSharpCode.SharpZipLib.Zip.NTTaggedData.SetData(System.Byte[],System.Int32,System.Int32)">
  8763. <summary>
  8764. Set the data from the raw values provided.
  8765. </summary>
  8766. <param name="data">The raw data to extract values from.</param>
  8767. <param name="index">The index to start extracting values from.</param>
  8768. <param name="count">The number of bytes available.</param>
  8769. </member>
  8770. <member name="M:ICSharpCode.SharpZipLib.Zip.NTTaggedData.GetData">
  8771. <summary>
  8772. Get the binary data representing this instance.
  8773. </summary>
  8774. <returns>The raw binary data representing this instance.</returns>
  8775. </member>
  8776. <member name="M:ICSharpCode.SharpZipLib.Zip.NTTaggedData.IsValidValue(System.DateTime)">
  8777. <summary>
  8778. Test a <see cref="T:System.DateTime"> valuie to see if is valid and can be represented here.</see>
  8779. </summary>
  8780. <param name="value">The <see cref="T:System.DateTime">value</see> to test.</param>
  8781. <returns>Returns true if the value is valid and can be represented; false if not.</returns>
  8782. <remarks>
  8783. NTFS filetimes are 64-bit unsigned integers, stored in Intel
  8784. (least significant byte first) byte order. They determine the
  8785. number of 1.0E-07 seconds (1/10th microseconds!) past WinNT "epoch",
  8786. which is "01-Jan-1601 00:00:00 UTC". 28 May 60056 is the upper limit
  8787. </remarks>
  8788. </member>
  8789. <member name="P:ICSharpCode.SharpZipLib.Zip.NTTaggedData.LastModificationTime">
  8790. <summary>
  8791. Get/set the <see cref="T:System.DateTime">last modification time</see>.
  8792. </summary>
  8793. </member>
  8794. <member name="P:ICSharpCode.SharpZipLib.Zip.NTTaggedData.CreateTime">
  8795. <summary>
  8796. Get /set the <see cref="T:System.DateTime">create time</see>
  8797. </summary>
  8798. </member>
  8799. <member name="P:ICSharpCode.SharpZipLib.Zip.NTTaggedData.LastAccessTime">
  8800. <summary>
  8801. Get /set the <see cref="T:System.DateTime">last access time</see>.
  8802. </summary>
  8803. </member>
  8804. <member name="T:ICSharpCode.SharpZipLib.Zip.ITaggedDataFactory">
  8805. <summary>
  8806. A factory that creates <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">tagged data</see> instances.
  8807. </summary>
  8808. </member>
  8809. <member name="M:ICSharpCode.SharpZipLib.Zip.ITaggedDataFactory.Create(System.Int16,System.Byte[],System.Int32,System.Int32)">
  8810. <summary>
  8811. Get data for a specific tag value.
  8812. </summary>
  8813. <param name="tag">The tag ID to find.</param>
  8814. <param name="data">The data to search.</param>
  8815. <param name="offset">The offset to begin extracting data from.</param>
  8816. <param name="count">The number of bytes to extract.</param>
  8817. <returns>The located <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">value found</see>, or null if not found.</returns>
  8818. </member>
  8819. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipExtraData">
  8820. <summary>
  8821. A class to handle the extra data field for Zip entries
  8822. </summary>
  8823. <remarks>
  8824. Extra data contains 0 or more values each prefixed by a header tag and length.
  8825. They contain zero or more bytes of actual data.
  8826. The data is held internally using a copy on write strategy. This is more efficient but
  8827. means that for extra data created by passing in data can have the values modified by the caller
  8828. in some circumstances.
  8829. </remarks>
  8830. </member>
  8831. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.#ctor">
  8832. <summary>
  8833. Initialise a default instance.
  8834. </summary>
  8835. </member>
  8836. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.#ctor(System.Byte[])">
  8837. <summary>
  8838. Initialise with known extra data.
  8839. </summary>
  8840. <param name="data">The extra data.</param>
  8841. </member>
  8842. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.GetEntryData">
  8843. <summary>
  8844. Get the raw extra data value
  8845. </summary>
  8846. <returns>Returns the raw byte[] extra data this instance represents.</returns>
  8847. </member>
  8848. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Clear">
  8849. <summary>
  8850. Clear the stored data.
  8851. </summary>
  8852. </member>
  8853. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Length">
  8854. <summary>
  8855. Gets the current extra data length.
  8856. </summary>
  8857. </member>
  8858. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.GetStreamForTag(System.Int32)">
  8859. <summary>
  8860. Get a read-only <see cref="T:System.IO.Stream"/> for the associated tag.
  8861. </summary>
  8862. <param name="tag">The tag to locate data for.</param>
  8863. <returns>Returns a <see cref="T:System.IO.Stream"/> containing tag data or null if no tag was found.</returns>
  8864. </member>
  8865. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.GetData``1">
  8866. <summary>
  8867. Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">tagged data</see> for a tag.
  8868. </summary>
  8869. <typeparam name="T">The tag to search for.</typeparam>
  8870. <returns>Returns a <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData">tagged value</see> or null if none found.</returns>
  8871. </member>
  8872. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ValueLength">
  8873. <summary>
  8874. Get the length of the last value found by <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)"/>
  8875. </summary>
  8876. <remarks>This is only valid if <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)"/> has previously returned true.</remarks>
  8877. </member>
  8878. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipExtraData.CurrentReadIndex">
  8879. <summary>
  8880. Get the index for the current read value.
  8881. </summary>
  8882. <remarks>This is only valid if <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)"/> has previously returned true.
  8883. Initially the result will be the index of the first byte of actual data. The value is updated after calls to
  8884. <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadInt"/>, <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadShort"/> and <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadLong"/>. </remarks>
  8885. </member>
  8886. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipExtraData.UnreadCount">
  8887. <summary>
  8888. Get the number of bytes remaining to be read for the current value;
  8889. </summary>
  8890. </member>
  8891. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)">
  8892. <summary>
  8893. Find an extra data value
  8894. </summary>
  8895. <param name="headerID">The identifier for the value to find.</param>
  8896. <returns>Returns true if the value was found; false otherwise.</returns>
  8897. </member>
  8898. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddEntry(ICSharpCode.SharpZipLib.Zip.ITaggedData)">
  8899. <summary>
  8900. Add a new entry to extra data.
  8901. </summary>
  8902. <param name="taggedData">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ITaggedData"/> value to add.</param>
  8903. </member>
  8904. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddEntry(System.Int32,System.Byte[])">
  8905. <summary>
  8906. Add a new entry to extra data
  8907. </summary>
  8908. <param name="headerID">The ID for this entry.</param>
  8909. <param name="fieldData">The data to add.</param>
  8910. <remarks>If the ID already exists its contents are replaced.</remarks>
  8911. </member>
  8912. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry">
  8913. <summary>
  8914. Start adding a new entry.
  8915. </summary>
  8916. <remarks>Add data using <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddData(System.Byte[])"/>, <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeShort(System.Int32)"/>, <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeInt(System.Int32)"/>, or <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeLong(System.Int64)"/>.
  8917. The new entry is completed and actually added by calling <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddNewEntry(System.Int32)"/></remarks>
  8918. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddEntry(ICSharpCode.SharpZipLib.Zip.ITaggedData)"/>
  8919. </member>
  8920. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddNewEntry(System.Int32)">
  8921. <summary>
  8922. Add entry data added since <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/> using the ID passed.
  8923. </summary>
  8924. <param name="headerID">The identifier to use for this entry.</param>
  8925. </member>
  8926. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddData(System.Byte)">
  8927. <summary>
  8928. Add a byte of data to the pending new entry.
  8929. </summary>
  8930. <param name="data">The byte to add.</param>
  8931. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
  8932. </member>
  8933. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddData(System.Byte[])">
  8934. <summary>
  8935. Add data to a pending new entry.
  8936. </summary>
  8937. <param name="data">The data to add.</param>
  8938. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
  8939. </member>
  8940. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeShort(System.Int32)">
  8941. <summary>
  8942. Add a short value in little endian order to the pending new entry.
  8943. </summary>
  8944. <param name="toAdd">The data to add.</param>
  8945. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
  8946. </member>
  8947. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeInt(System.Int32)">
  8948. <summary>
  8949. Add an integer value in little endian order to the pending new entry.
  8950. </summary>
  8951. <param name="toAdd">The data to add.</param>
  8952. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
  8953. </member>
  8954. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.AddLeLong(System.Int64)">
  8955. <summary>
  8956. Add a long value in little endian order to the pending new entry.
  8957. </summary>
  8958. <param name="toAdd">The data to add.</param>
  8959. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.StartNewEntry"/>
  8960. </member>
  8961. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Delete(System.Int32)">
  8962. <summary>
  8963. Delete an extra data field.
  8964. </summary>
  8965. <param name="headerID">The identifier of the field to delete.</param>
  8966. <returns>Returns true if the field was found and deleted.</returns>
  8967. </member>
  8968. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadLong">
  8969. <summary>
  8970. Read a long in little endian form from the last <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)">found</see> data value
  8971. </summary>
  8972. <returns>Returns the long value read.</returns>
  8973. </member>
  8974. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadInt">
  8975. <summary>
  8976. Read an integer in little endian form from the last <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)">found</see> data value.
  8977. </summary>
  8978. <returns>Returns the integer read.</returns>
  8979. </member>
  8980. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadShort">
  8981. <summary>
  8982. Read a short value in little endian form from the last <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Find(System.Int32)">found</see> data value.
  8983. </summary>
  8984. <returns>Returns the short value read.</returns>
  8985. </member>
  8986. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadByte">
  8987. <summary>
  8988. Read a byte from an extra data
  8989. </summary>
  8990. <returns>The byte value read or -1 if the end of data has been reached.</returns>
  8991. </member>
  8992. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Skip(System.Int32)">
  8993. <summary>
  8994. Skip data during reading.
  8995. </summary>
  8996. <param name="amount">The number of bytes to skip.</param>
  8997. </member>
  8998. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadShortInternal">
  8999. <summary>
  9000. Internal form of <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.ReadShort"/> that reads data at any location.
  9001. </summary>
  9002. <returns>Returns the short value read.</returns>
  9003. </member>
  9004. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipExtraData.Dispose">
  9005. <summary>
  9006. Dispose of this instance.
  9007. </summary>
  9008. </member>
  9009. <member name="T:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs">
  9010. <summary>
  9011. Arguments used with KeysRequiredEvent
  9012. </summary>
  9013. </member>
  9014. <member name="M:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs.#ctor(System.String)">
  9015. <summary>
  9016. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs"></see>
  9017. </summary>
  9018. <param name="name">The name of the file for which keys are required.</param>
  9019. </member>
  9020. <member name="M:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs.#ctor(System.String,System.Byte[])">
  9021. <summary>
  9022. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs"></see>
  9023. </summary>
  9024. <param name="name">The name of the file for which keys are required.</param>
  9025. <param name="keyValue">The current key value.</param>
  9026. </member>
  9027. <member name="P:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs.FileName">
  9028. <summary>
  9029. Gets the name of the file for which keys are required.
  9030. </summary>
  9031. </member>
  9032. <member name="P:ICSharpCode.SharpZipLib.Zip.KeysRequiredEventArgs.Key">
  9033. <summary>
  9034. Gets or sets the key value
  9035. </summary>
  9036. </member>
  9037. <member name="T:ICSharpCode.SharpZipLib.Zip.TestStrategy">
  9038. <summary>
  9039. The strategy to apply to testing.
  9040. </summary>
  9041. </member>
  9042. <member name="F:ICSharpCode.SharpZipLib.Zip.TestStrategy.FindFirstError">
  9043. <summary>
  9044. Find the first error only.
  9045. </summary>
  9046. </member>
  9047. <member name="F:ICSharpCode.SharpZipLib.Zip.TestStrategy.FindAllErrors">
  9048. <summary>
  9049. Find all possible errors.
  9050. </summary>
  9051. </member>
  9052. <member name="T:ICSharpCode.SharpZipLib.Zip.TestOperation">
  9053. <summary>
  9054. The operation in progress reported by a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler"/> during testing.
  9055. </summary>
  9056. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean)">TestArchive</seealso>
  9057. </member>
  9058. <member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.Initialising">
  9059. <summary>
  9060. Setting up testing.
  9061. </summary>
  9062. </member>
  9063. <member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.EntryHeader">
  9064. <summary>
  9065. Testing an individual entries header
  9066. </summary>
  9067. </member>
  9068. <member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.EntryData">
  9069. <summary>
  9070. Testing an individual entries data
  9071. </summary>
  9072. </member>
  9073. <member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.EntryComplete">
  9074. <summary>
  9075. Testing an individual entry has completed.
  9076. </summary>
  9077. </member>
  9078. <member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.MiscellaneousTests">
  9079. <summary>
  9080. Running miscellaneous tests
  9081. </summary>
  9082. </member>
  9083. <member name="F:ICSharpCode.SharpZipLib.Zip.TestOperation.Complete">
  9084. <summary>
  9085. Testing is complete
  9086. </summary>
  9087. </member>
  9088. <member name="T:ICSharpCode.SharpZipLib.Zip.TestStatus">
  9089. <summary>
  9090. Status returned by <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler"/> during testing.
  9091. </summary>
  9092. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean)">TestArchive</seealso>
  9093. </member>
  9094. <member name="M:ICSharpCode.SharpZipLib.Zip.TestStatus.#ctor(ICSharpCode.SharpZipLib.Zip.ZipFile)">
  9095. <summary>
  9096. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.TestStatus"/>
  9097. </summary>
  9098. <param name="file">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> this status applies to.</param>
  9099. </member>
  9100. <member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.Operation">
  9101. <summary>
  9102. Get the current <see cref="T:ICSharpCode.SharpZipLib.Zip.TestOperation"/> in progress.
  9103. </summary>
  9104. </member>
  9105. <member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.File">
  9106. <summary>
  9107. Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> this status is applicable to.
  9108. </summary>
  9109. </member>
  9110. <member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.Entry">
  9111. <summary>
  9112. Get the current/last entry tested.
  9113. </summary>
  9114. </member>
  9115. <member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.ErrorCount">
  9116. <summary>
  9117. Get the number of errors detected so far.
  9118. </summary>
  9119. </member>
  9120. <member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.BytesTested">
  9121. <summary>
  9122. Get the number of bytes tested so far for the current entry.
  9123. </summary>
  9124. </member>
  9125. <member name="P:ICSharpCode.SharpZipLib.Zip.TestStatus.EntryValid">
  9126. <summary>
  9127. Get a value indicating whether the last entry test was valid.
  9128. </summary>
  9129. </member>
  9130. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler">
  9131. <summary>
  9132. Delegate invoked during <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean,ICSharpCode.SharpZipLib.Zip.TestStrategy,ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler)">testing</see> if supplied indicating current progress and status.
  9133. </summary>
  9134. <remarks>If the message is non-null an error has occured. If the message is null
  9135. the operation as found in <see cref="T:ICSharpCode.SharpZipLib.Zip.TestStatus">status</see> has started.</remarks>
  9136. </member>
  9137. <member name="T:ICSharpCode.SharpZipLib.Zip.FileUpdateMode">
  9138. <summary>
  9139. The possible ways of <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate">applying updates</see> to an archive.
  9140. </summary>
  9141. </member>
  9142. <member name="F:ICSharpCode.SharpZipLib.Zip.FileUpdateMode.Safe">
  9143. <summary>
  9144. Perform all updates on temporary files ensuring that the original file is saved.
  9145. </summary>
  9146. </member>
  9147. <member name="F:ICSharpCode.SharpZipLib.Zip.FileUpdateMode.Direct">
  9148. <summary>
  9149. Update the archive directly, which is faster but less safe.
  9150. </summary>
  9151. </member>
  9152. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile">
  9153. <summary>
  9154. This class represents a Zip archive. You can ask for the contained
  9155. entries, or get an input stream for a file entry. The entry is
  9156. automatically decompressed.
  9157. You can also update the archive adding or deleting entries.
  9158. This class is thread safe for input: You can open input streams for arbitrary
  9159. entries in different threads.
  9160. <br/>
  9161. <br/>Author of the original java version : Jochen Hoenicke
  9162. </summary>
  9163. <example>
  9164. <code>
  9165. using System;
  9166. using System.Text;
  9167. using System.Collections;
  9168. using System.IO;
  9169. using ICSharpCode.SharpZipLib.Zip;
  9170. class MainClass
  9171. {
  9172. static public void Main(string[] args)
  9173. {
  9174. using (ZipFile zFile = new ZipFile(args[0])) {
  9175. Console.WriteLine("Listing of : " + zFile.Name);
  9176. Console.WriteLine("");
  9177. Console.WriteLine("Raw Size Size Date Time Name");
  9178. Console.WriteLine("-------- -------- -------- ------ ---------");
  9179. foreach (ZipEntry e in zFile) {
  9180. if ( e.IsFile ) {
  9181. DateTime d = e.DateTime;
  9182. Console.WriteLine("{0, -10}{1, -10}{2} {3} {4}", e.Size, e.CompressedSize,
  9183. d.ToString("dd-MM-yy"), d.ToString("HH:mm"),
  9184. e.Name);
  9185. }
  9186. }
  9187. }
  9188. }
  9189. }
  9190. </code>
  9191. </example>
  9192. </member>
  9193. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.KeysRequiredEventHandler">
  9194. <summary>
  9195. Delegate for handling keys/password setting during compression/decompression.
  9196. </summary>
  9197. </member>
  9198. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipFile.KeysRequired">
  9199. <summary>
  9200. Event handler for handling encryption keys.
  9201. </summary>
  9202. </member>
  9203. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.OnKeysRequired(System.String)">
  9204. <summary>
  9205. Handles getting of encryption keys when required.
  9206. </summary>
  9207. <param name="fileName">The file for which encryption keys are required.</param>
  9208. </member>
  9209. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Key">
  9210. <summary>
  9211. Get/set the encryption key value.
  9212. </summary>
  9213. </member>
  9214. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Password">
  9215. <summary>
  9216. Password to be used for encrypting/decrypting files.
  9217. </summary>
  9218. <remarks>Set to null if no password is required.</remarks>
  9219. </member>
  9220. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.HaveKeys">
  9221. <summary>
  9222. Get a value indicating whether encryption keys are currently available.
  9223. </summary>
  9224. </member>
  9225. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor(System.String,ICSharpCode.SharpZipLib.Zip.StringCodec)">
  9226. <summary>
  9227. Opens a Zip file with the given name for reading.
  9228. </summary>
  9229. <param name="name">The name of the file to open.</param>
  9230. <param name="stringCodec"></param>
  9231. <exception cref="T:System.ArgumentNullException">The argument supplied is null.</exception>
  9232. <exception cref="T:System.IO.IOException">
  9233. An i/o error occurs
  9234. </exception>
  9235. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9236. The file doesn't contain a valid zip archive.
  9237. </exception>
  9238. </member>
  9239. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor(System.IO.FileStream)">
  9240. <summary>
  9241. Opens a Zip file reading the given <see cref="T:System.IO.FileStream"/>.
  9242. </summary>
  9243. <param name="file">The <see cref="T:System.IO.FileStream"/> to read archive data from.</param>
  9244. <exception cref="T:System.ArgumentNullException">The supplied argument is null.</exception>
  9245. <exception cref="T:System.IO.IOException">
  9246. An i/o error occurs.
  9247. </exception>
  9248. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9249. The file doesn't contain a valid zip archive.
  9250. </exception>
  9251. </member>
  9252. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor(System.IO.FileStream,System.Boolean)">
  9253. <summary>
  9254. Opens a Zip file reading the given <see cref="T:System.IO.FileStream"/>.
  9255. </summary>
  9256. <param name="file">The <see cref="T:System.IO.FileStream"/> to read archive data from.</param>
  9257. <param name="leaveOpen">true to leave the <see cref="T:System.IO.FileStream">file</see> open when the ZipFile is disposed, false to dispose of it</param>
  9258. <exception cref="T:System.ArgumentNullException">The supplied argument is null.</exception>
  9259. <exception cref="T:System.IO.IOException">
  9260. An i/o error occurs.
  9261. </exception>
  9262. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9263. The file doesn't contain a valid zip archive.
  9264. </exception>
  9265. </member>
  9266. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor(System.IO.Stream)">
  9267. <summary>
  9268. Opens a Zip file reading the given <see cref="T:System.IO.Stream"/>.
  9269. </summary>
  9270. <param name="stream">The <see cref="T:System.IO.Stream"/> to read archive data from.</param>
  9271. <exception cref="T:System.IO.IOException">
  9272. An i/o error occurs
  9273. </exception>
  9274. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9275. The stream doesn't contain a valid zip archive.<br/>
  9276. </exception>
  9277. <exception cref="T:System.ArgumentException">
  9278. The <see cref="T:System.IO.Stream">stream</see> doesnt support seeking.
  9279. </exception>
  9280. <exception cref="T:System.ArgumentNullException">
  9281. The <see cref="T:System.IO.Stream">stream</see> argument is null.
  9282. </exception>
  9283. </member>
  9284. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor(System.IO.Stream,System.Boolean,ICSharpCode.SharpZipLib.Zip.StringCodec)">
  9285. <summary>
  9286. Opens a Zip file reading the given <see cref="T:System.IO.Stream"/>.
  9287. </summary>
  9288. <param name="stream">The <see cref="T:System.IO.Stream"/> to read archive data from.</param>
  9289. <param name="leaveOpen">true to leave the <see cref="T:System.IO.Stream">stream</see> open when the ZipFile is disposed, false to dispose of it</param>
  9290. <param name="stringCodec"></param>
  9291. <exception cref="T:System.IO.IOException">
  9292. An i/o error occurs
  9293. </exception>
  9294. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9295. The stream doesn't contain a valid zip archive.<br/>
  9296. </exception>
  9297. <exception cref="T:System.ArgumentException">
  9298. The <see cref="T:System.IO.Stream">stream</see> doesnt support seeking.
  9299. </exception>
  9300. <exception cref="T:System.ArgumentNullException">
  9301. The <see cref="T:System.IO.Stream">stream</see> argument is null.
  9302. </exception>
  9303. </member>
  9304. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.#ctor">
  9305. <summary>
  9306. Initialises a default <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> instance with no entries and no file storage.
  9307. </summary>
  9308. </member>
  9309. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Finalize">
  9310. <summary>
  9311. Finalize this instance.
  9312. </summary>
  9313. </member>
  9314. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Close">
  9315. <summary>
  9316. Closes the ZipFile. If the stream is <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsStreamOwner">owned</see> then this also closes the underlying input stream.
  9317. Once closed, no further instance methods should be called.
  9318. </summary>
  9319. <exception cref="T:System.IO.IOException">
  9320. An i/o error occurs.
  9321. </exception>
  9322. </member>
  9323. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Create(System.String)">
  9324. <summary>
  9325. Create a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> whose data will be stored in a file.
  9326. </summary>
  9327. <param name="fileName">The name of the archive to create.</param>
  9328. <returns>Returns the newly created <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/></returns>
  9329. <exception cref="T:System.ArgumentNullException"><paramref name="fileName"></paramref> is null</exception>
  9330. </member>
  9331. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Create(System.IO.Stream)">
  9332. <summary>
  9333. Create a new <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> whose data will be stored on a stream.
  9334. </summary>
  9335. <param name="outStream">The stream providing data storage.</param>
  9336. <returns>Returns the newly created <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/></returns>
  9337. <exception cref="T:System.ArgumentNullException"><paramref name="outStream"> is null</paramref></exception>
  9338. <exception cref="T:System.ArgumentException"><paramref name="outStream"> doesnt support writing.</paramref></exception>
  9339. </member>
  9340. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsStreamOwner">
  9341. <summary>
  9342. Get/set a flag indicating if the underlying stream is owned by the ZipFile instance.
  9343. If the flag is true then the stream will be closed when <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Close">Close</see> is called.
  9344. </summary>
  9345. <remarks>
  9346. The default value is true in all cases.
  9347. </remarks>
  9348. </member>
  9349. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsEmbeddedArchive">
  9350. <summary>
  9351. Get a value indicating whether
  9352. this archive is embedded in another file or not.
  9353. </summary>
  9354. </member>
  9355. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsNewArchive">
  9356. <summary>
  9357. Get a value indicating that this archive is a new one.
  9358. </summary>
  9359. </member>
  9360. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipFileComment">
  9361. <summary>
  9362. Gets the comment for the zip file.
  9363. </summary>
  9364. </member>
  9365. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Name">
  9366. <summary>
  9367. Gets the name of this zip file.
  9368. </summary>
  9369. </member>
  9370. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Size">
  9371. <summary>
  9372. Gets the number of entries in this zip file.
  9373. </summary>
  9374. <exception cref="T:System.InvalidOperationException">
  9375. The Zip file has been closed.
  9376. </exception>
  9377. </member>
  9378. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.Count">
  9379. <summary>
  9380. Get the number of entries contained in this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/>.
  9381. </summary>
  9382. </member>
  9383. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.EntryByIndex(System.Int32)">
  9384. <summary>
  9385. Indexer property for ZipEntries
  9386. </summary>
  9387. </member>
  9388. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipCryptoEncoding">
  9389. <inheritdoc cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipCryptoEncoding"/>
  9390. </member>
  9391. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.StringCodec">
  9392. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.StringCodec"/>
  9393. </member>
  9394. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetEnumerator">
  9395. <summary>
  9396. Gets an enumerator for the Zip entries in this Zip file.
  9397. </summary>
  9398. <returns>Returns an <see cref="T:System.Collections.IEnumerator"/> for this archive.</returns>
  9399. <exception cref="T:System.ObjectDisposedException">
  9400. The Zip file has been closed.
  9401. </exception>
  9402. </member>
  9403. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.FindEntry(System.String,System.Boolean)">
  9404. <summary>
  9405. Return the index of the entry with a matching name
  9406. </summary>
  9407. <param name="name">Entry name to find</param>
  9408. <param name="ignoreCase">If true the comparison is case insensitive</param>
  9409. <returns>The index position of the matching entry or -1 if not found</returns>
  9410. <exception cref="T:System.ObjectDisposedException">
  9411. The Zip file has been closed.
  9412. </exception>
  9413. </member>
  9414. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetEntry(System.String)">
  9415. <summary>
  9416. Searches for a zip entry in this archive with the given name.
  9417. String comparisons are case insensitive
  9418. </summary>
  9419. <param name="name">
  9420. The name to find. May contain directory components separated by slashes ('/').
  9421. </param>
  9422. <returns>
  9423. A clone of the zip entry, or null if no entry with that name exists.
  9424. </returns>
  9425. <exception cref="T:System.ObjectDisposedException">
  9426. The Zip file has been closed.
  9427. </exception>
  9428. </member>
  9429. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetInputStream(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  9430. <summary>
  9431. Gets an input stream for reading the given zip entry data in an uncompressed form.
  9432. Normally the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> should be an entry returned by GetEntry().
  9433. </summary>
  9434. <param name="entry">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> to obtain a data <see cref="T:System.IO.Stream"/> for</param>
  9435. <returns>An input <see cref="T:System.IO.Stream"/> containing data for this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/></returns>
  9436. <exception cref="T:System.ObjectDisposedException">
  9437. The ZipFile has already been closed
  9438. </exception>
  9439. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9440. The compression method for the entry is unknown
  9441. </exception>
  9442. <exception cref="T:System.IndexOutOfRangeException">
  9443. The entry is not found in the ZipFile
  9444. </exception>
  9445. </member>
  9446. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetInputStream(System.Int64)">
  9447. <summary>
  9448. Creates an input stream reading a zip entry
  9449. </summary>
  9450. <param name="entryIndex">The index of the entry to obtain an input stream for.</param>
  9451. <returns>
  9452. An input <see cref="T:System.IO.Stream"/> containing data for this <paramref name="entryIndex"/>
  9453. </returns>
  9454. <exception cref="T:System.ObjectDisposedException">
  9455. The ZipFile has already been closed
  9456. </exception>
  9457. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9458. The compression method for the entry is unknown
  9459. </exception>
  9460. <exception cref="T:System.IndexOutOfRangeException">
  9461. The entry is not found in the ZipFile
  9462. </exception>
  9463. </member>
  9464. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean)">
  9465. <summary>
  9466. Test an archive for integrity/validity
  9467. </summary>
  9468. <param name="testData">Perform low level data Crc check</param>
  9469. <returns>true if all tests pass, false otherwise</returns>
  9470. <remarks>Testing will terminate on the first error found.</remarks>
  9471. </member>
  9472. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestArchive(System.Boolean,ICSharpCode.SharpZipLib.Zip.TestStrategy,ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler)">
  9473. <summary>
  9474. Test an archive for integrity/validity
  9475. </summary>
  9476. <param name="testData">Perform low level data Crc check</param>
  9477. <param name="strategy">The <see cref="T:ICSharpCode.SharpZipLib.Zip.TestStrategy"></see> to apply.</param>
  9478. <param name="resultHandler">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipTestResultHandler"></see> handler to call during testing.</param>
  9479. <returns>true if all tests pass, false otherwise</returns>
  9480. <exception cref="T:System.ObjectDisposedException">The object has already been closed.</exception>
  9481. </member>
  9482. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.TestLocalHeader(ICSharpCode.SharpZipLib.Zip.ZipEntry,ICSharpCode.SharpZipLib.Zip.ZipFile.HeaderTest)">
  9483. <summary>
  9484. Test a local header against that provided from the central directory
  9485. </summary>
  9486. <param name="entry">
  9487. The entry to test against
  9488. </param>
  9489. <param name="tests">The type of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.HeaderTest">tests</see> to carry out.</param>
  9490. <returns>The offset of the entries data in the file</returns>
  9491. </member>
  9492. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.UpdateCommand">
  9493. <summary>
  9494. The kind of update to apply.
  9495. </summary>
  9496. </member>
  9497. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.NameTransform">
  9498. <summary>
  9499. Get / set the <see cref="T:ICSharpCode.SharpZipLib.Core.INameTransform"/> to apply to names when updating.
  9500. </summary>
  9501. </member>
  9502. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.EntryFactory">
  9503. <summary>
  9504. Get/set the <see cref="T:ICSharpCode.SharpZipLib.Zip.IEntryFactory"/> used to generate <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> values
  9505. during updates.
  9506. </summary>
  9507. </member>
  9508. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.BufferSize">
  9509. <summary>
  9510. Get /set the buffer size to be used when updating this zip file.
  9511. </summary>
  9512. </member>
  9513. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.IsUpdating">
  9514. <summary>
  9515. Get a value indicating an update has <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate">been started</see>.
  9516. </summary>
  9517. </member>
  9518. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UseZip64">
  9519. <summary>
  9520. Get / set a value indicating how Zip64 Extension usage is determined when adding entries.
  9521. </summary>
  9522. </member>
  9523. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate(ICSharpCode.SharpZipLib.Zip.IArchiveStorage,ICSharpCode.SharpZipLib.Zip.IDynamicDataSource)">
  9524. <summary>
  9525. Begin updating this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> archive.
  9526. </summary>
  9527. <param name="archiveStorage">The <see cref="T:ICSharpCode.SharpZipLib.Zip.IArchiveStorage">archive storage</see> for use during the update.</param>
  9528. <param name="dataSource">The <see cref="T:ICSharpCode.SharpZipLib.Zip.IDynamicDataSource">data source</see> to utilise during updating.</param>
  9529. <exception cref="T:System.ObjectDisposedException">ZipFile has been closed.</exception>
  9530. <exception cref="T:System.ArgumentNullException">One of the arguments provided is null</exception>
  9531. <exception cref="T:System.ObjectDisposedException">ZipFile has been closed.</exception>
  9532. </member>
  9533. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate(ICSharpCode.SharpZipLib.Zip.IArchiveStorage)">
  9534. <summary>
  9535. Begin updating to this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> archive.
  9536. </summary>
  9537. <param name="archiveStorage">The storage to use during the update.</param>
  9538. </member>
  9539. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate">
  9540. <summary>
  9541. Begin updating this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> archive.
  9542. </summary>
  9543. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate(ICSharpCode.SharpZipLib.Zip.IArchiveStorage)"/>
  9544. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate"></seealso>
  9545. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.AbortUpdate"></seealso>
  9546. </member>
  9547. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate">
  9548. <summary>
  9549. Commit current updates, updating this archive.
  9550. </summary>
  9551. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate"></seealso>
  9552. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.AbortUpdate"></seealso>
  9553. <exception cref="T:System.ObjectDisposedException">ZipFile has been closed.</exception>
  9554. </member>
  9555. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.AbortUpdate">
  9556. <summary>
  9557. Abort updating leaving the archive unchanged.
  9558. </summary>
  9559. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.BeginUpdate"></seealso>
  9560. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate"></seealso>
  9561. </member>
  9562. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.SetComment(System.String)">
  9563. <summary>
  9564. Set the file comment to be recorded when the current update is <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CommitUpdate">commited</see>.
  9565. </summary>
  9566. <param name="comment">The comment to record.</param>
  9567. <exception cref="T:System.ObjectDisposedException">ZipFile has been closed.</exception>
  9568. </member>
  9569. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(System.String,ICSharpCode.SharpZipLib.Zip.CompressionMethod,System.Boolean)">
  9570. <summary>
  9571. Add a new entry to the archive.
  9572. </summary>
  9573. <param name="fileName">The name of the file to add.</param>
  9574. <param name="compressionMethod">The compression method to use.</param>
  9575. <param name="useUnicodeText">Ensure Unicode text is used for name and comment for this entry.</param>
  9576. <exception cref="T:System.ArgumentNullException">Argument supplied is null.</exception>
  9577. <exception cref="T:System.ObjectDisposedException">ZipFile has been closed.</exception>
  9578. <exception cref="T:System.NotImplementedException">Compression method is not supported for creating entries.</exception>
  9579. </member>
  9580. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(System.String,ICSharpCode.SharpZipLib.Zip.CompressionMethod)">
  9581. <summary>
  9582. Add a new entry to the archive.
  9583. </summary>
  9584. <param name="fileName">The name of the file to add.</param>
  9585. <param name="compressionMethod">The compression method to use.</param>
  9586. <exception cref="T:System.ArgumentNullException">ZipFile has been closed.</exception>
  9587. <exception cref="T:System.NotImplementedException">Compression method is not supported for creating entries.</exception>
  9588. </member>
  9589. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(System.String)">
  9590. <summary>
  9591. Add a file to the archive.
  9592. </summary>
  9593. <param name="fileName">The name of the file to add.</param>
  9594. <exception cref="T:System.ArgumentNullException">Argument supplied is null.</exception>
  9595. </member>
  9596. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(System.String,System.String)">
  9597. <summary>
  9598. Add a file to the archive.
  9599. </summary>
  9600. <param name="fileName">The name of the file to add.</param>
  9601. <param name="entryName">The name to use for the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> on the Zip file created.</param>
  9602. <exception cref="T:System.ArgumentNullException">Argument supplied is null.</exception>
  9603. </member>
  9604. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.IStaticDataSource,System.String)">
  9605. <summary>
  9606. Add a file entry with data.
  9607. </summary>
  9608. <param name="dataSource">The source of the data for this entry.</param>
  9609. <param name="entryName">The name to give to the entry.</param>
  9610. </member>
  9611. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.IStaticDataSource,System.String,ICSharpCode.SharpZipLib.Zip.CompressionMethod)">
  9612. <summary>
  9613. Add a file entry with data.
  9614. </summary>
  9615. <param name="dataSource">The source of the data for this entry.</param>
  9616. <param name="entryName">The name to give to the entry.</param>
  9617. <param name="compressionMethod">The compression method to use.</param>
  9618. <exception cref="T:System.NotImplementedException">Compression method is not supported for creating entries.</exception>
  9619. </member>
  9620. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.IStaticDataSource,System.String,ICSharpCode.SharpZipLib.Zip.CompressionMethod,System.Boolean)">
  9621. <summary>
  9622. Add a file entry with data.
  9623. </summary>
  9624. <param name="dataSource">The source of the data for this entry.</param>
  9625. <param name="entryName">The name to give to the entry.</param>
  9626. <param name="compressionMethod">The compression method to use.</param>
  9627. <param name="useUnicodeText">Ensure Unicode text is used for name and comments for this entry.</param>
  9628. <exception cref="T:System.NotImplementedException">Compression method is not supported for creating entries.</exception>
  9629. </member>
  9630. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  9631. <summary>
  9632. Add a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> that contains no data.
  9633. </summary>
  9634. <param name="entry">The entry to add.</param>
  9635. <remarks>This can be used to add directories, volume labels, or empty file entries.</remarks>
  9636. </member>
  9637. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Add(ICSharpCode.SharpZipLib.Zip.IStaticDataSource,ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  9638. <summary>
  9639. Add a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> with data.
  9640. </summary>
  9641. <param name="dataSource">The source of the data for this entry.</param>
  9642. <param name="entry">The entry to add.</param>
  9643. <remarks>This can be used to add file entries with a custom data source.</remarks>
  9644. <exception cref="T:System.NotSupportedException">
  9645. The encryption method specified in <paramref name="entry"/> is unsupported.
  9646. </exception>
  9647. <exception cref="T:System.NotImplementedException">Compression method is not supported for creating entries.</exception>
  9648. </member>
  9649. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.AddDirectory(System.String)">
  9650. <summary>
  9651. Add a directory entry to the archive.
  9652. </summary>
  9653. <param name="directoryName">The directory to add.</param>
  9654. </member>
  9655. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.CheckSupportedCompressionMethod(ICSharpCode.SharpZipLib.Zip.CompressionMethod)">
  9656. <summary>
  9657. Check if the specified compression method is supported for adding a new entry.
  9658. </summary>
  9659. <param name="compressionMethod">The compression method for the new entry.</param>
  9660. </member>
  9661. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Delete(System.String)">
  9662. <summary>
  9663. Delete an entry by name
  9664. </summary>
  9665. <param name="fileName">The filename to delete</param>
  9666. <returns>True if the entry was found and deleted; false otherwise.</returns>
  9667. </member>
  9668. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Delete(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  9669. <summary>
  9670. Delete a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> from the archive.
  9671. </summary>
  9672. <param name="entry">The entry to delete.</param>
  9673. </member>
  9674. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.WriteLEUshort(System.UInt16)">
  9675. <summary>
  9676. Write an unsigned short in little endian byte order.
  9677. </summary>
  9678. </member>
  9679. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.WriteLEInt(System.Int32)">
  9680. <summary>
  9681. Write an int in little endian byte order.
  9682. </summary>
  9683. </member>
  9684. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.WriteLEUint(System.UInt32)">
  9685. <summary>
  9686. Write an unsigned int in little endian byte order.
  9687. </summary>
  9688. </member>
  9689. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.WriteLeLong(System.Int64)">
  9690. <summary>
  9691. Write a long in little endian byte order.
  9692. </summary>
  9693. </member>
  9694. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetBuffer">
  9695. <summary>
  9696. Get a raw memory buffer.
  9697. </summary>
  9698. <returns>Returns a raw memory buffer.</returns>
  9699. </member>
  9700. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetDescriptorSize(ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate,System.Boolean)">
  9701. <summary>
  9702. Get the size of the source descriptor for a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate"/>.
  9703. </summary>
  9704. <param name="update">The update to get the size for.</param>
  9705. <param name="includingSignature">Whether to include the signature size</param>
  9706. <returns>The descriptor size, zero if there isn't one.</returns>
  9707. </member>
  9708. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.GetOutputStream(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  9709. <summary>
  9710. Get an output stream for the specified <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/>
  9711. </summary>
  9712. <param name="entry">The entry to get an output stream for.</param>
  9713. <returns>The output stream obtained for the entry.</returns>
  9714. </member>
  9715. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.UpdateComparer">
  9716. <summary>
  9717. Class used to sort updates.
  9718. </summary>
  9719. </member>
  9720. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UpdateComparer.Compare(ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate,ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate)">
  9721. <summary>
  9722. Compares two objects and returns a value indicating whether one is
  9723. less than, equal to or greater than the other.
  9724. </summary>
  9725. <param name="x">First object to compare</param>
  9726. <param name="y">Second object to compare.</param>
  9727. <returns>Compare result.</returns>
  9728. </member>
  9729. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate">
  9730. <summary>
  9731. Represents a pending update to a Zip file.
  9732. </summary>
  9733. </member>
  9734. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.#ctor(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  9735. <summary>
  9736. Copy an existing entry.
  9737. </summary>
  9738. <param name="entry">The existing entry to copy.</param>
  9739. </member>
  9740. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.Entry">
  9741. <summary>
  9742. Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> for this update.
  9743. </summary>
  9744. <remarks>This is the source or original entry.</remarks>
  9745. </member>
  9746. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.OutEntry">
  9747. <summary>
  9748. Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> that will be written to the updated/new file.
  9749. </summary>
  9750. </member>
  9751. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.Command">
  9752. <summary>
  9753. Get the command for this update.
  9754. </summary>
  9755. </member>
  9756. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.Filename">
  9757. <summary>
  9758. Get the filename if any for this update. Null if none exists.
  9759. </summary>
  9760. </member>
  9761. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.SizePatchOffset">
  9762. <summary>
  9763. Get/set the location of the size patch for this update.
  9764. </summary>
  9765. </member>
  9766. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.CrcPatchOffset">
  9767. <summary>
  9768. Get /set the location of the crc patch for this update.
  9769. </summary>
  9770. </member>
  9771. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipUpdate.OffsetBasedSize">
  9772. <summary>
  9773. Get/set the size calculated by offset.
  9774. Specifically, the difference between this and next entry's starting offset.
  9775. </summary>
  9776. </member>
  9777. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.Dispose(System.Boolean)">
  9778. <summary>
  9779. Releases the unmanaged resources used by the this instance and optionally releases the managed resources.
  9780. </summary>
  9781. <param name="disposing">true to release both managed and unmanaged resources;
  9782. false to release only unmanaged resources.</param>
  9783. </member>
  9784. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ReadLEUshort">
  9785. <summary>
  9786. Read an unsigned short in little endian byte order.
  9787. </summary>
  9788. <returns>Returns the value read.</returns>
  9789. <exception cref="T:System.IO.EndOfStreamException">
  9790. The stream ends prematurely
  9791. </exception>
  9792. </member>
  9793. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ReadLEUint">
  9794. <summary>
  9795. Read a uint in little endian byte order.
  9796. </summary>
  9797. <returns>Returns the value read.</returns>
  9798. <exception cref="T:System.IO.IOException">
  9799. An i/o error occurs.
  9800. </exception>
  9801. <exception cref="T:System.IO.EndOfStreamException">
  9802. The file ends prematurely
  9803. </exception>
  9804. </member>
  9805. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ReadEntries">
  9806. <summary>
  9807. Search for and read the central directory of a zip file filling the entries array.
  9808. </summary>
  9809. <exception cref="T:System.IO.IOException">
  9810. An i/o error occurs.
  9811. </exception>
  9812. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9813. The central directory is malformed or cannot be found
  9814. </exception>
  9815. </member>
  9816. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.LocateEntry(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  9817. <summary>
  9818. Locate the data for a given entry.
  9819. </summary>
  9820. <returns>
  9821. The start offset of the data.
  9822. </returns>
  9823. <exception cref="T:System.IO.EndOfStreamException">
  9824. The stream ends prematurely
  9825. </exception>
  9826. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  9827. The local header signature is invalid, the entry and central header file name lengths are different
  9828. or the local and entry compression methods dont match
  9829. </exception>
  9830. </member>
  9831. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.SkipLocalEntryTestsOnLocate">
  9832. <summary>
  9833. Skip the verification of the local header when reading an archive entry. Set this to attempt to read the
  9834. entries even if the headers should indicate that doing so would fail or produce an unexpected output.
  9835. </summary>
  9836. </member>
  9837. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString">
  9838. <summary>
  9839. Represents a string from a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> which is stored as an array of bytes.
  9840. </summary>
  9841. </member>
  9842. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.#ctor(System.String,System.Text.Encoding)">
  9843. <summary>
  9844. Initialise a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString"/> with a string.
  9845. </summary>
  9846. <param name="comment">The textual string form.</param>
  9847. <param name="encoding"></param>
  9848. </member>
  9849. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.#ctor(System.Byte[],System.Text.Encoding)">
  9850. <summary>
  9851. Initialise a <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString"/> using a string in its binary 'raw' form.
  9852. </summary>
  9853. <param name="rawString"></param>
  9854. <param name="encoding"></param>
  9855. </member>
  9856. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.IsSourceString">
  9857. <summary>
  9858. Get a value indicating the original source of data for this instance.
  9859. True if the source was a string; false if the source was binary data.
  9860. </summary>
  9861. </member>
  9862. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.RawLength">
  9863. <summary>
  9864. Get the length of the comment when represented as raw bytes.
  9865. </summary>
  9866. </member>
  9867. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.RawComment">
  9868. <summary>
  9869. Get the comment in its 'raw' form as plain bytes.
  9870. </summary>
  9871. </member>
  9872. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.Reset">
  9873. <summary>
  9874. Reset the comment to its initial state.
  9875. </summary>
  9876. </member>
  9877. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString.op_Implicit(ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString)~System.String">
  9878. <summary>
  9879. Implicit conversion of comment to a string.
  9880. </summary>
  9881. <param name="zipString">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipString"/> to convert to a string.</param>
  9882. <returns>The textual equivalent for the input value.</returns>
  9883. </member>
  9884. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.ZipEntryEnumerator">
  9885. <summary>
  9886. An <see cref="T:System.Collections.IEnumerator">enumerator</see> for <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">Zip entries</see>
  9887. </summary>
  9888. </member>
  9889. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream">
  9890. <summary>
  9891. An <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream"/> is a stream that you can write uncompressed data
  9892. to and flush, but cannot read, seek or do anything else to.
  9893. </summary>
  9894. </member>
  9895. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.CanRead">
  9896. <summary>
  9897. Gets a value indicating whether the current stream supports reading.
  9898. </summary>
  9899. </member>
  9900. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Flush">
  9901. <summary>
  9902. Write any buffered data to underlying storage.
  9903. </summary>
  9904. </member>
  9905. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.CanWrite">
  9906. <summary>
  9907. Gets a value indicating whether the current stream supports writing.
  9908. </summary>
  9909. </member>
  9910. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.CanSeek">
  9911. <summary>
  9912. Gets a value indicating whether the current stream supports seeking.
  9913. </summary>
  9914. </member>
  9915. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Length">
  9916. <summary>
  9917. Get the length in bytes of the stream.
  9918. </summary>
  9919. </member>
  9920. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Position">
  9921. <summary>
  9922. Gets or sets the position within the current stream.
  9923. </summary>
  9924. </member>
  9925. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Read(System.Byte[],System.Int32,System.Int32)">
  9926. <summary>
  9927. Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
  9928. </summary>
  9929. <param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.</param>
  9930. <param name="offset">The zero-based byte offset in buffer at which to begin storing the data read from the current stream.</param>
  9931. <param name="count">The maximum number of bytes to be read from the current stream.</param>
  9932. <returns>
  9933. The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
  9934. </returns>
  9935. <exception cref="T:System.ArgumentException">The sum of offset and count is larger than the buffer length. </exception>
  9936. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  9937. <exception cref="T:System.NotSupportedException">The stream does not support reading. </exception>
  9938. <exception cref="T:System.ArgumentNullException">buffer is null. </exception>
  9939. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  9940. <exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative. </exception>
  9941. </member>
  9942. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Seek(System.Int64,System.IO.SeekOrigin)">
  9943. <summary>
  9944. Sets the position within the current stream.
  9945. </summary>
  9946. <param name="offset">A byte offset relative to the origin parameter.</param>
  9947. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"></see> indicating the reference point used to obtain the new position.</param>
  9948. <returns>
  9949. The new position within the current stream.
  9950. </returns>
  9951. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  9952. <exception cref="T:System.NotSupportedException">The stream does not support seeking, such as if the stream is constructed from a pipe or console output. </exception>
  9953. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  9954. </member>
  9955. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.SetLength(System.Int64)">
  9956. <summary>
  9957. Sets the length of the current stream.
  9958. </summary>
  9959. <param name="value">The desired length of the current stream in bytes.</param>
  9960. <exception cref="T:System.NotSupportedException">The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. </exception>
  9961. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  9962. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  9963. </member>
  9964. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.UncompressedStream.Write(System.Byte[],System.Int32,System.Int32)">
  9965. <summary>
  9966. Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
  9967. </summary>
  9968. <param name="buffer">An array of bytes. This method copies count bytes from buffer to the current stream.</param>
  9969. <param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current stream.</param>
  9970. <param name="count">The number of bytes to be written to the current stream.</param>
  9971. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  9972. <exception cref="T:System.NotSupportedException">The stream does not support writing. </exception>
  9973. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  9974. <exception cref="T:System.ArgumentNullException">buffer is null. </exception>
  9975. <exception cref="T:System.ArgumentException">The sum of offset and count is greater than the buffer length. </exception>
  9976. <exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative. </exception>
  9977. </member>
  9978. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream">
  9979. <summary>
  9980. A <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream"/> is an <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Streams.InflaterInputStream"/>
  9981. whose data is only a part or subsection of a file.
  9982. </summary>
  9983. </member>
  9984. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.#ctor(ICSharpCode.SharpZipLib.Zip.ZipFile,System.Int64,System.Int64)">
  9985. <summary>
  9986. Initialise a new instance of the <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream"/> class.
  9987. </summary>
  9988. <param name="zipFile">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipFile"/> containing the underlying stream to use for IO.</param>
  9989. <param name="start">The start of the partial data.</param>
  9990. <param name="length">The length of the partial data.</param>
  9991. </member>
  9992. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.ReadByte">
  9993. <summary>
  9994. Read a byte from this stream.
  9995. </summary>
  9996. <returns>Returns the byte read or -1 on end of stream.</returns>
  9997. </member>
  9998. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  9999. <summary>
  10000. Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
  10001. </summary>
  10002. <param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.</param>
  10003. <param name="offset">The zero-based byte offset in buffer at which to begin storing the data read from the current stream.</param>
  10004. <param name="count">The maximum number of bytes to be read from the current stream.</param>
  10005. <returns>
  10006. The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
  10007. </returns>
  10008. <exception cref="T:System.ArgumentException">The sum of offset and count is larger than the buffer length. </exception>
  10009. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  10010. <exception cref="T:System.NotSupportedException">The stream does not support reading. </exception>
  10011. <exception cref="T:System.ArgumentNullException">buffer is null. </exception>
  10012. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  10013. <exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative. </exception>
  10014. </member>
  10015. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.Write(System.Byte[],System.Int32,System.Int32)">
  10016. <summary>
  10017. Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
  10018. </summary>
  10019. <param name="buffer">An array of bytes. This method copies count bytes from buffer to the current stream.</param>
  10020. <param name="offset">The zero-based byte offset in buffer at which to begin copying bytes to the current stream.</param>
  10021. <param name="count">The number of bytes to be written to the current stream.</param>
  10022. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  10023. <exception cref="T:System.NotSupportedException">The stream does not support writing. </exception>
  10024. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  10025. <exception cref="T:System.ArgumentNullException">buffer is null. </exception>
  10026. <exception cref="T:System.ArgumentException">The sum of offset and count is greater than the buffer length. </exception>
  10027. <exception cref="T:System.ArgumentOutOfRangeException">offset or count is negative. </exception>
  10028. </member>
  10029. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.SetLength(System.Int64)">
  10030. <summary>
  10031. When overridden in a derived class, sets the length of the current stream.
  10032. </summary>
  10033. <param name="value">The desired length of the current stream in bytes.</param>
  10034. <exception cref="T:System.NotSupportedException">The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output. </exception>
  10035. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  10036. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  10037. </member>
  10038. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  10039. <summary>
  10040. When overridden in a derived class, sets the position within the current stream.
  10041. </summary>
  10042. <param name="offset">A byte offset relative to the origin parameter.</param>
  10043. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"></see> indicating the reference point used to obtain the new position.</param>
  10044. <returns>
  10045. The new position within the current stream.
  10046. </returns>
  10047. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  10048. <exception cref="T:System.NotSupportedException">The stream does not support seeking, such as if the stream is constructed from a pipe or console output. </exception>
  10049. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  10050. </member>
  10051. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.Flush">
  10052. <summary>
  10053. Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  10054. </summary>
  10055. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  10056. </member>
  10057. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.Position">
  10058. <summary>
  10059. Gets or sets the position within the current stream.
  10060. </summary>
  10061. <value></value>
  10062. <returns>The current position within the stream.</returns>
  10063. <exception cref="T:System.IO.IOException">An I/O error occurs. </exception>
  10064. <exception cref="T:System.NotSupportedException">The stream does not support seeking. </exception>
  10065. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  10066. </member>
  10067. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.Length">
  10068. <summary>
  10069. Gets the length in bytes of the stream.
  10070. </summary>
  10071. <value></value>
  10072. <returns>A long value representing the length of the stream in bytes.</returns>
  10073. <exception cref="T:System.NotSupportedException">A class derived from Stream does not support seeking. </exception>
  10074. <exception cref="T:System.ObjectDisposedException">Methods were called after the stream was closed. </exception>
  10075. </member>
  10076. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.CanWrite">
  10077. <summary>
  10078. Gets a value indicating whether the current stream supports writing.
  10079. </summary>
  10080. <value>false</value>
  10081. <returns>true if the stream supports writing; otherwise, false.</returns>
  10082. </member>
  10083. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.CanSeek">
  10084. <summary>
  10085. Gets a value indicating whether the current stream supports seeking.
  10086. </summary>
  10087. <value>true</value>
  10088. <returns>true if the stream supports seeking; otherwise, false.</returns>
  10089. </member>
  10090. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.CanRead">
  10091. <summary>
  10092. Gets a value indicating whether the current stream supports reading.
  10093. </summary>
  10094. <value>true.</value>
  10095. <returns>true if the stream supports reading; otherwise, false.</returns>
  10096. </member>
  10097. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipFile.PartialInputStream.CanTimeout">
  10098. <summary>
  10099. Gets a value that determines whether the current stream can time out.
  10100. </summary>
  10101. <value></value>
  10102. <returns>A value that determines whether the current stream can time out.</returns>
  10103. </member>
  10104. <member name="T:ICSharpCode.SharpZipLib.Zip.IStaticDataSource">
  10105. <summary>
  10106. Provides a static way to obtain a source of data for an entry.
  10107. </summary>
  10108. </member>
  10109. <member name="M:ICSharpCode.SharpZipLib.Zip.IStaticDataSource.GetSource">
  10110. <summary>
  10111. Get a source of data by creating a new stream.
  10112. </summary>
  10113. <returns>Returns a <see cref="T:System.IO.Stream"/> to use for compression input.</returns>
  10114. <remarks>Ideally a new stream is created and opened to achieve this, to avoid locking problems.</remarks>
  10115. </member>
  10116. <member name="T:ICSharpCode.SharpZipLib.Zip.IDynamicDataSource">
  10117. <summary>
  10118. Represents a source of data that can dynamically provide
  10119. multiple <see cref="T:System.IO.Stream">data sources</see> based on the parameters passed.
  10120. </summary>
  10121. </member>
  10122. <member name="M:ICSharpCode.SharpZipLib.Zip.IDynamicDataSource.GetSource(ICSharpCode.SharpZipLib.Zip.ZipEntry,System.String)">
  10123. <summary>
  10124. Get a data source.
  10125. </summary>
  10126. <param name="entry">The <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> to get a source for.</param>
  10127. <param name="name">The name for data if known.</param>
  10128. <returns>Returns a <see cref="T:System.IO.Stream"/> to use for compression input.</returns>
  10129. <remarks>Ideally a new stream is created and opened to achieve this, to avoid locking problems.</remarks>
  10130. </member>
  10131. <member name="T:ICSharpCode.SharpZipLib.Zip.StaticDiskDataSource">
  10132. <summary>
  10133. Default implementation of a <see cref="T:ICSharpCode.SharpZipLib.Zip.IStaticDataSource"/> for use with files stored on disk.
  10134. </summary>
  10135. </member>
  10136. <member name="M:ICSharpCode.SharpZipLib.Zip.StaticDiskDataSource.#ctor(System.String)">
  10137. <summary>
  10138. Initialise a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.StaticDiskDataSource"/>
  10139. </summary>
  10140. <param name="fileName">The name of the file to obtain data from.</param>
  10141. </member>
  10142. <member name="M:ICSharpCode.SharpZipLib.Zip.StaticDiskDataSource.GetSource">
  10143. <summary>
  10144. Get a <see cref="T:System.IO.Stream"/> providing data.
  10145. </summary>
  10146. <returns>Returns a <see cref="T:System.IO.Stream"/> providing data.</returns>
  10147. </member>
  10148. <member name="T:ICSharpCode.SharpZipLib.Zip.DynamicDiskDataSource">
  10149. <summary>
  10150. Default implementation of <see cref="T:ICSharpCode.SharpZipLib.Zip.IDynamicDataSource"/> for files stored on disk.
  10151. </summary>
  10152. </member>
  10153. <member name="M:ICSharpCode.SharpZipLib.Zip.DynamicDiskDataSource.GetSource(ICSharpCode.SharpZipLib.Zip.ZipEntry,System.String)">
  10154. <summary>
  10155. Get a <see cref="T:System.IO.Stream"/> providing data for an entry.
  10156. </summary>
  10157. <param name="entry">The entry to provide data for.</param>
  10158. <param name="name">The file name for data if known.</param>
  10159. <returns>Returns a stream providing data; or null if not available</returns>
  10160. </member>
  10161. <member name="T:ICSharpCode.SharpZipLib.Zip.IArchiveStorage">
  10162. <summary>
  10163. Defines facilities for data storage when updating Zip Archives.
  10164. </summary>
  10165. </member>
  10166. <member name="P:ICSharpCode.SharpZipLib.Zip.IArchiveStorage.UpdateMode">
  10167. <summary>
  10168. Get the <see cref="T:ICSharpCode.SharpZipLib.Zip.FileUpdateMode"/> to apply during updates.
  10169. </summary>
  10170. </member>
  10171. <member name="M:ICSharpCode.SharpZipLib.Zip.IArchiveStorage.GetTemporaryOutput">
  10172. <summary>
  10173. Get an empty <see cref="T:System.IO.Stream"/> that can be used for temporary output.
  10174. </summary>
  10175. <returns>Returns a temporary output <see cref="T:System.IO.Stream"/></returns>
  10176. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.IArchiveStorage.ConvertTemporaryToFinal"></seealso>
  10177. </member>
  10178. <member name="M:ICSharpCode.SharpZipLib.Zip.IArchiveStorage.ConvertTemporaryToFinal">
  10179. <summary>
  10180. Convert a temporary output stream to a final stream.
  10181. </summary>
  10182. <returns>The resulting final <see cref="T:System.IO.Stream"/></returns>
  10183. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.IArchiveStorage.GetTemporaryOutput"/>
  10184. </member>
  10185. <member name="M:ICSharpCode.SharpZipLib.Zip.IArchiveStorage.MakeTemporaryCopy(System.IO.Stream)">
  10186. <summary>
  10187. Make a temporary copy of the original stream.
  10188. </summary>
  10189. <param name="stream">The <see cref="T:System.IO.Stream"/> to copy.</param>
  10190. <returns>Returns a temporary output <see cref="T:System.IO.Stream"/> that is a copy of the input.</returns>
  10191. </member>
  10192. <member name="M:ICSharpCode.SharpZipLib.Zip.IArchiveStorage.OpenForDirectUpdate(System.IO.Stream)">
  10193. <summary>
  10194. Return a stream suitable for performing direct updates on the original source.
  10195. </summary>
  10196. <param name="stream">The current stream.</param>
  10197. <returns>Returns a stream suitable for direct updating.</returns>
  10198. <remarks>This may be the current stream passed.</remarks>
  10199. </member>
  10200. <member name="M:ICSharpCode.SharpZipLib.Zip.IArchiveStorage.Dispose">
  10201. <summary>
  10202. Dispose of this instance.
  10203. </summary>
  10204. </member>
  10205. <member name="T:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage">
  10206. <summary>
  10207. An abstract <see cref="T:ICSharpCode.SharpZipLib.Zip.IArchiveStorage"/> suitable for extension by inheritance.
  10208. </summary>
  10209. </member>
  10210. <member name="M:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.#ctor(ICSharpCode.SharpZipLib.Zip.FileUpdateMode)">
  10211. <summary>
  10212. Initializes a new instance of the <see cref="T:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage"/> class.
  10213. </summary>
  10214. <param name="updateMode">The update mode.</param>
  10215. </member>
  10216. <member name="M:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.GetTemporaryOutput">
  10217. <summary>
  10218. Gets a temporary output <see cref="T:System.IO.Stream"/>
  10219. </summary>
  10220. <returns>Returns the temporary output stream.</returns>
  10221. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.ConvertTemporaryToFinal"></seealso>
  10222. </member>
  10223. <member name="M:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.ConvertTemporaryToFinal">
  10224. <summary>
  10225. Converts the temporary <see cref="T:System.IO.Stream"/> to its final form.
  10226. </summary>
  10227. <returns>Returns a <see cref="T:System.IO.Stream"/> that can be used to read
  10228. the final storage for the archive.</returns>
  10229. <seealso cref="M:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.GetTemporaryOutput"/>
  10230. </member>
  10231. <member name="M:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.MakeTemporaryCopy(System.IO.Stream)">
  10232. <summary>
  10233. Make a temporary copy of a <see cref="T:System.IO.Stream"/>.
  10234. </summary>
  10235. <param name="stream">The <see cref="T:System.IO.Stream"/> to make a copy of.</param>
  10236. <returns>Returns a temporary output <see cref="T:System.IO.Stream"/> that is a copy of the input.</returns>
  10237. </member>
  10238. <member name="M:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.OpenForDirectUpdate(System.IO.Stream)">
  10239. <summary>
  10240. Return a stream suitable for performing direct updates on the original source.
  10241. </summary>
  10242. <param name="stream">The <see cref="T:System.IO.Stream"/> to open for direct update.</param>
  10243. <returns>Returns a stream suitable for direct updating.</returns>
  10244. </member>
  10245. <member name="M:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.Dispose">
  10246. <summary>
  10247. Disposes this instance.
  10248. </summary>
  10249. </member>
  10250. <member name="P:ICSharpCode.SharpZipLib.Zip.BaseArchiveStorage.UpdateMode">
  10251. <summary>
  10252. Gets the update mode applicable.
  10253. </summary>
  10254. <value>The update mode.</value>
  10255. </member>
  10256. <member name="T:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage">
  10257. <summary>
  10258. An <see cref="T:ICSharpCode.SharpZipLib.Zip.IArchiveStorage"/> implementation suitable for hard disks.
  10259. </summary>
  10260. </member>
  10261. <member name="M:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage.#ctor(ICSharpCode.SharpZipLib.Zip.ZipFile,ICSharpCode.SharpZipLib.Zip.FileUpdateMode)">
  10262. <summary>
  10263. Initializes a new instance of the <see cref="T:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage"/> class.
  10264. </summary>
  10265. <param name="file">The file.</param>
  10266. <param name="updateMode">The update mode.</param>
  10267. </member>
  10268. <member name="M:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage.#ctor(ICSharpCode.SharpZipLib.Zip.ZipFile)">
  10269. <summary>
  10270. Initializes a new instance of the <see cref="T:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage"/> class.
  10271. </summary>
  10272. <param name="file">The file.</param>
  10273. </member>
  10274. <member name="M:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage.GetTemporaryOutput">
  10275. <summary>
  10276. Gets a temporary output <see cref="T:System.IO.Stream"/> for performing updates on.
  10277. </summary>
  10278. <returns>Returns the temporary output stream.</returns>
  10279. </member>
  10280. <member name="M:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage.ConvertTemporaryToFinal">
  10281. <summary>
  10282. Converts a temporary <see cref="T:System.IO.Stream"/> to its final form.
  10283. </summary>
  10284. <returns>Returns a <see cref="T:System.IO.Stream"/> that can be used to read
  10285. the final storage for the archive.</returns>
  10286. </member>
  10287. <member name="M:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage.MakeTemporaryCopy(System.IO.Stream)">
  10288. <summary>
  10289. Make a temporary copy of a stream.
  10290. </summary>
  10291. <param name="stream">The <see cref="T:System.IO.Stream"/> to copy.</param>
  10292. <returns>Returns a temporary output <see cref="T:System.IO.Stream"/> that is a copy of the input.</returns>
  10293. </member>
  10294. <member name="M:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage.OpenForDirectUpdate(System.IO.Stream)">
  10295. <summary>
  10296. Return a stream suitable for performing direct updates on the original source.
  10297. </summary>
  10298. <param name="stream">The current stream.</param>
  10299. <returns>Returns a stream suitable for direct updating.</returns>
  10300. <remarks>If the <paramref name="stream"/> is not null this is used as is.</remarks>
  10301. </member>
  10302. <member name="M:ICSharpCode.SharpZipLib.Zip.DiskArchiveStorage.Dispose">
  10303. <summary>
  10304. Disposes this instance.
  10305. </summary>
  10306. </member>
  10307. <member name="T:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage">
  10308. <summary>
  10309. An <see cref="T:ICSharpCode.SharpZipLib.Zip.IArchiveStorage"/> implementation suitable for in memory streams.
  10310. </summary>
  10311. </member>
  10312. <member name="M:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.#ctor">
  10313. <summary>
  10314. Initializes a new instance of the <see cref="T:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage"/> class.
  10315. </summary>
  10316. </member>
  10317. <member name="M:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.#ctor(ICSharpCode.SharpZipLib.Zip.FileUpdateMode)">
  10318. <summary>
  10319. Initializes a new instance of the <see cref="T:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage"/> class.
  10320. </summary>
  10321. <param name="updateMode">The <see cref="T:ICSharpCode.SharpZipLib.Zip.FileUpdateMode"/> to use</param>
  10322. <remarks>This constructor is for testing as memory streams dont really require safe mode.</remarks>
  10323. </member>
  10324. <member name="P:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.FinalStream">
  10325. <summary>
  10326. Get the stream returned by <see cref="M:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.ConvertTemporaryToFinal"/> if this was in fact called.
  10327. </summary>
  10328. </member>
  10329. <member name="M:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.GetTemporaryOutput">
  10330. <summary>
  10331. Gets the temporary output <see cref="T:System.IO.Stream"/>
  10332. </summary>
  10333. <returns>Returns the temporary output stream.</returns>
  10334. </member>
  10335. <member name="M:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.ConvertTemporaryToFinal">
  10336. <summary>
  10337. Converts the temporary <see cref="T:System.IO.Stream"/> to its final form.
  10338. </summary>
  10339. <returns>Returns a <see cref="T:System.IO.Stream"/> that can be used to read
  10340. the final storage for the archive.</returns>
  10341. </member>
  10342. <member name="M:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.MakeTemporaryCopy(System.IO.Stream)">
  10343. <summary>
  10344. Make a temporary copy of the original stream.
  10345. </summary>
  10346. <param name="stream">The <see cref="T:System.IO.Stream"/> to copy.</param>
  10347. <returns>Returns a temporary output <see cref="T:System.IO.Stream"/> that is a copy of the input.</returns>
  10348. </member>
  10349. <member name="M:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.OpenForDirectUpdate(System.IO.Stream)">
  10350. <summary>
  10351. Return a stream suitable for performing direct updates on the original source.
  10352. </summary>
  10353. <param name="stream">The original source stream</param>
  10354. <returns>Returns a stream suitable for direct updating.</returns>
  10355. <remarks>If the <paramref name="stream"/> passed is not null this is used;
  10356. otherwise a new <see cref="T:System.IO.MemoryStream"/> is returned.</remarks>
  10357. </member>
  10358. <member name="M:ICSharpCode.SharpZipLib.Zip.MemoryArchiveStorage.Dispose">
  10359. <summary>
  10360. Disposes this instance.
  10361. </summary>
  10362. </member>
  10363. <member name="T:ICSharpCode.SharpZipLib.Zip.DescriptorData">
  10364. <summary>
  10365. Holds data pertinent to a data descriptor.
  10366. </summary>
  10367. </member>
  10368. <member name="P:ICSharpCode.SharpZipLib.Zip.DescriptorData.CompressedSize">
  10369. <summary>
  10370. Get /set the compressed size of data.
  10371. </summary>
  10372. </member>
  10373. <member name="P:ICSharpCode.SharpZipLib.Zip.DescriptorData.Size">
  10374. <summary>
  10375. Get / set the uncompressed size of data
  10376. </summary>
  10377. </member>
  10378. <member name="P:ICSharpCode.SharpZipLib.Zip.DescriptorData.Crc">
  10379. <summary>
  10380. Get /set the crc value.
  10381. </summary>
  10382. </member>
  10383. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipFormat">
  10384. <summary>
  10385. This class assists with writing/reading from Zip files.
  10386. </summary>
  10387. </member>
  10388. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.LocateBlockWithSignature(System.IO.Stream,System.Int32,System.Int64,System.Int32,System.Int32)">
  10389. <summary>
  10390. Locates a block with the desired <paramref name="signature"/>.
  10391. </summary>
  10392. <param name="stream" />
  10393. <param name="signature">The signature to find.</param>
  10394. <param name="endLocation">Location, marking the end of block.</param>
  10395. <param name="minimumBlockSize">Minimum size of the block.</param>
  10396. <param name="maximumVariableData">The maximum variable data.</param>
  10397. <returns>Returns the offset of the first byte after the signature; -1 if not found</returns>
  10398. </member>
  10399. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.WriteZip64EndOfCentralDirectoryAsync(System.IO.Stream,System.Int64,System.Int64,System.Int64,System.Threading.CancellationToken)">
  10400. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.WriteZip64EndOfCentralDirectory(System.IO.Stream,System.Int64,System.Int64,System.Int64)"/>
  10401. </member>
  10402. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.WriteZip64EndOfCentralDirectory(System.IO.Stream,System.Int64,System.Int64,System.Int64)">
  10403. <summary>
  10404. Write Zip64 end of central directory records (File header and locator).
  10405. </summary>
  10406. <param name="stream" />
  10407. <param name="noOfEntries">The number of entries in the central directory.</param>
  10408. <param name="sizeEntries">The size of entries in the central directory.</param>
  10409. <param name="centralDirOffset">The offset of the central directory.</param>
  10410. </member>
  10411. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.WriteEndOfCentralDirectoryAsync(System.IO.Stream,System.Int64,System.Int64,System.Int64,System.Byte[],System.Threading.CancellationToken)">
  10412. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.WriteEndOfCentralDirectory(System.IO.Stream,System.Int64,System.Int64,System.Int64,System.Byte[])"/>
  10413. </member>
  10414. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.WriteEndOfCentralDirectory(System.IO.Stream,System.Int64,System.Int64,System.Int64,System.Byte[])">
  10415. <summary>
  10416. Write the required records to end the central directory.
  10417. </summary>
  10418. <param name="stream" />
  10419. <param name="noOfEntries">The number of entries in the directory.</param>
  10420. <param name="sizeEntries">The size of the entries in the directory.</param>
  10421. <param name="start">The start of the central directory.</param>
  10422. <param name="comment">The archive comment. (This can be null).</param>
  10423. </member>
  10424. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.WriteDataDescriptor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  10425. <summary>
  10426. Write a data descriptor.
  10427. </summary>
  10428. <param name="stream" />
  10429. <param name="entry">The entry to write a descriptor for.</param>
  10430. <returns>Returns the number of descriptor bytes written.</returns>
  10431. </member>
  10432. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipFormat.ReadDataDescriptor(System.IO.Stream,System.Boolean,ICSharpCode.SharpZipLib.Zip.DescriptorData)">
  10433. <summary>
  10434. Read data descriptor at the end of compressed data.
  10435. </summary>
  10436. <param name="stream" />
  10437. <param name="zip64">if set to <c>true</c> [zip64].</param>
  10438. <param name="data">The data to fill in.</param>
  10439. <returns>Returns the number of bytes read in the descriptor.</returns>
  10440. </member>
  10441. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream">
  10442. <summary>
  10443. This is an InflaterInputStream that reads the files baseInputStream an zip archive
  10444. one after another. It has a special method to get the zip entry of
  10445. the next file. The zip entry contains information about the file name
  10446. size, compressed size, Crc, etc.
  10447. It includes support for Stored and Deflated entries.
  10448. <br/>
  10449. <br/>Author of the original java version : Jochen Hoenicke
  10450. </summary>
  10451. <example> This sample shows how to read a zip file
  10452. <code lang="C#">
  10453. using System;
  10454. using System.Text;
  10455. using System.IO;
  10456. using ICSharpCode.SharpZipLib.Zip;
  10457. class MainClass
  10458. {
  10459. public static void Main(string[] args)
  10460. {
  10461. using ( ZipInputStream s = new ZipInputStream(File.OpenRead(args[0]))) {
  10462. ZipEntry theEntry;
  10463. const int size = 2048;
  10464. byte[] data = new byte[2048];
  10465. while ((theEntry = s.GetNextEntry()) != null) {
  10466. if ( entry.IsFile ) {
  10467. Console.Write("Show contents (y/n) ?");
  10468. if (Console.ReadLine() == "y") {
  10469. while (true) {
  10470. size = s.Read(data, 0, data.Length);
  10471. if (size > 0) {
  10472. Console.Write(new ASCIIEncoding().GetString(data, 0, size));
  10473. } else {
  10474. break;
  10475. }
  10476. }
  10477. }
  10478. }
  10479. }
  10480. }
  10481. }
  10482. }
  10483. </code>
  10484. </example>
  10485. </member>
  10486. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadDataHandler">
  10487. <summary>
  10488. Delegate for reading bytes from a stream.
  10489. </summary>
  10490. </member>
  10491. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipInputStream.internalReader">
  10492. <summary>
  10493. The current reader this instance.
  10494. </summary>
  10495. </member>
  10496. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.#ctor(System.IO.Stream)">
  10497. <summary>
  10498. Creates a new Zip input stream, for reading a zip archive.
  10499. </summary>
  10500. <param name="baseInputStream">The underlying <see cref="T:System.IO.Stream"/> providing data.</param>
  10501. </member>
  10502. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.#ctor(System.IO.Stream,System.Int32)">
  10503. <summary>
  10504. Creates a new Zip input stream, for reading a zip archive.
  10505. </summary>
  10506. <param name="baseInputStream">The underlying <see cref="T:System.IO.Stream"/> providing data.</param>
  10507. <param name="bufferSize">Size of the buffer.</param>
  10508. </member>
  10509. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.StringCodec)">
  10510. <summary>
  10511. Creates a new Zip input stream, for reading a zip archive.
  10512. </summary>
  10513. <param name="baseInputStream">The underlying <see cref="T:System.IO.Stream"/> providing data.</param>
  10514. <param name="stringCodec"></param>
  10515. </member>
  10516. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Password">
  10517. <summary>
  10518. Optional password used for encryption when non-null
  10519. </summary>
  10520. <value>A password for all encrypted <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">entries </see> in this <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream"/></value>
  10521. </member>
  10522. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CanDecompressEntry">
  10523. <summary>
  10524. Gets a value indicating if there is a current entry and it can be decompressed
  10525. </summary>
  10526. <remarks>
  10527. The entry can only be decompressed if the library supports the zip features required to extract it.
  10528. See the <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Version">ZipEntry Version</see> property for more details.
  10529. Since <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipInputStream"/> uses the local headers for extraction, entries with no compression combined with the
  10530. <see cref="F:ICSharpCode.SharpZipLib.Zip.GeneralBitFlags.Descriptor"/> flag set, cannot be extracted as the end of the entry data cannot be deduced.
  10531. </remarks>
  10532. </member>
  10533. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.IsEntryCompressionMethodSupported(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  10534. <summary>
  10535. Is the compression method for the specified entry supported?
  10536. </summary>
  10537. <remarks>
  10538. Uses entry.CompressionMethodForHeader so that entries of type WinZipAES will be rejected.
  10539. </remarks>
  10540. <param name="entry">the entry to check.</param>
  10541. <returns>true if the compression method is supported, false if not.</returns>
  10542. </member>
  10543. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.GetNextEntry">
  10544. <summary>
  10545. Advances to the next entry in the archive
  10546. </summary>
  10547. <returns>
  10548. The next <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry">entry</see> in the archive or null if there are no more entries.
  10549. </returns>
  10550. <remarks>
  10551. If the previous entry is still open <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CloseEntry">CloseEntry</see> is called.
  10552. </remarks>
  10553. <exception cref="T:System.InvalidOperationException">
  10554. Input stream is closed
  10555. </exception>
  10556. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  10557. Password is not set, password is invalid, compression method is invalid,
  10558. version required to extract is not supported
  10559. </exception>
  10560. </member>
  10561. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.SkipUntilNextEntry">
  10562. <summary>
  10563. Reads bytes from the input stream until either a local file header signature, or another signature
  10564. indicating that no more entries should be present, is found.
  10565. </summary>
  10566. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">Thrown if the end of the input stream is reached without any signatures found</exception>
  10567. <returns>Returns whether the found signature is for a local entry header</returns>
  10568. </member>
  10569. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadDataDescriptor">
  10570. <summary>
  10571. Read data descriptor at the end of compressed data.
  10572. </summary>
  10573. </member>
  10574. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CompleteCloseEntry(System.Boolean)">
  10575. <summary>
  10576. Complete cleanup as the final part of closing.
  10577. </summary>
  10578. <param name="testCrc">True if the crc value should be tested</param>
  10579. </member>
  10580. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.CloseEntry">
  10581. <summary>
  10582. Closes the current zip entry and moves to the next one.
  10583. </summary>
  10584. <exception cref="T:System.InvalidOperationException">
  10585. The stream is closed
  10586. </exception>
  10587. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  10588. The Zip stream ends early
  10589. </exception>
  10590. </member>
  10591. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Available">
  10592. <summary>
  10593. Returns 1 if there is an entry available
  10594. Otherwise returns 0.
  10595. </summary>
  10596. </member>
  10597. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Length">
  10598. <summary>
  10599. Returns the current size that can be read from the current entry if available
  10600. </summary>
  10601. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">Thrown if the entry size is not known.</exception>
  10602. <exception cref="T:System.InvalidOperationException">Thrown if no entry is currently available.</exception>
  10603. </member>
  10604. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadByte">
  10605. <summary>
  10606. Reads a byte from the current zip entry.
  10607. </summary>
  10608. <returns>
  10609. The byte or -1 if end of stream is reached.
  10610. </returns>
  10611. </member>
  10612. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadingNotAvailable(System.Byte[],System.Int32,System.Int32)">
  10613. <summary>
  10614. Handle attempts to read by throwing an <see cref="T:System.InvalidOperationException"/>.
  10615. </summary>
  10616. <param name="destination">The destination array to store data in.</param>
  10617. <param name="offset">The offset at which data read should be stored.</param>
  10618. <param name="count">The maximum number of bytes to read.</param>
  10619. <returns>Returns the number of bytes actually read.</returns>
  10620. </member>
  10621. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.ReadingNotSupported(System.Byte[],System.Int32,System.Int32)">
  10622. <summary>
  10623. Handle attempts to read from this entry by throwing an exception
  10624. </summary>
  10625. </member>
  10626. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.StoredDescriptorEntry(System.Byte[],System.Int32,System.Int32)">
  10627. <summary>
  10628. Handle attempts to read from this entry by throwing an exception
  10629. </summary>
  10630. </member>
  10631. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.InitialRead(System.Byte[],System.Int32,System.Int32)">
  10632. <summary>
  10633. Perform the initial read on an entry which may include
  10634. reading encryption headers and setting up inflation.
  10635. </summary>
  10636. <param name="destination">The destination to fill with data read.</param>
  10637. <param name="offset">The offset to start reading at.</param>
  10638. <param name="count">The maximum number of bytes to read.</param>
  10639. <returns>The actual number of bytes read.</returns>
  10640. </member>
  10641. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  10642. <summary>
  10643. Read a block of bytes from the stream.
  10644. </summary>
  10645. <param name="buffer">The destination for the bytes.</param>
  10646. <param name="offset">The index to start storing data.</param>
  10647. <param name="count">The number of bytes to attempt to read.</param>
  10648. <returns>Returns the number of bytes read.</returns>
  10649. <remarks>Zero bytes read means end of stream.</remarks>
  10650. </member>
  10651. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.BodyRead(System.Byte[],System.Int32,System.Int32)">
  10652. <summary>
  10653. Reads a block of bytes from the current zip entry.
  10654. </summary>
  10655. <returns>
  10656. The number of bytes read (this may be less than the length requested, even before the end of stream), or 0 on end of stream.
  10657. </returns>
  10658. <exception cref="T:System.IO.IOException">
  10659. An i/o error occurred.
  10660. </exception>
  10661. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  10662. The deflated stream is corrupted.
  10663. </exception>
  10664. <exception cref="T:System.InvalidOperationException">
  10665. The stream is not open.
  10666. </exception>
  10667. </member>
  10668. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipInputStream.Dispose(System.Boolean)">
  10669. <summary>
  10670. Closes the zip input stream
  10671. </summary>
  10672. </member>
  10673. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform">
  10674. <summary>
  10675. ZipNameTransform transforms names as per the Zip file naming convention.
  10676. </summary>
  10677. <remarks>The use of absolute names is supported although its use is not valid
  10678. according to Zip naming conventions, and should not be used if maximum compatability is desired.</remarks>
  10679. </member>
  10680. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.#ctor">
  10681. <summary>
  10682. Initialize a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform"></see>
  10683. </summary>
  10684. </member>
  10685. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.#ctor(System.String)">
  10686. <summary>
  10687. Initialize a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipNameTransform"></see>
  10688. </summary>
  10689. <param name="trimPrefix">The string to trim from the front of paths if found.</param>
  10690. </member>
  10691. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.#cctor">
  10692. <summary>
  10693. Static constructor.
  10694. </summary>
  10695. </member>
  10696. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.TransformDirectory(System.String)">
  10697. <summary>
  10698. Transform a windows directory name according to the Zip file naming conventions.
  10699. </summary>
  10700. <param name="name">The directory name to transform.</param>
  10701. <returns>The transformed name.</returns>
  10702. </member>
  10703. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.TransformFile(System.String)">
  10704. <summary>
  10705. Transform a windows file name according to the Zip file naming conventions.
  10706. </summary>
  10707. <param name="name">The file name to transform.</param>
  10708. <returns>The transformed name.</returns>
  10709. </member>
  10710. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.TrimPrefix">
  10711. <summary>
  10712. Get/set the path prefix to be trimmed from paths if present.
  10713. </summary>
  10714. <remarks>The prefix is trimmed before any conversion from
  10715. a windows path is done.</remarks>
  10716. </member>
  10717. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.MakeValidName(System.String,System.Char)">
  10718. <summary>
  10719. Force a name to be valid by replacing invalid characters with a fixed value
  10720. </summary>
  10721. <param name="name">The name to force valid</param>
  10722. <param name="replacement">The replacement character to use.</param>
  10723. <returns>Returns a valid name</returns>
  10724. </member>
  10725. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.IsValidName(System.String,System.Boolean)">
  10726. <summary>
  10727. Test a name to see if it is a valid name for a zip entry.
  10728. </summary>
  10729. <param name="name">The name to test.</param>
  10730. <param name="relaxed">If true checking is relaxed about windows file names and absolute paths.</param>
  10731. <returns>Returns true if the name is a valid zip name; false otherwise.</returns>
  10732. <remarks>Zip path names are actually in Unix format, and should only contain relative paths.
  10733. This means that any path stored should not contain a drive or
  10734. device letter, or a leading slash. All slashes should forward slashes '/'.
  10735. An empty name is valid for a file where the input comes from standard input.
  10736. A null name is not considered valid.
  10737. </remarks>
  10738. </member>
  10739. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipNameTransform.IsValidName(System.String)">
  10740. <summary>
  10741. Test a name to see if it is a valid name for a zip entry.
  10742. </summary>
  10743. <param name="name">The name to test.</param>
  10744. <returns>Returns true if the name is a valid zip name; false otherwise.</returns>
  10745. <remarks>Zip path names are actually in unix format,
  10746. and should only contain relative paths if a path is present.
  10747. This means that the path stored should not contain a drive or
  10748. device letter, or a leading slash. All slashes should forward slashes '/'.
  10749. An empty name is valid where the input comes from standard input.
  10750. A null name is not considered valid.
  10751. </remarks>
  10752. </member>
  10753. <member name="T:ICSharpCode.SharpZipLib.Zip.PathTransformer">
  10754. <summary>
  10755. An implementation of INameTransform that transforms entry paths as per the Zip file naming convention.
  10756. Strips path roots and puts directory separators in the correct format ('/')
  10757. </summary>
  10758. </member>
  10759. <member name="M:ICSharpCode.SharpZipLib.Zip.PathTransformer.#ctor">
  10760. <summary>
  10761. Initialize a new instance of <see cref="T:ICSharpCode.SharpZipLib.Zip.PathTransformer"></see>
  10762. </summary>
  10763. </member>
  10764. <member name="M:ICSharpCode.SharpZipLib.Zip.PathTransformer.TransformDirectory(System.String)">
  10765. <summary>
  10766. Transform a windows directory name according to the Zip file naming conventions.
  10767. </summary>
  10768. <param name="name">The directory name to transform.</param>
  10769. <returns>The transformed name.</returns>
  10770. </member>
  10771. <member name="M:ICSharpCode.SharpZipLib.Zip.PathTransformer.TransformFile(System.String)">
  10772. <summary>
  10773. Transform a windows file name according to the Zip file naming conventions.
  10774. </summary>
  10775. <param name="name">The file name to transform.</param>
  10776. <returns>The transformed name.</returns>
  10777. </member>
  10778. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipOutputStream">
  10779. <summary>
  10780. This is a DeflaterOutputStream that writes the files into a zip
  10781. archive one after another. It has a special method to start a new
  10782. zip entry. The zip entries contains information about the file name
  10783. size, compressed size, CRC, etc.
  10784. It includes support for Stored and Deflated entries.
  10785. This class is not thread safe.
  10786. <br/>
  10787. <br/>Author of the original java version : Jochen Hoenicke
  10788. </summary>
  10789. <example> This sample shows how to create a zip file
  10790. <code>
  10791. using System;
  10792. using System.IO;
  10793. using ICSharpCode.SharpZipLib.Core;
  10794. using ICSharpCode.SharpZipLib.Zip;
  10795. class MainClass
  10796. {
  10797. public static void Main(string[] args)
  10798. {
  10799. string[] filenames = Directory.GetFiles(args[0]);
  10800. byte[] buffer = new byte[4096];
  10801. using ( ZipOutputStream s = new ZipOutputStream(File.Create(args[1])) ) {
  10802. s.SetLevel(9); // 0 - store only to 9 - means best compression
  10803. foreach (string file in filenames) {
  10804. ZipEntry entry = new ZipEntry(file);
  10805. s.PutNextEntry(entry);
  10806. using (FileStream fs = File.OpenRead(file)) {
  10807. StreamUtils.Copy(fs, s, buffer);
  10808. }
  10809. }
  10810. }
  10811. }
  10812. }
  10813. </code>
  10814. </example>
  10815. </member>
  10816. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.#ctor(System.IO.Stream)">
  10817. <summary>
  10818. Creates a new Zip output stream, writing a zip archive.
  10819. </summary>
  10820. <param name="baseOutputStream">
  10821. The output stream to which the archive contents are written.
  10822. </param>
  10823. </member>
  10824. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.#ctor(System.IO.Stream,System.Int32)">
  10825. <summary>
  10826. Creates a new Zip output stream, writing a zip archive.
  10827. </summary>
  10828. <param name="baseOutputStream">The output stream to which the archive contents are written.</param>
  10829. <param name="bufferSize">Size of the buffer to use.</param>
  10830. </member>
  10831. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.#ctor(System.IO.Stream,ICSharpCode.SharpZipLib.Zip.StringCodec)">
  10832. <summary>
  10833. Creates a new Zip output stream, writing a zip archive.
  10834. </summary>
  10835. <param name="baseOutputStream">The output stream to which the archive contents are written.</param>
  10836. <param name="stringCodec"></param>
  10837. </member>
  10838. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.IsFinished">
  10839. <summary>
  10840. Gets a flag value of true if the central header has been added for this archive; false if it has not been added.
  10841. </summary>
  10842. <remarks>No further entries can be added once this has been done.</remarks>
  10843. </member>
  10844. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.SetComment(System.String)">
  10845. <summary>
  10846. Set the zip file comment.
  10847. </summary>
  10848. <param name="comment">
  10849. The comment text for the entire archive.
  10850. </param>
  10851. <exception cref="T:System.ArgumentOutOfRangeException">
  10852. The converted comment is longer than 0xffff bytes.
  10853. </exception>
  10854. </member>
  10855. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.SetLevel(System.Int32)">
  10856. <summary>
  10857. Sets the compression level. The new level will be activated
  10858. immediately.
  10859. </summary>
  10860. <param name="level">The new compression level (1 to 9).</param>
  10861. <exception cref="T:System.ArgumentOutOfRangeException">
  10862. Level specified is not supported.
  10863. </exception>
  10864. <see cref="T:ICSharpCode.SharpZipLib.Zip.Compression.Deflater"/>
  10865. </member>
  10866. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.GetLevel">
  10867. <summary>
  10868. Get the current deflater compression level
  10869. </summary>
  10870. <returns>The current compression level</returns>
  10871. </member>
  10872. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.UseZip64">
  10873. <summary>
  10874. Get / set a value indicating how Zip64 Extension usage is determined when adding entries.
  10875. </summary>
  10876. <remarks>Older archivers may not understand Zip64 extensions.
  10877. If backwards compatability is an issue be careful when adding <see cref="P:ICSharpCode.SharpZipLib.Zip.ZipEntry.Size">entries</see> to an archive.
  10878. Setting this property to off is workable but less desirable as in those circumstances adding a file
  10879. larger then 4GB will fail.</remarks>
  10880. </member>
  10881. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.NameTransform">
  10882. <summary>
  10883. Used for transforming the names of entries added by <see cref="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.PutNextEntry(ICSharpCode.SharpZipLib.Zip.ZipEntry)"/>.
  10884. Defaults to <see cref="T:ICSharpCode.SharpZipLib.Zip.PathTransformer"/>, set to null to disable transforms and use names as supplied.
  10885. </summary>
  10886. </member>
  10887. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Password">
  10888. <summary>
  10889. Get/set the password used for encryption.
  10890. </summary>
  10891. <remarks>When set to null or if the password is empty no encryption is performed</remarks>
  10892. </member>
  10893. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeShort(System.Int32)">
  10894. <summary>
  10895. Write an unsigned short in little endian byte order.
  10896. </summary>
  10897. </member>
  10898. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeInt(System.Int32)">
  10899. <summary>
  10900. Write an int in little endian byte order.
  10901. </summary>
  10902. </member>
  10903. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteLeLong(System.Int64)">
  10904. <summary>
  10905. Write an int in little endian byte order.
  10906. </summary>
  10907. </member>
  10908. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.PutNextEntry(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  10909. <summary>
  10910. Starts a new Zip entry. It automatically closes the previous
  10911. entry if present.
  10912. All entry elements bar name are optional, but must be correct if present.
  10913. If the compression method is stored and the output is not patchable
  10914. the compression for that entry is automatically changed to deflate level 0
  10915. </summary>
  10916. <param name="entry">
  10917. the entry.
  10918. </param>
  10919. <exception cref="T:System.ArgumentNullException">
  10920. if entry passed is null.
  10921. </exception>
  10922. <exception cref="T:System.IO.IOException">
  10923. if an I/O error occurred.
  10924. </exception>
  10925. <exception cref="T:System.InvalidOperationException">
  10926. if stream was finished
  10927. </exception>
  10928. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  10929. Too many entries in the Zip file<br/>
  10930. Entry name is too long<br/>
  10931. Finish has already been called<br/>
  10932. </exception>
  10933. <exception cref="T:System.NotImplementedException">
  10934. The Compression method specified for the entry is unsupported.
  10935. </exception>
  10936. </member>
  10937. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.PutNextPassthroughEntry(ICSharpCode.SharpZipLib.Zip.ZipEntry)">
  10938. <summary>
  10939. Starts a new passthrough Zip entry. It automatically closes the previous
  10940. entry if present.
  10941. Passthrough entry is an entry that is created from compressed data.
  10942. It is useful to avoid recompression to save CPU resources if compressed data is already disposable.
  10943. All entry elements bar name, crc, size and compressed size are optional, but must be correct if present.
  10944. Compression should be set to Deflated.
  10945. </summary>
  10946. <param name="entry">
  10947. the entry.
  10948. </param>
  10949. <exception cref="T:System.ArgumentNullException">
  10950. if entry passed is null.
  10951. </exception>
  10952. <exception cref="T:System.IO.IOException">
  10953. if an I/O error occurred.
  10954. </exception>
  10955. <exception cref="T:System.InvalidOperationException">
  10956. if stream was finished.
  10957. </exception>
  10958. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  10959. Crc is not set<br/>
  10960. Size is not set<br/>
  10961. CompressedSize is not set<br/>
  10962. CompressionMethod is not Deflate<br/>
  10963. Too many entries in the Zip file<br/>
  10964. Entry name is too long<br/>
  10965. Finish has already been called<br/>
  10966. </exception>
  10967. <exception cref="T:System.NotImplementedException">
  10968. The Compression method specified for the entry is unsupported<br/>
  10969. Entry is encrypted<br/>
  10970. </exception>
  10971. </member>
  10972. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.PutNextEntryAsync(ICSharpCode.SharpZipLib.Zip.ZipEntry,System.Threading.CancellationToken)">
  10973. <summary>
  10974. Starts a new Zip entry. It automatically closes the previous
  10975. entry if present.
  10976. All entry elements bar name are optional, but must be correct if present.
  10977. If the compression method is stored and the output is not patchable
  10978. the compression for that entry is automatically changed to deflate level 0
  10979. </summary>
  10980. <param name="entry">
  10981. the entry.
  10982. </param>
  10983. <param name="ct">The <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the operation.</param>
  10984. <exception cref="T:System.ArgumentNullException">
  10985. if entry passed is null.
  10986. </exception>
  10987. <exception cref="T:System.IO.IOException">
  10988. if an I/O error occured.
  10989. </exception>
  10990. <exception cref="T:System.InvalidOperationException">
  10991. if stream was finished
  10992. </exception>
  10993. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  10994. Too many entries in the Zip file<br/>
  10995. Entry name is too long<br/>
  10996. Finish has already been called<br/>
  10997. </exception>
  10998. <exception cref="T:System.NotImplementedException">
  10999. The Compression method specified for the entry is unsupported.
  11000. </exception>
  11001. </member>
  11002. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.CloseEntry">
  11003. <summary>
  11004. Closes the current entry, updating header and footer information as required
  11005. </summary>
  11006. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  11007. Invalid entry field values.
  11008. </exception>
  11009. <exception cref="T:System.IO.IOException">
  11010. An I/O error occurs.
  11011. </exception>
  11012. <exception cref="T:System.InvalidOperationException">
  11013. No entry is active.
  11014. </exception>
  11015. </member>
  11016. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.CloseEntryAsync(System.Threading.CancellationToken)">
  11017. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.CloseEntry"/>
  11018. </member>
  11019. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.InitializeAESPassword(ICSharpCode.SharpZipLib.Zip.ZipEntry,System.String)">
  11020. <summary>
  11021. Initializes encryption keys based on given password.
  11022. </summary>
  11023. </member>
  11024. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.InitializeZipCryptoPassword(System.String)">
  11025. <summary>
  11026. Initializes encryption keys based on given <paramref name="password"/>.
  11027. </summary>
  11028. <param name="password">The password.</param>
  11029. </member>
  11030. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  11031. <summary>
  11032. Writes the given buffer to the current entry.
  11033. </summary>
  11034. <param name="buffer">The buffer containing data to write.</param>
  11035. <param name="offset">The offset of the first byte to write.</param>
  11036. <param name="count">The number of bytes to write.</param>
  11037. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">Archive size is invalid</exception>
  11038. <exception cref="T:System.InvalidOperationException">No entry is active.</exception>
  11039. </member>
  11040. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.WriteAsync(System.Byte[],System.Int32,System.Int32,System.Threading.CancellationToken)">
  11041. <inheritdoc />
  11042. </member>
  11043. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Finish">
  11044. <summary>
  11045. Finishes the stream. This will write the central directory at the
  11046. end of the zip file and flush the stream.
  11047. </summary>
  11048. <remarks>
  11049. This is automatically called when the stream is closed.
  11050. </remarks>
  11051. <exception cref="T:System.IO.IOException">
  11052. An I/O error occurs.
  11053. </exception>
  11054. <exception cref="T:ICSharpCode.SharpZipLib.Zip.ZipException">
  11055. Comment exceeds the maximum length<br/>
  11056. Entry name exceeds the maximum length
  11057. </exception>
  11058. </member>
  11059. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.FinishAsync(System.Threading.CancellationToken)">
  11060. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Finish"/>>
  11061. </member>
  11062. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.Flush">
  11063. <summary>
  11064. Flushes the stream by calling <see cref="M:ICSharpCode.SharpZipLib.Zip.Compression.Streams.DeflaterOutputStream.Flush">Flush</see> on the deflater stream unless
  11065. the current compression method is <see cref="F:ICSharpCode.SharpZipLib.Zip.CompressionMethod.Stored"/>. Then it flushes the underlying output stream.
  11066. </summary>
  11067. </member>
  11068. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.entries">
  11069. <summary>
  11070. The entries for the archive.
  11071. </summary>
  11072. </member>
  11073. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.crc">
  11074. <summary>
  11075. Used to track the crc of data added to entries.
  11076. </summary>
  11077. </member>
  11078. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.curEntry">
  11079. <summary>
  11080. The current entry being added.
  11081. </summary>
  11082. </member>
  11083. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.size">
  11084. <summary>
  11085. Used to track the size of data for an entry during writing.
  11086. </summary>
  11087. </member>
  11088. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.offset">
  11089. <summary>
  11090. Offset to be recorded for each entry in the central header.
  11091. </summary>
  11092. </member>
  11093. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.zipComment">
  11094. <summary>
  11095. Comment for the entire archive recorded in central header.
  11096. </summary>
  11097. </member>
  11098. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.patchEntryHeader">
  11099. <summary>
  11100. Flag indicating that header patching is required for the current entry.
  11101. </summary>
  11102. </member>
  11103. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.patchData">
  11104. <summary>
  11105. The values to patch in the entry local header
  11106. </summary>
  11107. </member>
  11108. <member name="F:ICSharpCode.SharpZipLib.Zip.ZipOutputStream.password">
  11109. <summary>
  11110. The password to use when encrypting archive entries.
  11111. </summary>
  11112. </member>
  11113. <member name="T:ICSharpCode.SharpZipLib.Zip.ZipStrings">
  11114. <summary>
  11115. Deprecated way of setting zip encoding provided for backwards compability.
  11116. Use <see cref="T:ICSharpCode.SharpZipLib.Zip.StringCodec"/> when possible.
  11117. </summary>
  11118. <remarks>
  11119. If any ZipStrings properties are being modified, it will enter a backwards compatibility mode, mimicking the
  11120. old behaviour where a single instance was shared between all Zip* instances.
  11121. </remarks>
  11122. </member>
  11123. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.GetStringCodec">
  11124. <summary>
  11125. Returns a new <see cref="T:ICSharpCode.SharpZipLib.Zip.StringCodec"/> instance or the shared backwards compatible instance.
  11126. </summary>
  11127. <returns></returns>
  11128. </member>
  11129. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.CodePage">
  11130. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11131. </member>
  11132. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.SystemDefaultCodePage">
  11133. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11134. </member>
  11135. <member name="P:ICSharpCode.SharpZipLib.Zip.ZipStrings.UseUnicode">
  11136. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11137. </member>
  11138. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.HasUnicodeFlag(System.Int32)">
  11139. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11140. </member>
  11141. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToString(System.Byte[],System.Int32)">
  11142. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11143. </member>
  11144. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToString(System.Byte[])">
  11145. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11146. </member>
  11147. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToStringExt(System.Int32,System.Byte[],System.Int32)">
  11148. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11149. </member>
  11150. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToStringExt(System.Int32,System.Byte[])">
  11151. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11152. </member>
  11153. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToArray(System.String)">
  11154. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11155. </member>
  11156. <member name="M:ICSharpCode.SharpZipLib.Zip.ZipStrings.ConvertToArray(System.Int32,System.String)">
  11157. <inheritdoc cref="T:ICSharpCode.SharpZipLib.Zip.ZipStrings"/>
  11158. </member>
  11159. <member name="T:ICSharpCode.SharpZipLib.Zip.StringCodec">
  11160. <summary>
  11161. Utility class for resolving the encoding used for reading and writing strings
  11162. </summary>
  11163. </member>
  11164. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.Default">
  11165. <summary>
  11166. Creates a StringCodec that uses the system default encoder or UTF-8 depending on whether the zip entry Unicode flag is set
  11167. </summary>
  11168. </member>
  11169. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.FromCodePage(System.Int32)">
  11170. <summary>
  11171. Creates a StringCodec that uses an encoding from the specified code page except for zip entries with the Unicode flag
  11172. </summary>
  11173. </member>
  11174. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.FromEncoding(System.Text.Encoding)">
  11175. <summary>
  11176. Creates a StringCodec that uses an the specified encoding, except for zip entries with the Unicode flag
  11177. </summary>
  11178. </member>
  11179. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.WithStrictSpecEncoding">
  11180. <summary>
  11181. Creates a StringCodec that uses the zip specification encoder or UTF-8 depending on whether the zip entry Unicode flag is set
  11182. </summary>
  11183. </member>
  11184. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ForceZipLegacyEncoding">
  11185. <summary>
  11186. If set, use the encoding set by <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.CodePage"/> for zip entries instead of the defaults
  11187. </summary>
  11188. </member>
  11189. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.DefaultZipCryptoEncoding">
  11190. <summary>
  11191. The default encoding used for ZipCrypto passwords in zip files, set to <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.SystemDefaultEncoding"/>
  11192. for greatest compability.
  11193. </summary>
  11194. </member>
  11195. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipOutputEncoding">
  11196. <summary>
  11197. Returns the encoding for an output <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/>.
  11198. Unless overriden by <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ForceZipLegacyEncoding"/> it returns <see cref="F:ICSharpCode.SharpZipLib.Zip.StringCodec.UnicodeZipEncoding"/>.
  11199. </summary>
  11200. </member>
  11201. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipEncoding(System.Boolean)">
  11202. <summary>
  11203. Returns <see cref="F:ICSharpCode.SharpZipLib.Zip.StringCodec.UnicodeZipEncoding"/> if <paramref name="unicode"/> is set, otherwise it returns the encoding indicated by <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.CodePage"/>
  11204. </summary>
  11205. </member>
  11206. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipInputEncoding(ICSharpCode.SharpZipLib.Zip.GeneralBitFlags)">
  11207. <summary>
  11208. Returns the appropriate encoding for an input <see cref="T:ICSharpCode.SharpZipLib.Zip.ZipEntry"/> according to <paramref name="flags"/>.
  11209. If overridden by <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ForceZipLegacyEncoding"/>, it always returns the encoding indicated by <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.CodePage"/>.
  11210. </summary>
  11211. <param name="flags"></param>
  11212. <returns></returns>
  11213. </member>
  11214. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipInputEncoding(System.Int32)">
  11215. <inheritdoc cref="M:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipInputEncoding(ICSharpCode.SharpZipLib.Zip.GeneralBitFlags)"/>
  11216. </member>
  11217. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.LegacyEncoding">
  11218. <summary>Code page encoding, used for non-unicode strings</summary>
  11219. <remarks>
  11220. The original Zip specification (https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT) states
  11221. that file names should only be encoded with IBM Code Page 437 or UTF-8.
  11222. In practice, most zip apps use OEM or system encoding (typically cp437 on Windows).
  11223. </remarks>
  11224. </member>
  11225. <member name="F:ICSharpCode.SharpZipLib.Zip.StringCodec.UnicodeZipEncoding">
  11226. <summary>
  11227. Returns the UTF-8 code page (65001) used for zip entries with unicode flag set
  11228. </summary>
  11229. </member>
  11230. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.CodePage">
  11231. <summary>
  11232. Code page used for non-unicode strings and legacy zip encoding (if <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ForceZipLegacyEncoding"/> is set).
  11233. Default value is <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.SystemDefaultCodePage"/>
  11234. </summary>
  11235. </member>
  11236. <member name="F:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipSpecCodePage">
  11237. <summary>
  11238. The non-unicode code page that should be used according to the zip specification
  11239. </summary>
  11240. </member>
  11241. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.SystemDefaultCodePage">
  11242. <summary>
  11243. Operating system default codepage.
  11244. </summary>
  11245. </member>
  11246. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.SystemDefaultEncoding">
  11247. <summary>
  11248. The system default encoding.
  11249. </summary>
  11250. </member>
  11251. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipArchiveCommentEncoding">
  11252. <summary>
  11253. The encoding used for the zip archive comment. Defaults to the encoding for <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.CodePage"/>, since
  11254. no unicode flag can be set for it in the files.
  11255. </summary>
  11256. </member>
  11257. <member name="P:ICSharpCode.SharpZipLib.Zip.StringCodec.ZipCryptoEncoding">
  11258. <summary>
  11259. The encoding used for the ZipCrypto passwords. Defaults to <see cref="P:ICSharpCode.SharpZipLib.Zip.StringCodec.DefaultZipCryptoEncoding"/>.
  11260. </summary>
  11261. </member>
  11262. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.WithZipArchiveCommentEncoding(System.Text.Encoding)">
  11263. <summary>
  11264. Create a copy of this StringCodec with the specified zip archive comment encoding
  11265. </summary>
  11266. <param name="commentEncoding"></param>
  11267. <returns></returns>
  11268. </member>
  11269. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.WithZipCryptoEncoding(System.Text.Encoding)">
  11270. <summary>
  11271. Create a copy of this StringCodec with the specified zip crypto password encoding
  11272. </summary>
  11273. <param name="cryptoEncoding"></param>
  11274. <returns></returns>
  11275. </member>
  11276. <member name="M:ICSharpCode.SharpZipLib.Zip.StringCodec.WithForcedLegacyEncoding">
  11277. <summary>
  11278. Create a copy of this StringCodec that ignores the Unicode flag when reading entries
  11279. </summary>
  11280. <returns></returns>
  11281. </member>
  11282. </members>
  11283. </doc>