No Description

log4net.xml 1.3MB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366283672836828369283702837128372283732837428375283762837728378283792838028381283822838328384283852838628387283882838928390283912839228393283942839528396283972839828399284002840128402284032840428405284062840728408284092841028411284122841328414284152841628417284182841928420284212842228423284242842528426284272842828429284302843128432284332843428435284362843728438284392844028441284422844328444284452844628447284482844928450284512845228453284542845528456284572845828459284602846128462284632846428465284662846728468284692847028471284722847328474284752847628477284782847928480284812848228483284842848528486284872848828489284902849128492284932849428495284962849728498284992850028501285022850328504285052850628507285082850928510285112851228513285142851528516285172851828519285202852128522285232852428525285262852728528285292853028531285322853328534285352853628537285382853928540285412854228543285442854528546285472854828549285502855128552285532855428555285562855728558285592856028561285622856328564285652856628567285682856928570285712857228573285742857528576285772857828579285802858128582285832858428585285862858728588285892859028591285922859328594285952859628597285982859928600286012860228603286042860528606286072860828609286102861128612286132861428615286162861728618286192862028621286222862328624286252862628627286282862928630286312863228633286342863528636286372863828639286402864128642286432864428645286462864728648286492865028651286522865328654286552865628657286582865928660286612866228663286642866528666286672866828669286702867128672286732867428675286762867728678286792868028681286822868328684286852868628687286882868928690286912869228693286942869528696286972869828699287002870128702287032870428705287062870728708287092871028711287122871328714287152871628717287182871928720287212872228723287242872528726287272872828729287302873128732287332873428735287362873728738287392874028741287422874328744287452874628747287482874928750287512875228753287542875528756287572875828759287602876128762287632876428765287662876728768287692877028771287722877328774287752877628777287782877928780287812878228783287842878528786287872878828789287902879128792287932879428795287962879728798287992880028801288022880328804288052880628807288082880928810288112881228813288142881528816288172881828819288202882128822288232882428825288262882728828288292883028831288322883328834288352883628837288382883928840288412884228843288442884528846288472884828849288502885128852288532885428855288562885728858288592886028861288622886328864288652886628867288682886928870288712887228873288742887528876288772887828879288802888128882288832888428885288862888728888288892889028891288922889328894288952889628897288982889928900289012890228903289042890528906289072890828909289102891128912289132891428915289162891728918289192892028921289222892328924289252892628927289282892928930289312893228933289342893528936289372893828939289402894128942289432894428945289462894728948289492895028951289522895328954289552895628957289582895928960289612896228963289642896528966289672896828969289702897128972289732897428975289762897728978289792898028981289822898328984289852898628987289882898928990289912899228993289942899528996289972899828999290002900129002290032900429005290062900729008290092901029011290122901329014290152901629017290182901929020290212902229023290242902529026290272902829029290302903129032290332903429035290362903729038290392904029041290422904329044290452904629047290482904929050290512905229053290542905529056290572905829059290602906129062290632906429065290662906729068290692907029071290722907329074290752907629077290782907929080290812908229083290842908529086290872908829089290902909129092290932909429095290962909729098290992910029101291022910329104291052910629107291082910929110291112911229113291142911529116291172911829119291202912129122291232912429125291262912729128291292913029131291322913329134291352913629137291382913929140291412914229143291442914529146291472914829149291502915129152291532915429155291562915729158291592916029161291622916329164291652916629167291682916929170291712917229173291742917529176291772917829179291802918129182291832918429185291862918729188291892919029191291922919329194291952919629197291982919929200292012920229203292042920529206292072920829209292102921129212292132921429215292162921729218292192922029221292222922329224292252922629227292282922929230292312923229233292342923529236292372923829239292402924129242292432924429245292462924729248292492925029251292522925329254292552925629257292582925929260292612926229263292642926529266292672926829269292702927129272292732927429275292762927729278292792928029281292822928329284292852928629287292882928929290292912929229293292942929529296292972929829299293002930129302293032930429305293062930729308293092931029311293122931329314293152931629317293182931929320293212932229323293242932529326293272932829329293302933129332293332933429335293362933729338293392934029341293422934329344293452934629347293482934929350293512935229353293542935529356293572935829359293602936129362293632936429365293662936729368293692937029371293722937329374293752937629377293782937929380293812938229383293842938529386293872938829389293902939129392293932939429395293962939729398293992940029401294022940329404294052940629407294082940929410294112941229413294142941529416294172941829419294202942129422294232942429425294262942729428294292943029431294322943329434294352943629437294382943929440294412944229443294442944529446294472944829449294502945129452294532945429455294562945729458294592946029461294622946329464294652946629467294682946929470294712947229473294742947529476294772947829479294802948129482294832948429485294862948729488294892949029491294922949329494294952949629497294982949929500295012950229503295042950529506295072950829509295102951129512295132951429515295162951729518295192952029521295222952329524295252952629527295282952929530295312953229533295342953529536295372953829539295402954129542295432954429545295462954729548295492955029551295522955329554295552955629557295582955929560295612956229563295642956529566295672956829569295702957129572295732957429575295762957729578295792958029581295822958329584295852958629587295882958929590295912959229593295942959529596295972959829599296002960129602296032960429605296062960729608296092961029611296122961329614296152961629617296182961929620296212962229623296242962529626296272962829629296302963129632296332963429635296362963729638296392964029641296422964329644296452964629647296482964929650296512965229653296542965529656296572965829659296602966129662296632966429665296662966729668296692967029671296722967329674296752967629677296782967929680296812968229683296842968529686296872968829689296902969129692296932969429695296962969729698296992970029701297022970329704297052970629707297082970929710297112971229713297142971529716297172971829719297202972129722297232972429725297262972729728297292973029731297322973329734297352973629737297382973929740297412974229743297442974529746297472974829749297502975129752297532975429755297562975729758297592976029761297622976329764297652976629767297682976929770297712977229773297742977529776297772977829779297802978129782297832978429785297862978729788297892979029791297922979329794297952979629797297982979929800298012980229803298042980529806298072980829809298102981129812298132981429815298162981729818298192982029821298222982329824298252982629827298282982929830298312983229833298342983529836298372983829839298402984129842298432984429845298462984729848298492985029851298522985329854298552985629857298582985929860298612986229863298642986529866298672986829869298702987129872298732987429875298762987729878298792988029881298822988329884298852988629887298882988929890298912989229893298942989529896298972989829899299002990129902299032990429905299062990729908299092991029911299122991329914299152991629917299182991929920299212992229923299242992529926299272992829929299302993129932299332993429935299362993729938299392994029941299422994329944299452994629947299482994929950299512995229953299542995529956299572995829959299602996129962299632996429965299662996729968299692997029971299722997329974299752997629977299782997929980299812998229983299842998529986299872998829989299902999129992299932999429995299962999729998299993000030001300023000330004300053000630007300083000930010300113001230013300143001530016300173001830019300203002130022300233002430025300263002730028300293003030031300323003330034300353003630037300383003930040300413004230043300443004530046300473004830049300503005130052300533005430055300563005730058300593006030061300623006330064300653006630067300683006930070300713007230073300743007530076300773007830079300803008130082300833008430085300863008730088300893009030091300923009330094300953009630097300983009930100301013010230103301043010530106301073010830109301103011130112301133011430115301163011730118301193012030121301223012330124301253012630127301283012930130301313013230133301343013530136301373013830139301403014130142301433014430145301463014730148301493015030151301523015330154301553015630157301583015930160301613016230163301643016530166301673016830169301703017130172301733017430175301763017730178301793018030181301823018330184301853018630187301883018930190301913019230193301943019530196301973019830199302003020130202302033020430205302063020730208302093021030211302123021330214302153021630217302183021930220302213022230223302243022530226302273022830229302303023130232302333023430235302363023730238302393024030241302423024330244302453024630247302483024930250302513025230253302543025530256302573025830259302603026130262302633026430265302663026730268302693027030271302723027330274302753027630277302783027930280302813028230283302843028530286302873028830289302903029130292302933029430295302963029730298302993030030301303023030330304303053030630307303083030930310303113031230313303143031530316303173031830319303203032130322303233032430325303263032730328303293033030331303323033330334303353033630337303383033930340303413034230343303443034530346303473034830349303503035130352303533035430355303563035730358303593036030361303623036330364303653036630367303683036930370303713037230373303743037530376303773037830379303803038130382303833038430385303863038730388303893039030391303923039330394303953039630397303983039930400304013040230403304043040530406304073040830409304103041130412304133041430415304163041730418304193042030421304223042330424304253042630427304283042930430304313043230433304343043530436304373043830439304403044130442304433044430445304463044730448304493045030451304523045330454304553045630457304583045930460304613046230463304643046530466304673046830469304703047130472304733047430475304763047730478304793048030481304823048330484304853048630487304883048930490304913049230493304943049530496304973049830499305003050130502305033050430505305063050730508305093051030511305123051330514305153051630517305183051930520305213052230523305243052530526
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>log4net</name>
  5. </assembly>
  6. <members>
  7. <member name="T:log4net.Appender.AdoNetAppender">
  8. <summary>
  9. Appender that logs to a database.
  10. </summary>
  11. <remarks>
  12. <para>
  13. <see cref="T:log4net.Appender.AdoNetAppender"/> appends logging events to a table within a
  14. database. The appender can be configured to specify the connection
  15. string by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionString"/> property.
  16. The connection type (provider) can be specified by setting the <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/>
  17. property. For more information on database connection strings for
  18. your specific database see <a href="http://www.connectionstrings.com/">http://www.connectionstrings.com/</a>.
  19. </para>
  20. <para>
  21. Records are written into the database either using a prepared
  22. statement or a stored procedure. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property
  23. is set to <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify a prepared statement
  24. or to <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify a stored
  25. procedure.
  26. </para>
  27. <para>
  28. The prepared statement text or the name of the stored procedure
  29. must be set in the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property.
  30. </para>
  31. <para>
  32. The prepared statement or stored procedure can take a number
  33. of parameters. Parameters are added using the <see cref="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)"/>
  34. method. This adds a single <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> to the
  35. ordered list of parameters. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/>
  36. type may be subclassed if required to provide database specific
  37. functionality. The <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> specifies
  38. the parameter name, database type, size, and how the value should
  39. be generated using a <see cref="T:log4net.Layout.ILayout"/>.
  40. </para>
  41. </remarks>
  42. <example>
  43. An example of a SQL Server table that could be logged to:
  44. <code lang="SQL">
  45. CREATE TABLE [dbo].[Log] (
  46. [ID] [int] IDENTITY (1, 1) NOT NULL ,
  47. [Date] [datetime] NOT NULL ,
  48. [Thread] [varchar] (255) NOT NULL ,
  49. [Level] [varchar] (20) NOT NULL ,
  50. [Logger] [varchar] (255) NOT NULL ,
  51. [Message] [varchar] (4000) NOT NULL
  52. ) ON [PRIMARY]
  53. </code>
  54. </example>
  55. <example>
  56. An example configuration to log to the above table:
  57. <code lang="XML" escaped="true">
  58. <appender name="AdoNetAppender_SqlServer" type="log4net.Appender.AdoNetAppender">
  59. <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"/>
  60. <connectionString value="data source=SQLSVR;initial catalog=test_log4net;integrated security=false;persist security info=True;User ID=sa;Password=sa"/>
  61. <commandText value="INSERT INTO Log ([Date],[Thread],[Level],[Logger],[Message]) VALUES (@log_date, @thread, @log_level, @logger, @message)"/>
  62. <parameter>
  63. <parameterName value="@log_date"/>
  64. <dbType value="DateTime"/>
  65. <layout type="log4net.Layout.PatternLayout" value="%date{yyyy'-'MM'-'dd HH':'mm':'ss'.'fff}"/>
  66. </parameter>
  67. <parameter>
  68. <parameterName value="@thread"/>
  69. <dbType value="String"/>
  70. <size value="255"/>
  71. <layout type="log4net.Layout.PatternLayout" value="%thread"/>
  72. </parameter>
  73. <parameter>
  74. <parameterName value="@log_level"/>
  75. <dbType value="String"/>
  76. <size value="50"/>
  77. <layout type="log4net.Layout.PatternLayout" value="%level"/>
  78. </parameter>
  79. <parameter>
  80. <parameterName value="@logger"/>
  81. <dbType value="String"/>
  82. <size value="255"/>
  83. <layout type="log4net.Layout.PatternLayout" value="%logger"/>
  84. </parameter>
  85. <parameter>
  86. <parameterName value="@message"/>
  87. <dbType value="String"/>
  88. <size value="4000"/>
  89. <layout type="log4net.Layout.PatternLayout" value="%message"/>
  90. </parameter>
  91. </appender>
  92. </code>
  93. </example>
  94. <author>Julian Biddle</author>
  95. <author>Nicko Cadell</author>
  96. <author>Gert Driesen</author>
  97. <author>Lance Nehring</author>
  98. </member>
  99. <member name="T:log4net.Appender.BufferingAppenderSkeleton">
  100. <summary>
  101. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
  102. buffers events in a fixed size buffer.
  103. </summary>
  104. <remarks>
  105. <para>
  106. This base class should be used by appenders that need to buffer a
  107. number of events before logging them. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
  108. buffers events and then submits the entire contents of the buffer to
  109. the underlying database in one go.
  110. </para>
  111. <para>
  112. Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
  113. method to deliver the buffered events.
  114. </para>
  115. <para>The BufferingAppenderSkeleton maintains a fixed size cyclic
  116. buffer of events. The size of the buffer is set using
  117. the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
  118. </para>
  119. <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
  120. each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  121. triggers, then the current buffer is sent immediately
  122. (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
  123. is stored in the buffer. For example, an evaluator can be used to
  124. deliver the events immediately when an ERROR event arrives.
  125. </para>
  126. <para>
  127. The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
  128. By default the appender is NOT lossy. When the buffer is full all
  129. the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
  130. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
  131. buffer will not be sent when it is full, and new events arriving
  132. in the appender will overwrite the oldest event in the buffer.
  133. In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  134. triggers. This can be useful behavior when you need to know about
  135. ERROR events but not about events with a lower level, configure an
  136. evaluator that will trigger when an ERROR event arrives, the whole
  137. buffer will be sent which gives a history of events leading up to
  138. the ERROR event.
  139. </para>
  140. </remarks>
  141. <author>Nicko Cadell</author>
  142. <author>Gert Driesen</author>
  143. </member>
  144. <member name="T:log4net.Appender.AppenderSkeleton">
  145. <summary>
  146. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
  147. </summary>
  148. <remarks>
  149. <para>
  150. This class provides the code for common functionality, such
  151. as support for threshold filtering and support for general filters.
  152. </para>
  153. <para>
  154. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  155. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  156. be called after the appenders properties have been configured.
  157. </para>
  158. </remarks>
  159. <author>Nicko Cadell</author>
  160. <author>Gert Driesen</author>
  161. </member>
  162. <member name="T:log4net.Appender.IAppender">
  163. <summary>
  164. Implement this interface for your own strategies for printing log statements.
  165. </summary>
  166. <remarks>
  167. <para>
  168. Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
  169. class which provides a default implementation of this interface.
  170. </para>
  171. <para>
  172. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  173. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  174. be called after the appenders properties have been configured.
  175. </para>
  176. </remarks>
  177. <author>Nicko Cadell</author>
  178. <author>Gert Driesen</author>
  179. </member>
  180. <member name="M:log4net.Appender.IAppender.Close">
  181. <summary>
  182. Closes the appender and releases resources.
  183. </summary>
  184. <remarks>
  185. <para>
  186. Releases any resources allocated within the appender such as file handles,
  187. network connections, etc.
  188. </para>
  189. <para>
  190. It is a programming error to append to a closed appender.
  191. </para>
  192. </remarks>
  193. </member>
  194. <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
  195. <summary>
  196. Log the logging event in Appender specific way.
  197. </summary>
  198. <param name="loggingEvent">The event to log</param>
  199. <remarks>
  200. <para>
  201. This method is called to log a message into this appender.
  202. </para>
  203. </remarks>
  204. </member>
  205. <member name="P:log4net.Appender.IAppender.Name">
  206. <summary>
  207. Gets or sets the name of this appender.
  208. </summary>
  209. <value>The name of the appender.</value>
  210. <remarks>
  211. <para>The name uniquely identifies the appender.</para>
  212. </remarks>
  213. </member>
  214. <member name="T:log4net.Appender.IBulkAppender">
  215. <summary>
  216. Interface for appenders that support bulk logging.
  217. </summary>
  218. <remarks>
  219. <para>
  220. This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
  221. support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
  222. should only implement this interface if they can bulk log efficiently.
  223. </para>
  224. </remarks>
  225. <author>Nicko Cadell</author>
  226. </member>
  227. <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
  228. <summary>
  229. Log the array of logging events in Appender specific way.
  230. </summary>
  231. <param name="loggingEvents">The events to log</param>
  232. <remarks>
  233. <para>
  234. This method is called to log an array of events into this appender.
  235. </para>
  236. </remarks>
  237. </member>
  238. <member name="T:log4net.Core.IOptionHandler">
  239. <summary>
  240. Interface used to delay activate a configured object.
  241. </summary>
  242. <remarks>
  243. <para>
  244. This allows an object to defer activation of its options until all
  245. options have been set. This is required for components which have
  246. related options that remain ambiguous until all are set.
  247. </para>
  248. <para>
  249. If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
  250. must be called by the container after its all the configured properties have been set
  251. and before the component can be used.
  252. </para>
  253. </remarks>
  254. <author>Nicko Cadell</author>
  255. </member>
  256. <member name="M:log4net.Core.IOptionHandler.ActivateOptions">
  257. <summary>
  258. Activate the options that were previously set with calls to properties.
  259. </summary>
  260. <remarks>
  261. <para>
  262. This allows an object to defer activation of its options until all
  263. options have been set. This is required for components which have
  264. related options that remain ambiguous until all are set.
  265. </para>
  266. <para>
  267. If a component implements this interface then this method must be called
  268. after its properties have been set before the component can be used.
  269. </para>
  270. </remarks>
  271. </member>
  272. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
  273. <summary>
  274. Initial buffer size
  275. </summary>
  276. </member>
  277. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
  278. <summary>
  279. Maximum buffer size before it is recycled
  280. </summary>
  281. </member>
  282. <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
  283. <summary>
  284. Default constructor
  285. </summary>
  286. <remarks>
  287. <para>Empty default constructor</para>
  288. </remarks>
  289. </member>
  290. <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
  291. <summary>
  292. Finalizes this appender by calling the implementation's
  293. <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
  294. </summary>
  295. <remarks>
  296. <para>
  297. If this appender has not been closed then the <c>Finalize</c> method
  298. will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
  299. </para>
  300. </remarks>
  301. </member>
  302. <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
  303. <summary>
  304. Initialize the appender based on the options set
  305. </summary>
  306. <remarks>
  307. <para>
  308. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  309. activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
  310. be called on this object after the configuration properties have
  311. been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
  312. object is in an undefined state and must not be used.
  313. </para>
  314. <para>
  315. If any of the configuration properties are modified then
  316. <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
  317. </para>
  318. </remarks>
  319. </member>
  320. <member name="M:log4net.Appender.AppenderSkeleton.Close">
  321. <summary>
  322. Closes the appender and release resources.
  323. </summary>
  324. <remarks>
  325. <para>
  326. Release any resources allocated within the appender such as file handles,
  327. network connections, etc.
  328. </para>
  329. <para>
  330. It is a programming error to append to a closed appender.
  331. </para>
  332. <para>
  333. This method cannot be overridden by subclasses. This method
  334. delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
  335. method which must be overridden in the subclass.
  336. </para>
  337. </remarks>
  338. </member>
  339. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
  340. <summary>
  341. Performs threshold checks and invokes filters before
  342. delegating actual logging to the subclasses specific
  343. <see cref="M:Append(LoggingEvent)"/> method.
  344. </summary>
  345. <param name="loggingEvent">The event to log.</param>
  346. <remarks>
  347. <para>
  348. This method cannot be overridden by derived classes. A
  349. derived class should override the <see cref="M:Append(LoggingEvent)"/> method
  350. which is called by this method.
  351. </para>
  352. <para>
  353. The implementation of this method is as follows:
  354. </para>
  355. <para>
  356. <list type="bullet">
  357. <item>
  358. <description>
  359. Checks that the severity of the <paramref name="loggingEvent"/>
  360. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  361. appender.</description>
  362. </item>
  363. <item>
  364. <description>
  365. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  366. <paramref name="loggingEvent"/>.
  367. </description>
  368. </item>
  369. <item>
  370. <description>
  371. Calls <see cref="M:PreAppendCheck()"/> and checks that
  372. it returns <c>true</c>.</description>
  373. </item>
  374. </list>
  375. </para>
  376. <para>
  377. If all of the above steps succeed then the <paramref name="loggingEvent"/>
  378. will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  379. </para>
  380. </remarks>
  381. </member>
  382. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
  383. <summary>
  384. Performs threshold checks and invokes filters before
  385. delegating actual logging to the subclasses specific
  386. <see cref="M:Append(LoggingEvent[])"/> method.
  387. </summary>
  388. <param name="loggingEvents">The array of events to log.</param>
  389. <remarks>
  390. <para>
  391. This method cannot be overridden by derived classes. A
  392. derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
  393. which is called by this method.
  394. </para>
  395. <para>
  396. The implementation of this method is as follows:
  397. </para>
  398. <para>
  399. <list type="bullet">
  400. <item>
  401. <description>
  402. Checks that the severity of the <paramref name="loggingEvents"/>
  403. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  404. appender.</description>
  405. </item>
  406. <item>
  407. <description>
  408. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  409. <paramref name="loggingEvents"/>.
  410. </description>
  411. </item>
  412. <item>
  413. <description>
  414. Calls <see cref="M:PreAppendCheck()"/> and checks that
  415. it returns <c>true</c>.</description>
  416. </item>
  417. </list>
  418. </para>
  419. <para>
  420. If all of the above steps succeed then the <paramref name="loggingEvents"/>
  421. will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
  422. </para>
  423. </remarks>
  424. </member>
  425. <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
  426. <summary>
  427. Test if the logging event should we output by this appender
  428. </summary>
  429. <param name="loggingEvent">the event to test</param>
  430. <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
  431. <remarks>
  432. <para>
  433. This method checks the logging event against the threshold level set
  434. on this appender and also against the filters specified on this
  435. appender.
  436. </para>
  437. <para>
  438. The implementation of this method is as follows:
  439. </para>
  440. <para>
  441. <list type="bullet">
  442. <item>
  443. <description>
  444. Checks that the severity of the <paramref name="loggingEvent"/>
  445. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  446. appender.</description>
  447. </item>
  448. <item>
  449. <description>
  450. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  451. <paramref name="loggingEvent"/>.
  452. </description>
  453. </item>
  454. </list>
  455. </para>
  456. </remarks>
  457. </member>
  458. <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
  459. <summary>
  460. Adds a filter to the end of the filter chain.
  461. </summary>
  462. <param name="filter">the filter to add to this appender</param>
  463. <remarks>
  464. <para>
  465. The Filters are organized in a linked list.
  466. </para>
  467. <para>
  468. Setting this property causes the new filter to be pushed onto the
  469. back of the filter chain.
  470. </para>
  471. </remarks>
  472. </member>
  473. <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
  474. <summary>
  475. Clears the filter list for this appender.
  476. </summary>
  477. <remarks>
  478. <para>
  479. Clears the filter list for this appender.
  480. </para>
  481. </remarks>
  482. </member>
  483. <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
  484. <summary>
  485. Checks if the message level is below this appender's threshold.
  486. </summary>
  487. <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
  488. <remarks>
  489. <para>
  490. If there is no threshold set, then the return value is always <c>true</c>.
  491. </para>
  492. </remarks>
  493. <returns>
  494. <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
  495. requirements of this appender.
  496. </returns>
  497. </member>
  498. <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
  499. <summary>
  500. Is called when the appender is closed. Derived classes should override
  501. this method if resources need to be released.
  502. </summary>
  503. <remarks>
  504. <para>
  505. Releases any resources allocated within the appender such as file handles,
  506. network connections, etc.
  507. </para>
  508. <para>
  509. It is a programming error to append to a closed appender.
  510. </para>
  511. </remarks>
  512. </member>
  513. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  514. <summary>
  515. Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
  516. to perform actual logging.
  517. </summary>
  518. <param name="loggingEvent">The event to append.</param>
  519. <remarks>
  520. <para>
  521. A subclass must implement this method to perform
  522. logging of the <paramref name="loggingEvent"/>.
  523. </para>
  524. <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
  525. if all the conditions listed for that method are met.
  526. </para>
  527. <para>
  528. To restrict the logging of events in the appender
  529. override the <see cref="M:PreAppendCheck()"/> method.
  530. </para>
  531. </remarks>
  532. </member>
  533. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
  534. <summary>
  535. Append a bulk array of logging events.
  536. </summary>
  537. <param name="loggingEvents">the array of logging events</param>
  538. <remarks>
  539. <para>
  540. This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
  541. method for each element in the bulk array.
  542. </para>
  543. <para>
  544. A sub class that can better process a bulk array of events should
  545. override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
  546. </para>
  547. </remarks>
  548. </member>
  549. <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
  550. <summary>
  551. Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
  552. </summary>
  553. <remarks>
  554. <para>
  555. This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
  556. before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  557. </para>
  558. <para>
  559. This method can be overridden in a subclass to extend the checks
  560. made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
  561. </para>
  562. <para>
  563. A subclass should ensure that they delegate this call to
  564. this base class if it is overridden.
  565. </para>
  566. </remarks>
  567. <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
  568. </member>
  569. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
  570. <summary>
  571. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  572. </summary>
  573. <param name="loggingEvent">The event to render.</param>
  574. <returns>The event rendered as a string.</returns>
  575. <remarks>
  576. <para>
  577. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  578. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  579. set to render the <paramref name="loggingEvent"/> to
  580. a string.
  581. </para>
  582. <para>If there is exception data in the logging event and
  583. the layout does not process the exception, this method
  584. will append the exception text to the rendered string.
  585. </para>
  586. <para>
  587. Where possible use the alternative version of this method
  588. <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
  589. That method streams the rendering onto an existing Writer
  590. which can give better performance if the caller already has
  591. a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
  592. </para>
  593. </remarks>
  594. </member>
  595. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  596. <summary>
  597. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  598. </summary>
  599. <param name="loggingEvent">The event to render.</param>
  600. <param name="writer">The TextWriter to write the formatted event to</param>
  601. <remarks>
  602. <para>
  603. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  604. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  605. set to render the <paramref name="loggingEvent"/> to
  606. a string.
  607. </para>
  608. <para>If there is exception data in the logging event and
  609. the layout does not process the exception, this method
  610. will append the exception text to the rendered string.
  611. </para>
  612. <para>
  613. Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
  614. where possible. If, however, the caller needs to render the event
  615. to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
  616. provide an efficient mechanism for doing so.
  617. </para>
  618. </remarks>
  619. </member>
  620. <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
  621. <summary>
  622. The layout of this appender.
  623. </summary>
  624. <remarks>
  625. See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
  626. </remarks>
  627. </member>
  628. <member name="F:log4net.Appender.AppenderSkeleton.m_name">
  629. <summary>
  630. The name of this appender.
  631. </summary>
  632. <remarks>
  633. See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
  634. </remarks>
  635. </member>
  636. <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
  637. <summary>
  638. The level threshold of this appender.
  639. </summary>
  640. <remarks>
  641. <para>
  642. There is no level threshold filtering by default.
  643. </para>
  644. <para>
  645. See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
  646. </para>
  647. </remarks>
  648. </member>
  649. <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
  650. <summary>
  651. It is assumed and enforced that errorHandler is never null.
  652. </summary>
  653. <remarks>
  654. <para>
  655. It is assumed and enforced that errorHandler is never null.
  656. </para>
  657. <para>
  658. See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
  659. </para>
  660. </remarks>
  661. </member>
  662. <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
  663. <summary>
  664. The first filter in the filter chain.
  665. </summary>
  666. <remarks>
  667. <para>
  668. Set to <c>null</c> initially.
  669. </para>
  670. <para>
  671. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  672. </para>
  673. </remarks>
  674. </member>
  675. <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
  676. <summary>
  677. The last filter in the filter chain.
  678. </summary>
  679. <remarks>
  680. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  681. </remarks>
  682. </member>
  683. <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
  684. <summary>
  685. Flag indicating if this appender is closed.
  686. </summary>
  687. <remarks>
  688. See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
  689. </remarks>
  690. </member>
  691. <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
  692. <summary>
  693. The guard prevents an appender from repeatedly calling its own DoAppend method
  694. </summary>
  695. </member>
  696. <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
  697. <summary>
  698. StringWriter used to render events
  699. </summary>
  700. </member>
  701. <member name="F:log4net.Appender.AppenderSkeleton.declaringType">
  702. <summary>
  703. The fully qualified type of the AppenderSkeleton class.
  704. </summary>
  705. <remarks>
  706. Used by the internal logger to record the Type of the
  707. log message.
  708. </remarks>
  709. </member>
  710. <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
  711. <summary>
  712. Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
  713. </summary>
  714. <value>
  715. The threshold <see cref="T:log4net.Core.Level"/> of the appender.
  716. </value>
  717. <remarks>
  718. <para>
  719. All log events with lower level than the threshold level are ignored
  720. by the appender.
  721. </para>
  722. <para>
  723. In configuration files this option is specified by setting the
  724. value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
  725. string, such as "DEBUG", "INFO" and so on.
  726. </para>
  727. </remarks>
  728. </member>
  729. <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
  730. <summary>
  731. Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  732. </summary>
  733. <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
  734. <remarks>
  735. <para>
  736. The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
  737. implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
  738. </para>
  739. </remarks>
  740. </member>
  741. <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
  742. <summary>
  743. The filter chain.
  744. </summary>
  745. <value>The head of the filter chain filter chain.</value>
  746. <remarks>
  747. <para>
  748. Returns the head Filter. The Filters are organized in a linked list
  749. and so all Filters on this Appender are available through the result.
  750. </para>
  751. </remarks>
  752. </member>
  753. <member name="P:log4net.Appender.AppenderSkeleton.Layout">
  754. <summary>
  755. Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
  756. </summary>
  757. <value>The layout of the appender.</value>
  758. <remarks>
  759. <para>
  760. See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
  761. </para>
  762. </remarks>
  763. <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
  764. </member>
  765. <member name="P:log4net.Appender.AppenderSkeleton.Name">
  766. <summary>
  767. Gets or sets the name of this appender.
  768. </summary>
  769. <value>The name of the appender.</value>
  770. <remarks>
  771. <para>
  772. The name uniquely identifies the appender.
  773. </para>
  774. </remarks>
  775. </member>
  776. <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
  777. <summary>
  778. Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  779. </summary>
  780. <remarks>
  781. <para>
  782. In the rather exceptional case, where the appender
  783. implementation admits a layout but can also work without it,
  784. then the appender should return <c>true</c>.
  785. </para>
  786. <para>
  787. This default implementation always returns <c>false</c>.
  788. </para>
  789. </remarks>
  790. <returns>
  791. <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
  792. </returns>
  793. </member>
  794. <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
  795. <summary>
  796. The default buffer size.
  797. </summary>
  798. <remarks>
  799. The default size of the cyclic buffer used to store events.
  800. This is set to 512 by default.
  801. </remarks>
  802. </member>
  803. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
  804. <summary>
  805. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
  806. </summary>
  807. <remarks>
  808. <para>
  809. Protected default constructor to allow subclassing.
  810. </para>
  811. </remarks>
  812. </member>
  813. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
  814. <summary>
  815. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> class.
  816. </summary>
  817. <param name="eventMustBeFixed">the events passed through this appender must be
  818. fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
  819. <remarks>
  820. <para>
  821. Protected constructor to allow subclassing.
  822. </para>
  823. <para>
  824. The <paramref name="eventMustBeFixed"/> should be set if the subclass
  825. expects the events delivered to be fixed even if the
  826. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
  827. </para>
  828. </remarks>
  829. </member>
  830. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
  831. <summary>
  832. Flush the currently buffered events
  833. </summary>
  834. <remarks>
  835. <para>
  836. Flushes any events that have been buffered.
  837. </para>
  838. <para>
  839. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  840. of the buffer will NOT be flushed to the appender.
  841. </para>
  842. </remarks>
  843. </member>
  844. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
  845. <summary>
  846. Flush the currently buffered events
  847. </summary>
  848. <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
  849. <remarks>
  850. <para>
  851. Flushes events that have been buffered. If <paramref name="flushLossyBuffer"/> is
  852. <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
  853. </para>
  854. <para>
  855. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  856. of the buffer will only be flushed if <paramref name="flushLossyBuffer"/> is <c>true</c>.
  857. In this case the contents of the buffer will be tested against the
  858. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
  859. events will be discarded.
  860. </para>
  861. <para>
  862. If <paramref name="flushLossyBuffer"/> is <c>true</c> then the buffer will always
  863. be emptied by calling this method.
  864. </para>
  865. </remarks>
  866. </member>
  867. <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
  868. <summary>
  869. Initialize the appender based on the options set
  870. </summary>
  871. <remarks>
  872. <para>
  873. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  874. activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
  875. be called on this object after the configuration properties have
  876. been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
  877. object is in an undefined state and must not be used.
  878. </para>
  879. <para>
  880. If any of the configuration properties are modified then
  881. <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
  882. </para>
  883. </remarks>
  884. </member>
  885. <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
  886. <summary>
  887. Close this appender instance.
  888. </summary>
  889. <remarks>
  890. <para>
  891. Close this appender instance. If this appender is marked
  892. as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
  893. the buffer must be sent when the appender is closed.
  894. </para>
  895. </remarks>
  896. </member>
  897. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  898. <summary>
  899. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  900. </summary>
  901. <param name="loggingEvent">the event to log</param>
  902. <remarks>
  903. <para>
  904. Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
  905. </para>
  906. <para>
  907. The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
  908. method) if one of the following conditions is met:
  909. </para>
  910. <list type="bullet">
  911. <item>
  912. <description>The cyclic buffer is full and this appender is
  913. marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
  914. </item>
  915. <item>
  916. <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
  917. it is triggered for the <paramref name="loggingEvent"/>
  918. specified.</description>
  919. </item>
  920. </list>
  921. <para>
  922. Before the event is stored in the buffer it is fixed
  923. (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
  924. any data referenced by the event will be valid when the buffer
  925. is processed.
  926. </para>
  927. </remarks>
  928. </member>
  929. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
  930. <summary>
  931. Sends the contents of the buffer.
  932. </summary>
  933. <param name="firstLoggingEvent">The first logging event.</param>
  934. <param name="buffer">The buffer containing the events that need to be send.</param>
  935. <remarks>
  936. <para>
  937. The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
  938. </para>
  939. </remarks>
  940. </member>
  941. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
  942. <summary>
  943. Sends the events.
  944. </summary>
  945. <param name="events">The events that need to be send.</param>
  946. <remarks>
  947. <para>
  948. The subclass must override this method to process the buffered events.
  949. </para>
  950. </remarks>
  951. </member>
  952. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
  953. <summary>
  954. The size of the cyclic buffer used to hold the logging events.
  955. </summary>
  956. <remarks>
  957. Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
  958. </remarks>
  959. </member>
  960. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
  961. <summary>
  962. The cyclic buffer used to store the logging events.
  963. </summary>
  964. </member>
  965. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
  966. <summary>
  967. The triggering event evaluator that causes the buffer to be sent immediately.
  968. </summary>
  969. <remarks>
  970. The object that is used to determine if an event causes the entire
  971. buffer to be sent immediately. This field can be <c>null</c>, which
  972. indicates that event triggering is not to be done. The evaluator
  973. can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
  974. has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
  975. <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
  976. </remarks>
  977. </member>
  978. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
  979. <summary>
  980. Indicates if the appender should overwrite events in the cyclic buffer
  981. when it becomes full, or if the buffer should be flushed when the
  982. buffer is full.
  983. </summary>
  984. <remarks>
  985. If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
  986. be set.
  987. </remarks>
  988. </member>
  989. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
  990. <summary>
  991. The triggering event evaluator filters discarded events.
  992. </summary>
  993. <remarks>
  994. The object that is used to determine if an event that is discarded should
  995. really be discarded or if it should be sent to the appenders.
  996. This field can be <c>null</c>, which indicates that all discarded events will
  997. be discarded.
  998. </remarks>
  999. </member>
  1000. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
  1001. <summary>
  1002. Value indicating which fields in the event should be fixed
  1003. </summary>
  1004. <remarks>
  1005. By default all fields are fixed
  1006. </remarks>
  1007. </member>
  1008. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
  1009. <summary>
  1010. The events delivered to the subclass must be fixed.
  1011. </summary>
  1012. </member>
  1013. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
  1014. <summary>
  1015. Gets or sets a value that indicates whether the appender is lossy.
  1016. </summary>
  1017. <value>
  1018. <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
  1019. </value>
  1020. <remarks>
  1021. <para>
  1022. This appender uses a buffer to store logging events before
  1023. delivering them. A triggering event causes the whole buffer
  1024. to be send to the remote sink. If the buffer overruns before
  1025. a triggering event then logging events could be lost. Set
  1026. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
  1027. from being lost.
  1028. </para>
  1029. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  1030. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  1031. </remarks>
  1032. </member>
  1033. <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
  1034. <summary>
  1035. Gets or sets the size of the cyclic buffer used to hold the
  1036. logging events.
  1037. </summary>
  1038. <value>
  1039. The size of the cyclic buffer used to hold the logging events.
  1040. </value>
  1041. <remarks>
  1042. <para>
  1043. The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
  1044. representing the maximum number of logging events to collect in
  1045. a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
  1046. oldest events are deleted as new events are added to the
  1047. buffer. By default the size of the cyclic buffer is 512 events.
  1048. </para>
  1049. <para>
  1050. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
  1051. or equal to 1 then no buffering will occur. The logging event
  1052. will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
  1053. and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
  1054. be buffered.
  1055. </para>
  1056. </remarks>
  1057. </member>
  1058. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
  1059. <summary>
  1060. Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
  1061. buffer to be sent immediately.
  1062. </summary>
  1063. <value>
  1064. The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
  1065. sent immediately.
  1066. </value>
  1067. <remarks>
  1068. <para>
  1069. The evaluator will be called for each event that is appended to this
  1070. appender. If the evaluator triggers then the current buffer will
  1071. immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  1072. </para>
  1073. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  1074. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  1075. </remarks>
  1076. </member>
  1077. <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
  1078. <summary>
  1079. Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  1080. </summary>
  1081. <value>
  1082. The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  1083. </value>
  1084. <remarks>
  1085. <para>
  1086. The evaluator will be called for each event that is discarded from this
  1087. appender. If the evaluator triggers then the current buffer will immediately
  1088. be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  1089. </para>
  1090. </remarks>
  1091. </member>
  1092. <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
  1093. <summary>
  1094. Gets or sets a value indicating if only part of the logging event data
  1095. should be fixed.
  1096. </summary>
  1097. <value>
  1098. <c>true</c> if the appender should only fix part of the logging event
  1099. data, otherwise <c>false</c>. The default is <c>false</c>.
  1100. </value>
  1101. <remarks>
  1102. <para>
  1103. Setting this property to <c>true</c> will cause only part of the
  1104. event data to be fixed and serialized. This will improve performance.
  1105. </para>
  1106. <para>
  1107. See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
  1108. </para>
  1109. </remarks>
  1110. </member>
  1111. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
  1112. <summary>
  1113. Gets or sets a the fields that will be fixed in the event
  1114. </summary>
  1115. <value>
  1116. The event fields that will be fixed before the event is buffered
  1117. </value>
  1118. <remarks>
  1119. <para>
  1120. The logging event needs to have certain thread specific values
  1121. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  1122. for details.
  1123. </para>
  1124. </remarks>
  1125. <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
  1126. </member>
  1127. <member name="M:log4net.Appender.AdoNetAppender.#ctor">
  1128. <summary>
  1129. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender"/> class.
  1130. </summary>
  1131. <remarks>
  1132. Public default constructor to initialize a new instance of this class.
  1133. </remarks>
  1134. </member>
  1135. <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
  1136. <summary>
  1137. Initialize the appender based on the options set
  1138. </summary>
  1139. <remarks>
  1140. <para>
  1141. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  1142. activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
  1143. be called on this object after the configuration properties have
  1144. been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
  1145. object is in an undefined state and must not be used.
  1146. </para>
  1147. <para>
  1148. If any of the configuration properties are modified then
  1149. <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
  1150. </para>
  1151. </remarks>
  1152. </member>
  1153. <member name="M:log4net.Appender.AdoNetAppender.OnClose">
  1154. <summary>
  1155. Override the parent method to close the database
  1156. </summary>
  1157. <remarks>
  1158. <para>
  1159. Closes the database command and database connection.
  1160. </para>
  1161. </remarks>
  1162. </member>
  1163. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  1164. <summary>
  1165. Inserts the events into the database.
  1166. </summary>
  1167. <param name="events">The events to insert into the database.</param>
  1168. <remarks>
  1169. <para>
  1170. Insert all the events specified in the <paramref name="events"/>
  1171. array into the database.
  1172. </para>
  1173. </remarks>
  1174. </member>
  1175. <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
  1176. <summary>
  1177. Adds a parameter to the command.
  1178. </summary>
  1179. <param name="parameter">The parameter to add to the command.</param>
  1180. <remarks>
  1181. <para>
  1182. Adds a parameter to the ordered list of command parameters.
  1183. </para>
  1184. </remarks>
  1185. </member>
  1186. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
  1187. <summary>
  1188. Writes the events to the database using the transaction specified.
  1189. </summary>
  1190. <param name="dbTran">The transaction that the events will be executed under.</param>
  1191. <param name="events">The array of events to insert into the database.</param>
  1192. <remarks>
  1193. <para>
  1194. The transaction argument can be <c>null</c> if the appender has been
  1195. configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
  1196. property for more information.
  1197. </para>
  1198. </remarks>
  1199. </member>
  1200. <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
  1201. <summary>
  1202. Formats the log message into database statement text.
  1203. </summary>
  1204. <param name="logEvent">The event being logged.</param>
  1205. <remarks>
  1206. This method can be overridden by subclasses to provide
  1207. more control over the format of the database statement.
  1208. </remarks>
  1209. <returns>
  1210. Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
  1211. </returns>
  1212. </member>
  1213. <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
  1214. <summary>
  1215. Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
  1216. </summary>
  1217. <remarks>
  1218. This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
  1219. </remarks>
  1220. <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
  1221. <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
  1222. <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
  1223. </member>
  1224. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
  1225. <summary>
  1226. Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
  1227. property.
  1228. </summary>
  1229. <remarks>
  1230. ConnectiongStringName is only supported on .NET 2.0 and higher.
  1231. </remarks>
  1232. <param name="connectionStringContext">Additional information describing the connection string.</param>
  1233. <returns>A connection string used to connect to the database.</returns>
  1234. </member>
  1235. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
  1236. <summary>
  1237. Retrieves the class type of the ADO.NET provider.
  1238. </summary>
  1239. <remarks>
  1240. <para>
  1241. Gets the Type of the ADO.NET provider to use to connect to the
  1242. database. This method resolves the type specified in the
  1243. <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
  1244. </para>
  1245. <para>
  1246. Subclasses can override this method to return a different type
  1247. if necessary.
  1248. </para>
  1249. </remarks>
  1250. <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
  1251. </member>
  1252. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseCommand">
  1253. <summary>
  1254. Prepares the database command and initialize the parameters.
  1255. </summary>
  1256. </member>
  1257. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
  1258. <summary>
  1259. Connects to the database.
  1260. </summary>
  1261. </member>
  1262. <member name="M:log4net.Appender.AdoNetAppender.DisposeCommand(System.Boolean)">
  1263. <summary>
  1264. Cleanup the existing command.
  1265. </summary>
  1266. <param name="ignoreException">
  1267. If true, a message will be written using LogLog.Warn if an exception is encountered when calling Dispose.
  1268. </param>
  1269. </member>
  1270. <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
  1271. <summary>
  1272. Cleanup the existing connection.
  1273. </summary>
  1274. <remarks>
  1275. Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
  1276. </remarks>
  1277. </member>
  1278. <member name="F:log4net.Appender.AdoNetAppender.m_usePreparedCommand">
  1279. <summary>
  1280. Flag to indicate if we are using a command object
  1281. </summary>
  1282. <remarks>
  1283. <para>
  1284. Set to <c>true</c> when the appender is to use a prepared
  1285. statement or stored procedure to insert into the database.
  1286. </para>
  1287. </remarks>
  1288. </member>
  1289. <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
  1290. <summary>
  1291. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  1292. </summary>
  1293. <remarks>
  1294. <para>
  1295. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  1296. </para>
  1297. </remarks>
  1298. </member>
  1299. <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
  1300. <summary>
  1301. The security context to use for privileged calls
  1302. </summary>
  1303. </member>
  1304. <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
  1305. <summary>
  1306. The <see cref="T:System.Data.IDbConnection"/> that will be used
  1307. to insert logging events into a database.
  1308. </summary>
  1309. </member>
  1310. <member name="F:log4net.Appender.AdoNetAppender.m_dbCommand">
  1311. <summary>
  1312. The database command.
  1313. </summary>
  1314. </member>
  1315. <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
  1316. <summary>
  1317. Database connection string.
  1318. </summary>
  1319. </member>
  1320. <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
  1321. <summary>
  1322. The appSettings key from App.Config that contains the connection string.
  1323. </summary>
  1324. </member>
  1325. <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
  1326. <summary>
  1327. String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
  1328. </summary>
  1329. </member>
  1330. <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
  1331. <summary>
  1332. The text of the command.
  1333. </summary>
  1334. </member>
  1335. <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
  1336. <summary>
  1337. The command type.
  1338. </summary>
  1339. </member>
  1340. <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
  1341. <summary>
  1342. Indicates whether to use transactions when writing to the database.
  1343. </summary>
  1344. </member>
  1345. <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
  1346. <summary>
  1347. Indicates whether to use transactions when writing to the database.
  1348. </summary>
  1349. </member>
  1350. <member name="F:log4net.Appender.AdoNetAppender.declaringType">
  1351. <summary>
  1352. The fully qualified type of the AdoNetAppender class.
  1353. </summary>
  1354. <remarks>
  1355. Used by the internal logger to record the Type of the
  1356. log message.
  1357. </remarks>
  1358. </member>
  1359. <member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
  1360. <summary>
  1361. Gets or sets the database connection string that is used to connect to
  1362. the database.
  1363. </summary>
  1364. <value>
  1365. The database connection string used to connect to the database.
  1366. </value>
  1367. <remarks>
  1368. <para>
  1369. The connections string is specific to the connection type.
  1370. See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
  1371. </para>
  1372. </remarks>
  1373. <example>Connection string for MS Access via ODBC:
  1374. <code>"DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb"</code>
  1375. </example>
  1376. <example>Another connection string for MS Access via ODBC:
  1377. <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
  1378. </example>
  1379. <example>Connection string for MS Access via OLE DB:
  1380. <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
  1381. </example>
  1382. </member>
  1383. <member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey">
  1384. <summary>
  1385. The appSettings key from App.Config that contains the connection string.
  1386. </summary>
  1387. </member>
  1388. <member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
  1389. <summary>
  1390. Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
  1391. that should be created.
  1392. </summary>
  1393. <value>
  1394. The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
  1395. </value>
  1396. <remarks>
  1397. <para>
  1398. The type name of the ADO.NET provider to use.
  1399. </para>
  1400. <para>
  1401. The default is to use the OLE DB provider.
  1402. </para>
  1403. </remarks>
  1404. <example>Use the OLE DB Provider. This is the default value.
  1405. <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1406. </example>
  1407. <example>Use the MS SQL Server Provider.
  1408. <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1409. </example>
  1410. <example>Use the ODBC Provider.
  1411. <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
  1412. This is an optional package that you can download from
  1413. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  1414. search for <b>ODBC .NET Data Provider</b>.
  1415. </example>
  1416. <example>Use the Oracle Provider.
  1417. <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  1418. This is an optional package that you can download from
  1419. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  1420. search for <b>.NET Managed Provider for Oracle</b>.
  1421. </example>
  1422. </member>
  1423. <member name="P:log4net.Appender.AdoNetAppender.CommandText">
  1424. <summary>
  1425. Gets or sets the command text that is used to insert logging events
  1426. into the database.
  1427. </summary>
  1428. <value>
  1429. The command text used to insert logging events into the database.
  1430. </value>
  1431. <remarks>
  1432. <para>
  1433. Either the text of the prepared statement or the
  1434. name of the stored procedure to execute to write into
  1435. the database.
  1436. </para>
  1437. <para>
  1438. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
  1439. this text is a prepared statement or a stored procedure.
  1440. </para>
  1441. </remarks>
  1442. </member>
  1443. <member name="P:log4net.Appender.AdoNetAppender.CommandType">
  1444. <summary>
  1445. Gets or sets the command type to execute.
  1446. </summary>
  1447. <value>
  1448. The command type to execute.
  1449. </value>
  1450. <remarks>
  1451. <para>
  1452. This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
  1453. that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
  1454. or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
  1455. <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
  1456. to execute.
  1457. </para>
  1458. <para>
  1459. The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
  1460. </para>
  1461. </remarks>
  1462. </member>
  1463. <member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
  1464. <summary>
  1465. Should transactions be used to insert logging events in the database.
  1466. </summary>
  1467. <value>
  1468. <c>true</c> if transactions should be used to insert logging events in
  1469. the database, otherwise <c>false</c>. The default value is <c>true</c>.
  1470. </value>
  1471. <remarks>
  1472. <para>
  1473. Gets or sets a value that indicates whether transactions should be used
  1474. to insert logging events in the database.
  1475. </para>
  1476. <para>
  1477. When set a single transaction will be used to insert the buffered events
  1478. into the database. Otherwise each event will be inserted without using
  1479. an explicit transaction.
  1480. </para>
  1481. </remarks>
  1482. </member>
  1483. <member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
  1484. <summary>
  1485. Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  1486. </summary>
  1487. <value>
  1488. The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  1489. </value>
  1490. <remarks>
  1491. <para>
  1492. Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
  1493. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  1494. security context to use. The default behavior is to use the security context
  1495. of the current thread.
  1496. </para>
  1497. </remarks>
  1498. </member>
  1499. <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
  1500. <summary>
  1501. Should this appender try to reconnect to the database on error.
  1502. </summary>
  1503. <value>
  1504. <c>true</c> if the appender should try to reconnect to the database after an
  1505. error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
  1506. i.e. not to try to reconnect.
  1507. </value>
  1508. <remarks>
  1509. <para>
  1510. The default behaviour is for the appender not to try to reconnect to the
  1511. database if an error occurs. Subsequent logging events are discarded.
  1512. </para>
  1513. <para>
  1514. To force the appender to attempt to reconnect to the database set this
  1515. property to <c>true</c>.
  1516. </para>
  1517. <note>
  1518. When the appender attempts to connect to the database there may be a
  1519. delay of up to the connection timeout specified in the connection string.
  1520. This delay will block the calling application's thread.
  1521. Until the connection can be reestablished this potential delay may occur multiple times.
  1522. </note>
  1523. </remarks>
  1524. </member>
  1525. <member name="P:log4net.Appender.AdoNetAppender.Connection">
  1526. <summary>
  1527. Gets or sets the underlying <see cref="T:System.Data.IDbConnection"/>.
  1528. </summary>
  1529. <value>
  1530. The underlying <see cref="T:System.Data.IDbConnection"/>.
  1531. </value>
  1532. <remarks>
  1533. <see cref="T:log4net.Appender.AdoNetAppender"/> creates a <see cref="T:System.Data.IDbConnection"/> to insert
  1534. logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender"/>
  1535. can use this property to get or set this <see cref="T:System.Data.IDbConnection"/>. Use the
  1536. underlying <see cref="T:System.Data.IDbConnection"/> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection"/> if
  1537. you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender"/> provides.
  1538. </remarks>
  1539. </member>
  1540. <member name="T:log4net.Appender.AdoNetAppenderParameter">
  1541. <summary>
  1542. Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
  1543. </summary>
  1544. <remarks>
  1545. <para>
  1546. This class provides the basic database parameter properties
  1547. as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
  1548. </para>
  1549. <para>This type can be subclassed to provide database specific
  1550. functionality. The two methods that are called externally are
  1551. <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
  1552. </para>
  1553. </remarks>
  1554. </member>
  1555. <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
  1556. <summary>
  1557. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> class.
  1558. </summary>
  1559. <remarks>
  1560. Default constructor for the AdoNetAppenderParameter class.
  1561. </remarks>
  1562. </member>
  1563. <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
  1564. <summary>
  1565. Prepare the specified database command object.
  1566. </summary>
  1567. <param name="command">The command to prepare.</param>
  1568. <remarks>
  1569. <para>
  1570. Prepares the database command object by adding
  1571. this parameter to its collection of parameters.
  1572. </para>
  1573. </remarks>
  1574. </member>
  1575. <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
  1576. <summary>
  1577. Renders the logging event and set the parameter value in the command.
  1578. </summary>
  1579. <param name="command">The command containing the parameter.</param>
  1580. <param name="loggingEvent">The event to be rendered.</param>
  1581. <remarks>
  1582. <para>
  1583. Renders the logging event using this parameters layout
  1584. object. Sets the value of the parameter on the command object.
  1585. </para>
  1586. </remarks>
  1587. </member>
  1588. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
  1589. <summary>
  1590. The name of this parameter.
  1591. </summary>
  1592. </member>
  1593. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
  1594. <summary>
  1595. The database type for this parameter.
  1596. </summary>
  1597. </member>
  1598. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
  1599. <summary>
  1600. Flag to infer type rather than use the DbType
  1601. </summary>
  1602. </member>
  1603. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
  1604. <summary>
  1605. The precision for this parameter.
  1606. </summary>
  1607. </member>
  1608. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
  1609. <summary>
  1610. The scale for this parameter.
  1611. </summary>
  1612. </member>
  1613. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
  1614. <summary>
  1615. The size for this parameter.
  1616. </summary>
  1617. </member>
  1618. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
  1619. <summary>
  1620. The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
  1621. logging event into an object for this parameter.
  1622. </summary>
  1623. </member>
  1624. <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
  1625. <summary>
  1626. Gets or sets the name of this parameter.
  1627. </summary>
  1628. <value>
  1629. The name of this parameter.
  1630. </value>
  1631. <remarks>
  1632. <para>
  1633. The name of this parameter. The parameter name
  1634. must match up to a named parameter to the SQL stored procedure
  1635. or prepared statement.
  1636. </para>
  1637. </remarks>
  1638. </member>
  1639. <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
  1640. <summary>
  1641. Gets or sets the database type for this parameter.
  1642. </summary>
  1643. <value>
  1644. The database type for this parameter.
  1645. </value>
  1646. <remarks>
  1647. <para>
  1648. The database type for this parameter. This property should
  1649. be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
  1650. enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
  1651. </para>
  1652. <para>
  1653. This property is optional. If not specified the ADO.NET provider
  1654. will attempt to infer the type from the value.
  1655. </para>
  1656. </remarks>
  1657. <seealso cref="P:System.Data.IDataParameter.DbType"/>
  1658. </member>
  1659. <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
  1660. <summary>
  1661. Gets or sets the precision for this parameter.
  1662. </summary>
  1663. <value>
  1664. The precision for this parameter.
  1665. </value>
  1666. <remarks>
  1667. <para>
  1668. The maximum number of digits used to represent the Value.
  1669. </para>
  1670. <para>
  1671. This property is optional. If not specified the ADO.NET provider
  1672. will attempt to infer the precision from the value.
  1673. </para>
  1674. </remarks>
  1675. <seealso cref="P:System.Data.IDbDataParameter.Precision"/>
  1676. </member>
  1677. <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
  1678. <summary>
  1679. Gets or sets the scale for this parameter.
  1680. </summary>
  1681. <value>
  1682. The scale for this parameter.
  1683. </value>
  1684. <remarks>
  1685. <para>
  1686. The number of decimal places to which Value is resolved.
  1687. </para>
  1688. <para>
  1689. This property is optional. If not specified the ADO.NET provider
  1690. will attempt to infer the scale from the value.
  1691. </para>
  1692. </remarks>
  1693. <seealso cref="P:System.Data.IDbDataParameter.Scale"/>
  1694. </member>
  1695. <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
  1696. <summary>
  1697. Gets or sets the size for this parameter.
  1698. </summary>
  1699. <value>
  1700. The size for this parameter.
  1701. </value>
  1702. <remarks>
  1703. <para>
  1704. The maximum size, in bytes, of the data within the column.
  1705. </para>
  1706. <para>
  1707. This property is optional. If not specified the ADO.NET provider
  1708. will attempt to infer the size from the value.
  1709. </para>
  1710. <para>
  1711. For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
  1712. </para>
  1713. </remarks>
  1714. <seealso cref="P:System.Data.IDbDataParameter.Size"/>
  1715. </member>
  1716. <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
  1717. <summary>
  1718. Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
  1719. render the logging event into an object for this
  1720. parameter.
  1721. </summary>
  1722. <value>
  1723. The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
  1724. logging event into an object for this parameter.
  1725. </value>
  1726. <remarks>
  1727. <para>
  1728. The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
  1729. parameter.
  1730. </para>
  1731. <para>
  1732. The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
  1733. any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
  1734. for use in the property.
  1735. </para>
  1736. </remarks>
  1737. </member>
  1738. <member name="T:log4net.Appender.AnsiColorTerminalAppender">
  1739. <summary>
  1740. Appends logging events to the terminal using ANSI color escape sequences.
  1741. </summary>
  1742. <remarks>
  1743. <para>
  1744. AnsiColorTerminalAppender appends log events to the standard output stream
  1745. or the error output stream using a layout specified by the
  1746. user. It also allows the color of a specific level of message to be set.
  1747. </para>
  1748. <note>
  1749. This appender expects the terminal to understand the VT100 control set
  1750. in order to interpret the color codes. If the terminal or console does not
  1751. understand the control codes the behavior is not defined.
  1752. </note>
  1753. <para>
  1754. By default, all output is written to the console's standard output stream.
  1755. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
  1756. error stream.
  1757. </para>
  1758. <para>
  1759. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  1760. <c>System.Console.Error</c> that is set at the time the event is appended.
  1761. Therefore it is possible to programmatically redirect the output of this appender
  1762. (for example NUnit does this to capture program output). While this is the desired
  1763. behavior of this appender it may have security implications in your application.
  1764. </para>
  1765. <para>
  1766. When configuring the ANSI colored terminal appender, a mapping should be
  1767. specified to map a logging level to a color. For example:
  1768. </para>
  1769. <code lang="XML" escaped="true">
  1770. <mapping>
  1771. <level value="ERROR"/>
  1772. <foreColor value="White"/>
  1773. <backColor value="Red"/>
  1774. <attributes value="Bright,Underscore"/>
  1775. </mapping>
  1776. <mapping>
  1777. <level value="DEBUG"/>
  1778. <backColor value="Green"/>
  1779. </mapping>
  1780. </code>
  1781. <para>
  1782. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  1783. of the following values:
  1784. <list type="bullet">
  1785. <item><term>Blue</term><description></description></item>
  1786. <item><term>Green</term><description></description></item>
  1787. <item><term>Red</term><description></description></item>
  1788. <item><term>White</term><description></description></item>
  1789. <item><term>Yellow</term><description></description></item>
  1790. <item><term>Purple</term><description></description></item>
  1791. <item><term>Cyan</term><description></description></item>
  1792. </list>
  1793. These color values cannot be combined together to make new colors.
  1794. </para>
  1795. <para>
  1796. The attributes can be any combination of the following:
  1797. <list type="bullet">
  1798. <item><term>Bright</term><description>foreground is brighter</description></item>
  1799. <item><term>Dim</term><description>foreground is dimmer</description></item>
  1800. <item><term>Underscore</term><description>message is underlined</description></item>
  1801. <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
  1802. <item><term>Reverse</term><description>foreground and background are reversed</description></item>
  1803. <item><term>Hidden</term><description>output is hidden</description></item>
  1804. <item><term>Strikethrough</term><description>message has a line through it</description></item>
  1805. </list>
  1806. While any of these attributes may be combined together not all combinations
  1807. work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
  1808. no sense.
  1809. </para>
  1810. </remarks>
  1811. <author>Patrick Wagstrom</author>
  1812. <author>Nicko Cadell</author>
  1813. </member>
  1814. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
  1815. <summary>
  1816. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1817. standard output stream.
  1818. </summary>
  1819. <remarks>
  1820. <para>
  1821. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1822. standard output stream.
  1823. </para>
  1824. </remarks>
  1825. </member>
  1826. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
  1827. <summary>
  1828. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1829. standard error output stream.
  1830. </summary>
  1831. <remarks>
  1832. <para>
  1833. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  1834. standard error output stream.
  1835. </para>
  1836. </remarks>
  1837. </member>
  1838. <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
  1839. <summary>
  1840. Ansi code to reset terminal
  1841. </summary>
  1842. </member>
  1843. <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
  1844. <summary>
  1845. Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class.
  1846. </summary>
  1847. <remarks>
  1848. The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender"/> class is set up to write
  1849. to the standard output stream.
  1850. </remarks>
  1851. </member>
  1852. <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
  1853. <summary>
  1854. Add a mapping of level to color
  1855. </summary>
  1856. <param name="mapping">The mapping to add</param>
  1857. <remarks>
  1858. <para>
  1859. Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
  1860. Each mapping defines the foreground and background colours
  1861. for a level.
  1862. </para>
  1863. </remarks>
  1864. </member>
  1865. <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
  1866. <summary>
  1867. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  1868. </summary>
  1869. <param name="loggingEvent">The event to log.</param>
  1870. <remarks>
  1871. <para>
  1872. Writes the event to the console.
  1873. </para>
  1874. <para>
  1875. The format of the output will depend on the appender's layout.
  1876. </para>
  1877. </remarks>
  1878. </member>
  1879. <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
  1880. <summary>
  1881. Initialize the options for this appender
  1882. </summary>
  1883. <remarks>
  1884. <para>
  1885. Initialize the level to color mappings set on this appender.
  1886. </para>
  1887. </remarks>
  1888. </member>
  1889. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
  1890. <summary>
  1891. Flag to write output to the error stream rather than the standard output stream
  1892. </summary>
  1893. </member>
  1894. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
  1895. <summary>
  1896. Mapping from level object to color value
  1897. </summary>
  1898. </member>
  1899. <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
  1900. <summary>
  1901. Target is the value of the console output stream.
  1902. </summary>
  1903. <value>
  1904. Target is the value of the console output stream.
  1905. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  1906. </value>
  1907. <remarks>
  1908. <para>
  1909. Target is the value of the console output stream.
  1910. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  1911. </para>
  1912. </remarks>
  1913. </member>
  1914. <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
  1915. <summary>
  1916. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  1917. </summary>
  1918. <value><c>true</c></value>
  1919. <remarks>
  1920. <para>
  1921. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  1922. </para>
  1923. </remarks>
  1924. </member>
  1925. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
  1926. <summary>
  1927. The enum of possible display attributes
  1928. </summary>
  1929. <remarks>
  1930. <para>
  1931. The following flags can be combined together to
  1932. form the ANSI color attributes.
  1933. </para>
  1934. </remarks>
  1935. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
  1936. </member>
  1937. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
  1938. <summary>
  1939. text is bright
  1940. </summary>
  1941. </member>
  1942. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
  1943. <summary>
  1944. text is dim
  1945. </summary>
  1946. </member>
  1947. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
  1948. <summary>
  1949. text is underlined
  1950. </summary>
  1951. </member>
  1952. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
  1953. <summary>
  1954. text is blinking
  1955. </summary>
  1956. <remarks>
  1957. Not all terminals support this attribute
  1958. </remarks>
  1959. </member>
  1960. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
  1961. <summary>
  1962. text and background colors are reversed
  1963. </summary>
  1964. </member>
  1965. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
  1966. <summary>
  1967. text is hidden
  1968. </summary>
  1969. </member>
  1970. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
  1971. <summary>
  1972. text is displayed with a strikethrough
  1973. </summary>
  1974. </member>
  1975. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
  1976. <summary>
  1977. text color is light
  1978. </summary>
  1979. </member>
  1980. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
  1981. <summary>
  1982. The enum of possible foreground or background color values for
  1983. use with the color mapping method
  1984. </summary>
  1985. <remarks>
  1986. <para>
  1987. The output can be in one for the following ANSI colors.
  1988. </para>
  1989. </remarks>
  1990. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender"/>
  1991. </member>
  1992. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
  1993. <summary>
  1994. color is black
  1995. </summary>
  1996. </member>
  1997. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
  1998. <summary>
  1999. color is red
  2000. </summary>
  2001. </member>
  2002. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
  2003. <summary>
  2004. color is green
  2005. </summary>
  2006. </member>
  2007. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
  2008. <summary>
  2009. color is yellow
  2010. </summary>
  2011. </member>
  2012. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
  2013. <summary>
  2014. color is blue
  2015. </summary>
  2016. </member>
  2017. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
  2018. <summary>
  2019. color is magenta
  2020. </summary>
  2021. </member>
  2022. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
  2023. <summary>
  2024. color is cyan
  2025. </summary>
  2026. </member>
  2027. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
  2028. <summary>
  2029. color is white
  2030. </summary>
  2031. </member>
  2032. <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
  2033. <summary>
  2034. A class to act as a mapping between the level that a logging call is made at and
  2035. the color it should be displayed as.
  2036. </summary>
  2037. <remarks>
  2038. <para>
  2039. Defines the mapping between a level and the color it should be displayed in.
  2040. </para>
  2041. </remarks>
  2042. </member>
  2043. <member name="T:log4net.Util.LevelMappingEntry">
  2044. <summary>
  2045. An entry in the <see cref="T:log4net.Util.LevelMapping"/>
  2046. </summary>
  2047. <remarks>
  2048. <para>
  2049. This is an abstract base class for types that are stored in the
  2050. <see cref="T:log4net.Util.LevelMapping"/> object.
  2051. </para>
  2052. </remarks>
  2053. <author>Nicko Cadell</author>
  2054. </member>
  2055. <member name="M:log4net.Util.LevelMappingEntry.#ctor">
  2056. <summary>
  2057. Default protected constructor
  2058. </summary>
  2059. <remarks>
  2060. <para>
  2061. Default protected constructor
  2062. </para>
  2063. </remarks>
  2064. </member>
  2065. <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
  2066. <summary>
  2067. Initialize any options defined on this entry
  2068. </summary>
  2069. <remarks>
  2070. <para>
  2071. Should be overridden by any classes that need to initialise based on their options
  2072. </para>
  2073. </remarks>
  2074. </member>
  2075. <member name="P:log4net.Util.LevelMappingEntry.Level">
  2076. <summary>
  2077. The level that is the key for this mapping
  2078. </summary>
  2079. <value>
  2080. The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
  2081. </value>
  2082. <remarks>
  2083. <para>
  2084. Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
  2085. mapping subclass.
  2086. </para>
  2087. </remarks>
  2088. </member>
  2089. <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
  2090. <summary>
  2091. Initialize the options for the object
  2092. </summary>
  2093. <remarks>
  2094. <para>
  2095. Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
  2096. and append the attributes.
  2097. </para>
  2098. </remarks>
  2099. </member>
  2100. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
  2101. <summary>
  2102. The mapped foreground color for the specified level
  2103. </summary>
  2104. <remarks>
  2105. <para>
  2106. Required property.
  2107. The mapped foreground color for the specified level
  2108. </para>
  2109. </remarks>
  2110. </member>
  2111. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
  2112. <summary>
  2113. The mapped background color for the specified level
  2114. </summary>
  2115. <remarks>
  2116. <para>
  2117. Required property.
  2118. The mapped background color for the specified level
  2119. </para>
  2120. </remarks>
  2121. </member>
  2122. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
  2123. <summary>
  2124. The color attributes for the specified level
  2125. </summary>
  2126. <remarks>
  2127. <para>
  2128. Required property.
  2129. The color attributes for the specified level
  2130. </para>
  2131. </remarks>
  2132. </member>
  2133. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
  2134. <summary>
  2135. The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
  2136. <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
  2137. </summary>
  2138. </member>
  2139. <member name="T:log4net.Appender.AppenderCollection">
  2140. <summary>
  2141. A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
  2142. </summary>
  2143. <author>Nicko Cadell</author>
  2144. </member>
  2145. <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
  2146. <summary>
  2147. Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
  2148. </summary>
  2149. <param name="list">list to create a readonly wrapper arround</param>
  2150. <returns>
  2151. An <c>AppenderCollection</c> wrapper that is read-only.
  2152. </returns>
  2153. </member>
  2154. <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
  2155. <summary>
  2156. An empty readonly static AppenderCollection
  2157. </summary>
  2158. </member>
  2159. <member name="M:log4net.Appender.AppenderCollection.#ctor">
  2160. <summary>
  2161. Initializes a new instance of the <c>AppenderCollection</c> class
  2162. that is empty and has the default initial capacity.
  2163. </summary>
  2164. </member>
  2165. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
  2166. <summary>
  2167. Initializes a new instance of the <c>AppenderCollection</c> class
  2168. that has the specified initial capacity.
  2169. </summary>
  2170. <param name="capacity">
  2171. The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
  2172. </param>
  2173. </member>
  2174. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
  2175. <summary>
  2176. Initializes a new instance of the <c>AppenderCollection</c> class
  2177. that contains elements copied from the specified <c>AppenderCollection</c>.
  2178. </summary>
  2179. <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
  2180. </member>
  2181. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
  2182. <summary>
  2183. Initializes a new instance of the <c>AppenderCollection</c> class
  2184. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
  2185. </summary>
  2186. <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
  2187. </member>
  2188. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
  2189. <summary>
  2190. Initializes a new instance of the <c>AppenderCollection</c> class
  2191. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
  2192. </summary>
  2193. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
  2194. </member>
  2195. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
  2196. <summary>
  2197. Allow subclasses to avoid our default constructors
  2198. </summary>
  2199. <param name="tag"></param>
  2200. <exclude/>
  2201. </member>
  2202. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
  2203. <summary>
  2204. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  2205. <see cref="T:log4net.Appender.IAppender"/> array.
  2206. </summary>
  2207. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  2208. </member>
  2209. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
  2210. <summary>
  2211. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  2212. <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
  2213. </summary>
  2214. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  2215. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  2216. </member>
  2217. <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
  2218. <summary>
  2219. Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
  2220. </summary>
  2221. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
  2222. <returns>The index at which the value has been added.</returns>
  2223. </member>
  2224. <member name="M:log4net.Appender.AppenderCollection.Clear">
  2225. <summary>
  2226. Removes all elements from the <c>AppenderCollection</c>.
  2227. </summary>
  2228. </member>
  2229. <member name="M:log4net.Appender.AppenderCollection.Clone">
  2230. <summary>
  2231. Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
  2232. </summary>
  2233. <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
  2234. </member>
  2235. <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
  2236. <summary>
  2237. Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
  2238. </summary>
  2239. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
  2240. <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
  2241. </member>
  2242. <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
  2243. <summary>
  2244. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
  2245. in the <c>AppenderCollection</c>.
  2246. </summary>
  2247. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
  2248. <returns>
  2249. The zero-based index of the first occurrence of <paramref name="item"/>
  2250. in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
  2251. </returns>
  2252. </member>
  2253. <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
  2254. <summary>
  2255. Inserts an element into the <c>AppenderCollection</c> at the specified index.
  2256. </summary>
  2257. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  2258. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
  2259. <exception cref="T:System.ArgumentOutOfRangeException">
  2260. <para><paramref name="index"/> is less than zero</para>
  2261. <para>-or-</para>
  2262. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2263. </exception>
  2264. </member>
  2265. <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
  2266. <summary>
  2267. Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
  2268. </summary>
  2269. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
  2270. <exception cref="T:System.ArgumentException">
  2271. The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
  2272. </exception>
  2273. </member>
  2274. <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
  2275. <summary>
  2276. Removes the element at the specified index of the <c>AppenderCollection</c>.
  2277. </summary>
  2278. <param name="index">The zero-based index of the element to remove.</param>
  2279. <exception cref="T:System.ArgumentOutOfRangeException">
  2280. <para><paramref name="index"/> is less than zero</para>
  2281. <para>-or-</para>
  2282. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2283. </exception>
  2284. </member>
  2285. <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
  2286. <summary>
  2287. Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
  2288. </summary>
  2289. <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
  2290. </member>
  2291. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
  2292. <summary>
  2293. Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
  2294. </summary>
  2295. <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
  2296. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2297. </member>
  2298. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
  2299. <summary>
  2300. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
  2301. </summary>
  2302. <param name="x">The <see cref="T:log4net.Appender.IAppender"/> array whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
  2303. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2304. </member>
  2305. <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
  2306. <summary>
  2307. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
  2308. </summary>
  2309. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements should be added to the end of the <c>AppenderCollection</c>.</param>
  2310. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  2311. </member>
  2312. <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
  2313. <summary>
  2314. Sets the capacity to the actual number of elements.
  2315. </summary>
  2316. </member>
  2317. <member name="M:log4net.Appender.AppenderCollection.ToArray">
  2318. <summary>
  2319. Return the collection elements as an array
  2320. </summary>
  2321. <returns>the array</returns>
  2322. </member>
  2323. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
  2324. <exception cref="T:System.ArgumentOutOfRangeException">
  2325. <para><paramref name="i"/> is less than zero</para>
  2326. <para>-or-</para>
  2327. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2328. </exception>
  2329. </member>
  2330. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
  2331. <exception cref="T:System.ArgumentOutOfRangeException">
  2332. <para><paramref name="i"/> is less than zero</para>
  2333. <para>-or-</para>
  2334. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2335. </exception>
  2336. </member>
  2337. <member name="P:log4net.Appender.AppenderCollection.Count">
  2338. <summary>
  2339. Gets the number of elements actually contained in the <c>AppenderCollection</c>.
  2340. </summary>
  2341. </member>
  2342. <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
  2343. <summary>
  2344. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  2345. </summary>
  2346. <returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns>
  2347. </member>
  2348. <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
  2349. <summary>
  2350. Gets an object that can be used to synchronize access to the collection.
  2351. </summary>
  2352. </member>
  2353. <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
  2354. <summary>
  2355. Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
  2356. </summary>
  2357. <param name="index">The zero-based index of the element to get or set.</param>
  2358. <exception cref="T:System.ArgumentOutOfRangeException">
  2359. <para><paramref name="index"/> is less than zero</para>
  2360. <para>-or-</para>
  2361. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  2362. </exception>
  2363. </member>
  2364. <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
  2365. <summary>
  2366. Gets a value indicating whether the collection has a fixed size.
  2367. </summary>
  2368. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  2369. </member>
  2370. <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
  2371. <summary>
  2372. Gets a value indicating whether the IList is read-only.
  2373. </summary>
  2374. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  2375. </member>
  2376. <member name="P:log4net.Appender.AppenderCollection.Capacity">
  2377. <summary>
  2378. Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
  2379. </summary>
  2380. </member>
  2381. <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
  2382. <summary>
  2383. Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  2384. </summary>
  2385. <exclude/>
  2386. </member>
  2387. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
  2388. <summary>
  2389. Advances the enumerator to the next element in the collection.
  2390. </summary>
  2391. <returns>
  2392. <c>true</c> if the enumerator was successfully advanced to the next element;
  2393. <c>false</c> if the enumerator has passed the end of the collection.
  2394. </returns>
  2395. <exception cref="T:System.InvalidOperationException">
  2396. The collection was modified after the enumerator was created.
  2397. </exception>
  2398. </member>
  2399. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
  2400. <summary>
  2401. Sets the enumerator to its initial position, before the first element in the collection.
  2402. </summary>
  2403. </member>
  2404. <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
  2405. <summary>
  2406. Gets the current element in the collection.
  2407. </summary>
  2408. </member>
  2409. <member name="T:log4net.Appender.AppenderCollection.Tag">
  2410. <summary>
  2411. Type visible only to our subclasses
  2412. Used to access protected constructor
  2413. </summary>
  2414. <exclude/>
  2415. </member>
  2416. <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
  2417. <summary>
  2418. A value
  2419. </summary>
  2420. </member>
  2421. <member name="T:log4net.Appender.AppenderCollection.Enumerator">
  2422. <summary>
  2423. Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  2424. </summary>
  2425. <exclude/>
  2426. </member>
  2427. <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
  2428. <summary>
  2429. Initializes a new instance of the <c>Enumerator</c> class.
  2430. </summary>
  2431. <param name="tc"></param>
  2432. </member>
  2433. <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
  2434. <summary>
  2435. Advances the enumerator to the next element in the collection.
  2436. </summary>
  2437. <returns>
  2438. <c>true</c> if the enumerator was successfully advanced to the next element;
  2439. <c>false</c> if the enumerator has passed the end of the collection.
  2440. </returns>
  2441. <exception cref="T:System.InvalidOperationException">
  2442. The collection was modified after the enumerator was created.
  2443. </exception>
  2444. </member>
  2445. <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
  2446. <summary>
  2447. Sets the enumerator to its initial position, before the first element in the collection.
  2448. </summary>
  2449. </member>
  2450. <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
  2451. <summary>
  2452. Gets the current element in the collection.
  2453. </summary>
  2454. </member>
  2455. <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
  2456. <exclude/>
  2457. </member>
  2458. <member name="T:log4net.Appender.AspNetTraceAppender">
  2459. <summary>
  2460. <para>
  2461. Appends log events to the ASP.NET <see cref="T:System.Web.TraceContext"/> system.
  2462. </para>
  2463. </summary>
  2464. <remarks>
  2465. <para>
  2466. Diagnostic information and tracing messages that you specify are appended to the output
  2467. of the page that is sent to the requesting browser. Optionally, you can view this information
  2468. from a separate trace viewer (Trace.axd) that displays trace information for every page in a
  2469. given application.
  2470. </para>
  2471. <para>
  2472. Trace statements are processed and displayed only when tracing is enabled. You can control
  2473. whether tracing is displayed to a page, to the trace viewer, or both.
  2474. </para>
  2475. <para>
  2476. The logging event is passed to the <see cref="M:TraceContext.Write(string)"/> or
  2477. <see cref="M:TraceContext.Warn(string)"/> method depending on the level of the logging event.
  2478. The event's logger name is the default value for the category parameter of the Write/Warn method.
  2479. </para>
  2480. </remarks>
  2481. <author>Nicko Cadell</author>
  2482. <author>Gert Driesen</author>
  2483. <author>Ron Grabowski</author>
  2484. </member>
  2485. <member name="M:log4net.Appender.AspNetTraceAppender.#ctor">
  2486. <summary>
  2487. Initializes a new instance of the <see cref="T:log4net.Appender.AspNetTraceAppender"/> class.
  2488. </summary>
  2489. <remarks>
  2490. <para>
  2491. Default constructor.
  2492. </para>
  2493. </remarks>
  2494. </member>
  2495. <member name="M:log4net.Appender.AspNetTraceAppender.Append(log4net.Core.LoggingEvent)">
  2496. <summary>
  2497. Write the logging event to the ASP.NET trace
  2498. </summary>
  2499. <param name="loggingEvent">the event to log</param>
  2500. <remarks>
  2501. <para>
  2502. Write the logging event to the ASP.NET trace
  2503. <c>HttpContext.Current.Trace</c>
  2504. (<see cref="T:System.Web.TraceContext"/>).
  2505. </para>
  2506. </remarks>
  2507. </member>
  2508. <member name="F:log4net.Appender.AspNetTraceAppender.m_category">
  2509. <summary>
  2510. Defaults to %logger
  2511. </summary>
  2512. </member>
  2513. <member name="P:log4net.Appender.AspNetTraceAppender.RequiresLayout">
  2514. <summary>
  2515. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2516. </summary>
  2517. <value><c>true</c></value>
  2518. <remarks>
  2519. <para>
  2520. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2521. </para>
  2522. </remarks>
  2523. </member>
  2524. <member name="P:log4net.Appender.AspNetTraceAppender.Category">
  2525. <summary>
  2526. The category parameter sent to the Trace method.
  2527. </summary>
  2528. <remarks>
  2529. <para>
  2530. Defaults to %logger which will use the logger name of the current
  2531. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  2532. </para>
  2533. <para>
  2534. </para>
  2535. </remarks>
  2536. </member>
  2537. <member name="T:log4net.Appender.BufferingForwardingAppender">
  2538. <summary>
  2539. Buffers events and then forwards them to attached appenders.
  2540. </summary>
  2541. <remarks>
  2542. <para>
  2543. The events are buffered in this appender until conditions are
  2544. met to allow the appender to deliver the events to the attached
  2545. appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
  2546. conditions that cause the buffer to be sent.
  2547. </para>
  2548. <para>The forwarding appender can be used to specify different
  2549. thresholds and filters for the same appender at different locations
  2550. within the hierarchy.
  2551. </para>
  2552. </remarks>
  2553. <author>Nicko Cadell</author>
  2554. <author>Gert Driesen</author>
  2555. </member>
  2556. <member name="T:log4net.Core.IAppenderAttachable">
  2557. <summary>
  2558. Interface for attaching appenders to objects.
  2559. </summary>
  2560. <remarks>
  2561. <para>
  2562. Interface for attaching, removing and retrieving appenders.
  2563. </para>
  2564. </remarks>
  2565. <author>Nicko Cadell</author>
  2566. <author>Gert Driesen</author>
  2567. </member>
  2568. <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
  2569. <summary>
  2570. Attaches an appender.
  2571. </summary>
  2572. <param name="appender">The appender to add.</param>
  2573. <remarks>
  2574. <para>
  2575. Add the specified appender. The implementation may
  2576. choose to allow or deny duplicate appenders.
  2577. </para>
  2578. </remarks>
  2579. </member>
  2580. <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
  2581. <summary>
  2582. Gets an attached appender with the specified name.
  2583. </summary>
  2584. <param name="name">The name of the appender to get.</param>
  2585. <returns>
  2586. The appender with the name specified, or <c>null</c> if no appender with the
  2587. specified name is found.
  2588. </returns>
  2589. <remarks>
  2590. <para>
  2591. Returns an attached appender with the <paramref name="name"/> specified.
  2592. If no appender with the specified name is found <c>null</c> will be
  2593. returned.
  2594. </para>
  2595. </remarks>
  2596. </member>
  2597. <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
  2598. <summary>
  2599. Removes all attached appenders.
  2600. </summary>
  2601. <remarks>
  2602. <para>
  2603. Removes and closes all attached appenders
  2604. </para>
  2605. </remarks>
  2606. </member>
  2607. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
  2608. <summary>
  2609. Removes the specified appender from the list of attached appenders.
  2610. </summary>
  2611. <param name="appender">The appender to remove.</param>
  2612. <returns>The appender removed from the list</returns>
  2613. <remarks>
  2614. <para>
  2615. The appender removed is not closed.
  2616. If you are discarding the appender you must call
  2617. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2618. </para>
  2619. </remarks>
  2620. </member>
  2621. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
  2622. <summary>
  2623. Removes the appender with the specified name from the list of appenders.
  2624. </summary>
  2625. <param name="name">The name of the appender to remove.</param>
  2626. <returns>The appender removed from the list</returns>
  2627. <remarks>
  2628. <para>
  2629. The appender removed is not closed.
  2630. If you are discarding the appender you must call
  2631. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2632. </para>
  2633. </remarks>
  2634. </member>
  2635. <member name="P:log4net.Core.IAppenderAttachable.Appenders">
  2636. <summary>
  2637. Gets all attached appenders.
  2638. </summary>
  2639. <value>
  2640. A collection of attached appenders.
  2641. </value>
  2642. <remarks>
  2643. <para>
  2644. Gets a collection of attached appenders.
  2645. If there are no attached appenders the
  2646. implementation should return an empty
  2647. collection rather than <c>null</c>.
  2648. </para>
  2649. </remarks>
  2650. </member>
  2651. <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
  2652. <summary>
  2653. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender"/> class.
  2654. </summary>
  2655. <remarks>
  2656. <para>
  2657. Default constructor.
  2658. </para>
  2659. </remarks>
  2660. </member>
  2661. <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
  2662. <summary>
  2663. Closes the appender and releases resources.
  2664. </summary>
  2665. <remarks>
  2666. <para>
  2667. Releases any resources allocated within the appender such as file handles,
  2668. network connections, etc.
  2669. </para>
  2670. <para>
  2671. It is a programming error to append to a closed appender.
  2672. </para>
  2673. </remarks>
  2674. </member>
  2675. <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  2676. <summary>
  2677. Send the events.
  2678. </summary>
  2679. <param name="events">The events that need to be send.</param>
  2680. <remarks>
  2681. <para>
  2682. Forwards the events to the attached appenders.
  2683. </para>
  2684. </remarks>
  2685. </member>
  2686. <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  2687. <summary>
  2688. Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
  2689. instance.
  2690. </summary>
  2691. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
  2692. <remarks>
  2693. <para>
  2694. If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
  2695. appenders, then it won't be added again.
  2696. </para>
  2697. </remarks>
  2698. </member>
  2699. <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
  2700. <summary>
  2701. Looks for the appender with the specified name.
  2702. </summary>
  2703. <param name="name">The name of the appender to lookup.</param>
  2704. <returns>
  2705. The appender with the specified name, or <c>null</c>.
  2706. </returns>
  2707. <remarks>
  2708. <para>
  2709. Get the named appender attached to this buffering appender.
  2710. </para>
  2711. </remarks>
  2712. </member>
  2713. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
  2714. <summary>
  2715. Removes all previously added appenders from this appender.
  2716. </summary>
  2717. <remarks>
  2718. <para>
  2719. This is useful when re-reading configuration information.
  2720. </para>
  2721. </remarks>
  2722. </member>
  2723. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  2724. <summary>
  2725. Removes the specified appender from the list of appenders.
  2726. </summary>
  2727. <param name="appender">The appender to remove.</param>
  2728. <returns>The appender removed from the list</returns>
  2729. <remarks>
  2730. The appender removed is not closed.
  2731. If you are discarding the appender you must call
  2732. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2733. </remarks>
  2734. </member>
  2735. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
  2736. <summary>
  2737. Removes the appender with the specified name from the list of appenders.
  2738. </summary>
  2739. <param name="name">The name of the appender to remove.</param>
  2740. <returns>The appender removed from the list</returns>
  2741. <remarks>
  2742. The appender removed is not closed.
  2743. If you are discarding the appender you must call
  2744. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2745. </remarks>
  2746. </member>
  2747. <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
  2748. <summary>
  2749. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  2750. </summary>
  2751. </member>
  2752. <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
  2753. <summary>
  2754. Gets the appenders contained in this appender as an
  2755. <see cref="T:System.Collections.ICollection"/>.
  2756. </summary>
  2757. <remarks>
  2758. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  2759. is returned.
  2760. </remarks>
  2761. <returns>
  2762. A collection of the appenders in this appender.
  2763. </returns>
  2764. </member>
  2765. <member name="T:log4net.Appender.ColoredConsoleAppender">
  2766. <summary>
  2767. Appends logging events to the console.
  2768. </summary>
  2769. <remarks>
  2770. <para>
  2771. ColoredConsoleAppender appends log events to the standard output stream
  2772. or the error output stream using a layout specified by the
  2773. user. It also allows the color of a specific type of message to be set.
  2774. </para>
  2775. <para>
  2776. By default, all output is written to the console's standard output stream.
  2777. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> property can be set to direct the output to the
  2778. error stream.
  2779. </para>
  2780. <para>
  2781. NOTE: This appender writes directly to the application's attached console
  2782. not to the <c>System.Console.Out</c> or <c>System.Console.Error</c> <c>TextWriter</c>.
  2783. The <c>System.Console.Out</c> and <c>System.Console.Error</c> streams can be
  2784. programmatically redirected (for example NUnit does this to capture program output).
  2785. This appender will ignore these redirections because it needs to use Win32
  2786. API calls to colorize the output. To respect these redirections the <see cref="T:log4net.Appender.ConsoleAppender"/>
  2787. must be used.
  2788. </para>
  2789. <para>
  2790. When configuring the colored console appender, mapping should be
  2791. specified to map a logging level to a color. For example:
  2792. </para>
  2793. <code lang="XML" escaped="true">
  2794. <mapping>
  2795. <level value="ERROR"/>
  2796. <foreColor value="White"/>
  2797. <backColor value="Red, HighIntensity"/>
  2798. </mapping>
  2799. <mapping>
  2800. <level value="DEBUG"/>
  2801. <backColor value="Green"/>
  2802. </mapping>
  2803. </code>
  2804. <para>
  2805. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  2806. combination of the following values:
  2807. <list type="bullet">
  2808. <item><term>Blue</term><description></description></item>
  2809. <item><term>Green</term><description></description></item>
  2810. <item><term>Red</term><description></description></item>
  2811. <item><term>White</term><description></description></item>
  2812. <item><term>Yellow</term><description></description></item>
  2813. <item><term>Purple</term><description></description></item>
  2814. <item><term>Cyan</term><description></description></item>
  2815. <item><term>HighIntensity</term><description></description></item>
  2816. </list>
  2817. </para>
  2818. </remarks>
  2819. <author>Rick Hobbs</author>
  2820. <author>Nicko Cadell</author>
  2821. </member>
  2822. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleOut">
  2823. <summary>
  2824. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2825. standard output stream.
  2826. </summary>
  2827. <remarks>
  2828. <para>
  2829. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2830. standard output stream.
  2831. </para>
  2832. </remarks>
  2833. </member>
  2834. <member name="F:log4net.Appender.ColoredConsoleAppender.ConsoleError">
  2835. <summary>
  2836. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2837. standard error output stream.
  2838. </summary>
  2839. <remarks>
  2840. <para>
  2841. The <see cref="P:log4net.Appender.ColoredConsoleAppender.Target"/> to use when writing to the Console
  2842. standard error output stream.
  2843. </para>
  2844. </remarks>
  2845. </member>
  2846. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor">
  2847. <summary>
  2848. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class.
  2849. </summary>
  2850. <remarks>
  2851. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
  2852. to the standard output stream.
  2853. </remarks>
  2854. </member>
  2855. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2856. <summary>
  2857. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
  2858. with the specified layout.
  2859. </summary>
  2860. <param name="layout">the layout to use for this appender</param>
  2861. <remarks>
  2862. The instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class is set up to write
  2863. to the standard output stream.
  2864. </remarks>
  2865. </member>
  2866. <member name="M:log4net.Appender.ColoredConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2867. <summary>
  2868. Initializes a new instance of the <see cref="T:log4net.Appender.ColoredConsoleAppender"/> class
  2869. with the specified layout.
  2870. </summary>
  2871. <param name="layout">the layout to use for this appender</param>
  2872. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2873. <remarks>
  2874. When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
  2875. the standard error output stream. Otherwise, output is written to the standard
  2876. output stream.
  2877. </remarks>
  2878. </member>
  2879. <member name="M:log4net.Appender.ColoredConsoleAppender.AddMapping(log4net.Appender.ColoredConsoleAppender.LevelColors)">
  2880. <summary>
  2881. Add a mapping of level to color - done by the config file
  2882. </summary>
  2883. <param name="mapping">The mapping to add</param>
  2884. <remarks>
  2885. <para>
  2886. Add a <see cref="T:log4net.Appender.ColoredConsoleAppender.LevelColors"/> mapping to this appender.
  2887. Each mapping defines the foreground and background colors
  2888. for a level.
  2889. </para>
  2890. </remarks>
  2891. </member>
  2892. <member name="M:log4net.Appender.ColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2893. <summary>
  2894. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  2895. </summary>
  2896. <param name="loggingEvent">The event to log.</param>
  2897. <remarks>
  2898. <para>
  2899. Writes the event to the console.
  2900. </para>
  2901. <para>
  2902. The format of the output will depend on the appender's layout.
  2903. </para>
  2904. </remarks>
  2905. </member>
  2906. <member name="M:log4net.Appender.ColoredConsoleAppender.ActivateOptions">
  2907. <summary>
  2908. Initialize the options for this appender
  2909. </summary>
  2910. <remarks>
  2911. <para>
  2912. Initialize the level to color mappings set on this appender.
  2913. </para>
  2914. </remarks>
  2915. </member>
  2916. <member name="F:log4net.Appender.ColoredConsoleAppender.m_writeToErrorStream">
  2917. <summary>
  2918. Flag to write output to the error stream rather than the standard output stream
  2919. </summary>
  2920. </member>
  2921. <member name="F:log4net.Appender.ColoredConsoleAppender.m_levelMapping">
  2922. <summary>
  2923. Mapping from level object to color value
  2924. </summary>
  2925. </member>
  2926. <member name="F:log4net.Appender.ColoredConsoleAppender.m_consoleOutputWriter">
  2927. <summary>
  2928. The console output stream writer to write to
  2929. </summary>
  2930. <remarks>
  2931. <para>
  2932. This writer is not thread safe.
  2933. </para>
  2934. </remarks>
  2935. </member>
  2936. <member name="P:log4net.Appender.ColoredConsoleAppender.Target">
  2937. <summary>
  2938. Target is the value of the console output stream.
  2939. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2940. </summary>
  2941. <value>
  2942. Target is the value of the console output stream.
  2943. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2944. </value>
  2945. <remarks>
  2946. <para>
  2947. Target is the value of the console output stream.
  2948. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2949. </para>
  2950. </remarks>
  2951. </member>
  2952. <member name="P:log4net.Appender.ColoredConsoleAppender.RequiresLayout">
  2953. <summary>
  2954. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2955. </summary>
  2956. <value><c>true</c></value>
  2957. <remarks>
  2958. <para>
  2959. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2960. </para>
  2961. </remarks>
  2962. </member>
  2963. <member name="T:log4net.Appender.ColoredConsoleAppender.Colors">
  2964. <summary>
  2965. The enum of possible color values for use with the color mapping method
  2966. </summary>
  2967. <remarks>
  2968. <para>
  2969. The following flags can be combined together to
  2970. form the colors.
  2971. </para>
  2972. </remarks>
  2973. <seealso cref="T:log4net.Appender.ColoredConsoleAppender"/>
  2974. </member>
  2975. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Blue">
  2976. <summary>
  2977. color is blue
  2978. </summary>
  2979. </member>
  2980. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Green">
  2981. <summary>
  2982. color is green
  2983. </summary>
  2984. </member>
  2985. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Red">
  2986. <summary>
  2987. color is red
  2988. </summary>
  2989. </member>
  2990. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.White">
  2991. <summary>
  2992. color is white
  2993. </summary>
  2994. </member>
  2995. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Yellow">
  2996. <summary>
  2997. color is yellow
  2998. </summary>
  2999. </member>
  3000. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Purple">
  3001. <summary>
  3002. color is purple
  3003. </summary>
  3004. </member>
  3005. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.Cyan">
  3006. <summary>
  3007. color is cyan
  3008. </summary>
  3009. </member>
  3010. <member name="F:log4net.Appender.ColoredConsoleAppender.Colors.HighIntensity">
  3011. <summary>
  3012. color is intensified
  3013. </summary>
  3014. </member>
  3015. <member name="T:log4net.Appender.ColoredConsoleAppender.LevelColors">
  3016. <summary>
  3017. A class to act as a mapping between the level that a logging call is made at and
  3018. the color it should be displayed as.
  3019. </summary>
  3020. <remarks>
  3021. <para>
  3022. Defines the mapping between a level and the color it should be displayed in.
  3023. </para>
  3024. </remarks>
  3025. </member>
  3026. <member name="M:log4net.Appender.ColoredConsoleAppender.LevelColors.ActivateOptions">
  3027. <summary>
  3028. Initialize the options for the object
  3029. </summary>
  3030. <remarks>
  3031. <para>
  3032. Combine the <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> together.
  3033. </para>
  3034. </remarks>
  3035. </member>
  3036. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor">
  3037. <summary>
  3038. The mapped foreground color for the specified level
  3039. </summary>
  3040. <remarks>
  3041. <para>
  3042. Required property.
  3043. The mapped foreground color for the specified level.
  3044. </para>
  3045. </remarks>
  3046. </member>
  3047. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor">
  3048. <summary>
  3049. The mapped background color for the specified level
  3050. </summary>
  3051. <remarks>
  3052. <para>
  3053. Required property.
  3054. The mapped background color for the specified level.
  3055. </para>
  3056. </remarks>
  3057. </member>
  3058. <member name="P:log4net.Appender.ColoredConsoleAppender.LevelColors.CombinedColor">
  3059. <summary>
  3060. The combined <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.ColoredConsoleAppender.LevelColors.BackColor"/> suitable for
  3061. setting the console color.
  3062. </summary>
  3063. </member>
  3064. <member name="T:log4net.Appender.ConsoleAppender">
  3065. <summary>
  3066. Appends logging events to the console.
  3067. </summary>
  3068. <remarks>
  3069. <para>
  3070. ConsoleAppender appends log events to the standard output stream
  3071. or the error output stream using a layout specified by the
  3072. user.
  3073. </para>
  3074. <para>
  3075. By default, all output is written to the console's standard output stream.
  3076. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
  3077. error stream.
  3078. </para>
  3079. <para>
  3080. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  3081. <c>System.Console.Error</c> that is set at the time the event is appended.
  3082. Therefore it is possible to programmatically redirect the output of this appender
  3083. (for example NUnit does this to capture program output). While this is the desired
  3084. behavior of this appender it may have security implications in your application.
  3085. </para>
  3086. </remarks>
  3087. <author>Nicko Cadell</author>
  3088. <author>Gert Driesen</author>
  3089. </member>
  3090. <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
  3091. <summary>
  3092. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3093. standard output stream.
  3094. </summary>
  3095. <remarks>
  3096. <para>
  3097. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3098. standard output stream.
  3099. </para>
  3100. </remarks>
  3101. </member>
  3102. <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
  3103. <summary>
  3104. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3105. standard error output stream.
  3106. </summary>
  3107. <remarks>
  3108. <para>
  3109. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  3110. standard error output stream.
  3111. </para>
  3112. </remarks>
  3113. </member>
  3114. <member name="M:log4net.Appender.ConsoleAppender.#ctor">
  3115. <summary>
  3116. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class.
  3117. </summary>
  3118. <remarks>
  3119. The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
  3120. to the standard output stream.
  3121. </remarks>
  3122. </member>
  3123. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
  3124. <summary>
  3125. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
  3126. with the specified layout.
  3127. </summary>
  3128. <param name="layout">the layout to use for this appender</param>
  3129. <remarks>
  3130. The instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class is set up to write
  3131. to the standard output stream.
  3132. </remarks>
  3133. </member>
  3134. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  3135. <summary>
  3136. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender"/> class
  3137. with the specified layout.
  3138. </summary>
  3139. <param name="layout">the layout to use for this appender</param>
  3140. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  3141. <remarks>
  3142. When <paramref name="writeToErrorStream"/> is set to <c>true</c>, output is written to
  3143. the standard error output stream. Otherwise, output is written to the standard
  3144. output stream.
  3145. </remarks>
  3146. </member>
  3147. <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
  3148. <summary>
  3149. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  3150. </summary>
  3151. <param name="loggingEvent">The event to log.</param>
  3152. <remarks>
  3153. <para>
  3154. Writes the event to the console.
  3155. </para>
  3156. <para>
  3157. The format of the output will depend on the appender's layout.
  3158. </para>
  3159. </remarks>
  3160. </member>
  3161. <member name="P:log4net.Appender.ConsoleAppender.Target">
  3162. <summary>
  3163. Target is the value of the console output stream.
  3164. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3165. </summary>
  3166. <value>
  3167. Target is the value of the console output stream.
  3168. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3169. </value>
  3170. <remarks>
  3171. <para>
  3172. Target is the value of the console output stream.
  3173. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  3174. </para>
  3175. </remarks>
  3176. </member>
  3177. <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
  3178. <summary>
  3179. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3180. </summary>
  3181. <value><c>true</c></value>
  3182. <remarks>
  3183. <para>
  3184. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3185. </para>
  3186. </remarks>
  3187. </member>
  3188. <member name="T:log4net.Appender.DebugAppender">
  3189. <summary>
  3190. Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
  3191. </summary>
  3192. <remarks>
  3193. <para>
  3194. The application configuration file can be used to control what listeners
  3195. are actually used. See the MSDN documentation for the
  3196. <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
  3197. debug system.
  3198. </para>
  3199. <para>
  3200. Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
  3201. method. The event's logger name is passed as the value for the category name to the Write method.
  3202. </para>
  3203. </remarks>
  3204. <author>Nicko Cadell</author>
  3205. </member>
  3206. <member name="M:log4net.Appender.DebugAppender.#ctor">
  3207. <summary>
  3208. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>.
  3209. </summary>
  3210. <remarks>
  3211. <para>
  3212. Default constructor.
  3213. </para>
  3214. </remarks>
  3215. </member>
  3216. <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
  3217. <summary>
  3218. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender"/>
  3219. with a specified layout.
  3220. </summary>
  3221. <param name="layout">The layout to use with this appender.</param>
  3222. <remarks>
  3223. <para>
  3224. Obsolete constructor.
  3225. </para>
  3226. </remarks>
  3227. </member>
  3228. <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
  3229. <summary>
  3230. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  3231. </summary>
  3232. <param name="loggingEvent">The event to log.</param>
  3233. <remarks>
  3234. <para>
  3235. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  3236. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is <c>true</c> then the <see cref="M:System.Diagnostics.Debug.Flush"/>
  3237. is called.
  3238. </para>
  3239. </remarks>
  3240. </member>
  3241. <member name="F:log4net.Appender.DebugAppender.m_immediateFlush">
  3242. <summary>
  3243. Immediate flush means that the underlying writer or output stream
  3244. will be flushed at the end of each append operation.
  3245. </summary>
  3246. <remarks>
  3247. <para>
  3248. Immediate flush is slower but ensures that each append request is
  3249. actually written. If <see cref="P:log4net.Appender.DebugAppender.ImmediateFlush"/> is set to
  3250. <c>false</c>, then there is a good chance that the last few
  3251. logs events are not actually written to persistent media if and
  3252. when the application crashes.
  3253. </para>
  3254. <para>
  3255. The default value is <c>true</c>.</para>
  3256. </remarks>
  3257. </member>
  3258. <member name="P:log4net.Appender.DebugAppender.ImmediateFlush">
  3259. <summary>
  3260. Gets or sets a value that indicates whether the appender will
  3261. flush at the end of each write.
  3262. </summary>
  3263. <remarks>
  3264. <para>The default behavior is to flush at the end of each
  3265. write. If the option is set to<c>false</c>, then the underlying
  3266. stream can defer writing to physical medium to a later time.
  3267. </para>
  3268. <para>
  3269. Avoiding the flush operation at the end of each append results
  3270. in a performance gain of 10 to 20 percent. However, there is safety
  3271. trade-off involved in skipping flushing. Indeed, when flushing is
  3272. skipped, then it is likely that the last few log events will not
  3273. be recorded on disk when the application exits. This is a high
  3274. price to pay even for a 20% performance gain.
  3275. </para>
  3276. </remarks>
  3277. </member>
  3278. <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
  3279. <summary>
  3280. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3281. </summary>
  3282. <value><c>true</c></value>
  3283. <remarks>
  3284. <para>
  3285. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3286. </para>
  3287. </remarks>
  3288. </member>
  3289. <member name="T:log4net.Appender.EventLogAppender">
  3290. <summary>
  3291. Writes events to the system event log.
  3292. </summary>
  3293. <remarks>
  3294. <para>
  3295. The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges.
  3296. See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog
  3297. </para>
  3298. <para>
  3299. The <c>EventID</c> of the event log entry can be
  3300. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3301. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3302. </para>
  3303. <para>
  3304. The <c>Category</c> of the event log entry can be
  3305. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3306. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3307. </para>
  3308. <para>
  3309. There is a limit of 32K characters for an event log message
  3310. </para>
  3311. <para>
  3312. When configuring the EventLogAppender a mapping can be
  3313. specified to map a logging level to an event log entry type. For example:
  3314. </para>
  3315. <code lang="XML">
  3316. &lt;mapping&gt;
  3317. &lt;level value="ERROR" /&gt;
  3318. &lt;eventLogEntryType value="Error" /&gt;
  3319. &lt;/mapping&gt;
  3320. &lt;mapping&gt;
  3321. &lt;level value="DEBUG" /&gt;
  3322. &lt;eventLogEntryType value="Information" /&gt;
  3323. &lt;/mapping&gt;
  3324. </code>
  3325. <para>
  3326. The Level is the standard log4net logging level and eventLogEntryType can be any value
  3327. from the <see cref="T:System.Diagnostics.EventLogEntryType"/> enum, i.e.:
  3328. <list type="bullet">
  3329. <item><term>Error</term><description>an error event</description></item>
  3330. <item><term>Warning</term><description>a warning event</description></item>
  3331. <item><term>Information</term><description>an informational event</description></item>
  3332. </list>
  3333. </para>
  3334. </remarks>
  3335. <author>Aspi Havewala</author>
  3336. <author>Douglas de la Torre</author>
  3337. <author>Nicko Cadell</author>
  3338. <author>Gert Driesen</author>
  3339. <author>Thomas Voss</author>
  3340. </member>
  3341. <member name="M:log4net.Appender.EventLogAppender.#ctor">
  3342. <summary>
  3343. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class.
  3344. </summary>
  3345. <remarks>
  3346. <para>
  3347. Default constructor.
  3348. </para>
  3349. </remarks>
  3350. </member>
  3351. <member name="M:log4net.Appender.EventLogAppender.#ctor(log4net.Layout.ILayout)">
  3352. <summary>
  3353. Initializes a new instance of the <see cref="T:log4net.Appender.EventLogAppender"/> class
  3354. with the specified <see cref="T:log4net.Layout.ILayout"/>.
  3355. </summary>
  3356. <param name="layout">The <see cref="T:log4net.Layout.ILayout"/> to use with this appender.</param>
  3357. <remarks>
  3358. <para>
  3359. Obsolete constructor.
  3360. </para>
  3361. </remarks>
  3362. </member>
  3363. <member name="M:log4net.Appender.EventLogAppender.AddMapping(log4net.Appender.EventLogAppender.Level2EventLogEntryType)">
  3364. <summary>
  3365. Add a mapping of level to <see cref="T:System.Diagnostics.EventLogEntryType"/> - done by the config file
  3366. </summary>
  3367. <param name="mapping">The mapping to add</param>
  3368. <remarks>
  3369. <para>
  3370. Add a <see cref="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType"/> mapping to this appender.
  3371. Each mapping defines the event log entry type for a level.
  3372. </para>
  3373. </remarks>
  3374. </member>
  3375. <member name="M:log4net.Appender.EventLogAppender.ActivateOptions">
  3376. <summary>
  3377. Initialize the appender based on the options set
  3378. </summary>
  3379. <remarks>
  3380. <para>
  3381. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3382. activation scheme. The <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> method must
  3383. be called on this object after the configuration properties have
  3384. been set. Until <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> is called this
  3385. object is in an undefined state and must not be used.
  3386. </para>
  3387. <para>
  3388. If any of the configuration properties are modified then
  3389. <see cref="M:log4net.Appender.EventLogAppender.ActivateOptions"/> must be called again.
  3390. </para>
  3391. </remarks>
  3392. </member>
  3393. <member name="M:log4net.Appender.EventLogAppender.CreateEventSource(System.String,System.String,System.String)">
  3394. <summary>
  3395. Create an event log source
  3396. </summary>
  3397. <remarks>
  3398. Uses different API calls under NET_2_0
  3399. </remarks>
  3400. </member>
  3401. <member name="M:log4net.Appender.EventLogAppender.Append(log4net.Core.LoggingEvent)">
  3402. <summary>
  3403. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3404. method.
  3405. </summary>
  3406. <param name="loggingEvent">the event to log</param>
  3407. <remarks>
  3408. <para>Writes the event to the system event log using the
  3409. <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>.</para>
  3410. <para>If the event has an <c>EventID</c> property (see <see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3411. set then this integer will be used as the event log event id.</para>
  3412. <para>
  3413. There is a limit of 32K characters for an event log message
  3414. </para>
  3415. </remarks>
  3416. </member>
  3417. <member name="M:log4net.Appender.EventLogAppender.GetEntryType(log4net.Core.Level)">
  3418. <summary>
  3419. Get the equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/>
  3420. </summary>
  3421. <param name="level">the Level to convert to an EventLogEntryType</param>
  3422. <returns>The equivalent <see cref="T:System.Diagnostics.EventLogEntryType"/> for a <see cref="T:log4net.Core.Level"/> <paramref name="level"/></returns>
  3423. <remarks>
  3424. Because there are fewer applicable <see cref="T:System.Diagnostics.EventLogEntryType"/>
  3425. values to use in logging levels than there are in the
  3426. <see cref="T:log4net.Core.Level"/> this is a one way mapping. There is
  3427. a loss of information during the conversion.
  3428. </remarks>
  3429. </member>
  3430. <member name="F:log4net.Appender.EventLogAppender.m_logName">
  3431. <summary>
  3432. The log name is the section in the event logs where the messages
  3433. are stored.
  3434. </summary>
  3435. </member>
  3436. <member name="F:log4net.Appender.EventLogAppender.m_applicationName">
  3437. <summary>
  3438. Name of the application to use when logging. This appears in the
  3439. application column of the event log named by <see cref="F:log4net.Appender.EventLogAppender.m_logName"/>.
  3440. </summary>
  3441. </member>
  3442. <member name="F:log4net.Appender.EventLogAppender.m_machineName">
  3443. <summary>
  3444. The name of the machine which holds the event log. This is
  3445. currently only allowed to be '.' i.e. the current machine.
  3446. </summary>
  3447. </member>
  3448. <member name="F:log4net.Appender.EventLogAppender.m_levelMapping">
  3449. <summary>
  3450. Mapping from level object to EventLogEntryType
  3451. </summary>
  3452. </member>
  3453. <member name="F:log4net.Appender.EventLogAppender.m_securityContext">
  3454. <summary>
  3455. The security context to use for privileged calls
  3456. </summary>
  3457. </member>
  3458. <member name="F:log4net.Appender.EventLogAppender.m_eventId">
  3459. <summary>
  3460. The event ID to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3461. </summary>
  3462. </member>
  3463. <member name="F:log4net.Appender.EventLogAppender.m_category">
  3464. <summary>
  3465. The event category to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3466. </summary>
  3467. </member>
  3468. <member name="F:log4net.Appender.EventLogAppender.declaringType">
  3469. <summary>
  3470. The fully qualified type of the EventLogAppender class.
  3471. </summary>
  3472. <remarks>
  3473. Used by the internal logger to record the Type of the
  3474. log message.
  3475. </remarks>
  3476. </member>
  3477. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_DEFAULT">
  3478. <summary>
  3479. The maximum size supported by default.
  3480. </summary>
  3481. <remarks>
  3482. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx
  3483. The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766
  3484. may leave space for a two byte null terminator of #0#0). The 32766 max
  3485. length is what the .NET 4.0 source code checks for, but this is WRONG!
  3486. Strings with a length > 31839 on Windows Vista or higher can CORRUPT
  3487. the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent()
  3488. for the use of the 32766 max size.
  3489. </remarks>
  3490. </member>
  3491. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE_VISTA_OR_NEWER">
  3492. <summary>
  3493. The maximum size supported by a windows operating system that is vista
  3494. or newer.
  3495. </summary>
  3496. <remarks>
  3497. See ReportEvent API:
  3498. http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx
  3499. ReportEvent's lpStrings parameter:
  3500. "A pointer to a buffer containing an array of
  3501. null-terminated strings that are merged into the message before Event Viewer
  3502. displays the string to the user. This parameter must be a valid pointer
  3503. (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters."
  3504. Going beyond the size of 31839 will (at some point) corrupt the event log on Windows
  3505. Vista or higher! It may succeed for a while...but you will eventually run into the
  3506. error: "System.ComponentModel.Win32Exception : A device attached to the system is
  3507. not functioning", and the event log will then be corrupt (I was able to corrupt
  3508. an event log using a length of 31877 on Windows 7).
  3509. The max size for Windows Vista or higher is documented here:
  3510. http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx.
  3511. Going over this size may succeed a few times but the buffer will overrun and
  3512. eventually corrupt the log (based on testing).
  3513. The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API.
  3514. The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a
  3515. terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the
  3516. buffer, given enough time).
  3517. </remarks>
  3518. </member>
  3519. <member name="F:log4net.Appender.EventLogAppender.MAX_EVENTLOG_MESSAGE_SIZE">
  3520. <summary>
  3521. The maximum size that the operating system supports for
  3522. a event log message.
  3523. </summary>
  3524. <remarks>
  3525. Used to determine the maximum string length that can be written
  3526. to the operating system event log and eventually truncate a string
  3527. that exceeds the limits.
  3528. </remarks>
  3529. </member>
  3530. <member name="M:log4net.Appender.EventLogAppender.GetMaxEventLogMessageSize">
  3531. <summary>
  3532. This method determines the maximum event log message size allowed for
  3533. the current environment.
  3534. </summary>
  3535. <returns></returns>
  3536. </member>
  3537. <member name="P:log4net.Appender.EventLogAppender.LogName">
  3538. <summary>
  3539. The name of the log where messages will be stored.
  3540. </summary>
  3541. <value>
  3542. The string name of the log where messages will be stored.
  3543. </value>
  3544. <remarks>
  3545. <para>This is the name of the log as it appears in the Event Viewer
  3546. tree. The default value is to log into the <c>Application</c>
  3547. log, this is where most applications write their events. However
  3548. if you need a separate log for your application (or applications)
  3549. then you should set the <see cref="P:log4net.Appender.EventLogAppender.LogName"/> appropriately.</para>
  3550. <para>This should not be used to distinguish your event log messages
  3551. from those of other applications, the <see cref="P:log4net.Appender.EventLogAppender.ApplicationName"/>
  3552. property should be used to distinguish events. This property should be
  3553. used to group together events into a single log.
  3554. </para>
  3555. </remarks>
  3556. </member>
  3557. <member name="P:log4net.Appender.EventLogAppender.ApplicationName">
  3558. <summary>
  3559. Property used to set the Application name. This appears in the
  3560. event logs when logging.
  3561. </summary>
  3562. <value>
  3563. The string used to distinguish events from different sources.
  3564. </value>
  3565. <remarks>
  3566. Sets the event log source property.
  3567. </remarks>
  3568. </member>
  3569. <member name="P:log4net.Appender.EventLogAppender.MachineName">
  3570. <summary>
  3571. This property is used to return the name of the computer to use
  3572. when accessing the event logs. Currently, this is the current
  3573. computer, denoted by a dot "."
  3574. </summary>
  3575. <value>
  3576. The string name of the machine holding the event log that
  3577. will be logged into.
  3578. </value>
  3579. <remarks>
  3580. This property cannot be changed. It is currently set to '.'
  3581. i.e. the local machine. This may be changed in future.
  3582. </remarks>
  3583. </member>
  3584. <member name="P:log4net.Appender.EventLogAppender.SecurityContext">
  3585. <summary>
  3586. Gets or sets the <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3587. </summary>
  3588. <value>
  3589. The <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> used to write to the EventLog.
  3590. </value>
  3591. <remarks>
  3592. <para>
  3593. The system security context used to write to the EventLog.
  3594. </para>
  3595. <para>
  3596. Unless a <see cref="P:log4net.Appender.EventLogAppender.SecurityContext"/> specified here for this appender
  3597. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3598. security context to use. The default behavior is to use the security context
  3599. of the current thread.
  3600. </para>
  3601. </remarks>
  3602. </member>
  3603. <member name="P:log4net.Appender.EventLogAppender.EventId">
  3604. <summary>
  3605. Gets or sets the <c>EventId</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3606. </summary>
  3607. <remarks>
  3608. <para>
  3609. The <c>EventID</c> of the event log entry will normally be
  3610. set using the <c>EventID</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3611. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3612. This property provides the fallback value which defaults to 0.
  3613. </para>
  3614. </remarks>
  3615. </member>
  3616. <member name="P:log4net.Appender.EventLogAppender.Category">
  3617. <summary>
  3618. Gets or sets the <c>Category</c> to use unless one is explicitly specified via the <c>LoggingEvent</c>'s properties.
  3619. </summary>
  3620. <remarks>
  3621. <para>
  3622. The <c>Category</c> of the event log entry will normally be
  3623. set using the <c>Category</c> property (<see cref="P:log4net.Core.LoggingEvent.Properties"/>)
  3624. on the <see cref="T:log4net.Core.LoggingEvent"/>.
  3625. This property provides the fallback value which defaults to 0.
  3626. </para>
  3627. </remarks>
  3628. </member>
  3629. <member name="P:log4net.Appender.EventLogAppender.RequiresLayout">
  3630. <summary>
  3631. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3632. </summary>
  3633. <value><c>true</c></value>
  3634. <remarks>
  3635. <para>
  3636. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3637. </para>
  3638. </remarks>
  3639. </member>
  3640. <member name="T:log4net.Appender.EventLogAppender.Level2EventLogEntryType">
  3641. <summary>
  3642. A class to act as a mapping between the level that a logging call is made at and
  3643. the color it should be displayed as.
  3644. </summary>
  3645. <remarks>
  3646. <para>
  3647. Defines the mapping between a level and its event log entry type.
  3648. </para>
  3649. </remarks>
  3650. </member>
  3651. <member name="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType">
  3652. <summary>
  3653. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3654. </summary>
  3655. <remarks>
  3656. <para>
  3657. Required property.
  3658. The <see cref="P:log4net.Appender.EventLogAppender.Level2EventLogEntryType.EventLogEntryType"/> for this entry
  3659. </para>
  3660. </remarks>
  3661. </member>
  3662. <member name="T:log4net.Appender.FileAppender">
  3663. <summary>
  3664. Appends logging events to a file.
  3665. </summary>
  3666. <remarks>
  3667. <para>
  3668. Logging events are sent to the file specified by
  3669. the <see cref="P:log4net.Appender.FileAppender.File"/> property.
  3670. </para>
  3671. <para>
  3672. The file can be opened in either append or overwrite mode
  3673. by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
  3674. If the file path is relative it is taken as relative from
  3675. the application base directory. The file encoding can be
  3676. specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
  3677. </para>
  3678. <para>
  3679. The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  3680. values will be written each time the file is opened and closed
  3681. respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
  3682. then the file may contain multiple copies of the header and footer.
  3683. </para>
  3684. <para>
  3685. This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
  3686. is called. This will typically be during configuration.
  3687. If the file cannot be opened for writing the appender will attempt
  3688. to open the file again each time a message is logged to the appender.
  3689. If the file cannot be opened for writing when a message is logged then
  3690. the message will be discarded by this appender.
  3691. </para>
  3692. <para>
  3693. The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
  3694. the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
  3695. The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
  3696. is to obtain an exclusive write lock on the file until this appender is closed.
  3697. The alternative models only hold a
  3698. write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
  3699. or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
  3700. </para>
  3701. <para>
  3702. All locking strategies have issues and you should seriously consider using a different strategy that
  3703. avoids having multiple processes logging to the same file.
  3704. </para>
  3705. </remarks>
  3706. <author>Nicko Cadell</author>
  3707. <author>Gert Driesen</author>
  3708. <author>Rodrigo B. de Oliveira</author>
  3709. <author>Douglas de la Torre</author>
  3710. <author>Niall Daley</author>
  3711. </member>
  3712. <member name="T:log4net.Appender.TextWriterAppender">
  3713. <summary>
  3714. Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
  3715. </summary>
  3716. <remarks>
  3717. <para>
  3718. An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
  3719. </para>
  3720. <para>
  3721. This appender may be used stand alone if initialized with an appropriate
  3722. writer, however it is typically used as a base class for an appender that
  3723. can open a <see cref="T:System.IO.TextWriter"/> to write to.
  3724. </para>
  3725. </remarks>
  3726. <author>Nicko Cadell</author>
  3727. <author>Gert Driesen</author>
  3728. <author>Douglas de la Torre</author>
  3729. </member>
  3730. <member name="M:log4net.Appender.TextWriterAppender.#ctor">
  3731. <summary>
  3732. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class.
  3733. </summary>
  3734. <remarks>
  3735. <para>
  3736. Default constructor.
  3737. </para>
  3738. </remarks>
  3739. </member>
  3740. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
  3741. <summary>
  3742. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and
  3743. sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
  3744. with the specified <see cref="T:System.IO.Stream"/>.
  3745. </summary>
  3746. <param name="layout">The layout to use with this appender.</param>
  3747. <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
  3748. <remarks>
  3749. <para>
  3750. Obsolete constructor.
  3751. </para>
  3752. </remarks>
  3753. </member>
  3754. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
  3755. <summary>
  3756. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender"/> class and sets
  3757. the output destination to the specified <see cref="T:System.IO.StreamWriter"/>.
  3758. </summary>
  3759. <param name="layout">The layout to use with this appender</param>
  3760. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to output to</param>
  3761. <remarks>
  3762. The <see cref="T:System.IO.TextWriter"/> must have been previously opened.
  3763. </remarks>
  3764. <remarks>
  3765. <para>
  3766. Obsolete constructor.
  3767. </para>
  3768. </remarks>
  3769. </member>
  3770. <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
  3771. <summary>
  3772. This method determines if there is a sense in attempting to append.
  3773. </summary>
  3774. <remarks>
  3775. <para>
  3776. This method checks if an output target has been set and if a
  3777. layout has been set.
  3778. </para>
  3779. </remarks>
  3780. <returns><c>false</c> if any of the preconditions fail.</returns>
  3781. </member>
  3782. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
  3783. <summary>
  3784. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3785. method.
  3786. </summary>
  3787. <param name="loggingEvent">The event to log.</param>
  3788. <remarks>
  3789. <para>
  3790. Writes a log statement to the output stream if the output stream exists
  3791. and is writable.
  3792. </para>
  3793. <para>
  3794. The format of the output will depend on the appender's layout.
  3795. </para>
  3796. </remarks>
  3797. </member>
  3798. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
  3799. <summary>
  3800. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  3801. method.
  3802. </summary>
  3803. <param name="loggingEvents">The array of events to log.</param>
  3804. <remarks>
  3805. <para>
  3806. This method writes all the bulk logged events to the output writer
  3807. before flushing the stream.
  3808. </para>
  3809. </remarks>
  3810. </member>
  3811. <member name="M:log4net.Appender.TextWriterAppender.OnClose">
  3812. <summary>
  3813. Close this appender instance. The underlying stream or writer is also closed.
  3814. </summary>
  3815. <remarks>
  3816. Closed appenders cannot be reused.
  3817. </remarks>
  3818. </member>
  3819. <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
  3820. <summary>
  3821. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3822. </summary>
  3823. <remarks>
  3824. <para>
  3825. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3826. </para>
  3827. </remarks>
  3828. </member>
  3829. <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
  3830. <summary>
  3831. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3832. </summary>
  3833. <remarks>
  3834. <para>
  3835. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3836. </para>
  3837. </remarks>
  3838. </member>
  3839. <member name="M:log4net.Appender.TextWriterAppender.Reset">
  3840. <summary>
  3841. Clears internal references to the underlying <see cref="T:System.IO.TextWriter"/>
  3842. and other variables.
  3843. </summary>
  3844. <remarks>
  3845. <para>
  3846. Subclasses can override this method for an alternate closing behavior.
  3847. </para>
  3848. </remarks>
  3849. </member>
  3850. <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
  3851. <summary>
  3852. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3853. </summary>
  3854. <remarks>
  3855. <para>
  3856. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3857. </para>
  3858. </remarks>
  3859. </member>
  3860. <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
  3861. <summary>
  3862. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3863. </summary>
  3864. <remarks>
  3865. <para>
  3866. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3867. </para>
  3868. </remarks>
  3869. </member>
  3870. <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
  3871. <summary>
  3872. Called to allow a subclass to lazily initialize the writer
  3873. </summary>
  3874. <remarks>
  3875. <para>
  3876. This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
  3877. <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
  3878. attempt to initialize the writer multiple times.
  3879. </para>
  3880. </remarks>
  3881. </member>
  3882. <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
  3883. <summary>
  3884. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3885. will be written to.
  3886. </summary>
  3887. </member>
  3888. <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
  3889. <summary>
  3890. Immediate flush means that the underlying <see cref="T:System.IO.TextWriter"/>
  3891. or output stream will be flushed at the end of each append operation.
  3892. </summary>
  3893. <remarks>
  3894. <para>
  3895. Immediate flush is slower but ensures that each append request is
  3896. actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
  3897. <c>false</c>, then there is a good chance that the last few
  3898. logging events are not actually persisted if and when the application
  3899. crashes.
  3900. </para>
  3901. <para>
  3902. The default value is <c>true</c>.
  3903. </para>
  3904. </remarks>
  3905. </member>
  3906. <member name="F:log4net.Appender.TextWriterAppender.declaringType">
  3907. <summary>
  3908. The fully qualified type of the TextWriterAppender class.
  3909. </summary>
  3910. <remarks>
  3911. Used by the internal logger to record the Type of the
  3912. log message.
  3913. </remarks>
  3914. </member>
  3915. <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
  3916. <summary>
  3917. Gets or set whether the appender will flush at the end
  3918. of each append operation.
  3919. </summary>
  3920. <value>
  3921. <para>
  3922. The default behavior is to flush at the end of each
  3923. append operation.
  3924. </para>
  3925. <para>
  3926. If this option is set to <c>false</c>, then the underlying
  3927. stream can defer persisting the logging event to a later
  3928. time.
  3929. </para>
  3930. </value>
  3931. <remarks>
  3932. Avoiding the flush operation at the end of each append results in
  3933. a performance gain of 10 to 20 percent. However, there is safety
  3934. trade-off involved in skipping flushing. Indeed, when flushing is
  3935. skipped, then it is likely that the last few log events will not
  3936. be recorded on disk when the application exits. This is a high
  3937. price to pay even for a 20% performance gain.
  3938. </remarks>
  3939. </member>
  3940. <member name="P:log4net.Appender.TextWriterAppender.Writer">
  3941. <summary>
  3942. Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
  3943. </summary>
  3944. <remarks>
  3945. <para>
  3946. The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
  3947. </para>
  3948. <para>
  3949. The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
  3950. instance is closed.
  3951. </para>
  3952. <para>
  3953. <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
  3954. </para>
  3955. </remarks>
  3956. </member>
  3957. <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
  3958. <summary>
  3959. Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
  3960. <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
  3961. </summary>
  3962. <value>
  3963. The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  3964. </value>
  3965. </member>
  3966. <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
  3967. <summary>
  3968. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3969. </summary>
  3970. <value><c>true</c></value>
  3971. <remarks>
  3972. <para>
  3973. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  3974. </para>
  3975. </remarks>
  3976. </member>
  3977. <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
  3978. <summary>
  3979. Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3980. will be written to.
  3981. </summary>
  3982. <value>
  3983. The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
  3984. </value>
  3985. <remarks>
  3986. <para>
  3987. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  3988. will be written to.
  3989. </para>
  3990. </remarks>
  3991. </member>
  3992. <member name="M:log4net.Appender.FileAppender.#ctor">
  3993. <summary>
  3994. Default constructor
  3995. </summary>
  3996. <remarks>
  3997. <para>
  3998. Default constructor
  3999. </para>
  4000. </remarks>
  4001. </member>
  4002. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
  4003. <summary>
  4004. Construct a new appender using the layout, file and append mode.
  4005. </summary>
  4006. <param name="layout">the layout to use with this appender</param>
  4007. <param name="filename">the full path to the file to write to</param>
  4008. <param name="append">flag to indicate if the file should be appended to</param>
  4009. <remarks>
  4010. <para>
  4011. Obsolete constructor.
  4012. </para>
  4013. </remarks>
  4014. </member>
  4015. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
  4016. <summary>
  4017. Construct a new appender using the layout and file specified.
  4018. The file will be appended to.
  4019. </summary>
  4020. <param name="layout">the layout to use with this appender</param>
  4021. <param name="filename">the full path to the file to write to</param>
  4022. <remarks>
  4023. <para>
  4024. Obsolete constructor.
  4025. </para>
  4026. </remarks>
  4027. </member>
  4028. <member name="M:log4net.Appender.FileAppender.ActivateOptions">
  4029. <summary>
  4030. Activate the options on the file appender.
  4031. </summary>
  4032. <remarks>
  4033. <para>
  4034. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4035. activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
  4036. be called on this object after the configuration properties have
  4037. been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
  4038. object is in an undefined state and must not be used.
  4039. </para>
  4040. <para>
  4041. If any of the configuration properties are modified then
  4042. <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
  4043. </para>
  4044. <para>
  4045. This will cause the file to be opened.
  4046. </para>
  4047. </remarks>
  4048. </member>
  4049. <member name="M:log4net.Appender.FileAppender.Reset">
  4050. <summary>
  4051. Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
  4052. </summary>
  4053. <remarks>
  4054. <para>
  4055. Resets the filename and the file stream.
  4056. </para>
  4057. </remarks>
  4058. </member>
  4059. <member name="M:log4net.Appender.FileAppender.PrepareWriter">
  4060. <summary>
  4061. Called to initialize the file writer
  4062. </summary>
  4063. <remarks>
  4064. <para>
  4065. Will be called for each logged message until the file is
  4066. successfully opened.
  4067. </para>
  4068. </remarks>
  4069. </member>
  4070. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
  4071. <summary>
  4072. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  4073. method.
  4074. </summary>
  4075. <param name="loggingEvent">The event to log.</param>
  4076. <remarks>
  4077. <para>
  4078. Writes a log statement to the output stream if the output stream exists
  4079. and is writable.
  4080. </para>
  4081. <para>
  4082. The format of the output will depend on the appender's layout.
  4083. </para>
  4084. </remarks>
  4085. </member>
  4086. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
  4087. <summary>
  4088. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  4089. method.
  4090. </summary>
  4091. <param name="loggingEvents">The array of events to log.</param>
  4092. <remarks>
  4093. <para>
  4094. Acquires the output file locks once before writing all the events to
  4095. the stream.
  4096. </para>
  4097. </remarks>
  4098. </member>
  4099. <member name="M:log4net.Appender.FileAppender.WriteFooter">
  4100. <summary>
  4101. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  4102. </summary>
  4103. <remarks>
  4104. <para>
  4105. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  4106. </para>
  4107. </remarks>
  4108. </member>
  4109. <member name="M:log4net.Appender.FileAppender.WriteHeader">
  4110. <summary>
  4111. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  4112. </summary>
  4113. <remarks>
  4114. <para>
  4115. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  4116. </para>
  4117. </remarks>
  4118. </member>
  4119. <member name="M:log4net.Appender.FileAppender.CloseWriter">
  4120. <summary>
  4121. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  4122. </summary>
  4123. <remarks>
  4124. <para>
  4125. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  4126. </para>
  4127. </remarks>
  4128. </member>
  4129. <member name="M:log4net.Appender.FileAppender.CloseFile">
  4130. <summary>
  4131. Closes the previously opened file.
  4132. </summary>
  4133. <remarks>
  4134. <para>
  4135. Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
  4136. closes the file.
  4137. </para>
  4138. </remarks>
  4139. </member>
  4140. <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
  4141. <summary>
  4142. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  4143. </summary>
  4144. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  4145. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  4146. <remarks>
  4147. <para>
  4148. Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
  4149. Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
  4150. </para>
  4151. </remarks>
  4152. </member>
  4153. <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
  4154. <summary>
  4155. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  4156. </summary>
  4157. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  4158. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  4159. <remarks>
  4160. <para>
  4161. If there was already an opened file, then the previous file
  4162. is closed first.
  4163. </para>
  4164. <para>
  4165. This method will ensure that the directory structure
  4166. for the <paramref name="fileName"/> specified exists.
  4167. </para>
  4168. </remarks>
  4169. </member>
  4170. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
  4171. <summary>
  4172. Sets the quiet writer used for file output
  4173. </summary>
  4174. <param name="fileStream">the file stream that has been opened for writing</param>
  4175. <remarks>
  4176. <para>
  4177. This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
  4178. over the <paramref name="fileStream"/> and passes it to the
  4179. <see cref="M:SetQWForFiles(TextWriter)"/> method.
  4180. </para>
  4181. <para>
  4182. This method can be overridden by sub classes that want to wrap the
  4183. <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
  4184. data using a <c>System.Security.Cryptography.CryptoStream</c>.
  4185. </para>
  4186. </remarks>
  4187. </member>
  4188. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
  4189. <summary>
  4190. Sets the quiet writer being used.
  4191. </summary>
  4192. <param name="writer">the writer over the file stream that has been opened for writing</param>
  4193. <remarks>
  4194. <para>
  4195. This method can be overridden by sub classes that want to
  4196. wrap the <see cref="T:System.IO.TextWriter"/> in some way.
  4197. </para>
  4198. </remarks>
  4199. </member>
  4200. <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
  4201. <summary>
  4202. Convert a path into a fully qualified path.
  4203. </summary>
  4204. <param name="path">The path to convert.</param>
  4205. <returns>The fully qualified path.</returns>
  4206. <remarks>
  4207. <para>
  4208. Converts the path specified to a fully
  4209. qualified path. If the path is relative it is
  4210. taken as relative from the application base
  4211. directory.
  4212. </para>
  4213. </remarks>
  4214. </member>
  4215. <member name="F:log4net.Appender.FileAppender.m_appendToFile">
  4216. <summary>
  4217. Flag to indicate if we should append to the file
  4218. or overwrite the file. The default is to append.
  4219. </summary>
  4220. </member>
  4221. <member name="F:log4net.Appender.FileAppender.m_fileName">
  4222. <summary>
  4223. The name of the log file.
  4224. </summary>
  4225. </member>
  4226. <member name="F:log4net.Appender.FileAppender.m_encoding">
  4227. <summary>
  4228. The encoding to use for the file stream.
  4229. </summary>
  4230. </member>
  4231. <member name="F:log4net.Appender.FileAppender.m_securityContext">
  4232. <summary>
  4233. The security context to use for privileged calls
  4234. </summary>
  4235. </member>
  4236. <member name="F:log4net.Appender.FileAppender.m_stream">
  4237. <summary>
  4238. The stream to log to. Has added locking semantics
  4239. </summary>
  4240. </member>
  4241. <member name="F:log4net.Appender.FileAppender.m_lockingModel">
  4242. <summary>
  4243. The locking model to use
  4244. </summary>
  4245. </member>
  4246. <member name="F:log4net.Appender.FileAppender.declaringType">
  4247. <summary>
  4248. The fully qualified type of the FileAppender class.
  4249. </summary>
  4250. <remarks>
  4251. Used by the internal logger to record the Type of the
  4252. log message.
  4253. </remarks>
  4254. </member>
  4255. <member name="P:log4net.Appender.FileAppender.File">
  4256. <summary>
  4257. Gets or sets the path to the file that logging will be written to.
  4258. </summary>
  4259. <value>
  4260. The path to the file that logging will be written to.
  4261. </value>
  4262. <remarks>
  4263. <para>
  4264. If the path is relative it is taken as relative from
  4265. the application base directory.
  4266. </para>
  4267. </remarks>
  4268. </member>
  4269. <member name="P:log4net.Appender.FileAppender.AppendToFile">
  4270. <summary>
  4271. Gets or sets a flag that indicates whether the file should be
  4272. appended to or overwritten.
  4273. </summary>
  4274. <value>
  4275. Indicates whether the file should be appended to or overwritten.
  4276. </value>
  4277. <remarks>
  4278. <para>
  4279. If the value is set to false then the file will be overwritten, if
  4280. it is set to true then the file will be appended to.
  4281. </para>
  4282. The default value is true.
  4283. </remarks>
  4284. </member>
  4285. <member name="P:log4net.Appender.FileAppender.Encoding">
  4286. <summary>
  4287. Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  4288. </summary>
  4289. <value>
  4290. The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  4291. </value>
  4292. <remarks>
  4293. <para>
  4294. The default encoding set is <see cref="P:System.Text.Encoding.Default"/>
  4295. which is the encoding for the system's current ANSI code page.
  4296. </para>
  4297. </remarks>
  4298. </member>
  4299. <member name="P:log4net.Appender.FileAppender.SecurityContext">
  4300. <summary>
  4301. Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  4302. </summary>
  4303. <value>
  4304. The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  4305. </value>
  4306. <remarks>
  4307. <para>
  4308. Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
  4309. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  4310. security context to use. The default behavior is to use the security context
  4311. of the current thread.
  4312. </para>
  4313. </remarks>
  4314. </member>
  4315. <member name="P:log4net.Appender.FileAppender.LockingModel">
  4316. <summary>
  4317. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  4318. </summary>
  4319. <value>
  4320. The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
  4321. </value>
  4322. <remarks>
  4323. <para>
  4324. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  4325. </para>
  4326. <para>
  4327. There are three built in locking models, <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>, <see cref="T:log4net.Appender.FileAppender.MinimalLock"/> and <see cref="T:log4net.Appender.FileAppender.InterProcessLock"/> .
  4328. The first locks the file from the start of logging to the end, the
  4329. second locks only for the minimal amount of time when logging each message
  4330. and the last synchronizes processes using a named system wide Mutex.
  4331. </para>
  4332. <para>
  4333. The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
  4334. </para>
  4335. </remarks>
  4336. </member>
  4337. <member name="T:log4net.Appender.FileAppender.LockingStream">
  4338. <summary>
  4339. Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
  4340. to manage access to an underlying resource.
  4341. </summary>
  4342. </member>
  4343. <member name="M:log4net.Appender.FileAppender.LockingStream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)">
  4344. <summary>
  4345. True asynchronous writes are not supported, the implementation forces a synchronous write.
  4346. </summary>
  4347. </member>
  4348. <member name="T:log4net.Core.LogException">
  4349. <summary>
  4350. Exception base type for log4net.
  4351. </summary>
  4352. <remarks>
  4353. <para>
  4354. This type extends <see cref="T:System.ApplicationException"/>. It
  4355. does not add any new functionality but does differentiate the
  4356. type of exception being thrown.
  4357. </para>
  4358. </remarks>
  4359. <author>Nicko Cadell</author>
  4360. <author>Gert Driesen</author>
  4361. </member>
  4362. <member name="M:log4net.Core.LogException.#ctor">
  4363. <summary>
  4364. Constructor
  4365. </summary>
  4366. <remarks>
  4367. <para>
  4368. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class.
  4369. </para>
  4370. </remarks>
  4371. </member>
  4372. <member name="M:log4net.Core.LogException.#ctor(System.String)">
  4373. <summary>
  4374. Constructor
  4375. </summary>
  4376. <param name="message">A message to include with the exception.</param>
  4377. <remarks>
  4378. <para>
  4379. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class with
  4380. the specified message.
  4381. </para>
  4382. </remarks>
  4383. </member>
  4384. <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
  4385. <summary>
  4386. Constructor
  4387. </summary>
  4388. <param name="message">A message to include with the exception.</param>
  4389. <param name="innerException">A nested exception to include.</param>
  4390. <remarks>
  4391. <para>
  4392. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
  4393. with the specified message and inner exception.
  4394. </para>
  4395. </remarks>
  4396. </member>
  4397. <member name="M:log4net.Core.LogException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4398. <summary>
  4399. Serialization constructor
  4400. </summary>
  4401. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
  4402. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  4403. <remarks>
  4404. <para>
  4405. Initializes a new instance of the <see cref="T:log4net.Core.LogException"/> class
  4406. with serialized data.
  4407. </para>
  4408. </remarks>
  4409. </member>
  4410. <member name="T:log4net.Appender.FileAppender.LockingModelBase">
  4411. <summary>
  4412. Locking model base class
  4413. </summary>
  4414. <remarks>
  4415. <para>
  4416. Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
  4417. </para>
  4418. </remarks>
  4419. </member>
  4420. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4421. <summary>
  4422. Open the output file
  4423. </summary>
  4424. <param name="filename">The filename to use</param>
  4425. <param name="append">Whether to append to the file, or overwrite</param>
  4426. <param name="encoding">The encoding to use</param>
  4427. <remarks>
  4428. <para>
  4429. Open the file specified and prepare for logging.
  4430. No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
  4431. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
  4432. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
  4433. </para>
  4434. </remarks>
  4435. </member>
  4436. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
  4437. <summary>
  4438. Close the file
  4439. </summary>
  4440. <remarks>
  4441. <para>
  4442. Close the file. No further writes will be made.
  4443. </para>
  4444. </remarks>
  4445. </member>
  4446. <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
  4447. <summary>
  4448. Acquire the lock on the file
  4449. </summary>
  4450. <returns>A stream that is ready to be written to.</returns>
  4451. <remarks>
  4452. <para>
  4453. Acquire the lock on the file in preparation for writing to it.
  4454. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
  4455. must be called to release the lock on the output file.
  4456. </para>
  4457. </remarks>
  4458. </member>
  4459. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
  4460. <summary>
  4461. Release the lock on the file
  4462. </summary>
  4463. <remarks>
  4464. <para>
  4465. Release the lock on the file. No further writes will be made to the
  4466. stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
  4467. </para>
  4468. </remarks>
  4469. </member>
  4470. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
  4471. <summary>
  4472. Helper method that creates a FileStream under CurrentAppender's SecurityContext.
  4473. </summary>
  4474. <remarks>
  4475. <para>
  4476. Typically called during OpenFile or AcquireLock.
  4477. </para>
  4478. <para>
  4479. If the directory portion of the <paramref name="filename"/> does not exist, it is created
  4480. via Directory.CreateDirecctory.
  4481. </para>
  4482. </remarks>
  4483. <param name="filename"></param>
  4484. <param name="append"></param>
  4485. <param name="fileShare"></param>
  4486. <returns></returns>
  4487. </member>
  4488. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
  4489. <summary>
  4490. Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
  4491. </summary>
  4492. <remarks>
  4493. Does not set <paramref name="stream"/> to null.
  4494. </remarks>
  4495. <param name="stream"></param>
  4496. </member>
  4497. <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
  4498. <summary>
  4499. Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  4500. </summary>
  4501. <value>
  4502. The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  4503. </value>
  4504. <remarks>
  4505. <para>
  4506. The file appender this locking model is attached to and working on
  4507. behalf of.
  4508. </para>
  4509. <para>
  4510. The file appender is used to locate the security context and the error handler to use.
  4511. </para>
  4512. <para>
  4513. The value of this property will be set before <see cref="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)"/> is
  4514. called.
  4515. </para>
  4516. </remarks>
  4517. </member>
  4518. <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
  4519. <summary>
  4520. Hold an exclusive lock on the output file
  4521. </summary>
  4522. <remarks>
  4523. <para>
  4524. Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
  4525. Maintains an exclusive lock on the file during this time.
  4526. </para>
  4527. </remarks>
  4528. </member>
  4529. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4530. <summary>
  4531. Open the file specified and prepare for logging.
  4532. </summary>
  4533. <param name="filename">The filename to use</param>
  4534. <param name="append">Whether to append to the file, or overwrite</param>
  4535. <param name="encoding">The encoding to use</param>
  4536. <remarks>
  4537. <para>
  4538. Open the file specified and prepare for logging.
  4539. No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
  4540. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
  4541. <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
  4542. </para>
  4543. </remarks>
  4544. </member>
  4545. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
  4546. <summary>
  4547. Close the file
  4548. </summary>
  4549. <remarks>
  4550. <para>
  4551. Close the file. No further writes will be made.
  4552. </para>
  4553. </remarks>
  4554. </member>
  4555. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
  4556. <summary>
  4557. Acquire the lock on the file
  4558. </summary>
  4559. <returns>A stream that is ready to be written to.</returns>
  4560. <remarks>
  4561. <para>
  4562. Does nothing. The lock is already taken
  4563. </para>
  4564. </remarks>
  4565. </member>
  4566. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
  4567. <summary>
  4568. Release the lock on the file
  4569. </summary>
  4570. <remarks>
  4571. <para>
  4572. Does nothing. The lock will be released when the file is closed.
  4573. </para>
  4574. </remarks>
  4575. </member>
  4576. <member name="T:log4net.Appender.FileAppender.MinimalLock">
  4577. <summary>
  4578. Acquires the file lock for each write
  4579. </summary>
  4580. <remarks>
  4581. <para>
  4582. Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
  4583. thus holding the lock for the minimal amount of time. This method of locking
  4584. is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
  4585. other processes to move/delete the log file whilst logging continues.
  4586. </para>
  4587. </remarks>
  4588. </member>
  4589. <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4590. <summary>
  4591. Prepares to open the file when the first message is logged.
  4592. </summary>
  4593. <param name="filename">The filename to use</param>
  4594. <param name="append">Whether to append to the file, or overwrite</param>
  4595. <param name="encoding">The encoding to use</param>
  4596. <remarks>
  4597. <para>
  4598. Open the file specified and prepare for logging.
  4599. No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
  4600. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
  4601. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
  4602. </para>
  4603. </remarks>
  4604. </member>
  4605. <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
  4606. <summary>
  4607. Close the file
  4608. </summary>
  4609. <remarks>
  4610. <para>
  4611. Close the file. No further writes will be made.
  4612. </para>
  4613. </remarks>
  4614. </member>
  4615. <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
  4616. <summary>
  4617. Acquire the lock on the file
  4618. </summary>
  4619. <returns>A stream that is ready to be written to.</returns>
  4620. <remarks>
  4621. <para>
  4622. Acquire the lock on the file in preparation for writing to it.
  4623. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
  4624. must be called to release the lock on the output file.
  4625. </para>
  4626. </remarks>
  4627. </member>
  4628. <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
  4629. <summary>
  4630. Release the lock on the file
  4631. </summary>
  4632. <remarks>
  4633. <para>
  4634. Release the lock on the file. No further writes will be made to the
  4635. stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
  4636. </para>
  4637. </remarks>
  4638. </member>
  4639. <member name="T:log4net.Appender.FileAppender.InterProcessLock">
  4640. <summary>
  4641. Provides cross-process file locking.
  4642. </summary>
  4643. <author>Ron Grabowski</author>
  4644. <author>Steve Wranovsky</author>
  4645. </member>
  4646. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  4647. <summary>
  4648. Open the file specified and prepare for logging.
  4649. </summary>
  4650. <param name="filename">The filename to use</param>
  4651. <param name="append">Whether to append to the file, or overwrite</param>
  4652. <param name="encoding">The encoding to use</param>
  4653. <remarks>
  4654. <para>
  4655. Open the file specified and prepare for logging.
  4656. No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
  4657. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
  4658. -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
  4659. </para>
  4660. </remarks>
  4661. </member>
  4662. <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
  4663. <summary>
  4664. Close the file
  4665. </summary>
  4666. <remarks>
  4667. <para>
  4668. Close the file. No further writes will be made.
  4669. </para>
  4670. </remarks>
  4671. </member>
  4672. <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
  4673. <summary>
  4674. Acquire the lock on the file
  4675. </summary>
  4676. <returns>A stream that is ready to be written to.</returns>
  4677. <remarks>
  4678. <para>
  4679. Does nothing. The lock is already taken
  4680. </para>
  4681. </remarks>
  4682. </member>
  4683. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
  4684. <summary>
  4685. </summary>
  4686. </member>
  4687. <member name="T:log4net.Appender.ForwardingAppender">
  4688. <summary>
  4689. This appender forwards logging events to attached appenders.
  4690. </summary>
  4691. <remarks>
  4692. <para>
  4693. The forwarding appender can be used to specify different thresholds
  4694. and filters for the same appender at different locations within the hierarchy.
  4695. </para>
  4696. </remarks>
  4697. <author>Nicko Cadell</author>
  4698. <author>Gert Driesen</author>
  4699. </member>
  4700. <member name="M:log4net.Appender.ForwardingAppender.#ctor">
  4701. <summary>
  4702. Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender"/> class.
  4703. </summary>
  4704. <remarks>
  4705. <para>
  4706. Default constructor.
  4707. </para>
  4708. </remarks>
  4709. </member>
  4710. <member name="M:log4net.Appender.ForwardingAppender.OnClose">
  4711. <summary>
  4712. Closes the appender and releases resources.
  4713. </summary>
  4714. <remarks>
  4715. <para>
  4716. Releases any resources allocated within the appender such as file handles,
  4717. network connections, etc.
  4718. </para>
  4719. <para>
  4720. It is a programming error to append to a closed appender.
  4721. </para>
  4722. </remarks>
  4723. </member>
  4724. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
  4725. <summary>
  4726. Forward the logging event to the attached appenders
  4727. </summary>
  4728. <param name="loggingEvent">The event to log.</param>
  4729. <remarks>
  4730. <para>
  4731. Delivers the logging event to all the attached appenders.
  4732. </para>
  4733. </remarks>
  4734. </member>
  4735. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
  4736. <summary>
  4737. Forward the logging events to the attached appenders
  4738. </summary>
  4739. <param name="loggingEvents">The array of events to log.</param>
  4740. <remarks>
  4741. <para>
  4742. Delivers the logging events to all the attached appenders.
  4743. </para>
  4744. </remarks>
  4745. </member>
  4746. <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  4747. <summary>
  4748. Adds an <see cref="T:log4net.Appender.IAppender"/> to the list of appenders of this
  4749. instance.
  4750. </summary>
  4751. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender"/> to add to this appender.</param>
  4752. <remarks>
  4753. <para>
  4754. If the specified <see cref="T:log4net.Appender.IAppender"/> is already in the list of
  4755. appenders, then it won't be added again.
  4756. </para>
  4757. </remarks>
  4758. </member>
  4759. <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
  4760. <summary>
  4761. Looks for the appender with the specified name.
  4762. </summary>
  4763. <param name="name">The name of the appender to lookup.</param>
  4764. <returns>
  4765. The appender with the specified name, or <c>null</c>.
  4766. </returns>
  4767. <remarks>
  4768. <para>
  4769. Get the named appender attached to this appender.
  4770. </para>
  4771. </remarks>
  4772. </member>
  4773. <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
  4774. <summary>
  4775. Removes all previously added appenders from this appender.
  4776. </summary>
  4777. <remarks>
  4778. <para>
  4779. This is useful when re-reading configuration information.
  4780. </para>
  4781. </remarks>
  4782. </member>
  4783. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  4784. <summary>
  4785. Removes the specified appender from the list of appenders.
  4786. </summary>
  4787. <param name="appender">The appender to remove.</param>
  4788. <returns>The appender removed from the list</returns>
  4789. <remarks>
  4790. The appender removed is not closed.
  4791. If you are discarding the appender you must call
  4792. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4793. </remarks>
  4794. </member>
  4795. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
  4796. <summary>
  4797. Removes the appender with the specified name from the list of appenders.
  4798. </summary>
  4799. <param name="name">The name of the appender to remove.</param>
  4800. <returns>The appender removed from the list</returns>
  4801. <remarks>
  4802. The appender removed is not closed.
  4803. If you are discarding the appender you must call
  4804. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  4805. </remarks>
  4806. </member>
  4807. <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
  4808. <summary>
  4809. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  4810. </summary>
  4811. </member>
  4812. <member name="P:log4net.Appender.ForwardingAppender.Appenders">
  4813. <summary>
  4814. Gets the appenders contained in this appender as an
  4815. <see cref="T:System.Collections.ICollection"/>.
  4816. </summary>
  4817. <remarks>
  4818. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  4819. is returned.
  4820. </remarks>
  4821. <returns>
  4822. A collection of the appenders in this appender.
  4823. </returns>
  4824. </member>
  4825. <member name="T:log4net.Appender.LocalSyslogAppender">
  4826. <summary>
  4827. Logs events to a local syslog service.
  4828. </summary>
  4829. <remarks>
  4830. <note>
  4831. This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
  4832. If these functions are not available on the local system then this appender will not work!
  4833. </note>
  4834. <para>
  4835. The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
  4836. POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
  4837. </para>
  4838. <para>
  4839. This appender talks to a local syslog service. If you need to log to a remote syslog
  4840. daemon and you cannot configure your local syslog service to do this you may be
  4841. able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
  4842. </para>
  4843. <para>
  4844. Syslog messages must have a facility and and a severity. The severity
  4845. is derived from the Level of the logging event.
  4846. The facility must be chosen from the set of defined syslog
  4847. <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  4848. and cannot be extended.
  4849. </para>
  4850. <para>
  4851. An identifier is specified with each log message. This can be specified
  4852. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4853. as the tag) must not contain white space. The default value for the
  4854. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4855. </para>
  4856. </remarks>
  4857. <author>Rob Lyon</author>
  4858. <author>Nicko Cadell</author>
  4859. </member>
  4860. <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
  4861. <summary>
  4862. Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class.
  4863. </summary>
  4864. <remarks>
  4865. This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender"/> class is set up to write
  4866. to a local syslog service.
  4867. </remarks>
  4868. </member>
  4869. <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
  4870. <summary>
  4871. Add a mapping of level to severity
  4872. </summary>
  4873. <param name="mapping">The mapping to add</param>
  4874. <remarks>
  4875. <para>
  4876. Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
  4877. </para>
  4878. </remarks>
  4879. </member>
  4880. <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
  4881. <summary>
  4882. Initialize the appender based on the options set.
  4883. </summary>
  4884. <remarks>
  4885. <para>
  4886. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4887. activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
  4888. be called on this object after the configuration properties have
  4889. been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
  4890. object is in an undefined state and must not be used.
  4891. </para>
  4892. <para>
  4893. If any of the configuration properties are modified then
  4894. <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
  4895. </para>
  4896. </remarks>
  4897. </member>
  4898. <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
  4899. <summary>
  4900. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4901. </summary>
  4902. <param name="loggingEvent">The event to log.</param>
  4903. <remarks>
  4904. <para>
  4905. Writes the event to a remote syslog daemon.
  4906. </para>
  4907. <para>
  4908. The format of the output will depend on the appender's layout.
  4909. </para>
  4910. </remarks>
  4911. </member>
  4912. <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
  4913. <summary>
  4914. Close the syslog when the appender is closed
  4915. </summary>
  4916. <remarks>
  4917. <para>
  4918. Close the syslog when the appender is closed
  4919. </para>
  4920. </remarks>
  4921. </member>
  4922. <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
  4923. <summary>
  4924. Translates a log4net level to a syslog severity.
  4925. </summary>
  4926. <param name="level">A log4net level.</param>
  4927. <returns>A syslog severity.</returns>
  4928. <remarks>
  4929. <para>
  4930. Translates a log4net level to a syslog severity.
  4931. </para>
  4932. </remarks>
  4933. </member>
  4934. <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
  4935. <summary>
  4936. Generate a syslog priority.
  4937. </summary>
  4938. <param name="facility">The syslog facility.</param>
  4939. <param name="severity">The syslog severity.</param>
  4940. <returns>A syslog priority.</returns>
  4941. </member>
  4942. <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
  4943. <summary>
  4944. The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  4945. </summary>
  4946. </member>
  4947. <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
  4948. <summary>
  4949. The message identity
  4950. </summary>
  4951. </member>
  4952. <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
  4953. <summary>
  4954. Marshaled handle to the identity string. We have to hold on to the
  4955. string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
  4956. pointer to the ident and dereference it for each log message.
  4957. </summary>
  4958. </member>
  4959. <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
  4960. <summary>
  4961. Mapping from level object to syslog severity
  4962. </summary>
  4963. </member>
  4964. <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
  4965. <summary>
  4966. Open connection to system logger.
  4967. </summary>
  4968. </member>
  4969. <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
  4970. <summary>
  4971. Generate a log message.
  4972. </summary>
  4973. <remarks>
  4974. <para>
  4975. The libc syslog method takes a format string and a variable argument list similar
  4976. to the classic printf function. As this type of vararg list is not supported
  4977. by C# we need to specify the arguments explicitly. Here we have specified the
  4978. format string with a single message argument. The caller must set the format
  4979. string to <c>"%s"</c>.
  4980. </para>
  4981. </remarks>
  4982. </member>
  4983. <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
  4984. <summary>
  4985. Close descriptor used to write to system logger.
  4986. </summary>
  4987. </member>
  4988. <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
  4989. <summary>
  4990. Message identity
  4991. </summary>
  4992. <remarks>
  4993. <para>
  4994. An identifier is specified with each log message. This can be specified
  4995. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  4996. as the tag) must not contain white space. The default value for the
  4997. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  4998. </para>
  4999. </remarks>
  5000. </member>
  5001. <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
  5002. <summary>
  5003. Syslog facility
  5004. </summary>
  5005. <remarks>
  5006. Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
  5007. facilities is predefined and cannot be extended. The default value
  5008. is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  5009. </remarks>
  5010. </member>
  5011. <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
  5012. <summary>
  5013. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  5014. </summary>
  5015. <value><c>true</c></value>
  5016. <remarks>
  5017. <para>
  5018. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  5019. </para>
  5020. </remarks>
  5021. </member>
  5022. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
  5023. <summary>
  5024. syslog severities
  5025. </summary>
  5026. <remarks>
  5027. <para>
  5028. The log4net Level maps to a syslog severity using the
  5029. <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
  5030. class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
  5031. </para>
  5032. </remarks>
  5033. </member>
  5034. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
  5035. <summary>
  5036. system is unusable
  5037. </summary>
  5038. </member>
  5039. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
  5040. <summary>
  5041. action must be taken immediately
  5042. </summary>
  5043. </member>
  5044. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
  5045. <summary>
  5046. critical conditions
  5047. </summary>
  5048. </member>
  5049. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
  5050. <summary>
  5051. error conditions
  5052. </summary>
  5053. </member>
  5054. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
  5055. <summary>
  5056. warning conditions
  5057. </summary>
  5058. </member>
  5059. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
  5060. <summary>
  5061. normal but significant condition
  5062. </summary>
  5063. </member>
  5064. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
  5065. <summary>
  5066. informational
  5067. </summary>
  5068. </member>
  5069. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
  5070. <summary>
  5071. debug-level messages
  5072. </summary>
  5073. </member>
  5074. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
  5075. <summary>
  5076. syslog facilities
  5077. </summary>
  5078. <remarks>
  5079. <para>
  5080. The syslog facility defines which subsystem the logging comes from.
  5081. This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
  5082. </para>
  5083. </remarks>
  5084. </member>
  5085. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
  5086. <summary>
  5087. kernel messages
  5088. </summary>
  5089. </member>
  5090. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
  5091. <summary>
  5092. random user-level messages
  5093. </summary>
  5094. </member>
  5095. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
  5096. <summary>
  5097. mail system
  5098. </summary>
  5099. </member>
  5100. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
  5101. <summary>
  5102. system daemons
  5103. </summary>
  5104. </member>
  5105. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
  5106. <summary>
  5107. security/authorization messages
  5108. </summary>
  5109. </member>
  5110. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
  5111. <summary>
  5112. messages generated internally by syslogd
  5113. </summary>
  5114. </member>
  5115. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
  5116. <summary>
  5117. line printer subsystem
  5118. </summary>
  5119. </member>
  5120. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
  5121. <summary>
  5122. network news subsystem
  5123. </summary>
  5124. </member>
  5125. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
  5126. <summary>
  5127. UUCP subsystem
  5128. </summary>
  5129. </member>
  5130. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
  5131. <summary>
  5132. clock (cron/at) daemon
  5133. </summary>
  5134. </member>
  5135. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
  5136. <summary>
  5137. security/authorization messages (private)
  5138. </summary>
  5139. </member>
  5140. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
  5141. <summary>
  5142. ftp daemon
  5143. </summary>
  5144. </member>
  5145. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
  5146. <summary>
  5147. NTP subsystem
  5148. </summary>
  5149. </member>
  5150. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
  5151. <summary>
  5152. log audit
  5153. </summary>
  5154. </member>
  5155. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
  5156. <summary>
  5157. log alert
  5158. </summary>
  5159. </member>
  5160. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
  5161. <summary>
  5162. clock daemon
  5163. </summary>
  5164. </member>
  5165. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
  5166. <summary>
  5167. reserved for local use
  5168. </summary>
  5169. </member>
  5170. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
  5171. <summary>
  5172. reserved for local use
  5173. </summary>
  5174. </member>
  5175. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
  5176. <summary>
  5177. reserved for local use
  5178. </summary>
  5179. </member>
  5180. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
  5181. <summary>
  5182. reserved for local use
  5183. </summary>
  5184. </member>
  5185. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
  5186. <summary>
  5187. reserved for local use
  5188. </summary>
  5189. </member>
  5190. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
  5191. <summary>
  5192. reserved for local use
  5193. </summary>
  5194. </member>
  5195. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
  5196. <summary>
  5197. reserved for local use
  5198. </summary>
  5199. </member>
  5200. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
  5201. <summary>
  5202. reserved for local use
  5203. </summary>
  5204. </member>
  5205. <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
  5206. <summary>
  5207. A class to act as a mapping between the level that a logging call is made at and
  5208. the syslog severity that is should be logged at.
  5209. </summary>
  5210. <remarks>
  5211. <para>
  5212. A class to act as a mapping between the level that a logging call is made at and
  5213. the syslog severity that is should be logged at.
  5214. </para>
  5215. </remarks>
  5216. </member>
  5217. <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
  5218. <summary>
  5219. The mapped syslog severity for the specified level
  5220. </summary>
  5221. <remarks>
  5222. <para>
  5223. Required property.
  5224. The mapped syslog severity for the specified level
  5225. </para>
  5226. </remarks>
  5227. </member>
  5228. <member name="T:log4net.Appender.MemoryAppender">
  5229. <summary>
  5230. Stores logging events in an array.
  5231. </summary>
  5232. <remarks>
  5233. <para>
  5234. The memory appender stores all the logging events
  5235. that are appended in an in-memory array.
  5236. </para>
  5237. <para>
  5238. Use the <see cref="M:log4net.Appender.MemoryAppender.GetEvents"/> method to get
  5239. the current list of events that have been appended.
  5240. </para>
  5241. <para>
  5242. Use the <see cref="M:Clear()"/> method to clear the
  5243. current list of events.
  5244. </para>
  5245. </remarks>
  5246. <author>Julian Biddle</author>
  5247. <author>Nicko Cadell</author>
  5248. <author>Gert Driesen</author>
  5249. </member>
  5250. <member name="M:log4net.Appender.MemoryAppender.#ctor">
  5251. <summary>
  5252. Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender"/> class.
  5253. </summary>
  5254. <remarks>
  5255. <para>
  5256. Default constructor.
  5257. </para>
  5258. </remarks>
  5259. </member>
  5260. <member name="M:log4net.Appender.MemoryAppender.GetEvents">
  5261. <summary>
  5262. Gets the events that have been logged.
  5263. </summary>
  5264. <returns>The events that have been logged</returns>
  5265. <remarks>
  5266. <para>
  5267. Gets the events that have been logged.
  5268. </para>
  5269. </remarks>
  5270. </member>
  5271. <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
  5272. <summary>
  5273. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5274. </summary>
  5275. <param name="loggingEvent">the event to log</param>
  5276. <remarks>
  5277. <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
  5278. </remarks>
  5279. </member>
  5280. <member name="M:log4net.Appender.MemoryAppender.Clear">
  5281. <summary>
  5282. Clear the list of events
  5283. </summary>
  5284. <remarks>
  5285. Clear the list of events
  5286. </remarks>
  5287. </member>
  5288. <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
  5289. <summary>
  5290. The list of events that have been appended.
  5291. </summary>
  5292. </member>
  5293. <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
  5294. <summary>
  5295. Value indicating which fields in the event should be fixed
  5296. </summary>
  5297. <remarks>
  5298. By default all fields are fixed
  5299. </remarks>
  5300. </member>
  5301. <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
  5302. <summary>
  5303. Gets or sets a value indicating whether only part of the logging event
  5304. data should be fixed.
  5305. </summary>
  5306. <value>
  5307. <c>true</c> if the appender should only fix part of the logging event
  5308. data, otherwise <c>false</c>. The default is <c>false</c>.
  5309. </value>
  5310. <remarks>
  5311. <para>
  5312. Setting this property to <c>true</c> will cause only part of the event
  5313. data to be fixed and stored in the appender, hereby improving performance.
  5314. </para>
  5315. <para>
  5316. See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
  5317. </para>
  5318. </remarks>
  5319. </member>
  5320. <member name="P:log4net.Appender.MemoryAppender.Fix">
  5321. <summary>
  5322. Gets or sets the fields that will be fixed in the event
  5323. </summary>
  5324. <remarks>
  5325. <para>
  5326. The logging event needs to have certain thread specific values
  5327. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  5328. for details.
  5329. </para>
  5330. </remarks>
  5331. </member>
  5332. <member name="T:log4net.Appender.NetSendAppender">
  5333. <summary>
  5334. Logs entries by sending network messages using the
  5335. <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/> native function.
  5336. </summary>
  5337. <remarks>
  5338. <para>
  5339. You can send messages only to names that are active
  5340. on the network. If you send the message to a user name,
  5341. that user must be logged on and running the Messenger
  5342. service to receive the message.
  5343. </para>
  5344. <para>
  5345. The receiver will get a top most window displaying the
  5346. messages one at a time, therefore this appender should
  5347. not be used to deliver a high volume of messages.
  5348. </para>
  5349. <para>
  5350. The following table lists some possible uses for this appender :
  5351. </para>
  5352. <para>
  5353. <list type="table">
  5354. <listheader>
  5355. <term>Action</term>
  5356. <description>Property Value(s)</description>
  5357. </listheader>
  5358. <item>
  5359. <term>Send a message to a user account on the local machine</term>
  5360. <description>
  5361. <para>
  5362. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine&gt;
  5363. </para>
  5364. <para>
  5365. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5366. </para>
  5367. </description>
  5368. </item>
  5369. <item>
  5370. <term>Send a message to a user account on a remote machine</term>
  5371. <description>
  5372. <para>
  5373. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the remote machine&gt;
  5374. </para>
  5375. <para>
  5376. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5377. </para>
  5378. </description>
  5379. </item>
  5380. <item>
  5381. <term>Send a message to a domain user account</term>
  5382. <description>
  5383. <para>
  5384. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of a domain controller | uninitialized&gt;
  5385. </para>
  5386. <para>
  5387. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  5388. </para>
  5389. </description>
  5390. </item>
  5391. <item>
  5392. <term>Send a message to all the names in a workgroup or domain</term>
  5393. <description>
  5394. <para>
  5395. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;workgroup name | domain name&gt;*
  5396. </para>
  5397. </description>
  5398. </item>
  5399. <item>
  5400. <term>Send a message from the local machine to a remote machine</term>
  5401. <description>
  5402. <para>
  5403. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine | uninitialized&gt;
  5404. </para>
  5405. <para>
  5406. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;name of the remote machine&gt;
  5407. </para>
  5408. </description>
  5409. </item>
  5410. </list>
  5411. </para>
  5412. <para>
  5413. <b>Note :</b> security restrictions apply for sending
  5414. network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)"/>
  5415. for more information.
  5416. </para>
  5417. </remarks>
  5418. <example>
  5419. <para>
  5420. An example configuration section to log information
  5421. using this appender from the local machine, named
  5422. LOCAL_PC, to machine OPERATOR_PC :
  5423. </para>
  5424. <code lang="XML" escaped="true">
  5425. <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
  5426. <server value="LOCAL_PC"/>
  5427. <recipient value="OPERATOR_PC"/>
  5428. <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n"/>
  5429. </appender>
  5430. </code>
  5431. </example>
  5432. <author>Nicko Cadell</author>
  5433. <author>Gert Driesen</author>
  5434. </member>
  5435. <member name="F:log4net.Appender.NetSendAppender.m_server">
  5436. <summary>
  5437. The DNS or NetBIOS name of the server on which the function is to execute.
  5438. </summary>
  5439. </member>
  5440. <member name="F:log4net.Appender.NetSendAppender.m_sender">
  5441. <summary>
  5442. The sender of the network message.
  5443. </summary>
  5444. </member>
  5445. <member name="F:log4net.Appender.NetSendAppender.m_recipient">
  5446. <summary>
  5447. The message alias to which the message should be sent.
  5448. </summary>
  5449. </member>
  5450. <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
  5451. <summary>
  5452. The security context to use for privileged calls
  5453. </summary>
  5454. </member>
  5455. <member name="M:log4net.Appender.NetSendAppender.#ctor">
  5456. <summary>
  5457. Initializes the appender.
  5458. </summary>
  5459. <remarks>
  5460. The default constructor initializes all fields to their default values.
  5461. </remarks>
  5462. </member>
  5463. <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
  5464. <summary>
  5465. Initialize the appender based on the options set.
  5466. </summary>
  5467. <remarks>
  5468. <para>
  5469. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5470. activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
  5471. be called on this object after the configuration properties have
  5472. been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
  5473. object is in an undefined state and must not be used.
  5474. </para>
  5475. <para>
  5476. If any of the configuration properties are modified then
  5477. <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
  5478. </para>
  5479. <para>
  5480. The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was specified.
  5481. </para>
  5482. </remarks>
  5483. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> was not specified.</exception>
  5484. </member>
  5485. <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
  5486. <summary>
  5487. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5488. </summary>
  5489. <param name="loggingEvent">The event to log.</param>
  5490. <remarks>
  5491. <para>
  5492. Sends the event using a network message.
  5493. </para>
  5494. </remarks>
  5495. </member>
  5496. <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
  5497. <summary>
  5498. Sends a buffer of information to a registered message alias.
  5499. </summary>
  5500. <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
  5501. <param name="msgName">The message alias to which the message buffer should be sent</param>
  5502. <param name="fromName">The originator of the message.</param>
  5503. <param name="buffer">The message text.</param>
  5504. <param name="bufferSize">The length, in bytes, of the message text.</param>
  5505. <remarks>
  5506. <para>
  5507. The following restrictions apply for sending network messages:
  5508. </para>
  5509. <para>
  5510. <list type="table">
  5511. <listheader>
  5512. <term>Platform</term>
  5513. <description>Requirements</description>
  5514. </listheader>
  5515. <item>
  5516. <term>Windows NT</term>
  5517. <description>
  5518. <para>
  5519. No special group membership is required to send a network message.
  5520. </para>
  5521. <para>
  5522. Admin, Accounts, Print, or Server Operator group membership is required to
  5523. successfully send a network message on a remote server.
  5524. </para>
  5525. </description>
  5526. </item>
  5527. <item>
  5528. <term>Windows 2000 or later</term>
  5529. <description>
  5530. <para>
  5531. If you send a message on a domain controller that is running Active Directory,
  5532. access is allowed or denied based on the access control list (ACL) for the securable
  5533. object. The default ACL permits only Domain Admins and Account Operators to send a network message.
  5534. </para>
  5535. <para>
  5536. On a member server or workstation, only Administrators and Server Operators can send a network message.
  5537. </para>
  5538. </description>
  5539. </item>
  5540. </list>
  5541. </para>
  5542. <para>
  5543. For more information see <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/security_requirements_for_the_network_management_functions.asp">Security Requirements for the Network Management Functions</a>.
  5544. </para>
  5545. </remarks>
  5546. <returns>
  5547. <para>
  5548. If the function succeeds, the return value is zero.
  5549. </para>
  5550. </returns>
  5551. </member>
  5552. <member name="P:log4net.Appender.NetSendAppender.Sender">
  5553. <summary>
  5554. Gets or sets the sender of the message.
  5555. </summary>
  5556. <value>
  5557. The sender of the message.
  5558. </value>
  5559. <remarks>
  5560. If this property is not specified, the message is sent from the local computer.
  5561. </remarks>
  5562. </member>
  5563. <member name="P:log4net.Appender.NetSendAppender.Recipient">
  5564. <summary>
  5565. Gets or sets the message alias to which the message should be sent.
  5566. </summary>
  5567. <value>
  5568. The recipient of the message.
  5569. </value>
  5570. <remarks>
  5571. This property should always be specified in order to send a message.
  5572. </remarks>
  5573. </member>
  5574. <member name="P:log4net.Appender.NetSendAppender.Server">
  5575. <summary>
  5576. Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
  5577. </summary>
  5578. <value>
  5579. DNS or NetBIOS name of the remote server on which the function is to execute.
  5580. </value>
  5581. <remarks>
  5582. <para>
  5583. For Windows NT 4.0 and earlier, the string should begin with \\.
  5584. </para>
  5585. <para>
  5586. If this property is not specified, the local computer is used.
  5587. </para>
  5588. </remarks>
  5589. </member>
  5590. <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
  5591. <summary>
  5592. Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5593. </summary>
  5594. <value>
  5595. The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  5596. </value>
  5597. <remarks>
  5598. <para>
  5599. Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
  5600. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  5601. security context to use. The default behavior is to use the security context
  5602. of the current thread.
  5603. </para>
  5604. </remarks>
  5605. </member>
  5606. <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
  5607. <summary>
  5608. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5609. </summary>
  5610. <value><c>true</c></value>
  5611. <remarks>
  5612. <para>
  5613. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5614. </para>
  5615. </remarks>
  5616. </member>
  5617. <member name="T:log4net.Appender.OutputDebugStringAppender">
  5618. <summary>
  5619. Appends log events to the OutputDebugString system.
  5620. </summary>
  5621. <remarks>
  5622. <para>
  5623. OutputDebugStringAppender appends log events to the
  5624. OutputDebugString system.
  5625. </para>
  5626. <para>
  5627. The string is passed to the native <c>OutputDebugString</c>
  5628. function.
  5629. </para>
  5630. </remarks>
  5631. <author>Nicko Cadell</author>
  5632. <author>Gert Driesen</author>
  5633. </member>
  5634. <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
  5635. <summary>
  5636. Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender"/> class.
  5637. </summary>
  5638. <remarks>
  5639. <para>
  5640. Default constructor.
  5641. </para>
  5642. </remarks>
  5643. </member>
  5644. <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
  5645. <summary>
  5646. Write the logging event to the output debug string API
  5647. </summary>
  5648. <param name="loggingEvent">the event to log</param>
  5649. <remarks>
  5650. <para>
  5651. Write the logging event to the output debug string API
  5652. </para>
  5653. </remarks>
  5654. </member>
  5655. <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
  5656. <summary>
  5657. Stub for OutputDebugString native method
  5658. </summary>
  5659. <param name="message">the string to output</param>
  5660. <remarks>
  5661. <para>
  5662. Stub for OutputDebugString native method
  5663. </para>
  5664. </remarks>
  5665. </member>
  5666. <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
  5667. <summary>
  5668. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5669. </summary>
  5670. <value><c>true</c></value>
  5671. <remarks>
  5672. <para>
  5673. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  5674. </para>
  5675. </remarks>
  5676. </member>
  5677. <member name="T:log4net.Appender.RemoteSyslogAppender">
  5678. <summary>
  5679. Logs events to a remote syslog daemon.
  5680. </summary>
  5681. <remarks>
  5682. <para>
  5683. The BSD syslog protocol is used to remotely log to
  5684. a syslog daemon. The syslogd listens for for messages
  5685. on UDP port 514.
  5686. </para>
  5687. <para>
  5688. The syslog UDP protocol is not authenticated. Most syslog daemons
  5689. do not accept remote log messages because of the security implications.
  5690. You may be able to use the LocalSyslogAppender to talk to a local
  5691. syslog service.
  5692. </para>
  5693. <para>
  5694. There is an RFC 3164 that claims to document the BSD Syslog Protocol.
  5695. This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
  5696. This appender generates what the RFC calls an "Original Device Message",
  5697. i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
  5698. this format of message will be accepted by all current syslog daemon
  5699. implementations. The daemon will attach the current time and the source
  5700. hostname or IP address to any messages received.
  5701. </para>
  5702. <para>
  5703. Syslog messages must have a facility and and a severity. The severity
  5704. is derived from the Level of the logging event.
  5705. The facility must be chosen from the set of defined syslog
  5706. <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  5707. and cannot be extended.
  5708. </para>
  5709. <para>
  5710. An identifier is specified with each log message. This can be specified
  5711. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  5712. as the tag) must not contain white space. The default value for the
  5713. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  5714. </para>
  5715. </remarks>
  5716. <author>Rob Lyon</author>
  5717. <author>Nicko Cadell</author>
  5718. </member>
  5719. <member name="T:log4net.Appender.UdpAppender">
  5720. <summary>
  5721. Sends logging events as connectionless UDP datagrams to a remote host or a
  5722. multicast group using an <see cref="T:System.Net.Sockets.UdpClient"/>.
  5723. </summary>
  5724. <remarks>
  5725. <para>
  5726. UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
  5727. </para>
  5728. <para>
  5729. To view the logging results, a custom application can be developed that listens for logging
  5730. events.
  5731. </para>
  5732. <para>
  5733. When decoding events send via this appender remember to use the same encoding
  5734. to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
  5735. property to specify the encoding to use.
  5736. </para>
  5737. </remarks>
  5738. <example>
  5739. This example shows how to log receive logging events that are sent
  5740. on IP address 244.0.0.1 and port 8080 to the console. The event is
  5741. encoded in the packet as a unicode string and it is decoded as such.
  5742. <code lang="C#">
  5743. IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
  5744. UdpClient udpClient;
  5745. byte[] buffer;
  5746. string loggingEvent;
  5747. try
  5748. {
  5749. udpClient = new UdpClient(8080);
  5750. while(true)
  5751. {
  5752. buffer = udpClient.Receive(ref remoteEndPoint);
  5753. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
  5754. Console.WriteLine(loggingEvent);
  5755. }
  5756. }
  5757. catch(Exception e)
  5758. {
  5759. Console.WriteLine(e.ToString());
  5760. }
  5761. </code>
  5762. <code lang="Visual Basic">
  5763. Dim remoteEndPoint as IPEndPoint
  5764. Dim udpClient as UdpClient
  5765. Dim buffer as Byte()
  5766. Dim loggingEvent as String
  5767. Try
  5768. remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
  5769. udpClient = new UdpClient(8080)
  5770. While True
  5771. buffer = udpClient.Receive(ByRef remoteEndPoint)
  5772. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
  5773. Console.WriteLine(loggingEvent)
  5774. Wend
  5775. Catch e As Exception
  5776. Console.WriteLine(e.ToString())
  5777. End Try
  5778. </code>
  5779. <para>
  5780. An example configuration section to log information using this appender to the
  5781. IP 224.0.0.1 on port 8080:
  5782. </para>
  5783. <code lang="XML" escaped="true">
  5784. <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
  5785. <remoteAddress value="224.0.0.1"/>
  5786. <remotePort value="8080"/>
  5787. <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline"/>
  5788. </appender>
  5789. </code>
  5790. </example>
  5791. <author>Gert Driesen</author>
  5792. <author>Nicko Cadell</author>
  5793. </member>
  5794. <member name="M:log4net.Appender.UdpAppender.#ctor">
  5795. <summary>
  5796. Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender"/> class.
  5797. </summary>
  5798. <remarks>
  5799. The default constructor initializes all fields to their default values.
  5800. </remarks>
  5801. </member>
  5802. <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
  5803. <summary>
  5804. Initialize the appender based on the options set.
  5805. </summary>
  5806. <remarks>
  5807. <para>
  5808. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5809. activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
  5810. be called on this object after the configuration properties have
  5811. been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
  5812. object is in an undefined state and must not be used.
  5813. </para>
  5814. <para>
  5815. If any of the configuration properties are modified then
  5816. <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
  5817. </para>
  5818. <para>
  5819. The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was specified or
  5820. an invalid remote or local TCP port number was specified.
  5821. </para>
  5822. </remarks>
  5823. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> was not specified.</exception>
  5824. <exception cref="T:System.ArgumentOutOfRangeException">The TCP port number assigned to <see cref="P:log4net.Appender.UdpAppender.LocalPort"/> or <see cref="P:log4net.Appender.UdpAppender.RemotePort"/> is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  5825. </member>
  5826. <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
  5827. <summary>
  5828. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  5829. </summary>
  5830. <param name="loggingEvent">The event to log.</param>
  5831. <remarks>
  5832. <para>
  5833. Sends the event using an UDP datagram.
  5834. </para>
  5835. <para>
  5836. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  5837. </para>
  5838. </remarks>
  5839. </member>
  5840. <member name="M:log4net.Appender.UdpAppender.OnClose">
  5841. <summary>
  5842. Closes the UDP connection and releases all resources associated with
  5843. this <see cref="T:log4net.Appender.UdpAppender"/> instance.
  5844. </summary>
  5845. <remarks>
  5846. <para>
  5847. Disables the underlying <see cref="T:System.Net.Sockets.UdpClient"/> and releases all managed
  5848. and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender"/>.
  5849. </para>
  5850. </remarks>
  5851. </member>
  5852. <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
  5853. <summary>
  5854. Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient"/> connection.
  5855. </summary>
  5856. <remarks>
  5857. <para>
  5858. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
  5859. port number from which you intend to communicate.
  5860. </para>
  5861. <para>
  5862. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  5863. </para>
  5864. </remarks>
  5865. </member>
  5866. <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
  5867. <summary>
  5868. The IP address of the remote host or multicast group to which
  5869. the logging event will be sent.
  5870. </summary>
  5871. </member>
  5872. <member name="F:log4net.Appender.UdpAppender.m_remotePort">
  5873. <summary>
  5874. The TCP port number of the remote host or multicast group to
  5875. which the logging event will be sent.
  5876. </summary>
  5877. </member>
  5878. <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
  5879. <summary>
  5880. The cached remote endpoint to which the logging events will be sent.
  5881. </summary>
  5882. </member>
  5883. <member name="F:log4net.Appender.UdpAppender.m_localPort">
  5884. <summary>
  5885. The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  5886. </summary>
  5887. </member>
  5888. <member name="F:log4net.Appender.UdpAppender.m_client">
  5889. <summary>
  5890. The <see cref="T:System.Net.Sockets.UdpClient"/> instance that will be used for sending the
  5891. logging events.
  5892. </summary>
  5893. </member>
  5894. <member name="F:log4net.Appender.UdpAppender.m_encoding">
  5895. <summary>
  5896. The encoding to use for the packet.
  5897. </summary>
  5898. </member>
  5899. <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
  5900. <summary>
  5901. Gets or sets the IP address of the remote host or multicast group to which
  5902. the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
  5903. </summary>
  5904. <value>
  5905. The IP address of the remote host or multicast group to which the logging event
  5906. will be sent.
  5907. </value>
  5908. <remarks>
  5909. <para>
  5910. Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
  5911. 239.255.255.255). Multicast packets can pass across different networks through routers, so
  5912. it is possible to use multicasts in an Internet scenario as long as your network provider
  5913. supports multicasting.
  5914. </para>
  5915. <para>
  5916. Hosts that want to receive particular multicast messages must register their interest by joining
  5917. the multicast group. Multicast messages are not sent to networks where no host has joined
  5918. the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
  5919. them from normal host addresses, allowing nodes to easily detect if a message is of interest.
  5920. </para>
  5921. <para>
  5922. Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
  5923. </para>
  5924. <para>
  5925. <list type="table">
  5926. <listheader>
  5927. <term>IP Address</term>
  5928. <description>Description</description>
  5929. </listheader>
  5930. <item>
  5931. <term>224.0.0.1</term>
  5932. <description>
  5933. <para>
  5934. Sends a message to all system on the subnet.
  5935. </para>
  5936. </description>
  5937. </item>
  5938. <item>
  5939. <term>224.0.0.2</term>
  5940. <description>
  5941. <para>
  5942. Sends a message to all routers on the subnet.
  5943. </para>
  5944. </description>
  5945. </item>
  5946. <item>
  5947. <term>224.0.0.12</term>
  5948. <description>
  5949. <para>
  5950. The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
  5951. </para>
  5952. </description>
  5953. </item>
  5954. </list>
  5955. </para>
  5956. <para>
  5957. A complete list of actually reserved multicast addresses and their owners in the ranges
  5958. defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
  5959. </para>
  5960. <para>
  5961. The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
  5962. addresses. These addresses can be reused with other local groups. Routers are typically
  5963. configured with filters to prevent multicast traffic in this range from flowing outside
  5964. of the local network.
  5965. </para>
  5966. </remarks>
  5967. </member>
  5968. <member name="P:log4net.Appender.UdpAppender.RemotePort">
  5969. <summary>
  5970. Gets or sets the TCP port number of the remote host or multicast group to which
  5971. the underlying <see cref="T:System.Net.Sockets.UdpClient"/> should sent the logging event.
  5972. </summary>
  5973. <value>
  5974. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  5975. indicating the TCP port number of the remote host or multicast group to which the logging event
  5976. will be sent.
  5977. </value>
  5978. <remarks>
  5979. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will send messages to this TCP port number
  5980. on the remote host or multicast group.
  5981. </remarks>
  5982. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  5983. </member>
  5984. <member name="P:log4net.Appender.UdpAppender.LocalPort">
  5985. <summary>
  5986. Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  5987. </summary>
  5988. <value>
  5989. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  5990. indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient"/> will communicate.
  5991. </value>
  5992. <remarks>
  5993. <para>
  5994. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> will bind to this port for sending messages.
  5995. </para>
  5996. <para>
  5997. Setting the value to 0 (the default) will cause the udp client not to bind to
  5998. a local port.
  5999. </para>
  6000. </remarks>
  6001. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/> or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  6002. </member>
  6003. <member name="P:log4net.Appender.UdpAppender.Encoding">
  6004. <summary>
  6005. Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6006. </summary>
  6007. <value>
  6008. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6009. </value>
  6010. <remarks>
  6011. <para>
  6012. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6013. </para>
  6014. </remarks>
  6015. </member>
  6016. <member name="P:log4net.Appender.UdpAppender.Client">
  6017. <summary>
  6018. Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
  6019. </summary>
  6020. <value>
  6021. The underlying <see cref="T:System.Net.Sockets.UdpClient"/>.
  6022. </value>
  6023. <remarks>
  6024. <see cref="T:log4net.Appender.UdpAppender"/> creates a <see cref="T:System.Net.Sockets.UdpClient"/> to send logging events
  6025. over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender"/> can use this
  6026. property to get or set this <see cref="T:System.Net.Sockets.UdpClient"/>. Use the underlying <see cref="T:System.Net.Sockets.UdpClient"/>
  6027. returned from <see cref="P:log4net.Appender.UdpAppender.Client"/> if you require access beyond that which
  6028. <see cref="T:log4net.Appender.UdpAppender"/> provides.
  6029. </remarks>
  6030. </member>
  6031. <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
  6032. <summary>
  6033. Gets or sets the cached remote endpoint to which the logging events should be sent.
  6034. </summary>
  6035. <value>
  6036. The cached remote endpoint to which the logging events will be sent.
  6037. </value>
  6038. <remarks>
  6039. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method will initialize the remote endpoint
  6040. with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress"/> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
  6041. properties.
  6042. </remarks>
  6043. </member>
  6044. <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
  6045. <summary>
  6046. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6047. </summary>
  6048. <value><c>true</c></value>
  6049. <remarks>
  6050. <para>
  6051. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6052. </para>
  6053. </remarks>
  6054. </member>
  6055. <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
  6056. <summary>
  6057. Syslog port 514
  6058. </summary>
  6059. </member>
  6060. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
  6061. <summary>
  6062. Initial buffer size
  6063. </summary>
  6064. </member>
  6065. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
  6066. <summary>
  6067. Maximum buffer size before it is recycled
  6068. </summary>
  6069. </member>
  6070. <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
  6071. <summary>
  6072. Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class.
  6073. </summary>
  6074. <remarks>
  6075. This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> class is set up to write
  6076. to a remote syslog daemon.
  6077. </remarks>
  6078. </member>
  6079. <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
  6080. <summary>
  6081. Add a mapping of level to severity
  6082. </summary>
  6083. <param name="mapping">The mapping to add</param>
  6084. <remarks>
  6085. <para>
  6086. Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
  6087. </para>
  6088. </remarks>
  6089. </member>
  6090. <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
  6091. <summary>
  6092. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  6093. </summary>
  6094. <param name="loggingEvent">The event to log.</param>
  6095. <remarks>
  6096. <para>
  6097. Writes the event to a remote syslog daemon.
  6098. </para>
  6099. <para>
  6100. The format of the output will depend on the appender's layout.
  6101. </para>
  6102. </remarks>
  6103. </member>
  6104. <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
  6105. <summary>
  6106. Initialize the options for this appender
  6107. </summary>
  6108. <remarks>
  6109. <para>
  6110. Initialize the level to syslog severity mappings set on this appender.
  6111. </para>
  6112. </remarks>
  6113. </member>
  6114. <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
  6115. <summary>
  6116. Translates a log4net level to a syslog severity.
  6117. </summary>
  6118. <param name="level">A log4net level.</param>
  6119. <returns>A syslog severity.</returns>
  6120. <remarks>
  6121. <para>
  6122. Translates a log4net level to a syslog severity.
  6123. </para>
  6124. </remarks>
  6125. </member>
  6126. <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
  6127. <summary>
  6128. Generate a syslog priority.
  6129. </summary>
  6130. <param name="facility">The syslog facility.</param>
  6131. <param name="severity">The syslog severity.</param>
  6132. <returns>A syslog priority.</returns>
  6133. <remarks>
  6134. <para>
  6135. Generate a syslog priority.
  6136. </para>
  6137. </remarks>
  6138. </member>
  6139. <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
  6140. <summary>
  6141. The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  6142. </summary>
  6143. </member>
  6144. <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
  6145. <summary>
  6146. The message identity
  6147. </summary>
  6148. </member>
  6149. <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
  6150. <summary>
  6151. Mapping from level object to syslog severity
  6152. </summary>
  6153. </member>
  6154. <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
  6155. <summary>
  6156. Message identity
  6157. </summary>
  6158. <remarks>
  6159. <para>
  6160. An identifier is specified with each log message. This can be specified
  6161. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  6162. as the tag) must not contain white space. The default value for the
  6163. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  6164. </para>
  6165. </remarks>
  6166. </member>
  6167. <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
  6168. <summary>
  6169. Syslog facility
  6170. </summary>
  6171. <remarks>
  6172. Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
  6173. facilities is predefined and cannot be extended. The default value
  6174. is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  6175. </remarks>
  6176. </member>
  6177. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
  6178. <summary>
  6179. syslog severities
  6180. </summary>
  6181. <remarks>
  6182. <para>
  6183. The syslog severities.
  6184. </para>
  6185. </remarks>
  6186. </member>
  6187. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
  6188. <summary>
  6189. system is unusable
  6190. </summary>
  6191. </member>
  6192. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
  6193. <summary>
  6194. action must be taken immediately
  6195. </summary>
  6196. </member>
  6197. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
  6198. <summary>
  6199. critical conditions
  6200. </summary>
  6201. </member>
  6202. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
  6203. <summary>
  6204. error conditions
  6205. </summary>
  6206. </member>
  6207. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
  6208. <summary>
  6209. warning conditions
  6210. </summary>
  6211. </member>
  6212. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
  6213. <summary>
  6214. normal but significant condition
  6215. </summary>
  6216. </member>
  6217. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
  6218. <summary>
  6219. informational
  6220. </summary>
  6221. </member>
  6222. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
  6223. <summary>
  6224. debug-level messages
  6225. </summary>
  6226. </member>
  6227. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
  6228. <summary>
  6229. syslog facilities
  6230. </summary>
  6231. <remarks>
  6232. <para>
  6233. The syslog facilities
  6234. </para>
  6235. </remarks>
  6236. </member>
  6237. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
  6238. <summary>
  6239. kernel messages
  6240. </summary>
  6241. </member>
  6242. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
  6243. <summary>
  6244. random user-level messages
  6245. </summary>
  6246. </member>
  6247. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
  6248. <summary>
  6249. mail system
  6250. </summary>
  6251. </member>
  6252. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
  6253. <summary>
  6254. system daemons
  6255. </summary>
  6256. </member>
  6257. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
  6258. <summary>
  6259. security/authorization messages
  6260. </summary>
  6261. </member>
  6262. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
  6263. <summary>
  6264. messages generated internally by syslogd
  6265. </summary>
  6266. </member>
  6267. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
  6268. <summary>
  6269. line printer subsystem
  6270. </summary>
  6271. </member>
  6272. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
  6273. <summary>
  6274. network news subsystem
  6275. </summary>
  6276. </member>
  6277. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
  6278. <summary>
  6279. UUCP subsystem
  6280. </summary>
  6281. </member>
  6282. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
  6283. <summary>
  6284. clock (cron/at) daemon
  6285. </summary>
  6286. </member>
  6287. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
  6288. <summary>
  6289. security/authorization messages (private)
  6290. </summary>
  6291. </member>
  6292. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
  6293. <summary>
  6294. ftp daemon
  6295. </summary>
  6296. </member>
  6297. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
  6298. <summary>
  6299. NTP subsystem
  6300. </summary>
  6301. </member>
  6302. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
  6303. <summary>
  6304. log audit
  6305. </summary>
  6306. </member>
  6307. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
  6308. <summary>
  6309. log alert
  6310. </summary>
  6311. </member>
  6312. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
  6313. <summary>
  6314. clock daemon
  6315. </summary>
  6316. </member>
  6317. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
  6318. <summary>
  6319. reserved for local use
  6320. </summary>
  6321. </member>
  6322. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
  6323. <summary>
  6324. reserved for local use
  6325. </summary>
  6326. </member>
  6327. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
  6328. <summary>
  6329. reserved for local use
  6330. </summary>
  6331. </member>
  6332. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
  6333. <summary>
  6334. reserved for local use
  6335. </summary>
  6336. </member>
  6337. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
  6338. <summary>
  6339. reserved for local use
  6340. </summary>
  6341. </member>
  6342. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
  6343. <summary>
  6344. reserved for local use
  6345. </summary>
  6346. </member>
  6347. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
  6348. <summary>
  6349. reserved for local use
  6350. </summary>
  6351. </member>
  6352. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
  6353. <summary>
  6354. reserved for local use
  6355. </summary>
  6356. </member>
  6357. <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
  6358. <summary>
  6359. A class to act as a mapping between the level that a logging call is made at and
  6360. the syslog severity that is should be logged at.
  6361. </summary>
  6362. <remarks>
  6363. <para>
  6364. A class to act as a mapping between the level that a logging call is made at and
  6365. the syslog severity that is should be logged at.
  6366. </para>
  6367. </remarks>
  6368. </member>
  6369. <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
  6370. <summary>
  6371. The mapped syslog severity for the specified level
  6372. </summary>
  6373. <remarks>
  6374. <para>
  6375. Required property.
  6376. The mapped syslog severity for the specified level
  6377. </para>
  6378. </remarks>
  6379. </member>
  6380. <member name="T:log4net.Appender.RemotingAppender">
  6381. <summary>
  6382. Delivers logging events to a remote logging sink.
  6383. </summary>
  6384. <remarks>
  6385. <para>
  6386. This Appender is designed to deliver events to a remote sink.
  6387. That is any object that implements the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6388. interface. It delivers the events using .NET remoting. The
  6389. object to deliver events to is specified by setting the
  6390. appenders <see cref="P:log4net.Appender.RemotingAppender.Sink"/> property.</para>
  6391. <para>
  6392. The RemotingAppender buffers events before sending them. This allows it to
  6393. make more efficient use of the remoting infrastructure.</para>
  6394. <para>
  6395. Once the buffer is full the events are still not sent immediately.
  6396. They are scheduled to be sent using a pool thread. The effect is that
  6397. the send occurs asynchronously. This is very important for a
  6398. number of non obvious reasons. The remoting infrastructure will
  6399. flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  6400. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  6401. remoting boundary. If the server is not contactable then
  6402. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  6403. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  6404. having side effects on the calling application the remoting call must be made
  6405. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  6406. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  6407. the events will block in the thread pool manager until a thread is available.</para>
  6408. <para>
  6409. Because the events are sent asynchronously using pool threads it is possible to close
  6410. this appender before all the queued events have been sent.
  6411. When closing the appender attempts to wait until all the queued events have been sent, but
  6412. this will timeout after 30 seconds regardless.</para>
  6413. <para>
  6414. If this appender is being closed because the <see cref="F:System.AppDomain.ProcessExit"/>
  6415. event has fired it may not be possible to send all the queued events. During process
  6416. exit the runtime limits the time that a <see cref="F:System.AppDomain.ProcessExit"/>
  6417. event handler is allowed to run for. If the runtime terminates the threads before
  6418. the queued events have been sent then they will be lost. To ensure that all events
  6419. are sent the appender must be closed before the application exits. See
  6420. <see cref="M:log4net.Core.LoggerManager.Shutdown"/> for details on how to shutdown
  6421. log4net programmatically.</para>
  6422. </remarks>
  6423. <seealso cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6424. <author>Nicko Cadell</author>
  6425. <author>Gert Driesen</author>
  6426. <author>Daniel Cazzulino</author>
  6427. </member>
  6428. <member name="M:log4net.Appender.RemotingAppender.#ctor">
  6429. <summary>
  6430. Initializes a new instance of the <see cref="T:log4net.Appender.RemotingAppender"/> class.
  6431. </summary>
  6432. <remarks>
  6433. <para>
  6434. Default constructor.
  6435. </para>
  6436. </remarks>
  6437. </member>
  6438. <member name="M:log4net.Appender.RemotingAppender.ActivateOptions">
  6439. <summary>
  6440. Initialize the appender based on the options set
  6441. </summary>
  6442. <remarks>
  6443. <para>
  6444. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6445. activation scheme. The <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> method must
  6446. be called on this object after the configuration properties have
  6447. been set. Until <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> is called this
  6448. object is in an undefined state and must not be used.
  6449. </para>
  6450. <para>
  6451. If any of the configuration properties are modified then
  6452. <see cref="M:log4net.Appender.RemotingAppender.ActivateOptions"/> must be called again.
  6453. </para>
  6454. </remarks>
  6455. </member>
  6456. <member name="M:log4net.Appender.RemotingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  6457. <summary>
  6458. Send the contents of the buffer to the remote sink.
  6459. </summary>
  6460. <remarks>
  6461. The events are not sent immediately. They are scheduled to be sent
  6462. using a pool thread. The effect is that the send occurs asynchronously.
  6463. This is very important for a number of non obvious reasons. The remoting
  6464. infrastructure will flow thread local variables (stored in the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>),
  6465. if they are marked as <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>, across the
  6466. remoting boundary. If the server is not contactable then
  6467. the remoting infrastructure will clear the <see cref="T:System.Runtime.Remoting.Messaging.ILogicalThreadAffinative"/>
  6468. objects from the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/>. To prevent a logging failure from
  6469. having side effects on the calling application the remoting call must be made
  6470. from a separate thread to the one used by the application. A <see cref="T:System.Threading.ThreadPool"/>
  6471. thread is used for this. If no <see cref="T:System.Threading.ThreadPool"/> thread is available then
  6472. the events will block in the thread pool manager until a thread is available.
  6473. </remarks>
  6474. <param name="events">The events to send.</param>
  6475. </member>
  6476. <member name="M:log4net.Appender.RemotingAppender.OnClose">
  6477. <summary>
  6478. Override base class close.
  6479. </summary>
  6480. <remarks>
  6481. <para>
  6482. This method waits while there are queued work items. The events are
  6483. sent asynchronously using <see cref="T:System.Threading.ThreadPool"/> work items. These items
  6484. will be sent once a thread pool thread is available to send them, therefore
  6485. it is possible to close the appender before all the queued events have been
  6486. sent.</para>
  6487. <para>
  6488. This method attempts to wait until all the queued events have been sent, but this
  6489. method will timeout after 30 seconds regardless.</para>
  6490. <para>
  6491. If the appender is being closed because the <see cref="F:System.AppDomain.ProcessExit"/>
  6492. event has fired it may not be possible to send all the queued events. During process
  6493. exit the runtime limits the time that a <see cref="F:System.AppDomain.ProcessExit"/>
  6494. event handler is allowed to run for.</para>
  6495. </remarks>
  6496. </member>
  6497. <member name="M:log4net.Appender.RemotingAppender.BeginAsyncSend">
  6498. <summary>
  6499. A work item is being queued into the thread pool
  6500. </summary>
  6501. </member>
  6502. <member name="M:log4net.Appender.RemotingAppender.EndAsyncSend">
  6503. <summary>
  6504. A work item from the thread pool has completed
  6505. </summary>
  6506. </member>
  6507. <member name="M:log4net.Appender.RemotingAppender.SendBufferCallback(System.Object)">
  6508. <summary>
  6509. Send the contents of the buffer to the remote sink.
  6510. </summary>
  6511. <remarks>
  6512. This method is designed to be used with the <see cref="T:System.Threading.ThreadPool"/>.
  6513. This method expects to be passed an array of <see cref="T:log4net.Core.LoggingEvent"/>
  6514. objects in the state param.
  6515. </remarks>
  6516. <param name="state">the logging events to send</param>
  6517. </member>
  6518. <member name="F:log4net.Appender.RemotingAppender.m_sinkUrl">
  6519. <summary>
  6520. The URL of the remote sink.
  6521. </summary>
  6522. </member>
  6523. <member name="F:log4net.Appender.RemotingAppender.m_sinkObj">
  6524. <summary>
  6525. The local proxy (.NET remoting) for the remote logging sink.
  6526. </summary>
  6527. </member>
  6528. <member name="F:log4net.Appender.RemotingAppender.m_queuedCallbackCount">
  6529. <summary>
  6530. The number of queued callbacks currently waiting or executing
  6531. </summary>
  6532. </member>
  6533. <member name="F:log4net.Appender.RemotingAppender.m_workQueueEmptyEvent">
  6534. <summary>
  6535. Event used to signal when there are no queued work items
  6536. </summary>
  6537. <remarks>
  6538. This event is set when there are no queued work items. In this
  6539. state it is safe to close the appender.
  6540. </remarks>
  6541. </member>
  6542. <member name="P:log4net.Appender.RemotingAppender.Sink">
  6543. <summary>
  6544. Gets or sets the URL of the well-known object that will accept
  6545. the logging events.
  6546. </summary>
  6547. <value>
  6548. The well-known URL of the remote sink.
  6549. </value>
  6550. <remarks>
  6551. <para>
  6552. The URL of the remoting sink that will accept logging events.
  6553. The sink must implement the <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  6554. interface.
  6555. </para>
  6556. </remarks>
  6557. </member>
  6558. <member name="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink">
  6559. <summary>
  6560. Interface used to deliver <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  6561. </summary>
  6562. <remarks>
  6563. This interface must be implemented by a remoting sink
  6564. if the <see cref="T:log4net.Appender.RemotingAppender"/> is to be used
  6565. to deliver logging events to the sink.
  6566. </remarks>
  6567. </member>
  6568. <member name="M:log4net.Appender.RemotingAppender.IRemoteLoggingSink.LogEvents(log4net.Core.LoggingEvent[])">
  6569. <summary>
  6570. Delivers logging events to the remote sink
  6571. </summary>
  6572. <param name="events">Array of events to log.</param>
  6573. <remarks>
  6574. <para>
  6575. Delivers logging events to the remote sink
  6576. </para>
  6577. </remarks>
  6578. </member>
  6579. <member name="T:log4net.Appender.RollingFileAppender">
  6580. <summary>
  6581. Appender that rolls log files based on size or date or both.
  6582. </summary>
  6583. <remarks>
  6584. <para>
  6585. RollingFileAppender can roll log files based on size or date or both
  6586. depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
  6587. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
  6588. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6589. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
  6590. once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  6591. is crossed.
  6592. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
  6593. rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  6594. is crossed, but within a date boundary the file will also be rolled
  6595. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  6596. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
  6597. the appender is configured. This effectively means that the log file can be
  6598. rolled once per program execution.
  6599. </para>
  6600. <para>
  6601. A of few additional optional features have been added:
  6602. <list type="bullet">
  6603. <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
  6604. <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
  6605. <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
  6606. </list>
  6607. </para>
  6608. <note>
  6609. <para>
  6610. For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
  6611. greater than zero is highly recommended, otherwise all the backup files need
  6612. to be renamed each time a new backup is created.
  6613. </para>
  6614. <para>
  6615. When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6616. to <see langword="true"/> will reduce the number of file renamings to few or none.
  6617. </para>
  6618. </note>
  6619. <note type="caution">
  6620. <para>
  6621. Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
  6622. the log file directory of backup files will cause unexpected and unwanted side effects.
  6623. </para>
  6624. </note>
  6625. <para>
  6626. If Date/Time based rolling is enabled this appender will attempt to roll existing files
  6627. in the directory without a Date/Time tag based on the last write date of the base log file.
  6628. The appender only rolls the log file when a message is logged. If Date/Time based rolling
  6629. is enabled then the appender will not roll the log file at the Date/Time boundary but
  6630. at the point when the next message is logged after the boundary has been crossed.
  6631. </para>
  6632. <para>
  6633. The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
  6634. has the same behavior when opening the log file.
  6635. The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
  6636. is called. This will typically be during configuration.
  6637. If the file cannot be opened for writing the appender will attempt
  6638. to open the file again each time a message is logged to the appender.
  6639. If the file cannot be opened for writing when a message is logged then
  6640. the message will be discarded by this appender.
  6641. </para>
  6642. <para>
  6643. When rolling a backup file necessitates deleting an older backup file the
  6644. file to be deleted is moved to a temporary name before being deleted.
  6645. </para>
  6646. <note type="caution">
  6647. <para>
  6648. A maximum number of backup files when rolling on date/time boundaries is not supported.
  6649. </para>
  6650. </note>
  6651. </remarks>
  6652. <author>Nicko Cadell</author>
  6653. <author>Gert Driesen</author>
  6654. <author>Aspi Havewala</author>
  6655. <author>Douglas de la Torre</author>
  6656. <author>Edward Smit</author>
  6657. </member>
  6658. <member name="M:log4net.Appender.RollingFileAppender.#ctor">
  6659. <summary>
  6660. Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender"/> class.
  6661. </summary>
  6662. <remarks>
  6663. <para>
  6664. Default constructor.
  6665. </para>
  6666. </remarks>
  6667. </member>
  6668. <member name="F:log4net.Appender.RollingFileAppender.declaringType">
  6669. <summary>
  6670. The fully qualified type of the RollingFileAppender class.
  6671. </summary>
  6672. <remarks>
  6673. Used by the internal logger to record the Type of the
  6674. log message.
  6675. </remarks>
  6676. </member>
  6677. <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
  6678. <summary>
  6679. Sets the quiet writer being used.
  6680. </summary>
  6681. <remarks>
  6682. This method can be overridden by sub classes.
  6683. </remarks>
  6684. <param name="writer">the writer to set</param>
  6685. </member>
  6686. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
  6687. <summary>
  6688. Write out a logging event.
  6689. </summary>
  6690. <param name="loggingEvent">the event to write to file.</param>
  6691. <remarks>
  6692. <para>
  6693. Handles append time behavior for RollingFileAppender. This checks
  6694. if a roll over either by date (checked first) or time (checked second)
  6695. is need and then appends to the file last.
  6696. </para>
  6697. </remarks>
  6698. </member>
  6699. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
  6700. <summary>
  6701. Write out an array of logging events.
  6702. </summary>
  6703. <param name="loggingEvents">the events to write to file.</param>
  6704. <remarks>
  6705. <para>
  6706. Handles append time behavior for RollingFileAppender. This checks
  6707. if a roll over either by date (checked first) or time (checked second)
  6708. is need and then appends to the file last.
  6709. </para>
  6710. </remarks>
  6711. </member>
  6712. <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
  6713. <summary>
  6714. Performs any required rolling before outputting the next event
  6715. </summary>
  6716. <remarks>
  6717. <para>
  6718. Handles append time behavior for RollingFileAppender. This checks
  6719. if a roll over either by date (checked first) or time (checked second)
  6720. is need and then appends to the file last.
  6721. </para>
  6722. </remarks>
  6723. </member>
  6724. <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
  6725. <summary>
  6726. Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  6727. is false then the fully qualified name is determined and used.
  6728. </summary>
  6729. <param name="fileName">the name of the file to open</param>
  6730. <param name="append">true to append to existing file</param>
  6731. <remarks>
  6732. <para>This method will ensure that the directory structure
  6733. for the <paramref name="fileName"/> specified exists.</para>
  6734. </remarks>
  6735. </member>
  6736. <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
  6737. <summary>
  6738. Get the current output file name
  6739. </summary>
  6740. <param name="fileName">the base file name</param>
  6741. <returns>the output file name</returns>
  6742. <remarks>
  6743. The output file name is based on the base fileName specified.
  6744. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
  6745. file name is the same as the base file passed in. Otherwise
  6746. the output file depends on the date pattern, on the count
  6747. direction or both.
  6748. </remarks>
  6749. </member>
  6750. <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
  6751. <summary>
  6752. Determines curSizeRollBackups (only within the current roll point)
  6753. </summary>
  6754. </member>
  6755. <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
  6756. <summary>
  6757. Generates a wildcard pattern that can be used to find all files
  6758. that are similar to the base file name.
  6759. </summary>
  6760. <param name="baseFileName"></param>
  6761. <returns></returns>
  6762. </member>
  6763. <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
  6764. <summary>
  6765. Builds a list of filenames for all files matching the base filename plus a file
  6766. pattern.
  6767. </summary>
  6768. <param name="baseFilePath"></param>
  6769. <returns></returns>
  6770. </member>
  6771. <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
  6772. <summary>
  6773. Initiates a roll over if needed for crossing a date boundary since the last run.
  6774. </summary>
  6775. </member>
  6776. <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
  6777. <summary>
  6778. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  6779. </summary>
  6780. <remarks>
  6781. <para>
  6782. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  6783. The following is done
  6784. <list type="bullet">
  6785. <item>determine curSizeRollBackups (only within the current roll point)</item>
  6786. <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
  6787. </list>
  6788. </para>
  6789. </remarks>
  6790. </member>
  6791. <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
  6792. <summary>
  6793. Does the work of bumping the 'current' file counter higher
  6794. to the highest count when an incremental file name is seen.
  6795. The highest count is either the first file (when count direction
  6796. is greater than 0) or the last file (when count direction less than 0).
  6797. In either case, we want to know the highest count that is present.
  6798. </summary>
  6799. <param name="baseFile"></param>
  6800. <param name="curFileName"></param>
  6801. </member>
  6802. <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
  6803. <summary>
  6804. Attempts to extract a number from the end of the file name that indicates
  6805. the number of the times the file has been rolled over.
  6806. </summary>
  6807. <remarks>
  6808. Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
  6809. </remarks>
  6810. <param name="curFileName"></param>
  6811. <returns></returns>
  6812. </member>
  6813. <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
  6814. <summary>
  6815. Takes a list of files and a base file name, and looks for
  6816. 'incremented' versions of the base file. Bumps the max
  6817. count up to the highest count seen.
  6818. </summary>
  6819. <param name="baseFile"></param>
  6820. <param name="arrayFiles"></param>
  6821. </member>
  6822. <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
  6823. <summary>
  6824. Calculates the RollPoint for the datePattern supplied.
  6825. </summary>
  6826. <param name="datePattern">the date pattern to calculate the check period for</param>
  6827. <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
  6828. <remarks>
  6829. Essentially the date pattern is examined to determine what the
  6830. most suitable roll point is. The roll point chosen is the roll point
  6831. with the smallest period that can be detected using the date pattern
  6832. supplied. i.e. if the date pattern only outputs the year, month, day
  6833. and hour then the smallest roll point that can be detected would be
  6834. and hourly roll point as minutes could not be detected.
  6835. </remarks>
  6836. </member>
  6837. <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
  6838. <summary>
  6839. Initialize the appender based on the options set
  6840. </summary>
  6841. <remarks>
  6842. <para>
  6843. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6844. activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
  6845. be called on this object after the configuration properties have
  6846. been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
  6847. object is in an undefined state and must not be used.
  6848. </para>
  6849. <para>
  6850. If any of the configuration properties are modified then
  6851. <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
  6852. </para>
  6853. <para>
  6854. Sets initial conditions including date/time roll over information, first check,
  6855. scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
  6856. the current number of backups.
  6857. </para>
  6858. </remarks>
  6859. </member>
  6860. <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
  6861. <summary>
  6862. </summary>
  6863. <param name="path1"></param>
  6864. <param name="path2">.1, .2, .3, etc.</param>
  6865. <returns></returns>
  6866. </member>
  6867. <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
  6868. <summary>
  6869. Rollover the file(s) to date/time tagged file(s).
  6870. </summary>
  6871. <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
  6872. <remarks>
  6873. <para>
  6874. Rollover the file(s) to date/time tagged file(s).
  6875. Resets curSizeRollBackups.
  6876. If fileIsOpen is set then the new file is opened (through SafeOpenFile).
  6877. </para>
  6878. </remarks>
  6879. </member>
  6880. <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
  6881. <summary>
  6882. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
  6883. </summary>
  6884. <param name="fromFile">Name of existing file to roll.</param>
  6885. <param name="toFile">New name for file.</param>
  6886. <remarks>
  6887. <para>
  6888. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
  6889. also checks for existence of target file and deletes if it does.
  6890. </para>
  6891. </remarks>
  6892. </member>
  6893. <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
  6894. <summary>
  6895. Test if a file exists at a specified path
  6896. </summary>
  6897. <param name="path">the path to the file</param>
  6898. <returns>true if the file exists</returns>
  6899. <remarks>
  6900. <para>
  6901. Test if a file exists at a specified path
  6902. </para>
  6903. </remarks>
  6904. </member>
  6905. <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
  6906. <summary>
  6907. Deletes the specified file if it exists.
  6908. </summary>
  6909. <param name="fileName">The file to delete.</param>
  6910. <remarks>
  6911. <para>
  6912. Delete a file if is exists.
  6913. The file is first moved to a new filename then deleted.
  6914. This allows the file to be removed even when it cannot
  6915. be deleted, but it still can be moved.
  6916. </para>
  6917. </remarks>
  6918. </member>
  6919. <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
  6920. <summary>
  6921. Implements file roll base on file size.
  6922. </summary>
  6923. <remarks>
  6924. <para>
  6925. If the maximum number of size based backups is reached
  6926. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  6927. file is deleted -- its index determined by the sign of countDirection.
  6928. If <c>countDirection</c> &lt; 0, then files
  6929. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  6930. are renamed to {<c>File.2</c>, ...,
  6931. <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
  6932. renamed <c>File.1</c> and closed.
  6933. </para>
  6934. <para>
  6935. A new file is created to receive further log output.
  6936. </para>
  6937. <para>
  6938. If <c>maxSizeRollBackups</c> is equal to zero, then the
  6939. <c>File</c> is truncated with no backup files created.
  6940. </para>
  6941. <para>
  6942. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  6943. renamed if needed and no files are deleted.
  6944. </para>
  6945. </remarks>
  6946. </member>
  6947. <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
  6948. <summary>
  6949. Implements file roll.
  6950. </summary>
  6951. <param name="baseFileName">the base name to rename</param>
  6952. <remarks>
  6953. <para>
  6954. If the maximum number of size based backups is reached
  6955. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  6956. file is deleted -- its index determined by the sign of countDirection.
  6957. If <c>countDirection</c> &lt; 0, then files
  6958. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  6959. are renamed to {<c>File.2</c>, ...,
  6960. <c>File.curSizeRollBackups</c>}.
  6961. </para>
  6962. <para>
  6963. If <c>maxSizeRollBackups</c> is equal to zero, then the
  6964. <c>File</c> is truncated with no backup files created.
  6965. </para>
  6966. <para>
  6967. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  6968. renamed if needed and no files are deleted.
  6969. </para>
  6970. <para>
  6971. This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
  6972. </para>
  6973. </remarks>
  6974. </member>
  6975. <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
  6976. <summary>
  6977. Get the start time of the next window for the current rollpoint
  6978. </summary>
  6979. <param name="currentDateTime">the current date</param>
  6980. <param name="rollPoint">the type of roll point we are working with</param>
  6981. <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
  6982. <remarks>
  6983. <para>
  6984. Returns the date of the next roll point after the currentDateTime date passed to the method.
  6985. </para>
  6986. <para>
  6987. The basic strategy is to subtract the time parts that are less significant
  6988. than the rollpoint from the current time. This should roll the time back to
  6989. the start of the time window for the current rollpoint. Then we add 1 window
  6990. worth of time and get the start time of the next window for the rollpoint.
  6991. </para>
  6992. </remarks>
  6993. </member>
  6994. <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
  6995. <summary>
  6996. This object supplies the current date/time. Allows test code to plug in
  6997. a method to control this class when testing date/time based rolling. The default
  6998. implementation uses the underlying value of DateTime.Now.
  6999. </summary>
  7000. </member>
  7001. <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
  7002. <summary>
  7003. The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
  7004. meaning daily rollover.
  7005. </summary>
  7006. </member>
  7007. <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
  7008. <summary>
  7009. The actual formatted filename that is currently being written to
  7010. or will be the file transferred to on roll over
  7011. (based on staticLogFileName).
  7012. </summary>
  7013. </member>
  7014. <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
  7015. <summary>
  7016. The timestamp when we shall next recompute the filename.
  7017. </summary>
  7018. </member>
  7019. <member name="F:log4net.Appender.RollingFileAppender.m_now">
  7020. <summary>
  7021. Holds date of last roll over
  7022. </summary>
  7023. </member>
  7024. <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
  7025. <summary>
  7026. The type of rolling done
  7027. </summary>
  7028. </member>
  7029. <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
  7030. <summary>
  7031. The default maximum file size is 10MB
  7032. </summary>
  7033. </member>
  7034. <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
  7035. <summary>
  7036. There is zero backup files by default
  7037. </summary>
  7038. </member>
  7039. <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
  7040. <summary>
  7041. How many sized based backups have been made so far
  7042. </summary>
  7043. </member>
  7044. <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
  7045. <summary>
  7046. The rolling file count direction.
  7047. </summary>
  7048. </member>
  7049. <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
  7050. <summary>
  7051. The rolling mode used in this appender.
  7052. </summary>
  7053. </member>
  7054. <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
  7055. <summary>
  7056. Cache flag set if we are rolling by date.
  7057. </summary>
  7058. </member>
  7059. <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
  7060. <summary>
  7061. Cache flag set if we are rolling by size.
  7062. </summary>
  7063. </member>
  7064. <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
  7065. <summary>
  7066. Value indicating whether to always log to the same file.
  7067. </summary>
  7068. </member>
  7069. <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
  7070. <summary>
  7071. Value indicating whether to preserve the file name extension when rolling.
  7072. </summary>
  7073. </member>
  7074. <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
  7075. <summary>
  7076. FileName provided in configuration. Used for rolling properly
  7077. </summary>
  7078. </member>
  7079. <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
  7080. <summary>
  7081. The 1st of January 1970 in UTC
  7082. </summary>
  7083. </member>
  7084. <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
  7085. <summary>
  7086. Gets or sets the strategy for determining the current date and time. The default
  7087. implementation is to use LocalDateTime which internally calls through to DateTime.Now.
  7088. </summary>
  7089. <value>
  7090. An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
  7091. </value>
  7092. <remarks>
  7093. <para>
  7094. Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
  7095. </para>
  7096. <para>
  7097. The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
  7098. </para>
  7099. </remarks>
  7100. </member>
  7101. <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
  7102. <summary>
  7103. Gets or sets the date pattern to be used for generating file names
  7104. when rolling over on date.
  7105. </summary>
  7106. <value>
  7107. The date pattern to be used for generating file names when rolling
  7108. over on date.
  7109. </value>
  7110. <remarks>
  7111. <para>
  7112. Takes a string in the same format as expected by
  7113. <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/>.
  7114. </para>
  7115. <para>
  7116. This property determines the rollover schedule when rolling over
  7117. on date.
  7118. </para>
  7119. </remarks>
  7120. </member>
  7121. <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
  7122. <summary>
  7123. Gets or sets the maximum number of backup files that are kept before
  7124. the oldest is erased.
  7125. </summary>
  7126. <value>
  7127. The maximum number of backup files that are kept before the oldest is
  7128. erased.
  7129. </value>
  7130. <remarks>
  7131. <para>
  7132. If set to zero, then there will be no backup files and the log file
  7133. will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
  7134. </para>
  7135. <para>
  7136. If a negative number is supplied then no deletions will be made. Note
  7137. that this could result in very slow performance as a large number of
  7138. files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
  7139. </para>
  7140. <para>
  7141. The maximum applies to <b>each</b> time based group of files and
  7142. <b>not</b> the total.
  7143. </para>
  7144. </remarks>
  7145. </member>
  7146. <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
  7147. <summary>
  7148. Gets or sets the maximum size that the output file is allowed to reach
  7149. before being rolled over to backup files.
  7150. </summary>
  7151. <value>
  7152. The maximum size in bytes that the output file is allowed to reach before being
  7153. rolled over to backup files.
  7154. </value>
  7155. <remarks>
  7156. <para>
  7157. This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
  7158. that it is required for differentiating the setter taking a
  7159. <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
  7160. argument.
  7161. </para>
  7162. <para>
  7163. The default maximum file size is 10MB (10*1024*1024).
  7164. </para>
  7165. </remarks>
  7166. </member>
  7167. <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
  7168. <summary>
  7169. Gets or sets the maximum size that the output file is allowed to reach
  7170. before being rolled over to backup files.
  7171. </summary>
  7172. <value>
  7173. The maximum size that the output file is allowed to reach before being
  7174. rolled over to backup files.
  7175. </value>
  7176. <remarks>
  7177. <para>
  7178. This property allows you to specify the maximum size with the
  7179. suffixes "KB", "MB" or "GB" so that the size is interpreted being
  7180. expressed respectively in kilobytes, megabytes or gigabytes.
  7181. </para>
  7182. <para>
  7183. For example, the value "10KB" will be interpreted as 10240 bytes.
  7184. </para>
  7185. <para>
  7186. The default maximum file size is 10MB.
  7187. </para>
  7188. <para>
  7189. If you have the option to set the maximum file size programmatically
  7190. consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
  7191. allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
  7192. </para>
  7193. </remarks>
  7194. </member>
  7195. <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
  7196. <summary>
  7197. Gets or sets the rolling file count direction.
  7198. </summary>
  7199. <value>
  7200. The rolling file count direction.
  7201. </value>
  7202. <remarks>
  7203. <para>
  7204. Indicates if the current file is the lowest numbered file or the
  7205. highest numbered file.
  7206. </para>
  7207. <para>
  7208. By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &lt; 0),
  7209. i.e. log.1 is most recent, log.5 is the 5th backup, etc...
  7210. </para>
  7211. <para>
  7212. <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &gt;= 0 does the opposite i.e.
  7213. log.1 is the first backup made, log.5 is the 5th backup made, etc.
  7214. For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> &gt;= 0 to reduce
  7215. rollover costs.
  7216. </para>
  7217. <para>The default file count direction is -1.</para>
  7218. </remarks>
  7219. </member>
  7220. <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
  7221. <summary>
  7222. Gets or sets the rolling style.
  7223. </summary>
  7224. <value>The rolling style.</value>
  7225. <remarks>
  7226. <para>
  7227. The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/>.
  7228. </para>
  7229. <para>
  7230. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
  7231. <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
  7232. the appender would append to a single file rather than rolling
  7233. the file each time it is opened.
  7234. </para>
  7235. </remarks>
  7236. </member>
  7237. <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
  7238. <summary>
  7239. Gets or sets a value indicating whether to preserve the file name extension when rolling.
  7240. </summary>
  7241. <value>
  7242. <c>true</c> if the file name extension should be preserved.
  7243. </value>
  7244. <remarks>
  7245. <para>
  7246. By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
  7247. However, under Windows the new file name will loose any program associations as the
  7248. extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
  7249. file.curSizeRollBackup.log to maintain any program associations.
  7250. </para>
  7251. </remarks>
  7252. </member>
  7253. <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
  7254. <summary>
  7255. Gets or sets a value indicating whether to always log to
  7256. the same file.
  7257. </summary>
  7258. <value>
  7259. <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
  7260. </value>
  7261. <remarks>
  7262. <para>
  7263. By default file.log is always the current file. Optionally
  7264. file.log.yyyy-mm-dd for current formatted datePattern can by the currently
  7265. logging file (or file.log.curSizeRollBackup or even
  7266. file.log.yyyy-mm-dd.curSizeRollBackup).
  7267. </para>
  7268. <para>
  7269. This will make time based rollovers with a large number of backups
  7270. much faster as the appender it won't have to rename all the backups!
  7271. </para>
  7272. </remarks>
  7273. </member>
  7274. <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
  7275. <summary>
  7276. Style of rolling to use
  7277. </summary>
  7278. <remarks>
  7279. <para>
  7280. Style of rolling to use
  7281. </para>
  7282. </remarks>
  7283. </member>
  7284. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
  7285. <summary>
  7286. Roll files once per program execution
  7287. </summary>
  7288. <remarks>
  7289. <para>
  7290. Roll files once per program execution.
  7291. Well really once each time this appender is
  7292. configured.
  7293. </para>
  7294. <para>
  7295. Setting this option also sets <c>AppendToFile</c> to
  7296. <c>false</c> on the <c>RollingFileAppender</c>, otherwise
  7297. this appender would just be a normal file appender.
  7298. </para>
  7299. </remarks>
  7300. </member>
  7301. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
  7302. <summary>
  7303. Roll files based only on the size of the file
  7304. </summary>
  7305. </member>
  7306. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
  7307. <summary>
  7308. Roll files based only on the date
  7309. </summary>
  7310. </member>
  7311. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
  7312. <summary>
  7313. Roll files based on both the size and date of the file
  7314. </summary>
  7315. </member>
  7316. <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
  7317. <summary>
  7318. The code assumes that the following 'time' constants are in a increasing sequence.
  7319. </summary>
  7320. <remarks>
  7321. <para>
  7322. The code assumes that the following 'time' constants are in a increasing sequence.
  7323. </para>
  7324. </remarks>
  7325. </member>
  7326. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
  7327. <summary>
  7328. Roll the log not based on the date
  7329. </summary>
  7330. </member>
  7331. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
  7332. <summary>
  7333. Roll the log for each minute
  7334. </summary>
  7335. </member>
  7336. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
  7337. <summary>
  7338. Roll the log for each hour
  7339. </summary>
  7340. </member>
  7341. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
  7342. <summary>
  7343. Roll the log twice a day (midday and midnight)
  7344. </summary>
  7345. </member>
  7346. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
  7347. <summary>
  7348. Roll the log each day (midnight)
  7349. </summary>
  7350. </member>
  7351. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
  7352. <summary>
  7353. Roll the log each week
  7354. </summary>
  7355. </member>
  7356. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
  7357. <summary>
  7358. Roll the log each month
  7359. </summary>
  7360. </member>
  7361. <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
  7362. <summary>
  7363. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  7364. </summary>
  7365. <remarks>
  7366. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  7367. Used primarily to allow test classes to plug themselves in so they can
  7368. supply test date/times.
  7369. </remarks>
  7370. </member>
  7371. <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
  7372. <summary>
  7373. Gets the <i>current</i> time.
  7374. </summary>
  7375. <value>The <i>current</i> time.</value>
  7376. <remarks>
  7377. <para>
  7378. Gets the <i>current</i> time.
  7379. </para>
  7380. </remarks>
  7381. </member>
  7382. <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
  7383. <summary>
  7384. Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
  7385. </summary>
  7386. </member>
  7387. <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
  7388. <summary>
  7389. Gets the <b>current</b> time.
  7390. </summary>
  7391. <value>The <b>current</b> time.</value>
  7392. <remarks>
  7393. <para>
  7394. Gets the <b>current</b> time.
  7395. </para>
  7396. </remarks>
  7397. </member>
  7398. <member name="T:log4net.Appender.SmtpAppender">
  7399. <summary>
  7400. Send an e-mail when a specific logging event occurs, typically on errors
  7401. or fatal errors.
  7402. </summary>
  7403. <remarks>
  7404. <para>
  7405. The number of logging events delivered in this e-mail depend on
  7406. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  7407. <see cref="T:log4net.Appender.SmtpAppender"/> keeps only the last
  7408. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  7409. cyclic buffer. This keeps memory requirements at a reasonable level while
  7410. still delivering useful application context.
  7411. </para>
  7412. <note type="caution">
  7413. Authentication and setting the server Port are only available on the MS .NET 1.1 runtime.
  7414. For these features to be enabled you need to ensure that you are using a version of
  7415. the log4net assembly that is built against the MS .NET 1.1 framework and that you are
  7416. running the your application on the MS .NET 1.1 runtime. On all other platforms only sending
  7417. unauthenticated messages to a server listening on port 25 (the default) is supported.
  7418. </note>
  7419. <para>
  7420. Authentication is supported by setting the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property to
  7421. either <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> or <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7422. If using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> authentication then the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7423. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> properties must also be set.
  7424. </para>
  7425. <para>
  7426. To set the SMTP server port use the <see cref="P:log4net.Appender.SmtpAppender.Port"/> property. The default port is 25.
  7427. </para>
  7428. </remarks>
  7429. <author>Nicko Cadell</author>
  7430. <author>Gert Driesen</author>
  7431. </member>
  7432. <member name="M:log4net.Appender.SmtpAppender.#ctor">
  7433. <summary>
  7434. Default constructor
  7435. </summary>
  7436. <remarks>
  7437. <para>
  7438. Default constructor
  7439. </para>
  7440. </remarks>
  7441. </member>
  7442. <member name="M:log4net.Appender.SmtpAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7443. <summary>
  7444. Sends the contents of the cyclic buffer as an e-mail message.
  7445. </summary>
  7446. <param name="events">The logging events to send.</param>
  7447. </member>
  7448. <member name="M:log4net.Appender.SmtpAppender.SendEmail(System.String)">
  7449. <summary>
  7450. Send the email message
  7451. </summary>
  7452. <param name="messageBody">the body text to include in the mail</param>
  7453. </member>
  7454. <member name="P:log4net.Appender.SmtpAppender.To">
  7455. <summary>
  7456. Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions).
  7457. </summary>
  7458. <value>
  7459. <para>
  7460. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7461. </para>
  7462. <para>
  7463. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7464. </para>
  7465. </value>
  7466. <remarks>
  7467. <para>
  7468. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7469. </para>
  7470. <para>
  7471. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7472. </para>
  7473. </remarks>
  7474. </member>
  7475. <member name="P:log4net.Appender.SmtpAppender.Cc">
  7476. <summary>
  7477. Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses
  7478. that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions).
  7479. </summary>
  7480. <value>
  7481. <para>
  7482. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7483. </para>
  7484. <para>
  7485. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7486. </para>
  7487. </value>
  7488. <remarks>
  7489. <para>
  7490. For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses.
  7491. </para>
  7492. <para>
  7493. For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses.
  7494. </para>
  7495. </remarks>
  7496. </member>
  7497. <member name="P:log4net.Appender.SmtpAppender.Bcc">
  7498. <summary>
  7499. Gets or sets a semicolon-delimited list of recipient e-mail addresses
  7500. that will be blind carbon copied.
  7501. </summary>
  7502. <value>
  7503. A semicolon-delimited list of e-mail addresses.
  7504. </value>
  7505. <remarks>
  7506. <para>
  7507. A semicolon-delimited list of recipient e-mail addresses.
  7508. </para>
  7509. </remarks>
  7510. </member>
  7511. <member name="P:log4net.Appender.SmtpAppender.From">
  7512. <summary>
  7513. Gets or sets the e-mail address of the sender.
  7514. </summary>
  7515. <value>
  7516. The e-mail address of the sender.
  7517. </value>
  7518. <remarks>
  7519. <para>
  7520. The e-mail address of the sender.
  7521. </para>
  7522. </remarks>
  7523. </member>
  7524. <member name="P:log4net.Appender.SmtpAppender.Subject">
  7525. <summary>
  7526. Gets or sets the subject line of the e-mail message.
  7527. </summary>
  7528. <value>
  7529. The subject line of the e-mail message.
  7530. </value>
  7531. <remarks>
  7532. <para>
  7533. The subject line of the e-mail message.
  7534. </para>
  7535. </remarks>
  7536. </member>
  7537. <member name="P:log4net.Appender.SmtpAppender.SmtpHost">
  7538. <summary>
  7539. Gets or sets the name of the SMTP relay mail server to use to send
  7540. the e-mail messages.
  7541. </summary>
  7542. <value>
  7543. The name of the e-mail relay server. If SmtpServer is not set, the
  7544. name of the local SMTP server is used.
  7545. </value>
  7546. <remarks>
  7547. <para>
  7548. The name of the e-mail relay server. If SmtpServer is not set, the
  7549. name of the local SMTP server is used.
  7550. </para>
  7551. </remarks>
  7552. </member>
  7553. <member name="P:log4net.Appender.SmtpAppender.LocationInfo">
  7554. <summary>
  7555. Obsolete
  7556. </summary>
  7557. <remarks>
  7558. Use the BufferingAppenderSkeleton Fix methods instead
  7559. </remarks>
  7560. <remarks>
  7561. <para>
  7562. Obsolete property.
  7563. </para>
  7564. </remarks>
  7565. </member>
  7566. <member name="P:log4net.Appender.SmtpAppender.Authentication">
  7567. <summary>
  7568. The mode to use to authentication with the SMTP server
  7569. </summary>
  7570. <remarks>
  7571. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7572. <para>
  7573. Valid Authentication mode values are: <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>,
  7574. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>, and <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/>.
  7575. The default value is <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None"/>. When using
  7576. <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/> you must specify the <see cref="P:log4net.Appender.SmtpAppender.Username"/>
  7577. and <see cref="P:log4net.Appender.SmtpAppender.Password"/> to use to authenticate.
  7578. When using <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm"/> the Windows credentials for the current
  7579. thread, if impersonating, or the process will be used to authenticate.
  7580. </para>
  7581. </remarks>
  7582. </member>
  7583. <member name="P:log4net.Appender.SmtpAppender.Username">
  7584. <summary>
  7585. The username to use to authenticate with the SMTP server
  7586. </summary>
  7587. <remarks>
  7588. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7589. <para>
  7590. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7591. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7592. otherwise the username will be ignored.
  7593. </para>
  7594. </remarks>
  7595. </member>
  7596. <member name="P:log4net.Appender.SmtpAppender.Password">
  7597. <summary>
  7598. The password to use to authenticate with the SMTP server
  7599. </summary>
  7600. <remarks>
  7601. <note type="caution">Authentication is only available on the MS .NET 1.1 runtime.</note>
  7602. <para>
  7603. A <see cref="P:log4net.Appender.SmtpAppender.Username"/> and <see cref="P:log4net.Appender.SmtpAppender.Password"/> must be specified when
  7604. <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> is set to <see cref="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic"/>,
  7605. otherwise the password will be ignored.
  7606. </para>
  7607. </remarks>
  7608. </member>
  7609. <member name="P:log4net.Appender.SmtpAppender.Port">
  7610. <summary>
  7611. The port on which the SMTP server is listening
  7612. </summary>
  7613. <remarks>
  7614. <note type="caution">Server Port is only available on the MS .NET 1.1 runtime.</note>
  7615. <para>
  7616. The port on which the SMTP server is listening. The default
  7617. port is <c>25</c>. The Port can only be changed when running on
  7618. the MS .NET 1.1 runtime.
  7619. </para>
  7620. </remarks>
  7621. </member>
  7622. <member name="P:log4net.Appender.SmtpAppender.Priority">
  7623. <summary>
  7624. Gets or sets the priority of the e-mail message
  7625. </summary>
  7626. <value>
  7627. One of the <see cref="T:System.Web.Mail.MailPriority"/> values.
  7628. </value>
  7629. <remarks>
  7630. <para>
  7631. Sets the priority of the e-mails generated by this
  7632. appender. The default priority is <see cref="F:System.Web.Mail.MailPriority.Normal"/>.
  7633. </para>
  7634. <para>
  7635. If you are using this appender to report errors then
  7636. you may want to set the priority to <see cref="F:System.Web.Mail.MailPriority.High"/>.
  7637. </para>
  7638. </remarks>
  7639. </member>
  7640. <member name="P:log4net.Appender.SmtpAppender.SubjectEncoding">
  7641. <summary>
  7642. Gets or sets the subject encoding to be used.
  7643. </summary>
  7644. <remarks>
  7645. The default encoding is the operating system's current ANSI codepage.
  7646. </remarks>
  7647. </member>
  7648. <member name="P:log4net.Appender.SmtpAppender.BodyEncoding">
  7649. <summary>
  7650. Gets or sets the body encoding to be used.
  7651. </summary>
  7652. <remarks>
  7653. The default encoding is the operating system's current ANSI codepage.
  7654. </remarks>
  7655. </member>
  7656. <member name="P:log4net.Appender.SmtpAppender.RequiresLayout">
  7657. <summary>
  7658. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7659. </summary>
  7660. <value><c>true</c></value>
  7661. <remarks>
  7662. <para>
  7663. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7664. </para>
  7665. </remarks>
  7666. </member>
  7667. <member name="T:log4net.Appender.SmtpAppender.SmtpAuthentication">
  7668. <summary>
  7669. Values for the <see cref="P:log4net.Appender.SmtpAppender.Authentication"/> property.
  7670. </summary>
  7671. <remarks>
  7672. <para>
  7673. SMTP authentication modes.
  7674. </para>
  7675. </remarks>
  7676. </member>
  7677. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.None">
  7678. <summary>
  7679. No authentication
  7680. </summary>
  7681. </member>
  7682. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Basic">
  7683. <summary>
  7684. Basic authentication.
  7685. </summary>
  7686. <remarks>
  7687. Requires a username and password to be supplied
  7688. </remarks>
  7689. </member>
  7690. <member name="F:log4net.Appender.SmtpAppender.SmtpAuthentication.Ntlm">
  7691. <summary>
  7692. Integrated authentication
  7693. </summary>
  7694. <remarks>
  7695. Uses the Windows credentials from the current thread or process to authenticate.
  7696. </remarks>
  7697. </member>
  7698. <member name="T:log4net.Appender.SmtpPickupDirAppender">
  7699. <summary>
  7700. Send an email when a specific logging event occurs, typically on errors
  7701. or fatal errors. Rather than sending via smtp it writes a file into the
  7702. directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
  7703. as the IIS SMTP agent to manage sending the messages.
  7704. </summary>
  7705. <remarks>
  7706. <para>
  7707. The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
  7708. except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
  7709. <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
  7710. </para>
  7711. <para>
  7712. The number of logging events delivered in this e-mail depend on
  7713. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  7714. <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
  7715. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  7716. cyclic buffer. This keeps memory requirements at a reasonable level while
  7717. still delivering useful application context.
  7718. </para>
  7719. </remarks>
  7720. <author>Niall Daley</author>
  7721. <author>Nicko Cadell</author>
  7722. </member>
  7723. <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
  7724. <summary>
  7725. Default constructor
  7726. </summary>
  7727. <remarks>
  7728. <para>
  7729. Default constructor
  7730. </para>
  7731. </remarks>
  7732. </member>
  7733. <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  7734. <summary>
  7735. Sends the contents of the cyclic buffer as an e-mail message.
  7736. </summary>
  7737. <param name="events">The logging events to send.</param>
  7738. <remarks>
  7739. <para>
  7740. Sends the contents of the cyclic buffer as an e-mail message.
  7741. </para>
  7742. </remarks>
  7743. </member>
  7744. <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
  7745. <summary>
  7746. Activate the options on this appender.
  7747. </summary>
  7748. <remarks>
  7749. <para>
  7750. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7751. activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
  7752. be called on this object after the configuration properties have
  7753. been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
  7754. object is in an undefined state and must not be used.
  7755. </para>
  7756. <para>
  7757. If any of the configuration properties are modified then
  7758. <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
  7759. </para>
  7760. </remarks>
  7761. </member>
  7762. <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
  7763. <summary>
  7764. Convert a path into a fully qualified path.
  7765. </summary>
  7766. <param name="path">The path to convert.</param>
  7767. <returns>The fully qualified path.</returns>
  7768. <remarks>
  7769. <para>
  7770. Converts the path specified to a fully
  7771. qualified path. If the path is relative it is
  7772. taken as relative from the application base
  7773. directory.
  7774. </para>
  7775. </remarks>
  7776. </member>
  7777. <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
  7778. <summary>
  7779. The security context to use for privileged calls
  7780. </summary>
  7781. </member>
  7782. <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
  7783. <summary>
  7784. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  7785. </summary>
  7786. <value>
  7787. A semicolon-delimited list of e-mail addresses.
  7788. </value>
  7789. <remarks>
  7790. <para>
  7791. A semicolon-delimited list of e-mail addresses.
  7792. </para>
  7793. </remarks>
  7794. </member>
  7795. <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
  7796. <summary>
  7797. Gets or sets the e-mail address of the sender.
  7798. </summary>
  7799. <value>
  7800. The e-mail address of the sender.
  7801. </value>
  7802. <remarks>
  7803. <para>
  7804. The e-mail address of the sender.
  7805. </para>
  7806. </remarks>
  7807. </member>
  7808. <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
  7809. <summary>
  7810. Gets or sets the subject line of the e-mail message.
  7811. </summary>
  7812. <value>
  7813. The subject line of the e-mail message.
  7814. </value>
  7815. <remarks>
  7816. <para>
  7817. The subject line of the e-mail message.
  7818. </para>
  7819. </remarks>
  7820. </member>
  7821. <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
  7822. <summary>
  7823. Gets or sets the path to write the messages to.
  7824. </summary>
  7825. <remarks>
  7826. <para>
  7827. Gets or sets the path to write the messages to. This should be the same
  7828. as that used by the agent sending the messages.
  7829. </para>
  7830. </remarks>
  7831. </member>
  7832. <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
  7833. <summary>
  7834. Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  7835. </summary>
  7836. <value>
  7837. The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  7838. </value>
  7839. <remarks>
  7840. <para>
  7841. Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
  7842. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  7843. security context to use. The default behavior is to use the security context
  7844. of the current thread.
  7845. </para>
  7846. </remarks>
  7847. </member>
  7848. <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
  7849. <summary>
  7850. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7851. </summary>
  7852. <value><c>true</c></value>
  7853. <remarks>
  7854. <para>
  7855. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7856. </para>
  7857. </remarks>
  7858. </member>
  7859. <member name="T:log4net.Appender.TelnetAppender">
  7860. <summary>
  7861. Appender that allows clients to connect via Telnet to receive log messages
  7862. </summary>
  7863. <remarks>
  7864. <para>
  7865. The TelnetAppender accepts socket connections and streams logging messages
  7866. back to the client.
  7867. The output is provided in a telnet-friendly way so that a log can be monitored
  7868. over a TCP/IP socket.
  7869. This allows simple remote monitoring of application logging.
  7870. </para>
  7871. <para>
  7872. The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
  7873. </para>
  7874. </remarks>
  7875. <author>Keith Long</author>
  7876. <author>Nicko Cadell</author>
  7877. </member>
  7878. <member name="M:log4net.Appender.TelnetAppender.#ctor">
  7879. <summary>
  7880. Default constructor
  7881. </summary>
  7882. <remarks>
  7883. <para>
  7884. Default constructor
  7885. </para>
  7886. </remarks>
  7887. </member>
  7888. <member name="F:log4net.Appender.TelnetAppender.declaringType">
  7889. <summary>
  7890. The fully qualified type of the TelnetAppender class.
  7891. </summary>
  7892. <remarks>
  7893. Used by the internal logger to record the Type of the
  7894. log message.
  7895. </remarks>
  7896. </member>
  7897. <member name="M:log4net.Appender.TelnetAppender.OnClose">
  7898. <summary>
  7899. Overrides the parent method to close the socket handler
  7900. </summary>
  7901. <remarks>
  7902. <para>
  7903. Closes all the outstanding connections.
  7904. </para>
  7905. </remarks>
  7906. </member>
  7907. <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
  7908. <summary>
  7909. Initialize the appender based on the options set.
  7910. </summary>
  7911. <remarks>
  7912. <para>
  7913. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  7914. activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
  7915. be called on this object after the configuration properties have
  7916. been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
  7917. object is in an undefined state and must not be used.
  7918. </para>
  7919. <para>
  7920. If any of the configuration properties are modified then
  7921. <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
  7922. </para>
  7923. <para>
  7924. Create the socket handler and wait for connections
  7925. </para>
  7926. </remarks>
  7927. </member>
  7928. <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
  7929. <summary>
  7930. Writes the logging event to each connected client.
  7931. </summary>
  7932. <param name="loggingEvent">The event to log.</param>
  7933. <remarks>
  7934. <para>
  7935. Writes the logging event to each connected client.
  7936. </para>
  7937. </remarks>
  7938. </member>
  7939. <member name="P:log4net.Appender.TelnetAppender.Port">
  7940. <summary>
  7941. Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  7942. </summary>
  7943. <value>
  7944. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort"/> to <see cref="F:System.Net.IPEndPoint.MaxPort"/>
  7945. indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  7946. </value>
  7947. <remarks>
  7948. <para>
  7949. The default value is 23 (the telnet port).
  7950. </para>
  7951. </remarks>
  7952. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort"/>
  7953. or greater than <see cref="F:System.Net.IPEndPoint.MaxPort"/>.</exception>
  7954. </member>
  7955. <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
  7956. <summary>
  7957. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7958. </summary>
  7959. <value><c>true</c></value>
  7960. <remarks>
  7961. <para>
  7962. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  7963. </para>
  7964. </remarks>
  7965. </member>
  7966. <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
  7967. <summary>
  7968. Helper class to manage connected clients
  7969. </summary>
  7970. <remarks>
  7971. <para>
  7972. The SocketHandler class is used to accept connections from
  7973. clients. It is threaded so that clients can connect/disconnect
  7974. asynchronously.
  7975. </para>
  7976. </remarks>
  7977. </member>
  7978. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
  7979. <summary>
  7980. Opens a new server port on <paramref ref="port"/>
  7981. </summary>
  7982. <param name="port">the local port to listen on for connections</param>
  7983. <remarks>
  7984. <para>
  7985. Creates a socket handler on the specified local server port.
  7986. </para>
  7987. </remarks>
  7988. </member>
  7989. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
  7990. <summary>
  7991. Sends a string message to each of the connected clients
  7992. </summary>
  7993. <param name="message">the text to send</param>
  7994. <remarks>
  7995. <para>
  7996. Sends a string message to each of the connected clients
  7997. </para>
  7998. </remarks>
  7999. </member>
  8000. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  8001. <summary>
  8002. Add a client to the internal clients list
  8003. </summary>
  8004. <param name="client">client to add</param>
  8005. </member>
  8006. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  8007. <summary>
  8008. Remove a client from the internal clients list
  8009. </summary>
  8010. <param name="client">client to remove</param>
  8011. </member>
  8012. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.OnConnect(System.IAsyncResult)">
  8013. <summary>
  8014. Callback used to accept a connection on the server socket
  8015. </summary>
  8016. <param name="asyncResult">The result of the asynchronous operation</param>
  8017. <remarks>
  8018. <para>
  8019. On connection adds to the list of connections
  8020. if there are two many open connections you will be disconnected
  8021. </para>
  8022. </remarks>
  8023. </member>
  8024. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
  8025. <summary>
  8026. Close all network connections
  8027. </summary>
  8028. <remarks>
  8029. <para>
  8030. Make sure we close all network connections
  8031. </para>
  8032. </remarks>
  8033. </member>
  8034. <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
  8035. <summary>
  8036. Test if this handler has active connections
  8037. </summary>
  8038. <value>
  8039. <c>true</c> if this handler has active connections
  8040. </value>
  8041. <remarks>
  8042. <para>
  8043. This property will be <c>true</c> while this handler has
  8044. active connections, that is at least one connection that
  8045. the handler will attempt to send a message to.
  8046. </para>
  8047. </remarks>
  8048. </member>
  8049. <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
  8050. <summary>
  8051. Class that represents a client connected to this handler
  8052. </summary>
  8053. <remarks>
  8054. <para>
  8055. Class that represents a client connected to this handler
  8056. </para>
  8057. </remarks>
  8058. </member>
  8059. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
  8060. <summary>
  8061. Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
  8062. </summary>
  8063. <param name="socket">the client's socket</param>
  8064. <remarks>
  8065. <para>
  8066. Opens a stream writer on the socket.
  8067. </para>
  8068. </remarks>
  8069. </member>
  8070. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
  8071. <summary>
  8072. Write a string to the client
  8073. </summary>
  8074. <param name="message">string to send</param>
  8075. <remarks>
  8076. <para>
  8077. Write a string to the client
  8078. </para>
  8079. </remarks>
  8080. </member>
  8081. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
  8082. <summary>
  8083. Cleanup the clients connection
  8084. </summary>
  8085. <remarks>
  8086. <para>
  8087. Close the socket connection.
  8088. </para>
  8089. </remarks>
  8090. </member>
  8091. <member name="T:log4net.Appender.TraceAppender">
  8092. <summary>
  8093. Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
  8094. </summary>
  8095. <remarks>
  8096. <para>
  8097. The application configuration file can be used to control what listeners
  8098. are actually used. See the MSDN documentation for the
  8099. <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
  8100. trace system.
  8101. </para>
  8102. <para>
  8103. Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
  8104. method. The event's logger name is the default value for the category parameter
  8105. of the Write method.
  8106. </para>
  8107. <para>
  8108. <b>Compact Framework</b><br/>
  8109. The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
  8110. class for any operation except <c>Assert</c>. When using the Compact Framework this
  8111. appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
  8112. the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
  8113. </para>
  8114. </remarks>
  8115. <author>Douglas de la Torre</author>
  8116. <author>Nicko Cadell</author>
  8117. <author>Gert Driesen</author>
  8118. <author>Ron Grabowski</author>
  8119. </member>
  8120. <member name="M:log4net.Appender.TraceAppender.#ctor">
  8121. <summary>
  8122. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>.
  8123. </summary>
  8124. <remarks>
  8125. <para>
  8126. Default constructor.
  8127. </para>
  8128. </remarks>
  8129. </member>
  8130. <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
  8131. <summary>
  8132. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender"/>
  8133. with a specified layout.
  8134. </summary>
  8135. <param name="layout">The layout to use with this appender.</param>
  8136. <remarks>
  8137. <para>
  8138. Obsolete constructor.
  8139. </para>
  8140. </remarks>
  8141. </member>
  8142. <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
  8143. <summary>
  8144. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  8145. </summary>
  8146. <param name="loggingEvent">The event to log.</param>
  8147. <remarks>
  8148. <para>
  8149. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  8150. </para>
  8151. </remarks>
  8152. </member>
  8153. <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
  8154. <summary>
  8155. Immediate flush means that the underlying writer or output stream
  8156. will be flushed at the end of each append operation.
  8157. </summary>
  8158. <remarks>
  8159. <para>
  8160. Immediate flush is slower but ensures that each append request is
  8161. actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
  8162. <c>false</c>, then there is a good chance that the last few
  8163. logs events are not actually written to persistent media if and
  8164. when the application crashes.
  8165. </para>
  8166. <para>
  8167. The default value is <c>true</c>.</para>
  8168. </remarks>
  8169. </member>
  8170. <member name="F:log4net.Appender.TraceAppender.m_category">
  8171. <summary>
  8172. Defaults to %logger
  8173. </summary>
  8174. </member>
  8175. <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
  8176. <summary>
  8177. Gets or sets a value that indicates whether the appender will
  8178. flush at the end of each write.
  8179. </summary>
  8180. <remarks>
  8181. <para>The default behavior is to flush at the end of each
  8182. write. If the option is set to<c>false</c>, then the underlying
  8183. stream can defer writing to physical medium to a later time.
  8184. </para>
  8185. <para>
  8186. Avoiding the flush operation at the end of each append results
  8187. in a performance gain of 10 to 20 percent. However, there is safety
  8188. trade-off involved in skipping flushing. Indeed, when flushing is
  8189. skipped, then it is likely that the last few log events will not
  8190. be recorded on disk when the application exits. This is a high
  8191. price to pay even for a 20% performance gain.
  8192. </para>
  8193. </remarks>
  8194. </member>
  8195. <member name="P:log4net.Appender.TraceAppender.Category">
  8196. <summary>
  8197. The category parameter sent to the Trace method.
  8198. </summary>
  8199. <remarks>
  8200. <para>
  8201. Defaults to %logger which will use the logger name of the current
  8202. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  8203. </para>
  8204. <para>
  8205. </para>
  8206. </remarks>
  8207. </member>
  8208. <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
  8209. <summary>
  8210. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8211. </summary>
  8212. <value><c>true</c></value>
  8213. <remarks>
  8214. <para>
  8215. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  8216. </para>
  8217. </remarks>
  8218. </member>
  8219. <member name="T:log4net.Config.AliasDomainAttribute">
  8220. <summary>
  8221. Assembly level attribute that specifies a domain to alias to this assembly's repository.
  8222. </summary>
  8223. <remarks>
  8224. <para>
  8225. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8226. </para>
  8227. <para>
  8228. An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
  8229. however this can be overridden by an assembly loaded before the target assembly.
  8230. </para>
  8231. <para>
  8232. An assembly can alias another assembly's domain to its repository by
  8233. specifying this attribute with the name of the target domain.
  8234. </para>
  8235. <para>
  8236. This attribute can only be specified on the assembly and may be used
  8237. as many times as necessary to alias all the required domains.
  8238. </para>
  8239. </remarks>
  8240. <author>Nicko Cadell</author>
  8241. <author>Gert Driesen</author>
  8242. </member>
  8243. <member name="T:log4net.Config.AliasRepositoryAttribute">
  8244. <summary>
  8245. Assembly level attribute that specifies a repository to alias to this assembly's repository.
  8246. </summary>
  8247. <remarks>
  8248. <para>
  8249. An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
  8250. however this can be overridden by an assembly loaded before the target assembly.
  8251. </para>
  8252. <para>
  8253. An assembly can alias another assembly's repository to its repository by
  8254. specifying this attribute with the name of the target repository.
  8255. </para>
  8256. <para>
  8257. This attribute can only be specified on the assembly and may be used
  8258. as many times as necessary to alias all the required repositories.
  8259. </para>
  8260. </remarks>
  8261. <author>Nicko Cadell</author>
  8262. <author>Gert Driesen</author>
  8263. </member>
  8264. <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
  8265. <summary>
  8266. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
  8267. the specified repository to alias to this assembly's repository.
  8268. </summary>
  8269. <param name="name">The repository to alias to this assemby's repository.</param>
  8270. <remarks>
  8271. <para>
  8272. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute"/> class with
  8273. the specified repository to alias to this assembly's repository.
  8274. </para>
  8275. </remarks>
  8276. </member>
  8277. <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
  8278. <summary>
  8279. Gets or sets the repository to alias to this assemby's repository.
  8280. </summary>
  8281. <value>
  8282. The repository to alias to this assemby's repository.
  8283. </value>
  8284. <remarks>
  8285. <para>
  8286. The name of the repository to alias to this assemby's repository.
  8287. </para>
  8288. </remarks>
  8289. </member>
  8290. <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
  8291. <summary>
  8292. Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute"/> class with
  8293. the specified domain to alias to this assembly's repository.
  8294. </summary>
  8295. <param name="name">The domain to alias to this assemby's repository.</param>
  8296. <remarks>
  8297. <para>
  8298. Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
  8299. </para>
  8300. </remarks>
  8301. </member>
  8302. <member name="T:log4net.Config.BasicConfigurator">
  8303. <summary>
  8304. Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8305. </summary>
  8306. <remarks>
  8307. <para>
  8308. Allows very simple programmatic configuration of log4net.
  8309. </para>
  8310. <para>
  8311. Only one appender can be configured using this configurator.
  8312. The appender is set at the root of the hierarchy and all logging
  8313. events will be delivered to that appender.
  8314. </para>
  8315. <para>
  8316. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  8317. they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
  8318. be called after the appenders properties have been configured.
  8319. </para>
  8320. </remarks>
  8321. <author>Nicko Cadell</author>
  8322. <author>Gert Driesen</author>
  8323. </member>
  8324. <member name="F:log4net.Config.BasicConfigurator.declaringType">
  8325. <summary>
  8326. The fully qualified type of the BasicConfigurator class.
  8327. </summary>
  8328. <remarks>
  8329. Used by the internal logger to record the Type of the
  8330. log message.
  8331. </remarks>
  8332. </member>
  8333. <member name="M:log4net.Config.BasicConfigurator.#ctor">
  8334. <summary>
  8335. Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator"/> class.
  8336. </summary>
  8337. <remarks>
  8338. <para>
  8339. Uses a private access modifier to prevent instantiation of this class.
  8340. </para>
  8341. </remarks>
  8342. </member>
  8343. <member name="M:log4net.Config.BasicConfigurator.Configure">
  8344. <summary>
  8345. Initializes the log4net system with a default configuration.
  8346. </summary>
  8347. <remarks>
  8348. <para>
  8349. Initializes the log4net logging system using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8350. that will write to <c>Console.Out</c>. The log messages are
  8351. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8352. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8353. layout style.
  8354. </para>
  8355. </remarks>
  8356. </member>
  8357. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender)">
  8358. <summary>
  8359. Initializes the log4net system using the specified appender.
  8360. </summary>
  8361. <param name="appender">The appender to use to log all logging events.</param>
  8362. <remarks>
  8363. <para>
  8364. Initializes the log4net system using the specified appender.
  8365. </para>
  8366. </remarks>
  8367. </member>
  8368. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Appender.IAppender[])">
  8369. <summary>
  8370. Initializes the log4net system using the specified appenders.
  8371. </summary>
  8372. <param name="appenders">The appenders to use to log all logging events.</param>
  8373. <remarks>
  8374. <para>
  8375. Initializes the log4net system using the specified appenders.
  8376. </para>
  8377. </remarks>
  8378. </member>
  8379. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8380. <summary>
  8381. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
  8382. </summary>
  8383. <param name="repository">The repository to configure.</param>
  8384. <remarks>
  8385. <para>
  8386. Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  8387. that will write to <c>Console.Out</c>. The log messages are
  8388. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  8389. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  8390. layout style.
  8391. </para>
  8392. </remarks>
  8393. </member>
  8394. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
  8395. <summary>
  8396. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8397. </summary>
  8398. <param name="repository">The repository to configure.</param>
  8399. <param name="appender">The appender to use to log all logging events.</param>
  8400. <remarks>
  8401. <para>
  8402. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8403. </para>
  8404. </remarks>
  8405. </member>
  8406. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
  8407. <summary>
  8408. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
  8409. </summary>
  8410. <param name="repository">The repository to configure.</param>
  8411. <param name="appenders">The appenders to use to log all logging events.</param>
  8412. <remarks>
  8413. <para>
  8414. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  8415. </para>
  8416. </remarks>
  8417. </member>
  8418. <member name="T:log4net.Config.ConfiguratorAttribute">
  8419. <summary>
  8420. Base class for all log4net configuration attributes.
  8421. </summary>
  8422. <remarks>
  8423. This is an abstract class that must be extended by
  8424. specific configurators. This attribute allows the
  8425. configurator to be parameterized by an assembly level
  8426. attribute.
  8427. </remarks>
  8428. <author>Nicko Cadell</author>
  8429. <author>Gert Driesen</author>
  8430. </member>
  8431. <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
  8432. <summary>
  8433. Constructor used by subclasses.
  8434. </summary>
  8435. <param name="priority">the ordering priority for this configurator</param>
  8436. <remarks>
  8437. <para>
  8438. The <paramref name="priority"/> is used to order the configurator
  8439. attributes before they are invoked. Higher priority configurators are executed
  8440. before lower priority ones.
  8441. </para>
  8442. </remarks>
  8443. </member>
  8444. <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8445. <summary>
  8446. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8447. </summary>
  8448. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8449. <param name="targetRepository">The repository to configure.</param>
  8450. <remarks>
  8451. <para>
  8452. Abstract method implemented by a subclass. When this method is called
  8453. the subclass should configure the <paramref name="targetRepository"/>.
  8454. </para>
  8455. </remarks>
  8456. </member>
  8457. <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
  8458. <summary>
  8459. Compare this instance to another ConfiguratorAttribute
  8460. </summary>
  8461. <param name="obj">the object to compare to</param>
  8462. <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
  8463. <remarks>
  8464. <para>
  8465. Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
  8466. Sorts by priority in descending order. Objects with the same priority are
  8467. randomly ordered.
  8468. </para>
  8469. </remarks>
  8470. </member>
  8471. <member name="T:log4net.Config.DomainAttribute">
  8472. <summary>
  8473. Assembly level attribute that specifies the logging domain for the assembly.
  8474. </summary>
  8475. <remarks>
  8476. <para>
  8477. <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
  8478. </para>
  8479. <para>
  8480. Assemblies are mapped to logging domains. Each domain has its own
  8481. logging repository. This attribute specified on the assembly controls
  8482. the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8483. of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8484. specifies the type of the repository objects to create for the domain. If
  8485. this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
  8486. then the assembly will be part of the default shared logging domain.
  8487. </para>
  8488. <para>
  8489. This attribute can only be specified on the assembly and may only be used
  8490. once per assembly.
  8491. </para>
  8492. </remarks>
  8493. <author>Nicko Cadell</author>
  8494. <author>Gert Driesen</author>
  8495. </member>
  8496. <member name="T:log4net.Config.RepositoryAttribute">
  8497. <summary>
  8498. Assembly level attribute that specifies the logging repository for the assembly.
  8499. </summary>
  8500. <remarks>
  8501. <para>
  8502. Assemblies are mapped to logging repository. This attribute specified
  8503. on the assembly controls
  8504. the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  8505. of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  8506. specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
  8507. to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
  8508. is not specified then the assembly will be part of the default shared logging repository.
  8509. </para>
  8510. <para>
  8511. This attribute can only be specified on the assembly and may only be used
  8512. once per assembly.
  8513. </para>
  8514. </remarks>
  8515. <author>Nicko Cadell</author>
  8516. <author>Gert Driesen</author>
  8517. </member>
  8518. <member name="M:log4net.Config.RepositoryAttribute.#ctor">
  8519. <summary>
  8520. Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class.
  8521. </summary>
  8522. <remarks>
  8523. <para>
  8524. Default constructor.
  8525. </para>
  8526. </remarks>
  8527. </member>
  8528. <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
  8529. <summary>
  8530. Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute"/> class
  8531. with the name of the repository.
  8532. </summary>
  8533. <param name="name">The name of the repository.</param>
  8534. <remarks>
  8535. <para>
  8536. Initialize the attribute with the name for the assembly's repository.
  8537. </para>
  8538. </remarks>
  8539. </member>
  8540. <member name="P:log4net.Config.RepositoryAttribute.Name">
  8541. <summary>
  8542. Gets or sets the name of the logging repository.
  8543. </summary>
  8544. <value>
  8545. The string name to use as the name of the repository associated with this
  8546. assembly.
  8547. </value>
  8548. <remarks>
  8549. <para>
  8550. This value does not have to be unique. Several assemblies can share the
  8551. same repository. They will share the logging configuration of the repository.
  8552. </para>
  8553. </remarks>
  8554. </member>
  8555. <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
  8556. <summary>
  8557. Gets or sets the type of repository to create for this assembly.
  8558. </summary>
  8559. <value>
  8560. The type of repository to create for this assembly.
  8561. </value>
  8562. <remarks>
  8563. <para>
  8564. The type of the repository to create for the assembly.
  8565. The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
  8566. interface.
  8567. </para>
  8568. <para>
  8569. This will be the type of repository created when
  8570. the repository is created. If multiple assemblies reference the
  8571. same repository then the repository is only created once using the
  8572. <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/> of the first assembly to call into the
  8573. repository.
  8574. </para>
  8575. </remarks>
  8576. </member>
  8577. <member name="M:log4net.Config.DomainAttribute.#ctor">
  8578. <summary>
  8579. Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class.
  8580. </summary>
  8581. <remarks>
  8582. <para>
  8583. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8584. </para>
  8585. </remarks>
  8586. </member>
  8587. <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
  8588. <summary>
  8589. Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute"/> class
  8590. with the name of the domain.
  8591. </summary>
  8592. <param name="name">The name of the domain.</param>
  8593. <remarks>
  8594. <para>
  8595. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  8596. </para>
  8597. </remarks>
  8598. </member>
  8599. <member name="T:log4net.Config.DOMConfigurator">
  8600. <summary>
  8601. Use this class to initialize the log4net environment using an Xml tree.
  8602. </summary>
  8603. <remarks>
  8604. <para>
  8605. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8606. </para>
  8607. <para>
  8608. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  8609. </para>
  8610. </remarks>
  8611. <author>Nicko Cadell</author>
  8612. <author>Gert Driesen</author>
  8613. </member>
  8614. <member name="M:log4net.Config.DOMConfigurator.#ctor">
  8615. <summary>
  8616. Private constructor
  8617. </summary>
  8618. </member>
  8619. <member name="M:log4net.Config.DOMConfigurator.Configure">
  8620. <summary>
  8621. Automatically configures the log4net system based on the
  8622. application's configuration settings.
  8623. </summary>
  8624. <remarks>
  8625. <para>
  8626. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8627. </para>
  8628. Each application has a configuration file. This has the
  8629. same name as the application with '.config' appended.
  8630. This file is XML and calling this function prompts the
  8631. configurator to look in that file for a section called
  8632. <c>log4net</c> that contains the configuration data.
  8633. </remarks>
  8634. </member>
  8635. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  8636. <summary>
  8637. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  8638. stored in the application's configuration file.
  8639. </summary>
  8640. <remarks>
  8641. <para>
  8642. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8643. </para>
  8644. Each application has a configuration file. This has the
  8645. same name as the application with '.config' appended.
  8646. This file is XML and calling this function prompts the
  8647. configurator to look in that file for a section called
  8648. <c>log4net</c> that contains the configuration data.
  8649. </remarks>
  8650. <param name="repository">The repository to configure.</param>
  8651. </member>
  8652. <member name="M:log4net.Config.DOMConfigurator.Configure(System.Xml.XmlElement)">
  8653. <summary>
  8654. Configures log4net using a <c>log4net</c> element
  8655. </summary>
  8656. <remarks>
  8657. <para>
  8658. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8659. </para>
  8660. Loads the log4net configuration from the XML element
  8661. supplied as <paramref name="element"/>.
  8662. </remarks>
  8663. <param name="element">The element to parse.</param>
  8664. </member>
  8665. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  8666. <summary>
  8667. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  8668. element.
  8669. </summary>
  8670. <remarks>
  8671. <para>
  8672. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8673. </para>
  8674. Loads the log4net configuration from the XML element
  8675. supplied as <paramref name="element"/>.
  8676. </remarks>
  8677. <param name="repository">The repository to configure.</param>
  8678. <param name="element">The element to parse.</param>
  8679. </member>
  8680. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.FileInfo)">
  8681. <summary>
  8682. Configures log4net using the specified configuration file.
  8683. </summary>
  8684. <param name="configFile">The XML file to load the configuration from.</param>
  8685. <remarks>
  8686. <para>
  8687. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8688. </para>
  8689. <para>
  8690. The configuration file must be valid XML. It must contain
  8691. at least one element called <c>log4net</c> that holds
  8692. the log4net configuration data.
  8693. </para>
  8694. <para>
  8695. The log4net configuration file can possible be specified in the application's
  8696. configuration file (either <c>MyAppName.exe.config</c> for a
  8697. normal application on <c>Web.config</c> for an ASP.NET application).
  8698. </para>
  8699. <example>
  8700. The following example configures log4net using a configuration file, of which the
  8701. location is stored in the application's configuration file :
  8702. </example>
  8703. <code lang="C#">
  8704. using log4net.Config;
  8705. using System.IO;
  8706. using System.Configuration;
  8707. ...
  8708. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8709. </code>
  8710. <para>
  8711. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8712. </para>
  8713. <code lang="XML" escaped="true">
  8714. <configuration>
  8715. <appSettings>
  8716. <add key="log4net-config-file" value="log.config"/>
  8717. </appSettings>
  8718. </configuration>
  8719. </code>
  8720. </remarks>
  8721. </member>
  8722. <member name="M:log4net.Config.DOMConfigurator.Configure(System.IO.Stream)">
  8723. <summary>
  8724. Configures log4net using the specified configuration file.
  8725. </summary>
  8726. <param name="configStream">A stream to load the XML configuration from.</param>
  8727. <remarks>
  8728. <para>
  8729. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8730. </para>
  8731. <para>
  8732. The configuration data must be valid XML. It must contain
  8733. at least one element called <c>log4net</c> that holds
  8734. the log4net configuration data.
  8735. </para>
  8736. <para>
  8737. Note that this method will NOT close the stream parameter.
  8738. </para>
  8739. </remarks>
  8740. </member>
  8741. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8742. <summary>
  8743. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8744. file.
  8745. </summary>
  8746. <param name="repository">The repository to configure.</param>
  8747. <param name="configFile">The XML file to load the configuration from.</param>
  8748. <remarks>
  8749. <para>
  8750. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8751. </para>
  8752. <para>
  8753. The configuration file must be valid XML. It must contain
  8754. at least one element called <c>log4net</c> that holds
  8755. the configuration data.
  8756. </para>
  8757. <para>
  8758. The log4net configuration file can possible be specified in the application's
  8759. configuration file (either <c>MyAppName.exe.config</c> for a
  8760. normal application on <c>Web.config</c> for an ASP.NET application).
  8761. </para>
  8762. <example>
  8763. The following example configures log4net using a configuration file, of which the
  8764. location is stored in the application's configuration file :
  8765. </example>
  8766. <code lang="C#">
  8767. using log4net.Config;
  8768. using System.IO;
  8769. using System.Configuration;
  8770. ...
  8771. DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  8772. </code>
  8773. <para>
  8774. In the <c>.config</c> file, the path to the log4net can be specified like this :
  8775. </para>
  8776. <code lang="XML" escaped="true">
  8777. <configuration>
  8778. <appSettings>
  8779. <add key="log4net-config-file" value="log.config"/>
  8780. </appSettings>
  8781. </configuration>
  8782. </code>
  8783. </remarks>
  8784. </member>
  8785. <member name="M:log4net.Config.DOMConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  8786. <summary>
  8787. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  8788. file.
  8789. </summary>
  8790. <param name="repository">The repository to configure.</param>
  8791. <param name="configStream">The stream to load the XML configuration from.</param>
  8792. <remarks>
  8793. <para>
  8794. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8795. </para>
  8796. <para>
  8797. The configuration data must be valid XML. It must contain
  8798. at least one element called <c>log4net</c> that holds
  8799. the configuration data.
  8800. </para>
  8801. <para>
  8802. Note that this method will NOT close the stream parameter.
  8803. </para>
  8804. </remarks>
  8805. </member>
  8806. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  8807. <summary>
  8808. Configures log4net using the file specified, monitors the file for changes
  8809. and reloads the configuration if a change is detected.
  8810. </summary>
  8811. <param name="configFile">The XML file to load the configuration from.</param>
  8812. <remarks>
  8813. <para>
  8814. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8815. </para>
  8816. <para>
  8817. The configuration file must be valid XML. It must contain
  8818. at least one element called <c>log4net</c> that holds
  8819. the configuration data.
  8820. </para>
  8821. <para>
  8822. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  8823. and depends on the behavior of that class.
  8824. </para>
  8825. <para>
  8826. For more information on how to configure log4net using
  8827. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  8828. </para>
  8829. </remarks>
  8830. <seealso cref="M:Configure(FileInfo)"/>
  8831. </member>
  8832. <member name="M:log4net.Config.DOMConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8833. <summary>
  8834. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  8835. monitors the file for changes and reloads the configuration if a change
  8836. is detected.
  8837. </summary>
  8838. <param name="repository">The repository to configure.</param>
  8839. <param name="configFile">The XML file to load the configuration from.</param>
  8840. <remarks>
  8841. <para>
  8842. <b>DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator.</b>
  8843. </para>
  8844. <para>
  8845. The configuration file must be valid XML. It must contain
  8846. at least one element called <c>log4net</c> that holds
  8847. the configuration data.
  8848. </para>
  8849. <para>
  8850. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  8851. and depends on the behavior of that class.
  8852. </para>
  8853. <para>
  8854. For more information on how to configure log4net using
  8855. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  8856. </para>
  8857. </remarks>
  8858. <seealso cref="M:Configure(FileInfo)"/>
  8859. </member>
  8860. <member name="T:log4net.Config.DOMConfiguratorAttribute">
  8861. <summary>
  8862. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  8863. </summary>
  8864. <remarks>
  8865. <para>
  8866. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  8867. </para>
  8868. <para>
  8869. This attribute may only be used at the assembly scope and can only
  8870. be used once per assembly.
  8871. </para>
  8872. <para>
  8873. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  8874. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  8875. methods.
  8876. </para>
  8877. </remarks>
  8878. <author>Nicko Cadell</author>
  8879. <author>Gert Driesen</author>
  8880. </member>
  8881. <member name="T:log4net.Config.XmlConfiguratorAttribute">
  8882. <summary>
  8883. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  8884. </summary>
  8885. <remarks>
  8886. <para>
  8887. This attribute may only be used at the assembly scope and can only
  8888. be used once per assembly.
  8889. </para>
  8890. <para>
  8891. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  8892. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  8893. methods.
  8894. </para>
  8895. <para>
  8896. If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
  8897. properties are set the configuration is loaded from the application's .config file.
  8898. If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
  8899. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
  8900. specifies a path to a file to load the config from. The path is relative to the
  8901. application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  8902. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
  8903. The config file must be located in the application's base directory; <see cref="P:System.AppDomain.BaseDirectory"/>.
  8904. For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
  8905. <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
  8906. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
  8907. </para>
  8908. <para>
  8909. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
  8910. to watch the configuration file for changes.
  8911. </para>
  8912. <note>
  8913. <para>
  8914. Log4net will only look for assembly level configuration attributes once.
  8915. When using the log4net assembly level attributes to control the configuration
  8916. of log4net you must ensure that the first call to any of the
  8917. <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
  8918. attributes.
  8919. </para>
  8920. <para>
  8921. If you cannot guarantee the order in which log4net calls will be made from
  8922. different assemblies you must use programmatic configuration instead, i.e.
  8923. call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
  8924. </para>
  8925. </note>
  8926. </remarks>
  8927. <author>Nicko Cadell</author>
  8928. <author>Gert Driesen</author>
  8929. </member>
  8930. <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
  8931. <summary>
  8932. Default constructor
  8933. </summary>
  8934. <remarks>
  8935. <para>
  8936. Default constructor
  8937. </para>
  8938. </remarks>
  8939. </member>
  8940. <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8941. <summary>
  8942. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8943. </summary>
  8944. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8945. <param name="targetRepository">The repository to configure.</param>
  8946. <remarks>
  8947. <para>
  8948. Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
  8949. The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  8950. class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
  8951. configure it.
  8952. </para>
  8953. </remarks>
  8954. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository"/> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
  8955. </member>
  8956. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8957. <summary>
  8958. Attempt to load configuration from the local file system
  8959. </summary>
  8960. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8961. <param name="targetRepository">The repository to configure.</param>
  8962. </member>
  8963. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8964. <summary>
  8965. Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
  8966. </summary>
  8967. <param name="targetRepository">The repository to configure.</param>
  8968. <param name="configFile">the FileInfo pointing to the config file</param>
  8969. </member>
  8970. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8971. <summary>
  8972. Attempt to load configuration from a URI
  8973. </summary>
  8974. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8975. <param name="targetRepository">The repository to configure.</param>
  8976. </member>
  8977. <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
  8978. <summary>
  8979. The fully qualified type of the XmlConfiguratorAttribute class.
  8980. </summary>
  8981. <remarks>
  8982. Used by the internal logger to record the Type of the
  8983. log message.
  8984. </remarks>
  8985. </member>
  8986. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
  8987. <summary>
  8988. Gets or sets the filename of the configuration file.
  8989. </summary>
  8990. <value>
  8991. The filename of the configuration file.
  8992. </value>
  8993. <remarks>
  8994. <para>
  8995. If specified, this is the name of the configuration file to use with
  8996. the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
  8997. <b>application base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>).
  8998. </para>
  8999. <para>
  9000. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9001. </para>
  9002. </remarks>
  9003. </member>
  9004. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
  9005. <summary>
  9006. Gets or sets the extension of the configuration file.
  9007. </summary>
  9008. <value>
  9009. The extension of the configuration file.
  9010. </value>
  9011. <remarks>
  9012. <para>
  9013. If specified this is the extension for the configuration file.
  9014. The path to the config file is built by using the <b>application
  9015. base</b> directory (<see cref="P:System.AppDomain.BaseDirectory"/>),
  9016. the <b>assembly file name</b> and the config file extension.
  9017. </para>
  9018. <para>
  9019. If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
  9020. possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
  9021. <c>MyClassLibrary.dll.MyExt</c>.
  9022. </para>
  9023. <para>
  9024. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  9025. </para>
  9026. </remarks>
  9027. </member>
  9028. <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
  9029. <summary>
  9030. Gets or sets a value indicating whether to watch the configuration file.
  9031. </summary>
  9032. <value>
  9033. <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
  9034. </value>
  9035. <remarks>
  9036. <para>
  9037. If this flag is specified and set to <c>true</c> then the framework
  9038. will watch the configuration file and will reload the config each time
  9039. the file is modified.
  9040. </para>
  9041. <para>
  9042. The config file can only be watched if it is loaded from local disk.
  9043. In a No-Touch (Smart Client) deployment where the application is downloaded
  9044. from a web server the config file may not reside on the local disk
  9045. and therefore it may not be able to watch it.
  9046. </para>
  9047. <note>
  9048. Watching configuration is not supported on the SSCLI.
  9049. </note>
  9050. </remarks>
  9051. </member>
  9052. <member name="T:log4net.Config.Log4NetConfigurationSectionHandler">
  9053. <summary>
  9054. Class to register for the log4net section of the configuration file
  9055. </summary>
  9056. <remarks>
  9057. The log4net section of the configuration file needs to have a section
  9058. handler registered. This is the section handler used. It simply returns
  9059. the XML element that is the root of the section.
  9060. </remarks>
  9061. <example>
  9062. Example of registering the log4net section handler :
  9063. <code lang="XML" escaped="true">
  9064. <configuration>
  9065. <configSections>
  9066. <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  9067. </configSections>
  9068. <log4net>
  9069. log4net configuration XML goes here
  9070. </log4net>
  9071. </configuration>
  9072. </code>
  9073. </example>
  9074. <author>Nicko Cadell</author>
  9075. <author>Gert Driesen</author>
  9076. </member>
  9077. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.#ctor">
  9078. <summary>
  9079. Initializes a new instance of the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> class.
  9080. </summary>
  9081. <remarks>
  9082. <para>
  9083. Default constructor.
  9084. </para>
  9085. </remarks>
  9086. </member>
  9087. <member name="M:log4net.Config.Log4NetConfigurationSectionHandler.Create(System.Object,System.Object,System.Xml.XmlNode)">
  9088. <summary>
  9089. Parses the configuration section.
  9090. </summary>
  9091. <param name="parent">The configuration settings in a corresponding parent configuration section.</param>
  9092. <param name="configContext">The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference.</param>
  9093. <param name="section">The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</param>
  9094. <returns>The <see cref="T:System.Xml.XmlNode"/> for the log4net section.</returns>
  9095. <remarks>
  9096. <para>
  9097. Returns the <see cref="T:System.Xml.XmlNode"/> containing the configuration data,
  9098. </para>
  9099. </remarks>
  9100. </member>
  9101. <member name="T:log4net.Config.PluginAttribute">
  9102. <summary>
  9103. Assembly level attribute that specifies a plugin to attach to
  9104. the repository.
  9105. </summary>
  9106. <remarks>
  9107. <para>
  9108. Specifies the type of a plugin to create and attach to the
  9109. assembly's repository. The plugin type must implement the
  9110. <see cref="T:log4net.Plugin.IPlugin"/> interface.
  9111. </para>
  9112. </remarks>
  9113. <author>Nicko Cadell</author>
  9114. <author>Gert Driesen</author>
  9115. </member>
  9116. <member name="T:log4net.Plugin.IPluginFactory">
  9117. <summary>
  9118. Interface used to create plugins.
  9119. </summary>
  9120. <remarks>
  9121. <para>
  9122. Interface used to create a plugin.
  9123. </para>
  9124. </remarks>
  9125. <author>Nicko Cadell</author>
  9126. <author>Gert Driesen</author>
  9127. </member>
  9128. <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
  9129. <summary>
  9130. Creates the plugin object.
  9131. </summary>
  9132. <returns>the new plugin instance</returns>
  9133. <remarks>
  9134. <para>
  9135. Create and return a new plugin instance.
  9136. </para>
  9137. </remarks>
  9138. </member>
  9139. <member name="M:log4net.Config.PluginAttribute.#ctor(System.String)">
  9140. <summary>
  9141. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
  9142. with the specified type.
  9143. </summary>
  9144. <param name="typeName">The type name of plugin to create.</param>
  9145. <remarks>
  9146. <para>
  9147. Create the attribute with the plugin type specified.
  9148. </para>
  9149. <para>
  9150. Where possible use the constructor that takes a <see cref="T:System.Type"/>.
  9151. </para>
  9152. </remarks>
  9153. </member>
  9154. <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
  9155. <summary>
  9156. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute"/> class
  9157. with the specified type.
  9158. </summary>
  9159. <param name="type">The type of plugin to create.</param>
  9160. <remarks>
  9161. <para>
  9162. Create the attribute with the plugin type specified.
  9163. </para>
  9164. </remarks>
  9165. </member>
  9166. <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
  9167. <summary>
  9168. Creates the plugin object defined by this attribute.
  9169. </summary>
  9170. <remarks>
  9171. <para>
  9172. Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
  9173. specified by this attribute.
  9174. </para>
  9175. </remarks>
  9176. <returns>The plugin object.</returns>
  9177. </member>
  9178. <member name="M:log4net.Config.PluginAttribute.ToString">
  9179. <summary>
  9180. Returns a representation of the properties of this object.
  9181. </summary>
  9182. <remarks>
  9183. <para>
  9184. Overrides base class <see cref="M:Object.ToString()" /> method to
  9185. return a representation of the properties of this object.
  9186. </para>
  9187. </remarks>
  9188. <returns>A representation of the properties of this object</returns>
  9189. </member>
  9190. <member name="P:log4net.Config.PluginAttribute.Type">
  9191. <summary>
  9192. Gets or sets the type for the plugin.
  9193. </summary>
  9194. <value>
  9195. The type for the plugin.
  9196. </value>
  9197. <remarks>
  9198. <para>
  9199. The type for the plugin.
  9200. </para>
  9201. </remarks>
  9202. </member>
  9203. <member name="P:log4net.Config.PluginAttribute.TypeName">
  9204. <summary>
  9205. Gets or sets the type name for the plugin.
  9206. </summary>
  9207. <value>
  9208. The type name for the plugin.
  9209. </value>
  9210. <remarks>
  9211. <para>
  9212. The type name for the plugin.
  9213. </para>
  9214. <para>
  9215. Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
  9216. </para>
  9217. </remarks>
  9218. </member>
  9219. <member name="T:log4net.Config.SecurityContextProviderAttribute">
  9220. <summary>
  9221. Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
  9222. </summary>
  9223. <remarks>
  9224. <para>
  9225. This attribute may only be used at the assembly scope and can only
  9226. be used once per assembly.
  9227. </para>
  9228. <para>
  9229. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  9230. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  9231. methods.
  9232. </para>
  9233. </remarks>
  9234. <author>Nicko Cadell</author>
  9235. </member>
  9236. <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
  9237. <summary>
  9238. Construct provider attribute with type specified
  9239. </summary>
  9240. <param name="providerType">the type of the provider to use</param>
  9241. <remarks>
  9242. <para>
  9243. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9244. class.
  9245. </para>
  9246. </remarks>
  9247. </member>
  9248. <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  9249. <summary>
  9250. Configures the SecurityContextProvider
  9251. </summary>
  9252. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  9253. <param name="targetRepository">The repository to configure.</param>
  9254. <remarks>
  9255. <para>
  9256. Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
  9257. Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
  9258. </para>
  9259. </remarks>
  9260. </member>
  9261. <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
  9262. <summary>
  9263. The fully qualified type of the SecurityContextProviderAttribute class.
  9264. </summary>
  9265. <remarks>
  9266. Used by the internal logger to record the Type of the
  9267. log message.
  9268. </remarks>
  9269. </member>
  9270. <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
  9271. <summary>
  9272. Gets or sets the type of the provider to use.
  9273. </summary>
  9274. <value>
  9275. the type of the provider to use.
  9276. </value>
  9277. <remarks>
  9278. <para>
  9279. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  9280. class.
  9281. </para>
  9282. </remarks>
  9283. </member>
  9284. <member name="T:log4net.Config.XmlConfigurator">
  9285. <summary>
  9286. Use this class to initialize the log4net environment using an Xml tree.
  9287. </summary>
  9288. <remarks>
  9289. <para>
  9290. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  9291. </para>
  9292. </remarks>
  9293. <author>Nicko Cadell</author>
  9294. <author>Gert Driesen</author>
  9295. </member>
  9296. <member name="M:log4net.Config.XmlConfigurator.#ctor">
  9297. <summary>
  9298. Private constructor
  9299. </summary>
  9300. </member>
  9301. <member name="M:log4net.Config.XmlConfigurator.Configure">
  9302. <summary>
  9303. Automatically configures the log4net system based on the
  9304. application's configuration settings.
  9305. </summary>
  9306. <remarks>
  9307. <para>
  9308. Each application has a configuration file. This has the
  9309. same name as the application with '.config' appended.
  9310. This file is XML and calling this function prompts the
  9311. configurator to look in that file for a section called
  9312. <c>log4net</c> that contains the configuration data.
  9313. </para>
  9314. <para>
  9315. To use this method to configure log4net you must specify
  9316. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9317. handler for the <c>log4net</c> configuration section. See the
  9318. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9319. </para>
  9320. </remarks>
  9321. <seealso cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/>
  9322. </member>
  9323. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  9324. <summary>
  9325. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  9326. stored in the application's configuration file.
  9327. </summary>
  9328. <remarks>
  9329. <para>
  9330. Each application has a configuration file. This has the
  9331. same name as the application with '.config' appended.
  9332. This file is XML and calling this function prompts the
  9333. configurator to look in that file for a section called
  9334. <c>log4net</c> that contains the configuration data.
  9335. </para>
  9336. <para>
  9337. To use this method to configure log4net you must specify
  9338. the <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> section
  9339. handler for the <c>log4net</c> configuration section. See the
  9340. <see cref="T:log4net.Config.Log4NetConfigurationSectionHandler"/> for an example.
  9341. </para>
  9342. </remarks>
  9343. <param name="repository">The repository to configure.</param>
  9344. </member>
  9345. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Xml.XmlElement)">
  9346. <summary>
  9347. Configures log4net using a <c>log4net</c> element
  9348. </summary>
  9349. <remarks>
  9350. <para>
  9351. Loads the log4net configuration from the XML element
  9352. supplied as <paramref name="element"/>.
  9353. </para>
  9354. </remarks>
  9355. <param name="element">The element to parse.</param>
  9356. </member>
  9357. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9358. <summary>
  9359. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  9360. element.
  9361. </summary>
  9362. <remarks>
  9363. Loads the log4net configuration from the XML element
  9364. supplied as <paramref name="element"/>.
  9365. </remarks>
  9366. <param name="repository">The repository to configure.</param>
  9367. <param name="element">The element to parse.</param>
  9368. </member>
  9369. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.FileInfo)">
  9370. <summary>
  9371. Configures log4net using the specified configuration file.
  9372. </summary>
  9373. <param name="configFile">The XML file to load the configuration from.</param>
  9374. <remarks>
  9375. <para>
  9376. The configuration file must be valid XML. It must contain
  9377. at least one element called <c>log4net</c> that holds
  9378. the log4net configuration data.
  9379. </para>
  9380. <para>
  9381. The log4net configuration file can possible be specified in the application's
  9382. configuration file (either <c>MyAppName.exe.config</c> for a
  9383. normal application on <c>Web.config</c> for an ASP.NET application).
  9384. </para>
  9385. <para>
  9386. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9387. configuration. If this file is also a .NET .config file then you must specify
  9388. a configuration section for the <c>log4net</c> element otherwise .NET will
  9389. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9390. <code lang="XML" escaped="true">
  9391. <configSections>
  9392. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  9393. </configSections>
  9394. </code>
  9395. </para>
  9396. <example>
  9397. The following example configures log4net using a configuration file, of which the
  9398. location is stored in the application's configuration file :
  9399. </example>
  9400. <code lang="C#">
  9401. using log4net.Config;
  9402. using System.IO;
  9403. using System.Configuration;
  9404. ...
  9405. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9406. </code>
  9407. <para>
  9408. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9409. </para>
  9410. <code lang="XML" escaped="true">
  9411. <configuration>
  9412. <appSettings>
  9413. <add key="log4net-config-file" value="log.config"/>
  9414. </appSettings>
  9415. </configuration>
  9416. </code>
  9417. </remarks>
  9418. </member>
  9419. <member name="M:log4net.Config.XmlConfigurator.Configure(System.Uri)">
  9420. <summary>
  9421. Configures log4net using the specified configuration URI.
  9422. </summary>
  9423. <param name="configUri">A URI to load the XML configuration from.</param>
  9424. <remarks>
  9425. <para>
  9426. The configuration data must be valid XML. It must contain
  9427. at least one element called <c>log4net</c> that holds
  9428. the log4net configuration data.
  9429. </para>
  9430. <para>
  9431. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9432. </para>
  9433. </remarks>
  9434. </member>
  9435. <member name="M:log4net.Config.XmlConfigurator.Configure(System.IO.Stream)">
  9436. <summary>
  9437. Configures log4net using the specified configuration data stream.
  9438. </summary>
  9439. <param name="configStream">A stream to load the XML configuration from.</param>
  9440. <remarks>
  9441. <para>
  9442. The configuration data must be valid XML. It must contain
  9443. at least one element called <c>log4net</c> that holds
  9444. the log4net configuration data.
  9445. </para>
  9446. <para>
  9447. Note that this method will NOT close the stream parameter.
  9448. </para>
  9449. </remarks>
  9450. </member>
  9451. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9452. <summary>
  9453. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9454. file.
  9455. </summary>
  9456. <param name="repository">The repository to configure.</param>
  9457. <param name="configFile">The XML file to load the configuration from.</param>
  9458. <remarks>
  9459. <para>
  9460. The configuration file must be valid XML. It must contain
  9461. at least one element called <c>log4net</c> that holds
  9462. the configuration data.
  9463. </para>
  9464. <para>
  9465. The log4net configuration file can possible be specified in the application's
  9466. configuration file (either <c>MyAppName.exe.config</c> for a
  9467. normal application on <c>Web.config</c> for an ASP.NET application).
  9468. </para>
  9469. <para>
  9470. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  9471. configuration. If this file is also a .NET .config file then you must specify
  9472. a configuration section for the <c>log4net</c> element otherwise .NET will
  9473. complain. Set the type for the section handler to <see cref="T:System.Configuration.IgnoreSectionHandler"/>, for example:
  9474. <code lang="XML" escaped="true">
  9475. <configSections>
  9476. <section name="log4net" type="System.Configuration.IgnoreSectionHandler"/>
  9477. </configSections>
  9478. </code>
  9479. </para>
  9480. <example>
  9481. The following example configures log4net using a configuration file, of which the
  9482. location is stored in the application's configuration file :
  9483. </example>
  9484. <code lang="C#">
  9485. using log4net.Config;
  9486. using System.IO;
  9487. using System.Configuration;
  9488. ...
  9489. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  9490. </code>
  9491. <para>
  9492. In the <c>.config</c> file, the path to the log4net can be specified like this :
  9493. </para>
  9494. <code lang="XML" escaped="true">
  9495. <configuration>
  9496. <appSettings>
  9497. <add key="log4net-config-file" value="log.config"/>
  9498. </appSettings>
  9499. </configuration>
  9500. </code>
  9501. </remarks>
  9502. </member>
  9503. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
  9504. <summary>
  9505. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9506. URI.
  9507. </summary>
  9508. <param name="repository">The repository to configure.</param>
  9509. <param name="configUri">A URI to load the XML configuration from.</param>
  9510. <remarks>
  9511. <para>
  9512. The configuration data must be valid XML. It must contain
  9513. at least one element called <c>log4net</c> that holds
  9514. the configuration data.
  9515. </para>
  9516. <para>
  9517. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  9518. </para>
  9519. </remarks>
  9520. </member>
  9521. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  9522. <summary>
  9523. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  9524. file.
  9525. </summary>
  9526. <param name="repository">The repository to configure.</param>
  9527. <param name="configStream">The stream to load the XML configuration from.</param>
  9528. <remarks>
  9529. <para>
  9530. The configuration data must be valid XML. It must contain
  9531. at least one element called <c>log4net</c> that holds
  9532. the configuration data.
  9533. </para>
  9534. <para>
  9535. Note that this method will NOT close the stream parameter.
  9536. </para>
  9537. </remarks>
  9538. </member>
  9539. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(System.IO.FileInfo)">
  9540. <summary>
  9541. Configures log4net using the file specified, monitors the file for changes
  9542. and reloads the configuration if a change is detected.
  9543. </summary>
  9544. <param name="configFile">The XML file to load the configuration from.</param>
  9545. <remarks>
  9546. <para>
  9547. The configuration file must be valid XML. It must contain
  9548. at least one element called <c>log4net</c> that holds
  9549. the configuration data.
  9550. </para>
  9551. <para>
  9552. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9553. and depends on the behavior of that class.
  9554. </para>
  9555. <para>
  9556. For more information on how to configure log4net using
  9557. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9558. </para>
  9559. </remarks>
  9560. <seealso cref="M:Configure(FileInfo)"/>
  9561. </member>
  9562. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9563. <summary>
  9564. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  9565. monitors the file for changes and reloads the configuration if a change
  9566. is detected.
  9567. </summary>
  9568. <param name="repository">The repository to configure.</param>
  9569. <param name="configFile">The XML file to load the configuration from.</param>
  9570. <remarks>
  9571. <para>
  9572. The configuration file must be valid XML. It must contain
  9573. at least one element called <c>log4net</c> that holds
  9574. the configuration data.
  9575. </para>
  9576. <para>
  9577. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  9578. and depends on the behavior of that class.
  9579. </para>
  9580. <para>
  9581. For more information on how to configure log4net using
  9582. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  9583. </para>
  9584. </remarks>
  9585. <seealso cref="M:Configure(FileInfo)"/>
  9586. </member>
  9587. <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  9588. <summary>
  9589. Configures the specified repository using a <c>log4net</c> element.
  9590. </summary>
  9591. <param name="repository">The hierarchy to configure.</param>
  9592. <param name="element">The element to parse.</param>
  9593. <remarks>
  9594. <para>
  9595. Loads the log4net configuration from the XML element
  9596. supplied as <paramref name="element"/>.
  9597. </para>
  9598. <para>
  9599. This method is ultimately called by one of the Configure methods
  9600. to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
  9601. </para>
  9602. </remarks>
  9603. </member>
  9604. <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
  9605. <summary>
  9606. Maps repository names to ConfigAndWatchHandler instances to allow a particular
  9607. ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
  9608. reconfigured.
  9609. </summary>
  9610. </member>
  9611. <member name="F:log4net.Config.XmlConfigurator.declaringType">
  9612. <summary>
  9613. The fully qualified type of the XmlConfigurator class.
  9614. </summary>
  9615. <remarks>
  9616. Used by the internal logger to record the Type of the
  9617. log message.
  9618. </remarks>
  9619. </member>
  9620. <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
  9621. <summary>
  9622. Class used to watch config files.
  9623. </summary>
  9624. <remarks>
  9625. <para>
  9626. Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
  9627. changes to a specified file. Because multiple change notifications
  9628. may be raised when the file is modified, a timer is used to
  9629. compress the notifications into a single event. The timer
  9630. waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
  9631. the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
  9632. change notifications arrive while the timer is waiting it
  9633. is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
  9634. elapse.
  9635. </para>
  9636. </remarks>
  9637. </member>
  9638. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
  9639. <summary>
  9640. The default amount of time to wait after receiving notification
  9641. before reloading the config file.
  9642. </summary>
  9643. </member>
  9644. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
  9645. <summary>
  9646. Holds the FileInfo used to configure the XmlConfigurator
  9647. </summary>
  9648. </member>
  9649. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
  9650. <summary>
  9651. Holds the repository being configured.
  9652. </summary>
  9653. </member>
  9654. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
  9655. <summary>
  9656. The timer used to compress the notification events.
  9657. </summary>
  9658. </member>
  9659. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
  9660. <summary>
  9661. Watches file for changes. This object should be disposed when no longer
  9662. needed to free system handles on the watched resources.
  9663. </summary>
  9664. </member>
  9665. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  9666. <summary>
  9667. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class to
  9668. watch a specified config file used to configure a repository.
  9669. </summary>
  9670. <param name="repository">The repository to configure.</param>
  9671. <param name="configFile">The configuration file to watch.</param>
  9672. <remarks>
  9673. <para>
  9674. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/> class.
  9675. </para>
  9676. </remarks>
  9677. </member>
  9678. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
  9679. <summary>
  9680. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  9681. </summary>
  9682. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  9683. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  9684. <remarks>
  9685. <para>
  9686. This handler reloads the configuration from the file when the event is fired.
  9687. </para>
  9688. </remarks>
  9689. </member>
  9690. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
  9691. <summary>
  9692. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  9693. </summary>
  9694. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  9695. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  9696. <remarks>
  9697. <para>
  9698. This handler reloads the configuration from the file when the event is fired.
  9699. </para>
  9700. </remarks>
  9701. </member>
  9702. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
  9703. <summary>
  9704. Called by the timer when the configuration has been updated.
  9705. </summary>
  9706. <param name="state">null</param>
  9707. </member>
  9708. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
  9709. <summary>
  9710. Release the handles held by the watcher and timer.
  9711. </summary>
  9712. </member>
  9713. <member name="T:log4net.Core.CompactRepositorySelector">
  9714. <summary>
  9715. The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
  9716. for use with the compact framework
  9717. </summary>
  9718. <remarks>
  9719. <para>
  9720. This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
  9721. mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9722. object.
  9723. </para>
  9724. <para>
  9725. The .NET Compact Framework 1.0 does not support retrieving assembly
  9726. level attributes therefore unlike the <c>DefaultRepositorySelector</c>
  9727. this selector does not examine the calling assembly for attributes.
  9728. </para>
  9729. </remarks>
  9730. <author>Nicko Cadell</author>
  9731. </member>
  9732. <member name="T:log4net.Core.IRepositorySelector">
  9733. <summary>
  9734. Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9735. </summary>
  9736. <remarks>
  9737. <para>
  9738. The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
  9739. to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
  9740. to return to the caller.
  9741. </para>
  9742. </remarks>
  9743. <author>Nicko Cadell</author>
  9744. <author>Gert Driesen</author>
  9745. </member>
  9746. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9747. <summary>
  9748. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9749. </summary>
  9750. <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9751. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
  9752. <remarks>
  9753. <para>
  9754. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9755. </para>
  9756. <para>
  9757. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9758. is made is not defined. The implementation may choose any method for
  9759. this association. The results of this method must be repeatable, i.e.
  9760. when called again with the same arguments the result must be the
  9761. save value.
  9762. </para>
  9763. </remarks>
  9764. </member>
  9765. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
  9766. <summary>
  9767. Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9768. </summary>
  9769. <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9770. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9771. <remarks>
  9772. Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
  9773. calling <see cref="M:CreateRepository(string,Type)"/>.
  9774. </remarks>
  9775. </member>
  9776. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9777. <summary>
  9778. Creates a new repository for the assembly specified.
  9779. </summary>
  9780. <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9781. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9782. <returns>The repository created.</returns>
  9783. <remarks>
  9784. <para>
  9785. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
  9786. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  9787. same assembly specified will return the same repository instance.
  9788. </para>
  9789. <para>
  9790. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9791. is made is not defined. The implementation may choose any method for
  9792. this association.
  9793. </para>
  9794. </remarks>
  9795. </member>
  9796. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
  9797. <summary>
  9798. Creates a new repository with the name specified.
  9799. </summary>
  9800. <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9801. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9802. <returns>The repository created.</returns>
  9803. <remarks>
  9804. <para>
  9805. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
  9806. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  9807. same name will return the same repository instance.
  9808. </para>
  9809. </remarks>
  9810. </member>
  9811. <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
  9812. <summary>
  9813. Test if a named repository exists
  9814. </summary>
  9815. <param name="repositoryName">the named repository to check</param>
  9816. <returns><c>true</c> if the repository exists</returns>
  9817. <remarks>
  9818. <para>
  9819. Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
  9820. to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
  9821. a repository.
  9822. </para>
  9823. </remarks>
  9824. </member>
  9825. <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
  9826. <summary>
  9827. Gets an array of all currently defined repositories.
  9828. </summary>
  9829. <returns>
  9830. An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
  9831. this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
  9832. <remarks>
  9833. <para>
  9834. Gets an array of all of the repositories created by this selector.
  9835. </para>
  9836. </remarks>
  9837. </member>
  9838. <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
  9839. <summary>
  9840. Event to notify that a logger repository has been created.
  9841. </summary>
  9842. <value>
  9843. Event to notify that a logger repository has been created.
  9844. </value>
  9845. <remarks>
  9846. <para>
  9847. Event raised when a new repository is created.
  9848. The event source will be this selector. The event args will
  9849. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9850. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9851. </para>
  9852. </remarks>
  9853. </member>
  9854. <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
  9855. <summary>
  9856. Create a new repository selector
  9857. </summary>
  9858. <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9859. <remarks>
  9860. <para>
  9861. Create an new compact repository selector.
  9862. The default type for repositories must be specified,
  9863. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  9864. </para>
  9865. </remarks>
  9866. <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
  9867. <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
  9868. </member>
  9869. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9870. <summary>
  9871. Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
  9872. </summary>
  9873. <param name="assembly">not used</param>
  9874. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9875. <remarks>
  9876. <para>
  9877. The <paramref name="assembly"/> argument is not used. This selector does not create a
  9878. separate repository for each assembly.
  9879. </para>
  9880. <para>
  9881. As a named repository is not specified the default repository is
  9882. returned. The default repository is named <c>log4net-default-repository</c>.
  9883. </para>
  9884. </remarks>
  9885. </member>
  9886. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
  9887. <summary>
  9888. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
  9889. </summary>
  9890. <param name="repositoryName">the name of the repository to lookup</param>
  9891. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9892. <remarks>
  9893. <para>
  9894. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
  9895. repository is <c>log4net-default-repository</c>. Other repositories
  9896. must be created using the <see cref="M:CreateRepository(string, Type)"/>.
  9897. If the named repository does not exist an exception is thrown.
  9898. </para>
  9899. </remarks>
  9900. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  9901. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
  9902. </member>
  9903. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9904. <summary>
  9905. Create a new repository for the assembly specified
  9906. </summary>
  9907. <param name="assembly">not used</param>
  9908. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9909. <returns>the repository created</returns>
  9910. <remarks>
  9911. <para>
  9912. The <paramref name="assembly"/> argument is not used. This selector does not create a
  9913. separate repository for each assembly.
  9914. </para>
  9915. <para>
  9916. If the <paramref name="repositoryType"/> is <c>null</c> then the
  9917. default repository type specified to the constructor is used.
  9918. </para>
  9919. <para>
  9920. As a named repository is not specified the default repository is
  9921. returned. The default repository is named <c>log4net-default-repository</c>.
  9922. </para>
  9923. </remarks>
  9924. </member>
  9925. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
  9926. <summary>
  9927. Create a new repository for the repository specified
  9928. </summary>
  9929. <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9930. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9931. If this param is null then the default repository type is used.</param>
  9932. <returns>the repository created</returns>
  9933. <remarks>
  9934. <para>
  9935. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  9936. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  9937. same repository specified will return the same repository instance.
  9938. </para>
  9939. <para>
  9940. If the named repository already exists an exception will be thrown.
  9941. </para>
  9942. <para>
  9943. If <paramref name="repositoryType"/> is <c>null</c> then the default
  9944. repository type specified to the constructor is used.
  9945. </para>
  9946. </remarks>
  9947. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  9948. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
  9949. </member>
  9950. <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
  9951. <summary>
  9952. Test if a named repository exists
  9953. </summary>
  9954. <param name="repositoryName">the named repository to check</param>
  9955. <returns><c>true</c> if the repository exists</returns>
  9956. <remarks>
  9957. <para>
  9958. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  9959. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  9960. a repository.
  9961. </para>
  9962. </remarks>
  9963. </member>
  9964. <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
  9965. <summary>
  9966. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  9967. </summary>
  9968. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  9969. <remarks>
  9970. <para>
  9971. Gets an array of all of the repositories created by this selector.
  9972. </para>
  9973. </remarks>
  9974. </member>
  9975. <member name="F:log4net.Core.CompactRepositorySelector.declaringType">
  9976. <summary>
  9977. The fully qualified type of the CompactRepositorySelector class.
  9978. </summary>
  9979. <remarks>
  9980. Used by the internal logger to record the Type of the
  9981. log message.
  9982. </remarks>
  9983. </member>
  9984. <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  9985. <summary>
  9986. Notify the registered listeners that the repository has been created
  9987. </summary>
  9988. <param name="repository">The repository that has been created</param>
  9989. <remarks>
  9990. <para>
  9991. Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
  9992. event.
  9993. </para>
  9994. </remarks>
  9995. </member>
  9996. <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
  9997. <summary>
  9998. Event to notify that a logger repository has been created.
  9999. </summary>
  10000. <value>
  10001. Event to notify that a logger repository has been created.
  10002. </value>
  10003. <remarks>
  10004. <para>
  10005. Event raised when a new repository is created.
  10006. The event source will be this selector. The event args will
  10007. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10008. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10009. </para>
  10010. </remarks>
  10011. </member>
  10012. <member name="T:log4net.Core.DefaultRepositorySelector">
  10013. <summary>
  10014. The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
  10015. </summary>
  10016. <remarks>
  10017. <para>
  10018. Uses attributes defined on the calling assembly to determine how to
  10019. configure the hierarchy for the repository.
  10020. </para>
  10021. </remarks>
  10022. <author>Nicko Cadell</author>
  10023. <author>Gert Driesen</author>
  10024. </member>
  10025. <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
  10026. <summary>
  10027. Creates a new repository selector.
  10028. </summary>
  10029. <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  10030. <remarks>
  10031. <para>
  10032. Create an new repository selector.
  10033. The default type for repositories must be specified,
  10034. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  10035. </para>
  10036. </remarks>
  10037. <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null"/>.</exception>
  10038. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
  10039. </member>
  10040. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
  10041. <summary>
  10042. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  10043. </summary>
  10044. <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10045. <remarks>
  10046. <para>
  10047. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
  10048. to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
  10049. attribute on the <paramref name="repositoryAssembly"/>.
  10050. </para>
  10051. <para>
  10052. The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  10053. implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10054. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10055. </para>
  10056. <para>
  10057. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
  10058. any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
  10059. the <paramref name="repositoryAssembly"/>.
  10060. </para>
  10061. </remarks>
  10062. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
  10063. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10064. </member>
  10065. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
  10066. <summary>
  10067. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
  10068. </summary>
  10069. <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10070. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
  10071. <remarks>
  10072. <para>
  10073. Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
  10074. a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
  10075. does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
  10076. </para>
  10077. <para>
  10078. Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
  10079. </para>
  10080. </remarks>
  10081. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
  10082. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
  10083. </member>
  10084. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  10085. <summary>
  10086. Create a new repository for the assembly specified
  10087. </summary>
  10088. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10089. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10090. <returns>The repository created.</returns>
  10091. <remarks>
  10092. <para>
  10093. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10094. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10095. same assembly specified will return the same repository instance.
  10096. </para>
  10097. <para>
  10098. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10099. the repository to create can be overridden by specifying the
  10100. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10101. <paramref name="repositoryAssembly"/>. The default values are to use the
  10102. <paramref name="repositoryType"/> implementation of the
  10103. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10104. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10105. </para>
  10106. <para>
  10107. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10108. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10109. attributes defined on the <paramref name="repositoryAssembly"/>.
  10110. </para>
  10111. <para>
  10112. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10113. that repository will be returned. An error will not be raised and that
  10114. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10115. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10116. assembly may be used to override the repository type specified in
  10117. <paramref name="repositoryType"/>.
  10118. </para>
  10119. </remarks>
  10120. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10121. </member>
  10122. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
  10123. <summary>
  10124. Creates a new repository for the assembly specified.
  10125. </summary>
  10126. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10127. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10128. <param name="repositoryName">The name to assign to the created repository</param>
  10129. <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
  10130. <returns>The repository created.</returns>
  10131. <remarks>
  10132. <para>
  10133. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10134. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10135. same assembly specified will return the same repository instance.
  10136. </para>
  10137. <para>
  10138. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  10139. the repository to create can be overridden by specifying the
  10140. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10141. <paramref name="repositoryAssembly"/>. The default values are to use the
  10142. <paramref name="repositoryType"/> implementation of the
  10143. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  10144. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  10145. </para>
  10146. <para>
  10147. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  10148. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10149. attributes defined on the <paramref name="repositoryAssembly"/>.
  10150. </para>
  10151. <para>
  10152. If a repository for the <paramref name="repositoryAssembly"/> already exists
  10153. that repository will be returned. An error will not be raised and that
  10154. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  10155. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  10156. assembly may be used to override the repository type specified in
  10157. <paramref name="repositoryType"/>.
  10158. </para>
  10159. </remarks>
  10160. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null"/>.</exception>
  10161. </member>
  10162. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
  10163. <summary>
  10164. Creates a new repository for the specified repository.
  10165. </summary>
  10166. <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  10167. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10168. If this param is <see langword="null"/> then the default repository type is used.</param>
  10169. <returns>The new repository.</returns>
  10170. <remarks>
  10171. <para>
  10172. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10173. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  10174. same repository specified will return the same repository instance.
  10175. </para>
  10176. </remarks>
  10177. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null"/>.</exception>
  10178. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
  10179. </member>
  10180. <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
  10181. <summary>
  10182. Test if a named repository exists
  10183. </summary>
  10184. <param name="repositoryName">the named repository to check</param>
  10185. <returns><c>true</c> if the repository exists</returns>
  10186. <remarks>
  10187. <para>
  10188. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  10189. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  10190. a repository.
  10191. </para>
  10192. </remarks>
  10193. </member>
  10194. <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
  10195. <summary>
  10196. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  10197. </summary>
  10198. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  10199. <remarks>
  10200. <para>
  10201. Gets an array of all of the repositories created by this selector.
  10202. </para>
  10203. </remarks>
  10204. </member>
  10205. <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
  10206. <summary>
  10207. Aliases a repository to an existing repository.
  10208. </summary>
  10209. <param name="repositoryAlias">The repository to alias.</param>
  10210. <param name="repositoryTarget">The repository that the repository is aliased to.</param>
  10211. <remarks>
  10212. <para>
  10213. The repository specified will be aliased to the repository when created.
  10214. The repository must not already exist.
  10215. </para>
  10216. <para>
  10217. When the repository is created it must utilize the same repository type as
  10218. the repository it is aliased to, otherwise the aliasing will fail.
  10219. </para>
  10220. </remarks>
  10221. <exception cref="T:System.ArgumentNullException">
  10222. <para><paramref name="repositoryAlias"/> is <see langword="null"/>.</para>
  10223. <para>-or-</para>
  10224. <para><paramref name="repositoryTarget"/> is <see langword="null"/>.</para>
  10225. </exception>
  10226. </member>
  10227. <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  10228. <summary>
  10229. Notifies the registered listeners that the repository has been created.
  10230. </summary>
  10231. <param name="repository">The repository that has been created.</param>
  10232. <remarks>
  10233. <para>
  10234. Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10235. </para>
  10236. </remarks>
  10237. </member>
  10238. <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
  10239. <summary>
  10240. Gets the repository name and repository type for the specified assembly.
  10241. </summary>
  10242. <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
  10243. <param name="repositoryName">in/out param to hold the repository name to use for the assembly, caller should set this to the default value before calling.</param>
  10244. <param name="repositoryType">in/out param to hold the type of the repository to create for the assembly, caller should set this to the default value before calling.</param>
  10245. <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception>
  10246. </member>
  10247. <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10248. <summary>
  10249. Configures the repository using information from the assembly.
  10250. </summary>
  10251. <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  10252. attributes which define the configuration for the repository.</param>
  10253. <param name="repository">The repository to configure.</param>
  10254. <exception cref="T:System.ArgumentNullException">
  10255. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10256. <para>-or-</para>
  10257. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10258. </exception>
  10259. </member>
  10260. <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10261. <summary>
  10262. Loads the attribute defined plugins on the assembly.
  10263. </summary>
  10264. <param name="assembly">The assembly that contains the attributes.</param>
  10265. <param name="repository">The repository to add the plugins to.</param>
  10266. <exception cref="T:System.ArgumentNullException">
  10267. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10268. <para>-or-</para>
  10269. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10270. </exception>
  10271. </member>
  10272. <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  10273. <summary>
  10274. Loads the attribute defined aliases on the assembly.
  10275. </summary>
  10276. <param name="assembly">The assembly that contains the attributes.</param>
  10277. <param name="repository">The repository to alias to.</param>
  10278. <exception cref="T:System.ArgumentNullException">
  10279. <para><paramref name="assembly"/> is <see langword="null"/>.</para>
  10280. <para>-or-</para>
  10281. <para><paramref name="repository"/> is <see langword="null"/>.</para>
  10282. </exception>
  10283. </member>
  10284. <member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
  10285. <summary>
  10286. The fully qualified type of the DefaultRepositorySelector class.
  10287. </summary>
  10288. <remarks>
  10289. Used by the internal logger to record the Type of the
  10290. log message.
  10291. </remarks>
  10292. </member>
  10293. <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
  10294. <summary>
  10295. Event to notify that a logger repository has been created.
  10296. </summary>
  10297. <value>
  10298. Event to notify that a logger repository has been created.
  10299. </value>
  10300. <remarks>
  10301. <para>
  10302. Event raised when a new repository is created.
  10303. The event source will be this selector. The event args will
  10304. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  10305. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  10306. </para>
  10307. </remarks>
  10308. </member>
  10309. <member name="T:log4net.Core.ErrorCode">
  10310. <summary>
  10311. Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10312. </summary>
  10313. <remarks>
  10314. <para>
  10315. Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  10316. </para>
  10317. </remarks>
  10318. <author>Nicko Cadell</author>
  10319. </member>
  10320. <member name="F:log4net.Core.ErrorCode.GenericFailure">
  10321. <summary>
  10322. A general error
  10323. </summary>
  10324. </member>
  10325. <member name="F:log4net.Core.ErrorCode.WriteFailure">
  10326. <summary>
  10327. Error while writing output
  10328. </summary>
  10329. </member>
  10330. <member name="F:log4net.Core.ErrorCode.FlushFailure">
  10331. <summary>
  10332. Failed to flush file
  10333. </summary>
  10334. </member>
  10335. <member name="F:log4net.Core.ErrorCode.CloseFailure">
  10336. <summary>
  10337. Failed to close file
  10338. </summary>
  10339. </member>
  10340. <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
  10341. <summary>
  10342. Unable to open output file
  10343. </summary>
  10344. </member>
  10345. <member name="F:log4net.Core.ErrorCode.MissingLayout">
  10346. <summary>
  10347. No layout specified
  10348. </summary>
  10349. </member>
  10350. <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
  10351. <summary>
  10352. Failed to parse address
  10353. </summary>
  10354. </member>
  10355. <member name="T:log4net.Core.ExceptionEvaluator">
  10356. <summary>
  10357. An evaluator that triggers on an Exception type
  10358. </summary>
  10359. <remarks>
  10360. <para>
  10361. This evaluator will trigger if the type of the Exception
  10362. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10363. is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
  10364. </para>
  10365. </remarks>
  10366. <author>Drew Schaeffer</author>
  10367. </member>
  10368. <member name="T:log4net.Core.ITriggeringEventEvaluator">
  10369. <summary>
  10370. Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
  10371. </summary>
  10372. <remarks>
  10373. <para>
  10374. Implementations of this interface allow certain appenders to decide
  10375. when to perform an appender specific action.
  10376. </para>
  10377. <para>
  10378. The action or behavior triggered is defined by the implementation.
  10379. </para>
  10380. </remarks>
  10381. <author>Nicko Cadell</author>
  10382. </member>
  10383. <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10384. <summary>
  10385. Test if this event triggers the action
  10386. </summary>
  10387. <param name="loggingEvent">The event to check</param>
  10388. <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
  10389. <remarks>
  10390. <para>
  10391. Return <c>true</c> if this event triggers the action
  10392. </para>
  10393. </remarks>
  10394. </member>
  10395. <member name="F:log4net.Core.ExceptionEvaluator.m_type">
  10396. <summary>
  10397. The type that causes the trigger to fire.
  10398. </summary>
  10399. </member>
  10400. <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
  10401. <summary>
  10402. Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
  10403. </summary>
  10404. </member>
  10405. <member name="M:log4net.Core.ExceptionEvaluator.#ctor">
  10406. <summary>
  10407. Default ctor to allow dynamic creation through a configurator.
  10408. </summary>
  10409. </member>
  10410. <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
  10411. <summary>
  10412. Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
  10413. </summary>
  10414. <param name="exType">the type that triggers this evaluator.</param>
  10415. <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
  10416. </member>
  10417. <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  10418. <summary>
  10419. Is this <paramref name="loggingEvent"/> the triggering event?
  10420. </summary>
  10421. <param name="loggingEvent">The event to check</param>
  10422. <returns>This method returns <c>true</c>, if the logging event Exception
  10423. Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10424. Otherwise it returns <c>false</c></returns>
  10425. <remarks>
  10426. <para>
  10427. This evaluator will trigger if the Exception Type of the event
  10428. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  10429. is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10430. </para>
  10431. </remarks>
  10432. </member>
  10433. <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
  10434. <summary>
  10435. The type that triggers this evaluator.
  10436. </summary>
  10437. </member>
  10438. <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
  10439. <summary>
  10440. If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  10441. </summary>
  10442. </member>
  10443. <member name="T:log4net.Core.IErrorHandler">
  10444. <summary>
  10445. Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler"/>.
  10446. </summary>
  10447. <remarks>
  10448. <para>
  10449. Error handling is a particularly tedious to get right because by
  10450. definition errors are hard to predict and to reproduce.
  10451. </para>
  10452. </remarks>
  10453. <author>Nicko Cadell</author>
  10454. <author>Gert Driesen</author>
  10455. </member>
  10456. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  10457. <summary>
  10458. Handles the error and information about the error condition is passed as
  10459. a parameter.
  10460. </summary>
  10461. <param name="message">The message associated with the error.</param>
  10462. <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
  10463. <param name="errorCode">The error code associated with the error.</param>
  10464. <remarks>
  10465. <para>
  10466. Handles the error and information about the error condition is passed as
  10467. a parameter.
  10468. </para>
  10469. </remarks>
  10470. </member>
  10471. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
  10472. <summary>
  10473. Prints the error message passed as a parameter.
  10474. </summary>
  10475. <param name="message">The message associated with the error.</param>
  10476. <param name="e">The <see cref="T:System.Exception"/> that was thrown when the error occurred.</param>
  10477. <remarks>
  10478. <para>
  10479. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10480. </para>
  10481. </remarks>
  10482. </member>
  10483. <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
  10484. <summary>
  10485. Prints the error message passed as a parameter.
  10486. </summary>
  10487. <param name="message">The message associated with the error.</param>
  10488. <remarks>
  10489. <para>
  10490. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  10491. </para>
  10492. </remarks>
  10493. </member>
  10494. <member name="T:log4net.Core.IFixingRequired">
  10495. <summary>
  10496. Interface for objects that require fixing.
  10497. </summary>
  10498. <remarks>
  10499. <para>
  10500. Interface that indicates that the object requires fixing before it
  10501. can be taken outside the context of the appender's
  10502. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  10503. </para>
  10504. <para>
  10505. When objects that implement this interface are stored
  10506. in the context properties maps <see cref="T:log4net.GlobalContext"/>
  10507. <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
  10508. <see cref="P:log4net.ThreadContext.Properties"/> are fixed
  10509. (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
  10510. method will be called.
  10511. </para>
  10512. </remarks>
  10513. <author>Nicko Cadell</author>
  10514. </member>
  10515. <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
  10516. <summary>
  10517. Get a portable version of this object
  10518. </summary>
  10519. <returns>the portable instance of this object</returns>
  10520. <remarks>
  10521. <para>
  10522. Get a portable instance object that represents the current
  10523. state of this object. The portable object can be stored
  10524. and logged from any thread with identical results.
  10525. </para>
  10526. </remarks>
  10527. </member>
  10528. <member name="T:log4net.Core.ILogger">
  10529. <summary>
  10530. Interface that all loggers implement
  10531. </summary>
  10532. <remarks>
  10533. <para>
  10534. This interface supports logging events and testing if a level
  10535. is enabled for logging.
  10536. </para>
  10537. <para>
  10538. These methods will not throw exceptions. Note to implementor, ensure
  10539. that the implementation of these methods cannot allow an exception
  10540. to be thrown to the caller.
  10541. </para>
  10542. </remarks>
  10543. <author>Nicko Cadell</author>
  10544. <author>Gert Driesen</author>
  10545. </member>
  10546. <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  10547. <summary>
  10548. This generic form is intended to be used by wrappers.
  10549. </summary>
  10550. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  10551. the stack boundary into the logging system for this call.</param>
  10552. <param name="level">The level of the message to be logged.</param>
  10553. <param name="message">The message object to log.</param>
  10554. <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
  10555. <remarks>
  10556. <para>
  10557. Generates a logging event for the specified <paramref name="level"/> using
  10558. the <paramref name="message"/> and <paramref name="exception"/>.
  10559. </para>
  10560. </remarks>
  10561. </member>
  10562. <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
  10563. <summary>
  10564. This is the most generic printing method that is intended to be used
  10565. by wrappers.
  10566. </summary>
  10567. <param name="logEvent">The event being logged.</param>
  10568. <remarks>
  10569. <para>
  10570. Logs the specified logging event through this logger.
  10571. </para>
  10572. </remarks>
  10573. </member>
  10574. <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
  10575. <summary>
  10576. Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
  10577. </summary>
  10578. <param name="level">The level to check.</param>
  10579. <returns>
  10580. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  10581. </returns>
  10582. <remarks>
  10583. <para>
  10584. Test if this logger is going to log events of the specified <paramref name="level"/>.
  10585. </para>
  10586. </remarks>
  10587. </member>
  10588. <member name="P:log4net.Core.ILogger.Name">
  10589. <summary>
  10590. Gets the name of the logger.
  10591. </summary>
  10592. <value>
  10593. The name of the logger.
  10594. </value>
  10595. <remarks>
  10596. <para>
  10597. The name of this logger
  10598. </para>
  10599. </remarks>
  10600. </member>
  10601. <member name="P:log4net.Core.ILogger.Repository">
  10602. <summary>
  10603. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10604. <c>Logger</c> instance is attached to.
  10605. </summary>
  10606. <value>
  10607. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
  10608. </value>
  10609. <remarks>
  10610. <para>
  10611. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  10612. <c>Logger</c> instance is attached to.
  10613. </para>
  10614. </remarks>
  10615. </member>
  10616. <member name="T:log4net.Core.ILoggerWrapper">
  10617. <summary>
  10618. Base interface for all wrappers
  10619. </summary>
  10620. <remarks>
  10621. <para>
  10622. Base interface for all wrappers.
  10623. </para>
  10624. <para>
  10625. All wrappers must implement this interface.
  10626. </para>
  10627. </remarks>
  10628. <author>Nicko Cadell</author>
  10629. </member>
  10630. <member name="P:log4net.Core.ILoggerWrapper.Logger">
  10631. <summary>
  10632. Get the implementation behind this wrapper object.
  10633. </summary>
  10634. <value>
  10635. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
  10636. </value>
  10637. <remarks>
  10638. <para>
  10639. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
  10640. object. The <c>Logger</c> object may not
  10641. be the same object as this object because of logger decorators.
  10642. This gets the actual underlying objects that is used to process
  10643. the log events.
  10644. </para>
  10645. </remarks>
  10646. </member>
  10647. <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
  10648. <summary>
  10649. Delegate used to handle logger repository creation event notifications
  10650. </summary>
  10651. <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
  10652. <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
  10653. that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
  10654. <remarks>
  10655. <para>
  10656. Delegate used to handle logger repository creation event notifications.
  10657. </para>
  10658. </remarks>
  10659. </member>
  10660. <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
  10661. <summary>
  10662. Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  10663. </summary>
  10664. <remarks>
  10665. <para>
  10666. A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
  10667. event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
  10668. </para>
  10669. </remarks>
  10670. </member>
  10671. <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
  10672. <summary>
  10673. The <see cref="T:log4net.Repository.ILoggerRepository"/> created
  10674. </summary>
  10675. </member>
  10676. <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
  10677. <summary>
  10678. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  10679. </summary>
  10680. <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
  10681. <remarks>
  10682. <para>
  10683. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  10684. </para>
  10685. </remarks>
  10686. </member>
  10687. <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
  10688. <summary>
  10689. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10690. </summary>
  10691. <value>
  10692. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10693. </value>
  10694. <remarks>
  10695. <para>
  10696. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  10697. </para>
  10698. </remarks>
  10699. </member>
  10700. <member name="T:log4net.Core.Level">
  10701. <summary>
  10702. Defines the default set of levels recognized by the system.
  10703. </summary>
  10704. <remarks>
  10705. <para>
  10706. Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
  10707. </para>
  10708. <para>
  10709. Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
  10710. ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
  10711. are deemed to be equivalent.
  10712. </para>
  10713. <para>
  10714. The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
  10715. and each repository can have different levels defined. The levels are stored
  10716. in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
  10717. looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
  10718. </para>
  10719. <para>
  10720. When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
  10721. the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
  10722. <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
  10723. </para>
  10724. <para>
  10725. Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
  10726. <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
  10727. the display name is the same as the level name, but this can be used to alias levels
  10728. or to localize the log output.
  10729. </para>
  10730. <para>
  10731. Some of the predefined levels recognized by the system are:
  10732. </para>
  10733. <list type="bullet">
  10734. <item>
  10735. <description><see cref="F:log4net.Core.Level.Off"/>.</description>
  10736. </item>
  10737. <item>
  10738. <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
  10739. </item>
  10740. <item>
  10741. <description><see cref="F:log4net.Core.Level.Error"/>.</description>
  10742. </item>
  10743. <item>
  10744. <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
  10745. </item>
  10746. <item>
  10747. <description><see cref="F:log4net.Core.Level.Info"/>.</description>
  10748. </item>
  10749. <item>
  10750. <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
  10751. </item>
  10752. <item>
  10753. <description><see cref="F:log4net.Core.Level.All"/>.</description>
  10754. </item>
  10755. </list>
  10756. </remarks>
  10757. <author>Nicko Cadell</author>
  10758. <author>Gert Driesen</author>
  10759. </member>
  10760. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
  10761. <summary>
  10762. Constructor
  10763. </summary>
  10764. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  10765. <param name="levelName">The string name of this level.</param>
  10766. <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
  10767. <remarks>
  10768. <para>
  10769. Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
  10770. the specified level name and value.
  10771. </para>
  10772. </remarks>
  10773. </member>
  10774. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
  10775. <summary>
  10776. Constructor
  10777. </summary>
  10778. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  10779. <param name="levelName">The string name of this level.</param>
  10780. <remarks>
  10781. <para>
  10782. Initializes a new instance of the <see cref="T:log4net.Core.Level"/> class with
  10783. the specified level name and value.
  10784. </para>
  10785. </remarks>
  10786. </member>
  10787. <member name="M:log4net.Core.Level.ToString">
  10788. <summary>
  10789. Returns the <see cref="T:System.String"/> representation of the current
  10790. <see cref="T:log4net.Core.Level"/>.
  10791. </summary>
  10792. <returns>
  10793. A <see cref="T:System.String"/> representation of the current <see cref="T:log4net.Core.Level"/>.
  10794. </returns>
  10795. <remarks>
  10796. <para>
  10797. Returns the level <see cref="P:log4net.Core.Level.Name"/>.
  10798. </para>
  10799. </remarks>
  10800. </member>
  10801. <member name="M:log4net.Core.Level.Equals(System.Object)">
  10802. <summary>
  10803. Compares levels.
  10804. </summary>
  10805. <param name="o">The object to compare against.</param>
  10806. <returns><c>true</c> if the objects are equal.</returns>
  10807. <remarks>
  10808. <para>
  10809. Compares the levels of <see cref="T:log4net.Core.Level"/> instances, and
  10810. defers to base class if the target object is not a <see cref="T:log4net.Core.Level"/>
  10811. instance.
  10812. </para>
  10813. </remarks>
  10814. </member>
  10815. <member name="M:log4net.Core.Level.GetHashCode">
  10816. <summary>
  10817. Returns a hash code
  10818. </summary>
  10819. <returns>A hash code for the current <see cref="T:log4net.Core.Level"/>.</returns>
  10820. <remarks>
  10821. <para>
  10822. Returns a hash code suitable for use in hashing algorithms and data
  10823. structures like a hash table.
  10824. </para>
  10825. <para>
  10826. Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
  10827. </para>
  10828. </remarks>
  10829. </member>
  10830. <member name="M:log4net.Core.Level.CompareTo(System.Object)">
  10831. <summary>
  10832. Compares this instance to a specified object and returns an
  10833. indication of their relative values.
  10834. </summary>
  10835. <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null"/> to compare with this instance.</param>
  10836. <returns>
  10837. A 32-bit signed integer that indicates the relative order of the
  10838. values compared. The return value has these meanings:
  10839. <list type="table">
  10840. <listheader>
  10841. <term>Value</term>
  10842. <description>Meaning</description>
  10843. </listheader>
  10844. <item>
  10845. <term>Less than zero</term>
  10846. <description>This instance is less than <paramref name="r"/>.</description>
  10847. </item>
  10848. <item>
  10849. <term>Zero</term>
  10850. <description>This instance is equal to <paramref name="r"/>.</description>
  10851. </item>
  10852. <item>
  10853. <term>Greater than zero</term>
  10854. <description>
  10855. <para>This instance is greater than <paramref name="r"/>.</para>
  10856. <para>-or-</para>
  10857. <para><paramref name="r"/> is <see langword="null"/>.</para>
  10858. </description>
  10859. </item>
  10860. </list>
  10861. </returns>
  10862. <remarks>
  10863. <para>
  10864. <paramref name="r"/> must be an instance of <see cref="T:log4net.Core.Level"/>
  10865. or <see langword="null"/>; otherwise, an exception is thrown.
  10866. </para>
  10867. </remarks>
  10868. <exception cref="T:System.ArgumentException"><paramref name="r"/> is not a <see cref="T:log4net.Core.Level"/>.</exception>
  10869. </member>
  10870. <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
  10871. <summary>
  10872. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  10873. is greater than another specified <see cref="T:log4net.Core.Level"/>.
  10874. </summary>
  10875. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  10876. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  10877. <returns>
  10878. <c>true</c> if <paramref name="l"/> is greater than
  10879. <paramref name="r"/>; otherwise, <c>false</c>.
  10880. </returns>
  10881. <remarks>
  10882. <para>
  10883. Compares two levels.
  10884. </para>
  10885. </remarks>
  10886. </member>
  10887. <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
  10888. <summary>
  10889. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  10890. is less than another specified <see cref="T:log4net.Core.Level"/>.
  10891. </summary>
  10892. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  10893. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  10894. <returns>
  10895. <c>true</c> if <paramref name="l"/> is less than
  10896. <paramref name="r"/>; otherwise, <c>false</c>.
  10897. </returns>
  10898. <remarks>
  10899. <para>
  10900. Compares two levels.
  10901. </para>
  10902. </remarks>
  10903. </member>
  10904. <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  10905. <summary>
  10906. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  10907. is greater than or equal to another specified <see cref="T:log4net.Core.Level"/>.
  10908. </summary>
  10909. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  10910. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  10911. <returns>
  10912. <c>true</c> if <paramref name="l"/> is greater than or equal to
  10913. <paramref name="r"/>; otherwise, <c>false</c>.
  10914. </returns>
  10915. <remarks>
  10916. <para>
  10917. Compares two levels.
  10918. </para>
  10919. </remarks>
  10920. </member>
  10921. <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  10922. <summary>
  10923. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level"/>
  10924. is less than or equal to another specified <see cref="T:log4net.Core.Level"/>.
  10925. </summary>
  10926. <param name="l">A <see cref="T:log4net.Core.Level"/></param>
  10927. <param name="r">A <see cref="T:log4net.Core.Level"/></param>
  10928. <returns>
  10929. <c>true</c> if <paramref name="l"/> is less than or equal to
  10930. <paramref name="r"/>; otherwise, <c>false</c>.
  10931. </returns>
  10932. <remarks>
  10933. <para>
  10934. Compares two levels.
  10935. </para>
  10936. </remarks>
  10937. </member>
  10938. <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
  10939. <summary>
  10940. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
  10941. objects have the same value.
  10942. </summary>
  10943. <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  10944. <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  10945. <returns>
  10946. <c>true</c> if the value of <paramref name="l"/> is the same as the
  10947. value of <paramref name="r"/>; otherwise, <c>false</c>.
  10948. </returns>
  10949. <remarks>
  10950. <para>
  10951. Compares two levels.
  10952. </para>
  10953. </remarks>
  10954. </member>
  10955. <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
  10956. <summary>
  10957. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level"/>
  10958. objects have different values.
  10959. </summary>
  10960. <param name="l">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  10961. <param name="r">A <see cref="T:log4net.Core.Level"/> or <see langword="null"/>.</param>
  10962. <returns>
  10963. <c>true</c> if the value of <paramref name="l"/> is different from
  10964. the value of <paramref name="r"/>; otherwise, <c>false</c>.
  10965. </returns>
  10966. <remarks>
  10967. <para>
  10968. Compares two levels.
  10969. </para>
  10970. </remarks>
  10971. </member>
  10972. <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
  10973. <summary>
  10974. Compares two specified <see cref="T:log4net.Core.Level"/> instances.
  10975. </summary>
  10976. <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
  10977. <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
  10978. <returns>
  10979. A 32-bit signed integer that indicates the relative order of the
  10980. two values compared. The return value has these meanings:
  10981. <list type="table">
  10982. <listheader>
  10983. <term>Value</term>
  10984. <description>Meaning</description>
  10985. </listheader>
  10986. <item>
  10987. <term>Less than zero</term>
  10988. <description><paramref name="l"/> is less than <paramref name="r"/>.</description>
  10989. </item>
  10990. <item>
  10991. <term>Zero</term>
  10992. <description><paramref name="l"/> is equal to <paramref name="r"/>.</description>
  10993. </item>
  10994. <item>
  10995. <term>Greater than zero</term>
  10996. <description><paramref name="l"/> is greater than <paramref name="r"/>.</description>
  10997. </item>
  10998. </list>
  10999. </returns>
  11000. <remarks>
  11001. <para>
  11002. Compares two levels.
  11003. </para>
  11004. </remarks>
  11005. </member>
  11006. <member name="F:log4net.Core.Level.Off">
  11007. <summary>
  11008. The <see cref="F:log4net.Core.Level.Off"/> level designates a higher level than all the rest.
  11009. </summary>
  11010. </member>
  11011. <member name="F:log4net.Core.Level.Log4Net_Debug">
  11012. <summary>
  11013. The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
  11014. System unusable, emergencies.
  11015. </summary>
  11016. </member>
  11017. <member name="F:log4net.Core.Level.Emergency">
  11018. <summary>
  11019. The <see cref="F:log4net.Core.Level.Emergency"/> level designates very severe error events.
  11020. System unusable, emergencies.
  11021. </summary>
  11022. </member>
  11023. <member name="F:log4net.Core.Level.Fatal">
  11024. <summary>
  11025. The <see cref="F:log4net.Core.Level.Fatal"/> level designates very severe error events
  11026. that will presumably lead the application to abort.
  11027. </summary>
  11028. </member>
  11029. <member name="F:log4net.Core.Level.Alert">
  11030. <summary>
  11031. The <see cref="F:log4net.Core.Level.Alert"/> level designates very severe error events.
  11032. Take immediate action, alerts.
  11033. </summary>
  11034. </member>
  11035. <member name="F:log4net.Core.Level.Critical">
  11036. <summary>
  11037. The <see cref="F:log4net.Core.Level.Critical"/> level designates very severe error events.
  11038. Critical condition, critical.
  11039. </summary>
  11040. </member>
  11041. <member name="F:log4net.Core.Level.Severe">
  11042. <summary>
  11043. The <see cref="F:log4net.Core.Level.Severe"/> level designates very severe error events.
  11044. </summary>
  11045. </member>
  11046. <member name="F:log4net.Core.Level.Error">
  11047. <summary>
  11048. The <see cref="F:log4net.Core.Level.Error"/> level designates error events that might
  11049. still allow the application to continue running.
  11050. </summary>
  11051. </member>
  11052. <member name="F:log4net.Core.Level.Warn">
  11053. <summary>
  11054. The <see cref="F:log4net.Core.Level.Warn"/> level designates potentially harmful
  11055. situations.
  11056. </summary>
  11057. </member>
  11058. <member name="F:log4net.Core.Level.Notice">
  11059. <summary>
  11060. The <see cref="F:log4net.Core.Level.Notice"/> level designates informational messages
  11061. that highlight the progress of the application at the highest level.
  11062. </summary>
  11063. </member>
  11064. <member name="F:log4net.Core.Level.Info">
  11065. <summary>
  11066. The <see cref="F:log4net.Core.Level.Info"/> level designates informational messages that
  11067. highlight the progress of the application at coarse-grained level.
  11068. </summary>
  11069. </member>
  11070. <member name="F:log4net.Core.Level.Debug">
  11071. <summary>
  11072. The <see cref="F:log4net.Core.Level.Debug"/> level designates fine-grained informational
  11073. events that are most useful to debug an application.
  11074. </summary>
  11075. </member>
  11076. <member name="F:log4net.Core.Level.Fine">
  11077. <summary>
  11078. The <see cref="F:log4net.Core.Level.Fine"/> level designates fine-grained informational
  11079. events that are most useful to debug an application.
  11080. </summary>
  11081. </member>
  11082. <member name="F:log4net.Core.Level.Trace">
  11083. <summary>
  11084. The <see cref="F:log4net.Core.Level.Trace"/> level designates fine-grained informational
  11085. events that are most useful to debug an application.
  11086. </summary>
  11087. </member>
  11088. <member name="F:log4net.Core.Level.Finer">
  11089. <summary>
  11090. The <see cref="F:log4net.Core.Level.Finer"/> level designates fine-grained informational
  11091. events that are most useful to debug an application.
  11092. </summary>
  11093. </member>
  11094. <member name="F:log4net.Core.Level.Verbose">
  11095. <summary>
  11096. The <see cref="F:log4net.Core.Level.Verbose"/> level designates fine-grained informational
  11097. events that are most useful to debug an application.
  11098. </summary>
  11099. </member>
  11100. <member name="F:log4net.Core.Level.Finest">
  11101. <summary>
  11102. The <see cref="F:log4net.Core.Level.Finest"/> level designates fine-grained informational
  11103. events that are most useful to debug an application.
  11104. </summary>
  11105. </member>
  11106. <member name="F:log4net.Core.Level.All">
  11107. <summary>
  11108. The <see cref="F:log4net.Core.Level.All"/> level designates the lowest level possible.
  11109. </summary>
  11110. </member>
  11111. <member name="P:log4net.Core.Level.Name">
  11112. <summary>
  11113. Gets the name of this level.
  11114. </summary>
  11115. <value>
  11116. The name of this level.
  11117. </value>
  11118. <remarks>
  11119. <para>
  11120. Gets the name of this level.
  11121. </para>
  11122. </remarks>
  11123. </member>
  11124. <member name="P:log4net.Core.Level.Value">
  11125. <summary>
  11126. Gets the value of this level.
  11127. </summary>
  11128. <value>
  11129. The value of this level.
  11130. </value>
  11131. <remarks>
  11132. <para>
  11133. Gets the value of this level.
  11134. </para>
  11135. </remarks>
  11136. </member>
  11137. <member name="P:log4net.Core.Level.DisplayName">
  11138. <summary>
  11139. Gets the display name of this level.
  11140. </summary>
  11141. <value>
  11142. The display name of this level.
  11143. </value>
  11144. <remarks>
  11145. <para>
  11146. Gets the display name of this level.
  11147. </para>
  11148. </remarks>
  11149. </member>
  11150. <member name="T:log4net.Core.LevelCollection">
  11151. <summary>
  11152. A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
  11153. </summary>
  11154. <author>Nicko Cadell</author>
  11155. </member>
  11156. <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
  11157. <summary>
  11158. Creates a read-only wrapper for a <c>LevelCollection</c> instance.
  11159. </summary>
  11160. <param name="list">list to create a readonly wrapper arround</param>
  11161. <returns>
  11162. A <c>LevelCollection</c> wrapper that is read-only.
  11163. </returns>
  11164. </member>
  11165. <member name="M:log4net.Core.LevelCollection.#ctor">
  11166. <summary>
  11167. Initializes a new instance of the <c>LevelCollection</c> class
  11168. that is empty and has the default initial capacity.
  11169. </summary>
  11170. </member>
  11171. <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
  11172. <summary>
  11173. Initializes a new instance of the <c>LevelCollection</c> class
  11174. that has the specified initial capacity.
  11175. </summary>
  11176. <param name="capacity">
  11177. The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
  11178. </param>
  11179. </member>
  11180. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
  11181. <summary>
  11182. Initializes a new instance of the <c>LevelCollection</c> class
  11183. that contains elements copied from the specified <c>LevelCollection</c>.
  11184. </summary>
  11185. <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
  11186. </member>
  11187. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
  11188. <summary>
  11189. Initializes a new instance of the <c>LevelCollection</c> class
  11190. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
  11191. </summary>
  11192. <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
  11193. </member>
  11194. <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
  11195. <summary>
  11196. Initializes a new instance of the <c>LevelCollection</c> class
  11197. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
  11198. </summary>
  11199. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
  11200. </member>
  11201. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
  11202. <summary>
  11203. Allow subclasses to avoid our default constructors
  11204. </summary>
  11205. <param name="tag"></param>
  11206. </member>
  11207. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
  11208. <summary>
  11209. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11210. <see cref="T:log4net.Core.Level"/> array.
  11211. </summary>
  11212. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11213. </member>
  11214. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
  11215. <summary>
  11216. Copies the entire <c>LevelCollection</c> to a one-dimensional
  11217. <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
  11218. </summary>
  11219. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  11220. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  11221. </member>
  11222. <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
  11223. <summary>
  11224. Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
  11225. </summary>
  11226. <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
  11227. <returns>The index at which the value has been added.</returns>
  11228. </member>
  11229. <member name="M:log4net.Core.LevelCollection.Clear">
  11230. <summary>
  11231. Removes all elements from the <c>LevelCollection</c>.
  11232. </summary>
  11233. </member>
  11234. <member name="M:log4net.Core.LevelCollection.Clone">
  11235. <summary>
  11236. Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
  11237. </summary>
  11238. <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
  11239. </member>
  11240. <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
  11241. <summary>
  11242. Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
  11243. </summary>
  11244. <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
  11245. <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
  11246. </member>
  11247. <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
  11248. <summary>
  11249. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
  11250. in the <c>LevelCollection</c>.
  11251. </summary>
  11252. <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
  11253. <returns>
  11254. The zero-based index of the first occurrence of <paramref name="item"/>
  11255. in the entire <c>LevelCollection</c>, if found; otherwise, -1.
  11256. </returns>
  11257. </member>
  11258. <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
  11259. <summary>
  11260. Inserts an element into the <c>LevelCollection</c> at the specified index.
  11261. </summary>
  11262. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  11263. <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
  11264. <exception cref="T:System.ArgumentOutOfRangeException">
  11265. <para><paramref name="index"/> is less than zero</para>
  11266. <para>-or-</para>
  11267. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11268. </exception>
  11269. </member>
  11270. <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
  11271. <summary>
  11272. Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
  11273. </summary>
  11274. <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
  11275. <exception cref="T:System.ArgumentException">
  11276. The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
  11277. </exception>
  11278. </member>
  11279. <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
  11280. <summary>
  11281. Removes the element at the specified index of the <c>LevelCollection</c>.
  11282. </summary>
  11283. <param name="index">The zero-based index of the element to remove.</param>
  11284. <exception cref="T:System.ArgumentOutOfRangeException">
  11285. <para><paramref name="index"/> is less than zero</para>
  11286. <para>-or-</para>
  11287. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11288. </exception>
  11289. </member>
  11290. <member name="M:log4net.Core.LevelCollection.GetEnumerator">
  11291. <summary>
  11292. Returns an enumerator that can iterate through the <c>LevelCollection</c>.
  11293. </summary>
  11294. <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
  11295. </member>
  11296. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
  11297. <summary>
  11298. Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
  11299. </summary>
  11300. <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
  11301. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11302. </member>
  11303. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
  11304. <summary>
  11305. Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
  11306. </summary>
  11307. <param name="x">The <see cref="T:log4net.Core.Level"/> array whose elements should be added to the end of the <c>LevelCollection</c>.</param>
  11308. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11309. </member>
  11310. <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
  11311. <summary>
  11312. Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
  11313. </summary>
  11314. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements should be added to the end of the <c>LevelCollection</c>.</param>
  11315. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  11316. </member>
  11317. <member name="M:log4net.Core.LevelCollection.TrimToSize">
  11318. <summary>
  11319. Sets the capacity to the actual number of elements.
  11320. </summary>
  11321. </member>
  11322. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
  11323. <exception cref="T:System.ArgumentOutOfRangeException">
  11324. <para><paramref name="i"/> is less than zero</para>
  11325. <para>-or-</para>
  11326. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11327. </exception>
  11328. </member>
  11329. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
  11330. <exception cref="T:System.ArgumentOutOfRangeException">
  11331. <para><paramref name="i"/> is less than zero</para>
  11332. <para>-or-</para>
  11333. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11334. </exception>
  11335. </member>
  11336. <member name="P:log4net.Core.LevelCollection.Count">
  11337. <summary>
  11338. Gets the number of elements actually contained in the <c>LevelCollection</c>.
  11339. </summary>
  11340. </member>
  11341. <member name="P:log4net.Core.LevelCollection.IsSynchronized">
  11342. <summary>
  11343. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  11344. </summary>
  11345. <value>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</value>
  11346. </member>
  11347. <member name="P:log4net.Core.LevelCollection.SyncRoot">
  11348. <summary>
  11349. Gets an object that can be used to synchronize access to the collection.
  11350. </summary>
  11351. </member>
  11352. <member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
  11353. <summary>
  11354. Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
  11355. </summary>
  11356. <param name="index">The zero-based index of the element to get or set.</param>
  11357. <exception cref="T:System.ArgumentOutOfRangeException">
  11358. <para><paramref name="index"/> is less than zero</para>
  11359. <para>-or-</para>
  11360. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  11361. </exception>
  11362. </member>
  11363. <member name="P:log4net.Core.LevelCollection.IsFixedSize">
  11364. <summary>
  11365. Gets a value indicating whether the collection has a fixed size.
  11366. </summary>
  11367. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  11368. </member>
  11369. <member name="P:log4net.Core.LevelCollection.IsReadOnly">
  11370. <summary>
  11371. Gets a value indicating whether the IList is read-only.
  11372. </summary>
  11373. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  11374. </member>
  11375. <member name="P:log4net.Core.LevelCollection.Capacity">
  11376. <summary>
  11377. Gets or sets the number of elements the <c>LevelCollection</c> can contain.
  11378. </summary>
  11379. </member>
  11380. <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
  11381. <summary>
  11382. Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11383. </summary>
  11384. </member>
  11385. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
  11386. <summary>
  11387. Advances the enumerator to the next element in the collection.
  11388. </summary>
  11389. <returns>
  11390. <c>true</c> if the enumerator was successfully advanced to the next element;
  11391. <c>false</c> if the enumerator has passed the end of the collection.
  11392. </returns>
  11393. <exception cref="T:System.InvalidOperationException">
  11394. The collection was modified after the enumerator was created.
  11395. </exception>
  11396. </member>
  11397. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
  11398. <summary>
  11399. Sets the enumerator to its initial position, before the first element in the collection.
  11400. </summary>
  11401. </member>
  11402. <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
  11403. <summary>
  11404. Gets the current element in the collection.
  11405. </summary>
  11406. </member>
  11407. <member name="T:log4net.Core.LevelCollection.Tag">
  11408. <summary>
  11409. Type visible only to our subclasses
  11410. Used to access protected constructor
  11411. </summary>
  11412. </member>
  11413. <member name="F:log4net.Core.LevelCollection.Tag.Default">
  11414. <summary>
  11415. A value
  11416. </summary>
  11417. </member>
  11418. <member name="T:log4net.Core.LevelCollection.Enumerator">
  11419. <summary>
  11420. Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  11421. </summary>
  11422. </member>
  11423. <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
  11424. <summary>
  11425. Initializes a new instance of the <c>Enumerator</c> class.
  11426. </summary>
  11427. <param name="tc"></param>
  11428. </member>
  11429. <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
  11430. <summary>
  11431. Advances the enumerator to the next element in the collection.
  11432. </summary>
  11433. <returns>
  11434. <c>true</c> if the enumerator was successfully advanced to the next element;
  11435. <c>false</c> if the enumerator has passed the end of the collection.
  11436. </returns>
  11437. <exception cref="T:System.InvalidOperationException">
  11438. The collection was modified after the enumerator was created.
  11439. </exception>
  11440. </member>
  11441. <member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
  11442. <summary>
  11443. Sets the enumerator to its initial position, before the first element in the collection.
  11444. </summary>
  11445. </member>
  11446. <member name="P:log4net.Core.LevelCollection.Enumerator.Current">
  11447. <summary>
  11448. Gets the current element in the collection.
  11449. </summary>
  11450. </member>
  11451. <member name="T:log4net.Core.LevelEvaluator">
  11452. <summary>
  11453. An evaluator that triggers at a threshold level
  11454. </summary>
  11455. <remarks>
  11456. <para>
  11457. This evaluator will trigger if the level of the event
  11458. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11459. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11460. level.
  11461. </para>
  11462. </remarks>
  11463. <author>Nicko Cadell</author>
  11464. </member>
  11465. <member name="F:log4net.Core.LevelEvaluator.m_threshold">
  11466. <summary>
  11467. The threshold for triggering
  11468. </summary>
  11469. </member>
  11470. <member name="M:log4net.Core.LevelEvaluator.#ctor">
  11471. <summary>
  11472. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11473. </summary>
  11474. <remarks>
  11475. <para>
  11476. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  11477. </para>
  11478. <para>
  11479. This evaluator will trigger if the level of the event
  11480. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11481. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11482. level.
  11483. </para>
  11484. </remarks>
  11485. </member>
  11486. <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
  11487. <summary>
  11488. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11489. </summary>
  11490. <param name="threshold">the threshold to trigger at</param>
  11491. <remarks>
  11492. <para>
  11493. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  11494. </para>
  11495. <para>
  11496. This evaluator will trigger if the level of the event
  11497. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11498. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11499. level.
  11500. </para>
  11501. </remarks>
  11502. </member>
  11503. <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  11504. <summary>
  11505. Is this <paramref name="loggingEvent"/> the triggering event?
  11506. </summary>
  11507. <param name="loggingEvent">The event to check</param>
  11508. <returns>This method returns <c>true</c>, if the event level
  11509. is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
  11510. Otherwise it returns <c>false</c></returns>
  11511. <remarks>
  11512. <para>
  11513. This evaluator will trigger if the level of the event
  11514. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11515. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11516. level.
  11517. </para>
  11518. </remarks>
  11519. </member>
  11520. <member name="P:log4net.Core.LevelEvaluator.Threshold">
  11521. <summary>
  11522. the threshold to trigger at
  11523. </summary>
  11524. <value>
  11525. The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
  11526. </value>
  11527. <remarks>
  11528. <para>
  11529. This evaluator will trigger if the level of the event
  11530. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  11531. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  11532. level.
  11533. </para>
  11534. </remarks>
  11535. </member>
  11536. <member name="T:log4net.Core.LevelMap">
  11537. <summary>
  11538. Mapping between string name and Level object
  11539. </summary>
  11540. <remarks>
  11541. <para>
  11542. Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
  11543. This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
  11544. The level name is case insensitive.
  11545. </para>
  11546. </remarks>
  11547. <author>Nicko Cadell</author>
  11548. </member>
  11549. <member name="F:log4net.Core.LevelMap.m_mapName2Level">
  11550. <summary>
  11551. Mapping from level name to Level object. The
  11552. level name is case insensitive
  11553. </summary>
  11554. </member>
  11555. <member name="M:log4net.Core.LevelMap.#ctor">
  11556. <summary>
  11557. Construct the level map
  11558. </summary>
  11559. <remarks>
  11560. <para>
  11561. Construct the level map.
  11562. </para>
  11563. </remarks>
  11564. </member>
  11565. <member name="M:log4net.Core.LevelMap.Clear">
  11566. <summary>
  11567. Clear the internal maps of all levels
  11568. </summary>
  11569. <remarks>
  11570. <para>
  11571. Clear the internal maps of all levels
  11572. </para>
  11573. </remarks>
  11574. </member>
  11575. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
  11576. <summary>
  11577. Create a new Level and add it to the map
  11578. </summary>
  11579. <param name="name">the string to display for the Level</param>
  11580. <param name="value">the level value to give to the Level</param>
  11581. <remarks>
  11582. <para>
  11583. Create a new Level and add it to the map
  11584. </para>
  11585. </remarks>
  11586. <seealso cref="M:Add(string,int,string)"/>
  11587. </member>
  11588. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
  11589. <summary>
  11590. Create a new Level and add it to the map
  11591. </summary>
  11592. <param name="name">the string to display for the Level</param>
  11593. <param name="value">the level value to give to the Level</param>
  11594. <param name="displayName">the display name to give to the Level</param>
  11595. <remarks>
  11596. <para>
  11597. Create a new Level and add it to the map
  11598. </para>
  11599. </remarks>
  11600. </member>
  11601. <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
  11602. <summary>
  11603. Add a Level to the map
  11604. </summary>
  11605. <param name="level">the Level to add</param>
  11606. <remarks>
  11607. <para>
  11608. Add a Level to the map
  11609. </para>
  11610. </remarks>
  11611. </member>
  11612. <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
  11613. <summary>
  11614. Lookup a named level from the map
  11615. </summary>
  11616. <param name="defaultLevel">the name of the level to lookup is taken from this level.
  11617. If the level is not set on the map then this level is added</param>
  11618. <returns>the level in the map with the name specified</returns>
  11619. <remarks>
  11620. <para>
  11621. Lookup a named level from the map. The name of the level to lookup is taken
  11622. from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
  11623. argument.
  11624. </para>
  11625. <para>
  11626. If no level with the specified name is found then the
  11627. <paramref name="defaultLevel"/> argument is added to the level map
  11628. and returned.
  11629. </para>
  11630. </remarks>
  11631. </member>
  11632. <member name="P:log4net.Core.LevelMap.Item(System.String)">
  11633. <summary>
  11634. Lookup a <see cref="T:log4net.Core.Level"/> by name
  11635. </summary>
  11636. <param name="name">The name of the Level to lookup</param>
  11637. <returns>a Level from the map with the name specified</returns>
  11638. <remarks>
  11639. <para>
  11640. Returns the <see cref="T:log4net.Core.Level"/> from the
  11641. map with the name specified. If the no level is
  11642. found then <c>null</c> is returned.
  11643. </para>
  11644. </remarks>
  11645. </member>
  11646. <member name="P:log4net.Core.LevelMap.AllLevels">
  11647. <summary>
  11648. Return all possible levels as a list of Level objects.
  11649. </summary>
  11650. <returns>all possible levels as a list of Level objects</returns>
  11651. <remarks>
  11652. <para>
  11653. Return all possible levels as a list of Level objects.
  11654. </para>
  11655. </remarks>
  11656. </member>
  11657. <member name="T:log4net.Core.LocationInfo">
  11658. <summary>
  11659. The internal representation of caller location information.
  11660. </summary>
  11661. <remarks>
  11662. <para>
  11663. This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
  11664. a call stack. The caller's information is then extracted from this stack.
  11665. </para>
  11666. <para>
  11667. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  11668. .NET Compact Framework 1.0 therefore caller location information is not
  11669. available on that framework.
  11670. </para>
  11671. <para>
  11672. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  11673. </para>
  11674. <para>
  11675. "StackTrace information will be most informative with Debug build configurations.
  11676. By default, Debug builds include debug symbols, while Release builds do not. The
  11677. debug symbols contain most of the file, method name, line number, and column
  11678. information used in constructing StackFrame and StackTrace objects. StackTrace
  11679. might not report as many method calls as expected, due to code transformations
  11680. that occur during optimization."
  11681. </para>
  11682. <para>
  11683. This means that in a Release build the caller information may be incomplete or may
  11684. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  11685. </para>
  11686. </remarks>
  11687. <author>Nicko Cadell</author>
  11688. <author>Gert Driesen</author>
  11689. </member>
  11690. <member name="F:log4net.Core.LocationInfo.NA">
  11691. <summary>
  11692. When location information is not available the constant
  11693. <c>NA</c> is returned. Current value of this string
  11694. constant is <b>?</b>.
  11695. </summary>
  11696. </member>
  11697. <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
  11698. <summary>
  11699. Constructor
  11700. </summary>
  11701. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11702. the stack boundary into the logging system for this call.</param>
  11703. <remarks>
  11704. <para>
  11705. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
  11706. class based on the current thread.
  11707. </para>
  11708. </remarks>
  11709. </member>
  11710. <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
  11711. <summary>
  11712. Constructor
  11713. </summary>
  11714. <param name="className">The fully qualified class name.</param>
  11715. <param name="methodName">The method name.</param>
  11716. <param name="fileName">The file name.</param>
  11717. <param name="lineNumber">The line number of the method within the file.</param>
  11718. <remarks>
  11719. <para>
  11720. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo"/>
  11721. class with the specified data.
  11722. </para>
  11723. </remarks>
  11724. </member>
  11725. <member name="F:log4net.Core.LocationInfo.declaringType">
  11726. <summary>
  11727. The fully qualified type of the LocationInfo class.
  11728. </summary>
  11729. <remarks>
  11730. Used by the internal logger to record the Type of the
  11731. log message.
  11732. </remarks>
  11733. </member>
  11734. <member name="P:log4net.Core.LocationInfo.ClassName">
  11735. <summary>
  11736. Gets the fully qualified class name of the caller making the logging
  11737. request.
  11738. </summary>
  11739. <value>
  11740. The fully qualified class name of the caller making the logging
  11741. request.
  11742. </value>
  11743. <remarks>
  11744. <para>
  11745. Gets the fully qualified class name of the caller making the logging
  11746. request.
  11747. </para>
  11748. </remarks>
  11749. </member>
  11750. <member name="P:log4net.Core.LocationInfo.FileName">
  11751. <summary>
  11752. Gets the file name of the caller.
  11753. </summary>
  11754. <value>
  11755. The file name of the caller.
  11756. </value>
  11757. <remarks>
  11758. <para>
  11759. Gets the file name of the caller.
  11760. </para>
  11761. </remarks>
  11762. </member>
  11763. <member name="P:log4net.Core.LocationInfo.LineNumber">
  11764. <summary>
  11765. Gets the line number of the caller.
  11766. </summary>
  11767. <value>
  11768. The line number of the caller.
  11769. </value>
  11770. <remarks>
  11771. <para>
  11772. Gets the line number of the caller.
  11773. </para>
  11774. </remarks>
  11775. </member>
  11776. <member name="P:log4net.Core.LocationInfo.MethodName">
  11777. <summary>
  11778. Gets the method name of the caller.
  11779. </summary>
  11780. <value>
  11781. The method name of the caller.
  11782. </value>
  11783. <remarks>
  11784. <para>
  11785. Gets the method name of the caller.
  11786. </para>
  11787. </remarks>
  11788. </member>
  11789. <member name="P:log4net.Core.LocationInfo.FullInfo">
  11790. <summary>
  11791. Gets all available caller information
  11792. </summary>
  11793. <value>
  11794. All available caller information, in the format
  11795. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  11796. </value>
  11797. <remarks>
  11798. <para>
  11799. Gets all available caller information, in the format
  11800. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  11801. </para>
  11802. </remarks>
  11803. </member>
  11804. <member name="P:log4net.Core.LocationInfo.StackFrames">
  11805. <summary>
  11806. Gets the stack frames from the stack trace of the caller making the log request
  11807. </summary>
  11808. </member>
  11809. <member name="T:log4net.Core.LoggerManager">
  11810. <summary>
  11811. Static manager that controls the creation of repositories
  11812. </summary>
  11813. <remarks>
  11814. <para>
  11815. Static manager that controls the creation of repositories
  11816. </para>
  11817. <para>
  11818. This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
  11819. to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
  11820. </para>
  11821. <para>
  11822. This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
  11823. lookup and create repositories. The selector can be set either programmatically using
  11824. the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
  11825. AppSetting in the applications config file to the fully qualified type name of the
  11826. selector to use.
  11827. </para>
  11828. </remarks>
  11829. <author>Nicko Cadell</author>
  11830. <author>Gert Driesen</author>
  11831. </member>
  11832. <member name="M:log4net.Core.LoggerManager.#ctor">
  11833. <summary>
  11834. Private constructor to prevent instances. Only static methods should be used.
  11835. </summary>
  11836. <remarks>
  11837. <para>
  11838. Private constructor to prevent instances. Only static methods should be used.
  11839. </para>
  11840. </remarks>
  11841. </member>
  11842. <member name="M:log4net.Core.LoggerManager.#cctor">
  11843. <summary>
  11844. Hook the shutdown event
  11845. </summary>
  11846. <remarks>
  11847. <para>
  11848. On the full .NET runtime, the static constructor hooks up the
  11849. <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
  11850. These are used to shutdown the log4net system as the application exits.
  11851. </para>
  11852. </remarks>
  11853. </member>
  11854. <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
  11855. <summary>
  11856. Register for ProcessExit and DomainUnload events on the AppDomain
  11857. </summary>
  11858. <remarks>
  11859. <para>
  11860. This needs to be in a separate method because the events make
  11861. a LinkDemand for the ControlAppDomain SecurityPermission. Because
  11862. this is a LinkDemand it is demanded at JIT time. Therefore we cannot
  11863. catch the exception in the method itself, we have to catch it in the
  11864. caller.
  11865. </para>
  11866. </remarks>
  11867. </member>
  11868. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
  11869. <summary>
  11870. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  11871. </summary>
  11872. <param name="repository">the repository to lookup in</param>
  11873. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  11874. <remarks>
  11875. <para>
  11876. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  11877. by the <paramref name="repository"/> argument.
  11878. </para>
  11879. </remarks>
  11880. </member>
  11881. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
  11882. <summary>
  11883. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  11884. </summary>
  11885. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  11886. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  11887. </member>
  11888. <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
  11889. <summary>
  11890. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  11891. </summary>
  11892. <param name="repository">the repository to lookup in</param>
  11893. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  11894. <remarks>
  11895. <para>
  11896. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  11897. by the <paramref name="repository"/> argument.
  11898. </para>
  11899. </remarks>
  11900. </member>
  11901. <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
  11902. <summary>
  11903. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  11904. </summary>
  11905. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  11906. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  11907. <remarks>
  11908. <para>
  11909. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  11910. </para>
  11911. </remarks>
  11912. </member>
  11913. <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
  11914. <summary>
  11915. Returns the named logger if it exists.
  11916. </summary>
  11917. <param name="repository">The repository to lookup in.</param>
  11918. <param name="name">The fully qualified logger name to look for.</param>
  11919. <returns>
  11920. The logger found, or <c>null</c> if the named logger does not exist in the
  11921. specified repository.
  11922. </returns>
  11923. <remarks>
  11924. <para>
  11925. If the named logger exists (in the specified repository) then it
  11926. returns a reference to the logger, otherwise it returns
  11927. <c>null</c>.
  11928. </para>
  11929. </remarks>
  11930. </member>
  11931. <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
  11932. <summary>
  11933. Returns the named logger if it exists.
  11934. </summary>
  11935. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  11936. <param name="name">The fully qualified logger name to look for.</param>
  11937. <returns>
  11938. The logger found, or <c>null</c> if the named logger does not exist in the
  11939. specified assembly's repository.
  11940. </returns>
  11941. <remarks>
  11942. <para>
  11943. If the named logger exists (in the specified assembly's repository) then it
  11944. returns a reference to the logger, otherwise it returns
  11945. <c>null</c>.
  11946. </para>
  11947. </remarks>
  11948. </member>
  11949. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
  11950. <summary>
  11951. Returns all the currently defined loggers in the specified repository.
  11952. </summary>
  11953. <param name="repository">The repository to lookup in.</param>
  11954. <returns>All the defined loggers.</returns>
  11955. <remarks>
  11956. <para>
  11957. The root logger is <b>not</b> included in the returned array.
  11958. </para>
  11959. </remarks>
  11960. </member>
  11961. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
  11962. <summary>
  11963. Returns all the currently defined loggers in the specified assembly's repository.
  11964. </summary>
  11965. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  11966. <returns>All the defined loggers.</returns>
  11967. <remarks>
  11968. <para>
  11969. The root logger is <b>not</b> included in the returned array.
  11970. </para>
  11971. </remarks>
  11972. </member>
  11973. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
  11974. <summary>
  11975. Retrieves or creates a named logger.
  11976. </summary>
  11977. <param name="repository">The repository to lookup in.</param>
  11978. <param name="name">The name of the logger to retrieve.</param>
  11979. <returns>The logger with the name specified.</returns>
  11980. <remarks>
  11981. <para>
  11982. Retrieves a logger named as the <paramref name="name"/>
  11983. parameter. If the named logger already exists, then the
  11984. existing instance will be returned. Otherwise, a new instance is
  11985. created.
  11986. </para>
  11987. <para>
  11988. By default, loggers do not have a set level but inherit
  11989. it from the hierarchy. This is one of the central features of
  11990. log4net.
  11991. </para>
  11992. </remarks>
  11993. </member>
  11994. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
  11995. <summary>
  11996. Retrieves or creates a named logger.
  11997. </summary>
  11998. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  11999. <param name="name">The name of the logger to retrieve.</param>
  12000. <returns>The logger with the name specified.</returns>
  12001. <remarks>
  12002. <para>
  12003. Retrieves a logger named as the <paramref name="name"/>
  12004. parameter. If the named logger already exists, then the
  12005. existing instance will be returned. Otherwise, a new instance is
  12006. created.
  12007. </para>
  12008. <para>
  12009. By default, loggers do not have a set level but inherit
  12010. it from the hierarchy. This is one of the central features of
  12011. log4net.
  12012. </para>
  12013. </remarks>
  12014. </member>
  12015. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
  12016. <summary>
  12017. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12018. </summary>
  12019. <param name="repository">The repository to lookup in.</param>
  12020. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12021. <returns>The logger with the name specified.</returns>
  12022. <remarks>
  12023. <para>
  12024. Gets the logger for the fully qualified name of the type specified.
  12025. </para>
  12026. </remarks>
  12027. </member>
  12028. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
  12029. <summary>
  12030. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  12031. </summary>
  12032. <param name="repositoryAssembly">the assembly to use to lookup the repository</param>
  12033. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  12034. <returns>The logger with the name specified.</returns>
  12035. <remarks>
  12036. <para>
  12037. Gets the logger for the fully qualified name of the type specified.
  12038. </para>
  12039. </remarks>
  12040. </member>
  12041. <member name="M:log4net.Core.LoggerManager.Shutdown">
  12042. <summary>
  12043. Shuts down the log4net system.
  12044. </summary>
  12045. <remarks>
  12046. <para>
  12047. Calling this method will <b>safely</b> close and remove all
  12048. appenders in all the loggers including root contained in all the
  12049. default repositories.
  12050. </para>
  12051. <para>
  12052. Some appenders need to be closed before the application exists.
  12053. Otherwise, pending logging events might be lost.
  12054. </para>
  12055. <para>
  12056. The <c>shutdown</c> method is careful to close nested
  12057. appenders before closing regular appenders. This is allows
  12058. configurations where a regular appender is attached to a logger
  12059. and again to a nested appender.
  12060. </para>
  12061. </remarks>
  12062. </member>
  12063. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
  12064. <summary>
  12065. Shuts down the repository for the repository specified.
  12066. </summary>
  12067. <param name="repository">The repository to shutdown.</param>
  12068. <remarks>
  12069. <para>
  12070. Calling this method will <b>safely</b> close and remove all
  12071. appenders in all the loggers including root contained in the
  12072. repository for the <paramref name="repository"/> specified.
  12073. </para>
  12074. <para>
  12075. Some appenders need to be closed before the application exists.
  12076. Otherwise, pending logging events might be lost.
  12077. </para>
  12078. <para>
  12079. The <c>shutdown</c> method is careful to close nested
  12080. appenders before closing regular appenders. This is allows
  12081. configurations where a regular appender is attached to a logger
  12082. and again to a nested appender.
  12083. </para>
  12084. </remarks>
  12085. </member>
  12086. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
  12087. <summary>
  12088. Shuts down the repository for the repository specified.
  12089. </summary>
  12090. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  12091. <remarks>
  12092. <para>
  12093. Calling this method will <b>safely</b> close and remove all
  12094. appenders in all the loggers including root contained in the
  12095. repository for the repository. The repository is looked up using
  12096. the <paramref name="repositoryAssembly"/> specified.
  12097. </para>
  12098. <para>
  12099. Some appenders need to be closed before the application exists.
  12100. Otherwise, pending logging events might be lost.
  12101. </para>
  12102. <para>
  12103. The <c>shutdown</c> method is careful to close nested
  12104. appenders before closing regular appenders. This is allows
  12105. configurations where a regular appender is attached to a logger
  12106. and again to a nested appender.
  12107. </para>
  12108. </remarks>
  12109. </member>
  12110. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
  12111. <summary>
  12112. Resets all values contained in this repository instance to their defaults.
  12113. </summary>
  12114. <param name="repository">The repository to reset.</param>
  12115. <remarks>
  12116. <para>
  12117. Resets all values contained in the repository instance to their
  12118. defaults. This removes all appenders from all loggers, sets
  12119. the level of all non-root loggers to <c>null</c>,
  12120. sets their additivity flag to <c>true</c> and sets the level
  12121. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12122. message disabling is set its default "off" value.
  12123. </para>
  12124. </remarks>
  12125. </member>
  12126. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
  12127. <summary>
  12128. Resets all values contained in this repository instance to their defaults.
  12129. </summary>
  12130. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  12131. <remarks>
  12132. <para>
  12133. Resets all values contained in the repository instance to their
  12134. defaults. This removes all appenders from all loggers, sets
  12135. the level of all non-root loggers to <c>null</c>,
  12136. sets their additivity flag to <c>true</c> and sets the level
  12137. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  12138. message disabling is set its default "off" value.
  12139. </para>
  12140. </remarks>
  12141. </member>
  12142. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
  12143. <summary>
  12144. Creates a repository with the specified name.
  12145. </summary>
  12146. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12147. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12148. <remarks>
  12149. <para>
  12150. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12151. </para>
  12152. <para>
  12153. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12154. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12155. </para>
  12156. <para>
  12157. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12158. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12159. </para>
  12160. </remarks>
  12161. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12162. </member>
  12163. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
  12164. <summary>
  12165. Creates a repository with the specified name.
  12166. </summary>
  12167. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  12168. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12169. <remarks>
  12170. <para>
  12171. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  12172. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  12173. </para>
  12174. <para>
  12175. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12176. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  12177. </para>
  12178. </remarks>
  12179. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12180. </member>
  12181. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
  12182. <summary>
  12183. Creates a repository with the specified name and repository type.
  12184. </summary>
  12185. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12186. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12187. and has a no arg constructor. An instance of this type will be created to act
  12188. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12189. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12190. <remarks>
  12191. <para>
  12192. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12193. </para>
  12194. <para>
  12195. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12196. An Exception will be thrown if the repository already exists.
  12197. </para>
  12198. </remarks>
  12199. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12200. </member>
  12201. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
  12202. <summary>
  12203. Creates a repository with the specified name and repository type.
  12204. </summary>
  12205. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  12206. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12207. and has a no arg constructor. An instance of this type will be created to act
  12208. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12209. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12210. <remarks>
  12211. <para>
  12212. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  12213. An Exception will be thrown if the repository already exists.
  12214. </para>
  12215. </remarks>
  12216. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  12217. </member>
  12218. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  12219. <summary>
  12220. Creates a repository for the specified assembly and repository type.
  12221. </summary>
  12222. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12223. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12224. and has a no arg constructor. An instance of this type will be created to act
  12225. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12226. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12227. <remarks>
  12228. <para>
  12229. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  12230. </para>
  12231. <para>
  12232. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12233. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12234. same assembly specified will return the same repository instance.
  12235. </para>
  12236. </remarks>
  12237. </member>
  12238. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  12239. <summary>
  12240. Creates a repository for the specified assembly and repository type.
  12241. </summary>
  12242. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  12243. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  12244. and has a no arg constructor. An instance of this type will be created to act
  12245. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  12246. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  12247. <remarks>
  12248. <para>
  12249. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  12250. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  12251. same assembly specified will return the same repository instance.
  12252. </para>
  12253. </remarks>
  12254. </member>
  12255. <member name="M:log4net.Core.LoggerManager.GetAllRepositories">
  12256. <summary>
  12257. Gets an array of all currently defined repositories.
  12258. </summary>
  12259. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  12260. <remarks>
  12261. <para>
  12262. Gets an array of all currently defined repositories.
  12263. </para>
  12264. </remarks>
  12265. </member>
  12266. <member name="M:log4net.Core.LoggerManager.GetVersionInfo">
  12267. <summary>
  12268. Internal method to get pertinent version info.
  12269. </summary>
  12270. <returns>A string of version info.</returns>
  12271. </member>
  12272. <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
  12273. <summary>
  12274. Called when the <see cref="F:System.AppDomain.DomainUnload"/> event fires
  12275. </summary>
  12276. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12277. <param name="e">null</param>
  12278. <remarks>
  12279. <para>
  12280. Called when the <see cref="F:System.AppDomain.DomainUnload"/> event fires.
  12281. </para>
  12282. <para>
  12283. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12284. </para>
  12285. </remarks>
  12286. </member>
  12287. <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
  12288. <summary>
  12289. Called when the <see cref="F:System.AppDomain.ProcessExit"/> event fires
  12290. </summary>
  12291. <param name="sender">the <see cref="T:System.AppDomain"/> that is exiting</param>
  12292. <param name="e">null</param>
  12293. <remarks>
  12294. <para>
  12295. Called when the <see cref="F:System.AppDomain.ProcessExit"/> event fires.
  12296. </para>
  12297. <para>
  12298. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  12299. </para>
  12300. </remarks>
  12301. </member>
  12302. <member name="F:log4net.Core.LoggerManager.declaringType">
  12303. <summary>
  12304. The fully qualified type of the LoggerManager class.
  12305. </summary>
  12306. <remarks>
  12307. Used by the internal logger to record the Type of the
  12308. log message.
  12309. </remarks>
  12310. </member>
  12311. <member name="F:log4net.Core.LoggerManager.s_repositorySelector">
  12312. <summary>
  12313. Initialize the default repository selector
  12314. </summary>
  12315. </member>
  12316. <member name="P:log4net.Core.LoggerManager.RepositorySelector">
  12317. <summary>
  12318. Gets or sets the repository selector used by the <see cref="T:log4net.LogManager"/>.
  12319. </summary>
  12320. <value>
  12321. The repository selector used by the <see cref="T:log4net.LogManager"/>.
  12322. </value>
  12323. <remarks>
  12324. <para>
  12325. The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
  12326. the <see cref="T:log4net.LogManager"/> to create and select repositories
  12327. (<see cref="T:log4net.Repository.ILoggerRepository"/>).
  12328. </para>
  12329. <para>
  12330. The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
  12331. or an assembly (if not supplied the assembly is inferred using
  12332. <see cref="M:Assembly.GetCallingAssembly()"/>).
  12333. </para>
  12334. <para>
  12335. This context is used by the selector to lookup a specific repository.
  12336. </para>
  12337. <para>
  12338. For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
  12339. for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
  12340. repository.
  12341. </para>
  12342. </remarks>
  12343. </member>
  12344. <member name="T:log4net.Core.LoggerWrapperImpl">
  12345. <summary>
  12346. Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
  12347. </summary>
  12348. <remarks>
  12349. <para>
  12350. This class should be used as the base for all wrapper implementations.
  12351. </para>
  12352. </remarks>
  12353. <author>Nicko Cadell</author>
  12354. <author>Gert Driesen</author>
  12355. </member>
  12356. <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
  12357. <summary>
  12358. Constructs a new wrapper for the specified logger.
  12359. </summary>
  12360. <param name="logger">The logger to wrap.</param>
  12361. <remarks>
  12362. <para>
  12363. Constructs a new wrapper for the specified logger.
  12364. </para>
  12365. </remarks>
  12366. </member>
  12367. <member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
  12368. <summary>
  12369. The logger that this object is wrapping
  12370. </summary>
  12371. </member>
  12372. <member name="P:log4net.Core.LoggerWrapperImpl.Logger">
  12373. <summary>
  12374. Gets the implementation behind this wrapper object.
  12375. </summary>
  12376. <value>
  12377. The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
  12378. </value>
  12379. <remarks>
  12380. <para>
  12381. The <c>Logger</c> object may not be the same object as this object
  12382. because of logger decorators.
  12383. </para>
  12384. <para>
  12385. This gets the actual underlying objects that is used to process
  12386. the log events.
  12387. </para>
  12388. </remarks>
  12389. </member>
  12390. <member name="T:log4net.Core.LoggingEventData">
  12391. <summary>
  12392. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12393. </summary>
  12394. <remarks>
  12395. <para>
  12396. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  12397. </para>
  12398. </remarks>
  12399. <author>Nicko Cadell</author>
  12400. </member>
  12401. <member name="F:log4net.Core.LoggingEventData.LoggerName">
  12402. <summary>
  12403. The logger name.
  12404. </summary>
  12405. <remarks>
  12406. <para>
  12407. The logger name.
  12408. </para>
  12409. </remarks>
  12410. </member>
  12411. <member name="F:log4net.Core.LoggingEventData.Level">
  12412. <summary>
  12413. Level of logging event.
  12414. </summary>
  12415. <remarks>
  12416. <para>
  12417. Level of logging event. Level cannot be Serializable
  12418. because it is a flyweight. Due to its special serialization it
  12419. cannot be declared final either.
  12420. </para>
  12421. </remarks>
  12422. </member>
  12423. <member name="F:log4net.Core.LoggingEventData.Message">
  12424. <summary>
  12425. The application supplied message.
  12426. </summary>
  12427. <remarks>
  12428. <para>
  12429. The application supplied message of logging event.
  12430. </para>
  12431. </remarks>
  12432. </member>
  12433. <member name="F:log4net.Core.LoggingEventData.ThreadName">
  12434. <summary>
  12435. The name of thread
  12436. </summary>
  12437. <remarks>
  12438. <para>
  12439. The name of thread in which this logging event was generated
  12440. </para>
  12441. </remarks>
  12442. </member>
  12443. <member name="F:log4net.Core.LoggingEventData.TimeStamp">
  12444. <summary>
  12445. The time the event was logged
  12446. </summary>
  12447. <remarks>
  12448. <para>
  12449. The TimeStamp is stored in the local time zone for this computer.
  12450. </para>
  12451. </remarks>
  12452. </member>
  12453. <member name="F:log4net.Core.LoggingEventData.LocationInfo">
  12454. <summary>
  12455. Location information for the caller.
  12456. </summary>
  12457. <remarks>
  12458. <para>
  12459. Location information for the caller.
  12460. </para>
  12461. </remarks>
  12462. </member>
  12463. <member name="F:log4net.Core.LoggingEventData.UserName">
  12464. <summary>
  12465. String representation of the user
  12466. </summary>
  12467. <remarks>
  12468. <para>
  12469. String representation of the user's windows name,
  12470. like DOMAIN\username
  12471. </para>
  12472. </remarks>
  12473. </member>
  12474. <member name="F:log4net.Core.LoggingEventData.Identity">
  12475. <summary>
  12476. String representation of the identity.
  12477. </summary>
  12478. <remarks>
  12479. <para>
  12480. String representation of the current thread's principal identity.
  12481. </para>
  12482. </remarks>
  12483. </member>
  12484. <member name="F:log4net.Core.LoggingEventData.ExceptionString">
  12485. <summary>
  12486. The string representation of the exception
  12487. </summary>
  12488. <remarks>
  12489. <para>
  12490. The string representation of the exception
  12491. </para>
  12492. </remarks>
  12493. </member>
  12494. <member name="F:log4net.Core.LoggingEventData.Domain">
  12495. <summary>
  12496. String representation of the AppDomain.
  12497. </summary>
  12498. <remarks>
  12499. <para>
  12500. String representation of the AppDomain.
  12501. </para>
  12502. </remarks>
  12503. </member>
  12504. <member name="F:log4net.Core.LoggingEventData.Properties">
  12505. <summary>
  12506. Additional event specific properties
  12507. </summary>
  12508. <remarks>
  12509. <para>
  12510. A logger or an appender may attach additional
  12511. properties to specific events. These properties
  12512. have a string key and an object value.
  12513. </para>
  12514. </remarks>
  12515. </member>
  12516. <member name="T:log4net.Core.FixFlags">
  12517. <summary>
  12518. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12519. </summary>
  12520. <remarks>
  12521. <para>
  12522. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  12523. </para>
  12524. </remarks>
  12525. <author>Nicko Cadell</author>
  12526. </member>
  12527. <member name="F:log4net.Core.FixFlags.Mdc">
  12528. <summary>
  12529. Fix the MDC
  12530. </summary>
  12531. </member>
  12532. <member name="F:log4net.Core.FixFlags.Ndc">
  12533. <summary>
  12534. Fix the NDC
  12535. </summary>
  12536. </member>
  12537. <member name="F:log4net.Core.FixFlags.Message">
  12538. <summary>
  12539. Fix the rendered message
  12540. </summary>
  12541. </member>
  12542. <member name="F:log4net.Core.FixFlags.ThreadName">
  12543. <summary>
  12544. Fix the thread name
  12545. </summary>
  12546. </member>
  12547. <member name="F:log4net.Core.FixFlags.LocationInfo">
  12548. <summary>
  12549. Fix the callers location information
  12550. </summary>
  12551. <remarks>
  12552. CAUTION: Very slow to generate
  12553. </remarks>
  12554. </member>
  12555. <member name="F:log4net.Core.FixFlags.UserName">
  12556. <summary>
  12557. Fix the callers windows user name
  12558. </summary>
  12559. <remarks>
  12560. CAUTION: Slow to generate
  12561. </remarks>
  12562. </member>
  12563. <member name="F:log4net.Core.FixFlags.Domain">
  12564. <summary>
  12565. Fix the domain friendly name
  12566. </summary>
  12567. </member>
  12568. <member name="F:log4net.Core.FixFlags.Identity">
  12569. <summary>
  12570. Fix the callers principal name
  12571. </summary>
  12572. <remarks>
  12573. CAUTION: May be slow to generate
  12574. </remarks>
  12575. </member>
  12576. <member name="F:log4net.Core.FixFlags.Exception">
  12577. <summary>
  12578. Fix the exception text
  12579. </summary>
  12580. </member>
  12581. <member name="F:log4net.Core.FixFlags.Properties">
  12582. <summary>
  12583. Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
  12584. </summary>
  12585. </member>
  12586. <member name="F:log4net.Core.FixFlags.None">
  12587. <summary>
  12588. No fields fixed
  12589. </summary>
  12590. </member>
  12591. <member name="F:log4net.Core.FixFlags.All">
  12592. <summary>
  12593. All fields fixed
  12594. </summary>
  12595. </member>
  12596. <member name="F:log4net.Core.FixFlags.Partial">
  12597. <summary>
  12598. Partial fields fixed
  12599. </summary>
  12600. <remarks>
  12601. <para>
  12602. This set of partial fields gives good performance. The following fields are fixed:
  12603. </para>
  12604. <list type="bullet">
  12605. <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
  12606. <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
  12607. <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
  12608. <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
  12609. <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
  12610. </list>
  12611. </remarks>
  12612. </member>
  12613. <member name="T:log4net.Core.LoggingEvent">
  12614. <summary>
  12615. The internal representation of logging events.
  12616. </summary>
  12617. <remarks>
  12618. <para>
  12619. When an affirmative decision is made to log then a
  12620. <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
  12621. is passed around to the different log4net components.
  12622. </para>
  12623. <para>
  12624. This class is of concern to those wishing to extend log4net.
  12625. </para>
  12626. <para>
  12627. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  12628. are considered volatile, that is the values are correct at the
  12629. time the event is delivered to appenders, but will not be consistent
  12630. at any time afterwards. If an event is to be stored and then processed
  12631. at a later time these volatile values must be fixed by calling
  12632. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  12633. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  12634. is essential to maintaining data consistency.
  12635. </para>
  12636. </remarks>
  12637. <author>Nicko Cadell</author>
  12638. <author>Gert Driesen</author>
  12639. <author>Douglas de la Torre</author>
  12640. <author>Daniel Cazzulino</author>
  12641. </member>
  12642. <member name="F:log4net.Core.LoggingEvent.HostNameProperty">
  12643. <summary>
  12644. The key into the Properties map for the host name value.
  12645. </summary>
  12646. </member>
  12647. <member name="F:log4net.Core.LoggingEvent.IdentityProperty">
  12648. <summary>
  12649. The key into the Properties map for the thread identity value.
  12650. </summary>
  12651. </member>
  12652. <member name="F:log4net.Core.LoggingEvent.UserNameProperty">
  12653. <summary>
  12654. The key into the Properties map for the user name value.
  12655. </summary>
  12656. </member>
  12657. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
  12658. <summary>
  12659. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  12660. from the supplied parameters.
  12661. </summary>
  12662. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12663. the stack boundary into the logging system for this call.</param>
  12664. <param name="repository">The repository this event is logged in.</param>
  12665. <param name="loggerName">The name of the logger of this event.</param>
  12666. <param name="level">The level of this event.</param>
  12667. <param name="message">The message of this event.</param>
  12668. <param name="exception">The exception for this event.</param>
  12669. <remarks>
  12670. <para>
  12671. Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
  12672. all fields of <c>LoggingEvent</c> are filled when actually needed. Call
  12673. <see cref="M:FixVolatileData()"/> to cache all data locally
  12674. to prevent inconsistencies.
  12675. </para>
  12676. <para>This method is called by the log4net framework
  12677. to create a logging event.
  12678. </para>
  12679. </remarks>
  12680. </member>
  12681. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
  12682. <summary>
  12683. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  12684. using specific data.
  12685. </summary>
  12686. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12687. the stack boundary into the logging system for this call.</param>
  12688. <param name="repository">The repository this event is logged in.</param>
  12689. <param name="data">Data used to initialize the logging event.</param>
  12690. <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
  12691. <remarks>
  12692. <para>
  12693. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  12694. to be created independently of the log4net framework. This can
  12695. be useful if you require a custom serialization scheme.
  12696. </para>
  12697. <para>
  12698. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  12699. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  12700. </para>
  12701. <para>
  12702. The <paramref name="fixedData"/> parameter should be used to specify which fields in the
  12703. <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
  12704. will be captured from the environment if requested or fixed.
  12705. </para>
  12706. </remarks>
  12707. </member>
  12708. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
  12709. <summary>
  12710. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  12711. using specific data.
  12712. </summary>
  12713. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  12714. the stack boundary into the logging system for this call.</param>
  12715. <param name="repository">The repository this event is logged in.</param>
  12716. <param name="data">Data used to initialize the logging event.</param>
  12717. <remarks>
  12718. <para>
  12719. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  12720. to be created independently of the log4net framework. This can
  12721. be useful if you require a custom serialization scheme.
  12722. </para>
  12723. <para>
  12724. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  12725. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  12726. </para>
  12727. <para>
  12728. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  12729. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  12730. parameter and no other data should be captured from the environment.
  12731. </para>
  12732. </remarks>
  12733. </member>
  12734. <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
  12735. <summary>
  12736. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  12737. using specific data.
  12738. </summary>
  12739. <param name="data">Data used to initialize the logging event.</param>
  12740. <remarks>
  12741. <para>
  12742. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent"/>
  12743. to be created independently of the log4net framework. This can
  12744. be useful if you require a custom serialization scheme.
  12745. </para>
  12746. <para>
  12747. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  12748. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  12749. </para>
  12750. <para>
  12751. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  12752. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  12753. parameter and no other data should be captured from the environment.
  12754. </para>
  12755. </remarks>
  12756. </member>
  12757. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12758. <summary>
  12759. Serialization constructor
  12760. </summary>
  12761. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  12762. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  12763. <remarks>
  12764. <para>
  12765. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent"/> class
  12766. with serialized data.
  12767. </para>
  12768. </remarks>
  12769. </member>
  12770. <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
  12771. <summary>
  12772. Ensure that the repository is set.
  12773. </summary>
  12774. <param name="repository">the value for the repository</param>
  12775. </member>
  12776. <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
  12777. <summary>
  12778. Write the rendered message to a TextWriter
  12779. </summary>
  12780. <param name="writer">the writer to write the message to</param>
  12781. <remarks>
  12782. <para>
  12783. Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
  12784. does store the message data in the internal cache. Therefore
  12785. if called only once this method should be faster than the
  12786. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
  12787. to be accessed multiple times then the property will be more efficient.
  12788. </para>
  12789. </remarks>
  12790. </member>
  12791. <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  12792. <summary>
  12793. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  12794. </summary>
  12795. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
  12796. <param name="context">The destination for this serialization.</param>
  12797. <remarks>
  12798. <para>
  12799. The data in this event must be fixed before it can be serialized.
  12800. </para>
  12801. <para>
  12802. The <see cref="M:FixVolatileData()"/> method must be called during the
  12803. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
  12804. is to be used outside that method.
  12805. </para>
  12806. </remarks>
  12807. </member>
  12808. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
  12809. <summary>
  12810. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
  12811. </summary>
  12812. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  12813. <remarks>
  12814. <para>
  12815. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  12816. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  12817. </para>
  12818. <para>
  12819. Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
  12820. in the logging event before returning the event data.
  12821. </para>
  12822. </remarks>
  12823. </member>
  12824. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
  12825. <summary>
  12826. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent"/>.
  12827. </summary>
  12828. <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
  12829. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  12830. <remarks>
  12831. <para>
  12832. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  12833. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  12834. </para>
  12835. </remarks>
  12836. </member>
  12837. <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
  12838. <summary>
  12839. Returns this event's exception's rendered using the
  12840. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  12841. </summary>
  12842. <returns>
  12843. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  12844. </returns>
  12845. <remarks>
  12846. <para>
  12847. <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
  12848. </para>
  12849. </remarks>
  12850. </member>
  12851. <member name="M:log4net.Core.LoggingEvent.GetExceptionString">
  12852. <summary>
  12853. Returns this event's exception's rendered using the
  12854. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  12855. </summary>
  12856. <returns>
  12857. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  12858. </returns>
  12859. <remarks>
  12860. <para>
  12861. Returns this event's exception's rendered using the
  12862. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  12863. </para>
  12864. </remarks>
  12865. </member>
  12866. <member name="M:log4net.Core.LoggingEvent.FixVolatileData">
  12867. <summary>
  12868. Fix instance fields that hold volatile data.
  12869. </summary>
  12870. <remarks>
  12871. <para>
  12872. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  12873. are considered volatile, that is the values are correct at the
  12874. time the event is delivered to appenders, but will not be consistent
  12875. at any time afterwards. If an event is to be stored and then processed
  12876. at a later time these volatile values must be fixed by calling
  12877. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  12878. incurred by calling <see cref="M:FixVolatileData()"/> but it
  12879. is essential to maintaining data consistency.
  12880. </para>
  12881. <para>
  12882. Calling <see cref="M:FixVolatileData()"/> is equivalent to
  12883. calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
  12884. <c>false</c>.
  12885. </para>
  12886. <para>
  12887. See <see cref="M:FixVolatileData(bool)"/> for more
  12888. information.
  12889. </para>
  12890. </remarks>
  12891. </member>
  12892. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
  12893. <summary>
  12894. Fixes instance fields that hold volatile data.
  12895. </summary>
  12896. <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
  12897. <remarks>
  12898. <para>
  12899. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  12900. are considered volatile, that is the values are correct at the
  12901. time the event is delivered to appenders, but will not be consistent
  12902. at any time afterwards. If an event is to be stored and then processed
  12903. at a later time these volatile values must be fixed by calling
  12904. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  12905. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  12906. is essential to maintaining data consistency.
  12907. </para>
  12908. <para>
  12909. The <paramref name="fastButLoose"/> param controls the data that
  12910. is fixed. Some of the data that can be fixed takes a long time to
  12911. generate, therefore if you do not require those settings to be fixed
  12912. they can be ignored by setting the <paramref name="fastButLoose"/> param
  12913. to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
  12914. and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
  12915. </para>
  12916. <para>
  12917. Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
  12918. settings are fixed.
  12919. </para>
  12920. </remarks>
  12921. </member>
  12922. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
  12923. <summary>
  12924. Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
  12925. </summary>
  12926. <param name="flags">the fields to fix</param>
  12927. <remarks>
  12928. <para>
  12929. Only fields specified in the <paramref name="flags"/> will be fixed.
  12930. Fields will not be fixed if they have previously been fixed.
  12931. It is not possible to 'unfix' a field.
  12932. </para>
  12933. </remarks>
  12934. </member>
  12935. <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
  12936. <summary>
  12937. Lookup a composite property in this event
  12938. </summary>
  12939. <param name="key">the key for the property to lookup</param>
  12940. <returns>the value for the property</returns>
  12941. <remarks>
  12942. <para>
  12943. This event has composite properties that combine together properties from
  12944. several different contexts in the following order:
  12945. <list type="definition">
  12946. <item>
  12947. <term>this events properties</term>
  12948. <description>
  12949. This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  12950. properties are specific to this event only.
  12951. </description>
  12952. </item>
  12953. <item>
  12954. <term>the thread properties</term>
  12955. <description>
  12956. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  12957. thread. These properties are shared by all events logged on this thread.
  12958. </description>
  12959. </item>
  12960. <item>
  12961. <term>the global properties</term>
  12962. <description>
  12963. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  12964. properties are shared by all the threads in the AppDomain.
  12965. </description>
  12966. </item>
  12967. </list>
  12968. </para>
  12969. </remarks>
  12970. </member>
  12971. <member name="M:log4net.Core.LoggingEvent.GetProperties">
  12972. <summary>
  12973. Get all the composite properties in this event
  12974. </summary>
  12975. <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
  12976. <remarks>
  12977. <para>
  12978. See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
  12979. stored by the event.
  12980. </para>
  12981. <para>
  12982. This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
  12983. properties defined for this event.
  12984. </para>
  12985. </remarks>
  12986. </member>
  12987. <member name="F:log4net.Core.LoggingEvent.m_data">
  12988. <summary>
  12989. The internal logging event data.
  12990. </summary>
  12991. </member>
  12992. <member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
  12993. <summary>
  12994. The internal logging event data.
  12995. </summary>
  12996. </member>
  12997. <member name="F:log4net.Core.LoggingEvent.m_eventProperties">
  12998. <summary>
  12999. The internal logging event data.
  13000. </summary>
  13001. </member>
  13002. <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
  13003. <summary>
  13004. The fully qualified Type of the calling
  13005. logger class in the stack frame (i.e. the declaring type of the method).
  13006. </summary>
  13007. </member>
  13008. <member name="F:log4net.Core.LoggingEvent.m_message">
  13009. <summary>
  13010. The application supplied message of logging event.
  13011. </summary>
  13012. </member>
  13013. <member name="F:log4net.Core.LoggingEvent.m_thrownException">
  13014. <summary>
  13015. The exception that was thrown.
  13016. </summary>
  13017. <remarks>
  13018. This is not serialized. The string representation
  13019. is serialized instead.
  13020. </remarks>
  13021. </member>
  13022. <member name="F:log4net.Core.LoggingEvent.m_repository">
  13023. <summary>
  13024. The repository that generated the logging event
  13025. </summary>
  13026. <remarks>
  13027. This is not serialized.
  13028. </remarks>
  13029. </member>
  13030. <member name="F:log4net.Core.LoggingEvent.m_fixFlags">
  13031. <summary>
  13032. The fix state for this event
  13033. </summary>
  13034. <remarks>
  13035. These flags indicate which fields have been fixed.
  13036. Not serialized.
  13037. </remarks>
  13038. </member>
  13039. <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
  13040. <summary>
  13041. Indicated that the internal cache is updateable (ie not fixed)
  13042. </summary>
  13043. <remarks>
  13044. This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
  13045. changes in the caching strategy.
  13046. </remarks>
  13047. </member>
  13048. <member name="P:log4net.Core.LoggingEvent.StartTime">
  13049. <summary>
  13050. Gets the time when the current process started.
  13051. </summary>
  13052. <value>
  13053. This is the time when this process started.
  13054. </value>
  13055. <remarks>
  13056. <para>
  13057. The TimeStamp is stored in the local time zone for this computer.
  13058. </para>
  13059. <para>
  13060. Tries to get the start time for the current process.
  13061. Failing that it returns the time of the first call to
  13062. this property.
  13063. </para>
  13064. <para>
  13065. Note that AppDomains may be loaded and unloaded within the
  13066. same process without the process terminating and therefore
  13067. without the process start time being reset.
  13068. </para>
  13069. </remarks>
  13070. </member>
  13071. <member name="P:log4net.Core.LoggingEvent.Level">
  13072. <summary>
  13073. Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13074. </summary>
  13075. <value>
  13076. The <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13077. </value>
  13078. <remarks>
  13079. <para>
  13080. Gets the <see cref="P:log4net.Core.LoggingEvent.Level"/> of the logging event.
  13081. </para>
  13082. </remarks>
  13083. </member>
  13084. <member name="P:log4net.Core.LoggingEvent.TimeStamp">
  13085. <summary>
  13086. Gets the time of the logging event.
  13087. </summary>
  13088. <value>
  13089. The time of the logging event.
  13090. </value>
  13091. <remarks>
  13092. <para>
  13093. The TimeStamp is stored in the local time zone for this computer.
  13094. </para>
  13095. </remarks>
  13096. </member>
  13097. <member name="P:log4net.Core.LoggingEvent.LoggerName">
  13098. <summary>
  13099. Gets the name of the logger that logged the event.
  13100. </summary>
  13101. <value>
  13102. The name of the logger that logged the event.
  13103. </value>
  13104. <remarks>
  13105. <para>
  13106. Gets the name of the logger that logged the event.
  13107. </para>
  13108. </remarks>
  13109. </member>
  13110. <member name="P:log4net.Core.LoggingEvent.LocationInformation">
  13111. <summary>
  13112. Gets the location information for this logging event.
  13113. </summary>
  13114. <value>
  13115. The location information for this logging event.
  13116. </value>
  13117. <remarks>
  13118. <para>
  13119. The collected information is cached for future use.
  13120. </para>
  13121. <para>
  13122. See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
  13123. supported frameworks and the different behavior in Debug and
  13124. Release builds.
  13125. </para>
  13126. </remarks>
  13127. </member>
  13128. <member name="P:log4net.Core.LoggingEvent.MessageObject">
  13129. <summary>
  13130. Gets the message object used to initialize this event.
  13131. </summary>
  13132. <value>
  13133. The message object used to initialize this event.
  13134. </value>
  13135. <remarks>
  13136. <para>
  13137. Gets the message object used to initialize this event.
  13138. Note that this event may not have a valid message object.
  13139. If the event is serialized the message object will not
  13140. be transferred. To get the text of the message the
  13141. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
  13142. not this property.
  13143. </para>
  13144. <para>
  13145. If there is no defined message object for this event then
  13146. null will be returned.
  13147. </para>
  13148. </remarks>
  13149. </member>
  13150. <member name="P:log4net.Core.LoggingEvent.ExceptionObject">
  13151. <summary>
  13152. Gets the exception object used to initialize this event.
  13153. </summary>
  13154. <value>
  13155. The exception object used to initialize this event.
  13156. </value>
  13157. <remarks>
  13158. <para>
  13159. Gets the exception object used to initialize this event.
  13160. Note that this event may not have a valid exception object.
  13161. If the event is serialized the exception object will not
  13162. be transferred. To get the text of the exception the
  13163. <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
  13164. not this property.
  13165. </para>
  13166. <para>
  13167. If there is no defined exception object for this event then
  13168. null will be returned.
  13169. </para>
  13170. </remarks>
  13171. </member>
  13172. <member name="P:log4net.Core.LoggingEvent.Repository">
  13173. <summary>
  13174. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13175. </summary>
  13176. <remarks>
  13177. <para>
  13178. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  13179. </para>
  13180. </remarks>
  13181. </member>
  13182. <member name="P:log4net.Core.LoggingEvent.RenderedMessage">
  13183. <summary>
  13184. Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13185. </summary>
  13186. <value>
  13187. The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap"/>.
  13188. </value>
  13189. <remarks>
  13190. <para>
  13191. The collected information is cached for future use.
  13192. </para>
  13193. </remarks>
  13194. </member>
  13195. <member name="P:log4net.Core.LoggingEvent.ThreadName">
  13196. <summary>
  13197. Gets the name of the current thread.
  13198. </summary>
  13199. <value>
  13200. The name of the current thread, or the thread ID when
  13201. the name is not available.
  13202. </value>
  13203. <remarks>
  13204. <para>
  13205. The collected information is cached for future use.
  13206. </para>
  13207. </remarks>
  13208. </member>
  13209. <member name="P:log4net.Core.LoggingEvent.UserName">
  13210. <summary>
  13211. Gets the name of the current user.
  13212. </summary>
  13213. <value>
  13214. The name of the current user, or <c>NOT AVAILABLE</c> when the
  13215. underlying runtime has no support for retrieving the name of the
  13216. current user.
  13217. </value>
  13218. <remarks>
  13219. <para>
  13220. Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
  13221. the current windows user.
  13222. </para>
  13223. <para>
  13224. To improve performance, we could cache the string representation of
  13225. the name, and reuse that as long as the identity stayed constant.
  13226. Once the identity changed, we would need to re-assign and re-render
  13227. the string.
  13228. </para>
  13229. <para>
  13230. However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
  13231. return different objects every time, so the current implementation
  13232. doesn't do this type of caching.
  13233. </para>
  13234. <para>
  13235. Timing for these operations:
  13236. </para>
  13237. <list type="table">
  13238. <listheader>
  13239. <term>Method</term>
  13240. <description>Results</description>
  13241. </listheader>
  13242. <item>
  13243. <term><c>WindowsIdentity.GetCurrent()</c></term>
  13244. <description>10000 loops, 00:00:00.2031250 seconds</description>
  13245. </item>
  13246. <item>
  13247. <term><c>WindowsIdentity.GetCurrent().Name</c></term>
  13248. <description>10000 loops, 00:00:08.0468750 seconds</description>
  13249. </item>
  13250. </list>
  13251. <para>
  13252. This means we could speed things up almost 40 times by caching the
  13253. value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
  13254. this takes (8.04-0.20) = 7.84375 seconds.
  13255. </para>
  13256. </remarks>
  13257. </member>
  13258. <member name="P:log4net.Core.LoggingEvent.Identity">
  13259. <summary>
  13260. Gets the identity of the current thread principal.
  13261. </summary>
  13262. <value>
  13263. The string name of the identity of the current thread principal.
  13264. </value>
  13265. <remarks>
  13266. <para>
  13267. Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
  13268. the name of the current thread principal.
  13269. </para>
  13270. </remarks>
  13271. </member>
  13272. <member name="P:log4net.Core.LoggingEvent.Domain">
  13273. <summary>
  13274. Gets the AppDomain friendly name.
  13275. </summary>
  13276. <value>
  13277. The AppDomain friendly name.
  13278. </value>
  13279. <remarks>
  13280. <para>
  13281. Gets the AppDomain friendly name.
  13282. </para>
  13283. </remarks>
  13284. </member>
  13285. <member name="P:log4net.Core.LoggingEvent.Properties">
  13286. <summary>
  13287. Additional event specific properties.
  13288. </summary>
  13289. <value>
  13290. Additional event specific properties.
  13291. </value>
  13292. <remarks>
  13293. <para>
  13294. A logger or an appender may attach additional
  13295. properties to specific events. These properties
  13296. have a string key and an object value.
  13297. </para>
  13298. <para>
  13299. This property is for events that have been added directly to
  13300. this event. The aggregate properties (which include these
  13301. event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
  13302. and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
  13303. </para>
  13304. <para>
  13305. Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
  13306. returns the combined cached properties. This ensures that updates to
  13307. this property are always reflected in the underlying storage. When
  13308. returning the combined properties there may be more keys in the
  13309. Dictionary than expected.
  13310. </para>
  13311. </remarks>
  13312. </member>
  13313. <member name="P:log4net.Core.LoggingEvent.Fix">
  13314. <summary>
  13315. The fixed fields in this event
  13316. </summary>
  13317. <value>
  13318. The set of fields that are fixed in this event
  13319. </value>
  13320. <remarks>
  13321. <para>
  13322. Fields will not be fixed if they have previously been fixed.
  13323. It is not possible to 'unfix' a field.
  13324. </para>
  13325. </remarks>
  13326. </member>
  13327. <member name="T:log4net.Core.LogImpl">
  13328. <summary>
  13329. Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
  13330. </summary>
  13331. <remarks>
  13332. <para>
  13333. This implementation of the <see cref="T:log4net.ILog"/> interface
  13334. forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
  13335. </para>
  13336. <para>
  13337. This logger has methods to allow the caller to log at the following
  13338. levels:
  13339. </para>
  13340. <list type="definition">
  13341. <item>
  13342. <term>DEBUG</term>
  13343. <description>
  13344. The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
  13345. at the <c>DEBUG</c> level. That is the level with that name defined in the
  13346. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13347. for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  13348. property tests if this level is enabled for logging.
  13349. </description>
  13350. </item>
  13351. <item>
  13352. <term>INFO</term>
  13353. <description>
  13354. The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
  13355. at the <c>INFO</c> level. That is the level with that name defined in the
  13356. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13357. for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
  13358. property tests if this level is enabled for logging.
  13359. </description>
  13360. </item>
  13361. <item>
  13362. <term>WARN</term>
  13363. <description>
  13364. The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
  13365. at the <c>WARN</c> level. That is the level with that name defined in the
  13366. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13367. for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
  13368. property tests if this level is enabled for logging.
  13369. </description>
  13370. </item>
  13371. <item>
  13372. <term>ERROR</term>
  13373. <description>
  13374. The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
  13375. at the <c>ERROR</c> level. That is the level with that name defined in the
  13376. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13377. for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
  13378. property tests if this level is enabled for logging.
  13379. </description>
  13380. </item>
  13381. <item>
  13382. <term>FATAL</term>
  13383. <description>
  13384. The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
  13385. at the <c>FATAL</c> level. That is the level with that name defined in the
  13386. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  13387. for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
  13388. property tests if this level is enabled for logging.
  13389. </description>
  13390. </item>
  13391. </list>
  13392. <para>
  13393. The values for these levels and their semantic meanings can be changed by
  13394. configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
  13395. </para>
  13396. </remarks>
  13397. <author>Nicko Cadell</author>
  13398. <author>Gert Driesen</author>
  13399. </member>
  13400. <member name="T:log4net.ILog">
  13401. <summary>
  13402. The ILog interface is use by application to log messages into
  13403. the log4net framework.
  13404. </summary>
  13405. <remarks>
  13406. <para>
  13407. Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
  13408. that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
  13409. static method is used to get logger instances.
  13410. </para>
  13411. <para>
  13412. This class contains methods for logging at different levels and also
  13413. has properties for determining if those logging levels are
  13414. enabled in the current configuration.
  13415. </para>
  13416. <para>
  13417. This interface can be implemented in different ways. This documentation
  13418. specifies reasonable behavior that a caller can expect from the actual
  13419. implementation, however different implementations reserve the right to
  13420. do things differently.
  13421. </para>
  13422. </remarks>
  13423. <example>Simple example of logging messages
  13424. <code lang="C#">
  13425. ILog log = LogManager.GetLogger("application-log");
  13426. log.Info("Application Start");
  13427. log.Debug("This is a debug message");
  13428. if (log.IsDebugEnabled)
  13429. {
  13430. log.Debug("This is another debug message");
  13431. }
  13432. </code>
  13433. </example>
  13434. <seealso cref="T:log4net.LogManager"/>
  13435. <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
  13436. <author>Nicko Cadell</author>
  13437. <author>Gert Driesen</author>
  13438. </member>
  13439. <member name="M:log4net.ILog.Debug(System.Object)">
  13440. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  13441. <summary>
  13442. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13443. </summary>
  13444. <param name="message">The message object to log.</param>
  13445. <remarks>
  13446. <para>
  13447. This method first checks if this logger is <c>DEBUG</c>
  13448. enabled by comparing the level of this logger with the
  13449. <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
  13450. <c>DEBUG</c> enabled, then it converts the message object
  13451. (passed as parameter) to a string by invoking the appropriate
  13452. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13453. proceeds to call all the registered appenders in this logger
  13454. and also higher in the hierarchy depending on the value of
  13455. the additivity flag.
  13456. </para>
  13457. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13458. to this method will print the name of the <see cref="T:System.Exception"/>
  13459. but no stack trace. To print a stack trace use the
  13460. <see cref="M:Debug(object,Exception)"/> form instead.
  13461. </para>
  13462. </remarks>
  13463. <seealso cref="M:Debug(object,Exception)"/>
  13464. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13465. </member>
  13466. <member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
  13467. <summary>
  13468. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  13469. the stack trace of the <see cref="T:System.Exception"/> passed
  13470. as a parameter.
  13471. </summary>
  13472. <param name="message">The message object to log.</param>
  13473. <param name="exception">The exception to log, including its stack trace.</param>
  13474. <remarks>
  13475. <para>
  13476. See the <see cref="M:Debug(object)"/> form for more detailed information.
  13477. </para>
  13478. </remarks>
  13479. <seealso cref="M:Debug(object)"/>
  13480. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13481. </member>
  13482. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
  13483. <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  13484. <summary>
  13485. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13486. </summary>
  13487. <param name="format">A String containing zero or more format items</param>
  13488. <param name="args">An Object array containing zero or more objects to format</param>
  13489. <remarks>
  13490. <para>
  13491. The message is formatted using the <c>String.Format</c> method. See
  13492. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13493. of the formatting.
  13494. </para>
  13495. <para>
  13496. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13497. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13498. methods instead.
  13499. </para>
  13500. </remarks>
  13501. <seealso cref="M:Debug(object)"/>
  13502. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13503. </member>
  13504. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
  13505. <summary>
  13506. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13507. </summary>
  13508. <param name="format">A String containing zero or more format items</param>
  13509. <param name="arg0">An Object to format</param>
  13510. <remarks>
  13511. <para>
  13512. The message is formatted using the <c>String.Format</c> method. See
  13513. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13514. of the formatting.
  13515. </para>
  13516. <para>
  13517. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13518. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13519. methods instead.
  13520. </para>
  13521. </remarks>
  13522. <seealso cref="M:Debug(object)"/>
  13523. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13524. </member>
  13525. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
  13526. <summary>
  13527. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13528. </summary>
  13529. <param name="format">A String containing zero or more format items</param>
  13530. <param name="arg0">An Object to format</param>
  13531. <param name="arg1">An Object to format</param>
  13532. <remarks>
  13533. <para>
  13534. The message is formatted using the <c>String.Format</c> method. See
  13535. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13536. of the formatting.
  13537. </para>
  13538. <para>
  13539. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13540. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13541. methods instead.
  13542. </para>
  13543. </remarks>
  13544. <seealso cref="M:Debug(object)"/>
  13545. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13546. </member>
  13547. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  13548. <summary>
  13549. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13550. </summary>
  13551. <param name="format">A String containing zero or more format items</param>
  13552. <param name="arg0">An Object to format</param>
  13553. <param name="arg1">An Object to format</param>
  13554. <param name="arg2">An Object to format</param>
  13555. <remarks>
  13556. <para>
  13557. The message is formatted using the <c>String.Format</c> method. See
  13558. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13559. of the formatting.
  13560. </para>
  13561. <para>
  13562. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13563. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13564. methods instead.
  13565. </para>
  13566. </remarks>
  13567. <seealso cref="M:Debug(object)"/>
  13568. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13569. </member>
  13570. <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  13571. <summary>
  13572. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  13573. </summary>
  13574. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  13575. <param name="format">A String containing zero or more format items</param>
  13576. <param name="args">An Object array containing zero or more objects to format</param>
  13577. <remarks>
  13578. <para>
  13579. The message is formatted using the <c>String.Format</c> method. See
  13580. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13581. of the formatting.
  13582. </para>
  13583. <para>
  13584. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13585. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  13586. methods instead.
  13587. </para>
  13588. </remarks>
  13589. <seealso cref="M:Debug(object)"/>
  13590. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  13591. </member>
  13592. <member name="M:log4net.ILog.Info(System.Object)">
  13593. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  13594. <summary>
  13595. Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  13596. </summary>
  13597. <remarks>
  13598. <para>
  13599. This method first checks if this logger is <c>INFO</c>
  13600. enabled by comparing the level of this logger with the
  13601. <see cref="F:log4net.Core.Level.Info"/> level. If this logger is
  13602. <c>INFO</c> enabled, then it converts the message object
  13603. (passed as parameter) to a string by invoking the appropriate
  13604. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13605. proceeds to call all the registered appenders in this logger
  13606. and also higher in the hierarchy depending on the value of the
  13607. additivity flag.
  13608. </para>
  13609. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13610. to this method will print the name of the <see cref="T:System.Exception"/>
  13611. but no stack trace. To print a stack trace use the
  13612. <see cref="M:Info(object,Exception)"/> form instead.
  13613. </para>
  13614. </remarks>
  13615. <param name="message">The message object to log.</param>
  13616. <seealso cref="M:Info(object,Exception)"/>
  13617. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  13618. </member>
  13619. <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
  13620. <summary>
  13621. Logs a message object with the <c>INFO</c> level including
  13622. the stack trace of the <see cref="T:System.Exception"/> passed
  13623. as a parameter.
  13624. </summary>
  13625. <param name="message">The message object to log.</param>
  13626. <param name="exception">The exception to log, including its stack trace.</param>
  13627. <remarks>
  13628. <para>
  13629. See the <see cref="M:Info(object)"/> form for more detailed information.
  13630. </para>
  13631. </remarks>
  13632. <seealso cref="M:Info(object)"/>
  13633. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  13634. </member>
  13635. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
  13636. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  13637. <summary>
  13638. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  13639. </summary>
  13640. <param name="format">A String containing zero or more format items</param>
  13641. <param name="args">An Object array containing zero or more objects to format</param>
  13642. <remarks>
  13643. <para>
  13644. The message is formatted using the <c>String.Format</c> method. See
  13645. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13646. of the formatting.
  13647. </para>
  13648. <para>
  13649. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13650. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  13651. methods instead.
  13652. </para>
  13653. </remarks>
  13654. <seealso cref="M:Info(object,Exception)"/>
  13655. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  13656. </member>
  13657. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
  13658. <summary>
  13659. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  13660. </summary>
  13661. <param name="format">A String containing zero or more format items</param>
  13662. <param name="arg0">An Object to format</param>
  13663. <remarks>
  13664. <para>
  13665. The message is formatted using the <c>String.Format</c> method. See
  13666. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13667. of the formatting.
  13668. </para>
  13669. <para>
  13670. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13671. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  13672. methods instead.
  13673. </para>
  13674. </remarks>
  13675. <seealso cref="M:Info(object)"/>
  13676. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  13677. </member>
  13678. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
  13679. <summary>
  13680. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  13681. </summary>
  13682. <param name="format">A String containing zero or more format items</param>
  13683. <param name="arg0">An Object to format</param>
  13684. <param name="arg1">An Object to format</param>
  13685. <remarks>
  13686. <para>
  13687. The message is formatted using the <c>String.Format</c> method. See
  13688. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13689. of the formatting.
  13690. </para>
  13691. <para>
  13692. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13693. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  13694. methods instead.
  13695. </para>
  13696. </remarks>
  13697. <seealso cref="M:Info(object)"/>
  13698. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  13699. </member>
  13700. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  13701. <summary>
  13702. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  13703. </summary>
  13704. <param name="format">A String containing zero or more format items</param>
  13705. <param name="arg0">An Object to format</param>
  13706. <param name="arg1">An Object to format</param>
  13707. <param name="arg2">An Object to format</param>
  13708. <remarks>
  13709. <para>
  13710. The message is formatted using the <c>String.Format</c> method. See
  13711. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13712. of the formatting.
  13713. </para>
  13714. <para>
  13715. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13716. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  13717. methods instead.
  13718. </para>
  13719. </remarks>
  13720. <seealso cref="M:Info(object)"/>
  13721. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  13722. </member>
  13723. <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  13724. <summary>
  13725. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  13726. </summary>
  13727. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  13728. <param name="format">A String containing zero or more format items</param>
  13729. <param name="args">An Object array containing zero or more objects to format</param>
  13730. <remarks>
  13731. <para>
  13732. The message is formatted using the <c>String.Format</c> method. See
  13733. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13734. of the formatting.
  13735. </para>
  13736. <para>
  13737. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13738. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  13739. methods instead.
  13740. </para>
  13741. </remarks>
  13742. <seealso cref="M:Info(object,Exception)"/>
  13743. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  13744. </member>
  13745. <member name="M:log4net.ILog.Warn(System.Object)">
  13746. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  13747. <summary>
  13748. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  13749. </summary>
  13750. <remarks>
  13751. <para>
  13752. This method first checks if this logger is <c>WARN</c>
  13753. enabled by comparing the level of this logger with the
  13754. <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
  13755. <c>WARN</c> enabled, then it converts the message object
  13756. (passed as parameter) to a string by invoking the appropriate
  13757. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13758. proceeds to call all the registered appenders in this logger
  13759. and also higher in the hierarchy depending on the value of the
  13760. additivity flag.
  13761. </para>
  13762. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13763. to this method will print the name of the <see cref="T:System.Exception"/>
  13764. but no stack trace. To print a stack trace use the
  13765. <see cref="M:Warn(object,Exception)"/> form instead.
  13766. </para>
  13767. </remarks>
  13768. <param name="message">The message object to log.</param>
  13769. <seealso cref="M:Warn(object,Exception)"/>
  13770. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  13771. </member>
  13772. <member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
  13773. <summary>
  13774. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  13775. the stack trace of the <see cref="T:System.Exception"/> passed
  13776. as a parameter.
  13777. </summary>
  13778. <param name="message">The message object to log.</param>
  13779. <param name="exception">The exception to log, including its stack trace.</param>
  13780. <remarks>
  13781. <para>
  13782. See the <see cref="M:Warn(object)"/> form for more detailed information.
  13783. </para>
  13784. </remarks>
  13785. <seealso cref="M:Warn(object)"/>
  13786. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  13787. </member>
  13788. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
  13789. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  13790. <summary>
  13791. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  13792. </summary>
  13793. <param name="format">A String containing zero or more format items</param>
  13794. <param name="args">An Object array containing zero or more objects to format</param>
  13795. <remarks>
  13796. <para>
  13797. The message is formatted using the <c>String.Format</c> method. See
  13798. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13799. of the formatting.
  13800. </para>
  13801. <para>
  13802. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13803. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  13804. methods instead.
  13805. </para>
  13806. </remarks>
  13807. <seealso cref="M:Warn(object,Exception)"/>
  13808. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  13809. </member>
  13810. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
  13811. <summary>
  13812. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  13813. </summary>
  13814. <param name="format">A String containing zero or more format items</param>
  13815. <param name="arg0">An Object to format</param>
  13816. <remarks>
  13817. <para>
  13818. The message is formatted using the <c>String.Format</c> method. See
  13819. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13820. of the formatting.
  13821. </para>
  13822. <para>
  13823. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13824. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  13825. methods instead.
  13826. </para>
  13827. </remarks>
  13828. <seealso cref="M:Warn(object)"/>
  13829. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  13830. </member>
  13831. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
  13832. <summary>
  13833. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  13834. </summary>
  13835. <param name="format">A String containing zero or more format items</param>
  13836. <param name="arg0">An Object to format</param>
  13837. <param name="arg1">An Object to format</param>
  13838. <remarks>
  13839. <para>
  13840. The message is formatted using the <c>String.Format</c> method. See
  13841. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13842. of the formatting.
  13843. </para>
  13844. <para>
  13845. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13846. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  13847. methods instead.
  13848. </para>
  13849. </remarks>
  13850. <seealso cref="M:Warn(object)"/>
  13851. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  13852. </member>
  13853. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  13854. <summary>
  13855. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  13856. </summary>
  13857. <param name="format">A String containing zero or more format items</param>
  13858. <param name="arg0">An Object to format</param>
  13859. <param name="arg1">An Object to format</param>
  13860. <param name="arg2">An Object to format</param>
  13861. <remarks>
  13862. <para>
  13863. The message is formatted using the <c>String.Format</c> method. See
  13864. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13865. of the formatting.
  13866. </para>
  13867. <para>
  13868. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13869. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  13870. methods instead.
  13871. </para>
  13872. </remarks>
  13873. <seealso cref="M:Warn(object)"/>
  13874. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  13875. </member>
  13876. <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  13877. <summary>
  13878. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  13879. </summary>
  13880. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  13881. <param name="format">A String containing zero or more format items</param>
  13882. <param name="args">An Object array containing zero or more objects to format</param>
  13883. <remarks>
  13884. <para>
  13885. The message is formatted using the <c>String.Format</c> method. See
  13886. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13887. of the formatting.
  13888. </para>
  13889. <para>
  13890. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13891. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  13892. methods instead.
  13893. </para>
  13894. </remarks>
  13895. <seealso cref="M:Warn(object,Exception)"/>
  13896. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  13897. </member>
  13898. <member name="M:log4net.ILog.Error(System.Object)">
  13899. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  13900. <summary>
  13901. Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  13902. </summary>
  13903. <param name="message">The message object to log.</param>
  13904. <remarks>
  13905. <para>
  13906. This method first checks if this logger is <c>ERROR</c>
  13907. enabled by comparing the level of this logger with the
  13908. <see cref="F:log4net.Core.Level.Error"/> level. If this logger is
  13909. <c>ERROR</c> enabled, then it converts the message object
  13910. (passed as parameter) to a string by invoking the appropriate
  13911. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  13912. proceeds to call all the registered appenders in this logger
  13913. and also higher in the hierarchy depending on the value of the
  13914. additivity flag.
  13915. </para>
  13916. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  13917. to this method will print the name of the <see cref="T:System.Exception"/>
  13918. but no stack trace. To print a stack trace use the
  13919. <see cref="M:Error(object,Exception)"/> form instead.
  13920. </para>
  13921. </remarks>
  13922. <seealso cref="M:Error(object,Exception)"/>
  13923. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  13924. </member>
  13925. <member name="M:log4net.ILog.Error(System.Object,System.Exception)">
  13926. <summary>
  13927. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  13928. the stack trace of the <see cref="T:System.Exception"/> passed
  13929. as a parameter.
  13930. </summary>
  13931. <param name="message">The message object to log.</param>
  13932. <param name="exception">The exception to log, including its stack trace.</param>
  13933. <remarks>
  13934. <para>
  13935. See the <see cref="M:Error(object)"/> form for more detailed information.
  13936. </para>
  13937. </remarks>
  13938. <seealso cref="M:Error(object)"/>
  13939. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  13940. </member>
  13941. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
  13942. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  13943. <summary>
  13944. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  13945. </summary>
  13946. <param name="format">A String containing zero or more format items</param>
  13947. <param name="args">An Object array containing zero or more objects to format</param>
  13948. <remarks>
  13949. <para>
  13950. The message is formatted using the <c>String.Format</c> method. See
  13951. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13952. of the formatting.
  13953. </para>
  13954. <para>
  13955. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13956. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  13957. methods instead.
  13958. </para>
  13959. </remarks>
  13960. <seealso cref="M:Error(object,Exception)"/>
  13961. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  13962. </member>
  13963. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
  13964. <summary>
  13965. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  13966. </summary>
  13967. <param name="format">A String containing zero or more format items</param>
  13968. <param name="arg0">An Object to format</param>
  13969. <remarks>
  13970. <para>
  13971. The message is formatted using the <c>String.Format</c> method. See
  13972. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13973. of the formatting.
  13974. </para>
  13975. <para>
  13976. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13977. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  13978. methods instead.
  13979. </para>
  13980. </remarks>
  13981. <seealso cref="M:Error(object)"/>
  13982. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  13983. </member>
  13984. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
  13985. <summary>
  13986. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  13987. </summary>
  13988. <param name="format">A String containing zero or more format items</param>
  13989. <param name="arg0">An Object to format</param>
  13990. <param name="arg1">An Object to format</param>
  13991. <remarks>
  13992. <para>
  13993. The message is formatted using the <c>String.Format</c> method. See
  13994. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  13995. of the formatting.
  13996. </para>
  13997. <para>
  13998. This method does not take an <see cref="T:System.Exception"/> object to include in the
  13999. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14000. methods instead.
  14001. </para>
  14002. </remarks>
  14003. <seealso cref="M:Error(object)"/>
  14004. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14005. </member>
  14006. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  14007. <summary>
  14008. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14009. </summary>
  14010. <param name="format">A String containing zero or more format items</param>
  14011. <param name="arg0">An Object to format</param>
  14012. <param name="arg1">An Object to format</param>
  14013. <param name="arg2">An Object to format</param>
  14014. <remarks>
  14015. <para>
  14016. The message is formatted using the <c>String.Format</c> method. See
  14017. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14018. of the formatting.
  14019. </para>
  14020. <para>
  14021. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14022. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14023. methods instead.
  14024. </para>
  14025. </remarks>
  14026. <seealso cref="M:Error(object)"/>
  14027. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14028. </member>
  14029. <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  14030. <summary>
  14031. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14032. </summary>
  14033. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14034. <param name="format">A String containing zero or more format items</param>
  14035. <param name="args">An Object array containing zero or more objects to format</param>
  14036. <remarks>
  14037. <para>
  14038. The message is formatted using the <c>String.Format</c> method. See
  14039. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14040. of the formatting.
  14041. </para>
  14042. <para>
  14043. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14044. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14045. methods instead.
  14046. </para>
  14047. </remarks>
  14048. <seealso cref="M:Error(object,Exception)"/>
  14049. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14050. </member>
  14051. <member name="M:log4net.ILog.Fatal(System.Object)">
  14052. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  14053. <summary>
  14054. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14055. </summary>
  14056. <remarks>
  14057. <para>
  14058. This method first checks if this logger is <c>FATAL</c>
  14059. enabled by comparing the level of this logger with the
  14060. <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
  14061. <c>FATAL</c> enabled, then it converts the message object
  14062. (passed as parameter) to a string by invoking the appropriate
  14063. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14064. proceeds to call all the registered appenders in this logger
  14065. and also higher in the hierarchy depending on the value of the
  14066. additivity flag.
  14067. </para>
  14068. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14069. to this method will print the name of the <see cref="T:System.Exception"/>
  14070. but no stack trace. To print a stack trace use the
  14071. <see cref="M:Fatal(object,Exception)"/> form instead.
  14072. </para>
  14073. </remarks>
  14074. <param name="message">The message object to log.</param>
  14075. <seealso cref="M:Fatal(object,Exception)"/>
  14076. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14077. </member>
  14078. <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
  14079. <summary>
  14080. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  14081. the stack trace of the <see cref="T:System.Exception"/> passed
  14082. as a parameter.
  14083. </summary>
  14084. <param name="message">The message object to log.</param>
  14085. <param name="exception">The exception to log, including its stack trace.</param>
  14086. <remarks>
  14087. <para>
  14088. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  14089. </para>
  14090. </remarks>
  14091. <seealso cref="M:Fatal(object)"/>
  14092. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14093. </member>
  14094. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
  14095. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  14096. <summary>
  14097. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14098. </summary>
  14099. <param name="format">A String containing zero or more format items</param>
  14100. <param name="args">An Object array containing zero or more objects to format</param>
  14101. <remarks>
  14102. <para>
  14103. The message is formatted using the <c>String.Format</c> method. See
  14104. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14105. of the formatting.
  14106. </para>
  14107. <para>
  14108. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14109. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14110. methods instead.
  14111. </para>
  14112. </remarks>
  14113. <seealso cref="M:Fatal(object,Exception)"/>
  14114. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14115. </member>
  14116. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
  14117. <summary>
  14118. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14119. </summary>
  14120. <param name="format">A String containing zero or more format items</param>
  14121. <param name="arg0">An Object to format</param>
  14122. <remarks>
  14123. <para>
  14124. The message is formatted using the <c>String.Format</c> method. See
  14125. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14126. of the formatting.
  14127. </para>
  14128. <para>
  14129. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14130. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14131. methods instead.
  14132. </para>
  14133. </remarks>
  14134. <seealso cref="M:Fatal(object)"/>
  14135. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14136. </member>
  14137. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
  14138. <summary>
  14139. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14140. </summary>
  14141. <param name="format">A String containing zero or more format items</param>
  14142. <param name="arg0">An Object to format</param>
  14143. <param name="arg1">An Object to format</param>
  14144. <remarks>
  14145. <para>
  14146. The message is formatted using the <c>String.Format</c> method. See
  14147. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14148. of the formatting.
  14149. </para>
  14150. <para>
  14151. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14152. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14153. methods instead.
  14154. </para>
  14155. </remarks>
  14156. <seealso cref="M:Fatal(object)"/>
  14157. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14158. </member>
  14159. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  14160. <summary>
  14161. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14162. </summary>
  14163. <param name="format">A String containing zero or more format items</param>
  14164. <param name="arg0">An Object to format</param>
  14165. <param name="arg1">An Object to format</param>
  14166. <param name="arg2">An Object to format</param>
  14167. <remarks>
  14168. <para>
  14169. The message is formatted using the <c>String.Format</c> method. See
  14170. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14171. of the formatting.
  14172. </para>
  14173. <para>
  14174. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14175. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  14176. methods instead.
  14177. </para>
  14178. </remarks>
  14179. <seealso cref="M:Fatal(object)"/>
  14180. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14181. </member>
  14182. <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  14183. <summary>
  14184. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14185. </summary>
  14186. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14187. <param name="format">A String containing zero or more format items</param>
  14188. <param name="args">An Object array containing zero or more objects to format</param>
  14189. <remarks>
  14190. <para>
  14191. The message is formatted using the <c>String.Format</c> method. See
  14192. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14193. of the formatting.
  14194. </para>
  14195. <para>
  14196. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14197. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  14198. methods instead.
  14199. </para>
  14200. </remarks>
  14201. <seealso cref="M:Fatal(object,Exception)"/>
  14202. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  14203. </member>
  14204. <member name="P:log4net.ILog.IsDebugEnabled">
  14205. <summary>
  14206. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
  14207. </summary>
  14208. <value>
  14209. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
  14210. </value>
  14211. <remarks>
  14212. <para>
  14213. This function is intended to lessen the computational cost of
  14214. disabled log debug statements.
  14215. </para>
  14216. <para> For some ILog interface <c>log</c>, when you write:</para>
  14217. <code lang="C#">
  14218. log.Debug("This is entry number: " + i );
  14219. </code>
  14220. <para>
  14221. You incur the cost constructing the message, string construction and concatenation in
  14222. this case, regardless of whether the message is logged or not.
  14223. </para>
  14224. <para>
  14225. If you are worried about speed (who isn't), then you should write:
  14226. </para>
  14227. <code lang="C#">
  14228. if (log.IsDebugEnabled)
  14229. {
  14230. log.Debug("This is entry number: " + i );
  14231. }
  14232. </code>
  14233. <para>
  14234. This way you will not incur the cost of parameter
  14235. construction if debugging is disabled for <c>log</c>. On
  14236. the other hand, if the <c>log</c> is debug enabled, you
  14237. will incur the cost of evaluating whether the logger is debug
  14238. enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
  14239. the <see cref="M:Debug(object)"/>. This is an insignificant overhead
  14240. since evaluating a logger takes about 1% of the time it
  14241. takes to actually log. This is the preferred style of logging.
  14242. </para>
  14243. <para>Alternatively if your logger is available statically then the is debug
  14244. enabled state can be stored in a static variable like this:
  14245. </para>
  14246. <code lang="C#">
  14247. private static readonly bool isDebugEnabled = log.IsDebugEnabled;
  14248. </code>
  14249. <para>
  14250. Then when you come to log you can write:
  14251. </para>
  14252. <code lang="C#">
  14253. if (isDebugEnabled)
  14254. {
  14255. log.Debug("This is entry number: " + i );
  14256. }
  14257. </code>
  14258. <para>
  14259. This way the debug enabled state is only queried once
  14260. when the class is loaded. Using a <c>private static readonly</c>
  14261. variable is the most efficient because it is a run time constant
  14262. and can be heavily optimized by the JIT compiler.
  14263. </para>
  14264. <para>
  14265. Of course if you use a static readonly variable to
  14266. hold the enabled state of the logger then you cannot
  14267. change the enabled state at runtime to vary the logging
  14268. that is produced. You have to decide if you need absolute
  14269. speed or runtime flexibility.
  14270. </para>
  14271. </remarks>
  14272. <seealso cref="M:Debug(object)"/>
  14273. <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
  14274. </member>
  14275. <member name="P:log4net.ILog.IsInfoEnabled">
  14276. <summary>
  14277. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
  14278. </summary>
  14279. <value>
  14280. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
  14281. </value>
  14282. <remarks>
  14283. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14284. </remarks>
  14285. <seealso cref="M:Info(object)"/>
  14286. <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
  14287. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14288. </member>
  14289. <member name="P:log4net.ILog.IsWarnEnabled">
  14290. <summary>
  14291. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
  14292. </summary>
  14293. <value>
  14294. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
  14295. </value>
  14296. <remarks>
  14297. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14298. </remarks>
  14299. <seealso cref="M:Warn(object)"/>
  14300. <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
  14301. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14302. </member>
  14303. <member name="P:log4net.ILog.IsErrorEnabled">
  14304. <summary>
  14305. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
  14306. </summary>
  14307. <value>
  14308. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
  14309. </value>
  14310. <remarks>
  14311. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14312. </remarks>
  14313. <seealso cref="M:Error(object)"/>
  14314. <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
  14315. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14316. </member>
  14317. <member name="P:log4net.ILog.IsFatalEnabled">
  14318. <summary>
  14319. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
  14320. </summary>
  14321. <value>
  14322. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
  14323. </value>
  14324. <remarks>
  14325. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  14326. </remarks>
  14327. <seealso cref="M:Fatal(object)"/>
  14328. <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
  14329. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14330. </member>
  14331. <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
  14332. <summary>
  14333. Construct a new wrapper for the specified logger.
  14334. </summary>
  14335. <param name="logger">The logger to wrap.</param>
  14336. <remarks>
  14337. <para>
  14338. Construct a new wrapper for the specified logger.
  14339. </para>
  14340. </remarks>
  14341. </member>
  14342. <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
  14343. <summary>
  14344. Virtual method called when the configuration of the repository changes
  14345. </summary>
  14346. <param name="repository">the repository holding the levels</param>
  14347. <remarks>
  14348. <para>
  14349. Virtual method called when the configuration of the repository changes
  14350. </para>
  14351. </remarks>
  14352. </member>
  14353. <member name="M:log4net.Core.LogImpl.Debug(System.Object)">
  14354. <summary>
  14355. Logs a message object with the <c>DEBUG</c> level.
  14356. </summary>
  14357. <param name="message">The message object to log.</param>
  14358. <remarks>
  14359. <para>
  14360. This method first checks if this logger is <c>DEBUG</c>
  14361. enabled by comparing the level of this logger with the
  14362. <c>DEBUG</c> level. If this logger is
  14363. <c>DEBUG</c> enabled, then it converts the message object
  14364. (passed as parameter) to a string by invoking the appropriate
  14365. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14366. proceeds to call all the registered appenders in this logger
  14367. and also higher in the hierarchy depending on the value of the
  14368. additivity flag.
  14369. </para>
  14370. <para>
  14371. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14372. to this method will print the name of the <see cref="T:System.Exception"/>
  14373. but no stack trace. To print a stack trace use the
  14374. <see cref="M:Debug(object,Exception)"/> form instead.
  14375. </para>
  14376. </remarks>
  14377. </member>
  14378. <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
  14379. <summary>
  14380. Logs a message object with the <c>DEBUG</c> level
  14381. </summary>
  14382. <param name="message">The message object to log.</param>
  14383. <param name="exception">The exception to log, including its stack trace.</param>
  14384. <remarks>
  14385. <para>
  14386. Logs a message object with the <c>DEBUG</c> level including
  14387. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
  14388. as a parameter.
  14389. </para>
  14390. <para>
  14391. See the <see cref="M:Debug(object)"/> form for more detailed information.
  14392. </para>
  14393. </remarks>
  14394. <seealso cref="M:Debug(object)"/>
  14395. </member>
  14396. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
  14397. <summary>
  14398. Logs a formatted message string with the <c>DEBUG</c> level.
  14399. </summary>
  14400. <param name="format">A String containing zero or more format items</param>
  14401. <param name="args">An Object array containing zero or more objects to format</param>
  14402. <remarks>
  14403. <para>
  14404. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14405. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14406. of the formatting.
  14407. </para>
  14408. <para>
  14409. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14410. format provider. To specify a localized provider use the
  14411. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14412. </para>
  14413. <para>
  14414. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14415. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14416. methods instead.
  14417. </para>
  14418. </remarks>
  14419. </member>
  14420. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
  14421. <summary>
  14422. Logs a formatted message string with the <c>DEBUG</c> level.
  14423. </summary>
  14424. <param name="format">A String containing zero or more format items</param>
  14425. <param name="arg0">An Object to format</param>
  14426. <remarks>
  14427. <para>
  14428. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14429. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14430. of the formatting.
  14431. </para>
  14432. <para>
  14433. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14434. format provider. To specify a localized provider use the
  14435. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14436. </para>
  14437. <para>
  14438. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14439. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14440. methods instead.
  14441. </para>
  14442. </remarks>
  14443. </member>
  14444. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
  14445. <summary>
  14446. Logs a formatted message string with the <c>DEBUG</c> level.
  14447. </summary>
  14448. <param name="format">A String containing zero or more format items</param>
  14449. <param name="arg0">An Object to format</param>
  14450. <param name="arg1">An Object to format</param>
  14451. <remarks>
  14452. <para>
  14453. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14454. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14455. of the formatting.
  14456. </para>
  14457. <para>
  14458. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14459. format provider. To specify a localized provider use the
  14460. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14461. </para>
  14462. <para>
  14463. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14464. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14465. methods instead.
  14466. </para>
  14467. </remarks>
  14468. </member>
  14469. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  14470. <summary>
  14471. Logs a formatted message string with the <c>DEBUG</c> level.
  14472. </summary>
  14473. <param name="format">A String containing zero or more format items</param>
  14474. <param name="arg0">An Object to format</param>
  14475. <param name="arg1">An Object to format</param>
  14476. <param name="arg2">An Object to format</param>
  14477. <remarks>
  14478. <para>
  14479. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14480. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14481. of the formatting.
  14482. </para>
  14483. <para>
  14484. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14485. format provider. To specify a localized provider use the
  14486. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  14487. </para>
  14488. <para>
  14489. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14490. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14491. methods instead.
  14492. </para>
  14493. </remarks>
  14494. </member>
  14495. <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  14496. <summary>
  14497. Logs a formatted message string with the <c>DEBUG</c> level.
  14498. </summary>
  14499. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14500. <param name="format">A String containing zero or more format items</param>
  14501. <param name="args">An Object array containing zero or more objects to format</param>
  14502. <remarks>
  14503. <para>
  14504. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14505. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14506. of the formatting.
  14507. </para>
  14508. <para>
  14509. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14510. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  14511. methods instead.
  14512. </para>
  14513. </remarks>
  14514. </member>
  14515. <member name="M:log4net.Core.LogImpl.Info(System.Object)">
  14516. <summary>
  14517. Logs a message object with the <c>INFO</c> level.
  14518. </summary>
  14519. <param name="message">The message object to log.</param>
  14520. <remarks>
  14521. <para>
  14522. This method first checks if this logger is <c>INFO</c>
  14523. enabled by comparing the level of this logger with the
  14524. <c>INFO</c> level. If this logger is
  14525. <c>INFO</c> enabled, then it converts the message object
  14526. (passed as parameter) to a string by invoking the appropriate
  14527. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14528. proceeds to call all the registered appenders in this logger
  14529. and also higher in the hierarchy depending on the value of
  14530. the additivity flag.
  14531. </para>
  14532. <para>
  14533. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14534. to this method will print the name of the <see cref="T:System.Exception"/>
  14535. but no stack trace. To print a stack trace use the
  14536. <see cref="M:Info(object,Exception)"/> form instead.
  14537. </para>
  14538. </remarks>
  14539. </member>
  14540. <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
  14541. <summary>
  14542. Logs a message object with the <c>INFO</c> level.
  14543. </summary>
  14544. <param name="message">The message object to log.</param>
  14545. <param name="exception">The exception to log, including its stack trace.</param>
  14546. <remarks>
  14547. <para>
  14548. Logs a message object with the <c>INFO</c> level including
  14549. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14550. passed as a parameter.
  14551. </para>
  14552. <para>
  14553. See the <see cref="M:Info(object)"/> form for more detailed information.
  14554. </para>
  14555. </remarks>
  14556. <seealso cref="M:Info(object)"/>
  14557. </member>
  14558. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
  14559. <summary>
  14560. Logs a formatted message string with the <c>INFO</c> level.
  14561. </summary>
  14562. <param name="format">A String containing zero or more format items</param>
  14563. <param name="args">An Object array containing zero or more objects to format</param>
  14564. <remarks>
  14565. <para>
  14566. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14567. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14568. of the formatting.
  14569. </para>
  14570. <para>
  14571. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14572. format provider. To specify a localized provider use the
  14573. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14574. </para>
  14575. <para>
  14576. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14577. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14578. methods instead.
  14579. </para>
  14580. </remarks>
  14581. </member>
  14582. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
  14583. <summary>
  14584. Logs a formatted message string with the <c>INFO</c> level.
  14585. </summary>
  14586. <param name="format">A String containing zero or more format items</param>
  14587. <param name="arg0">An Object to format</param>
  14588. <remarks>
  14589. <para>
  14590. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14591. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14592. of the formatting.
  14593. </para>
  14594. <para>
  14595. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14596. format provider. To specify a localized provider use the
  14597. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14598. </para>
  14599. <para>
  14600. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14601. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14602. methods instead.
  14603. </para>
  14604. </remarks>
  14605. </member>
  14606. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
  14607. <summary>
  14608. Logs a formatted message string with the <c>INFO</c> level.
  14609. </summary>
  14610. <param name="format">A String containing zero or more format items</param>
  14611. <param name="arg0">An Object to format</param>
  14612. <param name="arg1">An Object to format</param>
  14613. <remarks>
  14614. <para>
  14615. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14616. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14617. of the formatting.
  14618. </para>
  14619. <para>
  14620. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14621. format provider. To specify a localized provider use the
  14622. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14623. </para>
  14624. <para>
  14625. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14626. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14627. methods instead.
  14628. </para>
  14629. </remarks>
  14630. </member>
  14631. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  14632. <summary>
  14633. Logs a formatted message string with the <c>INFO</c> level.
  14634. </summary>
  14635. <param name="format">A String containing zero or more format items</param>
  14636. <param name="arg0">An Object to format</param>
  14637. <param name="arg1">An Object to format</param>
  14638. <param name="arg2">An Object to format</param>
  14639. <remarks>
  14640. <para>
  14641. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14642. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14643. of the formatting.
  14644. </para>
  14645. <para>
  14646. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14647. format provider. To specify a localized provider use the
  14648. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  14649. </para>
  14650. <para>
  14651. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14652. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14653. methods instead.
  14654. </para>
  14655. </remarks>
  14656. </member>
  14657. <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  14658. <summary>
  14659. Logs a formatted message string with the <c>INFO</c> level.
  14660. </summary>
  14661. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14662. <param name="format">A String containing zero or more format items</param>
  14663. <param name="args">An Object array containing zero or more objects to format</param>
  14664. <remarks>
  14665. <para>
  14666. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14667. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14668. of the formatting.
  14669. </para>
  14670. <para>
  14671. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14672. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14673. methods instead.
  14674. </para>
  14675. </remarks>
  14676. </member>
  14677. <member name="M:log4net.Core.LogImpl.Warn(System.Object)">
  14678. <summary>
  14679. Logs a message object with the <c>WARN</c> level.
  14680. </summary>
  14681. <param name="message">the message object to log</param>
  14682. <remarks>
  14683. <para>
  14684. This method first checks if this logger is <c>WARN</c>
  14685. enabled by comparing the level of this logger with the
  14686. <c>WARN</c> level. If this logger is
  14687. <c>WARN</c> enabled, then it converts the message object
  14688. (passed as parameter) to a string by invoking the appropriate
  14689. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14690. proceeds to call all the registered appenders in this logger and
  14691. also higher in the hierarchy depending on the value of the
  14692. additivity flag.
  14693. </para>
  14694. <para>
  14695. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  14696. method will print the name of the <see cref="T:System.Exception"/> but no
  14697. stack trace. To print a stack trace use the
  14698. <see cref="M:Warn(object,Exception)"/> form instead.
  14699. </para>
  14700. </remarks>
  14701. </member>
  14702. <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
  14703. <summary>
  14704. Logs a message object with the <c>WARN</c> level
  14705. </summary>
  14706. <param name="message">The message object to log.</param>
  14707. <param name="exception">The exception to log, including its stack trace.</param>
  14708. <remarks>
  14709. <para>
  14710. Logs a message object with the <c>WARN</c> level including
  14711. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14712. passed as a parameter.
  14713. </para>
  14714. <para>
  14715. See the <see cref="M:Warn(object)"/> form for more detailed information.
  14716. </para>
  14717. </remarks>
  14718. <seealso cref="M:Warn(object)"/>
  14719. </member>
  14720. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
  14721. <summary>
  14722. Logs a formatted message string with the <c>WARN</c> level.
  14723. </summary>
  14724. <param name="format">A String containing zero or more format items</param>
  14725. <param name="args">An Object array containing zero or more objects to format</param>
  14726. <remarks>
  14727. <para>
  14728. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14729. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14730. of the formatting.
  14731. </para>
  14732. <para>
  14733. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14734. format provider. To specify a localized provider use the
  14735. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14736. </para>
  14737. <para>
  14738. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14739. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14740. methods instead.
  14741. </para>
  14742. </remarks>
  14743. </member>
  14744. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
  14745. <summary>
  14746. Logs a formatted message string with the <c>WARN</c> level.
  14747. </summary>
  14748. <param name="format">A String containing zero or more format items</param>
  14749. <param name="arg0">An Object to format</param>
  14750. <remarks>
  14751. <para>
  14752. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14753. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14754. of the formatting.
  14755. </para>
  14756. <para>
  14757. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14758. format provider. To specify a localized provider use the
  14759. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14760. </para>
  14761. <para>
  14762. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14763. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14764. methods instead.
  14765. </para>
  14766. </remarks>
  14767. </member>
  14768. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
  14769. <summary>
  14770. Logs a formatted message string with the <c>WARN</c> level.
  14771. </summary>
  14772. <param name="format">A String containing zero or more format items</param>
  14773. <param name="arg0">An Object to format</param>
  14774. <param name="arg1">An Object to format</param>
  14775. <remarks>
  14776. <para>
  14777. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14778. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14779. of the formatting.
  14780. </para>
  14781. <para>
  14782. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14783. format provider. To specify a localized provider use the
  14784. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14785. </para>
  14786. <para>
  14787. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14788. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14789. methods instead.
  14790. </para>
  14791. </remarks>
  14792. </member>
  14793. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  14794. <summary>
  14795. Logs a formatted message string with the <c>WARN</c> level.
  14796. </summary>
  14797. <param name="format">A String containing zero or more format items</param>
  14798. <param name="arg0">An Object to format</param>
  14799. <param name="arg1">An Object to format</param>
  14800. <param name="arg2">An Object to format</param>
  14801. <remarks>
  14802. <para>
  14803. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14804. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14805. of the formatting.
  14806. </para>
  14807. <para>
  14808. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14809. format provider. To specify a localized provider use the
  14810. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  14811. </para>
  14812. <para>
  14813. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14814. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14815. methods instead.
  14816. </para>
  14817. </remarks>
  14818. </member>
  14819. <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  14820. <summary>
  14821. Logs a formatted message string with the <c>WARN</c> level.
  14822. </summary>
  14823. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14824. <param name="format">A String containing zero or more format items</param>
  14825. <param name="args">An Object array containing zero or more objects to format</param>
  14826. <remarks>
  14827. <para>
  14828. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14829. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14830. of the formatting.
  14831. </para>
  14832. <para>
  14833. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14834. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14835. methods instead.
  14836. </para>
  14837. </remarks>
  14838. </member>
  14839. <member name="M:log4net.Core.LogImpl.Error(System.Object)">
  14840. <summary>
  14841. Logs a message object with the <c>ERROR</c> level.
  14842. </summary>
  14843. <param name="message">The message object to log.</param>
  14844. <remarks>
  14845. <para>
  14846. This method first checks if this logger is <c>ERROR</c>
  14847. enabled by comparing the level of this logger with the
  14848. <c>ERROR</c> level. If this logger is
  14849. <c>ERROR</c> enabled, then it converts the message object
  14850. (passed as parameter) to a string by invoking the appropriate
  14851. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14852. proceeds to call all the registered appenders in this logger and
  14853. also higher in the hierarchy depending on the value of the
  14854. additivity flag.
  14855. </para>
  14856. <para>
  14857. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  14858. method will print the name of the <see cref="T:System.Exception"/> but no
  14859. stack trace. To print a stack trace use the
  14860. <see cref="M:Error(object,Exception)"/> form instead.
  14861. </para>
  14862. </remarks>
  14863. </member>
  14864. <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
  14865. <summary>
  14866. Logs a message object with the <c>ERROR</c> level
  14867. </summary>
  14868. <param name="message">The message object to log.</param>
  14869. <param name="exception">The exception to log, including its stack trace.</param>
  14870. <remarks>
  14871. <para>
  14872. Logs a message object with the <c>ERROR</c> level including
  14873. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  14874. passed as a parameter.
  14875. </para>
  14876. <para>
  14877. See the <see cref="M:Error(object)"/> form for more detailed information.
  14878. </para>
  14879. </remarks>
  14880. <seealso cref="M:Error(object)"/>
  14881. </member>
  14882. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
  14883. <summary>
  14884. Logs a formatted message string with the <c>ERROR</c> level.
  14885. </summary>
  14886. <param name="format">A String containing zero or more format items</param>
  14887. <param name="args">An Object array containing zero or more objects to format</param>
  14888. <remarks>
  14889. <para>
  14890. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14891. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14892. of the formatting.
  14893. </para>
  14894. <para>
  14895. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14896. format provider. To specify a localized provider use the
  14897. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14898. </para>
  14899. <para>
  14900. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14901. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14902. methods instead.
  14903. </para>
  14904. </remarks>
  14905. </member>
  14906. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
  14907. <summary>
  14908. Logs a formatted message string with the <c>ERROR</c> level.
  14909. </summary>
  14910. <param name="format">A String containing zero or more format items</param>
  14911. <param name="arg0">An Object to format</param>
  14912. <remarks>
  14913. <para>
  14914. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14915. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14916. of the formatting.
  14917. </para>
  14918. <para>
  14919. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14920. format provider. To specify a localized provider use the
  14921. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14922. </para>
  14923. <para>
  14924. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14925. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14926. methods instead.
  14927. </para>
  14928. </remarks>
  14929. </member>
  14930. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
  14931. <summary>
  14932. Logs a formatted message string with the <c>ERROR</c> level.
  14933. </summary>
  14934. <param name="format">A String containing zero or more format items</param>
  14935. <param name="arg0">An Object to format</param>
  14936. <param name="arg1">An Object to format</param>
  14937. <remarks>
  14938. <para>
  14939. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14940. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14941. of the formatting.
  14942. </para>
  14943. <para>
  14944. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14945. format provider. To specify a localized provider use the
  14946. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14947. </para>
  14948. <para>
  14949. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14950. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14951. methods instead.
  14952. </para>
  14953. </remarks>
  14954. </member>
  14955. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  14956. <summary>
  14957. Logs a formatted message string with the <c>ERROR</c> level.
  14958. </summary>
  14959. <param name="format">A String containing zero or more format items</param>
  14960. <param name="arg0">An Object to format</param>
  14961. <param name="arg1">An Object to format</param>
  14962. <param name="arg2">An Object to format</param>
  14963. <remarks>
  14964. <para>
  14965. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14966. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14967. of the formatting.
  14968. </para>
  14969. <para>
  14970. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  14971. format provider. To specify a localized provider use the
  14972. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  14973. </para>
  14974. <para>
  14975. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14976. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14977. methods instead.
  14978. </para>
  14979. </remarks>
  14980. </member>
  14981. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  14982. <summary>
  14983. Logs a formatted message string with the <c>ERROR</c> level.
  14984. </summary>
  14985. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14986. <param name="format">A String containing zero or more format items</param>
  14987. <param name="args">An Object array containing zero or more objects to format</param>
  14988. <remarks>
  14989. <para>
  14990. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  14991. <c>String.Format</c> for details of the syntax of the format string and the behavior
  14992. of the formatting.
  14993. </para>
  14994. <para>
  14995. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14996. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14997. methods instead.
  14998. </para>
  14999. </remarks>
  15000. </member>
  15001. <member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
  15002. <summary>
  15003. Logs a message object with the <c>FATAL</c> level.
  15004. </summary>
  15005. <param name="message">The message object to log.</param>
  15006. <remarks>
  15007. <para>
  15008. This method first checks if this logger is <c>FATAL</c>
  15009. enabled by comparing the level of this logger with the
  15010. <c>FATAL</c> level. If this logger is
  15011. <c>FATAL</c> enabled, then it converts the message object
  15012. (passed as parameter) to a string by invoking the appropriate
  15013. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15014. proceeds to call all the registered appenders in this logger and
  15015. also higher in the hierarchy depending on the value of the
  15016. additivity flag.
  15017. </para>
  15018. <para>
  15019. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  15020. method will print the name of the <see cref="T:System.Exception"/> but no
  15021. stack trace. To print a stack trace use the
  15022. <see cref="M:Fatal(object,Exception)"/> form instead.
  15023. </para>
  15024. </remarks>
  15025. </member>
  15026. <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
  15027. <summary>
  15028. Logs a message object with the <c>FATAL</c> level
  15029. </summary>
  15030. <param name="message">The message object to log.</param>
  15031. <param name="exception">The exception to log, including its stack trace.</param>
  15032. <remarks>
  15033. <para>
  15034. Logs a message object with the <c>FATAL</c> level including
  15035. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  15036. passed as a parameter.
  15037. </para>
  15038. <para>
  15039. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  15040. </para>
  15041. </remarks>
  15042. <seealso cref="M:Fatal(object)"/>
  15043. </member>
  15044. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
  15045. <summary>
  15046. Logs a formatted message string with the <c>FATAL</c> level.
  15047. </summary>
  15048. <param name="format">A String containing zero or more format items</param>
  15049. <param name="args">An Object array containing zero or more objects to format</param>
  15050. <remarks>
  15051. <para>
  15052. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15053. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15054. of the formatting.
  15055. </para>
  15056. <para>
  15057. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15058. format provider. To specify a localized provider use the
  15059. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15060. </para>
  15061. <para>
  15062. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15063. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15064. methods instead.
  15065. </para>
  15066. </remarks>
  15067. </member>
  15068. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
  15069. <summary>
  15070. Logs a formatted message string with the <c>FATAL</c> level.
  15071. </summary>
  15072. <param name="format">A String containing zero or more format items</param>
  15073. <param name="arg0">An Object to format</param>
  15074. <remarks>
  15075. <para>
  15076. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15077. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15078. of the formatting.
  15079. </para>
  15080. <para>
  15081. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15082. format provider. To specify a localized provider use the
  15083. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15084. </para>
  15085. <para>
  15086. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15087. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15088. methods instead.
  15089. </para>
  15090. </remarks>
  15091. </member>
  15092. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
  15093. <summary>
  15094. Logs a formatted message string with the <c>FATAL</c> level.
  15095. </summary>
  15096. <param name="format">A String containing zero or more format items</param>
  15097. <param name="arg0">An Object to format</param>
  15098. <param name="arg1">An Object to format</param>
  15099. <remarks>
  15100. <para>
  15101. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15102. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15103. of the formatting.
  15104. </para>
  15105. <para>
  15106. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15107. format provider. To specify a localized provider use the
  15108. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15109. </para>
  15110. <para>
  15111. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15112. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15113. methods instead.
  15114. </para>
  15115. </remarks>
  15116. </member>
  15117. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  15118. <summary>
  15119. Logs a formatted message string with the <c>FATAL</c> level.
  15120. </summary>
  15121. <param name="format">A String containing zero or more format items</param>
  15122. <param name="arg0">An Object to format</param>
  15123. <param name="arg1">An Object to format</param>
  15124. <param name="arg2">An Object to format</param>
  15125. <remarks>
  15126. <para>
  15127. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15128. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15129. of the formatting.
  15130. </para>
  15131. <para>
  15132. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  15133. format provider. To specify a localized provider use the
  15134. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  15135. </para>
  15136. <para>
  15137. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15138. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15139. methods instead.
  15140. </para>
  15141. </remarks>
  15142. </member>
  15143. <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  15144. <summary>
  15145. Logs a formatted message string with the <c>FATAL</c> level.
  15146. </summary>
  15147. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15148. <param name="format">A String containing zero or more format items</param>
  15149. <param name="args">An Object array containing zero or more objects to format</param>
  15150. <remarks>
  15151. <para>
  15152. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  15153. <c>String.Format</c> for details of the syntax of the format string and the behavior
  15154. of the formatting.
  15155. </para>
  15156. <para>
  15157. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15158. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15159. methods instead.
  15160. </para>
  15161. </remarks>
  15162. </member>
  15163. <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
  15164. <summary>
  15165. Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
  15166. </summary>
  15167. <param name="sender">the repository</param>
  15168. <param name="e">Empty</param>
  15169. </member>
  15170. <member name="F:log4net.Core.LogImpl.ThisDeclaringType">
  15171. <summary>
  15172. The fully qualified name of this declaring type not the type of any subclass.
  15173. </summary>
  15174. </member>
  15175. <member name="P:log4net.Core.LogImpl.IsDebugEnabled">
  15176. <summary>
  15177. Checks if this logger is enabled for the <c>DEBUG</c>
  15178. level.
  15179. </summary>
  15180. <value>
  15181. <c>true</c> if this logger is enabled for <c>DEBUG</c> events,
  15182. <c>false</c> otherwise.
  15183. </value>
  15184. <remarks>
  15185. <para>
  15186. This function is intended to lessen the computational cost of
  15187. disabled log debug statements.
  15188. </para>
  15189. <para>
  15190. For some <c>log</c> Logger object, when you write:
  15191. </para>
  15192. <code lang="C#">
  15193. log.Debug("This is entry number: " + i );
  15194. </code>
  15195. <para>
  15196. You incur the cost constructing the message, concatenation in
  15197. this case, regardless of whether the message is logged or not.
  15198. </para>
  15199. <para>
  15200. If you are worried about speed, then you should write:
  15201. </para>
  15202. <code lang="C#">
  15203. if (log.IsDebugEnabled())
  15204. {
  15205. log.Debug("This is entry number: " + i );
  15206. }
  15207. </code>
  15208. <para>
  15209. This way you will not incur the cost of parameter
  15210. construction if debugging is disabled for <c>log</c>. On
  15211. the other hand, if the <c>log</c> is debug enabled, you
  15212. will incur the cost of evaluating whether the logger is debug
  15213. enabled twice. Once in <c>IsDebugEnabled</c> and once in
  15214. the <c>Debug</c>. This is an insignificant overhead
  15215. since evaluating a logger takes about 1% of the time it
  15216. takes to actually log.
  15217. </para>
  15218. </remarks>
  15219. </member>
  15220. <member name="P:log4net.Core.LogImpl.IsInfoEnabled">
  15221. <summary>
  15222. Checks if this logger is enabled for the <c>INFO</c> level.
  15223. </summary>
  15224. <value>
  15225. <c>true</c> if this logger is enabled for <c>INFO</c> events,
  15226. <c>false</c> otherwise.
  15227. </value>
  15228. <remarks>
  15229. <para>
  15230. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  15231. of using this method.
  15232. </para>
  15233. </remarks>
  15234. <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  15235. </member>
  15236. <member name="P:log4net.Core.LogImpl.IsWarnEnabled">
  15237. <summary>
  15238. Checks if this logger is enabled for the <c>WARN</c> level.
  15239. </summary>
  15240. <value>
  15241. <c>true</c> if this logger is enabled for <c>WARN</c> events,
  15242. <c>false</c> otherwise.
  15243. </value>
  15244. <remarks>
  15245. <para>
  15246. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  15247. of using this method.
  15248. </para>
  15249. </remarks>
  15250. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15251. </member>
  15252. <member name="P:log4net.Core.LogImpl.IsErrorEnabled">
  15253. <summary>
  15254. Checks if this logger is enabled for the <c>ERROR</c> level.
  15255. </summary>
  15256. <value>
  15257. <c>true</c> if this logger is enabled for <c>ERROR</c> events,
  15258. <c>false</c> otherwise.
  15259. </value>
  15260. <remarks>
  15261. <para>
  15262. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  15263. </para>
  15264. </remarks>
  15265. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15266. </member>
  15267. <member name="P:log4net.Core.LogImpl.IsFatalEnabled">
  15268. <summary>
  15269. Checks if this logger is enabled for the <c>FATAL</c> level.
  15270. </summary>
  15271. <value>
  15272. <c>true</c> if this logger is enabled for <c>FATAL</c> events,
  15273. <c>false</c> otherwise.
  15274. </value>
  15275. <remarks>
  15276. <para>
  15277. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  15278. </para>
  15279. </remarks>
  15280. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15281. </member>
  15282. <member name="T:log4net.Core.MethodItem">
  15283. <summary>
  15284. provides method information without actually referencing a System.Reflection.MethodBase
  15285. as that would require that the containing assembly is loaded.
  15286. </summary>
  15287. </member>
  15288. <member name="F:log4net.Core.MethodItem.NA">
  15289. <summary>
  15290. When location information is not available the constant
  15291. <c>NA</c> is returned. Current value of this string
  15292. constant is <b>?</b>.
  15293. </summary>
  15294. </member>
  15295. <member name="M:log4net.Core.MethodItem.#ctor">
  15296. <summary>
  15297. constructs a method item for an unknown method.
  15298. </summary>
  15299. </member>
  15300. <member name="M:log4net.Core.MethodItem.#ctor(System.String)">
  15301. <summary>
  15302. constructs a method item from the name of the method.
  15303. </summary>
  15304. <param name="name"></param>
  15305. </member>
  15306. <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
  15307. <summary>
  15308. constructs a method item from the name of the method and its parameters.
  15309. </summary>
  15310. <param name="name"></param>
  15311. <param name="parameters"></param>
  15312. </member>
  15313. <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
  15314. <summary>
  15315. constructs a method item from a method base by determining the method name and its parameters.
  15316. </summary>
  15317. <param name="methodBase"></param>
  15318. </member>
  15319. <member name="F:log4net.Core.MethodItem.declaringType">
  15320. <summary>
  15321. The fully qualified type of the StackFrameItem class.
  15322. </summary>
  15323. <remarks>
  15324. Used by the internal logger to record the Type of the
  15325. log message.
  15326. </remarks>
  15327. </member>
  15328. <member name="P:log4net.Core.MethodItem.Name">
  15329. <summary>
  15330. Gets the method name of the caller making the logging
  15331. request.
  15332. </summary>
  15333. <value>
  15334. The method name of the caller making the logging
  15335. request.
  15336. </value>
  15337. <remarks>
  15338. <para>
  15339. Gets the method name of the caller making the logging
  15340. request.
  15341. </para>
  15342. </remarks>
  15343. </member>
  15344. <member name="P:log4net.Core.MethodItem.Parameters">
  15345. <summary>
  15346. Gets the method parameters of the caller making
  15347. the logging request.
  15348. </summary>
  15349. <value>
  15350. The method parameters of the caller making
  15351. the logging request
  15352. </value>
  15353. <remarks>
  15354. <para>
  15355. Gets the method parameters of the caller making
  15356. the logging request.
  15357. </para>
  15358. </remarks>
  15359. </member>
  15360. <member name="T:log4net.Core.SecurityContext">
  15361. <summary>
  15362. A SecurityContext used by log4net when interacting with protected resources
  15363. </summary>
  15364. <remarks>
  15365. <para>
  15366. A SecurityContext used by log4net when interacting with protected resources
  15367. for example with operating system services. This can be used to impersonate
  15368. a principal that has been granted privileges on the system resources.
  15369. </para>
  15370. </remarks>
  15371. <author>Nicko Cadell</author>
  15372. </member>
  15373. <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
  15374. <summary>
  15375. Impersonate this SecurityContext
  15376. </summary>
  15377. <param name="state">State supplied by the caller</param>
  15378. <returns>An <see cref="T:System.IDisposable"/> instance that will
  15379. revoke the impersonation of this SecurityContext, or <c>null</c></returns>
  15380. <remarks>
  15381. <para>
  15382. Impersonate this security context. Further calls on the current
  15383. thread should now be made in the security context provided
  15384. by this object. When the <see cref="T:System.IDisposable"/> result
  15385. <see cref="M:System.IDisposable.Dispose"/> method is called the security
  15386. context of the thread should be reverted to the state it was in
  15387. before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
  15388. </para>
  15389. </remarks>
  15390. </member>
  15391. <member name="T:log4net.Core.SecurityContextProvider">
  15392. <summary>
  15393. The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
  15394. </summary>
  15395. <remarks>
  15396. <para>
  15397. A configured component that interacts with potentially protected system
  15398. resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
  15399. privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
  15400. been not been explicitly provided to the component then the component
  15401. will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
  15402. </para>
  15403. <para>
  15404. By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
  15405. an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
  15406. <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
  15407. where the privileges required are not know by the system.
  15408. </para>
  15409. <para>
  15410. This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
  15411. and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
  15412. the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
  15413. can be replaced by programmatically setting the value of the
  15414. <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
  15415. </para>
  15416. <para>
  15417. An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
  15418. This attribute can be applied to an assembly in the same way as the
  15419. <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
  15420. the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
  15421. </para>
  15422. </remarks>
  15423. <author>Nicko Cadell</author>
  15424. </member>
  15425. <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
  15426. <summary>
  15427. The default provider
  15428. </summary>
  15429. </member>
  15430. <member name="M:log4net.Core.SecurityContextProvider.#ctor">
  15431. <summary>
  15432. Protected default constructor to allow subclassing
  15433. </summary>
  15434. <remarks>
  15435. <para>
  15436. Protected default constructor to allow subclassing
  15437. </para>
  15438. </remarks>
  15439. </member>
  15440. <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
  15441. <summary>
  15442. Create a SecurityContext for a consumer
  15443. </summary>
  15444. <param name="consumer">The consumer requesting the SecurityContext</param>
  15445. <returns>An impersonation context</returns>
  15446. <remarks>
  15447. <para>
  15448. The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
  15449. </para>
  15450. <para>
  15451. Subclasses should override this method to provide their own
  15452. behavior.
  15453. </para>
  15454. </remarks>
  15455. </member>
  15456. <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
  15457. <summary>
  15458. Gets or sets the default SecurityContextProvider
  15459. </summary>
  15460. <value>
  15461. The default SecurityContextProvider
  15462. </value>
  15463. <remarks>
  15464. <para>
  15465. The default provider is used by configured components that
  15466. require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
  15467. given to them.
  15468. </para>
  15469. <para>
  15470. By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
  15471. that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
  15472. </para>
  15473. <para>
  15474. The default provider can be set programmatically by setting
  15475. the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
  15476. that has the desired behavior.
  15477. </para>
  15478. </remarks>
  15479. </member>
  15480. <member name="T:log4net.Core.StackFrameItem">
  15481. <summary>
  15482. provides stack frame information without actually referencing a System.Diagnostics.StackFrame
  15483. as that would require that the containing assembly is loaded.
  15484. </summary>
  15485. </member>
  15486. <member name="F:log4net.Core.StackFrameItem.NA">
  15487. <summary>
  15488. When location information is not available the constant
  15489. <c>NA</c> is returned. Current value of this string
  15490. constant is <b>?</b>.
  15491. </summary>
  15492. </member>
  15493. <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
  15494. <summary>
  15495. returns a stack frame item from a stack frame. This
  15496. </summary>
  15497. <param name="frame"></param>
  15498. <returns></returns>
  15499. </member>
  15500. <member name="F:log4net.Core.StackFrameItem.declaringType">
  15501. <summary>
  15502. The fully qualified type of the StackFrameItem class.
  15503. </summary>
  15504. <remarks>
  15505. Used by the internal logger to record the Type of the
  15506. log message.
  15507. </remarks>
  15508. </member>
  15509. <member name="P:log4net.Core.StackFrameItem.ClassName">
  15510. <summary>
  15511. Gets the fully qualified class name of the caller making the logging
  15512. request.
  15513. </summary>
  15514. <value>
  15515. The fully qualified class name of the caller making the logging
  15516. request.
  15517. </value>
  15518. <remarks>
  15519. <para>
  15520. Gets the fully qualified class name of the caller making the logging
  15521. request.
  15522. </para>
  15523. </remarks>
  15524. </member>
  15525. <member name="P:log4net.Core.StackFrameItem.FileName">
  15526. <summary>
  15527. Gets the file name of the caller.
  15528. </summary>
  15529. <value>
  15530. The file name of the caller.
  15531. </value>
  15532. <remarks>
  15533. <para>
  15534. Gets the file name of the caller.
  15535. </para>
  15536. </remarks>
  15537. </member>
  15538. <member name="P:log4net.Core.StackFrameItem.LineNumber">
  15539. <summary>
  15540. Gets the line number of the caller.
  15541. </summary>
  15542. <value>
  15543. The line number of the caller.
  15544. </value>
  15545. <remarks>
  15546. <para>
  15547. Gets the line number of the caller.
  15548. </para>
  15549. </remarks>
  15550. </member>
  15551. <member name="P:log4net.Core.StackFrameItem.Method">
  15552. <summary>
  15553. Gets the method name of the caller.
  15554. </summary>
  15555. <value>
  15556. The method name of the caller.
  15557. </value>
  15558. <remarks>
  15559. <para>
  15560. Gets the method name of the caller.
  15561. </para>
  15562. </remarks>
  15563. </member>
  15564. <member name="P:log4net.Core.StackFrameItem.FullInfo">
  15565. <summary>
  15566. Gets all available caller information
  15567. </summary>
  15568. <value>
  15569. All available caller information, in the format
  15570. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  15571. </value>
  15572. <remarks>
  15573. <para>
  15574. Gets all available caller information, in the format
  15575. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  15576. </para>
  15577. </remarks>
  15578. </member>
  15579. <member name="T:log4net.Core.TimeEvaluator">
  15580. <summary>
  15581. An evaluator that triggers after specified number of seconds.
  15582. </summary>
  15583. <remarks>
  15584. <para>
  15585. This evaluator will trigger if the specified time period
  15586. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15587. </para>
  15588. </remarks>
  15589. <author>Robert Sevcik</author>
  15590. </member>
  15591. <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
  15592. <summary>
  15593. The default time threshold for triggering in seconds. Zero means it won't trigger at all.
  15594. </summary>
  15595. </member>
  15596. <member name="F:log4net.Core.TimeEvaluator.m_interval">
  15597. <summary>
  15598. The time threshold for triggering in seconds. Zero means it won't trigger at all.
  15599. </summary>
  15600. </member>
  15601. <member name="F:log4net.Core.TimeEvaluator.m_lasttime">
  15602. <summary>
  15603. The time of last check. This gets updated when the object is created and when the evaluator triggers.
  15604. </summary>
  15605. </member>
  15606. <member name="M:log4net.Core.TimeEvaluator.#ctor">
  15607. <summary>
  15608. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  15609. </summary>
  15610. <remarks>
  15611. <para>
  15612. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  15613. </para>
  15614. <para>
  15615. This evaluator will trigger if the specified time period
  15616. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15617. </para>
  15618. </remarks>
  15619. </member>
  15620. <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
  15621. <summary>
  15622. Create a new evaluator using the specified time threshold in seconds.
  15623. </summary>
  15624. <param name="interval">
  15625. The time threshold in seconds to trigger after.
  15626. Zero means it won't trigger at all.
  15627. </param>
  15628. <remarks>
  15629. <para>
  15630. Create a new evaluator using the specified time threshold in seconds.
  15631. </para>
  15632. <para>
  15633. This evaluator will trigger if the specified time period
  15634. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15635. </para>
  15636. </remarks>
  15637. </member>
  15638. <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  15639. <summary>
  15640. Is this <paramref name="loggingEvent"/> the triggering event?
  15641. </summary>
  15642. <param name="loggingEvent">The event to check</param>
  15643. <returns>This method returns <c>true</c>, if the specified time period
  15644. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
  15645. Otherwise it returns <c>false</c></returns>
  15646. <remarks>
  15647. <para>
  15648. This evaluator will trigger if the specified time period
  15649. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15650. </para>
  15651. </remarks>
  15652. </member>
  15653. <member name="P:log4net.Core.TimeEvaluator.Interval">
  15654. <summary>
  15655. The time threshold in seconds to trigger after
  15656. </summary>
  15657. <value>
  15658. The time threshold in seconds to trigger after.
  15659. Zero means it won't trigger at all.
  15660. </value>
  15661. <remarks>
  15662. <para>
  15663. This evaluator will trigger if the specified time period
  15664. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  15665. </para>
  15666. </remarks>
  15667. </member>
  15668. <member name="T:log4net.Core.WrapperCreationHandler">
  15669. <summary>
  15670. Delegate used to handle creation of new wrappers.
  15671. </summary>
  15672. <param name="logger">The logger to wrap in a wrapper.</param>
  15673. <remarks>
  15674. <para>
  15675. Delegate used to handle creation of new wrappers. This delegate
  15676. is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  15677. method to construct the wrapper for the specified logger.
  15678. </para>
  15679. <para>
  15680. The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
  15681. constructor.
  15682. </para>
  15683. </remarks>
  15684. </member>
  15685. <member name="T:log4net.Core.WrapperMap">
  15686. <summary>
  15687. Maps between logger objects and wrapper objects.
  15688. </summary>
  15689. <remarks>
  15690. <para>
  15691. This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
  15692. <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
  15693. lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
  15694. </para>
  15695. <para>
  15696. New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  15697. method. The default behavior is for this method to delegate construction
  15698. of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
  15699. to the constructor. This allows specialization of the behavior without
  15700. requiring subclassing of this type.
  15701. </para>
  15702. </remarks>
  15703. <author>Nicko Cadell</author>
  15704. <author>Gert Driesen</author>
  15705. </member>
  15706. <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
  15707. <summary>
  15708. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/>
  15709. </summary>
  15710. <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
  15711. <remarks>
  15712. <para>
  15713. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap"/> class with
  15714. the specified handler to create the wrapper objects.
  15715. </para>
  15716. </remarks>
  15717. </member>
  15718. <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
  15719. <summary>
  15720. Gets the wrapper object for the specified logger.
  15721. </summary>
  15722. <returns>The wrapper object for the specified logger</returns>
  15723. <remarks>
  15724. <para>
  15725. If the logger is null then the corresponding wrapper is null.
  15726. </para>
  15727. <para>
  15728. Looks up the wrapper it it has previously been requested and
  15729. returns it. If the wrapper has never been requested before then
  15730. the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
  15731. called.
  15732. </para>
  15733. </remarks>
  15734. </member>
  15735. <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
  15736. <summary>
  15737. Creates the wrapper object for the specified logger.
  15738. </summary>
  15739. <param name="logger">The logger to wrap in a wrapper.</param>
  15740. <returns>The wrapper object for the logger.</returns>
  15741. <remarks>
  15742. <para>
  15743. This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
  15744. passed to the constructor to create the wrapper. This method
  15745. can be overridden in a subclass.
  15746. </para>
  15747. </remarks>
  15748. </member>
  15749. <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
  15750. <summary>
  15751. Called when a monitored repository shutdown event is received.
  15752. </summary>
  15753. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
  15754. <remarks>
  15755. <para>
  15756. This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
  15757. <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
  15758. event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
  15759. behavior of this method is to release the references to the loggers
  15760. and their wrappers generated for this repository.
  15761. </para>
  15762. </remarks>
  15763. </member>
  15764. <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
  15765. <summary>
  15766. Event handler for repository shutdown event.
  15767. </summary>
  15768. <param name="sender">The sender of the event.</param>
  15769. <param name="e">The event args.</param>
  15770. </member>
  15771. <member name="F:log4net.Core.WrapperMap.m_repositories">
  15772. <summary>
  15773. Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
  15774. </summary>
  15775. </member>
  15776. <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
  15777. <summary>
  15778. The handler to use to create the extension wrapper objects.
  15779. </summary>
  15780. </member>
  15781. <member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
  15782. <summary>
  15783. Internal reference to the delegate used to register for repository shutdown events.
  15784. </summary>
  15785. </member>
  15786. <member name="P:log4net.Core.WrapperMap.Repositories">
  15787. <summary>
  15788. Gets the map of logger repositories.
  15789. </summary>
  15790. <value>
  15791. Map of logger repositories.
  15792. </value>
  15793. <remarks>
  15794. <para>
  15795. Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
  15796. values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
  15797. value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
  15798. </para>
  15799. </remarks>
  15800. </member>
  15801. <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
  15802. <summary>
  15803. Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
  15804. </summary>
  15805. <remarks>
  15806. <para>
  15807. Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  15808. </para>
  15809. </remarks>
  15810. <author>Nicko Cadell</author>
  15811. <author>Gert Driesen</author>
  15812. </member>
  15813. <member name="T:log4net.DateFormatter.IDateFormatter">
  15814. <summary>
  15815. Render a <see cref="T:System.DateTime"/> as a string.
  15816. </summary>
  15817. <remarks>
  15818. <para>
  15819. Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
  15820. instance into a string.
  15821. </para>
  15822. <para>
  15823. The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
  15824. date to a text writer.
  15825. </para>
  15826. </remarks>
  15827. <author>Nicko Cadell</author>
  15828. <author>Gert Driesen</author>
  15829. </member>
  15830. <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  15831. <summary>
  15832. Formats the specified date as a string.
  15833. </summary>
  15834. <param name="dateToFormat">The date to format.</param>
  15835. <param name="writer">The writer to write to.</param>
  15836. <remarks>
  15837. <para>
  15838. Format the <see cref="T:System.DateTime"/> as a string and write it
  15839. to the <see cref="T:System.IO.TextWriter"/> provided.
  15840. </para>
  15841. </remarks>
  15842. </member>
  15843. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
  15844. <summary>
  15845. String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
  15846. </summary>
  15847. </member>
  15848. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
  15849. <summary>
  15850. String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
  15851. </summary>
  15852. </member>
  15853. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
  15854. <summary>
  15855. String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
  15856. </summary>
  15857. </member>
  15858. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15859. <summary>
  15860. Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
  15861. </summary>
  15862. <param name="dateToFormat">The date to render into a string.</param>
  15863. <param name="buffer">The string builder to write to.</param>
  15864. <remarks>
  15865. <para>
  15866. Subclasses should override this method to render the date
  15867. into a string using a precision up to the second. This method
  15868. will be called at most once per second and the result will be
  15869. reused if it is needed again during the same second.
  15870. </para>
  15871. </remarks>
  15872. </member>
  15873. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  15874. <summary>
  15875. Renders the date into a string. Format is "HH:mm:ss,fff".
  15876. </summary>
  15877. <param name="dateToFormat">The date to render into a string.</param>
  15878. <param name="writer">The writer to write to.</param>
  15879. <remarks>
  15880. <para>
  15881. Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
  15882. time string up to the seconds and then appends the current
  15883. milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
  15884. cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
  15885. per second.
  15886. </para>
  15887. <para>
  15888. Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
  15889. rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
  15890. </para>
  15891. </remarks>
  15892. </member>
  15893. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
  15894. <summary>
  15895. Last stored time with precision up to the second.
  15896. </summary>
  15897. </member>
  15898. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
  15899. <summary>
  15900. Last stored time with precision up to the second, formatted
  15901. as a string.
  15902. </summary>
  15903. </member>
  15904. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
  15905. <summary>
  15906. Last stored time with precision up to the second, formatted
  15907. as a string.
  15908. </summary>
  15909. </member>
  15910. <member name="T:log4net.DateFormatter.DateTimeDateFormatter">
  15911. <summary>
  15912. Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
  15913. </summary>
  15914. <remarks>
  15915. <para>
  15916. Formats a <see cref="T:System.DateTime"/> in the format
  15917. <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
  15918. <c>"06 Nov 1994 15:49:37,459"</c>.
  15919. </para>
  15920. </remarks>
  15921. <author>Nicko Cadell</author>
  15922. <author>Gert Driesen</author>
  15923. <author>Angelika Schnagl</author>
  15924. </member>
  15925. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
  15926. <summary>
  15927. Default constructor.
  15928. </summary>
  15929. <remarks>
  15930. <para>
  15931. Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> class.
  15932. </para>
  15933. </remarks>
  15934. </member>
  15935. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15936. <summary>
  15937. Formats the date without the milliseconds part
  15938. </summary>
  15939. <param name="dateToFormat">The date to format.</param>
  15940. <param name="buffer">The string builder to write to.</param>
  15941. <remarks>
  15942. <para>
  15943. Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
  15944. for example, <c>"06 Nov 1994 15:49:37"</c>.
  15945. </para>
  15946. <para>
  15947. The base class will append the <c>",fff"</c> milliseconds section.
  15948. This method will only be called at most once per second.
  15949. </para>
  15950. </remarks>
  15951. </member>
  15952. <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
  15953. <summary>
  15954. The format info for the invariant culture.
  15955. </summary>
  15956. </member>
  15957. <member name="T:log4net.DateFormatter.Iso8601DateFormatter">
  15958. <summary>
  15959. Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  15960. </summary>
  15961. <remarks>
  15962. <para>
  15963. Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  15964. </para>
  15965. </remarks>
  15966. <author>Nicko Cadell</author>
  15967. <author>Gert Driesen</author>
  15968. </member>
  15969. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
  15970. <summary>
  15971. Default constructor
  15972. </summary>
  15973. <remarks>
  15974. <para>
  15975. Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> class.
  15976. </para>
  15977. </remarks>
  15978. </member>
  15979. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  15980. <summary>
  15981. Formats the date without the milliseconds part
  15982. </summary>
  15983. <param name="dateToFormat">The date to format.</param>
  15984. <param name="buffer">The string builder to write to.</param>
  15985. <remarks>
  15986. <para>
  15987. Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
  15988. </para>
  15989. <para>
  15990. The base class will append the <c>",fff"</c> milliseconds section.
  15991. This method will only be called at most once per second.
  15992. </para>
  15993. </remarks>
  15994. </member>
  15995. <member name="T:log4net.DateFormatter.SimpleDateFormatter">
  15996. <summary>
  15997. Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  15998. </summary>
  15999. <remarks>
  16000. <para>
  16001. Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  16002. </para>
  16003. </remarks>
  16004. <author>Nicko Cadell</author>
  16005. <author>Gert Driesen</author>
  16006. </member>
  16007. <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
  16008. <summary>
  16009. Constructor
  16010. </summary>
  16011. <param name="format">The format string.</param>
  16012. <remarks>
  16013. <para>
  16014. Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> class
  16015. with the specified format string.
  16016. </para>
  16017. <para>
  16018. The format string must be compatible with the options
  16019. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16020. </para>
  16021. </remarks>
  16022. </member>
  16023. <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  16024. <summary>
  16025. Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16026. </summary>
  16027. <param name="dateToFormat">The date to convert to a string.</param>
  16028. <param name="writer">The writer to write to.</param>
  16029. <remarks>
  16030. <para>
  16031. Uses the date format string supplied to the constructor to call
  16032. the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
  16033. </para>
  16034. </remarks>
  16035. </member>
  16036. <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
  16037. <summary>
  16038. The format string used to format the <see cref="T:System.DateTime"/>.
  16039. </summary>
  16040. <remarks>
  16041. <para>
  16042. The format string must be compatible with the options
  16043. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  16044. </para>
  16045. </remarks>
  16046. </member>
  16047. <member name="T:log4net.Filter.DenyAllFilter">
  16048. <summary>
  16049. This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
  16050. </summary>
  16051. <remarks>
  16052. <para>
  16053. You can add this filter to the end of a filter chain to
  16054. switch from the default "accept all unless instructed otherwise"
  16055. filtering behavior to a "deny all unless instructed otherwise"
  16056. behavior.
  16057. </para>
  16058. </remarks>
  16059. <author>Nicko Cadell</author>
  16060. <author>Gert Driesen</author>
  16061. </member>
  16062. <member name="T:log4net.Filter.FilterSkeleton">
  16063. <summary>
  16064. Subclass this type to implement customized logging event filtering
  16065. </summary>
  16066. <remarks>
  16067. <para>
  16068. Users should extend this class to implement customized logging
  16069. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  16070. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  16071. appenders, have built-in filtering rules. It is suggested that you
  16072. first use and understand the built-in rules before rushing to write
  16073. your own custom filters.
  16074. </para>
  16075. <para>
  16076. This abstract class assumes and also imposes that filters be
  16077. organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
  16078. method of each filter is called sequentially, in the order of their
  16079. addition to the chain.
  16080. </para>
  16081. <para>
  16082. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
  16083. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  16084. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  16085. </para>
  16086. <para>
  16087. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  16088. immediately without consulting with the remaining filters.
  16089. </para>
  16090. <para>
  16091. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  16092. in the chain is consulted. If there are no more filters in the
  16093. chain, then the log event is logged. Thus, in the presence of no
  16094. filters, the default behavior is to log all logging events.
  16095. </para>
  16096. <para>
  16097. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  16098. event is logged without consulting the remaining filters.
  16099. </para>
  16100. <para>
  16101. The philosophy of log4net filters is largely inspired from the
  16102. Linux ipchains.
  16103. </para>
  16104. </remarks>
  16105. <author>Nicko Cadell</author>
  16106. <author>Gert Driesen</author>
  16107. </member>
  16108. <member name="T:log4net.Filter.IFilter">
  16109. <summary>
  16110. Implement this interface to provide customized logging event filtering
  16111. </summary>
  16112. <remarks>
  16113. <para>
  16114. Users should implement this interface to implement customized logging
  16115. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  16116. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  16117. appenders, have built-in filtering rules. It is suggested that you
  16118. first use and understand the built-in rules before rushing to write
  16119. your own custom filters.
  16120. </para>
  16121. <para>
  16122. This abstract class assumes and also imposes that filters be
  16123. organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16124. method of each filter is called sequentially, in the order of their
  16125. addition to the chain.
  16126. </para>
  16127. <para>
  16128. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
  16129. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  16130. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  16131. </para>
  16132. <para>
  16133. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  16134. immediately without consulting with the remaining filters.
  16135. </para>
  16136. <para>
  16137. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  16138. in the chain is consulted. If there are no more filters in the
  16139. chain, then the log event is logged. Thus, in the presence of no
  16140. filters, the default behavior is to log all logging events.
  16141. </para>
  16142. <para>
  16143. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  16144. event is logged without consulting the remaining filters.
  16145. </para>
  16146. <para>
  16147. The philosophy of log4net filters is largely inspired from the
  16148. Linux ipchains.
  16149. </para>
  16150. </remarks>
  16151. <author>Nicko Cadell</author>
  16152. <author>Gert Driesen</author>
  16153. </member>
  16154. <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
  16155. <summary>
  16156. Decide if the logging event should be logged through an appender.
  16157. </summary>
  16158. <param name="loggingEvent">The LoggingEvent to decide upon</param>
  16159. <returns>The decision of the filter</returns>
  16160. <remarks>
  16161. <para>
  16162. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  16163. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  16164. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  16165. the event will be logged without consulting with other filters in
  16166. the chain.
  16167. </para>
  16168. </remarks>
  16169. </member>
  16170. <member name="P:log4net.Filter.IFilter.Next">
  16171. <summary>
  16172. Property to get and set the next filter
  16173. </summary>
  16174. <value>
  16175. The next filter in the chain
  16176. </value>
  16177. <remarks>
  16178. <para>
  16179. Filters are typically composed into chains. This property allows the next filter in
  16180. the chain to be accessed.
  16181. </para>
  16182. </remarks>
  16183. </member>
  16184. <member name="F:log4net.Filter.FilterSkeleton.m_next">
  16185. <summary>
  16186. Points to the next filter in the filter chain.
  16187. </summary>
  16188. <remarks>
  16189. <para>
  16190. See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
  16191. </para>
  16192. </remarks>
  16193. </member>
  16194. <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
  16195. <summary>
  16196. Initialize the filter with the options set
  16197. </summary>
  16198. <remarks>
  16199. <para>
  16200. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16201. activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
  16202. be called on this object after the configuration properties have
  16203. been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
  16204. object is in an undefined state and must not be used.
  16205. </para>
  16206. <para>
  16207. If any of the configuration properties are modified then
  16208. <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
  16209. </para>
  16210. <para>
  16211. Typically filter's options become active immediately on set,
  16212. however this method must still be called.
  16213. </para>
  16214. </remarks>
  16215. </member>
  16216. <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
  16217. <summary>
  16218. Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
  16219. </summary>
  16220. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
  16221. <returns>The decision of the filter</returns>
  16222. <remarks>
  16223. <para>
  16224. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  16225. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  16226. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  16227. the event will be logged without consulting with other filters in
  16228. the chain.
  16229. </para>
  16230. <para>
  16231. This method is marked <c>abstract</c> and must be implemented
  16232. in a subclass.
  16233. </para>
  16234. </remarks>
  16235. </member>
  16236. <member name="P:log4net.Filter.FilterSkeleton.Next">
  16237. <summary>
  16238. Property to get and set the next filter
  16239. </summary>
  16240. <value>
  16241. The next filter in the chain
  16242. </value>
  16243. <remarks>
  16244. <para>
  16245. Filters are typically composed into chains. This property allows the next filter in
  16246. the chain to be accessed.
  16247. </para>
  16248. </remarks>
  16249. </member>
  16250. <member name="M:log4net.Filter.DenyAllFilter.#ctor">
  16251. <summary>
  16252. Default constructor
  16253. </summary>
  16254. </member>
  16255. <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
  16256. <summary>
  16257. Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  16258. </summary>
  16259. <param name="loggingEvent">the LoggingEvent to filter</param>
  16260. <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
  16261. <remarks>
  16262. <para>
  16263. Ignores the event being logged and just returns
  16264. <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
  16265. chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
  16266. should only be used as the last filter in the chain
  16267. as any further filters will be ignored!
  16268. </para>
  16269. </remarks>
  16270. </member>
  16271. <member name="T:log4net.Filter.FilterDecision">
  16272. <summary>
  16273. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16274. </summary>
  16275. <remarks>
  16276. <para>
  16277. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  16278. </para>
  16279. </remarks>
  16280. </member>
  16281. <member name="F:log4net.Filter.FilterDecision.Deny">
  16282. <summary>
  16283. The log event must be dropped immediately without
  16284. consulting with the remaining filters, if any, in the chain.
  16285. </summary>
  16286. </member>
  16287. <member name="F:log4net.Filter.FilterDecision.Neutral">
  16288. <summary>
  16289. This filter is neutral with respect to the log event.
  16290. The remaining filters, if any, should be consulted for a final decision.
  16291. </summary>
  16292. </member>
  16293. <member name="F:log4net.Filter.FilterDecision.Accept">
  16294. <summary>
  16295. The log event must be logged immediately without
  16296. consulting with the remaining filters, if any, in the chain.
  16297. </summary>
  16298. </member>
  16299. <member name="T:log4net.Filter.LevelMatchFilter">
  16300. <summary>
  16301. This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  16302. </summary>
  16303. <remarks>
  16304. <para>
  16305. The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
  16306. <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
  16307. of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
  16308. <see cref="T:log4net.Core.LoggingEvent"/>, then the <see cref="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
  16309. case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
  16310. to <c>true</c>, if it is <c>false</c> then
  16311. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
  16312. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  16313. </para>
  16314. </remarks>
  16315. <author>Nicko Cadell</author>
  16316. <author>Gert Driesen</author>
  16317. </member>
  16318. <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
  16319. <summary>
  16320. flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
  16321. </summary>
  16322. </member>
  16323. <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
  16324. <summary>
  16325. the <see cref="T:log4net.Core.Level"/> to match against
  16326. </summary>
  16327. </member>
  16328. <member name="M:log4net.Filter.LevelMatchFilter.#ctor">
  16329. <summary>
  16330. Default constructor
  16331. </summary>
  16332. </member>
  16333. <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16334. <summary>
  16335. Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
  16336. </summary>
  16337. <param name="loggingEvent">the event to filter</param>
  16338. <returns>see remarks</returns>
  16339. <remarks>
  16340. <para>
  16341. If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
  16342. filter then the result of the function depends on the
  16343. value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
  16344. the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
  16345. will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
  16346. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  16347. </para>
  16348. </remarks>
  16349. </member>
  16350. <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
  16351. <summary>
  16352. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
  16353. </summary>
  16354. <remarks>
  16355. <para>
  16356. The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16357. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16358. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16359. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  16360. </para>
  16361. <para>
  16362. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16363. </para>
  16364. </remarks>
  16365. </member>
  16366. <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
  16367. <summary>
  16368. The <see cref="T:log4net.Core.Level"/> that the filter will match
  16369. </summary>
  16370. <remarks>
  16371. <para>
  16372. The level that this filter will attempt to match against the
  16373. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16374. the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
  16375. </para>
  16376. </remarks>
  16377. </member>
  16378. <member name="T:log4net.Filter.LevelRangeFilter">
  16379. <summary>
  16380. This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  16381. </summary>
  16382. <remarks>
  16383. <para>
  16384. The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  16385. that determine the range of priorities that are matched, and
  16386. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
  16387. of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
  16388. <see cref="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in case the <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>
  16389. option value is set to <c>true</c>, if it is <c>false</c>
  16390. then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16391. </para>
  16392. </remarks>
  16393. <author>Nicko Cadell</author>
  16394. <author>Gert Driesen</author>
  16395. </member>
  16396. <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
  16397. <summary>
  16398. Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
  16399. </summary>
  16400. </member>
  16401. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
  16402. <summary>
  16403. the minimum <see cref="T:log4net.Core.Level"/> value to match
  16404. </summary>
  16405. </member>
  16406. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
  16407. <summary>
  16408. the maximum <see cref="T:log4net.Core.Level"/> value to match
  16409. </summary>
  16410. </member>
  16411. <member name="M:log4net.Filter.LevelRangeFilter.#ctor">
  16412. <summary>
  16413. Default constructor
  16414. </summary>
  16415. </member>
  16416. <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
  16417. <summary>
  16418. Check if the event should be logged.
  16419. </summary>
  16420. <param name="loggingEvent">the logging event to check</param>
  16421. <returns>see remarks</returns>
  16422. <remarks>
  16423. <para>
  16424. If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
  16425. matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  16426. is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
  16427. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
  16428. <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
  16429. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
  16430. </para>
  16431. </remarks>
  16432. </member>
  16433. <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
  16434. <summary>
  16435. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  16436. </summary>
  16437. <remarks>
  16438. <para>
  16439. The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
  16440. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16441. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16442. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  16443. </para>
  16444. <para>
  16445. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16446. </para>
  16447. </remarks>
  16448. </member>
  16449. <member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
  16450. <summary>
  16451. Set the minimum matched <see cref="T:log4net.Core.Level"/>
  16452. </summary>
  16453. <remarks>
  16454. <para>
  16455. The minimum level that this filter will attempt to match against the
  16456. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16457. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  16458. </para>
  16459. </remarks>
  16460. </member>
  16461. <member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
  16462. <summary>
  16463. Sets the maximum matched <see cref="T:log4net.Core.Level"/>
  16464. </summary>
  16465. <remarks>
  16466. <para>
  16467. The maximum level that this filter will attempt to match against the
  16468. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  16469. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  16470. </para>
  16471. </remarks>
  16472. </member>
  16473. <member name="T:log4net.Filter.LoggerMatchFilter">
  16474. <summary>
  16475. Simple filter to match a string in the event's logger name.
  16476. </summary>
  16477. <remarks>
  16478. <para>
  16479. The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
  16480. options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
  16481. <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
  16482. with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
  16483. <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
  16484. case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
  16485. if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16486. </para>
  16487. </remarks>
  16488. <author>Daniel Cazzulino</author>
  16489. </member>
  16490. <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
  16491. <summary>
  16492. Flag to indicate the behavior when we have a match
  16493. </summary>
  16494. </member>
  16495. <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
  16496. <summary>
  16497. The logger name string to substring match against the event
  16498. </summary>
  16499. </member>
  16500. <member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
  16501. <summary>
  16502. Default constructor
  16503. </summary>
  16504. </member>
  16505. <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16506. <summary>
  16507. Check if this filter should allow the event to be logged
  16508. </summary>
  16509. <param name="loggingEvent">the event being logged</param>
  16510. <returns>see remarks</returns>
  16511. <remarks>
  16512. <para>
  16513. The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
  16514. If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
  16515. the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
  16516. then a match will have occurred. If no match occurs
  16517. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16518. allowing other filters to check the event. If a match occurs then
  16519. the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
  16520. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16521. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16522. </para>
  16523. </remarks>
  16524. </member>
  16525. <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
  16526. <summary>
  16527. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
  16528. </summary>
  16529. <remarks>
  16530. <para>
  16531. The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16532. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16533. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16534. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  16535. </para>
  16536. <para>
  16537. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16538. </para>
  16539. </remarks>
  16540. </member>
  16541. <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
  16542. <summary>
  16543. The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
  16544. </summary>
  16545. <remarks>
  16546. <para>
  16547. This filter will attempt to match this value against logger name in
  16548. the following way. The match will be done against the beginning of the
  16549. logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
  16550. case sensitive. If a match is found then
  16551. the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
  16552. </para>
  16553. </remarks>
  16554. </member>
  16555. <member name="T:log4net.Filter.MdcFilter">
  16556. <summary>
  16557. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  16558. </summary>
  16559. <remarks>
  16560. <para>
  16561. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  16562. </para>
  16563. <para>
  16564. As the MDC has been replaced with layered properties the
  16565. <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
  16566. </para>
  16567. </remarks>
  16568. <author>Nicko Cadell</author>
  16569. <author>Gert Driesen</author>
  16570. </member>
  16571. <member name="T:log4net.Filter.PropertyFilter">
  16572. <summary>
  16573. Simple filter to match a string an event property
  16574. </summary>
  16575. <remarks>
  16576. <para>
  16577. Simple filter to match a string in the value for a
  16578. specific event property
  16579. </para>
  16580. </remarks>
  16581. <author>Nicko Cadell</author>
  16582. </member>
  16583. <member name="T:log4net.Filter.StringMatchFilter">
  16584. <summary>
  16585. Simple filter to match a string in the rendered message
  16586. </summary>
  16587. <remarks>
  16588. <para>
  16589. Simple filter to match a string in the rendered message
  16590. </para>
  16591. </remarks>
  16592. <author>Nicko Cadell</author>
  16593. <author>Gert Driesen</author>
  16594. </member>
  16595. <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
  16596. <summary>
  16597. Flag to indicate the behavior when we have a match
  16598. </summary>
  16599. </member>
  16600. <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
  16601. <summary>
  16602. The string to substring match against the message
  16603. </summary>
  16604. </member>
  16605. <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
  16606. <summary>
  16607. A string regex to match
  16608. </summary>
  16609. </member>
  16610. <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
  16611. <summary>
  16612. A regex object to match (generated from m_stringRegexToMatch)
  16613. </summary>
  16614. </member>
  16615. <member name="M:log4net.Filter.StringMatchFilter.#ctor">
  16616. <summary>
  16617. Default constructor
  16618. </summary>
  16619. </member>
  16620. <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
  16621. <summary>
  16622. Initialize and precompile the Regex if required
  16623. </summary>
  16624. <remarks>
  16625. <para>
  16626. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16627. activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
  16628. be called on this object after the configuration properties have
  16629. been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
  16630. object is in an undefined state and must not be used.
  16631. </para>
  16632. <para>
  16633. If any of the configuration properties are modified then
  16634. <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
  16635. </para>
  16636. </remarks>
  16637. </member>
  16638. <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
  16639. <summary>
  16640. Check if this filter should allow the event to be logged
  16641. </summary>
  16642. <param name="loggingEvent">the event being logged</param>
  16643. <returns>see remarks</returns>
  16644. <remarks>
  16645. <para>
  16646. The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  16647. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  16648. the message then a match will have occurred. If no match occurs
  16649. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16650. allowing other filters to check the event. If a match occurs then
  16651. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  16652. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16653. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16654. </para>
  16655. </remarks>
  16656. </member>
  16657. <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
  16658. <summary>
  16659. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16660. </summary>
  16661. <remarks>
  16662. <para>
  16663. The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
  16664. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  16665. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  16666. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  16667. </para>
  16668. <para>
  16669. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  16670. </para>
  16671. </remarks>
  16672. </member>
  16673. <member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
  16674. <summary>
  16675. Sets the static string to match
  16676. </summary>
  16677. <remarks>
  16678. <para>
  16679. The string that will be substring matched against
  16680. the rendered message. If the message contains this
  16681. string then the filter will match. If a match is found then
  16682. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  16683. </para>
  16684. <para>
  16685. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16686. must be specified.
  16687. </para>
  16688. </remarks>
  16689. </member>
  16690. <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
  16691. <summary>
  16692. Sets the regular expression to match
  16693. </summary>
  16694. <remarks>
  16695. <para>
  16696. The regular expression pattern that will be matched against
  16697. the rendered message. If the message matches this
  16698. pattern then the filter will match. If a match is found then
  16699. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  16700. </para>
  16701. <para>
  16702. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  16703. must be specified.
  16704. </para>
  16705. </remarks>
  16706. </member>
  16707. <member name="F:log4net.Filter.PropertyFilter.m_key">
  16708. <summary>
  16709. The key to use to lookup the string from the event properties
  16710. </summary>
  16711. </member>
  16712. <member name="M:log4net.Filter.PropertyFilter.#ctor">
  16713. <summary>
  16714. Default constructor
  16715. </summary>
  16716. </member>
  16717. <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
  16718. <summary>
  16719. Check if this filter should allow the event to be logged
  16720. </summary>
  16721. <param name="loggingEvent">the event being logged</param>
  16722. <returns>see remarks</returns>
  16723. <remarks>
  16724. <para>
  16725. The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
  16726. the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  16727. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  16728. the property value then a match will have occurred. If no match occurs
  16729. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  16730. allowing other filters to check the event. If a match occurs then
  16731. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  16732. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  16733. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  16734. </para>
  16735. </remarks>
  16736. </member>
  16737. <member name="P:log4net.Filter.PropertyFilter.Key">
  16738. <summary>
  16739. The key to lookup in the event properties and then match against.
  16740. </summary>
  16741. <remarks>
  16742. <para>
  16743. The key name to use to lookup in the properties map of the
  16744. <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
  16745. the value of this property if it exists.
  16746. </para>
  16747. </remarks>
  16748. </member>
  16749. <member name="T:log4net.Filter.NdcFilter">
  16750. <summary>
  16751. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  16752. </summary>
  16753. <remarks>
  16754. <para>
  16755. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  16756. </para>
  16757. <para>
  16758. As the MDC has been replaced with named stacks stored in the
  16759. properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
  16760. be used instead.
  16761. </para>
  16762. </remarks>
  16763. <author>Nicko Cadell</author>
  16764. <author>Gert Driesen</author>
  16765. </member>
  16766. <member name="M:log4net.Filter.NdcFilter.#ctor">
  16767. <summary>
  16768. Default constructor
  16769. </summary>
  16770. <remarks>
  16771. <para>
  16772. Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
  16773. </para>
  16774. </remarks>
  16775. </member>
  16776. <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
  16777. <summary>
  16778. Write the event appdomain name to the output
  16779. </summary>
  16780. <remarks>
  16781. <para>
  16782. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
  16783. </para>
  16784. </remarks>
  16785. <author>Daniel Cazzulino</author>
  16786. <author>Nicko Cadell</author>
  16787. </member>
  16788. <member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
  16789. <summary>
  16790. Abstract class that provides the formatting functionality that
  16791. derived classes need.
  16792. </summary>
  16793. <remarks>
  16794. Conversion specifiers in a conversion patterns are parsed to
  16795. individual PatternConverters. Each of which is responsible for
  16796. converting a logging event in a converter specific manner.
  16797. </remarks>
  16798. <author>Nicko Cadell</author>
  16799. </member>
  16800. <member name="T:log4net.Util.PatternConverter">
  16801. <summary>
  16802. Abstract class that provides the formatting functionality that
  16803. derived classes need.
  16804. </summary>
  16805. <remarks>
  16806. <para>
  16807. Conversion specifiers in a conversion patterns are parsed to
  16808. individual PatternConverters. Each of which is responsible for
  16809. converting a logging event in a converter specific manner.
  16810. </para>
  16811. </remarks>
  16812. <author>Nicko Cadell</author>
  16813. <author>Gert Driesen</author>
  16814. </member>
  16815. <member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
  16816. <summary>
  16817. Initial buffer size
  16818. </summary>
  16819. </member>
  16820. <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
  16821. <summary>
  16822. Maximum buffer size before it is recycled
  16823. </summary>
  16824. </member>
  16825. <member name="M:log4net.Util.PatternConverter.#ctor">
  16826. <summary>
  16827. Protected constructor
  16828. </summary>
  16829. <remarks>
  16830. <para>
  16831. Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter"/> class.
  16832. </para>
  16833. </remarks>
  16834. </member>
  16835. <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
  16836. <summary>
  16837. Evaluate this pattern converter and write the output to a writer.
  16838. </summary>
  16839. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  16840. <param name="state">The state object on which the pattern converter should be executed.</param>
  16841. <remarks>
  16842. <para>
  16843. Derived pattern converters must override this method in order to
  16844. convert conversion specifiers in the appropriate way.
  16845. </para>
  16846. </remarks>
  16847. </member>
  16848. <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
  16849. <summary>
  16850. Set the next pattern converter in the chains
  16851. </summary>
  16852. <param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
  16853. <returns>the next converter</returns>
  16854. <remarks>
  16855. <para>
  16856. The PatternConverter can merge with its neighbor during this method (or a sub class).
  16857. Therefore the return value may or may not be the value of the argument passed in.
  16858. </para>
  16859. </remarks>
  16860. </member>
  16861. <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
  16862. <summary>
  16863. Write the pattern converter to the writer with appropriate formatting
  16864. </summary>
  16865. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  16866. <param name="state">The state object on which the pattern converter should be executed.</param>
  16867. <remarks>
  16868. <para>
  16869. This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
  16870. appropriate conversion of the pattern converter. If formatting options have
  16871. been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
  16872. apply those formattings before writing the output.
  16873. </para>
  16874. </remarks>
  16875. </member>
  16876. <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
  16877. <summary>
  16878. Fast space padding method.
  16879. </summary>
  16880. <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the spaces will be appended.</param>
  16881. <param name="length">The number of spaces to be padded.</param>
  16882. <remarks>
  16883. <para>
  16884. Fast space padding method.
  16885. </para>
  16886. </remarks>
  16887. </member>
  16888. <member name="F:log4net.Util.PatternConverter.m_option">
  16889. <summary>
  16890. The option string to the converter
  16891. </summary>
  16892. </member>
  16893. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
  16894. <summary>
  16895. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  16896. </summary>
  16897. <param name="writer">the writer to write to</param>
  16898. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  16899. <param name="value">the value to write to the writer</param>
  16900. <remarks>
  16901. <para>
  16902. Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
  16903. </para>
  16904. <code>
  16905. {key1=value1, key2=value2, key3=value3}
  16906. </code>
  16907. <para>
  16908. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  16909. is not null then it is used to render the key and value to text, otherwise
  16910. the object's ToString method is called.
  16911. </para>
  16912. </remarks>
  16913. </member>
  16914. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
  16915. <summary>
  16916. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  16917. </summary>
  16918. <param name="writer">the writer to write to</param>
  16919. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  16920. <param name="value">the value to write to the writer</param>
  16921. <remarks>
  16922. <para>
  16923. Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
  16924. </para>
  16925. <code>
  16926. {key1=value1, key2=value2, key3=value3}
  16927. </code>
  16928. <para>
  16929. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  16930. is not null then it is used to render the key and value to text, otherwise
  16931. the object's ToString method is called.
  16932. </para>
  16933. </remarks>
  16934. </member>
  16935. <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
  16936. <summary>
  16937. Write an object to a <see cref="T:System.IO.TextWriter"/>
  16938. </summary>
  16939. <param name="writer">the writer to write to</param>
  16940. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  16941. <param name="value">the value to write to the writer</param>
  16942. <remarks>
  16943. <para>
  16944. Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  16945. is not null then it is used to render the object to text, otherwise
  16946. the object's ToString method is called.
  16947. </para>
  16948. </remarks>
  16949. </member>
  16950. <member name="P:log4net.Util.PatternConverter.Next">
  16951. <summary>
  16952. Get the next pattern converter in the chain
  16953. </summary>
  16954. <value>
  16955. the next pattern converter in the chain
  16956. </value>
  16957. <remarks>
  16958. <para>
  16959. Get the next pattern converter in the chain
  16960. </para>
  16961. </remarks>
  16962. </member>
  16963. <member name="P:log4net.Util.PatternConverter.FormattingInfo">
  16964. <summary>
  16965. Gets or sets the formatting info for this converter
  16966. </summary>
  16967. <value>
  16968. The formatting info for this converter
  16969. </value>
  16970. <remarks>
  16971. <para>
  16972. Gets or sets the formatting info for this converter
  16973. </para>
  16974. </remarks>
  16975. </member>
  16976. <member name="P:log4net.Util.PatternConverter.Option">
  16977. <summary>
  16978. Gets or sets the option value for this converter
  16979. </summary>
  16980. <summary>
  16981. The option for this converter
  16982. </summary>
  16983. <remarks>
  16984. <para>
  16985. Gets or sets the option value for this converter
  16986. </para>
  16987. </remarks>
  16988. </member>
  16989. <member name="P:log4net.Util.PatternConverter.Properties">
  16990. <summary>
  16991. </summary>
  16992. </member>
  16993. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
  16994. <summary>
  16995. Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter"/> class.
  16996. </summary>
  16997. </member>
  16998. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16999. <summary>
  17000. Derived pattern converters must override this method in order to
  17001. convert conversion specifiers in the correct way.
  17002. </summary>
  17003. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17004. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17005. </member>
  17006. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
  17007. <summary>
  17008. Derived pattern converters must override this method in order to
  17009. convert conversion specifiers in the correct way.
  17010. </summary>
  17011. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17012. <param name="state">The state object on which the pattern converter should be executed.</param>
  17013. </member>
  17014. <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
  17015. <summary>
  17016. Flag indicating if this converter handles exceptions
  17017. </summary>
  17018. <remarks>
  17019. <c>false</c> if this converter handles exceptions
  17020. </remarks>
  17021. </member>
  17022. <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
  17023. <summary>
  17024. Flag indicating if this converter handles the logging event exception
  17025. </summary>
  17026. <value><c>false</c> if this converter handles the logging event exception</value>
  17027. <remarks>
  17028. <para>
  17029. If this converter handles the exception object contained within
  17030. <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
  17031. <c>false</c>. Otherwise, if the layout ignores the exception
  17032. object, then the property should be set to <c>true</c>.
  17033. </para>
  17034. <para>
  17035. Set this value to override a this default setting. The default
  17036. value is <c>true</c>, this converter does not handle the exception.
  17037. </para>
  17038. </remarks>
  17039. </member>
  17040. <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17041. <summary>
  17042. Write the event appdomain name to the output
  17043. </summary>
  17044. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17045. <param name="loggingEvent">the event being logged</param>
  17046. <remarks>
  17047. <para>
  17048. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
  17049. </para>
  17050. </remarks>
  17051. </member>
  17052. <member name="T:log4net.Layout.Pattern.AspNetCachePatternConverter">
  17053. <summary>
  17054. Converter for items in the ASP.Net Cache.
  17055. </summary>
  17056. <remarks>
  17057. <para>
  17058. Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
  17059. </para>
  17060. </remarks>
  17061. <author>Ron Grabowski</author>
  17062. </member>
  17063. <member name="T:log4net.Layout.Pattern.AspNetPatternLayoutConverter">
  17064. <summary>
  17065. Abstract class that provides access to the current HttpContext (<see cref="P:System.Web.HttpContext.Current"/>) that
  17066. derived classes need.
  17067. </summary>
  17068. <remarks>
  17069. This class handles the case when HttpContext.Current is null by writing
  17070. <see cref="P:log4net.Util.SystemInfo.NotAvailableText"/> to the writer.
  17071. </remarks>
  17072. <author>Ron Grabowski</author>
  17073. </member>
  17074. <member name="M:log4net.Layout.Pattern.AspNetPatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17075. <summary>
  17076. Derived pattern converters must override this method in order to
  17077. convert conversion specifiers in the correct way.
  17078. </summary>
  17079. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17080. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17081. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17082. </member>
  17083. <member name="M:log4net.Layout.Pattern.AspNetCachePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17084. <summary>
  17085. Write the ASP.Net Cache item to the output
  17086. </summary>
  17087. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17088. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17089. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17090. <remarks>
  17091. <para>
  17092. Writes out the value of a named property. The property name
  17093. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17094. property. If no property has been set, all key value pairs from the Cache will
  17095. be written to the output.
  17096. </para>
  17097. </remarks>
  17098. </member>
  17099. <member name="T:log4net.Layout.Pattern.AspNetContextPatternConverter">
  17100. <summary>
  17101. Converter for items in the <see cref="T:System.Web.HttpContext"/>.
  17102. </summary>
  17103. <remarks>
  17104. <para>
  17105. Outputs an item from the <see cref="T:System.Web.HttpContext"/>.
  17106. </para>
  17107. </remarks>
  17108. <author>Ron Grabowski</author>
  17109. </member>
  17110. <member name="M:log4net.Layout.Pattern.AspNetContextPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17111. <summary>
  17112. Write the ASP.Net HttpContext item to the output
  17113. </summary>
  17114. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17115. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17116. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17117. <remarks>
  17118. <para>
  17119. Writes out the value of a named property. The property name
  17120. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17121. property.
  17122. </para>
  17123. </remarks>
  17124. </member>
  17125. <member name="T:log4net.Layout.Pattern.AspNetRequestPatternConverter">
  17126. <summary>
  17127. Converter for items in the ASP.Net Cache.
  17128. </summary>
  17129. <remarks>
  17130. <para>
  17131. Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
  17132. </para>
  17133. </remarks>
  17134. <author>Ron Grabowski</author>
  17135. </member>
  17136. <member name="M:log4net.Layout.Pattern.AspNetRequestPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17137. <summary>
  17138. Write the ASP.Net Cache item to the output
  17139. </summary>
  17140. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17141. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17142. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17143. <remarks>
  17144. <para>
  17145. Writes out the value of a named property. The property name
  17146. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17147. property.
  17148. </para>
  17149. </remarks>
  17150. </member>
  17151. <member name="T:log4net.Layout.Pattern.AspNetSessionPatternConverter">
  17152. <summary>
  17153. Converter for items in the ASP.Net Cache.
  17154. </summary>
  17155. <remarks>
  17156. <para>
  17157. Outputs an item from the <see cref="P:System.Web.HttpRuntime.Cache"/>.
  17158. </para>
  17159. </remarks>
  17160. <author>Ron Grabowski</author>
  17161. </member>
  17162. <member name="M:log4net.Layout.Pattern.AspNetSessionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent,System.Web.HttpContext)">
  17163. <summary>
  17164. Write the ASP.Net Cache item to the output
  17165. </summary>
  17166. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17167. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> on which the pattern converter should be executed.</param>
  17168. <param name="httpContext">The <see cref="T:System.Web.HttpContext"/> under which the ASP.Net request is running.</param>
  17169. <remarks>
  17170. <para>
  17171. Writes out the value of a named property. The property name
  17172. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17173. property. If no property has been set, all key value pairs from the Session will
  17174. be written to the output.
  17175. </para>
  17176. </remarks>
  17177. </member>
  17178. <member name="T:log4net.Layout.Pattern.DatePatternConverter">
  17179. <summary>
  17180. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  17181. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  17182. </summary>
  17183. <remarks>
  17184. <para>
  17185. Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
  17186. </para>
  17187. <para>
  17188. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  17189. the formatting of the date. The following values are allowed:
  17190. <list type="definition">
  17191. <listheader>
  17192. <term>Option value</term>
  17193. <description>Output</description>
  17194. </listheader>
  17195. <item>
  17196. <term>ISO8601</term>
  17197. <description>
  17198. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  17199. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  17200. </description>
  17201. </item>
  17202. <item>
  17203. <term>DATE</term>
  17204. <description>
  17205. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  17206. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  17207. </description>
  17208. </item>
  17209. <item>
  17210. <term>ABSOLUTE</term>
  17211. <description>
  17212. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  17213. Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
  17214. </description>
  17215. </item>
  17216. <item>
  17217. <term>other</term>
  17218. <description>
  17219. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  17220. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  17221. <see cref="M:DateTime.ToString(string)"/> method.
  17222. For details on valid patterns see
  17223. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  17224. </description>
  17225. </item>
  17226. </list>
  17227. </para>
  17228. <para>
  17229. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
  17230. To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
  17231. </para>
  17232. </remarks>
  17233. <author>Nicko Cadell</author>
  17234. </member>
  17235. <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
  17236. <summary>
  17237. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  17238. </summary>
  17239. <remarks>
  17240. <para>
  17241. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  17242. </para>
  17243. </remarks>
  17244. </member>
  17245. <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
  17246. <summary>
  17247. Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  17248. </summary>
  17249. <remarks>
  17250. <para>
  17251. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17252. activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
  17253. be called on this object after the configuration properties have
  17254. been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
  17255. object is in an undefined state and must not be used.
  17256. </para>
  17257. <para>
  17258. If any of the configuration properties are modified then
  17259. <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
  17260. </para>
  17261. </remarks>
  17262. </member>
  17263. <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17264. <summary>
  17265. Convert the pattern into the rendered message
  17266. </summary>
  17267. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17268. <param name="loggingEvent">the event being logged</param>
  17269. <remarks>
  17270. <para>
  17271. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  17272. for it to render it to the writer.
  17273. </para>
  17274. <para>
  17275. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
  17276. </para>
  17277. </remarks>
  17278. </member>
  17279. <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
  17280. <summary>
  17281. The fully qualified type of the DatePatternConverter class.
  17282. </summary>
  17283. <remarks>
  17284. Used by the internal logger to record the Type of the
  17285. log message.
  17286. </remarks>
  17287. </member>
  17288. <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
  17289. <summary>
  17290. Write the exception text to the output
  17291. </summary>
  17292. <remarks>
  17293. <para>
  17294. If an exception object is stored in the logging event
  17295. it will be rendered into the pattern output with a
  17296. trailing newline.
  17297. </para>
  17298. <para>
  17299. If there is no exception then nothing will be output
  17300. and no trailing newline will be appended.
  17301. It is typical to put a newline before the exception
  17302. and to have the exception as the last data in the pattern.
  17303. </para>
  17304. </remarks>
  17305. <author>Nicko Cadell</author>
  17306. </member>
  17307. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
  17308. <summary>
  17309. Default constructor
  17310. </summary>
  17311. </member>
  17312. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17313. <summary>
  17314. Write the exception text to the output
  17315. </summary>
  17316. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17317. <param name="loggingEvent">the event being logged</param>
  17318. <remarks>
  17319. <para>
  17320. If an exception object is stored in the logging event
  17321. it will be rendered into the pattern output with a
  17322. trailing newline.
  17323. </para>
  17324. <para>
  17325. If there is no exception or the exception property specified
  17326. by the Option value does not exist then nothing will be output
  17327. and no trailing newline will be appended.
  17328. It is typical to put a newline before the exception
  17329. and to have the exception as the last data in the pattern.
  17330. </para>
  17331. <para>
  17332. Recognized values for the Option parameter are:
  17333. </para>
  17334. <list type="bullet">
  17335. <item>
  17336. <description>Message</description>
  17337. </item>
  17338. <item>
  17339. <description>Source</description>
  17340. </item>
  17341. <item>
  17342. <description>StackTrace</description>
  17343. </item>
  17344. <item>
  17345. <description>TargetSite</description>
  17346. </item>
  17347. <item>
  17348. <description>HelpLink</description>
  17349. </item>
  17350. </list>
  17351. </remarks>
  17352. </member>
  17353. <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
  17354. <summary>
  17355. Writes the caller location file name to the output
  17356. </summary>
  17357. <remarks>
  17358. <para>
  17359. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  17360. the event to the output writer.
  17361. </para>
  17362. </remarks>
  17363. <author>Nicko Cadell</author>
  17364. </member>
  17365. <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17366. <summary>
  17367. Write the caller location file name to the output
  17368. </summary>
  17369. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17370. <param name="loggingEvent">the event being logged</param>
  17371. <remarks>
  17372. <para>
  17373. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  17374. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  17375. </para>
  17376. </remarks>
  17377. </member>
  17378. <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
  17379. <summary>
  17380. Write the caller location info to the output
  17381. </summary>
  17382. <remarks>
  17383. <para>
  17384. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  17385. </para>
  17386. </remarks>
  17387. <author>Nicko Cadell</author>
  17388. </member>
  17389. <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17390. <summary>
  17391. Write the caller location info to the output
  17392. </summary>
  17393. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17394. <param name="loggingEvent">the event being logged</param>
  17395. <remarks>
  17396. <para>
  17397. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  17398. </para>
  17399. </remarks>
  17400. </member>
  17401. <member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
  17402. <summary>
  17403. Writes the event identity to the output
  17404. </summary>
  17405. <remarks>
  17406. <para>
  17407. Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17408. the output writer.
  17409. </para>
  17410. </remarks>
  17411. <author>Daniel Cazzulino</author>
  17412. <author>Nicko Cadell</author>
  17413. </member>
  17414. <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17415. <summary>
  17416. Writes the event identity to the output
  17417. </summary>
  17418. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17419. <param name="loggingEvent">the event being logged</param>
  17420. <remarks>
  17421. <para>
  17422. Writes the value of the <paramref name="loggingEvent"/>
  17423. <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17424. the output <paramref name="writer"/>.
  17425. </para>
  17426. </remarks>
  17427. </member>
  17428. <member name="T:log4net.Layout.Pattern.LevelPatternConverter">
  17429. <summary>
  17430. Write the event level to the output
  17431. </summary>
  17432. <remarks>
  17433. <para>
  17434. Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17435. to the writer.
  17436. </para>
  17437. </remarks>
  17438. <author>Nicko Cadell</author>
  17439. </member>
  17440. <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17441. <summary>
  17442. Write the event level to the output
  17443. </summary>
  17444. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17445. <param name="loggingEvent">the event being logged</param>
  17446. <remarks>
  17447. <para>
  17448. Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17449. to the <paramref name="writer"/>.
  17450. </para>
  17451. </remarks>
  17452. </member>
  17453. <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
  17454. <summary>
  17455. Write the caller location line number to the output
  17456. </summary>
  17457. <remarks>
  17458. <para>
  17459. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17460. the event to the output writer.
  17461. </para>
  17462. </remarks>
  17463. <author>Nicko Cadell</author>
  17464. </member>
  17465. <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17466. <summary>
  17467. Write the caller location line number to the output
  17468. </summary>
  17469. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17470. <param name="loggingEvent">the event being logged</param>
  17471. <remarks>
  17472. <para>
  17473. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17474. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  17475. </para>
  17476. </remarks>
  17477. </member>
  17478. <member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
  17479. <summary>
  17480. Converter for logger name
  17481. </summary>
  17482. <remarks>
  17483. <para>
  17484. Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
  17485. </para>
  17486. </remarks>
  17487. <author>Nicko Cadell</author>
  17488. </member>
  17489. <member name="T:log4net.Layout.Pattern.NamedPatternConverter">
  17490. <summary>
  17491. Converter to output and truncate <c>'.'</c> separated strings
  17492. </summary>
  17493. <remarks>
  17494. <para>
  17495. This abstract class supports truncating a <c>'.'</c> separated string
  17496. to show a specified number of elements from the right hand side.
  17497. This is used to truncate class names that are fully qualified.
  17498. </para>
  17499. <para>
  17500. Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
  17501. return the fully qualified string.
  17502. </para>
  17503. </remarks>
  17504. <author>Nicko Cadell</author>
  17505. </member>
  17506. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
  17507. <summary>
  17508. Initialize the converter
  17509. </summary>
  17510. <remarks>
  17511. <para>
  17512. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17513. activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
  17514. be called on this object after the configuration properties have
  17515. been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
  17516. object is in an undefined state and must not be used.
  17517. </para>
  17518. <para>
  17519. If any of the configuration properties are modified then
  17520. <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
  17521. </para>
  17522. </remarks>
  17523. </member>
  17524. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17525. <summary>
  17526. Get the fully qualified string data
  17527. </summary>
  17528. <param name="loggingEvent">the event being logged</param>
  17529. <returns>the fully qualified name</returns>
  17530. <remarks>
  17531. <para>
  17532. Overridden by subclasses to get the fully qualified name before the
  17533. precision is applied to it.
  17534. </para>
  17535. <para>
  17536. Return the fully qualified <c>'.'</c> (dot/period) separated string.
  17537. </para>
  17538. </remarks>
  17539. </member>
  17540. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17541. <summary>
  17542. Convert the pattern to the rendered message
  17543. </summary>
  17544. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17545. <param name="loggingEvent">the event being logged</param>
  17546. <remarks>
  17547. Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
  17548. specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  17549. </remarks>
  17550. </member>
  17551. <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
  17552. <summary>
  17553. The fully qualified type of the NamedPatternConverter class.
  17554. </summary>
  17555. <remarks>
  17556. Used by the internal logger to record the Type of the
  17557. log message.
  17558. </remarks>
  17559. </member>
  17560. <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17561. <summary>
  17562. Gets the fully qualified name of the logger
  17563. </summary>
  17564. <param name="loggingEvent">the event being logged</param>
  17565. <returns>The fully qualified logger name</returns>
  17566. <remarks>
  17567. <para>
  17568. Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
  17569. </para>
  17570. </remarks>
  17571. </member>
  17572. <member name="T:log4net.Layout.Pattern.MessagePatternConverter">
  17573. <summary>
  17574. Writes the event message to the output
  17575. </summary>
  17576. <remarks>
  17577. <para>
  17578. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  17579. to write out the event message.
  17580. </para>
  17581. </remarks>
  17582. <author>Nicko Cadell</author>
  17583. </member>
  17584. <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17585. <summary>
  17586. Writes the event message to the output
  17587. </summary>
  17588. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17589. <param name="loggingEvent">the event being logged</param>
  17590. <remarks>
  17591. <para>
  17592. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  17593. to write out the event message.
  17594. </para>
  17595. </remarks>
  17596. </member>
  17597. <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
  17598. <summary>
  17599. Write the method name to the output
  17600. </summary>
  17601. <remarks>
  17602. <para>
  17603. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  17604. the output.
  17605. </para>
  17606. </remarks>
  17607. <author>Nicko Cadell</author>
  17608. </member>
  17609. <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17610. <summary>
  17611. Write the method name to the output
  17612. </summary>
  17613. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17614. <param name="loggingEvent">the event being logged</param>
  17615. <remarks>
  17616. <para>
  17617. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  17618. the output.
  17619. </para>
  17620. </remarks>
  17621. </member>
  17622. <member name="T:log4net.Layout.Pattern.NdcPatternConverter">
  17623. <summary>
  17624. Converter to include event NDC
  17625. </summary>
  17626. <remarks>
  17627. <para>
  17628. Outputs the value of the event property named <c>NDC</c>.
  17629. </para>
  17630. <para>
  17631. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  17632. </para>
  17633. </remarks>
  17634. <author>Nicko Cadell</author>
  17635. </member>
  17636. <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17637. <summary>
  17638. Write the event NDC to the output
  17639. </summary>
  17640. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17641. <param name="loggingEvent">the event being logged</param>
  17642. <remarks>
  17643. <para>
  17644. As the thread context stacks are now stored in named event properties
  17645. this converter simply looks up the value of the <c>NDC</c> property.
  17646. </para>
  17647. <para>
  17648. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  17649. </para>
  17650. </remarks>
  17651. </member>
  17652. <member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
  17653. <summary>
  17654. Property pattern converter
  17655. </summary>
  17656. <remarks>
  17657. <para>
  17658. Writes out the value of a named property. The property name
  17659. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17660. property.
  17661. </para>
  17662. <para>
  17663. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  17664. then all the properties are written as key value pairs.
  17665. </para>
  17666. </remarks>
  17667. <author>Nicko Cadell</author>
  17668. </member>
  17669. <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17670. <summary>
  17671. Write the property value to the output
  17672. </summary>
  17673. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17674. <param name="loggingEvent">the event being logged</param>
  17675. <remarks>
  17676. <para>
  17677. Writes out the value of a named property. The property name
  17678. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17679. property.
  17680. </para>
  17681. <para>
  17682. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  17683. then all the properties are written as key value pairs.
  17684. </para>
  17685. </remarks>
  17686. </member>
  17687. <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
  17688. <summary>
  17689. Converter to output the relative time of the event
  17690. </summary>
  17691. <remarks>
  17692. <para>
  17693. Converter to output the time of the event relative to the start of the program.
  17694. </para>
  17695. </remarks>
  17696. <author>Nicko Cadell</author>
  17697. </member>
  17698. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17699. <summary>
  17700. Write the relative time to the output
  17701. </summary>
  17702. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17703. <param name="loggingEvent">the event being logged</param>
  17704. <remarks>
  17705. <para>
  17706. Writes out the relative time of the event in milliseconds.
  17707. That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  17708. and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
  17709. </para>
  17710. </remarks>
  17711. </member>
  17712. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
  17713. <summary>
  17714. Helper method to get the time difference between two DateTime objects
  17715. </summary>
  17716. <param name="start">start time (in the current local time zone)</param>
  17717. <param name="end">end time (in the current local time zone)</param>
  17718. <returns>the time difference in milliseconds</returns>
  17719. </member>
  17720. <member name="T:log4net.Layout.Pattern.StackTraceDetailPatternConverter">
  17721. <summary>
  17722. Write the caller stack frames to the output
  17723. </summary>
  17724. <remarks>
  17725. <para>
  17726. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  17727. type3.MethodCall3(type param,...) &gt; type2.MethodCall2(type param,...) &gt; type1.MethodCall1(type param,...)
  17728. </para>
  17729. </remarks>
  17730. <author>Adam Davies</author>
  17731. </member>
  17732. <member name="T:log4net.Layout.Pattern.StackTracePatternConverter">
  17733. <summary>
  17734. Write the caller stack frames to the output
  17735. </summary>
  17736. <remarks>
  17737. <para>
  17738. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer, using format:
  17739. type3.MethodCall3 &gt; type2.MethodCall2 &gt; type1.MethodCall1
  17740. </para>
  17741. </remarks>
  17742. <author>Michael Cromwell</author>
  17743. </member>
  17744. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions">
  17745. <summary>
  17746. Initialize the converter
  17747. </summary>
  17748. <remarks>
  17749. <para>
  17750. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17751. activation scheme. The <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> method must
  17752. be called on this object after the configuration properties have
  17753. been set. Until <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> is called this
  17754. object is in an undefined state and must not be used.
  17755. </para>
  17756. <para>
  17757. If any of the configuration properties are modified then
  17758. <see cref="M:log4net.Layout.Pattern.StackTracePatternConverter.ActivateOptions"/> must be called again.
  17759. </para>
  17760. </remarks>
  17761. </member>
  17762. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17763. <summary>
  17764. Write the strack frames to the output
  17765. </summary>
  17766. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17767. <param name="loggingEvent">the event being logged</param>
  17768. <remarks>
  17769. <para>
  17770. Writes the <see cref="P:log4net.Core.LocationInfo.StackFrames"/> to the output writer.
  17771. </para>
  17772. </remarks>
  17773. </member>
  17774. <member name="M:log4net.Layout.Pattern.StackTracePatternConverter.GetMethodInformation(log4net.Core.MethodItem)">
  17775. <summary>
  17776. Returns the Name of the method
  17777. </summary>
  17778. <param name="method"></param>
  17779. <remarks>This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter</remarks>
  17780. <returns>string</returns>
  17781. </member>
  17782. <member name="F:log4net.Layout.Pattern.StackTracePatternConverter.declaringType">
  17783. <summary>
  17784. The fully qualified type of the StackTracePatternConverter class.
  17785. </summary>
  17786. <remarks>
  17787. Used by the internal logger to record the Type of the
  17788. log message.
  17789. </remarks>
  17790. </member>
  17791. <member name="F:log4net.Layout.Pattern.StackTraceDetailPatternConverter.declaringType">
  17792. <summary>
  17793. The fully qualified type of the StackTraceDetailPatternConverter class.
  17794. </summary>
  17795. <remarks>
  17796. Used by the internal logger to record the Type of the
  17797. log message.
  17798. </remarks>
  17799. </member>
  17800. <member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
  17801. <summary>
  17802. Converter to include event thread name
  17803. </summary>
  17804. <remarks>
  17805. <para>
  17806. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
  17807. </para>
  17808. </remarks>
  17809. <author>Nicko Cadell</author>
  17810. </member>
  17811. <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17812. <summary>
  17813. Write the ThreadName to the output
  17814. </summary>
  17815. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17816. <param name="loggingEvent">the event being logged</param>
  17817. <remarks>
  17818. <para>
  17819. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer"/>.
  17820. </para>
  17821. </remarks>
  17822. </member>
  17823. <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
  17824. <summary>
  17825. Pattern converter for the class name
  17826. </summary>
  17827. <remarks>
  17828. <para>
  17829. Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
  17830. </para>
  17831. </remarks>
  17832. <author>Nicko Cadell</author>
  17833. </member>
  17834. <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17835. <summary>
  17836. Gets the fully qualified name of the class
  17837. </summary>
  17838. <param name="loggingEvent">the event being logged</param>
  17839. <returns>The fully qualified type name for the caller location</returns>
  17840. <remarks>
  17841. <para>
  17842. Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
  17843. </para>
  17844. </remarks>
  17845. </member>
  17846. <member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
  17847. <summary>
  17848. Converter to include event user name
  17849. </summary>
  17850. <author>Douglas de la Torre</author>
  17851. <author>Nicko Cadell</author>
  17852. </member>
  17853. <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17854. <summary>
  17855. Convert the pattern to the rendered message
  17856. </summary>
  17857. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17858. <param name="loggingEvent">the event being logged</param>
  17859. </member>
  17860. <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
  17861. <summary>
  17862. Write the TimeStamp to the output
  17863. </summary>
  17864. <remarks>
  17865. <para>
  17866. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  17867. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  17868. </para>
  17869. <para>
  17870. Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  17871. in Universal time.
  17872. </para>
  17873. <para>
  17874. See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
  17875. </para>
  17876. </remarks>
  17877. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  17878. <author>Nicko Cadell</author>
  17879. </member>
  17880. <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17881. <summary>
  17882. Write the TimeStamp to the output
  17883. </summary>
  17884. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  17885. <param name="loggingEvent">the event being logged</param>
  17886. <remarks>
  17887. <para>
  17888. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  17889. for it to render it to the writer.
  17890. </para>
  17891. <para>
  17892. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
  17893. to Universal time before it is rendered.
  17894. </para>
  17895. </remarks>
  17896. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  17897. </member>
  17898. <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
  17899. <summary>
  17900. The fully qualified type of the UtcDatePatternConverter class.
  17901. </summary>
  17902. <remarks>
  17903. Used by the internal logger to record the Type of the
  17904. log message.
  17905. </remarks>
  17906. </member>
  17907. <member name="T:log4net.Layout.DynamicPatternLayout">
  17908. <summary>
  17909. A flexible layout configurable with pattern string that re-evaluates on each call.
  17910. </summary>
  17911. <remarks>
  17912. <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
  17913. features and capabilities of PatternLayout. PatternLayout is a 'static' class
  17914. in that its layout is done once at configuration time. This class will recreate
  17915. the layout on each reference.</para>
  17916. <para>One important difference between PatternLayout and DynamicPatternLayout is the
  17917. treatment of the Header and Footer parameters in the configuration. The Header and Footer
  17918. parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
  17919. but should not be marked as type log4net.Util.PatternString. Doing so causes the
  17920. pattern to be statically converted at configuration time and causes DynamicPatternLayout
  17921. to perform the same as PatternLayout.</para>
  17922. <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
  17923. <example>
  17924. &lt;layout type="log4net.Layout.DynamicPatternLayout"&gt;
  17925. &lt;param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  17926. &lt;param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  17927. &lt;/layout&gt;
  17928. </example>
  17929. </remarks>
  17930. </member>
  17931. <member name="T:log4net.Layout.PatternLayout">
  17932. <summary>
  17933. A flexible layout configurable with pattern string.
  17934. </summary>
  17935. <remarks>
  17936. <para>
  17937. The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
  17938. <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
  17939. depend on the <i>conversion pattern</i>.
  17940. </para>
  17941. <para>
  17942. The conversion pattern is closely related to the conversion
  17943. pattern of the printf function in C. A conversion pattern is
  17944. composed of literal text and format control expressions called
  17945. <i>conversion specifiers</i>.
  17946. </para>
  17947. <para>
  17948. <i>You are free to insert any literal text within the conversion
  17949. pattern.</i>
  17950. </para>
  17951. <para>
  17952. Each conversion specifier starts with a percent sign (%) and is
  17953. followed by optional <i>format modifiers</i> and a <i>conversion
  17954. pattern name</i>. The conversion pattern name specifies the type of
  17955. data, e.g. logger, level, date, thread name. The format
  17956. modifiers control such things as field width, padding, left and
  17957. right justification. The following is a simple example.
  17958. </para>
  17959. <para>
  17960. Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
  17961. that the log4net environment was set to use a PatternLayout. Then the
  17962. statements
  17963. </para>
  17964. <code lang="C#">
  17965. ILog log = LogManager.GetLogger(typeof(TestApp));
  17966. log.Debug("Message 1");
  17967. log.Warn("Message 2");
  17968. </code>
  17969. <para>would yield the output</para>
  17970. <code>
  17971. DEBUG [main]: Message 1
  17972. WARN [main]: Message 2
  17973. </code>
  17974. <para>
  17975. Note that there is no explicit separator between text and
  17976. conversion specifiers. The pattern parser knows when it has reached
  17977. the end of a conversion specifier when it reads a conversion
  17978. character. In the example above the conversion specifier
  17979. <b>%-5level</b> means the level of the logging event should be left
  17980. justified to a width of five characters.
  17981. </para>
  17982. <para>
  17983. The recognized conversion pattern names are:
  17984. </para>
  17985. <list type="table">
  17986. <listheader>
  17987. <term>Conversion Pattern Name</term>
  17988. <description>Effect</description>
  17989. </listheader>
  17990. <item>
  17991. <term>a</term>
  17992. <description>Equivalent to <b>appdomain</b></description>
  17993. </item>
  17994. <item>
  17995. <term>appdomain</term>
  17996. <description>
  17997. Used to output the friendly name of the AppDomain where the
  17998. logging event was generated.
  17999. </description>
  18000. </item>
  18001. <item>
  18002. <term>aspnet-cache</term>
  18003. <description>
  18004. <para>
  18005. Used to output all cache items in the case of <b>%aspnet-cache</b> or just one named item if used as <b>%aspnet-cache{key}</b>
  18006. </para>
  18007. <para>
  18008. This pattern is not available for Compact Framework or Client Profile assemblies.
  18009. </para>
  18010. </description>
  18011. </item>
  18012. <item>
  18013. <term>aspnet-context</term>
  18014. <description>
  18015. <para>
  18016. Used to output all context items in the case of <b>%aspnet-context</b> or just one named item if used as <b>%aspnet-context{key}</b>
  18017. </para>
  18018. <para>
  18019. This pattern is not available for Compact Framework or Client Profile assemblies.
  18020. </para>
  18021. </description>
  18022. </item>
  18023. <item>
  18024. <term>aspnet-request</term>
  18025. <description>
  18026. <para>
  18027. Used to output all request parameters in the case of <b>%aspnet-request</b> or just one named param if used as <b>%aspnet-request{key}</b>
  18028. </para>
  18029. <para>
  18030. This pattern is not available for Compact Framework or Client Profile assemblies.
  18031. </para>
  18032. </description>
  18033. </item>
  18034. <item>
  18035. <term>aspnet-session</term>
  18036. <description>
  18037. <para>
  18038. Used to output all session items in the case of <b>%aspnet-session</b> or just one named item if used as <b>%aspnet-session{key}</b>
  18039. </para>
  18040. <para>
  18041. This pattern is not available for Compact Framework or Client Profile assemblies.
  18042. </para>
  18043. </description>
  18044. </item>
  18045. <item>
  18046. <term>c</term>
  18047. <description>Equivalent to <b>logger</b></description>
  18048. </item>
  18049. <item>
  18050. <term>C</term>
  18051. <description>Equivalent to <b>type</b></description>
  18052. </item>
  18053. <item>
  18054. <term>class</term>
  18055. <description>Equivalent to <b>type</b></description>
  18056. </item>
  18057. <item>
  18058. <term>d</term>
  18059. <description>Equivalent to <b>date</b></description>
  18060. </item>
  18061. <item>
  18062. <term>date</term>
  18063. <description>
  18064. <para>
  18065. Used to output the date of the logging event in the local time zone.
  18066. To output the date in universal time use the <c>%utcdate</c> pattern.
  18067. The date conversion
  18068. specifier may be followed by a <i>date format specifier</i> enclosed
  18069. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  18070. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  18071. given then ISO8601 format is
  18072. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  18073. </para>
  18074. <para>
  18075. The date format specifier admits the same syntax as the
  18076. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  18077. </para>
  18078. <para>
  18079. For better results it is recommended to use the log4net date
  18080. formatters. These can be specified using one of the strings
  18081. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  18082. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  18083. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  18084. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  18085. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  18086. </para>
  18087. <para>
  18088. These dedicated date formatters perform significantly
  18089. better than <see cref="M:DateTime.ToString(string)"/>.
  18090. </para>
  18091. </description>
  18092. </item>
  18093. <item>
  18094. <term>exception</term>
  18095. <description>
  18096. <para>
  18097. Used to output the exception passed in with the log message.
  18098. </para>
  18099. <para>
  18100. If an exception object is stored in the logging event
  18101. it will be rendered into the pattern output with a
  18102. trailing newline.
  18103. If there is no exception then nothing will be output
  18104. and no trailing newline will be appended.
  18105. It is typical to put a newline before the exception
  18106. and to have the exception as the last data in the pattern.
  18107. </para>
  18108. </description>
  18109. </item>
  18110. <item>
  18111. <term>F</term>
  18112. <description>Equivalent to <b>file</b></description>
  18113. </item>
  18114. <item>
  18115. <term>file</term>
  18116. <description>
  18117. <para>
  18118. Used to output the file name where the logging request was
  18119. issued.
  18120. </para>
  18121. <para>
  18122. <b>WARNING</b> Generating caller location information is
  18123. extremely slow. Its use should be avoided unless execution speed
  18124. is not an issue.
  18125. </para>
  18126. <para>
  18127. See the note below on the availability of caller location information.
  18128. </para>
  18129. </description>
  18130. </item>
  18131. <item>
  18132. <term>identity</term>
  18133. <description>
  18134. <para>
  18135. Used to output the user name for the currently active user
  18136. (Principal.Identity.Name).
  18137. </para>
  18138. <para>
  18139. <b>WARNING</b> Generating caller information is
  18140. extremely slow. Its use should be avoided unless execution speed
  18141. is not an issue.
  18142. </para>
  18143. </description>
  18144. </item>
  18145. <item>
  18146. <term>l</term>
  18147. <description>Equivalent to <b>location</b></description>
  18148. </item>
  18149. <item>
  18150. <term>L</term>
  18151. <description>Equivalent to <b>line</b></description>
  18152. </item>
  18153. <item>
  18154. <term>location</term>
  18155. <description>
  18156. <para>
  18157. Used to output location information of the caller which generated
  18158. the logging event.
  18159. </para>
  18160. <para>
  18161. The location information depends on the CLI implementation but
  18162. usually consists of the fully qualified name of the calling
  18163. method followed by the callers source the file name and line
  18164. number between parentheses.
  18165. </para>
  18166. <para>
  18167. The location information can be very useful. However, its
  18168. generation is <b>extremely</b> slow. Its use should be avoided
  18169. unless execution speed is not an issue.
  18170. </para>
  18171. <para>
  18172. See the note below on the availability of caller location information.
  18173. </para>
  18174. </description>
  18175. </item>
  18176. <item>
  18177. <term>level</term>
  18178. <description>
  18179. <para>
  18180. Used to output the level of the logging event.
  18181. </para>
  18182. </description>
  18183. </item>
  18184. <item>
  18185. <term>line</term>
  18186. <description>
  18187. <para>
  18188. Used to output the line number from where the logging request
  18189. was issued.
  18190. </para>
  18191. <para>
  18192. <b>WARNING</b> Generating caller location information is
  18193. extremely slow. Its use should be avoided unless execution speed
  18194. is not an issue.
  18195. </para>
  18196. <para>
  18197. See the note below on the availability of caller location information.
  18198. </para>
  18199. </description>
  18200. </item>
  18201. <item>
  18202. <term>logger</term>
  18203. <description>
  18204. <para>
  18205. Used to output the logger of the logging event. The
  18206. logger conversion specifier can be optionally followed by
  18207. <i>precision specifier</i>, that is a decimal constant in
  18208. brackets.
  18209. </para>
  18210. <para>
  18211. If a precision specifier is given, then only the corresponding
  18212. number of right most components of the logger name will be
  18213. printed. By default the logger name is printed in full.
  18214. </para>
  18215. <para>
  18216. For example, for the logger name "a.b.c" the pattern
  18217. <b>%logger{2}</b> will output "b.c".
  18218. </para>
  18219. </description>
  18220. </item>
  18221. <item>
  18222. <term>m</term>
  18223. <description>Equivalent to <b>message</b></description>
  18224. </item>
  18225. <item>
  18226. <term>M</term>
  18227. <description>Equivalent to <b>method</b></description>
  18228. </item>
  18229. <item>
  18230. <term>message</term>
  18231. <description>
  18232. <para>
  18233. Used to output the application supplied message associated with
  18234. the logging event.
  18235. </para>
  18236. </description>
  18237. </item>
  18238. <item>
  18239. <term>mdc</term>
  18240. <description>
  18241. <para>
  18242. The MDC (old name for the ThreadContext.Properties) is now part of the
  18243. combined event properties. This pattern is supported for compatibility
  18244. but is equivalent to <b>property</b>.
  18245. </para>
  18246. </description>
  18247. </item>
  18248. <item>
  18249. <term>method</term>
  18250. <description>
  18251. <para>
  18252. Used to output the method name where the logging request was
  18253. issued.
  18254. </para>
  18255. <para>
  18256. <b>WARNING</b> Generating caller location information is
  18257. extremely slow. Its use should be avoided unless execution speed
  18258. is not an issue.
  18259. </para>
  18260. <para>
  18261. See the note below on the availability of caller location information.
  18262. </para>
  18263. </description>
  18264. </item>
  18265. <item>
  18266. <term>n</term>
  18267. <description>Equivalent to <b>newline</b></description>
  18268. </item>
  18269. <item>
  18270. <term>newline</term>
  18271. <description>
  18272. <para>
  18273. Outputs the platform dependent line separator character or
  18274. characters.
  18275. </para>
  18276. <para>
  18277. This conversion pattern offers the same performance as using
  18278. non-portable line separator strings such as "\n", or "\r\n".
  18279. Thus, it is the preferred way of specifying a line separator.
  18280. </para>
  18281. </description>
  18282. </item>
  18283. <item>
  18284. <term>ndc</term>
  18285. <description>
  18286. <para>
  18287. Used to output the NDC (nested diagnostic context) associated
  18288. with the thread that generated the logging event.
  18289. </para>
  18290. </description>
  18291. </item>
  18292. <item>
  18293. <term>p</term>
  18294. <description>Equivalent to <b>level</b></description>
  18295. </item>
  18296. <item>
  18297. <term>P</term>
  18298. <description>Equivalent to <b>property</b></description>
  18299. </item>
  18300. <item>
  18301. <term>properties</term>
  18302. <description>Equivalent to <b>property</b></description>
  18303. </item>
  18304. <item>
  18305. <term>property</term>
  18306. <description>
  18307. <para>
  18308. Used to output the an event specific property. The key to
  18309. lookup must be specified within braces and directly following the
  18310. pattern specifier, e.g. <b>%property{user}</b> would include the value
  18311. from the property that is keyed by the string 'user'. Each property value
  18312. that is to be included in the log must be specified separately.
  18313. Properties are added to events by loggers or appenders. By default
  18314. the <c>log4net:HostName</c> property is set to the name of machine on
  18315. which the event was originally logged.
  18316. </para>
  18317. <para>
  18318. If no key is specified, e.g. <b>%property</b> then all the keys and their
  18319. values are printed in a comma separated list.
  18320. </para>
  18321. <para>
  18322. The properties of an event are combined from a number of different
  18323. contexts. These are listed below in the order in which they are searched.
  18324. </para>
  18325. <list type="definition">
  18326. <item>
  18327. <term>the event properties</term>
  18328. <description>
  18329. The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  18330. properties are specific to this event only.
  18331. </description>
  18332. </item>
  18333. <item>
  18334. <term>the thread properties</term>
  18335. <description>
  18336. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  18337. thread. These properties are shared by all events logged on this thread.
  18338. </description>
  18339. </item>
  18340. <item>
  18341. <term>the global properties</term>
  18342. <description>
  18343. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  18344. properties are shared by all the threads in the AppDomain.
  18345. </description>
  18346. </item>
  18347. </list>
  18348. </description>
  18349. </item>
  18350. <item>
  18351. <term>r</term>
  18352. <description>Equivalent to <b>timestamp</b></description>
  18353. </item>
  18354. <item>
  18355. <term>stacktrace</term>
  18356. <description>
  18357. <para>
  18358. Used to output the stack trace of the logging event
  18359. The stack trace level specifier may be enclosed
  18360. between braces. For example, <b>%stacktrace{level}</b>.
  18361. If no stack trace level specifier is given then 1 is assumed
  18362. </para>
  18363. <para>
  18364. Output uses the format:
  18365. type3.MethodCall3 &gt; type2.MethodCall2 &gt; type1.MethodCall1
  18366. </para>
  18367. <para>
  18368. This pattern is not available for Compact Framework assemblies.
  18369. </para>
  18370. </description>
  18371. </item>
  18372. <item>
  18373. <term>stacktracedetail</term>
  18374. <description>
  18375. <para>
  18376. Used to output the stack trace of the logging event
  18377. The stack trace level specifier may be enclosed
  18378. between braces. For example, <b>%stacktracedetail{level}</b>.
  18379. If no stack trace level specifier is given then 1 is assumed
  18380. </para>
  18381. <para>
  18382. Output uses the format:
  18383. type3.MethodCall3(type param,...) &gt; type2.MethodCall2(type param,...) &gt; type1.MethodCall1(type param,...)
  18384. </para>
  18385. <para>
  18386. This pattern is not available for Compact Framework assemblies.
  18387. </para>
  18388. </description>
  18389. </item>
  18390. <item>
  18391. <term>t</term>
  18392. <description>Equivalent to <b>thread</b></description>
  18393. </item>
  18394. <item>
  18395. <term>timestamp</term>
  18396. <description>
  18397. <para>
  18398. Used to output the number of milliseconds elapsed since the start
  18399. of the application until the creation of the logging event.
  18400. </para>
  18401. </description>
  18402. </item>
  18403. <item>
  18404. <term>thread</term>
  18405. <description>
  18406. <para>
  18407. Used to output the name of the thread that generated the
  18408. logging event. Uses the thread number if no name is available.
  18409. </para>
  18410. </description>
  18411. </item>
  18412. <item>
  18413. <term>type</term>
  18414. <description>
  18415. <para>
  18416. Used to output the fully qualified type name of the caller
  18417. issuing the logging request. This conversion specifier
  18418. can be optionally followed by <i>precision specifier</i>, that
  18419. is a decimal constant in brackets.
  18420. </para>
  18421. <para>
  18422. If a precision specifier is given, then only the corresponding
  18423. number of right most components of the class name will be
  18424. printed. By default the class name is output in fully qualified form.
  18425. </para>
  18426. <para>
  18427. For example, for the class name "log4net.Layout.PatternLayout", the
  18428. pattern <b>%type{1}</b> will output "PatternLayout".
  18429. </para>
  18430. <para>
  18431. <b>WARNING</b> Generating the caller class information is
  18432. slow. Thus, its use should be avoided unless execution speed is
  18433. not an issue.
  18434. </para>
  18435. <para>
  18436. See the note below on the availability of caller location information.
  18437. </para>
  18438. </description>
  18439. </item>
  18440. <item>
  18441. <term>u</term>
  18442. <description>Equivalent to <b>identity</b></description>
  18443. </item>
  18444. <item>
  18445. <term>username</term>
  18446. <description>
  18447. <para>
  18448. Used to output the WindowsIdentity for the currently
  18449. active user.
  18450. </para>
  18451. <para>
  18452. <b>WARNING</b> Generating caller WindowsIdentity information is
  18453. extremely slow. Its use should be avoided unless execution speed
  18454. is not an issue.
  18455. </para>
  18456. </description>
  18457. </item>
  18458. <item>
  18459. <term>utcdate</term>
  18460. <description>
  18461. <para>
  18462. Used to output the date of the logging event in universal time.
  18463. The date conversion
  18464. specifier may be followed by a <i>date format specifier</i> enclosed
  18465. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  18466. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  18467. given then ISO8601 format is
  18468. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  18469. </para>
  18470. <para>
  18471. The date format specifier admits the same syntax as the
  18472. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  18473. </para>
  18474. <para>
  18475. For better results it is recommended to use the log4net date
  18476. formatters. These can be specified using one of the strings
  18477. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  18478. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  18479. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  18480. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  18481. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  18482. </para>
  18483. <para>
  18484. These dedicated date formatters perform significantly
  18485. better than <see cref="M:DateTime.ToString(string)"/>.
  18486. </para>
  18487. </description>
  18488. </item>
  18489. <item>
  18490. <term>w</term>
  18491. <description>Equivalent to <b>username</b></description>
  18492. </item>
  18493. <item>
  18494. <term>x</term>
  18495. <description>Equivalent to <b>ndc</b></description>
  18496. </item>
  18497. <item>
  18498. <term>X</term>
  18499. <description>Equivalent to <b>mdc</b></description>
  18500. </item>
  18501. <item>
  18502. <term>%</term>
  18503. <description>
  18504. <para>
  18505. The sequence %% outputs a single percent sign.
  18506. </para>
  18507. </description>
  18508. </item>
  18509. </list>
  18510. <para>
  18511. The single letter patterns are deprecated in favor of the
  18512. longer more descriptive pattern names.
  18513. </para>
  18514. <para>
  18515. By default the relevant information is output as is. However,
  18516. with the aid of format modifiers it is possible to change the
  18517. minimum field width, the maximum field width and justification.
  18518. </para>
  18519. <para>
  18520. The optional format modifier is placed between the percent sign
  18521. and the conversion pattern name.
  18522. </para>
  18523. <para>
  18524. The first optional format modifier is the <i>left justification
  18525. flag</i> which is just the minus (-) character. Then comes the
  18526. optional <i>minimum field width</i> modifier. This is a decimal
  18527. constant that represents the minimum number of characters to
  18528. output. If the data item requires fewer characters, it is padded on
  18529. either the left or the right until the minimum width is
  18530. reached. The default is to pad on the left (right justify) but you
  18531. can specify right padding with the left justification flag. The
  18532. padding character is space. If the data item is larger than the
  18533. minimum field width, the field is expanded to accommodate the
  18534. data. The value is never truncated.
  18535. </para>
  18536. <para>
  18537. This behavior can be changed using the <i>maximum field
  18538. width</i> modifier which is designated by a period followed by a
  18539. decimal constant. If the data item is longer than the maximum
  18540. field, then the extra characters are removed from the
  18541. <i>beginning</i> of the data item and not from the end. For
  18542. example, it the maximum field width is eight and the data item is
  18543. ten characters long, then the first two characters of the data item
  18544. are dropped. This behavior deviates from the printf function in C
  18545. where truncation is done from the end.
  18546. </para>
  18547. <para>
  18548. Below are various format modifier examples for the logger
  18549. conversion specifier.
  18550. </para>
  18551. <div class="tablediv">
  18552. <table class="dtTABLE" cellspacing="0">
  18553. <tr>
  18554. <th>Format modifier</th>
  18555. <th>left justify</th>
  18556. <th>minimum width</th>
  18557. <th>maximum width</th>
  18558. <th>comment</th>
  18559. </tr>
  18560. <tr>
  18561. <td align="center">%20logger</td>
  18562. <td align="center">false</td>
  18563. <td align="center">20</td>
  18564. <td align="center">none</td>
  18565. <td>
  18566. <para>
  18567. Left pad with spaces if the logger name is less than 20
  18568. characters long.
  18569. </para>
  18570. </td>
  18571. </tr>
  18572. <tr>
  18573. <td align="center">%-20logger</td>
  18574. <td align="center">true</td>
  18575. <td align="center">20</td>
  18576. <td align="center">none</td>
  18577. <td>
  18578. <para>
  18579. Right pad with spaces if the logger
  18580. name is less than 20 characters long.
  18581. </para>
  18582. </td>
  18583. </tr>
  18584. <tr>
  18585. <td align="center">%.30logger</td>
  18586. <td align="center">NA</td>
  18587. <td align="center">none</td>
  18588. <td align="center">30</td>
  18589. <td>
  18590. <para>
  18591. Truncate from the beginning if the logger
  18592. name is longer than 30 characters.
  18593. </para>
  18594. </td>
  18595. </tr>
  18596. <tr>
  18597. <td align="center"><nobr>%20.30logger</nobr></td>
  18598. <td align="center">false</td>
  18599. <td align="center">20</td>
  18600. <td align="center">30</td>
  18601. <td>
  18602. <para>
  18603. Left pad with spaces if the logger name is shorter than 20
  18604. characters. However, if logger name is longer than 30 characters,
  18605. then truncate from the beginning.
  18606. </para>
  18607. </td>
  18608. </tr>
  18609. <tr>
  18610. <td align="center">%-20.30logger</td>
  18611. <td align="center">true</td>
  18612. <td align="center">20</td>
  18613. <td align="center">30</td>
  18614. <td>
  18615. <para>
  18616. Right pad with spaces if the logger name is shorter than 20
  18617. characters. However, if logger name is longer than 30 characters,
  18618. then truncate from the beginning.
  18619. </para>
  18620. </td>
  18621. </tr>
  18622. </table>
  18623. </div>
  18624. <para>
  18625. <b>Note about caller location information.</b><br/>
  18626. The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
  18627. all generate caller location information.
  18628. Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
  18629. a call stack. The caller's information is then extracted from this stack.
  18630. </para>
  18631. <note type="caution">
  18632. <para>
  18633. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  18634. .NET Compact Framework 1.0 therefore caller location information is not
  18635. available on that framework.
  18636. </para>
  18637. </note>
  18638. <note type="caution">
  18639. <para>
  18640. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  18641. </para>
  18642. <para>
  18643. "StackTrace information will be most informative with Debug build configurations.
  18644. By default, Debug builds include debug symbols, while Release builds do not. The
  18645. debug symbols contain most of the file, method name, line number, and column
  18646. information used in constructing StackFrame and StackTrace objects. StackTrace
  18647. might not report as many method calls as expected, due to code transformations
  18648. that occur during optimization."
  18649. </para>
  18650. <para>
  18651. This means that in a Release build the caller information may be incomplete or may
  18652. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  18653. </para>
  18654. </note>
  18655. <para>
  18656. Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
  18657. instance using the <see cref="M:AddConverter(string, Type)"/> method.
  18658. </para>
  18659. </remarks>
  18660. <example>
  18661. This is a more detailed pattern.
  18662. <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
  18663. </example>
  18664. <example>
  18665. A similar pattern except that the relative time is
  18666. right padded if less than 6 digits, thread name is right padded if
  18667. less than 15 characters and truncated if longer and the logger
  18668. name is left padded if shorter than 30 characters and truncated if
  18669. longer.
  18670. <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
  18671. </example>
  18672. <author>Nicko Cadell</author>
  18673. <author>Gert Driesen</author>
  18674. <author>Douglas de la Torre</author>
  18675. <author>Daniel Cazzulino</author>
  18676. </member>
  18677. <member name="T:log4net.Layout.LayoutSkeleton">
  18678. <summary>
  18679. Extend this abstract class to create your own log layout format.
  18680. </summary>
  18681. <remarks>
  18682. <para>
  18683. This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
  18684. interface. Most layout objects should extend this class.
  18685. </para>
  18686. </remarks>
  18687. <remarks>
  18688. <note type="inheritinfo">
  18689. <para>
  18690. Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
  18691. method.
  18692. </para>
  18693. <para>
  18694. Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
  18695. constructor.
  18696. </para>
  18697. </note>
  18698. </remarks>
  18699. <author>Nicko Cadell</author>
  18700. <author>Gert Driesen</author>
  18701. </member>
  18702. <member name="T:log4net.Layout.ILayout">
  18703. <summary>
  18704. Interface implemented by layout objects
  18705. </summary>
  18706. <remarks>
  18707. <para>
  18708. An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  18709. as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
  18710. appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
  18711. </para>
  18712. <para>
  18713. The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  18714. text that is appender before any events and after all the events respectively.
  18715. </para>
  18716. </remarks>
  18717. <author>Nicko Cadell</author>
  18718. <author>Gert Driesen</author>
  18719. </member>
  18720. <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18721. <summary>
  18722. Implement this method to create your own layout format.
  18723. </summary>
  18724. <param name="writer">The TextWriter to write the formatted event to</param>
  18725. <param name="loggingEvent">The event to format</param>
  18726. <remarks>
  18727. <para>
  18728. This method is called by an appender to format
  18729. the <paramref name="loggingEvent"/> as text and output to a writer.
  18730. </para>
  18731. <para>
  18732. If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
  18733. event to be formatted as a <see cref="T:System.String"/> then the following
  18734. code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
  18735. </para>
  18736. <code lang="C#">
  18737. StringWriter writer = new StringWriter();
  18738. Layout.Format(writer, loggingEvent);
  18739. string formattedEvent = writer.ToString();
  18740. </code>
  18741. </remarks>
  18742. </member>
  18743. <member name="P:log4net.Layout.ILayout.ContentType">
  18744. <summary>
  18745. The content type output by this layout.
  18746. </summary>
  18747. <value>The content type</value>
  18748. <remarks>
  18749. <para>
  18750. The content type output by this layout.
  18751. </para>
  18752. <para>
  18753. This is a MIME type e.g. <c>"text/plain"</c>.
  18754. </para>
  18755. </remarks>
  18756. </member>
  18757. <member name="P:log4net.Layout.ILayout.Header">
  18758. <summary>
  18759. The header for the layout format.
  18760. </summary>
  18761. <value>the layout header</value>
  18762. <remarks>
  18763. <para>
  18764. The Header text will be appended before any logging events
  18765. are formatted and appended.
  18766. </para>
  18767. </remarks>
  18768. </member>
  18769. <member name="P:log4net.Layout.ILayout.Footer">
  18770. <summary>
  18771. The footer for the layout format.
  18772. </summary>
  18773. <value>the layout footer</value>
  18774. <remarks>
  18775. <para>
  18776. The Footer text will be appended after all the logging events
  18777. have been formatted and appended.
  18778. </para>
  18779. </remarks>
  18780. </member>
  18781. <member name="P:log4net.Layout.ILayout.IgnoresException">
  18782. <summary>
  18783. Flag indicating if this layout handle exceptions
  18784. </summary>
  18785. <value><c>false</c> if this layout handles exceptions</value>
  18786. <remarks>
  18787. <para>
  18788. If this layout handles the exception object contained within
  18789. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  18790. <c>false</c>. Otherwise, if the layout ignores the exception
  18791. object, then the layout should return <c>true</c>.
  18792. </para>
  18793. </remarks>
  18794. </member>
  18795. <member name="F:log4net.Layout.LayoutSkeleton.m_header">
  18796. <summary>
  18797. The header text
  18798. </summary>
  18799. <remarks>
  18800. <para>
  18801. See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
  18802. </para>
  18803. </remarks>
  18804. </member>
  18805. <member name="F:log4net.Layout.LayoutSkeleton.m_footer">
  18806. <summary>
  18807. The footer text
  18808. </summary>
  18809. <remarks>
  18810. <para>
  18811. See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
  18812. </para>
  18813. </remarks>
  18814. </member>
  18815. <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
  18816. <summary>
  18817. Flag indicating if this layout handles exceptions
  18818. </summary>
  18819. <remarks>
  18820. <para>
  18821. <c>false</c> if this layout handles exceptions
  18822. </para>
  18823. </remarks>
  18824. </member>
  18825. <member name="M:log4net.Layout.LayoutSkeleton.#ctor">
  18826. <summary>
  18827. Empty default constructor
  18828. </summary>
  18829. <remarks>
  18830. <para>
  18831. Empty default constructor
  18832. </para>
  18833. </remarks>
  18834. </member>
  18835. <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
  18836. <summary>
  18837. Activate component options
  18838. </summary>
  18839. <remarks>
  18840. <para>
  18841. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  18842. activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
  18843. be called on this object after the configuration properties have
  18844. been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
  18845. object is in an undefined state and must not be used.
  18846. </para>
  18847. <para>
  18848. If any of the configuration properties are modified then
  18849. <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
  18850. </para>
  18851. <para>
  18852. This method must be implemented by the subclass.
  18853. </para>
  18854. </remarks>
  18855. </member>
  18856. <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  18857. <summary>
  18858. Implement this method to create your own layout format.
  18859. </summary>
  18860. <param name="writer">The TextWriter to write the formatted event to</param>
  18861. <param name="loggingEvent">The event to format</param>
  18862. <remarks>
  18863. <para>
  18864. This method is called by an appender to format
  18865. the <paramref name="loggingEvent"/> as text.
  18866. </para>
  18867. </remarks>
  18868. </member>
  18869. <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
  18870. <summary>
  18871. Convenience method for easily formatting the logging event into a string variable.
  18872. </summary>
  18873. <param name="loggingEvent"></param>
  18874. <remarks>
  18875. Creates a new StringWriter instance to store the formatted logging event.
  18876. </remarks>
  18877. </member>
  18878. <member name="P:log4net.Layout.LayoutSkeleton.ContentType">
  18879. <summary>
  18880. The content type output by this layout.
  18881. </summary>
  18882. <value>The content type is <c>"text/plain"</c></value>
  18883. <remarks>
  18884. <para>
  18885. The content type output by this layout.
  18886. </para>
  18887. <para>
  18888. This base class uses the value <c>"text/plain"</c>.
  18889. To change this value a subclass must override this
  18890. property.
  18891. </para>
  18892. </remarks>
  18893. </member>
  18894. <member name="P:log4net.Layout.LayoutSkeleton.Header">
  18895. <summary>
  18896. The header for the layout format.
  18897. </summary>
  18898. <value>the layout header</value>
  18899. <remarks>
  18900. <para>
  18901. The Header text will be appended before any logging events
  18902. are formatted and appended.
  18903. </para>
  18904. </remarks>
  18905. </member>
  18906. <member name="P:log4net.Layout.LayoutSkeleton.Footer">
  18907. <summary>
  18908. The footer for the layout format.
  18909. </summary>
  18910. <value>the layout footer</value>
  18911. <remarks>
  18912. <para>
  18913. The Footer text will be appended after all the logging events
  18914. have been formatted and appended.
  18915. </para>
  18916. </remarks>
  18917. </member>
  18918. <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
  18919. <summary>
  18920. Flag indicating if this layout handles exceptions
  18921. </summary>
  18922. <value><c>false</c> if this layout handles exceptions</value>
  18923. <remarks>
  18924. <para>
  18925. If this layout handles the exception object contained within
  18926. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  18927. <c>false</c>. Otherwise, if the layout ignores the exception
  18928. object, then the layout should return <c>true</c>.
  18929. </para>
  18930. <para>
  18931. Set this value to override a this default setting. The default
  18932. value is <c>true</c>, this layout does not handle the exception.
  18933. </para>
  18934. </remarks>
  18935. </member>
  18936. <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
  18937. <summary>
  18938. Default pattern string for log output.
  18939. </summary>
  18940. <remarks>
  18941. <para>
  18942. Default pattern string for log output.
  18943. Currently set to the string <b>"%message%newline"</b>
  18944. which just prints the application supplied message.
  18945. </para>
  18946. </remarks>
  18947. </member>
  18948. <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
  18949. <summary>
  18950. A detailed conversion pattern
  18951. </summary>
  18952. <remarks>
  18953. <para>
  18954. A conversion pattern which includes Time, Thread, Logger, and Nested Context.
  18955. Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
  18956. </para>
  18957. </remarks>
  18958. </member>
  18959. <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
  18960. <summary>
  18961. Internal map of converter identifiers to converter types.
  18962. </summary>
  18963. <remarks>
  18964. <para>
  18965. This static map is overridden by the m_converterRegistry instance map
  18966. </para>
  18967. </remarks>
  18968. </member>
  18969. <member name="F:log4net.Layout.PatternLayout.m_pattern">
  18970. <summary>
  18971. the pattern
  18972. </summary>
  18973. </member>
  18974. <member name="F:log4net.Layout.PatternLayout.m_head">
  18975. <summary>
  18976. the head of the pattern converter chain
  18977. </summary>
  18978. </member>
  18979. <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
  18980. <summary>
  18981. patterns defined on this PatternLayout only
  18982. </summary>
  18983. </member>
  18984. <member name="M:log4net.Layout.PatternLayout.#cctor">
  18985. <summary>
  18986. Initialize the global registry
  18987. </summary>
  18988. <remarks>
  18989. <para>
  18990. Defines the builtin global rules.
  18991. </para>
  18992. </remarks>
  18993. </member>
  18994. <member name="M:log4net.Layout.PatternLayout.#ctor">
  18995. <summary>
  18996. Constructs a PatternLayout using the DefaultConversionPattern
  18997. </summary>
  18998. <remarks>
  18999. <para>
  19000. The default pattern just produces the application supplied message.
  19001. </para>
  19002. <para>
  19003. Note to Inheritors: This constructor calls the virtual method
  19004. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  19005. aware that it will be called before your is called constructor.
  19006. </para>
  19007. <para>
  19008. As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
  19009. method must be called after the properties on this object have been
  19010. configured.
  19011. </para>
  19012. </remarks>
  19013. </member>
  19014. <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
  19015. <summary>
  19016. Constructs a PatternLayout using the supplied conversion pattern
  19017. </summary>
  19018. <param name="pattern">the pattern to use</param>
  19019. <remarks>
  19020. <para>
  19021. Note to Inheritors: This constructor calls the virtual method
  19022. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  19023. aware that it will be called before your is called constructor.
  19024. </para>
  19025. <para>
  19026. When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
  19027. need not be called. This may not be the case when using a subclass.
  19028. </para>
  19029. </remarks>
  19030. </member>
  19031. <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
  19032. <summary>
  19033. Create the pattern parser instance
  19034. </summary>
  19035. <param name="pattern">the pattern to parse</param>
  19036. <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
  19037. <remarks>
  19038. <para>
  19039. Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
  19040. global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
  19041. </para>
  19042. </remarks>
  19043. </member>
  19044. <member name="M:log4net.Layout.PatternLayout.ActivateOptions">
  19045. <summary>
  19046. Initialize layout options
  19047. </summary>
  19048. <remarks>
  19049. <para>
  19050. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19051. activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
  19052. be called on this object after the configuration properties have
  19053. been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
  19054. object is in an undefined state and must not be used.
  19055. </para>
  19056. <para>
  19057. If any of the configuration properties are modified then
  19058. <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
  19059. </para>
  19060. </remarks>
  19061. </member>
  19062. <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19063. <summary>
  19064. Produces a formatted string as specified by the conversion pattern.
  19065. </summary>
  19066. <param name="loggingEvent">the event being logged</param>
  19067. <param name="writer">The TextWriter to write the formatted event to</param>
  19068. <remarks>
  19069. <para>
  19070. Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
  19071. specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
  19072. </para>
  19073. </remarks>
  19074. </member>
  19075. <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
  19076. <summary>
  19077. Add a converter to this PatternLayout
  19078. </summary>
  19079. <param name="converterInfo">the converter info</param>
  19080. <remarks>
  19081. <para>
  19082. This version of the method is used by the configurator.
  19083. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  19084. </para>
  19085. </remarks>
  19086. </member>
  19087. <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
  19088. <summary>
  19089. Add a converter to this PatternLayout
  19090. </summary>
  19091. <param name="name">the name of the conversion pattern for this converter</param>
  19092. <param name="type">the type of the converter</param>
  19093. <remarks>
  19094. <para>
  19095. Add a named pattern converter to this instance. This
  19096. converter will be used in the formatting of the event.
  19097. This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
  19098. </para>
  19099. <para>
  19100. The <paramref name="type"/> specified must extend the
  19101. <see cref="T:log4net.Util.PatternConverter"/> type.
  19102. </para>
  19103. </remarks>
  19104. </member>
  19105. <member name="P:log4net.Layout.PatternLayout.ConversionPattern">
  19106. <summary>
  19107. The pattern formatting string
  19108. </summary>
  19109. <remarks>
  19110. <para>
  19111. The <b>ConversionPattern</b> option. This is the string which
  19112. controls formatting and consists of a mix of literal content and
  19113. conversion specifiers.
  19114. </para>
  19115. </remarks>
  19116. </member>
  19117. <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
  19118. <summary>
  19119. The header PatternString
  19120. </summary>
  19121. </member>
  19122. <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
  19123. <summary>
  19124. The footer PatternString
  19125. </summary>
  19126. </member>
  19127. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
  19128. <summary>
  19129. Constructs a DynamicPatternLayout using the DefaultConversionPattern
  19130. </summary>
  19131. <remarks>
  19132. <para>
  19133. The default pattern just produces the application supplied message.
  19134. </para>
  19135. </remarks>
  19136. </member>
  19137. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
  19138. <summary>
  19139. Constructs a DynamicPatternLayout using the supplied conversion pattern
  19140. </summary>
  19141. <param name="pattern">the pattern to use</param>
  19142. <remarks>
  19143. </remarks>
  19144. </member>
  19145. <member name="P:log4net.Layout.DynamicPatternLayout.Header">
  19146. <summary>
  19147. The header for the layout format.
  19148. </summary>
  19149. <value>the layout header</value>
  19150. <remarks>
  19151. <para>
  19152. The Header text will be appended before any logging events
  19153. are formatted and appended.
  19154. </para>
  19155. The pattern will be formatted on each get operation.
  19156. </remarks>
  19157. </member>
  19158. <member name="P:log4net.Layout.DynamicPatternLayout.Footer">
  19159. <summary>
  19160. The footer for the layout format.
  19161. </summary>
  19162. <value>the layout footer</value>
  19163. <remarks>
  19164. <para>
  19165. The Footer text will be appended after all the logging events
  19166. have been formatted and appended.
  19167. </para>
  19168. The pattern will be formatted on each get operation.
  19169. </remarks>
  19170. </member>
  19171. <member name="T:log4net.Layout.ExceptionLayout">
  19172. <summary>
  19173. A Layout that renders only the Exception text from the logging event
  19174. </summary>
  19175. <remarks>
  19176. <para>
  19177. A Layout that renders only the Exception text from the logging event.
  19178. </para>
  19179. <para>
  19180. This Layout should only be used with appenders that utilize multiple
  19181. layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
  19182. </para>
  19183. </remarks>
  19184. <author>Nicko Cadell</author>
  19185. <author>Gert Driesen</author>
  19186. </member>
  19187. <member name="M:log4net.Layout.ExceptionLayout.#ctor">
  19188. <summary>
  19189. Default constructor
  19190. </summary>
  19191. <remarks>
  19192. <para>
  19193. Constructs a ExceptionLayout
  19194. </para>
  19195. </remarks>
  19196. </member>
  19197. <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
  19198. <summary>
  19199. Activate component options
  19200. </summary>
  19201. <remarks>
  19202. <para>
  19203. Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
  19204. framework.
  19205. </para>
  19206. <para>
  19207. This method does nothing as options become effective immediately.
  19208. </para>
  19209. </remarks>
  19210. </member>
  19211. <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19212. <summary>
  19213. Gets the exception text from the logging event
  19214. </summary>
  19215. <param name="writer">The TextWriter to write the formatted event to</param>
  19216. <param name="loggingEvent">the event being logged</param>
  19217. <remarks>
  19218. <para>
  19219. Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
  19220. The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
  19221. </para>
  19222. </remarks>
  19223. </member>
  19224. <member name="T:log4net.Layout.IRawLayout">
  19225. <summary>
  19226. Interface for raw layout objects
  19227. </summary>
  19228. <remarks>
  19229. <para>
  19230. Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  19231. to an object.
  19232. </para>
  19233. <para>
  19234. This interface should not be confused with the
  19235. <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
  19236. only certain specialized situations where a raw object is
  19237. required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
  19238. is not generally useful than this interface.
  19239. </para>
  19240. </remarks>
  19241. <author>Nicko Cadell</author>
  19242. <author>Gert Driesen</author>
  19243. </member>
  19244. <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
  19245. <summary>
  19246. Implement this method to create your own layout format.
  19247. </summary>
  19248. <param name="loggingEvent">The event to format</param>
  19249. <returns>returns the formatted event</returns>
  19250. <remarks>
  19251. <para>
  19252. Implement this method to create your own layout format.
  19253. </para>
  19254. </remarks>
  19255. </member>
  19256. <member name="T:log4net.Layout.Layout2RawLayoutAdapter">
  19257. <summary>
  19258. Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
  19259. </summary>
  19260. <remarks>
  19261. <para>
  19262. Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
  19263. allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
  19264. </para>
  19265. </remarks>
  19266. <author>Nicko Cadell</author>
  19267. <author>Gert Driesen</author>
  19268. </member>
  19269. <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
  19270. <summary>
  19271. The layout to adapt
  19272. </summary>
  19273. </member>
  19274. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
  19275. <summary>
  19276. Construct a new adapter
  19277. </summary>
  19278. <param name="layout">the layout to adapt</param>
  19279. <remarks>
  19280. <para>
  19281. Create the adapter for the specified <paramref name="layout"/>.
  19282. </para>
  19283. </remarks>
  19284. </member>
  19285. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
  19286. <summary>
  19287. Format the logging event as an object.
  19288. </summary>
  19289. <param name="loggingEvent">The event to format</param>
  19290. <returns>returns the formatted event</returns>
  19291. <remarks>
  19292. <para>
  19293. Format the logging event as an object.
  19294. </para>
  19295. <para>
  19296. Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
  19297. the constructor to perform the formatting.
  19298. </para>
  19299. </remarks>
  19300. </member>
  19301. <member name="T:log4net.Layout.RawLayoutConverter">
  19302. <summary>
  19303. Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
  19304. </summary>
  19305. <remarks>
  19306. <para>
  19307. Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
  19308. Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
  19309. the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
  19310. </para>
  19311. </remarks>
  19312. <author>Nicko Cadell</author>
  19313. <author>Gert Driesen</author>
  19314. </member>
  19315. <member name="T:log4net.Util.TypeConverters.IConvertFrom">
  19316. <summary>
  19317. Interface supported by type converters
  19318. </summary>
  19319. <remarks>
  19320. <para>
  19321. This interface supports conversion from arbitrary types
  19322. to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  19323. </para>
  19324. </remarks>
  19325. <author>Nicko Cadell</author>
  19326. <author>Gert Driesen</author>
  19327. </member>
  19328. <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
  19329. <summary>
  19330. Can the source type be converted to the type supported by this object
  19331. </summary>
  19332. <param name="sourceType">the type to convert</param>
  19333. <returns>true if the conversion is possible</returns>
  19334. <remarks>
  19335. <para>
  19336. Test if the <paramref name="sourceType"/> can be converted to the
  19337. type supported by this converter.
  19338. </para>
  19339. </remarks>
  19340. </member>
  19341. <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
  19342. <summary>
  19343. Convert the source object to the type supported by this object
  19344. </summary>
  19345. <param name="source">the object to convert</param>
  19346. <returns>the converted object</returns>
  19347. <remarks>
  19348. <para>
  19349. Converts the <paramref name="source"/> to the type supported
  19350. by this converter.
  19351. </para>
  19352. </remarks>
  19353. </member>
  19354. <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
  19355. <summary>
  19356. Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
  19357. </summary>
  19358. <param name="sourceType">the source to be to be converted</param>
  19359. <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
  19360. <remarks>
  19361. <para>
  19362. Test if the <paramref name="sourceType"/> can be converted to a
  19363. <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
  19364. as the <paramref name="sourceType"/>.
  19365. </para>
  19366. </remarks>
  19367. </member>
  19368. <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
  19369. <summary>
  19370. Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
  19371. </summary>
  19372. <param name="source">the value to convert</param>
  19373. <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
  19374. <remarks>
  19375. <para>
  19376. Convert the <paramref name="source"/> object to a
  19377. <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
  19378. is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
  19379. is used to adapt between the two interfaces, otherwise an
  19380. exception is thrown.
  19381. </para>
  19382. </remarks>
  19383. </member>
  19384. <member name="T:log4net.Layout.RawPropertyLayout">
  19385. <summary>
  19386. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19387. </summary>
  19388. <remarks>
  19389. <para>
  19390. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  19391. </para>
  19392. </remarks>
  19393. <author>Nicko Cadell</author>
  19394. </member>
  19395. <member name="M:log4net.Layout.RawPropertyLayout.#ctor">
  19396. <summary>
  19397. Constructs a RawPropertyLayout
  19398. </summary>
  19399. </member>
  19400. <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
  19401. <summary>
  19402. Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
  19403. </summary>
  19404. <param name="loggingEvent">The event to format</param>
  19405. <returns>returns property value</returns>
  19406. <remarks>
  19407. <para>
  19408. Looks up and returns the object value of the property
  19409. named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
  19410. with than name then <c>null</c> will be returned.
  19411. </para>
  19412. </remarks>
  19413. </member>
  19414. <member name="P:log4net.Layout.RawPropertyLayout.Key">
  19415. <summary>
  19416. The name of the value to lookup in the LoggingEvent Properties collection.
  19417. </summary>
  19418. <value>
  19419. Value to lookup in the LoggingEvent Properties collection
  19420. </value>
  19421. <remarks>
  19422. <para>
  19423. String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
  19424. </para>
  19425. </remarks>
  19426. </member>
  19427. <member name="T:log4net.Layout.RawTimeStampLayout">
  19428. <summary>
  19429. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19430. </summary>
  19431. <remarks>
  19432. <para>
  19433. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19434. </para>
  19435. </remarks>
  19436. <author>Nicko Cadell</author>
  19437. <author>Gert Driesen</author>
  19438. </member>
  19439. <member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
  19440. <summary>
  19441. Constructs a RawTimeStampLayout
  19442. </summary>
  19443. </member>
  19444. <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19445. <summary>
  19446. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19447. </summary>
  19448. <param name="loggingEvent">The event to format</param>
  19449. <returns>returns the time stamp</returns>
  19450. <remarks>
  19451. <para>
  19452. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19453. </para>
  19454. <para>
  19455. The time stamp is in local time. To format the time stamp
  19456. in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
  19457. </para>
  19458. </remarks>
  19459. </member>
  19460. <member name="T:log4net.Layout.RawUtcTimeStampLayout">
  19461. <summary>
  19462. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19463. </summary>
  19464. <remarks>
  19465. <para>
  19466. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  19467. </para>
  19468. </remarks>
  19469. <author>Nicko Cadell</author>
  19470. <author>Gert Driesen</author>
  19471. </member>
  19472. <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
  19473. <summary>
  19474. Constructs a RawUtcTimeStampLayout
  19475. </summary>
  19476. </member>
  19477. <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  19478. <summary>
  19479. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19480. </summary>
  19481. <param name="loggingEvent">The event to format</param>
  19482. <returns>returns the time stamp</returns>
  19483. <remarks>
  19484. <para>
  19485. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  19486. </para>
  19487. <para>
  19488. The time stamp is in universal time. To format the time stamp
  19489. in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
  19490. </para>
  19491. </remarks>
  19492. </member>
  19493. <member name="T:log4net.Layout.SimpleLayout">
  19494. <summary>
  19495. A very simple layout
  19496. </summary>
  19497. <remarks>
  19498. <para>
  19499. SimpleLayout consists of the level of the log statement,
  19500. followed by " - " and then the log message itself. For example,
  19501. <code>
  19502. DEBUG - Hello world
  19503. </code>
  19504. </para>
  19505. </remarks>
  19506. <author>Nicko Cadell</author>
  19507. <author>Gert Driesen</author>
  19508. </member>
  19509. <member name="M:log4net.Layout.SimpleLayout.#ctor">
  19510. <summary>
  19511. Constructs a SimpleLayout
  19512. </summary>
  19513. </member>
  19514. <member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
  19515. <summary>
  19516. Initialize layout options
  19517. </summary>
  19518. <remarks>
  19519. <para>
  19520. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19521. activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
  19522. be called on this object after the configuration properties have
  19523. been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
  19524. object is in an undefined state and must not be used.
  19525. </para>
  19526. <para>
  19527. If any of the configuration properties are modified then
  19528. <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
  19529. </para>
  19530. </remarks>
  19531. </member>
  19532. <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19533. <summary>
  19534. Produces a simple formatted output.
  19535. </summary>
  19536. <param name="loggingEvent">the event being logged</param>
  19537. <param name="writer">The TextWriter to write the formatted event to</param>
  19538. <remarks>
  19539. <para>
  19540. Formats the event as the level of the even,
  19541. followed by " - " and then the log message itself. The
  19542. output is terminated by a newline.
  19543. </para>
  19544. </remarks>
  19545. </member>
  19546. <member name="T:log4net.Layout.XmlLayout">
  19547. <summary>
  19548. Layout that formats the log events as XML elements.
  19549. </summary>
  19550. <remarks>
  19551. <para>
  19552. The output of the <see cref="T:log4net.Layout.XmlLayout"/> consists of a series of
  19553. log4net:event elements. It does not output a complete well-formed XML
  19554. file. The output is designed to be included as an <em>external entity</em>
  19555. in a separate file to form a correct XML file.
  19556. </para>
  19557. <para>
  19558. For example, if <c>abc</c> is the name of the file where
  19559. the <see cref="T:log4net.Layout.XmlLayout"/> output goes, then a well-formed XML file would
  19560. be:
  19561. </para>
  19562. <code lang="XML">
  19563. &lt;?xml version="1.0" ?&gt;
  19564. &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
  19565. &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
  19566. &amp;data;
  19567. &lt;/log4net:events&gt;
  19568. </code>
  19569. <para>
  19570. This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout"/>
  19571. and the appender where it is embedded.
  19572. </para>
  19573. <para>
  19574. The <c>version</c> attribute helps components to correctly
  19575. interpret output generated by <see cref="T:log4net.Layout.XmlLayout"/>. The value of
  19576. this attribute should be "1.2" for release 1.2 and later.
  19577. </para>
  19578. <para>
  19579. Alternatively the <c>Header</c> and <c>Footer</c> properties can be
  19580. configured to output the correct XML header, open tag and close tag.
  19581. When setting the <c>Header</c> and <c>Footer</c> properties it is essential
  19582. that the underlying data store not be appendable otherwise the data
  19583. will become invalid XML.
  19584. </para>
  19585. </remarks>
  19586. <author>Nicko Cadell</author>
  19587. <author>Gert Driesen</author>
  19588. </member>
  19589. <member name="T:log4net.Layout.XmlLayoutBase">
  19590. <summary>
  19591. Layout that formats the log events as XML elements.
  19592. </summary>
  19593. <remarks>
  19594. <para>
  19595. This is an abstract class that must be subclassed by an implementation
  19596. to conform to a specific schema.
  19597. </para>
  19598. <para>
  19599. Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
  19600. </para>
  19601. </remarks>
  19602. <author>Nicko Cadell</author>
  19603. <author>Gert Driesen</author>
  19604. </member>
  19605. <member name="M:log4net.Layout.XmlLayoutBase.#ctor">
  19606. <summary>
  19607. Protected constructor to support subclasses
  19608. </summary>
  19609. <remarks>
  19610. <para>
  19611. Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase"/> class
  19612. with no location info.
  19613. </para>
  19614. </remarks>
  19615. </member>
  19616. <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
  19617. <summary>
  19618. Protected constructor to support subclasses
  19619. </summary>
  19620. <remarks>
  19621. <para>
  19622. The <paramref name="locationInfo" /> parameter determines whether
  19623. location information will be output by the layout. If
  19624. <paramref name="locationInfo" /> is set to <c>true</c>, then the
  19625. file name and line number of the statement at the origin of the log
  19626. statement will be output.
  19627. </para>
  19628. <para>
  19629. If you are embedding this layout within an SMTPAppender
  19630. then make sure to set the <b>LocationInfo</b> option of that
  19631. appender as well.
  19632. </para>
  19633. </remarks>
  19634. </member>
  19635. <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
  19636. <summary>
  19637. Initialize layout options
  19638. </summary>
  19639. <remarks>
  19640. <para>
  19641. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19642. activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
  19643. be called on this object after the configuration properties have
  19644. been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
  19645. object is in an undefined state and must not be used.
  19646. </para>
  19647. <para>
  19648. If any of the configuration properties are modified then
  19649. <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
  19650. </para>
  19651. </remarks>
  19652. </member>
  19653. <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  19654. <summary>
  19655. Produces a formatted string.
  19656. </summary>
  19657. <param name="loggingEvent">The event being logged.</param>
  19658. <param name="writer">The TextWriter to write the formatted event to</param>
  19659. <remarks>
  19660. <para>
  19661. Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
  19662. </para>
  19663. <para>
  19664. This method creates an <see cref="T:System.Xml.XmlTextWriter"/> that writes to the
  19665. <paramref name="writer"/>. The <see cref="T:System.Xml.XmlTextWriter"/> is passed
  19666. to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
  19667. <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
  19668. </para>
  19669. </remarks>
  19670. </member>
  19671. <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19672. <summary>
  19673. Does the actual writing of the XML.
  19674. </summary>
  19675. <param name="writer">The writer to use to output the event to.</param>
  19676. <param name="loggingEvent">The event to write.</param>
  19677. <remarks>
  19678. <para>
  19679. Subclasses should override this method to format
  19680. the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
  19681. </para>
  19682. </remarks>
  19683. </member>
  19684. <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
  19685. <summary>
  19686. Flag to indicate if location information should be included in
  19687. the XML events.
  19688. </summary>
  19689. </member>
  19690. <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
  19691. <summary>
  19692. The string to replace invalid chars with
  19693. </summary>
  19694. </member>
  19695. <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
  19696. <summary>
  19697. Gets a value indicating whether to include location information in
  19698. the XML events.
  19699. </summary>
  19700. <value>
  19701. <c>true</c> if location information should be included in the XML
  19702. events; otherwise, <c>false</c>.
  19703. </value>
  19704. <remarks>
  19705. <para>
  19706. If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo"/> is set to <c>true</c>, then the file
  19707. name and line number of the statement at the origin of the log
  19708. statement will be output.
  19709. </para>
  19710. <para>
  19711. If you are embedding this layout within an <c>SMTPAppender</c>
  19712. then make sure to set the <b>LocationInfo</b> option of that
  19713. appender as well.
  19714. </para>
  19715. </remarks>
  19716. </member>
  19717. <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
  19718. <summary>
  19719. The string to replace characters that can not be expressed in XML with.
  19720. <remarks>
  19721. <para>
  19722. Not all characters may be expressed in XML. This property contains the
  19723. string to replace those that can not with. This defaults to a ?. Set it
  19724. to the empty string to simply remove offending characters. For more
  19725. details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
  19726. Character replacement will occur in the log message, the property names
  19727. and the property values.
  19728. </para>
  19729. </remarks>
  19730. </summary>
  19731. </member>
  19732. <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
  19733. <summary>
  19734. Gets the content type output by this layout.
  19735. </summary>
  19736. <value>
  19737. As this is the XML layout, the value is always <c>"text/xml"</c>.
  19738. </value>
  19739. <remarks>
  19740. <para>
  19741. As this is the XML layout, the value is always <c>"text/xml"</c>.
  19742. </para>
  19743. </remarks>
  19744. </member>
  19745. <member name="M:log4net.Layout.XmlLayout.#ctor">
  19746. <summary>
  19747. Constructs an XmlLayout
  19748. </summary>
  19749. </member>
  19750. <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
  19751. <summary>
  19752. Constructs an XmlLayout.
  19753. </summary>
  19754. <remarks>
  19755. <para>
  19756. The <b>LocationInfo</b> option takes a boolean value. By
  19757. default, it is set to false which means there will be no location
  19758. information output by this layout. If the the option is set to
  19759. true, then the file name and line number of the statement
  19760. at the origin of the log statement will be output.
  19761. </para>
  19762. <para>
  19763. If you are embedding this layout within an SmtpAppender
  19764. then make sure to set the <b>LocationInfo</b> option of that
  19765. appender as well.
  19766. </para>
  19767. </remarks>
  19768. </member>
  19769. <member name="M:log4net.Layout.XmlLayout.ActivateOptions">
  19770. <summary>
  19771. Initialize layout options
  19772. </summary>
  19773. <remarks>
  19774. <para>
  19775. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  19776. activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
  19777. be called on this object after the configuration properties have
  19778. been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
  19779. object is in an undefined state and must not be used.
  19780. </para>
  19781. <para>
  19782. If any of the configuration properties are modified then
  19783. <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
  19784. </para>
  19785. <para>
  19786. Builds a cache of the element names
  19787. </para>
  19788. </remarks>
  19789. </member>
  19790. <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19791. <summary>
  19792. Does the actual writing of the XML.
  19793. </summary>
  19794. <param name="writer">The writer to use to output the event to.</param>
  19795. <param name="loggingEvent">The event to write.</param>
  19796. <remarks>
  19797. <para>
  19798. Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
  19799. to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
  19800. </para>
  19801. </remarks>
  19802. </member>
  19803. <member name="F:log4net.Layout.XmlLayout.m_prefix">
  19804. <summary>
  19805. The prefix to use for all generated element names
  19806. </summary>
  19807. </member>
  19808. <member name="P:log4net.Layout.XmlLayout.Prefix">
  19809. <summary>
  19810. The prefix to use for all element names
  19811. </summary>
  19812. <remarks>
  19813. <para>
  19814. The default prefix is <b>log4net</b>. Set this property
  19815. to change the prefix. If the prefix is set to an empty string
  19816. then no prefix will be written.
  19817. </para>
  19818. </remarks>
  19819. </member>
  19820. <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
  19821. <summary>
  19822. Set whether or not to base64 encode the message.
  19823. </summary>
  19824. <remarks>
  19825. <para>
  19826. By default the log message will be written as text to the xml
  19827. output. This can cause problems when the message contains binary
  19828. data. By setting this to true the contents of the message will be
  19829. base64 encoded. If this is set then invalid character replacement
  19830. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  19831. on the log message.
  19832. </para>
  19833. </remarks>
  19834. </member>
  19835. <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
  19836. <summary>
  19837. Set whether or not to base64 encode the property values.
  19838. </summary>
  19839. <remarks>
  19840. <para>
  19841. By default the properties will be written as text to the xml
  19842. output. This can cause problems when one or more properties contain
  19843. binary data. By setting this to true the values of the properties
  19844. will be base64 encoded. If this is set then invalid character replacement
  19845. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  19846. on the property values.
  19847. </para>
  19848. </remarks>
  19849. </member>
  19850. <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
  19851. <summary>
  19852. Layout that formats the log events as XML elements compatible with the log4j schema
  19853. </summary>
  19854. <remarks>
  19855. <para>
  19856. Formats the log events according to the http://logging.apache.org/log4j schema.
  19857. </para>
  19858. </remarks>
  19859. <author>Nicko Cadell</author>
  19860. </member>
  19861. <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
  19862. <summary>
  19863. The 1st of January 1970 in UTC
  19864. </summary>
  19865. </member>
  19866. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
  19867. <summary>
  19868. Constructs an XMLLayoutSchemaLog4j
  19869. </summary>
  19870. </member>
  19871. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
  19872. <summary>
  19873. Constructs an XMLLayoutSchemaLog4j.
  19874. </summary>
  19875. <remarks>
  19876. <para>
  19877. The <b>LocationInfo</b> option takes a boolean value. By
  19878. default, it is set to false which means there will be no location
  19879. information output by this layout. If the the option is set to
  19880. true, then the file name and line number of the statement
  19881. at the origin of the log statement will be output.
  19882. </para>
  19883. <para>
  19884. If you are embedding this layout within an SMTPAppender
  19885. then make sure to set the <b>LocationInfo</b> option of that
  19886. appender as well.
  19887. </para>
  19888. </remarks>
  19889. </member>
  19890. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  19891. <summary>
  19892. Actually do the writing of the xml
  19893. </summary>
  19894. <param name="writer">the writer to use</param>
  19895. <param name="loggingEvent">the event to write</param>
  19896. <remarks>
  19897. <para>
  19898. Generate XML that is compatible with the log4j schema.
  19899. </para>
  19900. </remarks>
  19901. </member>
  19902. <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
  19903. <summary>
  19904. The version of the log4j schema to use.
  19905. </summary>
  19906. <remarks>
  19907. <para>
  19908. Only version 1.2 of the log4j schema is supported.
  19909. </para>
  19910. </remarks>
  19911. </member>
  19912. <member name="T:log4net.ObjectRenderer.DefaultRenderer">
  19913. <summary>
  19914. The default object Renderer.
  19915. </summary>
  19916. <remarks>
  19917. <para>
  19918. The default renderer supports rendering objects and collections to strings.
  19919. </para>
  19920. <para>
  19921. See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
  19922. </para>
  19923. </remarks>
  19924. <author>Nicko Cadell</author>
  19925. <author>Gert Driesen</author>
  19926. </member>
  19927. <member name="T:log4net.ObjectRenderer.IObjectRenderer">
  19928. <summary>
  19929. Implement this interface in order to render objects as strings
  19930. </summary>
  19931. <remarks>
  19932. <para>
  19933. Certain types require special case conversion to
  19934. string form. This conversion is done by an object renderer.
  19935. Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
  19936. interface.
  19937. </para>
  19938. </remarks>
  19939. <author>Nicko Cadell</author>
  19940. <author>Gert Driesen</author>
  19941. </member>
  19942. <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  19943. <summary>
  19944. Render the object <paramref name="obj"/> to a string
  19945. </summary>
  19946. <param name="rendererMap">The map used to lookup renderers</param>
  19947. <param name="obj">The object to render</param>
  19948. <param name="writer">The writer to render to</param>
  19949. <remarks>
  19950. <para>
  19951. Render the object <paramref name="obj"/> to a
  19952. string.
  19953. </para>
  19954. <para>
  19955. The <paramref name="rendererMap"/> parameter is
  19956. provided to lookup and render other objects. This is
  19957. very useful where <paramref name="obj"/> contains
  19958. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
  19959. method can be used to render these objects.
  19960. </para>
  19961. </remarks>
  19962. </member>
  19963. <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
  19964. <summary>
  19965. Default constructor
  19966. </summary>
  19967. <remarks>
  19968. <para>
  19969. Default constructor
  19970. </para>
  19971. </remarks>
  19972. </member>
  19973. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  19974. <summary>
  19975. Render the object <paramref name="obj"/> to a string
  19976. </summary>
  19977. <param name="rendererMap">The map used to lookup renderers</param>
  19978. <param name="obj">The object to render</param>
  19979. <param name="writer">The writer to render to</param>
  19980. <remarks>
  19981. <para>
  19982. Render the object <paramref name="obj"/> to a string.
  19983. </para>
  19984. <para>
  19985. The <paramref name="rendererMap"/> parameter is
  19986. provided to lookup and render other objects. This is
  19987. very useful where <paramref name="obj"/> contains
  19988. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
  19989. method can be used to render these objects.
  19990. </para>
  19991. <para>
  19992. The default renderer supports rendering objects to strings as follows:
  19993. </para>
  19994. <list type="table">
  19995. <listheader>
  19996. <term>Value</term>
  19997. <description>Rendered String</description>
  19998. </listheader>
  19999. <item>
  20000. <term><c>null</c></term>
  20001. <description>
  20002. <para>"(null)"</para>
  20003. </description>
  20004. </item>
  20005. <item>
  20006. <term><see cref="T:System.Array"/></term>
  20007. <description>
  20008. <para>
  20009. For a one dimensional array this is the
  20010. array type name, an open brace, followed by a comma
  20011. separated list of the elements (using the appropriate
  20012. renderer), followed by a close brace.
  20013. </para>
  20014. <para>
  20015. For example: <c>int[] {1, 2, 3}</c>.
  20016. </para>
  20017. <para>
  20018. If the array is not one dimensional the
  20019. <c>Array.ToString()</c> is returned.
  20020. </para>
  20021. </description>
  20022. </item>
  20023. <item>
  20024. <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> &amp; <see cref="T:System.Collections.IEnumerator"/></term>
  20025. <description>
  20026. <para>
  20027. Rendered as an open brace, followed by a comma
  20028. separated list of the elements (using the appropriate
  20029. renderer), followed by a close brace.
  20030. </para>
  20031. <para>
  20032. For example: <c>{a, b, c}</c>.
  20033. </para>
  20034. <para>
  20035. All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
  20036. or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
  20037. </para>
  20038. </description>
  20039. </item>
  20040. <item>
  20041. <term><see cref="T:System.Collections.DictionaryEntry"/></term>
  20042. <description>
  20043. <para>
  20044. Rendered as the key, an equals sign ('='), and the value (using the appropriate
  20045. renderer).
  20046. </para>
  20047. <para>
  20048. For example: <c>key=value</c>.
  20049. </para>
  20050. </description>
  20051. </item>
  20052. <item>
  20053. <term>other</term>
  20054. <description>
  20055. <para><c>Object.ToString()</c></para>
  20056. </description>
  20057. </item>
  20058. </list>
  20059. </remarks>
  20060. </member>
  20061. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
  20062. <summary>
  20063. Render the array argument into a string
  20064. </summary>
  20065. <param name="rendererMap">The map used to lookup renderers</param>
  20066. <param name="array">the array to render</param>
  20067. <param name="writer">The writer to render to</param>
  20068. <remarks>
  20069. <para>
  20070. For a one dimensional array this is the
  20071. array type name, an open brace, followed by a comma
  20072. separated list of the elements (using the appropriate
  20073. renderer), followed by a close brace. For example:
  20074. <c>int[] {1, 2, 3}</c>.
  20075. </para>
  20076. <para>
  20077. If the array is not one dimensional the
  20078. <c>Array.ToString()</c> is returned.
  20079. </para>
  20080. </remarks>
  20081. </member>
  20082. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
  20083. <summary>
  20084. Render the enumerator argument into a string
  20085. </summary>
  20086. <param name="rendererMap">The map used to lookup renderers</param>
  20087. <param name="enumerator">the enumerator to render</param>
  20088. <param name="writer">The writer to render to</param>
  20089. <remarks>
  20090. <para>
  20091. Rendered as an open brace, followed by a comma
  20092. separated list of the elements (using the appropriate
  20093. renderer), followed by a close brace. For example:
  20094. <c>{a, b, c}</c>.
  20095. </para>
  20096. </remarks>
  20097. </member>
  20098. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
  20099. <summary>
  20100. Render the DictionaryEntry argument into a string
  20101. </summary>
  20102. <param name="rendererMap">The map used to lookup renderers</param>
  20103. <param name="entry">the DictionaryEntry to render</param>
  20104. <param name="writer">The writer to render to</param>
  20105. <remarks>
  20106. <para>
  20107. Render the key, an equals sign ('='), and the value (using the appropriate
  20108. renderer). For example: <c>key=value</c>.
  20109. </para>
  20110. </remarks>
  20111. </member>
  20112. <member name="T:log4net.ObjectRenderer.RendererMap">
  20113. <summary>
  20114. Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  20115. </summary>
  20116. <remarks>
  20117. <para>
  20118. Maintains a mapping between types that require special
  20119. rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
  20120. is used to render them.
  20121. </para>
  20122. <para>
  20123. The <see cref="M:FindAndRender(object)"/> method is used to render an
  20124. <c>object</c> using the appropriate renderers defined in this map.
  20125. </para>
  20126. </remarks>
  20127. <author>Nicko Cadell</author>
  20128. <author>Gert Driesen</author>
  20129. </member>
  20130. <member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
  20131. <summary>
  20132. Default Constructor
  20133. </summary>
  20134. <remarks>
  20135. <para>
  20136. Default constructor.
  20137. </para>
  20138. </remarks>
  20139. </member>
  20140. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
  20141. <summary>
  20142. Render <paramref name="obj"/> using the appropriate renderer.
  20143. </summary>
  20144. <param name="obj">the object to render to a string</param>
  20145. <returns>the object rendered as a string</returns>
  20146. <remarks>
  20147. <para>
  20148. This is a convenience method used to render an object to a string.
  20149. The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
  20150. should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
  20151. </para>
  20152. </remarks>
  20153. </member>
  20154. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
  20155. <summary>
  20156. Render <paramref name="obj"/> using the appropriate renderer.
  20157. </summary>
  20158. <param name="obj">the object to render to a string</param>
  20159. <param name="writer">The writer to render to</param>
  20160. <remarks>
  20161. <para>
  20162. Find the appropriate renderer for the type of the
  20163. <paramref name="obj"/> parameter. This is accomplished by calling the
  20164. <see cref="M:Get(Type)"/> method. Once a renderer is found, it is
  20165. applied on the object <paramref name="obj"/> and the result is returned
  20166. as a <see cref="T:System.String"/>.
  20167. </para>
  20168. </remarks>
  20169. </member>
  20170. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
  20171. <summary>
  20172. Gets the renderer for the specified object type
  20173. </summary>
  20174. <param name="obj">the object to lookup the renderer for</param>
  20175. <returns>the renderer for <paramref name="obj"/></returns>
  20176. <remarks>
  20177. <param>
  20178. Gets the renderer for the specified object type.
  20179. </param>
  20180. <param>
  20181. Syntactic sugar method that calls <see cref="M:Get(Type)"/>
  20182. with the type of the object parameter.
  20183. </param>
  20184. </remarks>
  20185. </member>
  20186. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
  20187. <summary>
  20188. Gets the renderer for the specified type
  20189. </summary>
  20190. <param name="type">the type to lookup the renderer for</param>
  20191. <returns>the renderer for the specified type</returns>
  20192. <remarks>
  20193. <para>
  20194. Returns the renderer for the specified type.
  20195. If no specific renderer has been defined the
  20196. <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
  20197. </para>
  20198. </remarks>
  20199. </member>
  20200. <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
  20201. <summary>
  20202. Internal function to recursively search interfaces
  20203. </summary>
  20204. <param name="type">the type to lookup the renderer for</param>
  20205. <returns>the renderer for the specified type</returns>
  20206. </member>
  20207. <member name="M:log4net.ObjectRenderer.RendererMap.Clear">
  20208. <summary>
  20209. Clear the map of renderers
  20210. </summary>
  20211. <remarks>
  20212. <para>
  20213. Clear the custom renderers defined by using
  20214. <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
  20215. cannot be removed.
  20216. </para>
  20217. </remarks>
  20218. </member>
  20219. <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  20220. <summary>
  20221. Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
  20222. </summary>
  20223. <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
  20224. <param name="renderer">the renderer for <paramref name="typeToRender"/></param>
  20225. <remarks>
  20226. <para>
  20227. Register an object renderer for a specific source type.
  20228. This renderer will be returned from a call to <see cref="M:Get(Type)"/>
  20229. specifying the same <paramref name="typeToRender"/> as an argument.
  20230. </para>
  20231. </remarks>
  20232. </member>
  20233. <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
  20234. <summary>
  20235. Get the default renderer instance
  20236. </summary>
  20237. <value>the default renderer</value>
  20238. <remarks>
  20239. <para>
  20240. Get the default renderer
  20241. </para>
  20242. </remarks>
  20243. </member>
  20244. <member name="T:log4net.Plugin.IPlugin">
  20245. <summary>
  20246. Interface implemented by logger repository plugins.
  20247. </summary>
  20248. <remarks>
  20249. <para>
  20250. Plugins define additional behavior that can be associated
  20251. with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20252. The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
  20253. property is used to store the plugins for a repository.
  20254. </para>
  20255. <para>
  20256. The <c>log4net.Config.PluginAttribute</c> can be used to
  20257. attach plugins to repositories created using configuration
  20258. attributes.
  20259. </para>
  20260. </remarks>
  20261. <author>Nicko Cadell</author>
  20262. <author>Gert Driesen</author>
  20263. </member>
  20264. <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
  20265. <summary>
  20266. Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20267. </summary>
  20268. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  20269. <remarks>
  20270. <para>
  20271. A plugin may only be attached to a single repository.
  20272. </para>
  20273. <para>
  20274. This method is called when the plugin is attached to the repository.
  20275. </para>
  20276. </remarks>
  20277. </member>
  20278. <member name="M:log4net.Plugin.IPlugin.Shutdown">
  20279. <summary>
  20280. Is called when the plugin is to shutdown.
  20281. </summary>
  20282. <remarks>
  20283. <para>
  20284. This method is called to notify the plugin that
  20285. it should stop operating and should detach from
  20286. the repository.
  20287. </para>
  20288. </remarks>
  20289. </member>
  20290. <member name="P:log4net.Plugin.IPlugin.Name">
  20291. <summary>
  20292. Gets the name of the plugin.
  20293. </summary>
  20294. <value>
  20295. The name of the plugin.
  20296. </value>
  20297. <remarks>
  20298. <para>
  20299. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  20300. keyed by name. Each plugin instance attached to a
  20301. repository must be a unique name.
  20302. </para>
  20303. </remarks>
  20304. </member>
  20305. <member name="T:log4net.Plugin.PluginCollection">
  20306. <summary>
  20307. A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  20308. </summary>
  20309. <author>Nicko Cadell</author>
  20310. </member>
  20311. <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
  20312. <summary>
  20313. Creates a read-only wrapper for a <c>PluginCollection</c> instance.
  20314. </summary>
  20315. <param name="list">list to create a readonly wrapper arround</param>
  20316. <returns>
  20317. A <c>PluginCollection</c> wrapper that is read-only.
  20318. </returns>
  20319. </member>
  20320. <member name="M:log4net.Plugin.PluginCollection.#ctor">
  20321. <summary>
  20322. Initializes a new instance of the <c>PluginCollection</c> class
  20323. that is empty and has the default initial capacity.
  20324. </summary>
  20325. </member>
  20326. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
  20327. <summary>
  20328. Initializes a new instance of the <c>PluginCollection</c> class
  20329. that has the specified initial capacity.
  20330. </summary>
  20331. <param name="capacity">
  20332. The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
  20333. </param>
  20334. </member>
  20335. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
  20336. <summary>
  20337. Initializes a new instance of the <c>PluginCollection</c> class
  20338. that contains elements copied from the specified <c>PluginCollection</c>.
  20339. </summary>
  20340. <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
  20341. </member>
  20342. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
  20343. <summary>
  20344. Initializes a new instance of the <c>PluginCollection</c> class
  20345. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
  20346. </summary>
  20347. <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
  20348. </member>
  20349. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
  20350. <summary>
  20351. Initializes a new instance of the <c>PluginCollection</c> class
  20352. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
  20353. </summary>
  20354. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
  20355. </member>
  20356. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
  20357. <summary>
  20358. Allow subclasses to avoid our default constructors
  20359. </summary>
  20360. <param name="tag"></param>
  20361. <exclude/>
  20362. </member>
  20363. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
  20364. <summary>
  20365. Copies the entire <c>PluginCollection</c> to a one-dimensional
  20366. <see cref="T:log4net.Plugin.IPlugin"/> array.
  20367. </summary>
  20368. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  20369. </member>
  20370. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
  20371. <summary>
  20372. Copies the entire <c>PluginCollection</c> to a one-dimensional
  20373. <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
  20374. </summary>
  20375. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  20376. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  20377. </member>
  20378. <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
  20379. <summary>
  20380. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
  20381. </summary>
  20382. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
  20383. <returns>The index at which the value has been added.</returns>
  20384. </member>
  20385. <member name="M:log4net.Plugin.PluginCollection.Clear">
  20386. <summary>
  20387. Removes all elements from the <c>PluginCollection</c>.
  20388. </summary>
  20389. </member>
  20390. <member name="M:log4net.Plugin.PluginCollection.Clone">
  20391. <summary>
  20392. Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
  20393. </summary>
  20394. <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
  20395. </member>
  20396. <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
  20397. <summary>
  20398. Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
  20399. </summary>
  20400. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
  20401. <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
  20402. </member>
  20403. <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
  20404. <summary>
  20405. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
  20406. in the <c>PluginCollection</c>.
  20407. </summary>
  20408. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
  20409. <returns>
  20410. The zero-based index of the first occurrence of <paramref name="item"/>
  20411. in the entire <c>PluginCollection</c>, if found; otherwise, -1.
  20412. </returns>
  20413. </member>
  20414. <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
  20415. <summary>
  20416. Inserts an element into the <c>PluginCollection</c> at the specified index.
  20417. </summary>
  20418. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  20419. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
  20420. <exception cref="T:System.ArgumentOutOfRangeException">
  20421. <para><paramref name="index"/> is less than zero</para>
  20422. <para>-or-</para>
  20423. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20424. </exception>
  20425. </member>
  20426. <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
  20427. <summary>
  20428. Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
  20429. </summary>
  20430. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
  20431. <exception cref="T:System.ArgumentException">
  20432. The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
  20433. </exception>
  20434. </member>
  20435. <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
  20436. <summary>
  20437. Removes the element at the specified index of the <c>PluginCollection</c>.
  20438. </summary>
  20439. <param name="index">The zero-based index of the element to remove.</param>
  20440. <exception cref="T:System.ArgumentOutOfRangeException">
  20441. <para><paramref name="index"/> is less than zero.</para>
  20442. <para>-or-</para>
  20443. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20444. </exception>
  20445. </member>
  20446. <member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
  20447. <summary>
  20448. Returns an enumerator that can iterate through the <c>PluginCollection</c>.
  20449. </summary>
  20450. <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
  20451. </member>
  20452. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
  20453. <summary>
  20454. Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
  20455. </summary>
  20456. <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
  20457. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20458. </member>
  20459. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
  20460. <summary>
  20461. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
  20462. </summary>
  20463. <param name="x">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements should be added to the end of the <c>PluginCollection</c>.</param>
  20464. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20465. </member>
  20466. <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
  20467. <summary>
  20468. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
  20469. </summary>
  20470. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements should be added to the end of the <c>PluginCollection</c>.</param>
  20471. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  20472. </member>
  20473. <member name="M:log4net.Plugin.PluginCollection.TrimToSize">
  20474. <summary>
  20475. Sets the capacity to the actual number of elements.
  20476. </summary>
  20477. </member>
  20478. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
  20479. <exception cref="T:System.ArgumentOutOfRangeException">
  20480. <para><paramref name="i"/> is less than zero.</para>
  20481. <para>-or-</para>
  20482. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20483. </exception>
  20484. </member>
  20485. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
  20486. <exception cref="T:System.ArgumentOutOfRangeException">
  20487. <para><paramref name="i"/> is less than zero.</para>
  20488. <para>-or-</para>
  20489. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20490. </exception>
  20491. </member>
  20492. <member name="P:log4net.Plugin.PluginCollection.Count">
  20493. <summary>
  20494. Gets the number of elements actually contained in the <c>PluginCollection</c>.
  20495. </summary>
  20496. </member>
  20497. <member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
  20498. <summary>
  20499. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  20500. </summary>
  20501. <returns>true if access to the ICollection is synchronized (thread-safe); otherwise, false.</returns>
  20502. </member>
  20503. <member name="P:log4net.Plugin.PluginCollection.SyncRoot">
  20504. <summary>
  20505. Gets an object that can be used to synchronize access to the collection.
  20506. </summary>
  20507. <value>
  20508. An object that can be used to synchronize access to the collection.
  20509. </value>
  20510. </member>
  20511. <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
  20512. <summary>
  20513. Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  20514. </summary>
  20515. <value>
  20516. The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  20517. </value>
  20518. <param name="index">The zero-based index of the element to get or set.</param>
  20519. <exception cref="T:System.ArgumentOutOfRangeException">
  20520. <para><paramref name="index"/> is less than zero.</para>
  20521. <para>-or-</para>
  20522. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  20523. </exception>
  20524. </member>
  20525. <member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
  20526. <summary>
  20527. Gets a value indicating whether the collection has a fixed size.
  20528. </summary>
  20529. <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  20530. </member>
  20531. <member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
  20532. <summary>
  20533. Gets a value indicating whether the IList is read-only.
  20534. </summary>
  20535. <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  20536. </member>
  20537. <member name="P:log4net.Plugin.PluginCollection.Capacity">
  20538. <summary>
  20539. Gets or sets the number of elements the <c>PluginCollection</c> can contain.
  20540. </summary>
  20541. <value>
  20542. The number of elements the <c>PluginCollection</c> can contain.
  20543. </value>
  20544. </member>
  20545. <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
  20546. <summary>
  20547. Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  20548. </summary>
  20549. <exclude/>
  20550. </member>
  20551. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
  20552. <summary>
  20553. Advances the enumerator to the next element in the collection.
  20554. </summary>
  20555. <returns>
  20556. <c>true</c> if the enumerator was successfully advanced to the next element;
  20557. <c>false</c> if the enumerator has passed the end of the collection.
  20558. </returns>
  20559. <exception cref="T:System.InvalidOperationException">
  20560. The collection was modified after the enumerator was created.
  20561. </exception>
  20562. </member>
  20563. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
  20564. <summary>
  20565. Sets the enumerator to its initial position, before the first element in the collection.
  20566. </summary>
  20567. </member>
  20568. <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
  20569. <summary>
  20570. Gets the current element in the collection.
  20571. </summary>
  20572. </member>
  20573. <member name="T:log4net.Plugin.PluginCollection.Tag">
  20574. <summary>
  20575. Type visible only to our subclasses
  20576. Used to access protected constructor
  20577. </summary>
  20578. <exclude/>
  20579. </member>
  20580. <member name="F:log4net.Plugin.PluginCollection.Tag.Default">
  20581. <summary>
  20582. A value
  20583. </summary>
  20584. </member>
  20585. <member name="T:log4net.Plugin.PluginCollection.Enumerator">
  20586. <summary>
  20587. Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  20588. </summary>
  20589. <exclude/>
  20590. </member>
  20591. <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
  20592. <summary>
  20593. Initializes a new instance of the <c>Enumerator</c> class.
  20594. </summary>
  20595. <param name="tc"></param>
  20596. </member>
  20597. <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
  20598. <summary>
  20599. Advances the enumerator to the next element in the collection.
  20600. </summary>
  20601. <returns>
  20602. <c>true</c> if the enumerator was successfully advanced to the next element;
  20603. <c>false</c> if the enumerator has passed the end of the collection.
  20604. </returns>
  20605. <exception cref="T:System.InvalidOperationException">
  20606. The collection was modified after the enumerator was created.
  20607. </exception>
  20608. </member>
  20609. <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
  20610. <summary>
  20611. Sets the enumerator to its initial position, before the first element in the collection.
  20612. </summary>
  20613. </member>
  20614. <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
  20615. <summary>
  20616. Gets the current element in the collection.
  20617. </summary>
  20618. <value>
  20619. The current element in the collection.
  20620. </value>
  20621. </member>
  20622. <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
  20623. <exclude/>
  20624. </member>
  20625. <member name="T:log4net.Plugin.PluginMap">
  20626. <summary>
  20627. Map of repository plugins.
  20628. </summary>
  20629. <remarks>
  20630. <para>
  20631. This class is a name keyed map of the plugins that are
  20632. attached to a repository.
  20633. </para>
  20634. </remarks>
  20635. <author>Nicko Cadell</author>
  20636. <author>Gert Driesen</author>
  20637. </member>
  20638. <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
  20639. <summary>
  20640. Constructor
  20641. </summary>
  20642. <param name="repository">The repository that the plugins should be attached to.</param>
  20643. <remarks>
  20644. <para>
  20645. Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap"/> class with a
  20646. repository that the plugins should be attached to.
  20647. </para>
  20648. </remarks>
  20649. </member>
  20650. <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
  20651. <summary>
  20652. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the map.
  20653. </summary>
  20654. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to add to the map.</param>
  20655. <remarks>
  20656. <para>
  20657. The <see cref="T:log4net.Plugin.IPlugin"/> will be attached to the repository when added.
  20658. </para>
  20659. <para>
  20660. If there already exists a plugin with the same name
  20661. attached to the repository then the old plugin will
  20662. be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
  20663. the new plugin.
  20664. </para>
  20665. </remarks>
  20666. </member>
  20667. <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
  20668. <summary>
  20669. Removes a <see cref="T:log4net.Plugin.IPlugin"/> from the map.
  20670. </summary>
  20671. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the map.</param>
  20672. <remarks>
  20673. <para>
  20674. Remove a specific plugin from this map.
  20675. </para>
  20676. </remarks>
  20677. </member>
  20678. <member name="P:log4net.Plugin.PluginMap.Item(System.String)">
  20679. <summary>
  20680. Gets a <see cref="T:log4net.Plugin.IPlugin"/> by name.
  20681. </summary>
  20682. <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin"/> to lookup.</param>
  20683. <returns>
  20684. The <see cref="T:log4net.Plugin.IPlugin"/> from the map with the name specified, or
  20685. <c>null</c> if no plugin is found.
  20686. </returns>
  20687. <remarks>
  20688. <para>
  20689. Lookup a plugin by name. If the plugin is not found <c>null</c>
  20690. will be returned.
  20691. </para>
  20692. </remarks>
  20693. </member>
  20694. <member name="P:log4net.Plugin.PluginMap.AllPlugins">
  20695. <summary>
  20696. Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  20697. </summary>
  20698. <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin"/> objects.</value>
  20699. <remarks>
  20700. <para>
  20701. Get a collection of all the plugins defined in this map.
  20702. </para>
  20703. </remarks>
  20704. </member>
  20705. <member name="T:log4net.Plugin.PluginSkeleton">
  20706. <summary>
  20707. Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
  20708. </summary>
  20709. <remarks>
  20710. <para>
  20711. Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
  20712. interface. This base class can be used by implementors
  20713. of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
  20714. </para>
  20715. </remarks>
  20716. <author>Nicko Cadell</author>
  20717. <author>Gert Driesen</author>
  20718. </member>
  20719. <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
  20720. <summary>
  20721. Constructor
  20722. </summary>
  20723. <param name="name">the name of the plugin</param>
  20724. <remarks>
  20725. Initializes a new Plugin with the specified name.
  20726. </remarks>
  20727. </member>
  20728. <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
  20729. <summary>
  20730. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20731. </summary>
  20732. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  20733. <remarks>
  20734. <para>
  20735. A plugin may only be attached to a single repository.
  20736. </para>
  20737. <para>
  20738. This method is called when the plugin is attached to the repository.
  20739. </para>
  20740. </remarks>
  20741. </member>
  20742. <member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
  20743. <summary>
  20744. Is called when the plugin is to shutdown.
  20745. </summary>
  20746. <remarks>
  20747. <para>
  20748. This method is called to notify the plugin that
  20749. it should stop operating and should detach from
  20750. the repository.
  20751. </para>
  20752. </remarks>
  20753. </member>
  20754. <member name="F:log4net.Plugin.PluginSkeleton.m_name">
  20755. <summary>
  20756. The name of this plugin.
  20757. </summary>
  20758. </member>
  20759. <member name="F:log4net.Plugin.PluginSkeleton.m_repository">
  20760. <summary>
  20761. The repository this plugin is attached to.
  20762. </summary>
  20763. </member>
  20764. <member name="P:log4net.Plugin.PluginSkeleton.Name">
  20765. <summary>
  20766. Gets or sets the name of the plugin.
  20767. </summary>
  20768. <value>
  20769. The name of the plugin.
  20770. </value>
  20771. <remarks>
  20772. <para>
  20773. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  20774. keyed by name. Each plugin instance attached to a
  20775. repository must be a unique name.
  20776. </para>
  20777. <para>
  20778. The name of the plugin must not change one the
  20779. plugin has been attached to a repository.
  20780. </para>
  20781. </remarks>
  20782. </member>
  20783. <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
  20784. <summary>
  20785. The repository for this plugin
  20786. </summary>
  20787. <value>
  20788. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is attached to.
  20789. </value>
  20790. <remarks>
  20791. <para>
  20792. Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin is
  20793. attached to.
  20794. </para>
  20795. </remarks>
  20796. </member>
  20797. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin">
  20798. <summary>
  20799. Plugin that listens for events from the <see cref="T:log4net.Appender.RemotingAppender"/>
  20800. </summary>
  20801. <remarks>
  20802. <para>
  20803. This plugin publishes an instance of <see cref="T:log4net.Appender.RemotingAppender.IRemoteLoggingSink"/>
  20804. on a specified <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/>. This listens for logging events delivered from
  20805. a remote <see cref="T:log4net.Appender.RemotingAppender"/>.
  20806. </para>
  20807. <para>
  20808. When an event is received it is relogged within the attached repository
  20809. as if it had been raised locally.
  20810. </para>
  20811. </remarks>
  20812. <author>Nicko Cadell</author>
  20813. <author>Gert Driesen</author>
  20814. </member>
  20815. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor">
  20816. <summary>
  20817. Default constructor
  20818. </summary>
  20819. <remarks>
  20820. <para>
  20821. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class.
  20822. </para>
  20823. <para>
  20824. The <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> property must be set.
  20825. </para>
  20826. </remarks>
  20827. </member>
  20828. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.#ctor(System.String)">
  20829. <summary>
  20830. Construct with sink Uri.
  20831. </summary>
  20832. <param name="sinkUri">The name to publish the sink under in the remoting infrastructure.
  20833. See <see cref="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri"/> for more details.</param>
  20834. <remarks>
  20835. <para>
  20836. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin"/> class
  20837. with specified name.
  20838. </para>
  20839. </remarks>
  20840. </member>
  20841. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Attach(log4net.Repository.ILoggerRepository)">
  20842. <summary>
  20843. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20844. </summary>
  20845. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  20846. <remarks>
  20847. <para>
  20848. A plugin may only be attached to a single repository.
  20849. </para>
  20850. <para>
  20851. This method is called when the plugin is attached to the repository.
  20852. </para>
  20853. </remarks>
  20854. </member>
  20855. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.Shutdown">
  20856. <summary>
  20857. Is called when the plugin is to shutdown.
  20858. </summary>
  20859. <remarks>
  20860. <para>
  20861. When the plugin is shutdown the remote logging
  20862. sink is disconnected.
  20863. </para>
  20864. </remarks>
  20865. </member>
  20866. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.declaringType">
  20867. <summary>
  20868. The fully qualified type of the RemoteLoggingServerPlugin class.
  20869. </summary>
  20870. <remarks>
  20871. Used by the internal logger to record the Type of the
  20872. log message.
  20873. </remarks>
  20874. </member>
  20875. <member name="P:log4net.Plugin.RemoteLoggingServerPlugin.SinkUri">
  20876. <summary>
  20877. Gets or sets the URI of this sink.
  20878. </summary>
  20879. <value>
  20880. The URI of this sink.
  20881. </value>
  20882. <remarks>
  20883. <para>
  20884. This is the name under which the object is marshaled.
  20885. <see cref="M:RemotingServices.Marshal(MarshalByRefObject,String,Type)"/>
  20886. </para>
  20887. </remarks>
  20888. </member>
  20889. <member name="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl">
  20890. <summary>
  20891. Delivers <see cref="T:log4net.Core.LoggingEvent"/> objects to a remote sink.
  20892. </summary>
  20893. <remarks>
  20894. <para>
  20895. Internal class used to listen for logging events
  20896. and deliver them to the local repository.
  20897. </para>
  20898. </remarks>
  20899. </member>
  20900. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.#ctor(log4net.Repository.ILoggerRepository)">
  20901. <summary>
  20902. Constructor
  20903. </summary>
  20904. <param name="repository">The repository to log to.</param>
  20905. <remarks>
  20906. <para>
  20907. Initializes a new instance of the <see cref="T:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl"/> for the
  20908. specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  20909. </para>
  20910. </remarks>
  20911. </member>
  20912. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.LogEvents(log4net.Core.LoggingEvent[])">
  20913. <summary>
  20914. Logs the events to the repository.
  20915. </summary>
  20916. <param name="events">The events to log.</param>
  20917. <remarks>
  20918. <para>
  20919. The events passed are logged to the <see cref="T:log4net.Repository.ILoggerRepository"/>
  20920. </para>
  20921. </remarks>
  20922. </member>
  20923. <member name="M:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.InitializeLifetimeService">
  20924. <summary>
  20925. Obtains a lifetime service object to control the lifetime
  20926. policy for this instance.
  20927. </summary>
  20928. <returns><c>null</c> to indicate that this instance should live forever.</returns>
  20929. <remarks>
  20930. <para>
  20931. Obtains a lifetime service object to control the lifetime
  20932. policy for this instance. This object should live forever
  20933. therefore this implementation returns <c>null</c>.
  20934. </para>
  20935. </remarks>
  20936. </member>
  20937. <member name="F:log4net.Plugin.RemoteLoggingServerPlugin.RemoteLoggingSinkImpl.m_repository">
  20938. <summary>
  20939. The underlying <see cref="T:log4net.Repository.ILoggerRepository"/> that events should
  20940. be logged to.
  20941. </summary>
  20942. </member>
  20943. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
  20944. <summary>
  20945. Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  20946. </summary>
  20947. <remarks>
  20948. <para>
  20949. This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  20950. interface is used to create the default subclass
  20951. of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
  20952. </para>
  20953. </remarks>
  20954. <author>Nicko Cadell</author>
  20955. <author>Gert Driesen</author>
  20956. </member>
  20957. <member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
  20958. <summary>
  20959. Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
  20960. </summary>
  20961. <remarks>
  20962. <para>
  20963. This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
  20964. create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
  20965. </para>
  20966. <para>
  20967. The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
  20968. to create a named <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
  20969. </para>
  20970. <para>
  20971. Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger"/>.
  20972. </para>
  20973. </remarks>
  20974. <author>Nicko Cadell</author>
  20975. <author>Gert Driesen</author>
  20976. </member>
  20977. <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  20978. <summary>
  20979. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
  20980. </summary>
  20981. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  20982. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  20983. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
  20984. <remarks>
  20985. <para>
  20986. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
  20987. specified name.
  20988. </para>
  20989. <para>
  20990. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  20991. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  20992. </para>
  20993. <para>
  20994. If the <paramref name="name"/> is <c>null</c> then the root logger
  20995. must be returned.
  20996. </para>
  20997. </remarks>
  20998. </member>
  20999. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
  21000. <summary>
  21001. Default constructor
  21002. </summary>
  21003. <remarks>
  21004. <para>
  21005. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> class.
  21006. </para>
  21007. </remarks>
  21008. </member>
  21009. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  21010. <summary>
  21011. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance
  21012. </summary>
  21013. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21014. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21015. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance for the specified name.</returns>
  21016. <remarks>
  21017. <para>
  21018. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance with the
  21019. specified name.
  21020. </para>
  21021. <para>
  21022. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  21023. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  21024. </para>
  21025. <para>
  21026. If the <paramref name="name"/> is <c>null</c> then the root logger
  21027. must be returned.
  21028. </para>
  21029. </remarks>
  21030. </member>
  21031. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
  21032. <summary>
  21033. Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  21034. </summary>
  21035. <remarks>
  21036. <para>
  21037. This subclass has no additional behavior over the
  21038. <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
  21039. to be created.
  21040. </para>
  21041. </remarks>
  21042. </member>
  21043. <member name="T:log4net.Repository.Hierarchy.Logger">
  21044. <summary>
  21045. Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
  21046. </summary>
  21047. <remarks>
  21048. <para>
  21049. Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
  21050. interface. Applications should use <see cref="T:log4net.LogManager"/> to get
  21051. logger instances.
  21052. </para>
  21053. <para>
  21054. This is one of the central classes in the log4net implementation. One of the
  21055. distinctive features of log4net are hierarchical loggers and their
  21056. evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  21057. instances into a rooted tree hierarchy.
  21058. </para>
  21059. <para>
  21060. The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
  21061. <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21062. is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  21063. </para>
  21064. </remarks>
  21065. <author>Nicko Cadell</author>
  21066. <author>Gert Driesen</author>
  21067. <author>Aspi Havewala</author>
  21068. <author>Douglas de la Torre</author>
  21069. </member>
  21070. <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
  21071. <summary>
  21072. This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance and
  21073. sets its name.
  21074. </summary>
  21075. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger"/>.</param>
  21076. <remarks>
  21077. <para>
  21078. This constructor is protected and designed to be used by
  21079. a subclass that is not abstract.
  21080. </para>
  21081. <para>
  21082. Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  21083. objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
  21084. logger creator.
  21085. </para>
  21086. </remarks>
  21087. </member>
  21088. <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
  21089. <summary>
  21090. Add <paramref name="newAppender"/> to the list of appenders of this
  21091. Logger instance.
  21092. </summary>
  21093. <param name="newAppender">An appender to add to this logger</param>
  21094. <remarks>
  21095. <para>
  21096. Add <paramref name="newAppender"/> to the list of appenders of this
  21097. Logger instance.
  21098. </para>
  21099. <para>
  21100. If <paramref name="newAppender"/> is already in the list of
  21101. appenders, then it won't be added again.
  21102. </para>
  21103. </remarks>
  21104. </member>
  21105. <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
  21106. <summary>
  21107. Look for the appender named as <c>name</c>
  21108. </summary>
  21109. <param name="name">The name of the appender to lookup</param>
  21110. <returns>The appender with the name specified, or <c>null</c>.</returns>
  21111. <remarks>
  21112. <para>
  21113. Returns the named appender, or null if the appender is not found.
  21114. </para>
  21115. </remarks>
  21116. </member>
  21117. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
  21118. <summary>
  21119. Remove all previously added appenders from this Logger instance.
  21120. </summary>
  21121. <remarks>
  21122. <para>
  21123. Remove all previously added appenders from this Logger instance.
  21124. </para>
  21125. <para>
  21126. This is useful when re-reading configuration information.
  21127. </para>
  21128. </remarks>
  21129. </member>
  21130. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
  21131. <summary>
  21132. Remove the appender passed as parameter form the list of appenders.
  21133. </summary>
  21134. <param name="appender">The appender to remove</param>
  21135. <returns>The appender removed from the list</returns>
  21136. <remarks>
  21137. <para>
  21138. Remove the appender passed as parameter form the list of appenders.
  21139. The appender removed is not closed.
  21140. If you are discarding the appender you must call
  21141. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  21142. </para>
  21143. </remarks>
  21144. </member>
  21145. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
  21146. <summary>
  21147. Remove the appender passed as parameter form the list of appenders.
  21148. </summary>
  21149. <param name="name">The name of the appender to remove</param>
  21150. <returns>The appender removed from the list</returns>
  21151. <remarks>
  21152. <para>
  21153. Remove the named appender passed as parameter form the list of appenders.
  21154. The appender removed is not closed.
  21155. If you are discarding the appender you must call
  21156. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  21157. </para>
  21158. </remarks>
  21159. </member>
  21160. <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  21161. <summary>
  21162. This generic form is intended to be used by wrappers.
  21163. </summary>
  21164. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  21165. the stack boundary into the logging system for this call.</param>
  21166. <param name="level">The level of the message to be logged.</param>
  21167. <param name="message">The message object to log.</param>
  21168. <param name="exception">The exception to log, including its stack trace.</param>
  21169. <remarks>
  21170. <para>
  21171. Generate a logging event for the specified <paramref name="level"/> using
  21172. the <paramref name="message"/> and <paramref name="exception"/>.
  21173. </para>
  21174. <para>
  21175. This method must not throw any exception to the caller.
  21176. </para>
  21177. </remarks>
  21178. </member>
  21179. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
  21180. <summary>
  21181. This is the most generic printing method that is intended to be used
  21182. by wrappers.
  21183. </summary>
  21184. <param name="logEvent">The event being logged.</param>
  21185. <remarks>
  21186. <para>
  21187. Logs the specified logging event through this logger.
  21188. </para>
  21189. <para>
  21190. This method must not throw any exception to the caller.
  21191. </para>
  21192. </remarks>
  21193. </member>
  21194. <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
  21195. <summary>
  21196. Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
  21197. </summary>
  21198. <param name="level">The level to check.</param>
  21199. <returns>
  21200. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  21201. </returns>
  21202. <remarks>
  21203. <para>
  21204. Test if this logger is going to log events of the specified <paramref name="level"/>.
  21205. </para>
  21206. <para>
  21207. This method must not throw any exception to the caller.
  21208. </para>
  21209. </remarks>
  21210. </member>
  21211. <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
  21212. <summary>
  21213. Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
  21214. </summary>
  21215. <param name="loggingEvent">The event to log.</param>
  21216. <remarks>
  21217. <para>
  21218. Call the appenders in the hierarchy starting at
  21219. <c>this</c>. If no appenders could be found, emit a
  21220. warning.
  21221. </para>
  21222. <para>
  21223. This method calls all the appenders inherited from the
  21224. hierarchy circumventing any evaluation of whether to log or not
  21225. to log the particular log request.
  21226. </para>
  21227. </remarks>
  21228. </member>
  21229. <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
  21230. <summary>
  21231. Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  21232. </summary>
  21233. <remarks>
  21234. <para>
  21235. Used to ensure that the appenders are correctly shutdown.
  21236. </para>
  21237. </remarks>
  21238. </member>
  21239. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
  21240. <summary>
  21241. This is the most generic printing method. This generic form is intended to be used by wrappers
  21242. </summary>
  21243. <param name="level">The level of the message to be logged.</param>
  21244. <param name="message">The message object to log.</param>
  21245. <param name="exception">The exception to log, including its stack trace.</param>
  21246. <remarks>
  21247. <para>
  21248. Generate a logging event for the specified <paramref name="level"/> using
  21249. the <paramref name="message"/>.
  21250. </para>
  21251. </remarks>
  21252. </member>
  21253. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  21254. <summary>
  21255. Creates a new logging event and logs the event without further checks.
  21256. </summary>
  21257. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  21258. the stack boundary into the logging system for this call.</param>
  21259. <param name="level">The level of the message to be logged.</param>
  21260. <param name="message">The message object to log.</param>
  21261. <param name="exception">The exception to log, including its stack trace.</param>
  21262. <remarks>
  21263. <para>
  21264. Generates a logging event and delivers it to the attached
  21265. appenders.
  21266. </para>
  21267. </remarks>
  21268. </member>
  21269. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
  21270. <summary>
  21271. Creates a new logging event and logs the event without further checks.
  21272. </summary>
  21273. <param name="logEvent">The event being logged.</param>
  21274. <remarks>
  21275. <para>
  21276. Delivers the logging event to the attached appenders.
  21277. </para>
  21278. </remarks>
  21279. </member>
  21280. <member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
  21281. <summary>
  21282. The fully qualified type of the Logger class.
  21283. </summary>
  21284. </member>
  21285. <member name="F:log4net.Repository.Hierarchy.Logger.m_name">
  21286. <summary>
  21287. The name of this logger.
  21288. </summary>
  21289. </member>
  21290. <member name="F:log4net.Repository.Hierarchy.Logger.m_level">
  21291. <summary>
  21292. The assigned level of this logger.
  21293. </summary>
  21294. <remarks>
  21295. <para>
  21296. The <c>level</c> variable need not be
  21297. assigned a value in which case it is inherited
  21298. form the hierarchy.
  21299. </para>
  21300. </remarks>
  21301. </member>
  21302. <member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
  21303. <summary>
  21304. The parent of this logger.
  21305. </summary>
  21306. <remarks>
  21307. <para>
  21308. The parent of this logger.
  21309. All loggers have at least one ancestor which is the root logger.
  21310. </para>
  21311. </remarks>
  21312. </member>
  21313. <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
  21314. <summary>
  21315. Loggers need to know what Hierarchy they are in.
  21316. </summary>
  21317. <remarks>
  21318. <para>
  21319. Loggers need to know what Hierarchy they are in.
  21320. The hierarchy that this logger is a member of is stored
  21321. here.
  21322. </para>
  21323. </remarks>
  21324. </member>
  21325. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
  21326. <summary>
  21327. Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  21328. </summary>
  21329. </member>
  21330. <member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
  21331. <summary>
  21332. Flag indicating if child loggers inherit their parents appenders
  21333. </summary>
  21334. <remarks>
  21335. <para>
  21336. Additivity is set to true by default, that is children inherit
  21337. the appenders of their ancestors by default. If this variable is
  21338. set to <c>false</c> then the appenders found in the
  21339. ancestors of this logger are not used. However, the children
  21340. of this logger will inherit its appenders, unless the children
  21341. have their additivity flag set to <c>false</c> too. See
  21342. the user manual for more details.
  21343. </para>
  21344. </remarks>
  21345. </member>
  21346. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
  21347. <summary>
  21348. Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
  21349. </summary>
  21350. </member>
  21351. <member name="P:log4net.Repository.Hierarchy.Logger.Parent">
  21352. <summary>
  21353. Gets or sets the parent logger in the hierarchy.
  21354. </summary>
  21355. <value>
  21356. The parent logger in the hierarchy.
  21357. </value>
  21358. <remarks>
  21359. <para>
  21360. Part of the Composite pattern that makes the hierarchy.
  21361. The hierarchy is parent linked rather than child linked.
  21362. </para>
  21363. </remarks>
  21364. </member>
  21365. <member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
  21366. <summary>
  21367. Gets or sets a value indicating if child loggers inherit their parent's appenders.
  21368. </summary>
  21369. <value>
  21370. <c>true</c> if child loggers inherit their parent's appenders.
  21371. </value>
  21372. <remarks>
  21373. <para>
  21374. Additivity is set to <c>true</c> by default, that is children inherit
  21375. the appenders of their ancestors by default. If this variable is
  21376. set to <c>false</c> then the appenders found in the
  21377. ancestors of this logger are not used. However, the children
  21378. of this logger will inherit its appenders, unless the children
  21379. have their additivity flag set to <c>false</c> too. See
  21380. the user manual for more details.
  21381. </para>
  21382. </remarks>
  21383. </member>
  21384. <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
  21385. <summary>
  21386. Gets the effective level for this logger.
  21387. </summary>
  21388. <returns>The nearest level in the logger hierarchy.</returns>
  21389. <remarks>
  21390. <para>
  21391. Starting from this logger, searches the logger hierarchy for a
  21392. non-null level and returns it. Otherwise, returns the level of the
  21393. root logger.
  21394. </para>
  21395. <para>The Logger class is designed so that this method executes as
  21396. quickly as possible.</para>
  21397. </remarks>
  21398. </member>
  21399. <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
  21400. <summary>
  21401. Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
  21402. <c>Logger</c> instance is attached to.
  21403. </summary>
  21404. <value>The hierarchy that this logger belongs to.</value>
  21405. <remarks>
  21406. <para>
  21407. This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  21408. </para>
  21409. </remarks>
  21410. </member>
  21411. <member name="P:log4net.Repository.Hierarchy.Logger.Level">
  21412. <summary>
  21413. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
  21414. </summary>
  21415. <value>
  21416. The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
  21417. </value>
  21418. <remarks>
  21419. <para>
  21420. The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
  21421. </para>
  21422. </remarks>
  21423. </member>
  21424. <member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
  21425. <summary>
  21426. Get the appenders contained in this logger as an
  21427. <see cref="T:System.Collections.ICollection"/>.
  21428. </summary>
  21429. <returns>A collection of the appenders in this logger</returns>
  21430. <remarks>
  21431. <para>
  21432. Get the appenders contained in this logger as an
  21433. <see cref="T:System.Collections.ICollection"/>. If no appenders
  21434. can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  21435. </para>
  21436. </remarks>
  21437. </member>
  21438. <member name="P:log4net.Repository.Hierarchy.Logger.Name">
  21439. <summary>
  21440. Gets the logger name.
  21441. </summary>
  21442. <value>
  21443. The name of the logger.
  21444. </value>
  21445. <remarks>
  21446. <para>
  21447. The name of this logger
  21448. </para>
  21449. </remarks>
  21450. </member>
  21451. <member name="P:log4net.Repository.Hierarchy.Logger.Repository">
  21452. <summary>
  21453. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  21454. <c>Logger</c> instance is attached to.
  21455. </summary>
  21456. <value>
  21457. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this logger belongs to.
  21458. </value>
  21459. <remarks>
  21460. <para>
  21461. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  21462. <c>Logger</c> instance is attached to.
  21463. </para>
  21464. </remarks>
  21465. </member>
  21466. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
  21467. <summary>
  21468. Construct a new Logger
  21469. </summary>
  21470. <param name="name">the name of the logger</param>
  21471. <remarks>
  21472. <para>
  21473. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl"/> class
  21474. with the specified name.
  21475. </para>
  21476. </remarks>
  21477. </member>
  21478. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
  21479. <summary>
  21480. Delegate used to handle logger creation event notifications.
  21481. </summary>
  21482. <param name="sender">The <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> in which the <see cref="T:log4net.Repository.Hierarchy.Logger"/> has been created.</param>
  21483. <param name="e">The <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event args that hold the <see cref="T:log4net.Repository.Hierarchy.Logger"/> instance that has been created.</param>
  21484. <remarks>
  21485. <para>
  21486. Delegate used to handle logger creation event notifications.
  21487. </para>
  21488. </remarks>
  21489. </member>
  21490. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
  21491. <summary>
  21492. Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
  21493. </summary>
  21494. <remarks>
  21495. <para>
  21496. A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
  21497. <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
  21498. </para>
  21499. </remarks>
  21500. </member>
  21501. <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
  21502. <summary>
  21503. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
  21504. </summary>
  21505. </member>
  21506. <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
  21507. <summary>
  21508. Constructor
  21509. </summary>
  21510. <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
  21511. <remarks>
  21512. <para>
  21513. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs"/> event argument
  21514. class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
  21515. </para>
  21516. </remarks>
  21517. </member>
  21518. <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
  21519. <summary>
  21520. Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21521. </summary>
  21522. <value>
  21523. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21524. </value>
  21525. <remarks>
  21526. <para>
  21527. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  21528. </para>
  21529. </remarks>
  21530. </member>
  21531. <member name="T:log4net.Repository.Hierarchy.Hierarchy">
  21532. <summary>
  21533. Hierarchical organization of loggers
  21534. </summary>
  21535. <remarks>
  21536. <para>
  21537. <i>The casual user should not have to deal with this class
  21538. directly.</i>
  21539. </para>
  21540. <para>
  21541. This class is specialized in retrieving loggers by name and
  21542. also maintaining the logger hierarchy. Implements the
  21543. <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21544. </para>
  21545. <para>
  21546. The structure of the logger hierarchy is maintained by the
  21547. <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
  21548. link to their parent but parents do not have any references to their
  21549. children. Moreover, loggers can be instantiated in any order, in
  21550. particular descendant before ancestor.
  21551. </para>
  21552. <para>
  21553. In case a descendant is created before a particular ancestor,
  21554. then it creates a provision node for the ancestor and adds itself
  21555. to the provision node. Other descendants of the same ancestor add
  21556. themselves to the previously created provision node.
  21557. </para>
  21558. </remarks>
  21559. <author>Nicko Cadell</author>
  21560. <author>Gert Driesen</author>
  21561. </member>
  21562. <member name="T:log4net.Repository.LoggerRepositorySkeleton">
  21563. <summary>
  21564. Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
  21565. </summary>
  21566. <remarks>
  21567. <para>
  21568. Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21569. </para>
  21570. <para>
  21571. Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21572. All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
  21573. </para>
  21574. </remarks>
  21575. <author>Nicko Cadell</author>
  21576. <author>Gert Driesen</author>
  21577. </member>
  21578. <member name="T:log4net.Repository.ILoggerRepository">
  21579. <summary>
  21580. Interface implemented by logger repositories.
  21581. </summary>
  21582. <remarks>
  21583. <para>
  21584. This interface is implemented by logger repositories. e.g.
  21585. <see cref="N:log4net.Repository.Hierarchy"/>.
  21586. </para>
  21587. <para>
  21588. This interface is used by the <see cref="T:log4net.LogManager"/>
  21589. to obtain <see cref="T:log4net.ILog"/> interfaces.
  21590. </para>
  21591. </remarks>
  21592. <author>Nicko Cadell</author>
  21593. <author>Gert Driesen</author>
  21594. </member>
  21595. <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
  21596. <summary>
  21597. Check if the named logger exists in the repository. If so return
  21598. its reference, otherwise returns <c>null</c>.
  21599. </summary>
  21600. <param name="name">The name of the logger to lookup</param>
  21601. <returns>The Logger object with the name specified</returns>
  21602. <remarks>
  21603. <para>
  21604. If the names logger exists it is returned, otherwise
  21605. <c>null</c> is returned.
  21606. </para>
  21607. </remarks>
  21608. </member>
  21609. <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
  21610. <summary>
  21611. Returns all the currently defined loggers as an Array.
  21612. </summary>
  21613. <returns>All the defined loggers</returns>
  21614. <remarks>
  21615. <para>
  21616. Returns all the currently defined loggers as an Array.
  21617. </para>
  21618. </remarks>
  21619. </member>
  21620. <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
  21621. <summary>
  21622. Returns a named logger instance
  21623. </summary>
  21624. <param name="name">The name of the logger to retrieve</param>
  21625. <returns>The logger object with the name specified</returns>
  21626. <remarks>
  21627. <para>
  21628. Returns a named logger instance.
  21629. </para>
  21630. <para>
  21631. If a logger of that name already exists, then it will be
  21632. returned. Otherwise, a new logger will be instantiated and
  21633. then linked with its existing ancestors as well as children.
  21634. </para>
  21635. </remarks>
  21636. </member>
  21637. <member name="M:log4net.Repository.ILoggerRepository.Shutdown">
  21638. <summary>Shutdown the repository</summary>
  21639. <remarks>
  21640. <para>
  21641. Shutting down a repository will <i>safely</i> close and remove
  21642. all appenders in all loggers including the root logger.
  21643. </para>
  21644. <para>
  21645. Some appenders need to be closed before the
  21646. application exists. Otherwise, pending logging events might be
  21647. lost.
  21648. </para>
  21649. <para>
  21650. The <see cref="M:Shutdown()"/> method is careful to close nested
  21651. appenders before closing regular appenders. This is allows
  21652. configurations where a regular appender is attached to a logger
  21653. and again to a nested appender.
  21654. </para>
  21655. </remarks>
  21656. </member>
  21657. <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
  21658. <summary>
  21659. Reset the repositories configuration to a default state
  21660. </summary>
  21661. <remarks>
  21662. <para>
  21663. Reset all values contained in this instance to their
  21664. default state.
  21665. </para>
  21666. <para>
  21667. Existing loggers are not removed. They are just reset.
  21668. </para>
  21669. <para>
  21670. This method should be used sparingly and with care as it will
  21671. block all logging until it is completed.
  21672. </para>
  21673. </remarks>
  21674. </member>
  21675. <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
  21676. <summary>
  21677. Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
  21678. </summary>
  21679. <param name="logEvent">the event to log</param>
  21680. <remarks>
  21681. <para>
  21682. This method should not normally be used to log.
  21683. The <see cref="T:log4net.ILog"/> interface should be used
  21684. for routine logging. This interface can be obtained
  21685. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  21686. </para>
  21687. <para>
  21688. The <c>logEvent</c> is delivered to the appropriate logger and
  21689. that logger is then responsible for logging the event.
  21690. </para>
  21691. </remarks>
  21692. </member>
  21693. <member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
  21694. <summary>
  21695. Returns all the Appenders that are configured as an Array.
  21696. </summary>
  21697. <returns>All the Appenders</returns>
  21698. <remarks>
  21699. <para>
  21700. Returns all the Appenders that are configured as an Array.
  21701. </para>
  21702. </remarks>
  21703. </member>
  21704. <member name="P:log4net.Repository.ILoggerRepository.Name">
  21705. <summary>
  21706. The name of the repository
  21707. </summary>
  21708. <value>
  21709. The name of the repository
  21710. </value>
  21711. <remarks>
  21712. <para>
  21713. The name of the repository.
  21714. </para>
  21715. </remarks>
  21716. </member>
  21717. <member name="P:log4net.Repository.ILoggerRepository.RendererMap">
  21718. <summary>
  21719. RendererMap accesses the object renderer map for this repository.
  21720. </summary>
  21721. <value>
  21722. RendererMap accesses the object renderer map for this repository.
  21723. </value>
  21724. <remarks>
  21725. <para>
  21726. RendererMap accesses the object renderer map for this repository.
  21727. </para>
  21728. <para>
  21729. The RendererMap holds a mapping between types and
  21730. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  21731. </para>
  21732. </remarks>
  21733. </member>
  21734. <member name="P:log4net.Repository.ILoggerRepository.PluginMap">
  21735. <summary>
  21736. The plugin map for this repository.
  21737. </summary>
  21738. <value>
  21739. The plugin map for this repository.
  21740. </value>
  21741. <remarks>
  21742. <para>
  21743. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  21744. that have been attached to this repository.
  21745. </para>
  21746. </remarks>
  21747. </member>
  21748. <member name="P:log4net.Repository.ILoggerRepository.LevelMap">
  21749. <summary>
  21750. Get the level map for the Repository.
  21751. </summary>
  21752. <remarks>
  21753. <para>
  21754. Get the level map for the Repository.
  21755. </para>
  21756. <para>
  21757. The level map defines the mappings between
  21758. level names and <see cref="T:log4net.Core.Level"/> objects in
  21759. this repository.
  21760. </para>
  21761. </remarks>
  21762. </member>
  21763. <member name="P:log4net.Repository.ILoggerRepository.Threshold">
  21764. <summary>
  21765. The threshold for all events in this repository
  21766. </summary>
  21767. <value>
  21768. The threshold for all events in this repository
  21769. </value>
  21770. <remarks>
  21771. <para>
  21772. The threshold for all events in this repository.
  21773. </para>
  21774. </remarks>
  21775. </member>
  21776. <member name="P:log4net.Repository.ILoggerRepository.Configured">
  21777. <summary>
  21778. Flag indicates if this repository has been configured.
  21779. </summary>
  21780. <value>
  21781. Flag indicates if this repository has been configured.
  21782. </value>
  21783. <remarks>
  21784. <para>
  21785. Flag indicates if this repository has been configured.
  21786. </para>
  21787. </remarks>
  21788. </member>
  21789. <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
  21790. <summary>
  21791. Collection of internal messages captured during the most
  21792. recent configuration process.
  21793. </summary>
  21794. </member>
  21795. <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
  21796. <summary>
  21797. Event to notify that the repository has been shutdown.
  21798. </summary>
  21799. <value>
  21800. Event to notify that the repository has been shutdown.
  21801. </value>
  21802. <remarks>
  21803. <para>
  21804. Event raised when the repository has been shutdown.
  21805. </para>
  21806. </remarks>
  21807. </member>
  21808. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
  21809. <summary>
  21810. Event to notify that the repository has had its configuration reset.
  21811. </summary>
  21812. <value>
  21813. Event to notify that the repository has had its configuration reset.
  21814. </value>
  21815. <remarks>
  21816. <para>
  21817. Event raised when the repository's configuration has been
  21818. reset to default.
  21819. </para>
  21820. </remarks>
  21821. </member>
  21822. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
  21823. <summary>
  21824. Event to notify that the repository has had its configuration changed.
  21825. </summary>
  21826. <value>
  21827. Event to notify that the repository has had its configuration changed.
  21828. </value>
  21829. <remarks>
  21830. <para>
  21831. Event raised when the repository's configuration has been changed.
  21832. </para>
  21833. </remarks>
  21834. </member>
  21835. <member name="P:log4net.Repository.ILoggerRepository.Properties">
  21836. <summary>
  21837. Repository specific properties
  21838. </summary>
  21839. <value>
  21840. Repository specific properties
  21841. </value>
  21842. <remarks>
  21843. <para>
  21844. These properties can be specified on a repository specific basis.
  21845. </para>
  21846. </remarks>
  21847. </member>
  21848. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
  21849. <summary>
  21850. Default Constructor
  21851. </summary>
  21852. <remarks>
  21853. <para>
  21854. Initializes the repository with default (empty) properties.
  21855. </para>
  21856. </remarks>
  21857. </member>
  21858. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
  21859. <summary>
  21860. Construct the repository using specific properties
  21861. </summary>
  21862. <param name="properties">the properties to set for this repository</param>
  21863. <remarks>
  21864. <para>
  21865. Initializes the repository with specified properties.
  21866. </para>
  21867. </remarks>
  21868. </member>
  21869. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
  21870. <summary>
  21871. Test if logger exists
  21872. </summary>
  21873. <param name="name">The name of the logger to lookup</param>
  21874. <returns>The Logger object with the name specified</returns>
  21875. <remarks>
  21876. <para>
  21877. Check if the named logger exists in the repository. If so return
  21878. its reference, otherwise returns <c>null</c>.
  21879. </para>
  21880. </remarks>
  21881. </member>
  21882. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
  21883. <summary>
  21884. Returns all the currently defined loggers in the repository
  21885. </summary>
  21886. <returns>All the defined loggers</returns>
  21887. <remarks>
  21888. <para>
  21889. Returns all the currently defined loggers in the repository as an Array.
  21890. </para>
  21891. </remarks>
  21892. </member>
  21893. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
  21894. <summary>
  21895. Return a new logger instance
  21896. </summary>
  21897. <param name="name">The name of the logger to retrieve</param>
  21898. <returns>The logger object with the name specified</returns>
  21899. <remarks>
  21900. <para>
  21901. Return a new logger instance.
  21902. </para>
  21903. <para>
  21904. If a logger of that name already exists, then it will be
  21905. returned. Otherwise, a new logger will be instantiated and
  21906. then linked with its existing ancestors as well as children.
  21907. </para>
  21908. </remarks>
  21909. </member>
  21910. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
  21911. <summary>
  21912. Shutdown the repository
  21913. </summary>
  21914. <remarks>
  21915. <para>
  21916. Shutdown the repository. Can be overridden in a subclass.
  21917. This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
  21918. listeners and all attached plugins of the shutdown event.
  21919. </para>
  21920. </remarks>
  21921. </member>
  21922. <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
  21923. <summary>
  21924. Reset the repositories configuration to a default state
  21925. </summary>
  21926. <remarks>
  21927. <para>
  21928. Reset all values contained in this instance to their
  21929. default state.
  21930. </para>
  21931. <para>
  21932. Existing loggers are not removed. They are just reset.
  21933. </para>
  21934. <para>
  21935. This method should be used sparingly and with care as it will
  21936. block all logging until it is completed.
  21937. </para>
  21938. </remarks>
  21939. </member>
  21940. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
  21941. <summary>
  21942. Log the logEvent through this repository.
  21943. </summary>
  21944. <param name="logEvent">the event to log</param>
  21945. <remarks>
  21946. <para>
  21947. This method should not normally be used to log.
  21948. The <see cref="T:log4net.ILog"/> interface should be used
  21949. for routine logging. This interface can be obtained
  21950. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  21951. </para>
  21952. <para>
  21953. The <c>logEvent</c> is delivered to the appropriate logger and
  21954. that logger is then responsible for logging the event.
  21955. </para>
  21956. </remarks>
  21957. </member>
  21958. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
  21959. <summary>
  21960. Returns all the Appenders that are configured as an Array.
  21961. </summary>
  21962. <returns>All the Appenders</returns>
  21963. <remarks>
  21964. <para>
  21965. Returns all the Appenders that are configured as an Array.
  21966. </para>
  21967. </remarks>
  21968. </member>
  21969. <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
  21970. <summary>
  21971. The fully qualified type of the LoggerRepositorySkeleton class.
  21972. </summary>
  21973. <remarks>
  21974. Used by the internal logger to record the Type of the
  21975. log message.
  21976. </remarks>
  21977. </member>
  21978. <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  21979. <summary>
  21980. Adds an object renderer for a specific class.
  21981. </summary>
  21982. <param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
  21983. <param name="rendererInstance">The object renderer used to render the object.</param>
  21984. <remarks>
  21985. <para>
  21986. Adds an object renderer for a specific class.
  21987. </para>
  21988. </remarks>
  21989. </member>
  21990. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
  21991. <summary>
  21992. Notify the registered listeners that the repository is shutting down
  21993. </summary>
  21994. <param name="e">Empty EventArgs</param>
  21995. <remarks>
  21996. <para>
  21997. Notify any listeners that this repository is shutting down.
  21998. </para>
  21999. </remarks>
  22000. </member>
  22001. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
  22002. <summary>
  22003. Notify the registered listeners that the repository has had its configuration reset
  22004. </summary>
  22005. <param name="e">Empty EventArgs</param>
  22006. <remarks>
  22007. <para>
  22008. Notify any listeners that this repository's configuration has been reset.
  22009. </para>
  22010. </remarks>
  22011. </member>
  22012. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
  22013. <summary>
  22014. Notify the registered listeners that the repository has had its configuration changed
  22015. </summary>
  22016. <param name="e">Empty EventArgs</param>
  22017. <remarks>
  22018. <para>
  22019. Notify any listeners that this repository's configuration has changed.
  22020. </para>
  22021. </remarks>
  22022. </member>
  22023. <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
  22024. <summary>
  22025. Raise a configuration changed event on this repository
  22026. </summary>
  22027. <param name="e">EventArgs.Empty</param>
  22028. <remarks>
  22029. <para>
  22030. Applications that programmatically change the configuration of the repository should
  22031. raise this event notification to notify listeners.
  22032. </para>
  22033. </remarks>
  22034. </member>
  22035. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
  22036. <summary>
  22037. The name of the repository
  22038. </summary>
  22039. <value>
  22040. The string name of the repository
  22041. </value>
  22042. <remarks>
  22043. <para>
  22044. The name of this repository. The name is
  22045. used to store and lookup the repositories
  22046. stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
  22047. </para>
  22048. </remarks>
  22049. </member>
  22050. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
  22051. <summary>
  22052. The threshold for all events in this repository
  22053. </summary>
  22054. <value>
  22055. The threshold for all events in this repository
  22056. </value>
  22057. <remarks>
  22058. <para>
  22059. The threshold for all events in this repository
  22060. </para>
  22061. </remarks>
  22062. </member>
  22063. <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
  22064. <summary>
  22065. RendererMap accesses the object renderer map for this repository.
  22066. </summary>
  22067. <value>
  22068. RendererMap accesses the object renderer map for this repository.
  22069. </value>
  22070. <remarks>
  22071. <para>
  22072. RendererMap accesses the object renderer map for this repository.
  22073. </para>
  22074. <para>
  22075. The RendererMap holds a mapping between types and
  22076. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  22077. </para>
  22078. </remarks>
  22079. </member>
  22080. <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
  22081. <summary>
  22082. The plugin map for this repository.
  22083. </summary>
  22084. <value>
  22085. The plugin map for this repository.
  22086. </value>
  22087. <remarks>
  22088. <para>
  22089. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  22090. that have been attached to this repository.
  22091. </para>
  22092. </remarks>
  22093. </member>
  22094. <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
  22095. <summary>
  22096. Get the level map for the Repository.
  22097. </summary>
  22098. <remarks>
  22099. <para>
  22100. Get the level map for the Repository.
  22101. </para>
  22102. <para>
  22103. The level map defines the mappings between
  22104. level names and <see cref="T:log4net.Core.Level"/> objects in
  22105. this repository.
  22106. </para>
  22107. </remarks>
  22108. </member>
  22109. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
  22110. <summary>
  22111. Flag indicates if this repository has been configured.
  22112. </summary>
  22113. <value>
  22114. Flag indicates if this repository has been configured.
  22115. </value>
  22116. <remarks>
  22117. <para>
  22118. Flag indicates if this repository has been configured.
  22119. </para>
  22120. </remarks>
  22121. </member>
  22122. <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
  22123. <summary>
  22124. Contains a list of internal messages captures during the
  22125. last configuration.
  22126. </summary>
  22127. </member>
  22128. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
  22129. <summary>
  22130. Event to notify that the repository has been shutdown.
  22131. </summary>
  22132. <value>
  22133. Event to notify that the repository has been shutdown.
  22134. </value>
  22135. <remarks>
  22136. <para>
  22137. Event raised when the repository has been shutdown.
  22138. </para>
  22139. </remarks>
  22140. </member>
  22141. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
  22142. <summary>
  22143. Event to notify that the repository has had its configuration reset.
  22144. </summary>
  22145. <value>
  22146. Event to notify that the repository has had its configuration reset.
  22147. </value>
  22148. <remarks>
  22149. <para>
  22150. Event raised when the repository's configuration has been
  22151. reset to default.
  22152. </para>
  22153. </remarks>
  22154. </member>
  22155. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
  22156. <summary>
  22157. Event to notify that the repository has had its configuration changed.
  22158. </summary>
  22159. <value>
  22160. Event to notify that the repository has had its configuration changed.
  22161. </value>
  22162. <remarks>
  22163. <para>
  22164. Event raised when the repository's configuration has been changed.
  22165. </para>
  22166. </remarks>
  22167. </member>
  22168. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
  22169. <summary>
  22170. Repository specific properties
  22171. </summary>
  22172. <value>
  22173. Repository specific properties
  22174. </value>
  22175. <remarks>
  22176. These properties can be specified on a repository specific basis
  22177. </remarks>
  22178. </member>
  22179. <member name="T:log4net.Repository.IBasicRepositoryConfigurator">
  22180. <summary>
  22181. Basic Configurator interface for repositories
  22182. </summary>
  22183. <remarks>
  22184. <para>
  22185. Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
  22186. with a default <see cref="T:log4net.Appender.IAppender"/>.
  22187. </para>
  22188. <para>
  22189. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  22190. configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
  22191. </para>
  22192. </remarks>
  22193. <author>Nicko Cadell</author>
  22194. <author>Gert Driesen</author>
  22195. </member>
  22196. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
  22197. <summary>
  22198. Initialize the repository using the specified appender
  22199. </summary>
  22200. <param name="appender">the appender to use to log all logging events</param>
  22201. <remarks>
  22202. <para>
  22203. Configure the repository to route all logging events to the
  22204. specified appender.
  22205. </para>
  22206. </remarks>
  22207. </member>
  22208. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
  22209. <summary>
  22210. Initialize the repository using the specified appenders
  22211. </summary>
  22212. <param name="appenders">the appenders to use to log all logging events</param>
  22213. <remarks>
  22214. <para>
  22215. Configure the repository to route all logging events to the
  22216. specified appenders.
  22217. </para>
  22218. </remarks>
  22219. </member>
  22220. <member name="T:log4net.Repository.IXmlRepositoryConfigurator">
  22221. <summary>
  22222. Configure repository using XML
  22223. </summary>
  22224. <remarks>
  22225. <para>
  22226. Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  22227. </para>
  22228. <para>
  22229. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  22230. configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
  22231. </para>
  22232. </remarks>
  22233. <author>Nicko Cadell</author>
  22234. <author>Gert Driesen</author>
  22235. </member>
  22236. <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
  22237. <summary>
  22238. Initialize the repository using the specified config
  22239. </summary>
  22240. <param name="element">the element containing the root of the config</param>
  22241. <remarks>
  22242. <para>
  22243. The schema for the XML configuration data is defined by
  22244. the implementation.
  22245. </para>
  22246. </remarks>
  22247. </member>
  22248. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
  22249. <summary>
  22250. Default constructor
  22251. </summary>
  22252. <remarks>
  22253. <para>
  22254. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
  22255. </para>
  22256. </remarks>
  22257. </member>
  22258. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
  22259. <summary>
  22260. Construct with properties
  22261. </summary>
  22262. <param name="properties">The properties to pass to this repository.</param>
  22263. <remarks>
  22264. <para>
  22265. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class.
  22266. </para>
  22267. </remarks>
  22268. </member>
  22269. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
  22270. <summary>
  22271. Construct with a logger factory
  22272. </summary>
  22273. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22274. <remarks>
  22275. <para>
  22276. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
  22277. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
  22278. </para>
  22279. </remarks>
  22280. </member>
  22281. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
  22282. <summary>
  22283. Construct with properties and a logger factory
  22284. </summary>
  22285. <param name="properties">The properties to pass to this repository.</param>
  22286. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  22287. <remarks>
  22288. <para>
  22289. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> class with
  22290. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>.
  22291. </para>
  22292. </remarks>
  22293. </member>
  22294. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
  22295. <summary>
  22296. Test if a logger exists
  22297. </summary>
  22298. <param name="name">The name of the logger to lookup</param>
  22299. <returns>The Logger object with the name specified</returns>
  22300. <remarks>
  22301. <para>
  22302. Check if the named logger exists in the hierarchy. If so return
  22303. its reference, otherwise returns <c>null</c>.
  22304. </para>
  22305. </remarks>
  22306. </member>
  22307. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
  22308. <summary>
  22309. Returns all the currently defined loggers in the hierarchy as an Array
  22310. </summary>
  22311. <returns>All the defined loggers</returns>
  22312. <remarks>
  22313. <para>
  22314. Returns all the currently defined loggers in the hierarchy as an Array.
  22315. The root logger is <b>not</b> included in the returned
  22316. enumeration.
  22317. </para>
  22318. </remarks>
  22319. </member>
  22320. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
  22321. <summary>
  22322. Return a new logger instance named as the first parameter using
  22323. the default factory.
  22324. </summary>
  22325. <remarks>
  22326. <para>
  22327. Return a new logger instance named as the first parameter using
  22328. the default factory.
  22329. </para>
  22330. <para>
  22331. If a logger of that name already exists, then it will be
  22332. returned. Otherwise, a new logger will be instantiated and
  22333. then linked with its existing ancestors as well as children.
  22334. </para>
  22335. </remarks>
  22336. <param name="name">The name of the logger to retrieve</param>
  22337. <returns>The logger object with the name specified</returns>
  22338. </member>
  22339. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
  22340. <summary>
  22341. Shutting down a hierarchy will <i>safely</i> close and remove
  22342. all appenders in all loggers including the root logger.
  22343. </summary>
  22344. <remarks>
  22345. <para>
  22346. Shutting down a hierarchy will <i>safely</i> close and remove
  22347. all appenders in all loggers including the root logger.
  22348. </para>
  22349. <para>
  22350. Some appenders need to be closed before the
  22351. application exists. Otherwise, pending logging events might be
  22352. lost.
  22353. </para>
  22354. <para>
  22355. The <c>Shutdown</c> method is careful to close nested
  22356. appenders before closing regular appenders. This is allows
  22357. configurations where a regular appender is attached to a logger
  22358. and again to a nested appender.
  22359. </para>
  22360. </remarks>
  22361. </member>
  22362. <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
  22363. <summary>
  22364. Reset all values contained in this hierarchy instance to their default.
  22365. </summary>
  22366. <remarks>
  22367. <para>
  22368. Reset all values contained in this hierarchy instance to their
  22369. default. This removes all appenders from all loggers, sets
  22370. the level of all non-root loggers to <c>null</c>,
  22371. sets their additivity flag to <c>true</c> and sets the level
  22372. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  22373. message disabling is set its default "off" value.
  22374. </para>
  22375. <para>
  22376. Existing loggers are not removed. They are just reset.
  22377. </para>
  22378. <para>
  22379. This method should be used sparingly and with care as it will
  22380. block all logging until it is completed.
  22381. </para>
  22382. </remarks>
  22383. </member>
  22384. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
  22385. <summary>
  22386. Log the logEvent through this hierarchy.
  22387. </summary>
  22388. <param name="logEvent">the event to log</param>
  22389. <remarks>
  22390. <para>
  22391. This method should not normally be used to log.
  22392. The <see cref="T:log4net.ILog"/> interface should be used
  22393. for routine logging. This interface can be obtained
  22394. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  22395. </para>
  22396. <para>
  22397. The <c>logEvent</c> is delivered to the appropriate logger and
  22398. that logger is then responsible for logging the event.
  22399. </para>
  22400. </remarks>
  22401. </member>
  22402. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
  22403. <summary>
  22404. Returns all the Appenders that are currently configured
  22405. </summary>
  22406. <returns>An array containing all the currently configured appenders</returns>
  22407. <remarks>
  22408. <para>
  22409. Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
  22410. All the loggers are searched for appenders. The appenders may also be containers
  22411. for appenders and these are also searched for additional loggers.
  22412. </para>
  22413. <para>
  22414. The list returned is unordered but does not contain duplicates.
  22415. </para>
  22416. </remarks>
  22417. </member>
  22418. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
  22419. <summary>
  22420. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
  22421. The appender may also be a container.
  22422. </summary>
  22423. <param name="appenderList"></param>
  22424. <param name="appender"></param>
  22425. </member>
  22426. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
  22427. <summary>
  22428. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
  22429. </summary>
  22430. <param name="appenderList"></param>
  22431. <param name="container"></param>
  22432. </member>
  22433. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)">
  22434. <summary>
  22435. Initialize the log4net system using the specified appender
  22436. </summary>
  22437. <param name="appender">the appender to use to log all logging events</param>
  22438. </member>
  22439. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender[])">
  22440. <summary>
  22441. Initialize the log4net system using the specified appenders
  22442. </summary>
  22443. <param name="appenders">the appenders to use to log all logging events</param>
  22444. </member>
  22445. <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])">
  22446. <summary>
  22447. Initialize the log4net system using the specified appenders
  22448. </summary>
  22449. <param name="appenders">the appenders to use to log all logging events</param>
  22450. <remarks>
  22451. <para>
  22452. This method provides the same functionality as the
  22453. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22454. on this object, but it is protected and therefore can be called by subclasses.
  22455. </para>
  22456. </remarks>
  22457. </member>
  22458. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)">
  22459. <summary>
  22460. Initialize the log4net system using the specified config
  22461. </summary>
  22462. <param name="element">the element containing the root of the config</param>
  22463. </member>
  22464. <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)">
  22465. <summary>
  22466. Initialize the log4net system using the specified config
  22467. </summary>
  22468. <param name="element">the element containing the root of the config</param>
  22469. <remarks>
  22470. <para>
  22471. This method provides the same functionality as the
  22472. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  22473. on this object, but it is protected and therefore can be called by subclasses.
  22474. </para>
  22475. </remarks>
  22476. </member>
  22477. <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
  22478. <summary>
  22479. Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
  22480. </summary>
  22481. <param name="level">The level to check against.</param>
  22482. <returns>
  22483. <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
  22484. </returns>
  22485. <remarks>
  22486. <para>
  22487. If this hierarchy has not been configured then this method will
  22488. always return <c>true</c>.
  22489. </para>
  22490. <para>
  22491. This method will return <c>true</c> if this repository is
  22492. disabled for <c>level</c> object passed as parameter and
  22493. <c>false</c> otherwise.
  22494. </para>
  22495. <para>
  22496. See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
  22497. </para>
  22498. </remarks>
  22499. </member>
  22500. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
  22501. <summary>
  22502. Clear all logger definitions from the internal hashtable
  22503. </summary>
  22504. <remarks>
  22505. <para>
  22506. This call will clear all logger definitions from the internal
  22507. hashtable. Invoking this method will irrevocably mess up the
  22508. logger hierarchy.
  22509. </para>
  22510. <para>
  22511. You should <b>really</b> know what you are doing before
  22512. invoking this method.
  22513. </para>
  22514. </remarks>
  22515. </member>
  22516. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
  22517. <summary>
  22518. Return a new logger instance named as the first parameter using
  22519. <paramref name="factory"/>.
  22520. </summary>
  22521. <param name="name">The name of the logger to retrieve</param>
  22522. <param name="factory">The factory that will make the new logger instance</param>
  22523. <returns>The logger object with the name specified</returns>
  22524. <remarks>
  22525. <para>
  22526. If a logger of that name already exists, then it will be
  22527. returned. Otherwise, a new logger will be instantiated by the
  22528. <paramref name="factory"/> parameter and linked with its existing
  22529. ancestors as well as children.
  22530. </para>
  22531. </remarks>
  22532. </member>
  22533. <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
  22534. <summary>
  22535. Sends a logger creation event to all registered listeners
  22536. </summary>
  22537. <param name="logger">The newly created logger</param>
  22538. <remarks>
  22539. Raises the logger creation event.
  22540. </remarks>
  22541. </member>
  22542. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
  22543. <summary>
  22544. Updates all the parents of the specified logger
  22545. </summary>
  22546. <param name="log">The logger to update the parents for</param>
  22547. <remarks>
  22548. <para>
  22549. This method loops through all the <i>potential</i> parents of
  22550. <paramref name="log"/>. There 3 possible cases:
  22551. </para>
  22552. <list type="number">
  22553. <item>
  22554. <term>No entry for the potential parent of <paramref name="log"/> exists</term>
  22555. <description>
  22556. We create a ProvisionNode for this potential
  22557. parent and insert <paramref name="log"/> in that provision node.
  22558. </description>
  22559. </item>
  22560. <item>
  22561. <term>The entry is of type Logger for the potential parent.</term>
  22562. <description>
  22563. The entry is <paramref name="log"/>'s nearest existing parent. We
  22564. update <paramref name="log"/>'s parent field with this entry. We also break from
  22565. he loop because updating our parent's parent is our parent's
  22566. responsibility.
  22567. </description>
  22568. </item>
  22569. <item>
  22570. <term>The entry is of type ProvisionNode for this potential parent.</term>
  22571. <description>
  22572. We add <paramref name="log"/> to the list of children for this
  22573. potential parent.
  22574. </description>
  22575. </item>
  22576. </list>
  22577. </remarks>
  22578. </member>
  22579. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
  22580. <summary>
  22581. Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
  22582. </summary>
  22583. <param name="pn"></param>
  22584. <param name="log"></param>
  22585. <remarks>
  22586. <para>
  22587. We update the links for all the children that placed themselves
  22588. in the provision node 'pn'. The second argument 'log' is a
  22589. reference for the newly created Logger, parent of all the
  22590. children in 'pn'.
  22591. </para>
  22592. <para>
  22593. We loop on all the children 'c' in 'pn'.
  22594. </para>
  22595. <para>
  22596. If the child 'c' has been already linked to a child of
  22597. 'log' then there is no need to update 'c'.
  22598. </para>
  22599. <para>
  22600. Otherwise, we set log's parent field to c's parent and set
  22601. c's parent field to log.
  22602. </para>
  22603. </remarks>
  22604. </member>
  22605. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
  22606. <summary>
  22607. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22608. </summary>
  22609. <param name="levelEntry">the level values</param>
  22610. <remarks>
  22611. <para>
  22612. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22613. </para>
  22614. <para>
  22615. Supports setting levels via the configuration file.
  22616. </para>
  22617. </remarks>
  22618. </member>
  22619. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
  22620. <summary>
  22621. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  22622. </summary>
  22623. <param name="propertyEntry">the property value</param>
  22624. <remarks>
  22625. <para>
  22626. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
  22627. </para>
  22628. <para>
  22629. Supports setting property values via the configuration file.
  22630. </para>
  22631. </remarks>
  22632. </member>
  22633. <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
  22634. <summary>
  22635. The fully qualified type of the Hierarchy class.
  22636. </summary>
  22637. <remarks>
  22638. Used by the internal logger to record the Type of the
  22639. log message.
  22640. </remarks>
  22641. </member>
  22642. <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
  22643. <summary>
  22644. Event used to notify that a logger has been created.
  22645. </summary>
  22646. <remarks>
  22647. <para>
  22648. Event raised when a logger is created.
  22649. </para>
  22650. </remarks>
  22651. </member>
  22652. <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
  22653. <summary>
  22654. Has no appender warning been emitted
  22655. </summary>
  22656. <remarks>
  22657. <para>
  22658. Flag to indicate if we have already issued a warning
  22659. about not having an appender warning.
  22660. </para>
  22661. </remarks>
  22662. </member>
  22663. <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
  22664. <summary>
  22665. Get the root of this hierarchy
  22666. </summary>
  22667. <remarks>
  22668. <para>
  22669. Get the root of this hierarchy.
  22670. </para>
  22671. </remarks>
  22672. </member>
  22673. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
  22674. <summary>
  22675. Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/> instance.
  22676. </summary>
  22677. <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/></value>
  22678. <remarks>
  22679. <para>
  22680. The logger factory is used to create logger instances.
  22681. </para>
  22682. </remarks>
  22683. </member>
  22684. <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
  22685. <summary>
  22686. A class to hold the value, name and display name for a level
  22687. </summary>
  22688. <remarks>
  22689. <para>
  22690. A class to hold the value, name and display name for a level
  22691. </para>
  22692. </remarks>
  22693. </member>
  22694. <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
  22695. <summary>
  22696. Override <c>Object.ToString</c> to return sensible debug info
  22697. </summary>
  22698. <returns>string info about this object</returns>
  22699. </member>
  22700. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
  22701. <summary>
  22702. Value of the level
  22703. </summary>
  22704. <remarks>
  22705. <para>
  22706. If the value is not set (defaults to -1) the value will be looked
  22707. up for the current level with the same name.
  22708. </para>
  22709. </remarks>
  22710. </member>
  22711. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
  22712. <summary>
  22713. Name of the level
  22714. </summary>
  22715. <value>
  22716. The name of the level
  22717. </value>
  22718. <remarks>
  22719. <para>
  22720. The name of the level.
  22721. </para>
  22722. </remarks>
  22723. </member>
  22724. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
  22725. <summary>
  22726. Display name for the level
  22727. </summary>
  22728. <value>
  22729. The display name of the level
  22730. </value>
  22731. <remarks>
  22732. <para>
  22733. The display name of the level.
  22734. </para>
  22735. </remarks>
  22736. </member>
  22737. <member name="T:log4net.Repository.Hierarchy.LoggerKey">
  22738. <summary>
  22739. Used internally to accelerate hash table searches.
  22740. </summary>
  22741. <remarks>
  22742. <para>
  22743. Internal class used to improve performance of
  22744. string keyed hashtables.
  22745. </para>
  22746. <para>
  22747. The hashcode of the string is cached for reuse.
  22748. The string is stored as an interned value.
  22749. When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
  22750. the reference equality of the interned strings is compared.
  22751. </para>
  22752. </remarks>
  22753. <author>Nicko Cadell</author>
  22754. <author>Gert Driesen</author>
  22755. </member>
  22756. <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
  22757. <summary>
  22758. Construct key with string name
  22759. </summary>
  22760. <remarks>
  22761. <para>
  22762. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> class
  22763. with the specified name.
  22764. </para>
  22765. <para>
  22766. Stores the hashcode of the string and interns
  22767. the string key to optimize comparisons.
  22768. </para>
  22769. <note>
  22770. The Compact Framework 1.0 the <see cref="M:System.String.Intern(System.String)"/>
  22771. method does not work. On the Compact Framework
  22772. the string keys are not interned nor are they
  22773. compared by reference.
  22774. </note>
  22775. </remarks>
  22776. <param name="name">The name of the logger.</param>
  22777. </member>
  22778. <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
  22779. <summary>
  22780. Returns a hash code for the current instance.
  22781. </summary>
  22782. <returns>A hash code for the current instance.</returns>
  22783. <remarks>
  22784. <para>
  22785. Returns the cached hashcode.
  22786. </para>
  22787. </remarks>
  22788. </member>
  22789. <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
  22790. <summary>
  22791. Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> instances
  22792. are equal.
  22793. </summary>
  22794. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>.</param>
  22795. <returns>
  22796. <c>true</c> if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/>; otherwise, <c>false</c>.
  22797. </returns>
  22798. <remarks>
  22799. <para>
  22800. Compares the references of the interned strings.
  22801. </para>
  22802. </remarks>
  22803. </member>
  22804. <member name="T:log4net.Repository.Hierarchy.ProvisionNode">
  22805. <summary>
  22806. Provision nodes are used where no logger instance has been specified
  22807. </summary>
  22808. <remarks>
  22809. <para>
  22810. <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
  22811. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> when there is no specified
  22812. <see cref="T:log4net.Repository.Hierarchy.Logger"/> for that node.
  22813. </para>
  22814. <para>
  22815. A provision node holds a list of child loggers on behalf of
  22816. a logger that does not exist.
  22817. </para>
  22818. </remarks>
  22819. <author>Nicko Cadell</author>
  22820. <author>Gert Driesen</author>
  22821. </member>
  22822. <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
  22823. <summary>
  22824. Create a new provision node with child node
  22825. </summary>
  22826. <param name="log">A child logger to add to this node.</param>
  22827. <remarks>
  22828. <para>
  22829. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> class
  22830. with the specified child logger.
  22831. </para>
  22832. </remarks>
  22833. </member>
  22834. <member name="T:log4net.Repository.Hierarchy.RootLogger">
  22835. <summary>
  22836. The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> sits at the root of the logger hierarchy tree.
  22837. </summary>
  22838. <remarks>
  22839. <para>
  22840. The <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger"/> except
  22841. that it provides several guarantees.
  22842. </para>
  22843. <para>
  22844. First, it cannot be assigned a <c>null</c>
  22845. level. Second, since the root logger cannot have a parent, the
  22846. <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
  22847. level field without walking the hierarchy.
  22848. </para>
  22849. </remarks>
  22850. <author>Nicko Cadell</author>
  22851. <author>Gert Driesen</author>
  22852. </member>
  22853. <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
  22854. <summary>
  22855. Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
  22856. </summary>
  22857. <param name="level">The level to assign to the root logger.</param>
  22858. <remarks>
  22859. <para>
  22860. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger"/> class with
  22861. the specified logging level.
  22862. </para>
  22863. <para>
  22864. The root logger names itself as "root". However, the root
  22865. logger cannot be retrieved by name.
  22866. </para>
  22867. </remarks>
  22868. </member>
  22869. <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
  22870. <summary>
  22871. The fully qualified type of the RootLogger class.
  22872. </summary>
  22873. <remarks>
  22874. Used by the internal logger to record the Type of the
  22875. log message.
  22876. </remarks>
  22877. </member>
  22878. <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
  22879. <summary>
  22880. Gets the assigned level value without walking the logger hierarchy.
  22881. </summary>
  22882. <value>The assigned level value without walking the logger hierarchy.</value>
  22883. <remarks>
  22884. <para>
  22885. Because the root logger cannot have a parent and its level
  22886. must not be <c>null</c> this property just returns the
  22887. value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
  22888. </para>
  22889. </remarks>
  22890. </member>
  22891. <member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
  22892. <summary>
  22893. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
  22894. </summary>
  22895. <value>
  22896. The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
  22897. </value>
  22898. <remarks>
  22899. <para>
  22900. Setting the level of the root logger to a <c>null</c> reference
  22901. may have catastrophic results. We prevent this here.
  22902. </para>
  22903. </remarks>
  22904. </member>
  22905. <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
  22906. <summary>
  22907. Initializes the log4net environment using an XML DOM.
  22908. </summary>
  22909. <remarks>
  22910. <para>
  22911. Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
  22912. </para>
  22913. </remarks>
  22914. <author>Nicko Cadell</author>
  22915. <author>Gert Driesen</author>
  22916. </member>
  22917. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
  22918. <summary>
  22919. Construct the configurator for a hierarchy
  22920. </summary>
  22921. <param name="hierarchy">The hierarchy to build.</param>
  22922. <remarks>
  22923. <para>
  22924. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator"/> class
  22925. with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  22926. </para>
  22927. </remarks>
  22928. </member>
  22929. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
  22930. <summary>
  22931. Configure the hierarchy by parsing a DOM tree of XML elements.
  22932. </summary>
  22933. <param name="element">The root element to parse.</param>
  22934. <remarks>
  22935. <para>
  22936. Configure the hierarchy by parsing a DOM tree of XML elements.
  22937. </para>
  22938. </remarks>
  22939. </member>
  22940. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
  22941. <summary>
  22942. Parse appenders by IDREF.
  22943. </summary>
  22944. <param name="appenderRef">The appender ref element.</param>
  22945. <returns>The instance of the appender that the ref refers to.</returns>
  22946. <remarks>
  22947. <para>
  22948. Parse an XML element that represents an appender and return
  22949. the appender.
  22950. </para>
  22951. </remarks>
  22952. </member>
  22953. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
  22954. <summary>
  22955. Parses an appender element.
  22956. </summary>
  22957. <param name="appenderElement">The appender element.</param>
  22958. <returns>The appender instance or <c>null</c> when parsing failed.</returns>
  22959. <remarks>
  22960. <para>
  22961. Parse an XML element that represents an appender and return
  22962. the appender instance.
  22963. </para>
  22964. </remarks>
  22965. </member>
  22966. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
  22967. <summary>
  22968. Parses a logger element.
  22969. </summary>
  22970. <param name="loggerElement">The logger element.</param>
  22971. <remarks>
  22972. <para>
  22973. Parse an XML element that represents a logger.
  22974. </para>
  22975. </remarks>
  22976. </member>
  22977. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
  22978. <summary>
  22979. Parses the root logger element.
  22980. </summary>
  22981. <param name="rootElement">The root element.</param>
  22982. <remarks>
  22983. <para>
  22984. Parse an XML element that represents the root logger.
  22985. </para>
  22986. </remarks>
  22987. </member>
  22988. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  22989. <summary>
  22990. Parses the children of a logger element.
  22991. </summary>
  22992. <param name="catElement">The category element.</param>
  22993. <param name="log">The logger instance.</param>
  22994. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  22995. <remarks>
  22996. <para>
  22997. Parse the child elements of a &lt;logger&gt; element.
  22998. </para>
  22999. </remarks>
  23000. </member>
  23001. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
  23002. <summary>
  23003. Parses an object renderer.
  23004. </summary>
  23005. <param name="element">The renderer element.</param>
  23006. <remarks>
  23007. <para>
  23008. Parse an XML element that represents a renderer.
  23009. </para>
  23010. </remarks>
  23011. </member>
  23012. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  23013. <summary>
  23014. Parses a level element.
  23015. </summary>
  23016. <param name="element">The level element.</param>
  23017. <param name="log">The logger object to set the level on.</param>
  23018. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  23019. <remarks>
  23020. <para>
  23021. Parse an XML element that represents a level.
  23022. </para>
  23023. </remarks>
  23024. </member>
  23025. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
  23026. <summary>
  23027. Sets a parameter on an object.
  23028. </summary>
  23029. <param name="element">The parameter element.</param>
  23030. <param name="target">The object to set the parameter on.</param>
  23031. <remarks>
  23032. The parameter name must correspond to a writable property
  23033. on the object. The value of the parameter is a string,
  23034. therefore this function will attempt to set a string
  23035. property first. If unable to set a string property it
  23036. will inspect the property and its argument type. It will
  23037. attempt to call a static method called <c>Parse</c> on the
  23038. type of the property. This method will take a single
  23039. string argument and return a value that can be used to
  23040. set the property.
  23041. </remarks>
  23042. </member>
  23043. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
  23044. <summary>
  23045. Test if an element has no attributes or child elements
  23046. </summary>
  23047. <param name="element">the element to inspect</param>
  23048. <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
  23049. </member>
  23050. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
  23051. <summary>
  23052. Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
  23053. </summary>
  23054. <param name="type">the type to inspect</param>
  23055. <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
  23056. </member>
  23057. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
  23058. <summary>
  23059. Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
  23060. </summary>
  23061. <param name="targetType">the type that has the method</param>
  23062. <param name="name">the name of the method</param>
  23063. <returns>the method info found</returns>
  23064. <remarks>
  23065. <para>
  23066. The method must be a public instance method on the <paramref name="targetType"/>.
  23067. The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
  23068. The method must take a single parameter.
  23069. </para>
  23070. </remarks>
  23071. </member>
  23072. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
  23073. <summary>
  23074. Converts a string value to a target type.
  23075. </summary>
  23076. <param name="type">The type of object to convert the string to.</param>
  23077. <param name="value">The string value to use as the value of the object.</param>
  23078. <returns>
  23079. <para>
  23080. An object of type <paramref name="type"/> with value <paramref name="value"/> or
  23081. <c>null</c> when the conversion could not be performed.
  23082. </para>
  23083. </returns>
  23084. </member>
  23085. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
  23086. <summary>
  23087. Creates an object as specified in XML.
  23088. </summary>
  23089. <param name="element">The XML element that contains the definition of the object.</param>
  23090. <param name="defaultTargetType">The object type to use if not explicitly specified.</param>
  23091. <param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
  23092. <returns>The object or <c>null</c></returns>
  23093. <remarks>
  23094. <para>
  23095. Parse an XML element and create an object instance based on the configuration
  23096. data.
  23097. </para>
  23098. <para>
  23099. The type of the instance may be specified in the XML. If not
  23100. specified then the <paramref name="defaultTargetType"/> is used
  23101. as the type. However the type is specified it must support the
  23102. <paramref name="typeConstraint"/> type.
  23103. </para>
  23104. </remarks>
  23105. </member>
  23106. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
  23107. <summary>
  23108. key: appenderName, value: appender.
  23109. </summary>
  23110. </member>
  23111. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
  23112. <summary>
  23113. The Hierarchy being configured.
  23114. </summary>
  23115. </member>
  23116. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
  23117. <summary>
  23118. The fully qualified type of the XmlHierarchyConfigurator class.
  23119. </summary>
  23120. <remarks>
  23121. Used by the internal logger to record the Type of the
  23122. log message.
  23123. </remarks>
  23124. </member>
  23125. <member name="T:log4net.Repository.ConfigurationChangedEventArgs">
  23126. <summary>
  23127. </summary>
  23128. </member>
  23129. <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
  23130. <summary>
  23131. </summary>
  23132. <param name="configurationMessages"></param>
  23133. </member>
  23134. <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
  23135. <summary>
  23136. </summary>
  23137. </member>
  23138. <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
  23139. <summary>
  23140. Delegate used to handle logger repository shutdown event notifications
  23141. </summary>
  23142. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
  23143. <param name="e">Empty event args</param>
  23144. <remarks>
  23145. <para>
  23146. Delegate used to handle logger repository shutdown event notifications.
  23147. </para>
  23148. </remarks>
  23149. </member>
  23150. <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
  23151. <summary>
  23152. Delegate used to handle logger repository configuration reset event notifications
  23153. </summary>
  23154. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
  23155. <param name="e">Empty event args</param>
  23156. <remarks>
  23157. <para>
  23158. Delegate used to handle logger repository configuration reset event notifications.
  23159. </para>
  23160. </remarks>
  23161. </member>
  23162. <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
  23163. <summary>
  23164. Delegate used to handle event notifications for logger repository configuration changes.
  23165. </summary>
  23166. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
  23167. <param name="e">Empty event arguments.</param>
  23168. <remarks>
  23169. <para>
  23170. Delegate used to handle event notifications for logger repository configuration changes.
  23171. </para>
  23172. </remarks>
  23173. </member>
  23174. <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
  23175. <summary>
  23176. Write the name of the current AppDomain to the output
  23177. </summary>
  23178. <remarks>
  23179. <para>
  23180. Write the name of the current AppDomain to the output writer
  23181. </para>
  23182. </remarks>
  23183. <author>Nicko Cadell</author>
  23184. </member>
  23185. <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23186. <summary>
  23187. Write the name of the current AppDomain to the output
  23188. </summary>
  23189. <param name="writer">the writer to write to</param>
  23190. <param name="state">null, state is not set</param>
  23191. <remarks>
  23192. <para>
  23193. Writes name of the current AppDomain to the output <paramref name="writer"/>.
  23194. </para>
  23195. </remarks>
  23196. </member>
  23197. <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
  23198. <summary>
  23199. Write the current date to the output
  23200. </summary>
  23201. <remarks>
  23202. <para>
  23203. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  23204. the current date and time to the writer as a string.
  23205. </para>
  23206. <para>
  23207. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23208. the formatting of the date. The following values are allowed:
  23209. <list type="definition">
  23210. <listheader>
  23211. <term>Option value</term>
  23212. <description>Output</description>
  23213. </listheader>
  23214. <item>
  23215. <term>ISO8601</term>
  23216. <description>
  23217. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  23218. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  23219. </description>
  23220. </item>
  23221. <item>
  23222. <term>DATE</term>
  23223. <description>
  23224. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  23225. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  23226. </description>
  23227. </item>
  23228. <item>
  23229. <term>ABSOLUTE</term>
  23230. <description>
  23231. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  23232. Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  23233. </description>
  23234. </item>
  23235. <item>
  23236. <term>other</term>
  23237. <description>
  23238. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  23239. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  23240. <see cref="M:DateTime.ToString(string)"/> method.
  23241. For details on valid patterns see
  23242. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  23243. </description>
  23244. </item>
  23245. </list>
  23246. </para>
  23247. <para>
  23248. The date and time is in the local time zone and is rendered in that zone.
  23249. To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
  23250. </para>
  23251. </remarks>
  23252. <author>Nicko Cadell</author>
  23253. </member>
  23254. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
  23255. <summary>
  23256. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  23257. </summary>
  23258. <remarks>
  23259. <para>
  23260. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  23261. </para>
  23262. </remarks>
  23263. </member>
  23264. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
  23265. <summary>
  23266. Initialize the converter options
  23267. </summary>
  23268. <remarks>
  23269. <para>
  23270. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  23271. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
  23272. be called on this object after the configuration properties have
  23273. been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
  23274. object is in an undefined state and must not be used.
  23275. </para>
  23276. <para>
  23277. If any of the configuration properties are modified then
  23278. <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
  23279. </para>
  23280. </remarks>
  23281. </member>
  23282. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23283. <summary>
  23284. Write the current date to the output
  23285. </summary>
  23286. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23287. <param name="state">null, state is not set</param>
  23288. <remarks>
  23289. <para>
  23290. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  23291. for it to render it to the writer.
  23292. </para>
  23293. <para>
  23294. The date and time passed is in the local time zone.
  23295. </para>
  23296. </remarks>
  23297. </member>
  23298. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
  23299. <summary>
  23300. The fully qualified type of the DatePatternConverter class.
  23301. </summary>
  23302. <remarks>
  23303. Used by the internal logger to record the Type of the
  23304. log message.
  23305. </remarks>
  23306. </member>
  23307. <member name="T:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter">
  23308. <summary>
  23309. Write an <see cref="T:System.Environment.SpecialFolder"/> folder path to the output
  23310. </summary>
  23311. <remarks>
  23312. <para>
  23313. Write an special path environment folder path to the output writer.
  23314. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23315. the name of the variable to output. <see cref="P:log4net.Util.PatternConverter.Option"/>
  23316. should be a value in the <see cref="T:System.Environment.SpecialFolder"/> enumeration.
  23317. </para>
  23318. </remarks>
  23319. <author>Ron Grabowski</author>
  23320. </member>
  23321. <member name="M:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23322. <summary>
  23323. Write an special path environment folder path to the output
  23324. </summary>
  23325. <param name="writer">the writer to write to</param>
  23326. <param name="state">null, state is not set</param>
  23327. <remarks>
  23328. <para>
  23329. Writes the special path environment folder path to the output <paramref name="writer"/>.
  23330. The name of the special path environment folder path to output must be set
  23331. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23332. property.
  23333. </para>
  23334. </remarks>
  23335. </member>
  23336. <member name="F:log4net.Util.PatternStringConverters.EnvironmentFolderPathPatternConverter.declaringType">
  23337. <summary>
  23338. The fully qualified type of the EnvironmentFolderPathPatternConverter class.
  23339. </summary>
  23340. <remarks>
  23341. Used by the internal logger to record the Type of the
  23342. log message.
  23343. </remarks>
  23344. </member>
  23345. <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
  23346. <summary>
  23347. Write an environment variable to the output
  23348. </summary>
  23349. <remarks>
  23350. <para>
  23351. Write an environment variable to the output writer.
  23352. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  23353. the name of the variable to output.
  23354. </para>
  23355. </remarks>
  23356. <author>Nicko Cadell</author>
  23357. </member>
  23358. <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23359. <summary>
  23360. Write an environment variable to the output
  23361. </summary>
  23362. <param name="writer">the writer to write to</param>
  23363. <param name="state">null, state is not set</param>
  23364. <remarks>
  23365. <para>
  23366. Writes the environment variable to the output <paramref name="writer"/>.
  23367. The name of the environment variable to output must be set
  23368. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23369. property.
  23370. </para>
  23371. </remarks>
  23372. </member>
  23373. <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
  23374. <summary>
  23375. The fully qualified type of the EnvironmentPatternConverter class.
  23376. </summary>
  23377. <remarks>
  23378. Used by the internal logger to record the Type of the
  23379. log message.
  23380. </remarks>
  23381. </member>
  23382. <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
  23383. <summary>
  23384. Write the current thread identity to the output
  23385. </summary>
  23386. <remarks>
  23387. <para>
  23388. Write the current thread identity to the output writer
  23389. </para>
  23390. </remarks>
  23391. <author>Nicko Cadell</author>
  23392. </member>
  23393. <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23394. <summary>
  23395. Write the current thread identity to the output
  23396. </summary>
  23397. <param name="writer">the writer to write to</param>
  23398. <param name="state">null, state is not set</param>
  23399. <remarks>
  23400. <para>
  23401. Writes the current thread identity to the output <paramref name="writer"/>.
  23402. </para>
  23403. </remarks>
  23404. </member>
  23405. <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
  23406. <summary>
  23407. The fully qualified type of the IdentityPatternConverter class.
  23408. </summary>
  23409. <remarks>
  23410. Used by the internal logger to record the Type of the
  23411. log message.
  23412. </remarks>
  23413. </member>
  23414. <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
  23415. <summary>
  23416. Pattern converter for literal string instances in the pattern
  23417. </summary>
  23418. <remarks>
  23419. <para>
  23420. Writes the literal string value specified in the
  23421. <see cref="P:log4net.Util.PatternConverter.Option"/> property to
  23422. the output.
  23423. </para>
  23424. </remarks>
  23425. <author>Nicko Cadell</author>
  23426. </member>
  23427. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
  23428. <summary>
  23429. Set the next converter in the chain
  23430. </summary>
  23431. <param name="pc">The next pattern converter in the chain</param>
  23432. <returns>The next pattern converter</returns>
  23433. <remarks>
  23434. <para>
  23435. Special case the building of the pattern converter chain
  23436. for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
  23437. literals in the pattern can be represented by a single combined
  23438. pattern converter. This implementation detects when a
  23439. <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
  23440. after this converter and combines its value with this converter's
  23441. literal value.
  23442. </para>
  23443. </remarks>
  23444. </member>
  23445. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
  23446. <summary>
  23447. Write the literal to the output
  23448. </summary>
  23449. <param name="writer">the writer to write to</param>
  23450. <param name="state">null, not set</param>
  23451. <remarks>
  23452. <para>
  23453. Override the formatting behavior to ignore the FormattingInfo
  23454. because we have a literal instead.
  23455. </para>
  23456. <para>
  23457. Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
  23458. to the output <paramref name="writer"/>.
  23459. </para>
  23460. </remarks>
  23461. </member>
  23462. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23463. <summary>
  23464. Convert this pattern into the rendered message
  23465. </summary>
  23466. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23467. <param name="state">null, not set</param>
  23468. <remarks>
  23469. <para>
  23470. This method is not used.
  23471. </para>
  23472. </remarks>
  23473. </member>
  23474. <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
  23475. <summary>
  23476. Writes a newline to the output
  23477. </summary>
  23478. <remarks>
  23479. <para>
  23480. Writes the system dependent line terminator to the output.
  23481. This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
  23482. </para>
  23483. <list type="definition">
  23484. <listheader>
  23485. <term>Option Value</term>
  23486. <description>Output</description>
  23487. </listheader>
  23488. <item>
  23489. <term>DOS</term>
  23490. <description>DOS or Windows line terminator <c>"\r\n"</c></description>
  23491. </item>
  23492. <item>
  23493. <term>UNIX</term>
  23494. <description>UNIX line terminator <c>"\n"</c></description>
  23495. </item>
  23496. </list>
  23497. </remarks>
  23498. <author>Nicko Cadell</author>
  23499. </member>
  23500. <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
  23501. <summary>
  23502. Initialize the converter
  23503. </summary>
  23504. <remarks>
  23505. <para>
  23506. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  23507. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
  23508. be called on this object after the configuration properties have
  23509. been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
  23510. object is in an undefined state and must not be used.
  23511. </para>
  23512. <para>
  23513. If any of the configuration properties are modified then
  23514. <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
  23515. </para>
  23516. </remarks>
  23517. </member>
  23518. <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
  23519. <summary>
  23520. Write the current process ID to the output
  23521. </summary>
  23522. <remarks>
  23523. <para>
  23524. Write the current process ID to the output writer
  23525. </para>
  23526. </remarks>
  23527. <author>Nicko Cadell</author>
  23528. </member>
  23529. <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23530. <summary>
  23531. Write the current process ID to the output
  23532. </summary>
  23533. <param name="writer">the writer to write to</param>
  23534. <param name="state">null, state is not set</param>
  23535. <remarks>
  23536. <para>
  23537. Write the current process ID to the output <paramref name="writer"/>.
  23538. </para>
  23539. </remarks>
  23540. </member>
  23541. <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
  23542. <summary>
  23543. The fully qualified type of the ProcessIdPatternConverter class.
  23544. </summary>
  23545. <remarks>
  23546. Used by the internal logger to record the Type of the
  23547. log message.
  23548. </remarks>
  23549. </member>
  23550. <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
  23551. <summary>
  23552. Property pattern converter
  23553. </summary>
  23554. <remarks>
  23555. <para>
  23556. This pattern converter reads the thread and global properties.
  23557. The thread properties take priority over global properties.
  23558. See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
  23559. thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
  23560. details of the global properties.
  23561. </para>
  23562. <para>
  23563. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  23564. lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  23565. then all properties will be dumped as a list of key value pairs.
  23566. </para>
  23567. </remarks>
  23568. <author>Nicko Cadell</author>
  23569. </member>
  23570. <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23571. <summary>
  23572. Write the property value to the output
  23573. </summary>
  23574. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23575. <param name="state">null, state is not set</param>
  23576. <remarks>
  23577. <para>
  23578. Writes out the value of a named property. The property name
  23579. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23580. property.
  23581. </para>
  23582. <para>
  23583. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  23584. then all the properties are written as key value pairs.
  23585. </para>
  23586. </remarks>
  23587. </member>
  23588. <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
  23589. <summary>
  23590. A Pattern converter that generates a string of random characters
  23591. </summary>
  23592. <remarks>
  23593. <para>
  23594. The converter generates a string of random characters. By default
  23595. the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
  23596. to the string value of the length required.
  23597. </para>
  23598. <para>
  23599. The random characters in the string are limited to uppercase letters
  23600. and numbers only.
  23601. </para>
  23602. <para>
  23603. The random number generator used by this class is not cryptographically secure.
  23604. </para>
  23605. </remarks>
  23606. <author>Nicko Cadell</author>
  23607. </member>
  23608. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
  23609. <summary>
  23610. Shared random number generator
  23611. </summary>
  23612. </member>
  23613. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
  23614. <summary>
  23615. Length of random string to generate. Default length 4.
  23616. </summary>
  23617. </member>
  23618. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
  23619. <summary>
  23620. Initialize the converter options
  23621. </summary>
  23622. <remarks>
  23623. <para>
  23624. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  23625. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
  23626. be called on this object after the configuration properties have
  23627. been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
  23628. object is in an undefined state and must not be used.
  23629. </para>
  23630. <para>
  23631. If any of the configuration properties are modified then
  23632. <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
  23633. </para>
  23634. </remarks>
  23635. </member>
  23636. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23637. <summary>
  23638. Write a randoim string to the output
  23639. </summary>
  23640. <param name="writer">the writer to write to</param>
  23641. <param name="state">null, state is not set</param>
  23642. <remarks>
  23643. <para>
  23644. Write a randoim string to the output <paramref name="writer"/>.
  23645. </para>
  23646. </remarks>
  23647. </member>
  23648. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
  23649. <summary>
  23650. The fully qualified type of the RandomStringPatternConverter class.
  23651. </summary>
  23652. <remarks>
  23653. Used by the internal logger to record the Type of the
  23654. log message.
  23655. </remarks>
  23656. </member>
  23657. <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
  23658. <summary>
  23659. Write the current threads username to the output
  23660. </summary>
  23661. <remarks>
  23662. <para>
  23663. Write the current threads username to the output writer
  23664. </para>
  23665. </remarks>
  23666. <author>Nicko Cadell</author>
  23667. </member>
  23668. <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23669. <summary>
  23670. Write the current threads username to the output
  23671. </summary>
  23672. <param name="writer">the writer to write to</param>
  23673. <param name="state">null, state is not set</param>
  23674. <remarks>
  23675. <para>
  23676. Write the current threads username to the output <paramref name="writer"/>.
  23677. </para>
  23678. </remarks>
  23679. </member>
  23680. <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
  23681. <summary>
  23682. The fully qualified type of the UserNamePatternConverter class.
  23683. </summary>
  23684. <remarks>
  23685. Used by the internal logger to record the Type of the
  23686. log message.
  23687. </remarks>
  23688. </member>
  23689. <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
  23690. <summary>
  23691. Write the UTC date time to the output
  23692. </summary>
  23693. <remarks>
  23694. <para>
  23695. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  23696. the current date and time in Universal time.
  23697. </para>
  23698. <para>
  23699. See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
  23700. </para>
  23701. </remarks>
  23702. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  23703. <author>Nicko Cadell</author>
  23704. </member>
  23705. <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  23706. <summary>
  23707. Write the current date and time to the output
  23708. </summary>
  23709. <param name="writer"><see cref="T:System.IO.TextWriter"/> that will receive the formatted result.</param>
  23710. <param name="state">null, state is not set</param>
  23711. <remarks>
  23712. <para>
  23713. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  23714. for it to render it to the writer.
  23715. </para>
  23716. <para>
  23717. The date is in Universal time when it is rendered.
  23718. </para>
  23719. </remarks>
  23720. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  23721. </member>
  23722. <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
  23723. <summary>
  23724. The fully qualified type of the UtcDatePatternConverter class.
  23725. </summary>
  23726. <remarks>
  23727. Used by the internal logger to record the Type of the
  23728. log message.
  23729. </remarks>
  23730. </member>
  23731. <member name="T:log4net.Util.TypeConverters.BooleanConverter">
  23732. <summary>
  23733. Type converter for Boolean.
  23734. </summary>
  23735. <remarks>
  23736. <para>
  23737. Supports conversion from string to <c>bool</c> type.
  23738. </para>
  23739. </remarks>
  23740. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  23741. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  23742. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  23743. <author>Nicko Cadell</author>
  23744. <author>Gert Driesen</author>
  23745. </member>
  23746. <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
  23747. <summary>
  23748. Can the source type be converted to the type supported by this object
  23749. </summary>
  23750. <param name="sourceType">the type to convert</param>
  23751. <returns>true if the conversion is possible</returns>
  23752. <remarks>
  23753. <para>
  23754. Returns <c>true</c> if the <paramref name="sourceType"/> is
  23755. the <see cref="T:System.String"/> type.
  23756. </para>
  23757. </remarks>
  23758. </member>
  23759. <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
  23760. <summary>
  23761. Convert the source object to the type supported by this object
  23762. </summary>
  23763. <param name="source">the object to convert</param>
  23764. <returns>the converted object</returns>
  23765. <remarks>
  23766. <para>
  23767. Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
  23768. <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
  23769. </para>
  23770. </remarks>
  23771. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  23772. The <paramref name="source"/> object cannot be converted to the
  23773. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
  23774. method.
  23775. </exception>
  23776. </member>
  23777. <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  23778. <summary>
  23779. Exception base type for conversion errors.
  23780. </summary>
  23781. <remarks>
  23782. <para>
  23783. This type extends <see cref="T:System.ApplicationException"/>. It
  23784. does not add any new functionality but does differentiate the
  23785. type of exception being thrown.
  23786. </para>
  23787. </remarks>
  23788. <author>Nicko Cadell</author>
  23789. <author>Gert Driesen</author>
  23790. </member>
  23791. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
  23792. <summary>
  23793. Constructor
  23794. </summary>
  23795. <remarks>
  23796. <para>
  23797. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  23798. </para>
  23799. </remarks>
  23800. </member>
  23801. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
  23802. <summary>
  23803. Constructor
  23804. </summary>
  23805. <param name="message">A message to include with the exception.</param>
  23806. <remarks>
  23807. <para>
  23808. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  23809. with the specified message.
  23810. </para>
  23811. </remarks>
  23812. </member>
  23813. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
  23814. <summary>
  23815. Constructor
  23816. </summary>
  23817. <param name="message">A message to include with the exception.</param>
  23818. <param name="innerException">A nested exception to include.</param>
  23819. <remarks>
  23820. <para>
  23821. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  23822. with the specified message and inner exception.
  23823. </para>
  23824. </remarks>
  23825. </member>
  23826. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  23827. <summary>
  23828. Serialization constructor
  23829. </summary>
  23830. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
  23831. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  23832. <remarks>
  23833. <para>
  23834. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class
  23835. with serialized data.
  23836. </para>
  23837. </remarks>
  23838. </member>
  23839. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
  23840. <summary>
  23841. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  23842. </summary>
  23843. <param name="destinationType">The conversion destination type.</param>
  23844. <param name="sourceValue">The value to convert.</param>
  23845. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
  23846. <remarks>
  23847. <para>
  23848. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  23849. </para>
  23850. </remarks>
  23851. </member>
  23852. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
  23853. <summary>
  23854. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  23855. </summary>
  23856. <param name="destinationType">The conversion destination type.</param>
  23857. <param name="sourceValue">The value to convert.</param>
  23858. <param name="innerException">A nested exception to include.</param>
  23859. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/>.</returns>
  23860. <remarks>
  23861. <para>
  23862. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException"/> class.
  23863. </para>
  23864. </remarks>
  23865. </member>
  23866. <member name="T:log4net.Util.TypeConverters.ConverterRegistry">
  23867. <summary>
  23868. Register of type converters for specific types.
  23869. </summary>
  23870. <remarks>
  23871. <para>
  23872. Maintains a registry of type converters used to convert between
  23873. types.
  23874. </para>
  23875. <para>
  23876. Use the <see cref="M:AddConverter(Type, object)"/> and
  23877. <see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
  23878. The <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)"/> and <see cref="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)"/> methods
  23879. lookup appropriate converters to use.
  23880. </para>
  23881. </remarks>
  23882. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  23883. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  23884. <author>Nicko Cadell</author>
  23885. <author>Gert Driesen</author>
  23886. </member>
  23887. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
  23888. <summary>
  23889. Private constructor
  23890. </summary>
  23891. <remarks>
  23892. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry"/> class.
  23893. </remarks>
  23894. </member>
  23895. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
  23896. <summary>
  23897. Static constructor.
  23898. </summary>
  23899. <remarks>
  23900. <para>
  23901. This constructor defines the intrinsic type converters.
  23902. </para>
  23903. </remarks>
  23904. </member>
  23905. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
  23906. <summary>
  23907. Adds a converter for a specific type.
  23908. </summary>
  23909. <param name="destinationType">The type being converted to.</param>
  23910. <param name="converter">The type converter to use to convert to the destination type.</param>
  23911. <remarks>
  23912. <para>
  23913. Adds a converter instance for a specific type.
  23914. </para>
  23915. </remarks>
  23916. </member>
  23917. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
  23918. <summary>
  23919. Adds a converter for a specific type.
  23920. </summary>
  23921. <param name="destinationType">The type being converted to.</param>
  23922. <param name="converterType">The type of the type converter to use to convert to the destination type.</param>
  23923. <remarks>
  23924. <para>
  23925. Adds a converter <see cref="T:System.Type"/> for a specific type.
  23926. </para>
  23927. </remarks>
  23928. </member>
  23929. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
  23930. <summary>
  23931. Gets the type converter to use to convert values to the destination type.
  23932. </summary>
  23933. <param name="sourceType">The type being converted from.</param>
  23934. <param name="destinationType">The type being converted to.</param>
  23935. <returns>
  23936. The type converter instance to use for type conversions or <c>null</c>
  23937. if no type converter is found.
  23938. </returns>
  23939. <remarks>
  23940. <para>
  23941. Gets the type converter to use to convert values to the destination type.
  23942. </para>
  23943. </remarks>
  23944. </member>
  23945. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
  23946. <summary>
  23947. Gets the type converter to use to convert values to the destination type.
  23948. </summary>
  23949. <param name="destinationType">The type being converted to.</param>
  23950. <returns>
  23951. The type converter instance to use for type conversions or <c>null</c>
  23952. if no type converter is found.
  23953. </returns>
  23954. <remarks>
  23955. <para>
  23956. Gets the type converter to use to convert values to the destination type.
  23957. </para>
  23958. </remarks>
  23959. </member>
  23960. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
  23961. <summary>
  23962. Lookups the type converter to use as specified by the attributes on the
  23963. destination type.
  23964. </summary>
  23965. <param name="destinationType">The type being converted to.</param>
  23966. <returns>
  23967. The type converter instance to use for type conversions or <c>null</c>
  23968. if no type converter is found.
  23969. </returns>
  23970. </member>
  23971. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
  23972. <summary>
  23973. Creates the instance of the type converter.
  23974. </summary>
  23975. <param name="converterType">The type of the type converter.</param>
  23976. <returns>
  23977. The type converter instance to use for type conversions or <c>null</c>
  23978. if no type converter is found.
  23979. </returns>
  23980. <remarks>
  23981. <para>
  23982. The type specified for the type converter must implement
  23983. the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
  23984. and must have a public default (no argument) constructor.
  23985. </para>
  23986. </remarks>
  23987. </member>
  23988. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
  23989. <summary>
  23990. The fully qualified type of the ConverterRegistry class.
  23991. </summary>
  23992. <remarks>
  23993. Used by the internal logger to record the Type of the
  23994. log message.
  23995. </remarks>
  23996. </member>
  23997. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
  23998. <summary>
  23999. Mapping from <see cref="T:System.Type"/> to type converter.
  24000. </summary>
  24001. </member>
  24002. <member name="T:log4net.Util.TypeConverters.EncodingConverter">
  24003. <summary>
  24004. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  24005. </summary>
  24006. <remarks>
  24007. <para>
  24008. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  24009. </para>
  24010. </remarks>
  24011. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24012. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24013. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24014. <author>Nicko Cadell</author>
  24015. <author>Gert Driesen</author>
  24016. </member>
  24017. <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
  24018. <summary>
  24019. Can the source type be converted to the type supported by this object
  24020. </summary>
  24021. <param name="sourceType">the type to convert</param>
  24022. <returns>true if the conversion is possible</returns>
  24023. <remarks>
  24024. <para>
  24025. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24026. the <see cref="T:System.String"/> type.
  24027. </para>
  24028. </remarks>
  24029. </member>
  24030. <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
  24031. <summary>
  24032. Overrides the ConvertFrom method of IConvertFrom.
  24033. </summary>
  24034. <param name="source">the object to convert to an encoding</param>
  24035. <returns>the encoding</returns>
  24036. <remarks>
  24037. <para>
  24038. Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
  24039. convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
  24040. </para>
  24041. </remarks>
  24042. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24043. The <paramref name="source"/> object cannot be converted to the
  24044. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
  24045. method.
  24046. </exception>
  24047. </member>
  24048. <member name="T:log4net.Util.TypeConverters.IConvertTo">
  24049. <summary>
  24050. Interface supported by type converters
  24051. </summary>
  24052. <remarks>
  24053. <para>
  24054. This interface supports conversion from a single type to arbitrary types.
  24055. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  24056. </para>
  24057. </remarks>
  24058. <author>Nicko Cadell</author>
  24059. </member>
  24060. <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
  24061. <summary>
  24062. Returns whether this converter can convert the object to the specified type
  24063. </summary>
  24064. <param name="targetType">A Type that represents the type you want to convert to</param>
  24065. <returns>true if the conversion is possible</returns>
  24066. <remarks>
  24067. <para>
  24068. Test if the type supported by this converter can be converted to the
  24069. <paramref name="targetType"/>.
  24070. </para>
  24071. </remarks>
  24072. </member>
  24073. <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
  24074. <summary>
  24075. Converts the given value object to the specified type, using the arguments
  24076. </summary>
  24077. <param name="source">the object to convert</param>
  24078. <param name="targetType">The Type to convert the value parameter to</param>
  24079. <returns>the converted object</returns>
  24080. <remarks>
  24081. <para>
  24082. Converts the <paramref name="source"/> (which must be of the type supported
  24083. by this converter) to the <paramref name="targetType"/> specified..
  24084. </para>
  24085. </remarks>
  24086. </member>
  24087. <member name="T:log4net.Util.TypeConverters.IPAddressConverter">
  24088. <summary>
  24089. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  24090. </summary>
  24091. <remarks>
  24092. <para>
  24093. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  24094. </para>
  24095. </remarks>
  24096. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24097. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24098. <author>Nicko Cadell</author>
  24099. </member>
  24100. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
  24101. <summary>
  24102. Can the source type be converted to the type supported by this object
  24103. </summary>
  24104. <param name="sourceType">the type to convert</param>
  24105. <returns>true if the conversion is possible</returns>
  24106. <remarks>
  24107. <para>
  24108. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24109. the <see cref="T:System.String"/> type.
  24110. </para>
  24111. </remarks>
  24112. </member>
  24113. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
  24114. <summary>
  24115. Overrides the ConvertFrom method of IConvertFrom.
  24116. </summary>
  24117. <param name="source">the object to convert to an IPAddress</param>
  24118. <returns>the IPAddress</returns>
  24119. <remarks>
  24120. <para>
  24121. Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
  24122. <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
  24123. If that fails then the string is resolved as a DNS hostname.
  24124. </para>
  24125. </remarks>
  24126. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24127. The <paramref name="source"/> object cannot be converted to the
  24128. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
  24129. method.
  24130. </exception>
  24131. </member>
  24132. <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
  24133. <summary>
  24134. Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
  24135. </summary>
  24136. </member>
  24137. <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
  24138. <summary>
  24139. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  24140. </summary>
  24141. <remarks>
  24142. <para>
  24143. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  24144. </para>
  24145. <para>
  24146. The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
  24147. of the <see cref="T:log4net.Layout.PatternLayout"/>.
  24148. </para>
  24149. </remarks>
  24150. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24151. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24152. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24153. <author>Nicko Cadell</author>
  24154. </member>
  24155. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
  24156. <summary>
  24157. Can the source type be converted to the type supported by this object
  24158. </summary>
  24159. <param name="sourceType">the type to convert</param>
  24160. <returns>true if the conversion is possible</returns>
  24161. <remarks>
  24162. <para>
  24163. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24164. the <see cref="T:System.String"/> type.
  24165. </para>
  24166. </remarks>
  24167. </member>
  24168. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
  24169. <summary>
  24170. Overrides the ConvertFrom method of IConvertFrom.
  24171. </summary>
  24172. <param name="source">the object to convert to a PatternLayout</param>
  24173. <returns>the PatternLayout</returns>
  24174. <remarks>
  24175. <para>
  24176. Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
  24177. the <paramref name="source"/> <see cref="T:System.String"/> as the
  24178. <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
  24179. </para>
  24180. </remarks>
  24181. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24182. The <paramref name="source"/> object cannot be converted to the
  24183. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
  24184. method.
  24185. </exception>
  24186. </member>
  24187. <member name="T:log4net.Util.TypeConverters.PatternStringConverter">
  24188. <summary>
  24189. Convert between string and <see cref="T:log4net.Util.PatternString"/>
  24190. </summary>
  24191. <remarks>
  24192. <para>
  24193. Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
  24194. and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
  24195. </para>
  24196. <para>
  24197. The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
  24198. of the <see cref="T:log4net.Util.PatternString"/>.
  24199. </para>
  24200. </remarks>
  24201. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24202. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24203. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24204. <author>Nicko Cadell</author>
  24205. </member>
  24206. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
  24207. <summary>
  24208. Can the target type be converted to the type supported by this object
  24209. </summary>
  24210. <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
  24211. <returns>true if the conversion is possible</returns>
  24212. <remarks>
  24213. <para>
  24214. Returns <c>true</c> if the <paramref name="targetType"/> is
  24215. assignable from a <see cref="T:System.String"/> type.
  24216. </para>
  24217. </remarks>
  24218. </member>
  24219. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
  24220. <summary>
  24221. Converts the given value object to the specified type, using the arguments
  24222. </summary>
  24223. <param name="source">the object to convert</param>
  24224. <param name="targetType">The Type to convert the value parameter to</param>
  24225. <returns>the converted object</returns>
  24226. <remarks>
  24227. <para>
  24228. Uses the <see cref="M:PatternString.Format()"/> method to convert the
  24229. <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
  24230. </para>
  24231. </remarks>
  24232. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24233. The <paramref name="source"/> object cannot be converted to the
  24234. <paramref name="targetType"/>. To check for this condition use the
  24235. <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
  24236. </exception>
  24237. </member>
  24238. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
  24239. <summary>
  24240. Can the source type be converted to the type supported by this object
  24241. </summary>
  24242. <param name="sourceType">the type to convert</param>
  24243. <returns>true if the conversion is possible</returns>
  24244. <remarks>
  24245. <para>
  24246. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24247. the <see cref="T:System.String"/> type.
  24248. </para>
  24249. </remarks>
  24250. </member>
  24251. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
  24252. <summary>
  24253. Overrides the ConvertFrom method of IConvertFrom.
  24254. </summary>
  24255. <param name="source">the object to convert to a PatternString</param>
  24256. <returns>the PatternString</returns>
  24257. <remarks>
  24258. <para>
  24259. Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
  24260. the <paramref name="source"/> <see cref="T:System.String"/> as the
  24261. <see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
  24262. </para>
  24263. </remarks>
  24264. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24265. The <paramref name="source"/> object cannot be converted to the
  24266. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
  24267. method.
  24268. </exception>
  24269. </member>
  24270. <member name="T:log4net.Util.TypeConverters.TypeConverter">
  24271. <summary>
  24272. Supports conversion from string to <see cref="T:System.Type"/> type.
  24273. </summary>
  24274. <remarks>
  24275. <para>
  24276. Supports conversion from string to <see cref="T:System.Type"/> type.
  24277. </para>
  24278. </remarks>
  24279. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  24280. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24281. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  24282. <author>Nicko Cadell</author>
  24283. </member>
  24284. <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
  24285. <summary>
  24286. Can the source type be converted to the type supported by this object
  24287. </summary>
  24288. <param name="sourceType">the type to convert</param>
  24289. <returns>true if the conversion is possible</returns>
  24290. <remarks>
  24291. <para>
  24292. Returns <c>true</c> if the <paramref name="sourceType"/> is
  24293. the <see cref="T:System.String"/> type.
  24294. </para>
  24295. </remarks>
  24296. </member>
  24297. <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
  24298. <summary>
  24299. Overrides the ConvertFrom method of IConvertFrom.
  24300. </summary>
  24301. <param name="source">the object to convert to a Type</param>
  24302. <returns>the Type</returns>
  24303. <remarks>
  24304. <para>
  24305. Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
  24306. <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
  24307. Additional effort is made to locate partially specified types
  24308. by searching the loaded assemblies.
  24309. </para>
  24310. </remarks>
  24311. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  24312. The <paramref name="source"/> object cannot be converted to the
  24313. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
  24314. method.
  24315. </exception>
  24316. </member>
  24317. <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
  24318. <summary>
  24319. Attribute used to associate a type converter
  24320. </summary>
  24321. <remarks>
  24322. <para>
  24323. Class and Interface level attribute that specifies a type converter
  24324. to use with the associated type.
  24325. </para>
  24326. <para>
  24327. To associate a type converter with a target type apply a
  24328. <c>TypeConverterAttribute</c> to the target type. Specify the
  24329. type of the type converter on the attribute.
  24330. </para>
  24331. </remarks>
  24332. <author>Nicko Cadell</author>
  24333. <author>Gert Driesen</author>
  24334. </member>
  24335. <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
  24336. <summary>
  24337. The string type name of the type converter
  24338. </summary>
  24339. </member>
  24340. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
  24341. <summary>
  24342. Default constructor
  24343. </summary>
  24344. <remarks>
  24345. <para>
  24346. Default constructor
  24347. </para>
  24348. </remarks>
  24349. </member>
  24350. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
  24351. <summary>
  24352. Create a new type converter attribute for the specified type name
  24353. </summary>
  24354. <param name="typeName">The string type name of the type converter</param>
  24355. <remarks>
  24356. <para>
  24357. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24358. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24359. </para>
  24360. </remarks>
  24361. </member>
  24362. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
  24363. <summary>
  24364. Create a new type converter attribute for the specified type
  24365. </summary>
  24366. <param name="converterType">The type of the type converter</param>
  24367. <remarks>
  24368. <para>
  24369. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24370. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24371. </para>
  24372. </remarks>
  24373. </member>
  24374. <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
  24375. <summary>
  24376. The string type name of the type converter
  24377. </summary>
  24378. <value>
  24379. The string type name of the type converter
  24380. </value>
  24381. <remarks>
  24382. <para>
  24383. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  24384. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  24385. </para>
  24386. </remarks>
  24387. </member>
  24388. <member name="T:log4net.Util.AppenderAttachedImpl">
  24389. <summary>
  24390. A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  24391. </summary>
  24392. <remarks>
  24393. <para>
  24394. This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
  24395. interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  24396. should aggregate an instance of this type.
  24397. </para>
  24398. </remarks>
  24399. <author>Nicko Cadell</author>
  24400. <author>Gert Driesen</author>
  24401. </member>
  24402. <member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
  24403. <summary>
  24404. Constructor
  24405. </summary>
  24406. <remarks>
  24407. <para>
  24408. Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
  24409. </para>
  24410. </remarks>
  24411. </member>
  24412. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
  24413. <summary>
  24414. Append on on all attached appenders.
  24415. </summary>
  24416. <param name="loggingEvent">The event being logged.</param>
  24417. <returns>The number of appenders called.</returns>
  24418. <remarks>
  24419. <para>
  24420. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
  24421. attached appenders.
  24422. </para>
  24423. </remarks>
  24424. </member>
  24425. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
  24426. <summary>
  24427. Append on on all attached appenders.
  24428. </summary>
  24429. <param name="loggingEvents">The array of events being logged.</param>
  24430. <returns>The number of appenders called.</returns>
  24431. <remarks>
  24432. <para>
  24433. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method on all
  24434. attached appenders.
  24435. </para>
  24436. </remarks>
  24437. </member>
  24438. <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
  24439. <summary>
  24440. Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
  24441. the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
  24442. </summary>
  24443. <param name="appender">The appender</param>
  24444. <param name="loggingEvents">The events</param>
  24445. <remarks>
  24446. <para>
  24447. If the <paramref name="appender"/> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
  24448. interface then the <paramref name="loggingEvents"/> will be passed
  24449. through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
  24450. objects in the array will be passed one at a time.
  24451. </para>
  24452. </remarks>
  24453. </member>
  24454. <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
  24455. <summary>
  24456. Attaches an appender.
  24457. </summary>
  24458. <param name="newAppender">The appender to add.</param>
  24459. <remarks>
  24460. <para>
  24461. If the appender is already in the list it won't be added again.
  24462. </para>
  24463. </remarks>
  24464. </member>
  24465. <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
  24466. <summary>
  24467. Gets an attached appender with the specified name.
  24468. </summary>
  24469. <param name="name">The name of the appender to get.</param>
  24470. <returns>
  24471. The appender with the name specified, or <c>null</c> if no appender with the
  24472. specified name is found.
  24473. </returns>
  24474. <remarks>
  24475. <para>
  24476. Lookup an attached appender by name.
  24477. </para>
  24478. </remarks>
  24479. </member>
  24480. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
  24481. <summary>
  24482. Removes all attached appenders.
  24483. </summary>
  24484. <remarks>
  24485. <para>
  24486. Removes and closes all attached appenders
  24487. </para>
  24488. </remarks>
  24489. </member>
  24490. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
  24491. <summary>
  24492. Removes the specified appender from the list of attached appenders.
  24493. </summary>
  24494. <param name="appender">The appender to remove.</param>
  24495. <returns>The appender removed from the list</returns>
  24496. <remarks>
  24497. <para>
  24498. The appender removed is not closed.
  24499. If you are discarding the appender you must call
  24500. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24501. </para>
  24502. </remarks>
  24503. </member>
  24504. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
  24505. <summary>
  24506. Removes the appender with the specified name from the list of appenders.
  24507. </summary>
  24508. <param name="name">The name of the appender to remove.</param>
  24509. <returns>The appender removed from the list</returns>
  24510. <remarks>
  24511. <para>
  24512. The appender removed is not closed.
  24513. If you are discarding the appender you must call
  24514. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  24515. </para>
  24516. </remarks>
  24517. </member>
  24518. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
  24519. <summary>
  24520. List of appenders
  24521. </summary>
  24522. </member>
  24523. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
  24524. <summary>
  24525. Array of appenders, used to cache the m_appenderList
  24526. </summary>
  24527. </member>
  24528. <member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
  24529. <summary>
  24530. The fully qualified type of the AppenderAttachedImpl class.
  24531. </summary>
  24532. <remarks>
  24533. Used by the internal logger to record the Type of the
  24534. log message.
  24535. </remarks>
  24536. </member>
  24537. <member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
  24538. <summary>
  24539. Gets all attached appenders.
  24540. </summary>
  24541. <returns>
  24542. A collection of attached appenders, or <c>null</c> if there
  24543. are no attached appenders.
  24544. </returns>
  24545. <remarks>
  24546. <para>
  24547. The read only collection of all currently attached appenders.
  24548. </para>
  24549. </remarks>
  24550. </member>
  24551. <member name="T:log4net.Util.CompositeProperties">
  24552. <summary>
  24553. This class aggregates several PropertiesDictionary collections together.
  24554. </summary>
  24555. <remarks>
  24556. <para>
  24557. Provides a dictionary style lookup over an ordered list of
  24558. <see cref="T:log4net.Util.PropertiesDictionary"/> collections.
  24559. </para>
  24560. </remarks>
  24561. <author>Nicko Cadell</author>
  24562. </member>
  24563. <member name="M:log4net.Util.CompositeProperties.#ctor">
  24564. <summary>
  24565. Constructor
  24566. </summary>
  24567. <remarks>
  24568. <para>
  24569. Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties"/> class.
  24570. </para>
  24571. </remarks>
  24572. </member>
  24573. <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
  24574. <summary>
  24575. Add a Properties Dictionary to this composite collection
  24576. </summary>
  24577. <param name="properties">the properties to add</param>
  24578. <remarks>
  24579. <para>
  24580. Properties dictionaries added first take precedence over dictionaries added
  24581. later.
  24582. </para>
  24583. </remarks>
  24584. </member>
  24585. <member name="M:log4net.Util.CompositeProperties.Flatten">
  24586. <summary>
  24587. Flatten this composite collection into a single properties dictionary
  24588. </summary>
  24589. <returns>the flattened dictionary</returns>
  24590. <remarks>
  24591. <para>
  24592. Reduces the collection of ordered dictionaries to a single dictionary
  24593. containing the resultant values for the keys.
  24594. </para>
  24595. </remarks>
  24596. </member>
  24597. <member name="P:log4net.Util.CompositeProperties.Item(System.String)">
  24598. <summary>
  24599. Gets the value of a property
  24600. </summary>
  24601. <value>
  24602. The value for the property with the specified key
  24603. </value>
  24604. <remarks>
  24605. <para>
  24606. Looks up the value for the <paramref name="key"/> specified.
  24607. The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
  24608. in the order in which they were added to this collection. The value
  24609. returned is the value held by the first collection that contains
  24610. the specified key.
  24611. </para>
  24612. <para>
  24613. If none of the collections contain the specified key then
  24614. <c>null</c> is returned.
  24615. </para>
  24616. </remarks>
  24617. </member>
  24618. <member name="T:log4net.Util.ContextPropertiesBase">
  24619. <summary>
  24620. Base class for Context Properties implementations
  24621. </summary>
  24622. <remarks>
  24623. <para>
  24624. This class defines a basic property get set accessor
  24625. </para>
  24626. </remarks>
  24627. <author>Nicko Cadell</author>
  24628. </member>
  24629. <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
  24630. <summary>
  24631. Gets or sets the value of a property
  24632. </summary>
  24633. <value>
  24634. The value for the property with the specified key
  24635. </value>
  24636. <remarks>
  24637. <para>
  24638. Gets or sets the value of a property
  24639. </para>
  24640. </remarks>
  24641. </member>
  24642. <member name="T:log4net.Util.ConverterInfo">
  24643. <summary>
  24644. Wrapper class used to map converter names to converter types
  24645. </summary>
  24646. <remarks>
  24647. <para>
  24648. Pattern converter info class used during configuration by custom
  24649. PatternString and PatternLayer converters.
  24650. </para>
  24651. </remarks>
  24652. </member>
  24653. <member name="M:log4net.Util.ConverterInfo.#ctor">
  24654. <summary>
  24655. default constructor
  24656. </summary>
  24657. </member>
  24658. <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
  24659. <summary>
  24660. </summary>
  24661. <param name="entry"></param>
  24662. </member>
  24663. <member name="P:log4net.Util.ConverterInfo.Name">
  24664. <summary>
  24665. Gets or sets the name of the conversion pattern
  24666. </summary>
  24667. <remarks>
  24668. <para>
  24669. The name of the pattern in the format string
  24670. </para>
  24671. </remarks>
  24672. </member>
  24673. <member name="P:log4net.Util.ConverterInfo.Type">
  24674. <summary>
  24675. Gets or sets the type of the converter
  24676. </summary>
  24677. <remarks>
  24678. <para>
  24679. The value specified must extend the
  24680. <see cref="T:log4net.Util.PatternConverter"/> type.
  24681. </para>
  24682. </remarks>
  24683. </member>
  24684. <member name="P:log4net.Util.ConverterInfo.Properties">
  24685. <summary>
  24686. </summary>
  24687. </member>
  24688. <member name="T:log4net.Util.CountingQuietTextWriter">
  24689. <summary>
  24690. Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
  24691. the number of bytes written.
  24692. </summary>
  24693. <remarks>
  24694. <para>
  24695. This writer counts the number of bytes written.
  24696. </para>
  24697. </remarks>
  24698. <author>Nicko Cadell</author>
  24699. <author>Gert Driesen</author>
  24700. </member>
  24701. <member name="T:log4net.Util.QuietTextWriter">
  24702. <summary>
  24703. <see cref="T:System.IO.TextWriter"/> that does not leak exceptions
  24704. </summary>
  24705. <remarks>
  24706. <para>
  24707. <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
  24708. Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
  24709. </para>
  24710. </remarks>
  24711. <author>Nicko Cadell</author>
  24712. <author>Gert Driesen</author>
  24713. </member>
  24714. <member name="T:log4net.Util.TextWriterAdapter">
  24715. <summary>
  24716. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  24717. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  24718. </summary>
  24719. <remarks>
  24720. <para>
  24721. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  24722. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  24723. </para>
  24724. </remarks>
  24725. <author>Nicko Cadell</author>
  24726. </member>
  24727. <member name="F:log4net.Util.TextWriterAdapter.m_writer">
  24728. <summary>
  24729. The writer to forward messages to
  24730. </summary>
  24731. </member>
  24732. <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
  24733. <summary>
  24734. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  24735. messages to a <see cref="T:System.IO.TextWriter"/>.
  24736. </summary>
  24737. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
  24738. <remarks>
  24739. <para>
  24740. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  24741. messages to a <see cref="T:System.IO.TextWriter"/>.
  24742. </para>
  24743. </remarks>
  24744. </member>
  24745. <member name="M:log4net.Util.TextWriterAdapter.Close">
  24746. <summary>
  24747. Closes the writer and releases any system resources associated with the writer
  24748. </summary>
  24749. <remarks>
  24750. <para>
  24751. </para>
  24752. </remarks>
  24753. </member>
  24754. <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
  24755. <summary>
  24756. Dispose this writer
  24757. </summary>
  24758. <param name="disposing">flag indicating if we are being disposed</param>
  24759. <remarks>
  24760. <para>
  24761. Dispose this writer
  24762. </para>
  24763. </remarks>
  24764. </member>
  24765. <member name="M:log4net.Util.TextWriterAdapter.Flush">
  24766. <summary>
  24767. Flushes any buffered output
  24768. </summary>
  24769. <remarks>
  24770. <para>
  24771. Clears all buffers for the writer and causes any buffered data to be written
  24772. to the underlying device
  24773. </para>
  24774. </remarks>
  24775. </member>
  24776. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
  24777. <summary>
  24778. Writes a character to the wrapped TextWriter
  24779. </summary>
  24780. <param name="value">the value to write to the TextWriter</param>
  24781. <remarks>
  24782. <para>
  24783. Writes a character to the wrapped TextWriter
  24784. </para>
  24785. </remarks>
  24786. </member>
  24787. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
  24788. <summary>
  24789. Writes a character buffer to the wrapped TextWriter
  24790. </summary>
  24791. <param name="buffer">the data buffer</param>
  24792. <param name="index">the start index</param>
  24793. <param name="count">the number of characters to write</param>
  24794. <remarks>
  24795. <para>
  24796. Writes a character buffer to the wrapped TextWriter
  24797. </para>
  24798. </remarks>
  24799. </member>
  24800. <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
  24801. <summary>
  24802. Writes a string to the wrapped TextWriter
  24803. </summary>
  24804. <param name="value">the value to write to the TextWriter</param>
  24805. <remarks>
  24806. <para>
  24807. Writes a string to the wrapped TextWriter
  24808. </para>
  24809. </remarks>
  24810. </member>
  24811. <member name="P:log4net.Util.TextWriterAdapter.Writer">
  24812. <summary>
  24813. Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
  24814. </summary>
  24815. <value>
  24816. The underlying <see cref="T:System.IO.TextWriter"/>.
  24817. </value>
  24818. <remarks>
  24819. <para>
  24820. Gets or sets the underlying <see cref="T:System.IO.TextWriter"/>.
  24821. </para>
  24822. </remarks>
  24823. </member>
  24824. <member name="P:log4net.Util.TextWriterAdapter.Encoding">
  24825. <summary>
  24826. The Encoding in which the output is written
  24827. </summary>
  24828. <value>
  24829. The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
  24830. </value>
  24831. <remarks>
  24832. <para>
  24833. The Encoding in which the output is written
  24834. </para>
  24835. </remarks>
  24836. </member>
  24837. <member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
  24838. <summary>
  24839. Gets an object that controls formatting
  24840. </summary>
  24841. <value>
  24842. The format provider
  24843. </value>
  24844. <remarks>
  24845. <para>
  24846. Gets an object that controls formatting
  24847. </para>
  24848. </remarks>
  24849. </member>
  24850. <member name="P:log4net.Util.TextWriterAdapter.NewLine">
  24851. <summary>
  24852. Gets or sets the line terminator string used by the TextWriter
  24853. </summary>
  24854. <value>
  24855. The line terminator to use
  24856. </value>
  24857. <remarks>
  24858. <para>
  24859. Gets or sets the line terminator string used by the TextWriter
  24860. </para>
  24861. </remarks>
  24862. </member>
  24863. <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  24864. <summary>
  24865. Constructor
  24866. </summary>
  24867. <param name="writer">the writer to actually write to</param>
  24868. <param name="errorHandler">the error handler to report error to</param>
  24869. <remarks>
  24870. <para>
  24871. Create a new QuietTextWriter using a writer and error handler
  24872. </para>
  24873. </remarks>
  24874. </member>
  24875. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
  24876. <summary>
  24877. Writes a character to the underlying writer
  24878. </summary>
  24879. <param name="value">the char to write</param>
  24880. <remarks>
  24881. <para>
  24882. Writes a character to the underlying writer
  24883. </para>
  24884. </remarks>
  24885. </member>
  24886. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  24887. <summary>
  24888. Writes a buffer to the underlying writer
  24889. </summary>
  24890. <param name="buffer">the buffer to write</param>
  24891. <param name="index">the start index to write from</param>
  24892. <param name="count">the number of characters to write</param>
  24893. <remarks>
  24894. <para>
  24895. Writes a buffer to the underlying writer
  24896. </para>
  24897. </remarks>
  24898. </member>
  24899. <member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
  24900. <summary>
  24901. Writes a string to the output.
  24902. </summary>
  24903. <param name="value">The string data to write to the output.</param>
  24904. <remarks>
  24905. <para>
  24906. Writes a string to the output.
  24907. </para>
  24908. </remarks>
  24909. </member>
  24910. <member name="M:log4net.Util.QuietTextWriter.Close">
  24911. <summary>
  24912. Closes the underlying output writer.
  24913. </summary>
  24914. <remarks>
  24915. <para>
  24916. Closes the underlying output writer.
  24917. </para>
  24918. </remarks>
  24919. </member>
  24920. <member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
  24921. <summary>
  24922. The error handler instance to pass all errors to
  24923. </summary>
  24924. </member>
  24925. <member name="F:log4net.Util.QuietTextWriter.m_closed">
  24926. <summary>
  24927. Flag to indicate if this writer is closed
  24928. </summary>
  24929. </member>
  24930. <member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
  24931. <summary>
  24932. Gets or sets the error handler that all errors are passed to.
  24933. </summary>
  24934. <value>
  24935. The error handler that all errors are passed to.
  24936. </value>
  24937. <remarks>
  24938. <para>
  24939. Gets or sets the error handler that all errors are passed to.
  24940. </para>
  24941. </remarks>
  24942. </member>
  24943. <member name="P:log4net.Util.QuietTextWriter.Closed">
  24944. <summary>
  24945. Gets a value indicating whether this writer is closed.
  24946. </summary>
  24947. <value>
  24948. <c>true</c> if this writer is closed, otherwise <c>false</c>.
  24949. </value>
  24950. <remarks>
  24951. <para>
  24952. Gets a value indicating whether this writer is closed.
  24953. </para>
  24954. </remarks>
  24955. </member>
  24956. <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  24957. <summary>
  24958. Constructor
  24959. </summary>
  24960. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to actually write to.</param>
  24961. <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler"/> to report errors to.</param>
  24962. <remarks>
  24963. <para>
  24964. Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter"/> class
  24965. with the specified <see cref="T:System.IO.TextWriter"/> and <see cref="T:log4net.Core.IErrorHandler"/>.
  24966. </para>
  24967. </remarks>
  24968. </member>
  24969. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
  24970. <summary>
  24971. Writes a character to the underlying writer and counts the number of bytes written.
  24972. </summary>
  24973. <param name="value">the char to write</param>
  24974. <remarks>
  24975. <para>
  24976. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  24977. the number of bytes written.
  24978. </para>
  24979. </remarks>
  24980. </member>
  24981. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  24982. <summary>
  24983. Writes a buffer to the underlying writer and counts the number of bytes written.
  24984. </summary>
  24985. <param name="buffer">the buffer to write</param>
  24986. <param name="index">the start index to write from</param>
  24987. <param name="count">the number of characters to write</param>
  24988. <remarks>
  24989. <para>
  24990. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  24991. the number of bytes written.
  24992. </para>
  24993. </remarks>
  24994. </member>
  24995. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
  24996. <summary>
  24997. Writes a string to the output and counts the number of bytes written.
  24998. </summary>
  24999. <param name="str">The string data to write to the output.</param>
  25000. <remarks>
  25001. <para>
  25002. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  25003. the number of bytes written.
  25004. </para>
  25005. </remarks>
  25006. </member>
  25007. <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
  25008. <summary>
  25009. Total number of bytes written.
  25010. </summary>
  25011. </member>
  25012. <member name="P:log4net.Util.CountingQuietTextWriter.Count">
  25013. <summary>
  25014. Gets or sets the total number of bytes written.
  25015. </summary>
  25016. <value>
  25017. The total number of bytes written.
  25018. </value>
  25019. <remarks>
  25020. <para>
  25021. Gets or sets the total number of bytes written.
  25022. </para>
  25023. </remarks>
  25024. </member>
  25025. <member name="T:log4net.Util.CyclicBuffer">
  25026. <summary>
  25027. A fixed size rolling buffer of logging events.
  25028. </summary>
  25029. <remarks>
  25030. <para>
  25031. An array backed fixed size leaky bucket.
  25032. </para>
  25033. </remarks>
  25034. <author>Nicko Cadell</author>
  25035. <author>Gert Driesen</author>
  25036. </member>
  25037. <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
  25038. <summary>
  25039. Constructor
  25040. </summary>
  25041. <param name="maxSize">The maximum number of logging events in the buffer.</param>
  25042. <remarks>
  25043. <para>
  25044. Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer"/> class with
  25045. the specified maximum number of buffered logging events.
  25046. </para>
  25047. </remarks>
  25048. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
  25049. </member>
  25050. <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
  25051. <summary>
  25052. Appends a <paramref name="loggingEvent"/> to the buffer.
  25053. </summary>
  25054. <param name="loggingEvent">The event to append to the buffer.</param>
  25055. <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
  25056. <remarks>
  25057. <para>
  25058. Append an event to the buffer. If the buffer still contains free space then
  25059. <c>null</c> is returned. If the buffer is full then an event will be dropped
  25060. to make space for the new event, the event dropped is returned.
  25061. </para>
  25062. </remarks>
  25063. </member>
  25064. <member name="M:log4net.Util.CyclicBuffer.PopOldest">
  25065. <summary>
  25066. Get and remove the oldest event in the buffer.
  25067. </summary>
  25068. <returns>The oldest logging event in the buffer</returns>
  25069. <remarks>
  25070. <para>
  25071. Gets the oldest (first) logging event in the buffer and removes it
  25072. from the buffer.
  25073. </para>
  25074. </remarks>
  25075. </member>
  25076. <member name="M:log4net.Util.CyclicBuffer.PopAll">
  25077. <summary>
  25078. Pops all the logging events from the buffer into an array.
  25079. </summary>
  25080. <returns>An array of all the logging events in the buffer.</returns>
  25081. <remarks>
  25082. <para>
  25083. Get all the events in the buffer and clear the buffer.
  25084. </para>
  25085. </remarks>
  25086. </member>
  25087. <member name="M:log4net.Util.CyclicBuffer.Clear">
  25088. <summary>
  25089. Clear the buffer
  25090. </summary>
  25091. <remarks>
  25092. <para>
  25093. Clear the buffer of all events. The events in the buffer are lost.
  25094. </para>
  25095. </remarks>
  25096. </member>
  25097. <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
  25098. <summary>
  25099. Gets the <paramref name="i"/>th oldest event currently in the buffer.
  25100. </summary>
  25101. <value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
  25102. <remarks>
  25103. <para>
  25104. If <paramref name="i"/> is outside the range 0 to the number of events
  25105. currently in the buffer, then <c>null</c> is returned.
  25106. </para>
  25107. </remarks>
  25108. </member>
  25109. <member name="P:log4net.Util.CyclicBuffer.MaxSize">
  25110. <summary>
  25111. Gets the maximum size of the buffer.
  25112. </summary>
  25113. <value>The maximum size of the buffer.</value>
  25114. <remarks>
  25115. <para>
  25116. Gets the maximum size of the buffer
  25117. </para>
  25118. </remarks>
  25119. </member>
  25120. <member name="P:log4net.Util.CyclicBuffer.Length">
  25121. <summary>
  25122. Gets the number of logging events in the buffer.
  25123. </summary>
  25124. <value>The number of logging events in the buffer.</value>
  25125. <remarks>
  25126. <para>
  25127. This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
  25128. (inclusive).
  25129. </para>
  25130. </remarks>
  25131. </member>
  25132. <member name="T:log4net.Util.EmptyCollection">
  25133. <summary>
  25134. An always empty <see cref="T:System.Collections.ICollection"/>.
  25135. </summary>
  25136. <remarks>
  25137. <para>
  25138. A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
  25139. interface that always represents an empty collection.
  25140. </para>
  25141. </remarks>
  25142. <author>Nicko Cadell</author>
  25143. <author>Gert Driesen</author>
  25144. </member>
  25145. <member name="M:log4net.Util.EmptyCollection.#ctor">
  25146. <summary>
  25147. Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection"/> class.
  25148. </summary>
  25149. <remarks>
  25150. <para>
  25151. Uses a private access modifier to enforce the singleton pattern.
  25152. </para>
  25153. </remarks>
  25154. </member>
  25155. <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
  25156. <summary>
  25157. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  25158. <see cref="T:System.Array"/>, starting at a particular Array index.
  25159. </summary>
  25160. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  25161. that is the destination of the elements copied from
  25162. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  25163. indexing.</param>
  25164. <param name="index">The zero-based index in array at which
  25165. copying begins.</param>
  25166. <remarks>
  25167. <para>
  25168. As the collection is empty no values are copied into the array.
  25169. </para>
  25170. </remarks>
  25171. </member>
  25172. <member name="M:log4net.Util.EmptyCollection.GetEnumerator">
  25173. <summary>
  25174. Returns an enumerator that can iterate through a collection.
  25175. </summary>
  25176. <returns>
  25177. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25178. iterate through the collection.
  25179. </returns>
  25180. <remarks>
  25181. <para>
  25182. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25183. </para>
  25184. </remarks>
  25185. </member>
  25186. <member name="F:log4net.Util.EmptyCollection.s_instance">
  25187. <summary>
  25188. The singleton instance of the empty collection.
  25189. </summary>
  25190. </member>
  25191. <member name="P:log4net.Util.EmptyCollection.Instance">
  25192. <summary>
  25193. Gets the singleton instance of the empty collection.
  25194. </summary>
  25195. <returns>The singleton instance of the empty collection.</returns>
  25196. <remarks>
  25197. <para>
  25198. Gets the singleton instance of the empty collection.
  25199. </para>
  25200. </remarks>
  25201. </member>
  25202. <member name="P:log4net.Util.EmptyCollection.IsSynchronized">
  25203. <summary>
  25204. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  25205. </summary>
  25206. <value>
  25207. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  25208. </value>
  25209. <remarks>
  25210. <para>
  25211. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
  25212. </para>
  25213. </remarks>
  25214. </member>
  25215. <member name="P:log4net.Util.EmptyCollection.Count">
  25216. <summary>
  25217. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25218. </summary>
  25219. <value>
  25220. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25221. </value>
  25222. <remarks>
  25223. <para>
  25224. As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
  25225. </para>
  25226. </remarks>
  25227. </member>
  25228. <member name="P:log4net.Util.EmptyCollection.SyncRoot">
  25229. <summary>
  25230. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25231. </summary>
  25232. <value>
  25233. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25234. </value>
  25235. <remarks>
  25236. <para>
  25237. As the collection is empty and thread safe and synchronized this instance is also
  25238. the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
  25239. </para>
  25240. </remarks>
  25241. </member>
  25242. <member name="T:log4net.Util.EmptyDictionary">
  25243. <summary>
  25244. An always empty <see cref="T:System.Collections.IDictionary"/>.
  25245. </summary>
  25246. <remarks>
  25247. <para>
  25248. A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
  25249. interface that always represents an empty collection.
  25250. </para>
  25251. </remarks>
  25252. <author>Nicko Cadell</author>
  25253. <author>Gert Driesen</author>
  25254. </member>
  25255. <member name="M:log4net.Util.EmptyDictionary.#ctor">
  25256. <summary>
  25257. Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary"/> class.
  25258. </summary>
  25259. <remarks>
  25260. <para>
  25261. Uses a private access modifier to enforce the singleton pattern.
  25262. </para>
  25263. </remarks>
  25264. </member>
  25265. <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
  25266. <summary>
  25267. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  25268. <see cref="T:System.Array"/>, starting at a particular Array index.
  25269. </summary>
  25270. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  25271. that is the destination of the elements copied from
  25272. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  25273. indexing.</param>
  25274. <param name="index">The zero-based index in array at which
  25275. copying begins.</param>
  25276. <remarks>
  25277. <para>
  25278. As the collection is empty no values are copied into the array.
  25279. </para>
  25280. </remarks>
  25281. </member>
  25282. <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
  25283. <summary>
  25284. Returns an enumerator that can iterate through a collection.
  25285. </summary>
  25286. <returns>
  25287. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25288. iterate through the collection.
  25289. </returns>
  25290. <remarks>
  25291. <para>
  25292. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25293. </para>
  25294. </remarks>
  25295. </member>
  25296. <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
  25297. <summary>
  25298. Adds an element with the provided key and value to the
  25299. <see cref="T:log4net.Util.EmptyDictionary"/>.
  25300. </summary>
  25301. <param name="key">The <see cref="T:System.Object"/> to use as the key of the element to add.</param>
  25302. <param name="value">The <see cref="T:System.Object"/> to use as the value of the element to add.</param>
  25303. <remarks>
  25304. <para>
  25305. As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
  25306. is thrown if this method is called.
  25307. </para>
  25308. </remarks>
  25309. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25310. </member>
  25311. <member name="M:log4net.Util.EmptyDictionary.Clear">
  25312. <summary>
  25313. Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25314. </summary>
  25315. <remarks>
  25316. <para>
  25317. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25318. is thrown if this method is called.
  25319. </para>
  25320. </remarks>
  25321. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25322. </member>
  25323. <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
  25324. <summary>
  25325. Determines whether the <see cref="T:log4net.Util.EmptyDictionary"/> contains an element
  25326. with the specified key.
  25327. </summary>
  25328. <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary"/>.</param>
  25329. <returns><c>false</c></returns>
  25330. <remarks>
  25331. <para>
  25332. As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
  25333. </para>
  25334. </remarks>
  25335. </member>
  25336. <member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
  25337. <summary>
  25338. Returns an enumerator that can iterate through a collection.
  25339. </summary>
  25340. <returns>
  25341. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  25342. iterate through the collection.
  25343. </returns>
  25344. <remarks>
  25345. <para>
  25346. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  25347. </para>
  25348. </remarks>
  25349. </member>
  25350. <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
  25351. <summary>
  25352. Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25353. </summary>
  25354. <param name="key">The key of the element to remove.</param>
  25355. <remarks>
  25356. <para>
  25357. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  25358. is thrown if this method is called.
  25359. </para>
  25360. </remarks>
  25361. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25362. </member>
  25363. <member name="F:log4net.Util.EmptyDictionary.s_instance">
  25364. <summary>
  25365. The singleton instance of the empty dictionary.
  25366. </summary>
  25367. </member>
  25368. <member name="P:log4net.Util.EmptyDictionary.Instance">
  25369. <summary>
  25370. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25371. </summary>
  25372. <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.</returns>
  25373. <remarks>
  25374. <para>
  25375. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25376. </para>
  25377. </remarks>
  25378. </member>
  25379. <member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
  25380. <summary>
  25381. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  25382. </summary>
  25383. <value>
  25384. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  25385. </value>
  25386. <remarks>
  25387. <para>
  25388. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
  25389. </para>
  25390. </remarks>
  25391. </member>
  25392. <member name="P:log4net.Util.EmptyDictionary.Count">
  25393. <summary>
  25394. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
  25395. </summary>
  25396. <value>
  25397. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  25398. </value>
  25399. <remarks>
  25400. <para>
  25401. As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
  25402. </para>
  25403. </remarks>
  25404. </member>
  25405. <member name="P:log4net.Util.EmptyDictionary.SyncRoot">
  25406. <summary>
  25407. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25408. </summary>
  25409. <value>
  25410. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  25411. </value>
  25412. <remarks>
  25413. <para>
  25414. As the collection is empty and thread safe and synchronized this instance is also
  25415. the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
  25416. </para>
  25417. </remarks>
  25418. </member>
  25419. <member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
  25420. <summary>
  25421. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> has a fixed size.
  25422. </summary>
  25423. <value><c>true</c></value>
  25424. <remarks>
  25425. <para>
  25426. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
  25427. </para>
  25428. </remarks>
  25429. </member>
  25430. <member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
  25431. <summary>
  25432. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary"/> is read-only.
  25433. </summary>
  25434. <value><c>true</c></value>
  25435. <remarks>
  25436. <para>
  25437. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
  25438. </para>
  25439. </remarks>
  25440. </member>
  25441. <member name="P:log4net.Util.EmptyDictionary.Keys">
  25442. <summary>
  25443. Gets an <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25444. </summary>
  25445. <value>An <see cref="T:System.Collections.ICollection"/> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
  25446. <remarks>
  25447. <para>
  25448. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25449. </para>
  25450. </remarks>
  25451. </member>
  25452. <member name="P:log4net.Util.EmptyDictionary.Values">
  25453. <summary>
  25454. Gets an <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.
  25455. </summary>
  25456. <value>An <see cref="T:System.Collections.ICollection"/> containing the values of the <see cref="T:log4net.Util.EmptyDictionary"/>.</value>
  25457. <remarks>
  25458. <para>
  25459. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  25460. </para>
  25461. </remarks>
  25462. </member>
  25463. <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
  25464. <summary>
  25465. Gets or sets the element with the specified key.
  25466. </summary>
  25467. <param name="key">The key of the element to get or set.</param>
  25468. <value><c>null</c></value>
  25469. <remarks>
  25470. <para>
  25471. As the collection is empty no values can be looked up or stored.
  25472. If the index getter is called then <c>null</c> is returned.
  25473. A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
  25474. </para>
  25475. </remarks>
  25476. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  25477. </member>
  25478. <member name="T:log4net.Util.FormattingInfo">
  25479. <summary>
  25480. Contain the information obtained when parsing formatting modifiers
  25481. in conversion modifiers.
  25482. </summary>
  25483. <remarks>
  25484. <para>
  25485. Holds the formatting information extracted from the format string by
  25486. the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
  25487. objects when rendering the output.
  25488. </para>
  25489. </remarks>
  25490. <author>Nicko Cadell</author>
  25491. <author>Gert Driesen</author>
  25492. </member>
  25493. <member name="M:log4net.Util.FormattingInfo.#ctor">
  25494. <summary>
  25495. Defaut Constructor
  25496. </summary>
  25497. <remarks>
  25498. <para>
  25499. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class.
  25500. </para>
  25501. </remarks>
  25502. </member>
  25503. <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
  25504. <summary>
  25505. Constructor
  25506. </summary>
  25507. <remarks>
  25508. <para>
  25509. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo"/> class
  25510. with the specified parameters.
  25511. </para>
  25512. </remarks>
  25513. </member>
  25514. <member name="P:log4net.Util.FormattingInfo.Min">
  25515. <summary>
  25516. Gets or sets the minimum value.
  25517. </summary>
  25518. <value>
  25519. The minimum value.
  25520. </value>
  25521. <remarks>
  25522. <para>
  25523. Gets or sets the minimum value.
  25524. </para>
  25525. </remarks>
  25526. </member>
  25527. <member name="P:log4net.Util.FormattingInfo.Max">
  25528. <summary>
  25529. Gets or sets the maximum value.
  25530. </summary>
  25531. <value>
  25532. The maximum value.
  25533. </value>
  25534. <remarks>
  25535. <para>
  25536. Gets or sets the maximum value.
  25537. </para>
  25538. </remarks>
  25539. </member>
  25540. <member name="P:log4net.Util.FormattingInfo.LeftAlign">
  25541. <summary>
  25542. Gets or sets a flag indicating whether left align is enabled
  25543. or not.
  25544. </summary>
  25545. <value>
  25546. A flag indicating whether left align is enabled or not.
  25547. </value>
  25548. <remarks>
  25549. <para>
  25550. Gets or sets a flag indicating whether left align is enabled or not.
  25551. </para>
  25552. </remarks>
  25553. </member>
  25554. <member name="T:log4net.Util.GlobalContextProperties">
  25555. <summary>
  25556. Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
  25557. </summary>
  25558. <remarks>
  25559. <para>
  25560. This class implements a properties collection that is thread safe and supports both
  25561. storing properties and capturing a read only copy of the current propertied.
  25562. </para>
  25563. <para>
  25564. This class is optimized to the scenario where the properties are read frequently
  25565. and are modified infrequently.
  25566. </para>
  25567. </remarks>
  25568. <author>Nicko Cadell</author>
  25569. </member>
  25570. <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
  25571. <summary>
  25572. The read only copy of the properties.
  25573. </summary>
  25574. <remarks>
  25575. <para>
  25576. This variable is declared <c>volatile</c> to prevent the compiler and JIT from
  25577. reordering reads and writes of this thread performed on different threads.
  25578. </para>
  25579. </remarks>
  25580. </member>
  25581. <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
  25582. <summary>
  25583. Lock object used to synchronize updates within this instance
  25584. </summary>
  25585. </member>
  25586. <member name="M:log4net.Util.GlobalContextProperties.#ctor">
  25587. <summary>
  25588. Constructor
  25589. </summary>
  25590. <remarks>
  25591. <para>
  25592. Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties"/> class.
  25593. </para>
  25594. </remarks>
  25595. </member>
  25596. <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
  25597. <summary>
  25598. Remove a property from the global context
  25599. </summary>
  25600. <param name="key">the key for the entry to remove</param>
  25601. <remarks>
  25602. <para>
  25603. Removing an entry from the global context properties is relatively expensive compared
  25604. with reading a value.
  25605. </para>
  25606. </remarks>
  25607. </member>
  25608. <member name="M:log4net.Util.GlobalContextProperties.Clear">
  25609. <summary>
  25610. Clear the global context properties
  25611. </summary>
  25612. </member>
  25613. <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
  25614. <summary>
  25615. Get a readonly immutable copy of the properties
  25616. </summary>
  25617. <returns>the current global context properties</returns>
  25618. <remarks>
  25619. <para>
  25620. This implementation is fast because the GlobalContextProperties class
  25621. stores a readonly copy of the properties.
  25622. </para>
  25623. </remarks>
  25624. </member>
  25625. <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
  25626. <summary>
  25627. Gets or sets the value of a property
  25628. </summary>
  25629. <value>
  25630. The value for the property with the specified key
  25631. </value>
  25632. <remarks>
  25633. <para>
  25634. Reading the value for a key is faster than setting the value.
  25635. When the value is written a new read only copy of
  25636. the properties is created.
  25637. </para>
  25638. </remarks>
  25639. </member>
  25640. <member name="T:log4net.Util.LevelMapping">
  25641. <summary>
  25642. Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
  25643. </summary>
  25644. <remarks>
  25645. <para>
  25646. Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
  25647. to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
  25648. </para>
  25649. </remarks>
  25650. <author>Nicko Cadell</author>
  25651. </member>
  25652. <member name="M:log4net.Util.LevelMapping.#ctor">
  25653. <summary>
  25654. Default constructor
  25655. </summary>
  25656. <remarks>
  25657. <para>
  25658. Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
  25659. </para>
  25660. </remarks>
  25661. </member>
  25662. <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
  25663. <summary>
  25664. Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
  25665. </summary>
  25666. <param name="entry">the entry to add</param>
  25667. <remarks>
  25668. <para>
  25669. If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
  25670. for the same <see cref="T:log4net.Core.Level"/> then that entry will be
  25671. overwritten.
  25672. </para>
  25673. </remarks>
  25674. </member>
  25675. <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
  25676. <summary>
  25677. Lookup the mapping for the specified level
  25678. </summary>
  25679. <param name="level">the level to lookup</param>
  25680. <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
  25681. <remarks>
  25682. <para>
  25683. Lookup the value for the specified level. Finds the nearest
  25684. mapping value for the level that is equal to or less than the
  25685. <paramref name="level"/> specified.
  25686. </para>
  25687. <para>
  25688. If no mapping could be found then <c>null</c> is returned.
  25689. </para>
  25690. </remarks>
  25691. </member>
  25692. <member name="M:log4net.Util.LevelMapping.ActivateOptions">
  25693. <summary>
  25694. Initialize options
  25695. </summary>
  25696. <remarks>
  25697. <para>
  25698. Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
  25699. </para>
  25700. </remarks>
  25701. </member>
  25702. <member name="T:log4net.Util.LogicalThreadContextProperties">
  25703. <summary>
  25704. Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
  25705. </summary>
  25706. <remarks>
  25707. <para>
  25708. Class implements a collection of properties that is specific to each thread.
  25709. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  25710. </para>
  25711. <para>
  25712. This class stores its properties in a slot on the <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> named
  25713. <c>log4net.Util.LogicalThreadContextProperties</c>.
  25714. </para>
  25715. <para>
  25716. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  25717. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  25718. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  25719. If the calling code does not have this permission then this context will be disabled.
  25720. It will not store any property values set on it.
  25721. </para>
  25722. </remarks>
  25723. <author>Nicko Cadell</author>
  25724. </member>
  25725. <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
  25726. <summary>
  25727. Flag used to disable this context if we don't have permission to access the CallContext.
  25728. </summary>
  25729. </member>
  25730. <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
  25731. <summary>
  25732. Constructor
  25733. </summary>
  25734. <remarks>
  25735. <para>
  25736. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties"/> class.
  25737. </para>
  25738. </remarks>
  25739. </member>
  25740. <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
  25741. <summary>
  25742. Remove a property
  25743. </summary>
  25744. <param name="key">the key for the entry to remove</param>
  25745. <remarks>
  25746. <para>
  25747. Remove the value for the specified <paramref name="key"/> from the context.
  25748. </para>
  25749. </remarks>
  25750. </member>
  25751. <member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
  25752. <summary>
  25753. Clear all the context properties
  25754. </summary>
  25755. <remarks>
  25756. <para>
  25757. Clear all the context properties
  25758. </para>
  25759. </remarks>
  25760. </member>
  25761. <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
  25762. <summary>
  25763. Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
  25764. </summary>
  25765. <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
  25766. <returns>the properties for this thread</returns>
  25767. <remarks>
  25768. <para>
  25769. The collection returned is only to be used on the calling thread. If the
  25770. caller needs to share the collection between different threads then the
  25771. caller must clone the collection before doings so.
  25772. </para>
  25773. </remarks>
  25774. </member>
  25775. <member name="M:log4net.Util.LogicalThreadContextProperties.GetCallContextData">
  25776. <summary>
  25777. Gets the call context get data.
  25778. </summary>
  25779. <returns>The peroperties dictionary stored in the call context</returns>
  25780. <remarks>
  25781. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.GetData(System.String)"/> has a
  25782. security link demand, therfore we must put the method call in a seperate method
  25783. that we can wrap in an exception handler.
  25784. </remarks>
  25785. </member>
  25786. <member name="M:log4net.Util.LogicalThreadContextProperties.SetCallContextData(log4net.Util.PropertiesDictionary)">
  25787. <summary>
  25788. Sets the call context data.
  25789. </summary>
  25790. <param name="properties">The properties.</param>
  25791. <remarks>
  25792. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> method <see cref="M:System.Runtime.Remoting.Messaging.CallContext.SetData(System.String,System.Object)"/> has a
  25793. security link demand, therfore we must put the method call in a seperate method
  25794. that we can wrap in an exception handler.
  25795. </remarks>
  25796. </member>
  25797. <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
  25798. <summary>
  25799. The fully qualified type of the LogicalThreadContextProperties class.
  25800. </summary>
  25801. <remarks>
  25802. Used by the internal logger to record the Type of the
  25803. log message.
  25804. </remarks>
  25805. </member>
  25806. <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
  25807. <summary>
  25808. Gets or sets the value of a property
  25809. </summary>
  25810. <value>
  25811. The value for the property with the specified key
  25812. </value>
  25813. <remarks>
  25814. <para>
  25815. Get or set the property value for the <paramref name="key"/> specified.
  25816. </para>
  25817. </remarks>
  25818. </member>
  25819. <member name="T:log4net.Util.LogReceivedEventHandler">
  25820. <summary>
  25821. </summary>
  25822. <param name="source"></param>
  25823. <param name="e"></param>
  25824. </member>
  25825. <member name="T:log4net.Util.LogLog">
  25826. <summary>
  25827. Outputs log statements from within the log4net assembly.
  25828. </summary>
  25829. <remarks>
  25830. <para>
  25831. Log4net components cannot make log4net logging calls. However, it is
  25832. sometimes useful for the user to learn about what log4net is
  25833. doing.
  25834. </para>
  25835. <para>
  25836. All log4net internal debug calls go to the standard output stream
  25837. whereas internal error messages are sent to the standard error output
  25838. stream.
  25839. </para>
  25840. </remarks>
  25841. <author>Nicko Cadell</author>
  25842. <author>Gert Driesen</author>
  25843. </member>
  25844. <member name="M:log4net.Util.LogLog.ToString">
  25845. <summary>
  25846. Formats Prefix, Source, and Message in the same format as the value
  25847. sent to Console.Out and Trace.Write.
  25848. </summary>
  25849. <returns></returns>
  25850. </member>
  25851. <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
  25852. <summary>
  25853. Initializes a new instance of the <see cref="T:log4net.Util.LogLog"/> class.
  25854. </summary>
  25855. <param name="source"></param>
  25856. <param name="prefix"></param>
  25857. <param name="message"></param>
  25858. <param name="exception"></param>
  25859. </member>
  25860. <member name="M:log4net.Util.LogLog.#cctor">
  25861. <summary>
  25862. Static constructor that initializes logging by reading
  25863. settings from the application configuration file.
  25864. </summary>
  25865. <remarks>
  25866. <para>
  25867. The <c>log4net.Internal.Debug</c> application setting
  25868. controls internal debugging. This setting should be set
  25869. to <c>true</c> to enable debugging.
  25870. </para>
  25871. <para>
  25872. The <c>log4net.Internal.Quiet</c> application setting
  25873. suppresses all internal logging including error messages.
  25874. This setting should be set to <c>true</c> to enable message
  25875. suppression.
  25876. </para>
  25877. </remarks>
  25878. </member>
  25879. <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
  25880. <summary>
  25881. Raises the LogReceived event when an internal messages is received.
  25882. </summary>
  25883. <param name="source"></param>
  25884. <param name="prefix"></param>
  25885. <param name="message"></param>
  25886. <param name="exception"></param>
  25887. </member>
  25888. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
  25889. <summary>
  25890. Writes log4net internal debug messages to the
  25891. standard output stream.
  25892. </summary>
  25893. <param name="source"></param>
  25894. <param name="message">The message to log.</param>
  25895. <remarks>
  25896. <para>
  25897. All internal debug messages are prepended with
  25898. the string "log4net: ".
  25899. </para>
  25900. </remarks>
  25901. </member>
  25902. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
  25903. <summary>
  25904. Writes log4net internal debug messages to the
  25905. standard output stream.
  25906. </summary>
  25907. <param name="source">The Type that generated this message.</param>
  25908. <param name="message">The message to log.</param>
  25909. <param name="exception">An exception to log.</param>
  25910. <remarks>
  25911. <para>
  25912. All internal debug messages are prepended with
  25913. the string "log4net: ".
  25914. </para>
  25915. </remarks>
  25916. </member>
  25917. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
  25918. <summary>
  25919. Writes log4net internal warning messages to the
  25920. standard error stream.
  25921. </summary>
  25922. <param name="source">The Type that generated this message.</param>
  25923. <param name="message">The message to log.</param>
  25924. <remarks>
  25925. <para>
  25926. All internal warning messages are prepended with
  25927. the string "log4net:WARN ".
  25928. </para>
  25929. </remarks>
  25930. </member>
  25931. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
  25932. <summary>
  25933. Writes log4net internal warning messages to the
  25934. standard error stream.
  25935. </summary>
  25936. <param name="source">The Type that generated this message.</param>
  25937. <param name="message">The message to log.</param>
  25938. <param name="exception">An exception to log.</param>
  25939. <remarks>
  25940. <para>
  25941. All internal warning messages are prepended with
  25942. the string "log4net:WARN ".
  25943. </para>
  25944. </remarks>
  25945. </member>
  25946. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
  25947. <summary>
  25948. Writes log4net internal error messages to the
  25949. standard error stream.
  25950. </summary>
  25951. <param name="source">The Type that generated this message.</param>
  25952. <param name="message">The message to log.</param>
  25953. <remarks>
  25954. <para>
  25955. All internal error messages are prepended with
  25956. the string "log4net:ERROR ".
  25957. </para>
  25958. </remarks>
  25959. </member>
  25960. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
  25961. <summary>
  25962. Writes log4net internal error messages to the
  25963. standard error stream.
  25964. </summary>
  25965. <param name="source">The Type that generated this message.</param>
  25966. <param name="message">The message to log.</param>
  25967. <param name="exception">An exception to log.</param>
  25968. <remarks>
  25969. <para>
  25970. All internal debug messages are prepended with
  25971. the string "log4net:ERROR ".
  25972. </para>
  25973. </remarks>
  25974. </member>
  25975. <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
  25976. <summary>
  25977. Writes output to the standard output stream.
  25978. </summary>
  25979. <param name="message">The message to log.</param>
  25980. <remarks>
  25981. <para>
  25982. Writes to both Console.Out and System.Diagnostics.Trace.
  25983. Note that the System.Diagnostics.Trace is not supported
  25984. on the Compact Framework.
  25985. </para>
  25986. <para>
  25987. If the AppDomain is not configured with a config file then
  25988. the call to System.Diagnostics.Trace may fail. This is only
  25989. an issue if you are programmatically creating your own AppDomains.
  25990. </para>
  25991. </remarks>
  25992. </member>
  25993. <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
  25994. <summary>
  25995. Writes output to the standard error stream.
  25996. </summary>
  25997. <param name="message">The message to log.</param>
  25998. <remarks>
  25999. <para>
  26000. Writes to both Console.Error and System.Diagnostics.Trace.
  26001. Note that the System.Diagnostics.Trace is not supported
  26002. on the Compact Framework.
  26003. </para>
  26004. <para>
  26005. If the AppDomain is not configured with a config file then
  26006. the call to System.Diagnostics.Trace may fail. This is only
  26007. an issue if you are programmatically creating your own AppDomains.
  26008. </para>
  26009. </remarks>
  26010. </member>
  26011. <member name="F:log4net.Util.LogLog.s_debugEnabled">
  26012. <summary>
  26013. Default debug level
  26014. </summary>
  26015. </member>
  26016. <member name="F:log4net.Util.LogLog.s_quietMode">
  26017. <summary>
  26018. In quietMode not even errors generate any output.
  26019. </summary>
  26020. </member>
  26021. <member name="E:log4net.Util.LogLog.LogReceived">
  26022. <summary>
  26023. The event raised when an internal message has been received.
  26024. </summary>
  26025. </member>
  26026. <member name="P:log4net.Util.LogLog.Source">
  26027. <summary>
  26028. The Type that generated the internal message.
  26029. </summary>
  26030. </member>
  26031. <member name="P:log4net.Util.LogLog.TimeStamp">
  26032. <summary>
  26033. The DateTime stamp of when the internal message was received.
  26034. </summary>
  26035. </member>
  26036. <member name="P:log4net.Util.LogLog.Prefix">
  26037. <summary>
  26038. A string indicating the severity of the internal message.
  26039. </summary>
  26040. <remarks>
  26041. "log4net: ",
  26042. "log4net:ERROR ",
  26043. "log4net:WARN "
  26044. </remarks>
  26045. </member>
  26046. <member name="P:log4net.Util.LogLog.Message">
  26047. <summary>
  26048. The internal log message.
  26049. </summary>
  26050. </member>
  26051. <member name="P:log4net.Util.LogLog.Exception">
  26052. <summary>
  26053. The Exception related to the message.
  26054. </summary>
  26055. <remarks>
  26056. Optional. Will be null if no Exception was passed.
  26057. </remarks>
  26058. </member>
  26059. <member name="P:log4net.Util.LogLog.InternalDebugging">
  26060. <summary>
  26061. Gets or sets a value indicating whether log4net internal logging
  26062. is enabled or disabled.
  26063. </summary>
  26064. <value>
  26065. <c>true</c> if log4net internal logging is enabled, otherwise
  26066. <c>false</c>.
  26067. </value>
  26068. <remarks>
  26069. <para>
  26070. When set to <c>true</c>, internal debug level logging will be
  26071. displayed.
  26072. </para>
  26073. <para>
  26074. This value can be set by setting the application setting
  26075. <c>log4net.Internal.Debug</c> in the application configuration
  26076. file.
  26077. </para>
  26078. <para>
  26079. The default value is <c>false</c>, i.e. debugging is
  26080. disabled.
  26081. </para>
  26082. </remarks>
  26083. <example>
  26084. <para>
  26085. The following example enables internal debugging using the
  26086. application configuration file :
  26087. </para>
  26088. <code lang="XML" escaped="true">
  26089. <configuration>
  26090. <appSettings>
  26091. <add key="log4net.Internal.Debug" value="true" />
  26092. </appSettings>
  26093. </configuration>
  26094. </code>
  26095. </example>
  26096. </member>
  26097. <member name="P:log4net.Util.LogLog.QuietMode">
  26098. <summary>
  26099. Gets or sets a value indicating whether log4net should generate no output
  26100. from internal logging, not even for errors.
  26101. </summary>
  26102. <value>
  26103. <c>true</c> if log4net should generate no output at all from internal
  26104. logging, otherwise <c>false</c>.
  26105. </value>
  26106. <remarks>
  26107. <para>
  26108. When set to <c>true</c> will cause internal logging at all levels to be
  26109. suppressed. This means that no warning or error reports will be logged.
  26110. This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
  26111. disables all debug also.
  26112. </para>
  26113. <para>This value can be set by setting the application setting
  26114. <c>log4net.Internal.Quiet</c> in the application configuration file.
  26115. </para>
  26116. <para>
  26117. The default value is <c>false</c>, i.e. internal logging is not
  26118. disabled.
  26119. </para>
  26120. </remarks>
  26121. <example>
  26122. The following example disables internal logging using the
  26123. application configuration file :
  26124. <code lang="XML" escaped="true">
  26125. <configuration>
  26126. <appSettings>
  26127. <add key="log4net.Internal.Quiet" value="true"/>
  26128. </appSettings>
  26129. </configuration>
  26130. </code>
  26131. </example>
  26132. </member>
  26133. <member name="P:log4net.Util.LogLog.EmitInternalMessages">
  26134. <summary>
  26135. </summary>
  26136. </member>
  26137. <member name="P:log4net.Util.LogLog.IsDebugEnabled">
  26138. <summary>
  26139. Test if LogLog.Debug is enabled for output.
  26140. </summary>
  26141. <value>
  26142. <c>true</c> if Debug is enabled
  26143. </value>
  26144. <remarks>
  26145. <para>
  26146. Test if LogLog.Debug is enabled for output.
  26147. </para>
  26148. </remarks>
  26149. </member>
  26150. <member name="P:log4net.Util.LogLog.IsWarnEnabled">
  26151. <summary>
  26152. Test if LogLog.Warn is enabled for output.
  26153. </summary>
  26154. <value>
  26155. <c>true</c> if Warn is enabled
  26156. </value>
  26157. <remarks>
  26158. <para>
  26159. Test if LogLog.Warn is enabled for output.
  26160. </para>
  26161. </remarks>
  26162. </member>
  26163. <member name="P:log4net.Util.LogLog.IsErrorEnabled">
  26164. <summary>
  26165. Test if LogLog.Error is enabled for output.
  26166. </summary>
  26167. <value>
  26168. <c>true</c> if Error is enabled
  26169. </value>
  26170. <remarks>
  26171. <para>
  26172. Test if LogLog.Error is enabled for output.
  26173. </para>
  26174. </remarks>
  26175. </member>
  26176. <member name="T:log4net.Util.LogLog.LogReceivedAdapter">
  26177. <summary>
  26178. Subscribes to the LogLog.LogReceived event and stores messages
  26179. to the supplied IList instance.
  26180. </summary>
  26181. </member>
  26182. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
  26183. <summary>
  26184. </summary>
  26185. <param name="items"></param>
  26186. </member>
  26187. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
  26188. <summary>
  26189. </summary>
  26190. </member>
  26191. <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
  26192. <summary>
  26193. </summary>
  26194. </member>
  26195. <member name="T:log4net.Util.LogReceivedEventArgs">
  26196. <summary>
  26197. </summary>
  26198. </member>
  26199. <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
  26200. <summary>
  26201. </summary>
  26202. <param name="loglog"></param>
  26203. </member>
  26204. <member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
  26205. <summary>
  26206. </summary>
  26207. </member>
  26208. <member name="T:log4net.Util.NativeError">
  26209. <summary>
  26210. Represents a native error code and message.
  26211. </summary>
  26212. <remarks>
  26213. <para>
  26214. Represents a Win32 platform native error.
  26215. </para>
  26216. </remarks>
  26217. <author>Nicko Cadell</author>
  26218. <author>Gert Driesen</author>
  26219. </member>
  26220. <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
  26221. <summary>
  26222. Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
  26223. error number and message.
  26224. </summary>
  26225. <param name="number">The number of the native error.</param>
  26226. <param name="message">The message of the native error.</param>
  26227. <remarks>
  26228. <para>
  26229. Create an instance of the <see cref="T:log4net.Util.NativeError"/> class with the specified
  26230. error number and message.
  26231. </para>
  26232. </remarks>
  26233. </member>
  26234. <member name="M:log4net.Util.NativeError.GetLastError">
  26235. <summary>
  26236. Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class for the last Windows error.
  26237. </summary>
  26238. <returns>
  26239. An instance of the <see cref="T:log4net.Util.NativeError"/> class for the last windows error.
  26240. </returns>
  26241. <remarks>
  26242. <para>
  26243. The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
  26244. native Win32 <c>FormatMessage</c> function.
  26245. </para>
  26246. </remarks>
  26247. </member>
  26248. <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
  26249. <summary>
  26250. Create a new instance of the <see cref="T:log4net.Util.NativeError"/> class.
  26251. </summary>
  26252. <param name="number">the error number for the native error</param>
  26253. <returns>
  26254. An instance of the <see cref="T:log4net.Util.NativeError"/> class for the specified
  26255. error number.
  26256. </returns>
  26257. <remarks>
  26258. <para>
  26259. The message for the specified error number is lookup up using the
  26260. native Win32 <c>FormatMessage</c> function.
  26261. </para>
  26262. </remarks>
  26263. </member>
  26264. <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
  26265. <summary>
  26266. Retrieves the message corresponding with a Win32 message identifier.
  26267. </summary>
  26268. <param name="messageId">Message identifier for the requested message.</param>
  26269. <returns>
  26270. The message corresponding with the specified message identifier.
  26271. </returns>
  26272. <remarks>
  26273. <para>
  26274. The message will be searched for in system message-table resource(s)
  26275. using the native <c>FormatMessage</c> function.
  26276. </para>
  26277. </remarks>
  26278. </member>
  26279. <member name="M:log4net.Util.NativeError.ToString">
  26280. <summary>
  26281. Return error information string
  26282. </summary>
  26283. <returns>error information string</returns>
  26284. <remarks>
  26285. <para>
  26286. Return error information string
  26287. </para>
  26288. </remarks>
  26289. </member>
  26290. <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
  26291. <summary>
  26292. Formats a message string.
  26293. </summary>
  26294. <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
  26295. <param name="lpSource">Location of the message definition.</param>
  26296. <param name="dwMessageId">Message identifier for the requested message.</param>
  26297. <param name="dwLanguageId">Language identifier for the requested message.</param>
  26298. <param name="lpBuffer">If <paramref name="dwFlags" /> includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the <c>LocalAlloc</c> function, and places the pointer to the buffer at the address specified in <paramref name="lpBuffer" />.</param>
  26299. <param name="nSize">If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer.</param>
  26300. <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
  26301. <remarks>
  26302. <para>
  26303. The function requires a message definition as input. The message definition can come from a
  26304. buffer passed into the function. It can come from a message table resource in an
  26305. already-loaded module. Or the caller can ask the function to search the system's message
  26306. table resource(s) for the message definition. The function finds the message definition
  26307. in a message table resource based on a message identifier and a language identifier.
  26308. The function copies the formatted message text to an output buffer, processing any embedded
  26309. insert sequences if requested.
  26310. </para>
  26311. <para>
  26312. To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
  26313. </para>
  26314. </remarks>
  26315. <returns>
  26316. <para>
  26317. If the function succeeds, the return value is the number of TCHARs stored in the output
  26318. buffer, excluding the terminating null character.
  26319. </para>
  26320. <para>
  26321. If the function fails, the return value is zero. To get extended error information,
  26322. call <see cref="M:Marshal.GetLastWin32Error()" />.
  26323. </para>
  26324. </returns>
  26325. </member>
  26326. <member name="P:log4net.Util.NativeError.Number">
  26327. <summary>
  26328. Gets the number of the native error.
  26329. </summary>
  26330. <value>
  26331. The number of the native error.
  26332. </value>
  26333. <remarks>
  26334. <para>
  26335. Gets the number of the native error.
  26336. </para>
  26337. </remarks>
  26338. </member>
  26339. <member name="P:log4net.Util.NativeError.Message">
  26340. <summary>
  26341. Gets the message of the native error.
  26342. </summary>
  26343. <value>
  26344. The message of the native error.
  26345. </value>
  26346. <remarks>
  26347. <para>
  26348. </para>
  26349. Gets the message of the native error.
  26350. </remarks>
  26351. </member>
  26352. <member name="T:log4net.Util.NullDictionaryEnumerator">
  26353. <summary>
  26354. An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
  26355. </summary>
  26356. <remarks>
  26357. <para>
  26358. A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
  26359. that is empty and not modifiable.
  26360. </para>
  26361. </remarks>
  26362. <author>Nicko Cadell</author>
  26363. <author>Gert Driesen</author>
  26364. </member>
  26365. <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
  26366. <summary>
  26367. Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> class.
  26368. </summary>
  26369. <remarks>
  26370. <para>
  26371. Uses a private access modifier to enforce the singleton pattern.
  26372. </para>
  26373. </remarks>
  26374. </member>
  26375. <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
  26376. <summary>
  26377. Test if the enumerator can advance, if so advance.
  26378. </summary>
  26379. <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator"/> cannot advance.</returns>
  26380. <remarks>
  26381. <para>
  26382. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26383. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
  26384. will always return <c>false</c>.
  26385. </para>
  26386. </remarks>
  26387. </member>
  26388. <member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
  26389. <summary>
  26390. Resets the enumerator back to the start.
  26391. </summary>
  26392. <remarks>
  26393. <para>
  26394. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
  26395. </para>
  26396. </remarks>
  26397. </member>
  26398. <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
  26399. <summary>
  26400. The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  26401. </summary>
  26402. </member>
  26403. <member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
  26404. <summary>
  26405. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  26406. </summary>
  26407. <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.</returns>
  26408. <remarks>
  26409. <para>
  26410. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>.
  26411. </para>
  26412. </remarks>
  26413. </member>
  26414. <member name="P:log4net.Util.NullDictionaryEnumerator.Current">
  26415. <summary>
  26416. Gets the current object from the enumerator.
  26417. </summary>
  26418. <remarks>
  26419. Throws an <see cref="T:System.InvalidOperationException"/> because the
  26420. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  26421. </remarks>
  26422. <remarks>
  26423. <para>
  26424. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26425. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26426. will throw an <see cref="T:System.InvalidOperationException"/>.
  26427. </para>
  26428. </remarks>
  26429. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26430. cannot be positioned over a valid location.</exception>
  26431. </member>
  26432. <member name="P:log4net.Util.NullDictionaryEnumerator.Key">
  26433. <summary>
  26434. Gets the current key from the enumerator.
  26435. </summary>
  26436. <remarks>
  26437. Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator"/>
  26438. never has a current value.
  26439. </remarks>
  26440. <remarks>
  26441. <para>
  26442. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26443. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
  26444. will throw an <see cref="T:System.InvalidOperationException"/>.
  26445. </para>
  26446. </remarks>
  26447. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26448. cannot be positioned over a valid location.</exception>
  26449. </member>
  26450. <member name="P:log4net.Util.NullDictionaryEnumerator.Value">
  26451. <summary>
  26452. Gets the current value from the enumerator.
  26453. </summary>
  26454. <value>The current value from the enumerator.</value>
  26455. <remarks>
  26456. Throws an <see cref="T:System.InvalidOperationException"/> because the
  26457. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  26458. </remarks>
  26459. <remarks>
  26460. <para>
  26461. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26462. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
  26463. will throw an <see cref="T:System.InvalidOperationException"/>.
  26464. </para>
  26465. </remarks>
  26466. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26467. cannot be positioned over a valid location.</exception>
  26468. </member>
  26469. <member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
  26470. <summary>
  26471. Gets the current entry from the enumerator.
  26472. </summary>
  26473. <remarks>
  26474. Throws an <see cref="T:System.InvalidOperationException"/> because the
  26475. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current entry.
  26476. </remarks>
  26477. <remarks>
  26478. <para>
  26479. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26480. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
  26481. will throw an <see cref="T:System.InvalidOperationException"/>.
  26482. </para>
  26483. </remarks>
  26484. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  26485. cannot be positioned over a valid location.</exception>
  26486. </member>
  26487. <member name="T:log4net.Util.NullEnumerator">
  26488. <summary>
  26489. An always empty <see cref="T:System.Collections.IEnumerator"/>.
  26490. </summary>
  26491. <remarks>
  26492. <para>
  26493. A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
  26494. that is empty and not modifiable.
  26495. </para>
  26496. </remarks>
  26497. <author>Nicko Cadell</author>
  26498. <author>Gert Driesen</author>
  26499. </member>
  26500. <member name="M:log4net.Util.NullEnumerator.#ctor">
  26501. <summary>
  26502. Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator"/> class.
  26503. </summary>
  26504. <remarks>
  26505. <para>
  26506. Uses a private access modifier to enforce the singleton pattern.
  26507. </para>
  26508. </remarks>
  26509. </member>
  26510. <member name="M:log4net.Util.NullEnumerator.MoveNext">
  26511. <summary>
  26512. Test if the enumerator can advance, if so advance
  26513. </summary>
  26514. <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator"/> cannot advance.</returns>
  26515. <remarks>
  26516. <para>
  26517. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  26518. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
  26519. will always return <c>false</c>.
  26520. </para>
  26521. </remarks>
  26522. </member>
  26523. <member name="M:log4net.Util.NullEnumerator.Reset">
  26524. <summary>
  26525. Resets the enumerator back to the start.
  26526. </summary>
  26527. <remarks>
  26528. <para>
  26529. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
  26530. </para>
  26531. </remarks>
  26532. </member>
  26533. <member name="F:log4net.Util.NullEnumerator.s_instance">
  26534. <summary>
  26535. The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  26536. </summary>
  26537. </member>
  26538. <member name="P:log4net.Util.NullEnumerator.Instance">
  26539. <summary>
  26540. Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  26541. </summary>
  26542. <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.</returns>
  26543. <remarks>
  26544. <para>
  26545. Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator"/>.
  26546. </para>
  26547. </remarks>
  26548. </member>
  26549. <member name="P:log4net.Util.NullEnumerator.Current">
  26550. <summary>
  26551. Gets the current object from the enumerator.
  26552. </summary>
  26553. <remarks>
  26554. Throws an <see cref="T:System.InvalidOperationException"/> because the
  26555. <see cref="T:log4net.Util.NullDictionaryEnumerator"/> never has a current value.
  26556. </remarks>
  26557. <remarks>
  26558. <para>
  26559. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  26560. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
  26561. will throw an <see cref="T:System.InvalidOperationException"/>.
  26562. </para>
  26563. </remarks>
  26564. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
  26565. cannot be positioned over a valid location.</exception>
  26566. </member>
  26567. <member name="T:log4net.Util.NullSecurityContext">
  26568. <summary>
  26569. A SecurityContext used when a SecurityContext is not required
  26570. </summary>
  26571. <remarks>
  26572. <para>
  26573. The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
  26574. <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
  26575. is required but one has not been provided.
  26576. </para>
  26577. </remarks>
  26578. <author>Nicko Cadell</author>
  26579. </member>
  26580. <member name="F:log4net.Util.NullSecurityContext.Instance">
  26581. <summary>
  26582. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  26583. </summary>
  26584. <remarks>
  26585. <para>
  26586. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  26587. </para>
  26588. </remarks>
  26589. </member>
  26590. <member name="M:log4net.Util.NullSecurityContext.#ctor">
  26591. <summary>
  26592. Private constructor
  26593. </summary>
  26594. <remarks>
  26595. <para>
  26596. Private constructor for singleton pattern.
  26597. </para>
  26598. </remarks>
  26599. </member>
  26600. <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
  26601. <summary>
  26602. Impersonate this SecurityContext
  26603. </summary>
  26604. <param name="state">State supplied by the caller</param>
  26605. <returns><c>null</c></returns>
  26606. <remarks>
  26607. <para>
  26608. No impersonation is done and <c>null</c> is always returned.
  26609. </para>
  26610. </remarks>
  26611. </member>
  26612. <member name="T:log4net.Util.OnlyOnceErrorHandler">
  26613. <summary>
  26614. Implements log4net's default error handling policy which consists
  26615. of emitting a message for the first error in an appender and
  26616. ignoring all subsequent errors.
  26617. </summary>
  26618. <remarks>
  26619. <para>
  26620. The error message is processed using the LogLog sub-system by default.
  26621. </para>
  26622. <para>
  26623. This policy aims at protecting an otherwise working application
  26624. from being flooded with error messages when logging fails.
  26625. </para>
  26626. </remarks>
  26627. <author>Nicko Cadell</author>
  26628. <author>Gert Driesen</author>
  26629. <author>Ron Grabowski</author>
  26630. </member>
  26631. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
  26632. <summary>
  26633. Default Constructor
  26634. </summary>
  26635. <remarks>
  26636. <para>
  26637. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class.
  26638. </para>
  26639. </remarks>
  26640. </member>
  26641. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
  26642. <summary>
  26643. Constructor
  26644. </summary>
  26645. <param name="prefix">The prefix to use for each message.</param>
  26646. <remarks>
  26647. <para>
  26648. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/> class
  26649. with the specified prefix.
  26650. </para>
  26651. </remarks>
  26652. </member>
  26653. <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
  26654. <summary>
  26655. Reset the error handler back to its initial disabled state.
  26656. </summary>
  26657. </member>
  26658. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  26659. <summary>
  26660. Log an Error
  26661. </summary>
  26662. <param name="message">The error message.</param>
  26663. <param name="e">The exception.</param>
  26664. <param name="errorCode">The internal error code.</param>
  26665. <remarks>
  26666. <para>
  26667. Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
  26668. </para>
  26669. </remarks>
  26670. </member>
  26671. <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
  26672. <summary>
  26673. Log the very first error
  26674. </summary>
  26675. <param name="message">The error message.</param>
  26676. <param name="e">The exception.</param>
  26677. <param name="errorCode">The internal error code.</param>
  26678. <remarks>
  26679. <para>
  26680. Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
  26681. </para>
  26682. </remarks>
  26683. </member>
  26684. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
  26685. <summary>
  26686. Log an Error
  26687. </summary>
  26688. <param name="message">The error message.</param>
  26689. <param name="e">The exception.</param>
  26690. <remarks>
  26691. <para>
  26692. Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
  26693. </para>
  26694. </remarks>
  26695. </member>
  26696. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
  26697. <summary>
  26698. Log an error
  26699. </summary>
  26700. <param name="message">The error message.</param>
  26701. <remarks>
  26702. <para>
  26703. Invokes <see cref="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)"/> if and only if this is the first error or the first error after <see cref="M:log4net.Util.OnlyOnceErrorHandler.Reset"/> has been called.
  26704. </para>
  26705. </remarks>
  26706. </member>
  26707. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDate">
  26708. <summary>
  26709. The date the error was recorded.
  26710. </summary>
  26711. </member>
  26712. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
  26713. <summary>
  26714. Flag to indicate if it is the first error
  26715. </summary>
  26716. </member>
  26717. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
  26718. <summary>
  26719. The message recorded during the first error.
  26720. </summary>
  26721. </member>
  26722. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
  26723. <summary>
  26724. The exception recorded during the first error.
  26725. </summary>
  26726. </member>
  26727. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
  26728. <summary>
  26729. The error code recorded during the first error.
  26730. </summary>
  26731. </member>
  26732. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
  26733. <summary>
  26734. String to prefix each message with
  26735. </summary>
  26736. </member>
  26737. <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
  26738. <summary>
  26739. The fully qualified type of the OnlyOnceErrorHandler class.
  26740. </summary>
  26741. <remarks>
  26742. Used by the internal logger to record the Type of the
  26743. log message.
  26744. </remarks>
  26745. </member>
  26746. <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
  26747. <summary>
  26748. Is error logging enabled
  26749. </summary>
  26750. <remarks>
  26751. <para>
  26752. Is error logging enabled. Logging is only enabled for the
  26753. first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
  26754. </para>
  26755. </remarks>
  26756. </member>
  26757. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
  26758. <summary>
  26759. The date the first error that trigged this error handler occured.
  26760. </summary>
  26761. </member>
  26762. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
  26763. <summary>
  26764. The message from the first error that trigged this error handler.
  26765. </summary>
  26766. </member>
  26767. <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
  26768. <summary>
  26769. The exception from the first error that trigged this error handler.
  26770. </summary>
  26771. <remarks>
  26772. May be <see langword="null" />.
  26773. </remarks>
  26774. </member>
  26775. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
  26776. <summary>
  26777. The error code from the first error that trigged this error handler.
  26778. </summary>
  26779. <remarks>
  26780. Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
  26781. </remarks>
  26782. </member>
  26783. <member name="T:log4net.Util.OptionConverter">
  26784. <summary>
  26785. A convenience class to convert property values to specific types.
  26786. </summary>
  26787. <remarks>
  26788. <para>
  26789. Utility functions for converting types and parsing values.
  26790. </para>
  26791. </remarks>
  26792. <author>Nicko Cadell</author>
  26793. <author>Gert Driesen</author>
  26794. </member>
  26795. <member name="M:log4net.Util.OptionConverter.#ctor">
  26796. <summary>
  26797. Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter"/> class.
  26798. </summary>
  26799. <remarks>
  26800. <para>
  26801. Uses a private access modifier to prevent instantiation of this class.
  26802. </para>
  26803. </remarks>
  26804. </member>
  26805. <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
  26806. <summary>
  26807. Converts a string to a <see cref="T:System.Boolean"/> value.
  26808. </summary>
  26809. <param name="argValue">String to convert.</param>
  26810. <param name="defaultValue">The default value.</param>
  26811. <returns>The <see cref="T:System.Boolean"/> value of <paramref name="argValue"/>.</returns>
  26812. <remarks>
  26813. <para>
  26814. If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
  26815. If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
  26816. Otherwise, <paramref name="defaultValue"/> is returned.
  26817. </para>
  26818. </remarks>
  26819. </member>
  26820. <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
  26821. <summary>
  26822. Parses a file size into a number.
  26823. </summary>
  26824. <param name="argValue">String to parse.</param>
  26825. <param name="defaultValue">The default value.</param>
  26826. <returns>The <see cref="T:System.Int64"/> value of <paramref name="argValue"/>.</returns>
  26827. <remarks>
  26828. <para>
  26829. Parses a file size of the form: number[KB|MB|GB] into a
  26830. long value. It is scaled with the appropriate multiplier.
  26831. </para>
  26832. <para>
  26833. <paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
  26834. cannot be converted to a <see cref="T:System.Int64"/> value.
  26835. </para>
  26836. </remarks>
  26837. </member>
  26838. <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
  26839. <summary>
  26840. Converts a string to an object.
  26841. </summary>
  26842. <param name="target">The target type to convert to.</param>
  26843. <param name="txt">The string to convert to an object.</param>
  26844. <returns>
  26845. The object converted from a string or <c>null</c> when the
  26846. conversion failed.
  26847. </returns>
  26848. <remarks>
  26849. <para>
  26850. Converts a string to an object. Uses the converter registry to try
  26851. to convert the string value into the specified target type.
  26852. </para>
  26853. </remarks>
  26854. </member>
  26855. <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
  26856. <summary>
  26857. Checks if there is an appropriate type conversion from the source type to the target type.
  26858. </summary>
  26859. <param name="sourceType">The type to convert from.</param>
  26860. <param name="targetType">The type to convert to.</param>
  26861. <returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
  26862. <remarks>
  26863. Checks if there is an appropriate type conversion from the source type to the target type.
  26864. <para>
  26865. </para>
  26866. </remarks>
  26867. </member>
  26868. <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
  26869. <summary>
  26870. Converts an object to the target type.
  26871. </summary>
  26872. <param name="sourceInstance">The object to convert to the target type.</param>
  26873. <param name="targetType">The type to convert to.</param>
  26874. <returns>The converted object.</returns>
  26875. <remarks>
  26876. <para>
  26877. Converts an object to the target type.
  26878. </para>
  26879. </remarks>
  26880. </member>
  26881. <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
  26882. <summary>
  26883. Instantiates an object given a class name.
  26884. </summary>
  26885. <param name="className">The fully qualified class name of the object to instantiate.</param>
  26886. <param name="superClass">The class to which the new object should belong.</param>
  26887. <param name="defaultValue">The object to return in case of non-fulfillment.</param>
  26888. <returns>
  26889. An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
  26890. if the object could not be instantiated.
  26891. </returns>
  26892. <remarks>
  26893. <para>
  26894. Checks that the <paramref name="className"/> is a subclass of
  26895. <paramref name="superClass"/>. If that test fails or the object could
  26896. not be instantiated, then <paramref name="defaultValue"/> is returned.
  26897. </para>
  26898. </remarks>
  26899. </member>
  26900. <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
  26901. <summary>
  26902. Performs variable substitution in string <paramref name="value"/> from the
  26903. values of keys found in <paramref name="props"/>.
  26904. </summary>
  26905. <param name="value">The string on which variable substitution is performed.</param>
  26906. <param name="props">The dictionary to use to lookup variables.</param>
  26907. <returns>The result of the substitutions.</returns>
  26908. <remarks>
  26909. <para>
  26910. The variable substitution delimiters are <b>${</b> and <b>}</b>.
  26911. </para>
  26912. <para>
  26913. For example, if props contains <c>key=value</c>, then the call
  26914. </para>
  26915. <para>
  26916. <code lang="C#">
  26917. string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
  26918. </code>
  26919. </para>
  26920. <para>
  26921. will set the variable <c>s</c> to "Value of key is value.".
  26922. </para>
  26923. <para>
  26924. If no value could be found for the specified key, then substitution
  26925. defaults to an empty string.
  26926. </para>
  26927. <para>
  26928. For example, if system properties contains no value for the key
  26929. "nonExistentKey", then the call
  26930. </para>
  26931. <para>
  26932. <code lang="C#">
  26933. string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
  26934. </code>
  26935. </para>
  26936. <para>
  26937. will set <s>s</s> to "Value of nonExistentKey is []".
  26938. </para>
  26939. <para>
  26940. An Exception is thrown if <paramref name="value"/> contains a start
  26941. delimiter "${" which is not balanced by a stop delimiter "}".
  26942. </para>
  26943. </remarks>
  26944. </member>
  26945. <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
  26946. <summary>
  26947. Converts the string representation of the name or numeric value of one or
  26948. more enumerated constants to an equivalent enumerated object.
  26949. </summary>
  26950. <param name="enumType">The type to convert to.</param>
  26951. <param name="value">The enum string value.</param>
  26952. <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
  26953. <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
  26954. </member>
  26955. <member name="F:log4net.Util.OptionConverter.declaringType">
  26956. <summary>
  26957. The fully qualified type of the OptionConverter class.
  26958. </summary>
  26959. <remarks>
  26960. Used by the internal logger to record the Type of the
  26961. log message.
  26962. </remarks>
  26963. </member>
  26964. <member name="T:log4net.Util.PatternParser">
  26965. <summary>
  26966. Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
  26967. is delegated to the PatternParser class.
  26968. </summary>
  26969. <remarks>
  26970. <para>
  26971. The <c>PatternParser</c> processes a pattern string and
  26972. returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
  26973. </para>
  26974. </remarks>
  26975. <author>Nicko Cadell</author>
  26976. <author>Gert Driesen</author>
  26977. </member>
  26978. <member name="M:log4net.Util.PatternParser.#ctor(System.String)">
  26979. <summary>
  26980. Constructor
  26981. </summary>
  26982. <param name="pattern">The pattern to parse.</param>
  26983. <remarks>
  26984. <para>
  26985. Initializes a new instance of the <see cref="T:log4net.Util.PatternParser"/> class
  26986. with the specified pattern string.
  26987. </para>
  26988. </remarks>
  26989. </member>
  26990. <member name="M:log4net.Util.PatternParser.Parse">
  26991. <summary>
  26992. Parses the pattern into a chain of pattern converters.
  26993. </summary>
  26994. <returns>The head of a chain of pattern converters.</returns>
  26995. <remarks>
  26996. <para>
  26997. Parses the pattern into a chain of pattern converters.
  26998. </para>
  26999. </remarks>
  27000. </member>
  27001. <member name="M:log4net.Util.PatternParser.BuildCache">
  27002. <summary>
  27003. Build the unified cache of converters from the static and instance maps
  27004. </summary>
  27005. <returns>the list of all the converter names</returns>
  27006. <remarks>
  27007. <para>
  27008. Build the unified cache of converters from the static and instance maps
  27009. </para>
  27010. </remarks>
  27011. </member>
  27012. <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
  27013. <summary>
  27014. Internal method to parse the specified pattern to find specified matches
  27015. </summary>
  27016. <param name="pattern">the pattern to parse</param>
  27017. <param name="matches">the converter names to match in the pattern</param>
  27018. <remarks>
  27019. <para>
  27020. The matches param must be sorted such that longer strings come before shorter ones.
  27021. </para>
  27022. </remarks>
  27023. </member>
  27024. <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
  27025. <summary>
  27026. Process a parsed literal
  27027. </summary>
  27028. <param name="text">the literal text</param>
  27029. </member>
  27030. <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
  27031. <summary>
  27032. Process a parsed converter pattern
  27033. </summary>
  27034. <param name="converterName">the name of the converter</param>
  27035. <param name="option">the optional option for the converter</param>
  27036. <param name="formattingInfo">the formatting info for the converter</param>
  27037. </member>
  27038. <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
  27039. <summary>
  27040. Resets the internal state of the parser and adds the specified pattern converter
  27041. to the chain.
  27042. </summary>
  27043. <param name="pc">The pattern converter to add.</param>
  27044. </member>
  27045. <member name="F:log4net.Util.PatternParser.m_head">
  27046. <summary>
  27047. The first pattern converter in the chain
  27048. </summary>
  27049. </member>
  27050. <member name="F:log4net.Util.PatternParser.m_tail">
  27051. <summary>
  27052. the last pattern converter in the chain
  27053. </summary>
  27054. </member>
  27055. <member name="F:log4net.Util.PatternParser.m_pattern">
  27056. <summary>
  27057. The pattern
  27058. </summary>
  27059. </member>
  27060. <member name="F:log4net.Util.PatternParser.m_patternConverters">
  27061. <summary>
  27062. Internal map of converter identifiers to converter types
  27063. </summary>
  27064. <remarks>
  27065. <para>
  27066. This map overrides the static s_globalRulesRegistry map.
  27067. </para>
  27068. </remarks>
  27069. </member>
  27070. <member name="F:log4net.Util.PatternParser.declaringType">
  27071. <summary>
  27072. The fully qualified type of the PatternParser class.
  27073. </summary>
  27074. <remarks>
  27075. Used by the internal logger to record the Type of the
  27076. log message.
  27077. </remarks>
  27078. </member>
  27079. <member name="P:log4net.Util.PatternParser.PatternConverters">
  27080. <summary>
  27081. Get the converter registry used by this parser
  27082. </summary>
  27083. <value>
  27084. The converter registry used by this parser
  27085. </value>
  27086. <remarks>
  27087. <para>
  27088. Get the converter registry used by this parser
  27089. </para>
  27090. </remarks>
  27091. </member>
  27092. <member name="T:log4net.Util.PatternParser.StringLengthComparer">
  27093. <summary>
  27094. Sort strings by length
  27095. </summary>
  27096. <remarks>
  27097. <para>
  27098. <see cref="T:System.Collections.IComparer"/> that orders strings by string length.
  27099. The longest strings are placed first
  27100. </para>
  27101. </remarks>
  27102. </member>
  27103. <member name="T:log4net.Util.PatternString">
  27104. <summary>
  27105. This class implements a patterned string.
  27106. </summary>
  27107. <remarks>
  27108. <para>
  27109. This string has embedded patterns that are resolved and expanded
  27110. when the string is formatted.
  27111. </para>
  27112. <para>
  27113. This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
  27114. in that it accepts a pattern and renders it to a string. Unlike the
  27115. <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
  27116. does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
  27117. of the process in general.
  27118. </para>
  27119. <para>
  27120. The recognized conversion pattern names are:
  27121. </para>
  27122. <list type="table">
  27123. <listheader>
  27124. <term>Conversion Pattern Name</term>
  27125. <description>Effect</description>
  27126. </listheader>
  27127. <item>
  27128. <term>appdomain</term>
  27129. <description>
  27130. <para>
  27131. Used to output the friendly name of the current AppDomain.
  27132. </para>
  27133. </description>
  27134. </item>
  27135. <item>
  27136. <term>date</term>
  27137. <description>
  27138. <para>
  27139. Used to output the current date and time in the local time zone.
  27140. To output the date in universal time use the <c>%utcdate</c> pattern.
  27141. The date conversion
  27142. specifier may be followed by a <i>date format specifier</i> enclosed
  27143. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  27144. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  27145. given then ISO8601 format is
  27146. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  27147. </para>
  27148. <para>
  27149. The date format specifier admits the same syntax as the
  27150. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  27151. </para>
  27152. <para>
  27153. For better results it is recommended to use the log4net date
  27154. formatters. These can be specified using one of the strings
  27155. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  27156. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  27157. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  27158. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  27159. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  27160. </para>
  27161. <para>
  27162. These dedicated date formatters perform significantly
  27163. better than <see cref="M:DateTime.ToString(string)"/>.
  27164. </para>
  27165. </description>
  27166. </item>
  27167. <item>
  27168. <term>env</term>
  27169. <description>
  27170. <para>
  27171. Used to output the a specific environment variable. The key to
  27172. lookup must be specified within braces and directly following the
  27173. pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
  27174. of the <c>COMPUTERNAME</c> environment variable.
  27175. </para>
  27176. <para>
  27177. The <c>env</c> pattern is not supported on the .NET Compact Framework.
  27178. </para>
  27179. </description>
  27180. </item>
  27181. <item>
  27182. <term>identity</term>
  27183. <description>
  27184. <para>
  27185. Used to output the user name for the currently active user
  27186. (Principal.Identity.Name).
  27187. </para>
  27188. </description>
  27189. </item>
  27190. <item>
  27191. <term>newline</term>
  27192. <description>
  27193. <para>
  27194. Outputs the platform dependent line separator character or
  27195. characters.
  27196. </para>
  27197. <para>
  27198. This conversion pattern name offers the same performance as using
  27199. non-portable line separator strings such as "\n", or "\r\n".
  27200. Thus, it is the preferred way of specifying a line separator.
  27201. </para>
  27202. </description>
  27203. </item>
  27204. <item>
  27205. <term>processid</term>
  27206. <description>
  27207. <para>
  27208. Used to output the system process ID for the current process.
  27209. </para>
  27210. </description>
  27211. </item>
  27212. <item>
  27213. <term>property</term>
  27214. <description>
  27215. <para>
  27216. Used to output a specific context property. The key to
  27217. lookup must be specified within braces and directly following the
  27218. pattern specifier, e.g. <b>%property{user}</b> would include the value
  27219. from the property that is keyed by the string 'user'. Each property value
  27220. that is to be included in the log must be specified separately.
  27221. Properties are stored in logging contexts. By default
  27222. the <c>log4net:HostName</c> property is set to the name of machine on
  27223. which the event was originally logged.
  27224. </para>
  27225. <para>
  27226. If no key is specified, e.g. <b>%property</b> then all the keys and their
  27227. values are printed in a comma separated list.
  27228. </para>
  27229. <para>
  27230. The properties of an event are combined from a number of different
  27231. contexts. These are listed below in the order in which they are searched.
  27232. </para>
  27233. <list type="definition">
  27234. <item>
  27235. <term>the thread properties</term>
  27236. <description>
  27237. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  27238. thread. These properties are shared by all events logged on this thread.
  27239. </description>
  27240. </item>
  27241. <item>
  27242. <term>the global properties</term>
  27243. <description>
  27244. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  27245. properties are shared by all the threads in the AppDomain.
  27246. </description>
  27247. </item>
  27248. </list>
  27249. </description>
  27250. </item>
  27251. <item>
  27252. <term>random</term>
  27253. <description>
  27254. <para>
  27255. Used to output a random string of characters. The string is made up of
  27256. uppercase letters and numbers. By default the string is 4 characters long.
  27257. The length of the string can be specified within braces directly following the
  27258. pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
  27259. </para>
  27260. </description>
  27261. </item>
  27262. <item>
  27263. <term>username</term>
  27264. <description>
  27265. <para>
  27266. Used to output the WindowsIdentity for the currently
  27267. active user.
  27268. </para>
  27269. </description>
  27270. </item>
  27271. <item>
  27272. <term>utcdate</term>
  27273. <description>
  27274. <para>
  27275. Used to output the date of the logging event in universal time.
  27276. The date conversion
  27277. specifier may be followed by a <i>date format specifier</i> enclosed
  27278. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  27279. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  27280. given then ISO8601 format is
  27281. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  27282. </para>
  27283. <para>
  27284. The date format specifier admits the same syntax as the
  27285. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  27286. </para>
  27287. <para>
  27288. For better results it is recommended to use the log4net date
  27289. formatters. These can be specified using one of the strings
  27290. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  27291. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  27292. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  27293. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  27294. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  27295. </para>
  27296. <para>
  27297. These dedicated date formatters perform significantly
  27298. better than <see cref="M:DateTime.ToString(string)"/>.
  27299. </para>
  27300. </description>
  27301. </item>
  27302. <item>
  27303. <term>%</term>
  27304. <description>
  27305. <para>
  27306. The sequence %% outputs a single percent sign.
  27307. </para>
  27308. </description>
  27309. </item>
  27310. </list>
  27311. <para>
  27312. Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
  27313. instance using <see cref="M:AddConverter(ConverterInfo)"/> or
  27314. <see cref="M:AddConverter(string, Type)"/>.
  27315. </para>
  27316. <para>
  27317. See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
  27318. <i>format modifiers</i> supported by the patterns.
  27319. </para>
  27320. </remarks>
  27321. <author>Nicko Cadell</author>
  27322. </member>
  27323. <member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
  27324. <summary>
  27325. Internal map of converter identifiers to converter types.
  27326. </summary>
  27327. </member>
  27328. <member name="F:log4net.Util.PatternString.m_pattern">
  27329. <summary>
  27330. the pattern
  27331. </summary>
  27332. </member>
  27333. <member name="F:log4net.Util.PatternString.m_head">
  27334. <summary>
  27335. the head of the pattern converter chain
  27336. </summary>
  27337. </member>
  27338. <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
  27339. <summary>
  27340. patterns defined on this PatternString only
  27341. </summary>
  27342. </member>
  27343. <member name="M:log4net.Util.PatternString.#cctor">
  27344. <summary>
  27345. Initialize the global registry
  27346. </summary>
  27347. </member>
  27348. <member name="M:log4net.Util.PatternString.#ctor">
  27349. <summary>
  27350. Default constructor
  27351. </summary>
  27352. <remarks>
  27353. <para>
  27354. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
  27355. </para>
  27356. </remarks>
  27357. </member>
  27358. <member name="M:log4net.Util.PatternString.#ctor(System.String)">
  27359. <summary>
  27360. Constructs a PatternString
  27361. </summary>
  27362. <param name="pattern">The pattern to use with this PatternString</param>
  27363. <remarks>
  27364. <para>
  27365. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
  27366. </para>
  27367. </remarks>
  27368. </member>
  27369. <member name="M:log4net.Util.PatternString.ActivateOptions">
  27370. <summary>
  27371. Initialize object options
  27372. </summary>
  27373. <remarks>
  27374. <para>
  27375. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  27376. activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
  27377. be called on this object after the configuration properties have
  27378. been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
  27379. object is in an undefined state and must not be used.
  27380. </para>
  27381. <para>
  27382. If any of the configuration properties are modified then
  27383. <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
  27384. </para>
  27385. </remarks>
  27386. </member>
  27387. <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
  27388. <summary>
  27389. Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
  27390. </summary>
  27391. <param name="pattern">the pattern to parse</param>
  27392. <returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
  27393. <remarks>
  27394. <para>
  27395. Returns PatternParser used to parse the conversion string. Subclasses
  27396. may override this to return a subclass of PatternParser which recognize
  27397. custom conversion pattern name.
  27398. </para>
  27399. </remarks>
  27400. </member>
  27401. <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
  27402. <summary>
  27403. Produces a formatted string as specified by the conversion pattern.
  27404. </summary>
  27405. <param name="writer">The TextWriter to write the formatted event to</param>
  27406. <remarks>
  27407. <para>
  27408. Format the pattern to the <paramref name="writer"/>.
  27409. </para>
  27410. </remarks>
  27411. </member>
  27412. <member name="M:log4net.Util.PatternString.Format">
  27413. <summary>
  27414. Format the pattern as a string
  27415. </summary>
  27416. <returns>the pattern formatted as a string</returns>
  27417. <remarks>
  27418. <para>
  27419. Format the pattern to a string.
  27420. </para>
  27421. </remarks>
  27422. </member>
  27423. <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
  27424. <summary>
  27425. Add a converter to this PatternString
  27426. </summary>
  27427. <param name="converterInfo">the converter info</param>
  27428. <remarks>
  27429. <para>
  27430. This version of the method is used by the configurator.
  27431. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  27432. </para>
  27433. </remarks>
  27434. </member>
  27435. <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
  27436. <summary>
  27437. Add a converter to this PatternString
  27438. </summary>
  27439. <param name="name">the name of the conversion pattern for this converter</param>
  27440. <param name="type">the type of the converter</param>
  27441. <remarks>
  27442. <para>
  27443. Add a converter to this PatternString
  27444. </para>
  27445. </remarks>
  27446. </member>
  27447. <member name="P:log4net.Util.PatternString.ConversionPattern">
  27448. <summary>
  27449. Gets or sets the pattern formatting string
  27450. </summary>
  27451. <value>
  27452. The pattern formatting string
  27453. </value>
  27454. <remarks>
  27455. <para>
  27456. The <b>ConversionPattern</b> option. This is the string which
  27457. controls formatting and consists of a mix of literal content and
  27458. conversion specifiers.
  27459. </para>
  27460. </remarks>
  27461. </member>
  27462. <member name="T:log4net.Util.PropertiesDictionary">
  27463. <summary>
  27464. String keyed object map.
  27465. </summary>
  27466. <remarks>
  27467. <para>
  27468. While this collection is serializable only member
  27469. objects that are serializable will
  27470. be serialized along with this collection.
  27471. </para>
  27472. </remarks>
  27473. <author>Nicko Cadell</author>
  27474. <author>Gert Driesen</author>
  27475. </member>
  27476. <member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
  27477. <summary>
  27478. String keyed object map that is read only.
  27479. </summary>
  27480. <remarks>
  27481. <para>
  27482. This collection is readonly and cannot be modified.
  27483. </para>
  27484. <para>
  27485. While this collection is serializable only member
  27486. objects that are serializable will
  27487. be serialized along with this collection.
  27488. </para>
  27489. </remarks>
  27490. <author>Nicko Cadell</author>
  27491. <author>Gert Driesen</author>
  27492. </member>
  27493. <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
  27494. <summary>
  27495. The Hashtable used to store the properties data
  27496. </summary>
  27497. </member>
  27498. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
  27499. <summary>
  27500. Constructor
  27501. </summary>
  27502. <remarks>
  27503. <para>
  27504. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
  27505. </para>
  27506. </remarks>
  27507. </member>
  27508. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  27509. <summary>
  27510. Copy Constructor
  27511. </summary>
  27512. <param name="propertiesDictionary">properties to copy</param>
  27513. <remarks>
  27514. <para>
  27515. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class.
  27516. </para>
  27517. </remarks>
  27518. </member>
  27519. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27520. <summary>
  27521. Deserialization constructor
  27522. </summary>
  27523. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  27524. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  27525. <remarks>
  27526. <para>
  27527. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary"/> class
  27528. with serialized data.
  27529. </para>
  27530. </remarks>
  27531. </member>
  27532. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
  27533. <summary>
  27534. Gets the key names.
  27535. </summary>
  27536. <returns>An array of all the keys.</returns>
  27537. <remarks>
  27538. <para>
  27539. Gets the key names.
  27540. </para>
  27541. </remarks>
  27542. </member>
  27543. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
  27544. <summary>
  27545. Test if the dictionary contains a specified key
  27546. </summary>
  27547. <param name="key">the key to look for</param>
  27548. <returns>true if the dictionary contains the specified key</returns>
  27549. <remarks>
  27550. <para>
  27551. Test if the dictionary contains a specified key
  27552. </para>
  27553. </remarks>
  27554. </member>
  27555. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27556. <summary>
  27557. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  27558. </summary>
  27559. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
  27560. <param name="context">The destination for this serialization.</param>
  27561. <remarks>
  27562. <para>
  27563. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
  27564. </para>
  27565. </remarks>
  27566. </member>
  27567. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  27568. <summary>
  27569. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  27570. </summary>
  27571. </member>
  27572. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  27573. <summary>
  27574. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  27575. </summary>
  27576. <param name="key"></param>
  27577. </member>
  27578. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  27579. <summary>
  27580. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  27581. </summary>
  27582. <param name="key"></param>
  27583. <returns></returns>
  27584. </member>
  27585. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
  27586. <summary>
  27587. Remove all properties from the properties collection
  27588. </summary>
  27589. </member>
  27590. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  27591. <summary>
  27592. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  27593. </summary>
  27594. <param name="key"></param>
  27595. <param name="value"></param>
  27596. </member>
  27597. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  27598. <summary>
  27599. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  27600. </summary>
  27601. <param name="array"></param>
  27602. <param name="index"></param>
  27603. </member>
  27604. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  27605. <summary>
  27606. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  27607. </summary>
  27608. </member>
  27609. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
  27610. <summary>
  27611. Gets or sets the value of the property with the specified key.
  27612. </summary>
  27613. <value>
  27614. The value of the property with the specified key.
  27615. </value>
  27616. <param name="key">The key of the property to get or set.</param>
  27617. <remarks>
  27618. <para>
  27619. The property value will only be serialized if it is serializable.
  27620. If it cannot be serialized it will be silently ignored if
  27621. a serialization operation is performed.
  27622. </para>
  27623. </remarks>
  27624. </member>
  27625. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
  27626. <summary>
  27627. The hashtable used to store the properties
  27628. </summary>
  27629. <value>
  27630. The internal collection used to store the properties
  27631. </value>
  27632. <remarks>
  27633. <para>
  27634. The hashtable used to store the properties
  27635. </para>
  27636. </remarks>
  27637. </member>
  27638. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  27639. <summary>
  27640. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  27641. </summary>
  27642. </member>
  27643. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#$Item$(System.Object)">
  27644. <summary>
  27645. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  27646. </summary>
  27647. </member>
  27648. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
  27649. <summary>
  27650. See <see cref="P:System.Collections.IDictionary.Values"/>
  27651. </summary>
  27652. </member>
  27653. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
  27654. <summary>
  27655. See <see cref="P:System.Collections.IDictionary.Keys"/>
  27656. </summary>
  27657. </member>
  27658. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  27659. <summary>
  27660. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  27661. </summary>
  27662. </member>
  27663. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  27664. <summary>
  27665. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  27666. </summary>
  27667. </member>
  27668. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
  27669. <summary>
  27670. The number of properties in this collection
  27671. </summary>
  27672. </member>
  27673. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
  27674. <summary>
  27675. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  27676. </summary>
  27677. </member>
  27678. <member name="M:log4net.Util.PropertiesDictionary.#ctor">
  27679. <summary>
  27680. Constructor
  27681. </summary>
  27682. <remarks>
  27683. <para>
  27684. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
  27685. </para>
  27686. </remarks>
  27687. </member>
  27688. <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  27689. <summary>
  27690. Constructor
  27691. </summary>
  27692. <param name="propertiesDictionary">properties to copy</param>
  27693. <remarks>
  27694. <para>
  27695. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class.
  27696. </para>
  27697. </remarks>
  27698. </member>
  27699. <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27700. <summary>
  27701. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary"/> class
  27702. with serialized data.
  27703. </summary>
  27704. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
  27705. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  27706. <remarks>
  27707. <para>
  27708. Because this class is sealed the serialization constructor is private.
  27709. </para>
  27710. </remarks>
  27711. </member>
  27712. <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
  27713. <summary>
  27714. Remove the entry with the specified key from this dictionary
  27715. </summary>
  27716. <param name="key">the key for the entry to remove</param>
  27717. <remarks>
  27718. <para>
  27719. Remove the entry with the specified key from this dictionary
  27720. </para>
  27721. </remarks>
  27722. </member>
  27723. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  27724. <summary>
  27725. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  27726. </summary>
  27727. <returns>an enumerator</returns>
  27728. <remarks>
  27729. <para>
  27730. Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
  27731. </para>
  27732. </remarks>
  27733. </member>
  27734. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  27735. <summary>
  27736. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  27737. </summary>
  27738. <param name="key">the key to remove</param>
  27739. <remarks>
  27740. <para>
  27741. Remove the entry with the specified key from this dictionary
  27742. </para>
  27743. </remarks>
  27744. </member>
  27745. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  27746. <summary>
  27747. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  27748. </summary>
  27749. <param name="key">the key to lookup in the collection</param>
  27750. <returns><c>true</c> if the collection contains the specified key</returns>
  27751. <remarks>
  27752. <para>
  27753. Test if this collection contains a specified key.
  27754. </para>
  27755. </remarks>
  27756. </member>
  27757. <member name="M:log4net.Util.PropertiesDictionary.Clear">
  27758. <summary>
  27759. Remove all properties from the properties collection
  27760. </summary>
  27761. <remarks>
  27762. <para>
  27763. Remove all properties from the properties collection
  27764. </para>
  27765. </remarks>
  27766. </member>
  27767. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  27768. <summary>
  27769. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  27770. </summary>
  27771. <param name="key">the key</param>
  27772. <param name="value">the value to store for the key</param>
  27773. <remarks>
  27774. <para>
  27775. Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  27776. </para>
  27777. </remarks>
  27778. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  27779. </member>
  27780. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  27781. <summary>
  27782. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  27783. </summary>
  27784. <param name="array"></param>
  27785. <param name="index"></param>
  27786. </member>
  27787. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  27788. <summary>
  27789. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  27790. </summary>
  27791. </member>
  27792. <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
  27793. <summary>
  27794. Gets or sets the value of the property with the specified key.
  27795. </summary>
  27796. <value>
  27797. The value of the property with the specified key.
  27798. </value>
  27799. <param name="key">The key of the property to get or set.</param>
  27800. <remarks>
  27801. <para>
  27802. The property value will only be serialized if it is serializable.
  27803. If it cannot be serialized it will be silently ignored if
  27804. a serialization operation is performed.
  27805. </para>
  27806. </remarks>
  27807. </member>
  27808. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  27809. <summary>
  27810. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  27811. </summary>
  27812. <value>
  27813. <c>false</c>
  27814. </value>
  27815. <remarks>
  27816. <para>
  27817. This collection is modifiable. This property always
  27818. returns <c>false</c>.
  27819. </para>
  27820. </remarks>
  27821. </member>
  27822. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#$Item$(System.Object)">
  27823. <summary>
  27824. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  27825. </summary>
  27826. <value>
  27827. The value for the key specified.
  27828. </value>
  27829. <remarks>
  27830. <para>
  27831. Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  27832. </para>
  27833. </remarks>
  27834. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  27835. </member>
  27836. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
  27837. <summary>
  27838. See <see cref="P:System.Collections.IDictionary.Values"/>
  27839. </summary>
  27840. </member>
  27841. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
  27842. <summary>
  27843. See <see cref="P:System.Collections.IDictionary.Keys"/>
  27844. </summary>
  27845. </member>
  27846. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  27847. <summary>
  27848. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  27849. </summary>
  27850. </member>
  27851. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  27852. <summary>
  27853. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  27854. </summary>
  27855. </member>
  27856. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
  27857. <summary>
  27858. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  27859. </summary>
  27860. </member>
  27861. <member name="T:log4net.Util.PropertyEntry">
  27862. <summary>
  27863. A class to hold the key and data for a property set in the config file
  27864. </summary>
  27865. <remarks>
  27866. <para>
  27867. A class to hold the key and data for a property set in the config file
  27868. </para>
  27869. </remarks>
  27870. </member>
  27871. <member name="M:log4net.Util.PropertyEntry.ToString">
  27872. <summary>
  27873. Override <c>Object.ToString</c> to return sensible debug info
  27874. </summary>
  27875. <returns>string info about this object</returns>
  27876. </member>
  27877. <member name="P:log4net.Util.PropertyEntry.Key">
  27878. <summary>
  27879. Property Key
  27880. </summary>
  27881. <value>
  27882. Property Key
  27883. </value>
  27884. <remarks>
  27885. <para>
  27886. Property Key.
  27887. </para>
  27888. </remarks>
  27889. </member>
  27890. <member name="P:log4net.Util.PropertyEntry.Value">
  27891. <summary>
  27892. Property Value
  27893. </summary>
  27894. <value>
  27895. Property Value
  27896. </value>
  27897. <remarks>
  27898. <para>
  27899. Property Value.
  27900. </para>
  27901. </remarks>
  27902. </member>
  27903. <member name="T:log4net.Util.ProtectCloseTextWriter">
  27904. <summary>
  27905. A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
  27906. </summary>
  27907. <remarks>
  27908. <para>
  27909. This writer is used in special cases where it is necessary
  27910. to protect a writer from being closed by a client.
  27911. </para>
  27912. </remarks>
  27913. <author>Nicko Cadell</author>
  27914. </member>
  27915. <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
  27916. <summary>
  27917. Constructor
  27918. </summary>
  27919. <param name="writer">the writer to actually write to</param>
  27920. <remarks>
  27921. <para>
  27922. Create a new ProtectCloseTextWriter using a writer
  27923. </para>
  27924. </remarks>
  27925. </member>
  27926. <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
  27927. <summary>
  27928. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  27929. </summary>
  27930. <param name="writer">the writer to attach to</param>
  27931. <remarks>
  27932. <para>
  27933. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  27934. </para>
  27935. </remarks>
  27936. </member>
  27937. <member name="M:log4net.Util.ProtectCloseTextWriter.Close">
  27938. <summary>
  27939. Does not close the underlying output writer.
  27940. </summary>
  27941. <remarks>
  27942. <para>
  27943. Does not close the underlying output writer.
  27944. This method does nothing.
  27945. </para>
  27946. </remarks>
  27947. </member>
  27948. <member name="T:log4net.Util.ReaderWriterLock">
  27949. <summary>
  27950. Defines a lock that supports single writers and multiple readers
  27951. </summary>
  27952. <remarks>
  27953. <para>
  27954. <c>ReaderWriterLock</c> is used to synchronize access to a resource.
  27955. At any given time, it allows either concurrent read access for
  27956. multiple threads, or write access for a single thread. In a
  27957. situation where a resource is changed infrequently, a
  27958. <c>ReaderWriterLock</c> provides better throughput than a simple
  27959. one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
  27960. </para>
  27961. <para>
  27962. If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
  27963. implementation then all readers and writers are serialized. Therefore
  27964. the caller must not rely on multiple simultaneous readers.
  27965. </para>
  27966. </remarks>
  27967. <author>Nicko Cadell</author>
  27968. </member>
  27969. <member name="M:log4net.Util.ReaderWriterLock.#ctor">
  27970. <summary>
  27971. Constructor
  27972. </summary>
  27973. <remarks>
  27974. <para>
  27975. Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock"/> class.
  27976. </para>
  27977. </remarks>
  27978. </member>
  27979. <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
  27980. <summary>
  27981. Acquires a reader lock
  27982. </summary>
  27983. <remarks>
  27984. <para>
  27985. <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
  27986. lock, or if at least one thread is waiting for the writer lock.
  27987. </para>
  27988. </remarks>
  27989. </member>
  27990. <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
  27991. <summary>
  27992. Decrements the lock count
  27993. </summary>
  27994. <remarks>
  27995. <para>
  27996. <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
  27997. reaches zero, the lock is released.
  27998. </para>
  27999. </remarks>
  28000. </member>
  28001. <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
  28002. <summary>
  28003. Acquires the writer lock
  28004. </summary>
  28005. <remarks>
  28006. <para>
  28007. This method blocks if another thread has a reader lock or writer lock.
  28008. </para>
  28009. </remarks>
  28010. </member>
  28011. <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
  28012. <summary>
  28013. Decrements the lock count on the writer lock
  28014. </summary>
  28015. <remarks>
  28016. <para>
  28017. ReleaseWriterLock decrements the writer lock count.
  28018. When the count reaches zero, the writer lock is released.
  28019. </para>
  28020. </remarks>
  28021. </member>
  28022. <member name="T:log4net.Util.ReusableStringWriter">
  28023. <summary>
  28024. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
  28025. </summary>
  28026. <remarks>
  28027. <para>
  28028. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
  28029. This uses a single buffer for string operations.
  28030. </para>
  28031. </remarks>
  28032. <author>Nicko Cadell</author>
  28033. </member>
  28034. <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
  28035. <summary>
  28036. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  28037. </summary>
  28038. <param name="formatProvider">the format provider to use</param>
  28039. <remarks>
  28040. <para>
  28041. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  28042. </para>
  28043. </remarks>
  28044. </member>
  28045. <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
  28046. <summary>
  28047. Override Dispose to prevent closing of writer
  28048. </summary>
  28049. <param name="disposing">flag</param>
  28050. <remarks>
  28051. <para>
  28052. Override Dispose to prevent closing of writer
  28053. </para>
  28054. </remarks>
  28055. </member>
  28056. <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
  28057. <summary>
  28058. Reset this string writer so that it can be reused.
  28059. </summary>
  28060. <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
  28061. <param name="defaultSize">the default size to make the buffer</param>
  28062. <remarks>
  28063. <para>
  28064. Reset this string writer so that it can be reused.
  28065. The internal buffers are cleared and reset.
  28066. </para>
  28067. </remarks>
  28068. </member>
  28069. <member name="T:log4net.Util.SystemInfo">
  28070. <summary>
  28071. Utility class for system specific information.
  28072. </summary>
  28073. <remarks>
  28074. <para>
  28075. Utility class of static methods for system specific information.
  28076. </para>
  28077. </remarks>
  28078. <author>Nicko Cadell</author>
  28079. <author>Gert Driesen</author>
  28080. <author>Alexey Solofnenko</author>
  28081. </member>
  28082. <member name="M:log4net.Util.SystemInfo.#ctor">
  28083. <summary>
  28084. Private constructor to prevent instances.
  28085. </summary>
  28086. <remarks>
  28087. <para>
  28088. Only static methods are exposed from this type.
  28089. </para>
  28090. </remarks>
  28091. </member>
  28092. <member name="M:log4net.Util.SystemInfo.#cctor">
  28093. <summary>
  28094. Initialize default values for private static fields.
  28095. </summary>
  28096. <remarks>
  28097. <para>
  28098. Only static methods are exposed from this type.
  28099. </para>
  28100. </remarks>
  28101. </member>
  28102. <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
  28103. <summary>
  28104. Gets the assembly location path for the specified assembly.
  28105. </summary>
  28106. <param name="myAssembly">The assembly to get the location for.</param>
  28107. <returns>The location of the assembly.</returns>
  28108. <remarks>
  28109. <para>
  28110. This method does not guarantee to return the correct path
  28111. to the assembly. If only tries to give an indication as to
  28112. where the assembly was loaded from.
  28113. </para>
  28114. </remarks>
  28115. </member>
  28116. <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
  28117. <summary>
  28118. Gets the fully qualified name of the <see cref="T:System.Type"/>, including
  28119. the name of the assembly from which the <see cref="T:System.Type"/> was
  28120. loaded.
  28121. </summary>
  28122. <param name="type">The <see cref="T:System.Type"/> to get the fully qualified name for.</param>
  28123. <returns>The fully qualified name for the <see cref="T:System.Type"/>.</returns>
  28124. <remarks>
  28125. <para>
  28126. This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
  28127. but this method works on the .NET Compact Framework 1.0 as well as
  28128. the full .NET runtime.
  28129. </para>
  28130. </remarks>
  28131. </member>
  28132. <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
  28133. <summary>
  28134. Gets the short name of the <see cref="T:System.Reflection.Assembly"/>.
  28135. </summary>
  28136. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the name for.</param>
  28137. <returns>The short name of the <see cref="T:System.Reflection.Assembly"/>.</returns>
  28138. <remarks>
  28139. <para>
  28140. The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName"/>
  28141. without the version, culture, or public key. i.e. it is just the
  28142. assembly's file name without the extension.
  28143. </para>
  28144. <para>
  28145. Use this rather than <c>Assembly.GetName().Name</c> because that
  28146. is not available on the Compact Framework.
  28147. </para>
  28148. <para>
  28149. Because of a FileIOPermission security demand we cannot do
  28150. the obvious Assembly.GetName().Name. We are allowed to get
  28151. the <see cref="P:System.Reflection.Assembly.FullName"/> of the assembly so we
  28152. start from there and strip out just the assembly name.
  28153. </para>
  28154. </remarks>
  28155. </member>
  28156. <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
  28157. <summary>
  28158. Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
  28159. </summary>
  28160. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly"/> to get the file name for.</param>
  28161. <returns>The file name of the assembly.</returns>
  28162. <remarks>
  28163. <para>
  28164. Gets the file name portion of the <see cref="T:System.Reflection.Assembly"/>, including the extension.
  28165. </para>
  28166. </remarks>
  28167. </member>
  28168. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
  28169. <summary>
  28170. Loads the type specified in the type string.
  28171. </summary>
  28172. <param name="relativeType">A sibling type to use to load the type.</param>
  28173. <param name="typeName">The name of the type to load.</param>
  28174. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  28175. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  28176. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  28177. <remarks>
  28178. <para>
  28179. If the type name is fully qualified, i.e. if contains an assembly name in
  28180. the type name, the type will be loaded from the system using
  28181. <see cref="M:Type.GetType(string,bool)"/>.
  28182. </para>
  28183. <para>
  28184. If the type name is not fully qualified, it will be loaded from the assembly
  28185. containing the specified relative type. If the type is not found in the assembly
  28186. then all the loaded assemblies will be searched for the type.
  28187. </para>
  28188. </remarks>
  28189. </member>
  28190. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.String,System.Boolean,System.Boolean)">
  28191. <summary>
  28192. Loads the type specified in the type string.
  28193. </summary>
  28194. <param name="typeName">The name of the type to load.</param>
  28195. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  28196. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  28197. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  28198. <remarks>
  28199. <para>
  28200. If the type name is fully qualified, i.e. if contains an assembly name in
  28201. the type name, the type will be loaded from the system using
  28202. <see cref="M:Type.GetType(string,bool)"/>.
  28203. </para>
  28204. <para>
  28205. If the type name is not fully qualified it will be loaded from the
  28206. assembly that is directly calling this method. If the type is not found
  28207. in the assembly then all the loaded assemblies will be searched for the type.
  28208. </para>
  28209. </remarks>
  28210. </member>
  28211. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
  28212. <summary>
  28213. Loads the type specified in the type string.
  28214. </summary>
  28215. <param name="relativeAssembly">An assembly to load the type from.</param>
  28216. <param name="typeName">The name of the type to load.</param>
  28217. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  28218. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  28219. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  28220. <remarks>
  28221. <para>
  28222. If the type name is fully qualified, i.e. if contains an assembly name in
  28223. the type name, the type will be loaded from the system using
  28224. <see cref="M:Type.GetType(string,bool)"/>.
  28225. </para>
  28226. <para>
  28227. If the type name is not fully qualified it will be loaded from the specified
  28228. assembly. If the type is not found in the assembly then all the loaded assemblies
  28229. will be searched for the type.
  28230. </para>
  28231. </remarks>
  28232. </member>
  28233. <member name="M:log4net.Util.SystemInfo.NewGuid">
  28234. <summary>
  28235. Generate a new guid
  28236. </summary>
  28237. <returns>A new Guid</returns>
  28238. <remarks>
  28239. <para>
  28240. Generate a new guid
  28241. </para>
  28242. </remarks>
  28243. </member>
  28244. <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
  28245. <summary>
  28246. Create an <see cref="T:System.ArgumentOutOfRangeException"/>
  28247. </summary>
  28248. <param name="parameterName">The name of the parameter that caused the exception</param>
  28249. <param name="actualValue">The value of the argument that causes this exception</param>
  28250. <param name="message">The message that describes the error</param>
  28251. <returns>the ArgumentOutOfRangeException object</returns>
  28252. <remarks>
  28253. <para>
  28254. Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
  28255. with a specified error message, the parameter name, and the value
  28256. of the argument.
  28257. </para>
  28258. <para>
  28259. The Compact Framework does not support the 3 parameter constructor for the
  28260. <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
  28261. implementation that works for all platforms.
  28262. </para>
  28263. </remarks>
  28264. </member>
  28265. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
  28266. <summary>
  28267. Parse a string into an <see cref="T:System.Int32"/> value
  28268. </summary>
  28269. <param name="s">the string to parse</param>
  28270. <param name="val">out param where the parsed value is placed</param>
  28271. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28272. <remarks>
  28273. <para>
  28274. Attempts to parse the string into an integer. If the string cannot
  28275. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28276. </para>
  28277. </remarks>
  28278. </member>
  28279. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
  28280. <summary>
  28281. Parse a string into an <see cref="T:System.Int64"/> value
  28282. </summary>
  28283. <param name="s">the string to parse</param>
  28284. <param name="val">out param where the parsed value is placed</param>
  28285. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28286. <remarks>
  28287. <para>
  28288. Attempts to parse the string into an integer. If the string cannot
  28289. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28290. </para>
  28291. </remarks>
  28292. </member>
  28293. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
  28294. <summary>
  28295. Parse a string into an <see cref="T:System.Int16"/> value
  28296. </summary>
  28297. <param name="s">the string to parse</param>
  28298. <param name="val">out param where the parsed value is placed</param>
  28299. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28300. <remarks>
  28301. <para>
  28302. Attempts to parse the string into an integer. If the string cannot
  28303. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28304. </para>
  28305. </remarks>
  28306. </member>
  28307. <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
  28308. <summary>
  28309. Lookup an application setting
  28310. </summary>
  28311. <param name="key">the application settings key to lookup</param>
  28312. <returns>the value for the key, or <c>null</c></returns>
  28313. <remarks>
  28314. <para>
  28315. Configuration APIs are not supported under the Compact Framework
  28316. </para>
  28317. </remarks>
  28318. </member>
  28319. <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
  28320. <summary>
  28321. Convert a path into a fully qualified local file path.
  28322. </summary>
  28323. <param name="path">The path to convert.</param>
  28324. <returns>The fully qualified path.</returns>
  28325. <remarks>
  28326. <para>
  28327. Converts the path specified to a fully
  28328. qualified path. If the path is relative it is
  28329. taken as relative from the application base
  28330. directory.
  28331. </para>
  28332. <para>
  28333. The path specified must be a local file path, a URI is not supported.
  28334. </para>
  28335. </remarks>
  28336. </member>
  28337. <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
  28338. <summary>
  28339. Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
  28340. </summary>
  28341. <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
  28342. <remarks>
  28343. <para>
  28344. The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
  28345. </para>
  28346. </remarks>
  28347. </member>
  28348. <member name="F:log4net.Util.SystemInfo.EmptyTypes">
  28349. <summary>
  28350. Gets an empty array of types.
  28351. </summary>
  28352. <remarks>
  28353. <para>
  28354. The <c>Type.EmptyTypes</c> field is not available on
  28355. the .NET Compact Framework 1.0.
  28356. </para>
  28357. </remarks>
  28358. </member>
  28359. <member name="F:log4net.Util.SystemInfo.declaringType">
  28360. <summary>
  28361. The fully qualified type of the SystemInfo class.
  28362. </summary>
  28363. <remarks>
  28364. Used by the internal logger to record the Type of the
  28365. log message.
  28366. </remarks>
  28367. </member>
  28368. <member name="F:log4net.Util.SystemInfo.s_hostName">
  28369. <summary>
  28370. Cache the host name for the current machine
  28371. </summary>
  28372. </member>
  28373. <member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
  28374. <summary>
  28375. Cache the application friendly name
  28376. </summary>
  28377. </member>
  28378. <member name="F:log4net.Util.SystemInfo.s_nullText">
  28379. <summary>
  28380. Text to output when a <c>null</c> is encountered.
  28381. </summary>
  28382. </member>
  28383. <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
  28384. <summary>
  28385. Text to output when an unsupported feature is requested.
  28386. </summary>
  28387. </member>
  28388. <member name="F:log4net.Util.SystemInfo.s_processStartTime">
  28389. <summary>
  28390. Start time for the current process.
  28391. </summary>
  28392. </member>
  28393. <member name="P:log4net.Util.SystemInfo.NewLine">
  28394. <summary>
  28395. Gets the system dependent line terminator.
  28396. </summary>
  28397. <value>
  28398. The system dependent line terminator.
  28399. </value>
  28400. <remarks>
  28401. <para>
  28402. Gets the system dependent line terminator.
  28403. </para>
  28404. </remarks>
  28405. </member>
  28406. <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
  28407. <summary>
  28408. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  28409. </summary>
  28410. <value>The base directory path for the current <see cref="T:System.AppDomain"/>.</value>
  28411. <remarks>
  28412. <para>
  28413. Gets the base directory for this <see cref="T:System.AppDomain"/>.
  28414. </para>
  28415. <para>
  28416. The value returned may be either a local file path or a URI.
  28417. </para>
  28418. </remarks>
  28419. </member>
  28420. <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
  28421. <summary>
  28422. Gets the path to the configuration file for the current <see cref="T:System.AppDomain"/>.
  28423. </summary>
  28424. <value>The path to the configuration file for the current <see cref="T:System.AppDomain"/>.</value>
  28425. <remarks>
  28426. <para>
  28427. The .NET Compact Framework 1.0 does not have a concept of a configuration
  28428. file. For this runtime, we use the entry assembly location as the root for
  28429. the configuration file name.
  28430. </para>
  28431. <para>
  28432. The value returned may be either a local file path or a URI.
  28433. </para>
  28434. </remarks>
  28435. </member>
  28436. <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
  28437. <summary>
  28438. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  28439. </summary>
  28440. <value>The path to the entry assembly.</value>
  28441. <remarks>
  28442. <para>
  28443. Gets the path to the file that first executed in the current <see cref="T:System.AppDomain"/>.
  28444. </para>
  28445. </remarks>
  28446. </member>
  28447. <member name="P:log4net.Util.SystemInfo.CurrentThreadId">
  28448. <summary>
  28449. Gets the ID of the current thread.
  28450. </summary>
  28451. <value>The ID of the current thread.</value>
  28452. <remarks>
  28453. <para>
  28454. On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
  28455. is used to obtain the thread ID for the current thread. This is the
  28456. operating system ID for the thread.
  28457. </para>
  28458. <para>
  28459. On the .NET Compact Framework 1.0 it is not possible to get the
  28460. operating system thread ID for the current thread. The native method
  28461. <c>GetCurrentThreadId</c> is implemented inline in a header file
  28462. and cannot be called.
  28463. </para>
  28464. <para>
  28465. On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
  28466. gives a stable id unrelated to the operating system thread ID which may
  28467. change if the runtime is using fibers.
  28468. </para>
  28469. </remarks>
  28470. </member>
  28471. <member name="P:log4net.Util.SystemInfo.HostName">
  28472. <summary>
  28473. Get the host name or machine name for the current machine
  28474. </summary>
  28475. <value>
  28476. The hostname or machine name
  28477. </value>
  28478. <remarks>
  28479. <para>
  28480. Get the host name or machine name for the current machine
  28481. </para>
  28482. <para>
  28483. The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
  28484. the machine name (<c>Environment.MachineName</c>) for
  28485. the current machine, or if neither of these are available
  28486. then <c>NOT AVAILABLE</c> is returned.
  28487. </para>
  28488. </remarks>
  28489. </member>
  28490. <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
  28491. <summary>
  28492. Get this application's friendly name
  28493. </summary>
  28494. <value>
  28495. The friendly name of this application as a string
  28496. </value>
  28497. <remarks>
  28498. <para>
  28499. If available the name of the application is retrieved from
  28500. the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
  28501. </para>
  28502. <para>
  28503. Otherwise the file name of the entry assembly is used.
  28504. </para>
  28505. </remarks>
  28506. </member>
  28507. <member name="P:log4net.Util.SystemInfo.ProcessStartTime">
  28508. <summary>
  28509. Get the start time for the current process.
  28510. </summary>
  28511. <remarks>
  28512. <para>
  28513. This is the time at which the log4net library was loaded into the
  28514. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  28515. this is not the start time for the current process.
  28516. </para>
  28517. <para>
  28518. The log4net library should be loaded by an application early during its
  28519. startup, therefore this start time should be a good approximation for
  28520. the actual start time.
  28521. </para>
  28522. <para>
  28523. Note that AppDomains may be loaded and unloaded within the
  28524. same process without the process terminating, however this start time
  28525. will be set per AppDomain.
  28526. </para>
  28527. </remarks>
  28528. </member>
  28529. <member name="P:log4net.Util.SystemInfo.NullText">
  28530. <summary>
  28531. Text to output when a <c>null</c> is encountered.
  28532. </summary>
  28533. <remarks>
  28534. <para>
  28535. Use this value to indicate a <c>null</c> has been encountered while
  28536. outputting a string representation of an item.
  28537. </para>
  28538. <para>
  28539. The default value is <c>(null)</c>. This value can be overridden by specifying
  28540. a value for the <c>log4net.NullText</c> appSetting in the application's
  28541. .config file.
  28542. </para>
  28543. </remarks>
  28544. </member>
  28545. <member name="P:log4net.Util.SystemInfo.NotAvailableText">
  28546. <summary>
  28547. Text to output when an unsupported feature is requested.
  28548. </summary>
  28549. <remarks>
  28550. <para>
  28551. Use this value when an unsupported feature is requested.
  28552. </para>
  28553. <para>
  28554. The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
  28555. a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
  28556. .config file.
  28557. </para>
  28558. </remarks>
  28559. </member>
  28560. <member name="T:log4net.Util.SystemStringFormat">
  28561. <summary>
  28562. Utility class that represents a format string.
  28563. </summary>
  28564. <remarks>
  28565. <para>
  28566. Utility class that represents a format string.
  28567. </para>
  28568. </remarks>
  28569. <author>Nicko Cadell</author>
  28570. </member>
  28571. <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
  28572. <summary>
  28573. Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
  28574. </summary>
  28575. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  28576. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  28577. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  28578. </member>
  28579. <member name="M:log4net.Util.SystemStringFormat.ToString">
  28580. <summary>
  28581. Format the string and arguments
  28582. </summary>
  28583. <returns>the formatted string</returns>
  28584. </member>
  28585. <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  28586. <summary>
  28587. Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
  28588. of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
  28589. A specified parameter supplies culture-specific formatting information.
  28590. </summary>
  28591. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  28592. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  28593. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  28594. <returns>
  28595. A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
  28596. equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
  28597. </returns>
  28598. <remarks>
  28599. <para>
  28600. This method does not throw exceptions. If an exception thrown while formatting the result the
  28601. exception and arguments are returned in the result string.
  28602. </para>
  28603. </remarks>
  28604. </member>
  28605. <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
  28606. <summary>
  28607. Process an error during StringFormat
  28608. </summary>
  28609. </member>
  28610. <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
  28611. <summary>
  28612. Dump the contents of an array into a string builder
  28613. </summary>
  28614. </member>
  28615. <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
  28616. <summary>
  28617. Dump an object to a string
  28618. </summary>
  28619. </member>
  28620. <member name="F:log4net.Util.SystemStringFormat.declaringType">
  28621. <summary>
  28622. The fully qualified type of the SystemStringFormat class.
  28623. </summary>
  28624. <remarks>
  28625. Used by the internal logger to record the Type of the
  28626. log message.
  28627. </remarks>
  28628. </member>
  28629. <member name="T:log4net.Util.ThreadContextProperties">
  28630. <summary>
  28631. Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
  28632. </summary>
  28633. <remarks>
  28634. <para>
  28635. Class implements a collection of properties that is specific to each thread.
  28636. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  28637. </para>
  28638. </remarks>
  28639. <author>Nicko Cadell</author>
  28640. </member>
  28641. <member name="F:log4net.Util.ThreadContextProperties._dictionary">
  28642. <summary>
  28643. Each thread will automatically have its instance.
  28644. </summary>
  28645. </member>
  28646. <member name="M:log4net.Util.ThreadContextProperties.#ctor">
  28647. <summary>
  28648. Internal constructor
  28649. </summary>
  28650. <remarks>
  28651. <para>
  28652. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties"/> class.
  28653. </para>
  28654. </remarks>
  28655. </member>
  28656. <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
  28657. <summary>
  28658. Remove a property
  28659. </summary>
  28660. <param name="key">the key for the entry to remove</param>
  28661. <remarks>
  28662. <para>
  28663. Remove a property
  28664. </para>
  28665. </remarks>
  28666. </member>
  28667. <member name="M:log4net.Util.ThreadContextProperties.GetKeys">
  28668. <summary>
  28669. Get the keys stored in the properties.
  28670. </summary>
  28671. <para>
  28672. Gets the keys stored in the properties.
  28673. </para>
  28674. <returns>a set of the defined keys</returns>
  28675. </member>
  28676. <member name="M:log4net.Util.ThreadContextProperties.Clear">
  28677. <summary>
  28678. Clear all properties
  28679. </summary>
  28680. <remarks>
  28681. <para>
  28682. Clear all properties
  28683. </para>
  28684. </remarks>
  28685. </member>
  28686. <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
  28687. <summary>
  28688. Get the <c>PropertiesDictionary</c> for this thread.
  28689. </summary>
  28690. <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
  28691. <returns>the properties for this thread</returns>
  28692. <remarks>
  28693. <para>
  28694. The collection returned is only to be used on the calling thread. If the
  28695. caller needs to share the collection between different threads then the
  28696. caller must clone the collection before doing so.
  28697. </para>
  28698. </remarks>
  28699. </member>
  28700. <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
  28701. <summary>
  28702. Gets or sets the value of a property
  28703. </summary>
  28704. <value>
  28705. The value for the property with the specified key
  28706. </value>
  28707. <remarks>
  28708. <para>
  28709. Gets or sets the value of a property
  28710. </para>
  28711. </remarks>
  28712. </member>
  28713. <member name="T:log4net.Util.ThreadContextStack">
  28714. <summary>
  28715. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  28716. </summary>
  28717. <remarks>
  28718. <para>
  28719. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  28720. </para>
  28721. </remarks>
  28722. <author>Nicko Cadell</author>
  28723. </member>
  28724. <member name="F:log4net.Util.ThreadContextStack.m_stack">
  28725. <summary>
  28726. The stack store.
  28727. </summary>
  28728. </member>
  28729. <member name="M:log4net.Util.ThreadContextStack.#ctor">
  28730. <summary>
  28731. Internal constructor
  28732. </summary>
  28733. <remarks>
  28734. <para>
  28735. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack"/> class.
  28736. </para>
  28737. </remarks>
  28738. </member>
  28739. <member name="M:log4net.Util.ThreadContextStack.Clear">
  28740. <summary>
  28741. Clears all the contextual information held in this stack.
  28742. </summary>
  28743. <remarks>
  28744. <para>
  28745. Clears all the contextual information held in this stack.
  28746. Only call this if you think that this tread is being reused after
  28747. a previous call execution which may not have completed correctly.
  28748. You do not need to use this method if you always guarantee to call
  28749. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  28750. returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  28751. for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  28752. syntax.
  28753. </para>
  28754. </remarks>
  28755. </member>
  28756. <member name="M:log4net.Util.ThreadContextStack.Pop">
  28757. <summary>
  28758. Removes the top context from this stack.
  28759. </summary>
  28760. <returns>The message in the context that was removed from the top of this stack.</returns>
  28761. <remarks>
  28762. <para>
  28763. Remove the top context from this stack, and return
  28764. it to the caller. If this stack is empty then an
  28765. empty string (not <see langword="null"/>) is returned.
  28766. </para>
  28767. </remarks>
  28768. </member>
  28769. <member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
  28770. <summary>
  28771. Pushes a new context message into this stack.
  28772. </summary>
  28773. <param name="message">The new context message.</param>
  28774. <returns>
  28775. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  28776. </returns>
  28777. <remarks>
  28778. <para>
  28779. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  28780. is returned that can be used to clean up this stack. This
  28781. can be easily combined with the <c>using</c> keyword to scope the
  28782. context.
  28783. </para>
  28784. </remarks>
  28785. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  28786. <code lang="C#">
  28787. using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
  28788. {
  28789. log.Warn("This should have an ThreadContext Stack message");
  28790. }
  28791. </code>
  28792. </example>
  28793. </member>
  28794. <member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
  28795. <summary>
  28796. Gets the current context information for this stack.
  28797. </summary>
  28798. <returns>The current context information.</returns>
  28799. </member>
  28800. <member name="M:log4net.Util.ThreadContextStack.ToString">
  28801. <summary>
  28802. Gets the current context information for this stack.
  28803. </summary>
  28804. <returns>Gets the current context information</returns>
  28805. <remarks>
  28806. <para>
  28807. Gets the current context information for this stack.
  28808. </para>
  28809. </remarks>
  28810. </member>
  28811. <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  28812. <summary>
  28813. Get a portable version of this object
  28814. </summary>
  28815. <returns>the portable instance of this object</returns>
  28816. <remarks>
  28817. <para>
  28818. Get a cross thread portable version of this object
  28819. </para>
  28820. </remarks>
  28821. </member>
  28822. <member name="P:log4net.Util.ThreadContextStack.Count">
  28823. <summary>
  28824. The number of messages in the stack
  28825. </summary>
  28826. <value>
  28827. The current number of messages in the stack
  28828. </value>
  28829. <remarks>
  28830. <para>
  28831. The current number of messages in the stack. That is
  28832. the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
  28833. minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
  28834. </para>
  28835. </remarks>
  28836. </member>
  28837. <member name="P:log4net.Util.ThreadContextStack.InternalStack">
  28838. <summary>
  28839. Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
  28840. </summary>
  28841. <value>The internal storage stack</value>
  28842. <remarks>
  28843. <para>
  28844. This property is provided only to support backward compatability
  28845. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  28846. be modified.
  28847. </para>
  28848. </remarks>
  28849. </member>
  28850. <member name="T:log4net.Util.ThreadContextStack.StackFrame">
  28851. <summary>
  28852. Inner class used to represent a single context frame in the stack.
  28853. </summary>
  28854. <remarks>
  28855. <para>
  28856. Inner class used to represent a single context frame in the stack.
  28857. </para>
  28858. </remarks>
  28859. </member>
  28860. <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
  28861. <summary>
  28862. Constructor
  28863. </summary>
  28864. <param name="message">The message for this context.</param>
  28865. <param name="parent">The parent context in the chain.</param>
  28866. <remarks>
  28867. <para>
  28868. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame"/> class
  28869. with the specified message and parent context.
  28870. </para>
  28871. </remarks>
  28872. </member>
  28873. <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
  28874. <summary>
  28875. Get the message.
  28876. </summary>
  28877. <value>The message.</value>
  28878. <remarks>
  28879. <para>
  28880. Get the message.
  28881. </para>
  28882. </remarks>
  28883. </member>
  28884. <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
  28885. <summary>
  28886. Gets the full text of the context down to the root level.
  28887. </summary>
  28888. <value>
  28889. The full text of the context down to the root level.
  28890. </value>
  28891. <remarks>
  28892. <para>
  28893. Gets the full text of the context down to the root level.
  28894. </para>
  28895. </remarks>
  28896. </member>
  28897. <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
  28898. <summary>
  28899. Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
  28900. </summary>
  28901. <remarks>
  28902. <para>
  28903. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  28904. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  28905. </para>
  28906. </remarks>
  28907. </member>
  28908. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
  28909. <summary>
  28910. The ThreadContextStack internal stack
  28911. </summary>
  28912. </member>
  28913. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
  28914. <summary>
  28915. The depth to trim the stack to when this instance is disposed
  28916. </summary>
  28917. </member>
  28918. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
  28919. <summary>
  28920. Constructor
  28921. </summary>
  28922. <param name="frameStack">The internal stack used by the ThreadContextStack.</param>
  28923. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  28924. <remarks>
  28925. <para>
  28926. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame"/> class with
  28927. the specified stack and return depth.
  28928. </para>
  28929. </remarks>
  28930. </member>
  28931. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
  28932. <summary>
  28933. Returns the stack to the correct depth.
  28934. </summary>
  28935. <remarks>
  28936. <para>
  28937. Returns the stack to the correct depth.
  28938. </para>
  28939. </remarks>
  28940. </member>
  28941. <member name="T:log4net.Util.ThreadContextStacks">
  28942. <summary>
  28943. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  28944. </summary>
  28945. <remarks>
  28946. <para>
  28947. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  28948. </para>
  28949. </remarks>
  28950. <author>Nicko Cadell</author>
  28951. </member>
  28952. <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
  28953. <summary>
  28954. Internal constructor
  28955. </summary>
  28956. <remarks>
  28957. <para>
  28958. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks"/> class.
  28959. </para>
  28960. </remarks>
  28961. </member>
  28962. <member name="F:log4net.Util.ThreadContextStacks.declaringType">
  28963. <summary>
  28964. The fully qualified type of the ThreadContextStacks class.
  28965. </summary>
  28966. <remarks>
  28967. Used by the internal logger to record the Type of the
  28968. log message.
  28969. </remarks>
  28970. </member>
  28971. <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
  28972. <summary>
  28973. Gets the named thread context stack
  28974. </summary>
  28975. <value>
  28976. The named stack
  28977. </value>
  28978. <remarks>
  28979. <para>
  28980. Gets the named thread context stack
  28981. </para>
  28982. </remarks>
  28983. </member>
  28984. <member name="T:log4net.Util.Transform">
  28985. <summary>
  28986. Utility class for transforming strings.
  28987. </summary>
  28988. <remarks>
  28989. <para>
  28990. Utility class for transforming strings.
  28991. </para>
  28992. </remarks>
  28993. <author>Nicko Cadell</author>
  28994. <author>Gert Driesen</author>
  28995. </member>
  28996. <member name="M:log4net.Util.Transform.#ctor">
  28997. <summary>
  28998. Initializes a new instance of the <see cref="T:log4net.Util.Transform"/> class.
  28999. </summary>
  29000. <remarks>
  29001. <para>
  29002. Uses a private access modifier to prevent instantiation of this class.
  29003. </para>
  29004. </remarks>
  29005. </member>
  29006. <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
  29007. <summary>
  29008. Write a string to an <see cref="T:System.Xml.XmlWriter"/>
  29009. </summary>
  29010. <param name="writer">the writer to write to</param>
  29011. <param name="textData">the string to write</param>
  29012. <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
  29013. <remarks>
  29014. <para>
  29015. The test is escaped either using XML escape entities
  29016. or using CDATA sections.
  29017. </para>
  29018. </remarks>
  29019. </member>
  29020. <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
  29021. <summary>
  29022. Replace invalid XML characters in text string
  29023. </summary>
  29024. <param name="textData">the XML text input string</param>
  29025. <param name="mask">the string to use in place of invalid characters</param>
  29026. <returns>A string that does not contain invalid XML characters.</returns>
  29027. <remarks>
  29028. <para>
  29029. Certain Unicode code points are not allowed in the XML InfoSet, for
  29030. details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
  29031. </para>
  29032. <para>
  29033. This method replaces any illegal characters in the input string
  29034. with the mask string specified.
  29035. </para>
  29036. </remarks>
  29037. </member>
  29038. <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
  29039. <summary>
  29040. Count the number of times that the substring occurs in the text
  29041. </summary>
  29042. <param name="text">the text to search</param>
  29043. <param name="substring">the substring to find</param>
  29044. <returns>the number of times the substring occurs in the text</returns>
  29045. <remarks>
  29046. <para>
  29047. The substring is assumed to be non repeating within itself.
  29048. </para>
  29049. </remarks>
  29050. </member>
  29051. <member name="F:log4net.Util.Transform.INVALIDCHARS">
  29052. <summary>
  29053. Characters illegal in XML 1.0
  29054. </summary>
  29055. </member>
  29056. <member name="T:log4net.Util.WindowsSecurityContext">
  29057. <summary>
  29058. Impersonate a Windows Account
  29059. </summary>
  29060. <remarks>
  29061. <para>
  29062. This <see cref="T:log4net.Core.SecurityContext"/> impersonates a Windows account.
  29063. </para>
  29064. <para>
  29065. How the impersonation is done depends on the value of <see cref="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)"/>.
  29066. This allows the context to either impersonate a set of user credentials specified
  29067. using username, domain name and password or to revert to the process credentials.
  29068. </para>
  29069. </remarks>
  29070. </member>
  29071. <member name="M:log4net.Util.WindowsSecurityContext.#ctor">
  29072. <summary>
  29073. Default constructor
  29074. </summary>
  29075. <remarks>
  29076. <para>
  29077. Default constructor
  29078. </para>
  29079. </remarks>
  29080. </member>
  29081. <member name="M:log4net.Util.WindowsSecurityContext.ActivateOptions">
  29082. <summary>
  29083. Initialize the SecurityContext based on the options set.
  29084. </summary>
  29085. <remarks>
  29086. <para>
  29087. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  29088. activation scheme. The <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> method must
  29089. be called on this object after the configuration properties have
  29090. been set. Until <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> is called this
  29091. object is in an undefined state and must not be used.
  29092. </para>
  29093. <para>
  29094. If any of the configuration properties are modified then
  29095. <see cref="M:log4net.Util.WindowsSecurityContext.ActivateOptions"/> must be called again.
  29096. </para>
  29097. <para>
  29098. The security context will try to Logon the specified user account and
  29099. capture a primary token for impersonation.
  29100. </para>
  29101. </remarks>
  29102. <exception cref="T:System.ArgumentNullException">The required <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>,
  29103. <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> or <see cref="P:log4net.Util.WindowsSecurityContext.Password"/> properties were not specified.</exception>
  29104. </member>
  29105. <member name="M:log4net.Util.WindowsSecurityContext.Impersonate(System.Object)">
  29106. <summary>
  29107. Impersonate the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  29108. </summary>
  29109. <param name="state">caller provided state</param>
  29110. <returns>
  29111. An <see cref="T:System.IDisposable"/> instance that will revoke the impersonation of this SecurityContext
  29112. </returns>
  29113. <remarks>
  29114. <para>
  29115. Depending on the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property either
  29116. impersonate a user using credentials supplied or revert
  29117. to the process credentials.
  29118. </para>
  29119. </remarks>
  29120. </member>
  29121. <member name="M:log4net.Util.WindowsSecurityContext.LogonUser(System.String,System.String,System.String)">
  29122. <summary>
  29123. Create a <see cref="T:System.Security.Principal.WindowsIdentity"/> given the userName, domainName and password.
  29124. </summary>
  29125. <param name="userName">the user name</param>
  29126. <param name="domainName">the domain name</param>
  29127. <param name="password">the password</param>
  29128. <returns>the <see cref="T:System.Security.Principal.WindowsIdentity"/> for the account specified</returns>
  29129. <remarks>
  29130. <para>
  29131. Uses the Windows API call LogonUser to get a principal token for the account. This
  29132. token is used to initialize the WindowsIdentity.
  29133. </para>
  29134. </remarks>
  29135. </member>
  29136. <member name="P:log4net.Util.WindowsSecurityContext.Credentials">
  29137. <summary>
  29138. Gets or sets the impersonation mode for this security context
  29139. </summary>
  29140. <value>
  29141. The impersonation mode for this security context
  29142. </value>
  29143. <remarks>
  29144. <para>
  29145. Impersonate either a user with user credentials or
  29146. revert this thread to the credentials of the process.
  29147. The value is one of the <see cref="T:log4net.Util.WindowsSecurityContext.ImpersonationMode"/>
  29148. enum.
  29149. </para>
  29150. <para>
  29151. The default value is <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  29152. </para>
  29153. <para>
  29154. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/>
  29155. the user's credentials are established using the
  29156. <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/>, <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.Password"/>
  29157. values.
  29158. </para>
  29159. <para>
  29160. When the mode is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process"/>
  29161. no other properties need to be set. If the calling thread is
  29162. impersonating then it will be reverted back to the process credentials.
  29163. </para>
  29164. </remarks>
  29165. </member>
  29166. <member name="P:log4net.Util.WindowsSecurityContext.UserName">
  29167. <summary>
  29168. Gets or sets the Windows username for this security context
  29169. </summary>
  29170. <value>
  29171. The Windows username for this security context
  29172. </value>
  29173. <remarks>
  29174. <para>
  29175. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  29176. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  29177. </para>
  29178. </remarks>
  29179. </member>
  29180. <member name="P:log4net.Util.WindowsSecurityContext.DomainName">
  29181. <summary>
  29182. Gets or sets the Windows domain name for this security context
  29183. </summary>
  29184. <value>
  29185. The Windows domain name for this security context
  29186. </value>
  29187. <remarks>
  29188. <para>
  29189. The default value for <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> is the local machine name
  29190. taken from the <see cref="P:System.Environment.MachineName"/> property.
  29191. </para>
  29192. <para>
  29193. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  29194. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  29195. </para>
  29196. </remarks>
  29197. </member>
  29198. <member name="P:log4net.Util.WindowsSecurityContext.Password">
  29199. <summary>
  29200. Sets the password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  29201. </summary>
  29202. <value>
  29203. The password for the Windows account specified by the <see cref="P:log4net.Util.WindowsSecurityContext.UserName"/> and <see cref="P:log4net.Util.WindowsSecurityContext.DomainName"/> properties.
  29204. </value>
  29205. <remarks>
  29206. <para>
  29207. This property must be set if <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/>
  29208. is set to <see cref="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User"/> (the default setting).
  29209. </para>
  29210. </remarks>
  29211. </member>
  29212. <member name="T:log4net.Util.WindowsSecurityContext.ImpersonationMode">
  29213. <summary>
  29214. The impersonation modes for the <see cref="T:log4net.Util.WindowsSecurityContext"/>
  29215. </summary>
  29216. <remarks>
  29217. <para>
  29218. See the <see cref="P:log4net.Util.WindowsSecurityContext.Credentials"/> property for
  29219. details.
  29220. </para>
  29221. </remarks>
  29222. </member>
  29223. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.User">
  29224. <summary>
  29225. Impersonate a user using the credentials supplied
  29226. </summary>
  29227. </member>
  29228. <member name="F:log4net.Util.WindowsSecurityContext.ImpersonationMode.Process">
  29229. <summary>
  29230. Revert this the thread to the credentials of the process
  29231. </summary>
  29232. </member>
  29233. <member name="T:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext">
  29234. <summary>
  29235. Adds <see cref="T:System.IDisposable"/> to <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  29236. </summary>
  29237. <remarks>
  29238. <para>
  29239. Helper class to expose the <see cref="T:System.Security.Principal.WindowsImpersonationContext"/>
  29240. through the <see cref="T:System.IDisposable"/> interface.
  29241. </para>
  29242. </remarks>
  29243. </member>
  29244. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.#ctor(System.Security.Principal.WindowsImpersonationContext)">
  29245. <summary>
  29246. Constructor
  29247. </summary>
  29248. <param name="impersonationContext">the impersonation context being wrapped</param>
  29249. <remarks>
  29250. <para>
  29251. Constructor
  29252. </para>
  29253. </remarks>
  29254. </member>
  29255. <member name="M:log4net.Util.WindowsSecurityContext.DisposableImpersonationContext.Dispose">
  29256. <summary>
  29257. Revert the impersonation
  29258. </summary>
  29259. <remarks>
  29260. <para>
  29261. Revert the impersonation
  29262. </para>
  29263. </remarks>
  29264. </member>
  29265. <member name="T:log4net.GlobalContext">
  29266. <summary>
  29267. The log4net Global Context.
  29268. </summary>
  29269. <remarks>
  29270. <para>
  29271. The <c>GlobalContext</c> provides a location for global debugging
  29272. information to be stored.
  29273. </para>
  29274. <para>
  29275. The global context has a properties map and these properties can
  29276. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  29277. supports selecting and outputing these properties.
  29278. </para>
  29279. <para>
  29280. By default the <c>log4net:HostName</c> property is set to the name of
  29281. the current machine.
  29282. </para>
  29283. </remarks>
  29284. <example>
  29285. <code lang="C#">
  29286. GlobalContext.Properties["hostname"] = Environment.MachineName;
  29287. </code>
  29288. </example>
  29289. <threadsafety static="true" instance="true"/>
  29290. <author>Nicko Cadell</author>
  29291. </member>
  29292. <member name="M:log4net.GlobalContext.#ctor">
  29293. <summary>
  29294. Private Constructor.
  29295. </summary>
  29296. <remarks>
  29297. Uses a private access modifier to prevent instantiation of this class.
  29298. </remarks>
  29299. </member>
  29300. <member name="F:log4net.GlobalContext.s_properties">
  29301. <summary>
  29302. The global context properties instance
  29303. </summary>
  29304. </member>
  29305. <member name="P:log4net.GlobalContext.Properties">
  29306. <summary>
  29307. The global properties map.
  29308. </summary>
  29309. <value>
  29310. The global properties map.
  29311. </value>
  29312. <remarks>
  29313. <para>
  29314. The global properties map.
  29315. </para>
  29316. </remarks>
  29317. </member>
  29318. <member name="T:log4net.AssemblyInfo">
  29319. <summary>
  29320. Provides information about the environment the assembly has
  29321. been built for.
  29322. </summary>
  29323. </member>
  29324. <member name="F:log4net.AssemblyInfo.Version">
  29325. <summary>Version of the assembly</summary>
  29326. </member>
  29327. <member name="F:log4net.AssemblyInfo.TargetFrameworkVersion">
  29328. <summary>Version of the framework targeted</summary>
  29329. </member>
  29330. <member name="F:log4net.AssemblyInfo.TargetFramework">
  29331. <summary>Type of framework targeted</summary>
  29332. </member>
  29333. <member name="F:log4net.AssemblyInfo.ClientProfile">
  29334. <summary>Does it target a client profile?</summary>
  29335. </member>
  29336. <member name="P:log4net.AssemblyInfo.Info">
  29337. <summary>
  29338. Identifies the version and target for this assembly.
  29339. </summary>
  29340. </member>
  29341. <member name="T:log4net.LogicalThreadContext">
  29342. <summary>
  29343. The log4net Logical Thread Context.
  29344. </summary>
  29345. <remarks>
  29346. <para>
  29347. The <c>LogicalThreadContext</c> provides a location for <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
  29348. information to be stored.
  29349. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
  29350. properties with the same name.
  29351. </para>
  29352. <para>
  29353. The Logical Thread Context has a properties map and a stack.
  29354. The properties and stack can
  29355. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  29356. supports selecting and outputting these properties.
  29357. </para>
  29358. <para>
  29359. The Logical Thread Context provides a diagnostic context for the current call context.
  29360. This is an instrument for distinguishing interleaved log
  29361. output from different sources. Log output is typically interleaved
  29362. when a server handles multiple clients near-simultaneously.
  29363. </para>
  29364. <para>
  29365. The Logical Thread Context is managed on a per <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> basis.
  29366. </para>
  29367. <para>
  29368. The <see cref="T:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  29369. <see cref="T:System.Security.Permissions.SecurityPermission"/> for the
  29370. <see cref="F:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  29371. If the calling code does not have this permission then this context will be disabled.
  29372. It will not store any property values set on it.
  29373. </para>
  29374. </remarks>
  29375. <example>Example of using the thread context properties to store a username.
  29376. <code lang="C#">
  29377. LogicalThreadContext.Properties["user"] = userName;
  29378. log.Info("This log message has a LogicalThreadContext Property called 'user'");
  29379. </code>
  29380. </example>
  29381. <example>Example of how to push a message into the context stack
  29382. <code lang="C#">
  29383. using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
  29384. {
  29385. log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
  29386. } // at the end of the using block the message is automatically popped
  29387. </code>
  29388. </example>
  29389. <threadsafety static="true" instance="true"/>
  29390. <author>Nicko Cadell</author>
  29391. </member>
  29392. <member name="M:log4net.LogicalThreadContext.#ctor">
  29393. <summary>
  29394. Private Constructor.
  29395. </summary>
  29396. <remarks>
  29397. <para>
  29398. Uses a private access modifier to prevent instantiation of this class.
  29399. </para>
  29400. </remarks>
  29401. </member>
  29402. <member name="F:log4net.LogicalThreadContext.s_properties">
  29403. <summary>
  29404. The thread context properties instance
  29405. </summary>
  29406. </member>
  29407. <member name="F:log4net.LogicalThreadContext.s_stacks">
  29408. <summary>
  29409. The thread context stacks instance
  29410. </summary>
  29411. </member>
  29412. <member name="P:log4net.LogicalThreadContext.Properties">
  29413. <summary>
  29414. The thread properties map
  29415. </summary>
  29416. <value>
  29417. The thread properties map
  29418. </value>
  29419. <remarks>
  29420. <para>
  29421. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
  29422. or <see cref="T:log4net.GlobalContext"/> properties with the same name.
  29423. </para>
  29424. </remarks>
  29425. </member>
  29426. <member name="P:log4net.LogicalThreadContext.Stacks">
  29427. <summary>
  29428. The thread stacks
  29429. </summary>
  29430. <value>
  29431. stack map
  29432. </value>
  29433. <remarks>
  29434. <para>
  29435. The logical thread stacks.
  29436. </para>
  29437. </remarks>
  29438. </member>
  29439. <member name="T:log4net.LogManager">
  29440. <summary>
  29441. This class is used by client applications to request logger instances.
  29442. </summary>
  29443. <remarks>
  29444. <para>
  29445. This class has static methods that are used by a client to request
  29446. a logger instance. The <see cref="M:GetLogger(string)"/> method is
  29447. used to retrieve a logger.
  29448. </para>
  29449. <para>
  29450. See the <see cref="T:log4net.ILog"/> interface for more details.
  29451. </para>
  29452. </remarks>
  29453. <example>Simple example of logging messages
  29454. <code lang="C#">
  29455. ILog log = LogManager.GetLogger("application-log");
  29456. log.Info("Application Start");
  29457. log.Debug("This is a debug message");
  29458. if (log.IsDebugEnabled)
  29459. {
  29460. log.Debug("This is another debug message");
  29461. }
  29462. </code>
  29463. </example>
  29464. <threadsafety static="true" instance="true"/>
  29465. <seealso cref="T:log4net.ILog"/>
  29466. <author>Nicko Cadell</author>
  29467. <author>Gert Driesen</author>
  29468. </member>
  29469. <member name="M:log4net.LogManager.#ctor">
  29470. <summary>
  29471. Initializes a new instance of the <see cref="T:log4net.LogManager"/> class.
  29472. </summary>
  29473. <remarks>
  29474. Uses a private access modifier to prevent instantiation of this class.
  29475. </remarks>
  29476. </member>
  29477. <member name="M:log4net.LogManager.Exists(System.String)">
  29478. <overloads>Returns the named logger if it exists.</overloads>
  29479. <summary>
  29480. Returns the named logger if it exists.
  29481. </summary>
  29482. <remarks>
  29483. <para>
  29484. If the named logger exists (in the default repository) then it
  29485. returns a reference to the logger, otherwise it returns <c>null</c>.
  29486. </para>
  29487. </remarks>
  29488. <param name="name">The fully qualified logger name to look for.</param>
  29489. <returns>The logger found, or <c>null</c> if no logger could be found.</returns>
  29490. </member>
  29491. <member name="M:log4net.LogManager.Exists(System.String,System.String)">
  29492. <summary>
  29493. Returns the named logger if it exists.
  29494. </summary>
  29495. <remarks>
  29496. <para>
  29497. If the named logger exists (in the specified repository) then it
  29498. returns a reference to the logger, otherwise it returns
  29499. <c>null</c>.
  29500. </para>
  29501. </remarks>
  29502. <param name="repository">The repository to lookup in.</param>
  29503. <param name="name">The fully qualified logger name to look for.</param>
  29504. <returns>
  29505. The logger found, or <c>null</c> if the logger doesn't exist in the specified
  29506. repository.
  29507. </returns>
  29508. </member>
  29509. <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
  29510. <summary>
  29511. Returns the named logger if it exists.
  29512. </summary>
  29513. <remarks>
  29514. <para>
  29515. If the named logger exists (in the repository for the specified assembly) then it
  29516. returns a reference to the logger, otherwise it returns
  29517. <c>null</c>.
  29518. </para>
  29519. </remarks>
  29520. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  29521. <param name="name">The fully qualified logger name to look for.</param>
  29522. <returns>
  29523. The logger, or <c>null</c> if the logger doesn't exist in the specified
  29524. assembly's repository.
  29525. </returns>
  29526. </member>
  29527. <member name="M:log4net.LogManager.GetCurrentLoggers">
  29528. <overloads>Get the currently defined loggers.</overloads>
  29529. <summary>
  29530. Returns all the currently defined loggers in the default repository.
  29531. </summary>
  29532. <remarks>
  29533. <para>The root logger is <b>not</b> included in the returned array.</para>
  29534. </remarks>
  29535. <returns>All the defined loggers.</returns>
  29536. </member>
  29537. <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
  29538. <summary>
  29539. Returns all the currently defined loggers in the specified repository.
  29540. </summary>
  29541. <param name="repository">The repository to lookup in.</param>
  29542. <remarks>
  29543. The root logger is <b>not</b> included in the returned array.
  29544. </remarks>
  29545. <returns>All the defined loggers.</returns>
  29546. </member>
  29547. <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
  29548. <summary>
  29549. Returns all the currently defined loggers in the specified assembly's repository.
  29550. </summary>
  29551. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  29552. <remarks>
  29553. The root logger is <b>not</b> included in the returned array.
  29554. </remarks>
  29555. <returns>All the defined loggers.</returns>
  29556. </member>
  29557. <member name="M:log4net.LogManager.GetLogger(System.String)">
  29558. <overloads>Get or create a logger.</overloads>
  29559. <summary>
  29560. Retrieves or creates a named logger.
  29561. </summary>
  29562. <remarks>
  29563. <para>
  29564. Retrieves a logger named as the <paramref name="name"/>
  29565. parameter. If the named logger already exists, then the
  29566. existing instance will be returned. Otherwise, a new instance is
  29567. created.
  29568. </para>
  29569. <para>By default, loggers do not have a set level but inherit
  29570. it from the hierarchy. This is one of the central features of
  29571. log4net.
  29572. </para>
  29573. </remarks>
  29574. <param name="name">The name of the logger to retrieve.</param>
  29575. <returns>The logger with the name specified.</returns>
  29576. </member>
  29577. <member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
  29578. <summary>
  29579. Retrieves or creates a named logger.
  29580. </summary>
  29581. <remarks>
  29582. <para>
  29583. Retrieve a logger named as the <paramref name="name"/>
  29584. parameter. If the named logger already exists, then the
  29585. existing instance will be returned. Otherwise, a new instance is
  29586. created.
  29587. </para>
  29588. <para>
  29589. By default, loggers do not have a set level but inherit
  29590. it from the hierarchy. This is one of the central features of
  29591. log4net.
  29592. </para>
  29593. </remarks>
  29594. <param name="repository">The repository to lookup in.</param>
  29595. <param name="name">The name of the logger to retrieve.</param>
  29596. <returns>The logger with the name specified.</returns>
  29597. </member>
  29598. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
  29599. <summary>
  29600. Retrieves or creates a named logger.
  29601. </summary>
  29602. <remarks>
  29603. <para>
  29604. Retrieve a logger named as the <paramref name="name"/>
  29605. parameter. If the named logger already exists, then the
  29606. existing instance will be returned. Otherwise, a new instance is
  29607. created.
  29608. </para>
  29609. <para>
  29610. By default, loggers do not have a set level but inherit
  29611. it from the hierarchy. This is one of the central features of
  29612. log4net.
  29613. </para>
  29614. </remarks>
  29615. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  29616. <param name="name">The name of the logger to retrieve.</param>
  29617. <returns>The logger with the name specified.</returns>
  29618. </member>
  29619. <member name="M:log4net.LogManager.GetLogger(System.Type)">
  29620. <summary>
  29621. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  29622. </summary>
  29623. <remarks>
  29624. Get the logger for the fully qualified name of the type specified.
  29625. </remarks>
  29626. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  29627. <returns>The logger with the name specified.</returns>
  29628. </member>
  29629. <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
  29630. <summary>
  29631. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  29632. </summary>
  29633. <remarks>
  29634. Gets the logger for the fully qualified name of the type specified.
  29635. </remarks>
  29636. <param name="repository">The repository to lookup in.</param>
  29637. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  29638. <returns>The logger with the name specified.</returns>
  29639. </member>
  29640. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
  29641. <summary>
  29642. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  29643. </summary>
  29644. <remarks>
  29645. Gets the logger for the fully qualified name of the type specified.
  29646. </remarks>
  29647. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  29648. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  29649. <returns>The logger with the name specified.</returns>
  29650. </member>
  29651. <member name="M:log4net.LogManager.Shutdown">
  29652. <summary>
  29653. Shuts down the log4net system.
  29654. </summary>
  29655. <remarks>
  29656. <para>
  29657. Calling this method will <b>safely</b> close and remove all
  29658. appenders in all the loggers including root contained in all the
  29659. default repositories.
  29660. </para>
  29661. <para>
  29662. Some appenders need to be closed before the application exists.
  29663. Otherwise, pending logging events might be lost.
  29664. </para>
  29665. <para>The <c>shutdown</c> method is careful to close nested
  29666. appenders before closing regular appenders. This is allows
  29667. configurations where a regular appender is attached to a logger
  29668. and again to a nested appender.
  29669. </para>
  29670. </remarks>
  29671. </member>
  29672. <member name="M:log4net.LogManager.ShutdownRepository">
  29673. <overloads>Shutdown a logger repository.</overloads>
  29674. <summary>
  29675. Shuts down the default repository.
  29676. </summary>
  29677. <remarks>
  29678. <para>
  29679. Calling this method will <b>safely</b> close and remove all
  29680. appenders in all the loggers including root contained in the
  29681. default repository.
  29682. </para>
  29683. <para>Some appenders need to be closed before the application exists.
  29684. Otherwise, pending logging events might be lost.
  29685. </para>
  29686. <para>The <c>shutdown</c> method is careful to close nested
  29687. appenders before closing regular appenders. This is allows
  29688. configurations where a regular appender is attached to a logger
  29689. and again to a nested appender.
  29690. </para>
  29691. </remarks>
  29692. </member>
  29693. <member name="M:log4net.LogManager.ShutdownRepository(System.String)">
  29694. <summary>
  29695. Shuts down the repository for the repository specified.
  29696. </summary>
  29697. <remarks>
  29698. <para>
  29699. Calling this method will <b>safely</b> close and remove all
  29700. appenders in all the loggers including root contained in the
  29701. <paramref name="repository"/> specified.
  29702. </para>
  29703. <para>
  29704. Some appenders need to be closed before the application exists.
  29705. Otherwise, pending logging events might be lost.
  29706. </para>
  29707. <para>The <c>shutdown</c> method is careful to close nested
  29708. appenders before closing regular appenders. This is allows
  29709. configurations where a regular appender is attached to a logger
  29710. and again to a nested appender.
  29711. </para>
  29712. </remarks>
  29713. <param name="repository">The repository to shutdown.</param>
  29714. </member>
  29715. <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
  29716. <summary>
  29717. Shuts down the repository specified.
  29718. </summary>
  29719. <remarks>
  29720. <para>
  29721. Calling this method will <b>safely</b> close and remove all
  29722. appenders in all the loggers including root contained in the
  29723. repository. The repository is looked up using
  29724. the <paramref name="repositoryAssembly"/> specified.
  29725. </para>
  29726. <para>
  29727. Some appenders need to be closed before the application exists.
  29728. Otherwise, pending logging events might be lost.
  29729. </para>
  29730. <para>
  29731. The <c>shutdown</c> method is careful to close nested
  29732. appenders before closing regular appenders. This is allows
  29733. configurations where a regular appender is attached to a logger
  29734. and again to a nested appender.
  29735. </para>
  29736. </remarks>
  29737. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  29738. </member>
  29739. <member name="M:log4net.LogManager.ResetConfiguration">
  29740. <overloads>Reset the configuration of a repository</overloads>
  29741. <summary>
  29742. Resets all values contained in this repository instance to their defaults.
  29743. </summary>
  29744. <remarks>
  29745. <para>
  29746. Resets all values contained in the repository instance to their
  29747. defaults. This removes all appenders from all loggers, sets
  29748. the level of all non-root loggers to <c>null</c>,
  29749. sets their additivity flag to <c>true</c> and sets the level
  29750. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  29751. message disabling is set to its default "off" value.
  29752. </para>
  29753. </remarks>
  29754. </member>
  29755. <member name="M:log4net.LogManager.ResetConfiguration(System.String)">
  29756. <summary>
  29757. Resets all values contained in this repository instance to their defaults.
  29758. </summary>
  29759. <remarks>
  29760. <para>
  29761. Reset all values contained in the repository instance to their
  29762. defaults. This removes all appenders from all loggers, sets
  29763. the level of all non-root loggers to <c>null</c>,
  29764. sets their additivity flag to <c>true</c> and sets the level
  29765. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  29766. message disabling is set to its default "off" value.
  29767. </para>
  29768. </remarks>
  29769. <param name="repository">The repository to reset.</param>
  29770. </member>
  29771. <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
  29772. <summary>
  29773. Resets all values contained in this repository instance to their defaults.
  29774. </summary>
  29775. <remarks>
  29776. <para>
  29777. Reset all values contained in the repository instance to their
  29778. defaults. This removes all appenders from all loggers, sets
  29779. the level of all non-root loggers to <c>null</c>,
  29780. sets their additivity flag to <c>true</c> and sets the level
  29781. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  29782. message disabling is set to its default "off" value.
  29783. </para>
  29784. </remarks>
  29785. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  29786. </member>
  29787. <member name="M:log4net.LogManager.GetLoggerRepository">
  29788. <overloads>Get the logger repository.</overloads>
  29789. <summary>
  29790. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  29791. </summary>
  29792. <remarks>
  29793. <para>
  29794. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  29795. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  29796. </para>
  29797. </remarks>
  29798. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  29799. </member>
  29800. <member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
  29801. <summary>
  29802. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  29803. </summary>
  29804. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  29805. <remarks>
  29806. <para>
  29807. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  29808. by the <paramref name="repository"/> argument.
  29809. </para>
  29810. </remarks>
  29811. <param name="repository">The repository to lookup in.</param>
  29812. </member>
  29813. <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
  29814. <summary>
  29815. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  29816. </summary>
  29817. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  29818. <remarks>
  29819. <para>
  29820. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  29821. by the <paramref name="repositoryAssembly"/> argument.
  29822. </para>
  29823. </remarks>
  29824. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  29825. </member>
  29826. <member name="M:log4net.LogManager.GetRepository">
  29827. <overloads>Get a logger repository.</overloads>
  29828. <summary>
  29829. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  29830. </summary>
  29831. <remarks>
  29832. <para>
  29833. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  29834. by the callers assembly (<see cref="M:Assembly.GetCallingAssembly()"/>).
  29835. </para>
  29836. </remarks>
  29837. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> instance for the default repository.</returns>
  29838. </member>
  29839. <member name="M:log4net.LogManager.GetRepository(System.String)">
  29840. <summary>
  29841. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  29842. </summary>
  29843. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  29844. <remarks>
  29845. <para>
  29846. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  29847. by the <paramref name="repository"/> argument.
  29848. </para>
  29849. </remarks>
  29850. <param name="repository">The repository to lookup in.</param>
  29851. </member>
  29852. <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
  29853. <summary>
  29854. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  29855. </summary>
  29856. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  29857. <remarks>
  29858. <para>
  29859. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  29860. by the <paramref name="repositoryAssembly"/> argument.
  29861. </para>
  29862. </remarks>
  29863. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  29864. </member>
  29865. <member name="M:log4net.LogManager.CreateDomain(System.Type)">
  29866. <overloads>Create a domain</overloads>
  29867. <summary>
  29868. Creates a repository with the specified repository type.
  29869. </summary>
  29870. <remarks>
  29871. <para>
  29872. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  29873. </para>
  29874. <para>
  29875. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  29876. specified such that a call to <see cref="M:GetRepository()"/> will return
  29877. the same repository instance.
  29878. </para>
  29879. </remarks>
  29880. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  29881. and has a no arg constructor. An instance of this type will be created to act
  29882. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  29883. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  29884. </member>
  29885. <member name="M:log4net.LogManager.CreateRepository(System.Type)">
  29886. <overloads>Create a logger repository.</overloads>
  29887. <summary>
  29888. Creates a repository with the specified repository type.
  29889. </summary>
  29890. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  29891. and has a no arg constructor. An instance of this type will be created to act
  29892. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  29893. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  29894. <remarks>
  29895. <para>
  29896. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  29897. specified such that a call to <see cref="M:GetRepository()"/> will return
  29898. the same repository instance.
  29899. </para>
  29900. </remarks>
  29901. </member>
  29902. <member name="M:log4net.LogManager.CreateDomain(System.String)">
  29903. <summary>
  29904. Creates a repository with the specified name.
  29905. </summary>
  29906. <remarks>
  29907. <para>
  29908. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  29909. </para>
  29910. <para>
  29911. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  29912. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  29913. </para>
  29914. <para>
  29915. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  29916. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  29917. </para>
  29918. </remarks>
  29919. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  29920. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  29921. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  29922. </member>
  29923. <member name="M:log4net.LogManager.CreateRepository(System.String)">
  29924. <summary>
  29925. Creates a repository with the specified name.
  29926. </summary>
  29927. <remarks>
  29928. <para>
  29929. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  29930. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  29931. </para>
  29932. <para>
  29933. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  29934. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  29935. </para>
  29936. </remarks>
  29937. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  29938. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  29939. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  29940. </member>
  29941. <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
  29942. <summary>
  29943. Creates a repository with the specified name and repository type.
  29944. </summary>
  29945. <remarks>
  29946. <para>
  29947. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  29948. </para>
  29949. <para>
  29950. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  29951. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  29952. </para>
  29953. </remarks>
  29954. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  29955. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  29956. and has a no arg constructor. An instance of this type will be created to act
  29957. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  29958. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  29959. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  29960. </member>
  29961. <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
  29962. <summary>
  29963. Creates a repository with the specified name and repository type.
  29964. </summary>
  29965. <remarks>
  29966. <para>
  29967. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  29968. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  29969. </para>
  29970. </remarks>
  29971. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  29972. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  29973. and has a no arg constructor. An instance of this type will be created to act
  29974. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  29975. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  29976. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  29977. </member>
  29978. <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  29979. <summary>
  29980. Creates a repository for the specified assembly and repository type.
  29981. </summary>
  29982. <remarks>
  29983. <para>
  29984. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  29985. </para>
  29986. <para>
  29987. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  29988. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  29989. same assembly specified will return the same repository instance.
  29990. </para>
  29991. </remarks>
  29992. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  29993. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  29994. and has a no arg constructor. An instance of this type will be created to act
  29995. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  29996. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  29997. </member>
  29998. <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  29999. <summary>
  30000. Creates a repository for the specified assembly and repository type.
  30001. </summary>
  30002. <remarks>
  30003. <para>
  30004. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  30005. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  30006. same assembly specified will return the same repository instance.
  30007. </para>
  30008. </remarks>
  30009. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  30010. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  30011. and has a no arg constructor. An instance of this type will be created to act
  30012. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  30013. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  30014. </member>
  30015. <member name="M:log4net.LogManager.GetAllRepositories">
  30016. <summary>
  30017. Gets the list of currently defined repositories.
  30018. </summary>
  30019. <remarks>
  30020. <para>
  30021. Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
  30022. </para>
  30023. </remarks>
  30024. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  30025. </member>
  30026. <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
  30027. <summary>
  30028. Looks up the wrapper object for the logger specified.
  30029. </summary>
  30030. <param name="logger">The logger to get the wrapper for.</param>
  30031. <returns>The wrapper for the logger specified.</returns>
  30032. </member>
  30033. <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
  30034. <summary>
  30035. Looks up the wrapper objects for the loggers specified.
  30036. </summary>
  30037. <param name="loggers">The loggers to get the wrappers for.</param>
  30038. <returns>The wrapper objects for the loggers specified.</returns>
  30039. </member>
  30040. <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
  30041. <summary>
  30042. Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
  30043. this manager.
  30044. </summary>
  30045. <param name="logger">The logger to wrap.</param>
  30046. <returns>The wrapper for the logger specified.</returns>
  30047. </member>
  30048. <member name="F:log4net.LogManager.s_wrapperMap">
  30049. <summary>
  30050. The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
  30051. </summary>
  30052. </member>
  30053. <member name="T:log4net.MDC">
  30054. <summary>
  30055. Implementation of Mapped Diagnostic Contexts.
  30056. </summary>
  30057. <remarks>
  30058. <note>
  30059. <para>
  30060. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  30061. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  30062. </para>
  30063. </note>
  30064. <para>
  30065. The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
  30066. based on a map instead of a stack. It provides <i>mapped
  30067. diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
  30068. MDC in short, is an instrument for distinguishing interleaved log
  30069. output from different sources. Log output is typically interleaved
  30070. when a server handles multiple clients near-simultaneously.
  30071. </para>
  30072. <para>
  30073. The MDC is managed on a per thread basis.
  30074. </para>
  30075. </remarks>
  30076. <threadsafety static="true" instance="true"/>
  30077. <author>Nicko Cadell</author>
  30078. <author>Gert Driesen</author>
  30079. </member>
  30080. <member name="M:log4net.MDC.#ctor">
  30081. <summary>
  30082. Initializes a new instance of the <see cref="T:log4net.MDC"/> class.
  30083. </summary>
  30084. <remarks>
  30085. Uses a private access modifier to prevent instantiation of this class.
  30086. </remarks>
  30087. </member>
  30088. <member name="M:log4net.MDC.Get(System.String)">
  30089. <summary>
  30090. Gets the context value identified by the <paramref name="key"/> parameter.
  30091. </summary>
  30092. <param name="key">The key to lookup in the MDC.</param>
  30093. <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
  30094. <remarks>
  30095. <note>
  30096. <para>
  30097. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  30098. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  30099. </para>
  30100. </note>
  30101. <para>
  30102. If the <paramref name="key"/> parameter does not look up to a
  30103. previously defined context then <c>null</c> will be returned.
  30104. </para>
  30105. </remarks>
  30106. </member>
  30107. <member name="M:log4net.MDC.Set(System.String,System.String)">
  30108. <summary>
  30109. Add an entry to the MDC
  30110. </summary>
  30111. <param name="key">The key to store the value under.</param>
  30112. <param name="value">The value to store.</param>
  30113. <remarks>
  30114. <note>
  30115. <para>
  30116. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  30117. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  30118. </para>
  30119. </note>
  30120. <para>
  30121. Puts a context value (the <paramref name="value"/> parameter) as identified
  30122. with the <paramref name="key"/> parameter into the current thread's
  30123. context map.
  30124. </para>
  30125. <para>
  30126. If a value is already defined for the <paramref name="key"/>
  30127. specified then the value will be replaced. If the <paramref name="value"/>
  30128. is specified as <c>null</c> then the key value mapping will be removed.
  30129. </para>
  30130. </remarks>
  30131. </member>
  30132. <member name="M:log4net.MDC.Remove(System.String)">
  30133. <summary>
  30134. Removes the key value mapping for the key specified.
  30135. </summary>
  30136. <param name="key">The key to remove.</param>
  30137. <remarks>
  30138. <note>
  30139. <para>
  30140. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  30141. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  30142. </para>
  30143. </note>
  30144. <para>
  30145. Remove the specified entry from this thread's MDC
  30146. </para>
  30147. </remarks>
  30148. </member>
  30149. <member name="M:log4net.MDC.Clear">
  30150. <summary>
  30151. Clear all entries in the MDC
  30152. </summary>
  30153. <remarks>
  30154. <note>
  30155. <para>
  30156. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  30157. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  30158. </para>
  30159. </note>
  30160. <para>
  30161. Remove all the entries from this thread's MDC
  30162. </para>
  30163. </remarks>
  30164. </member>
  30165. <member name="T:log4net.NDC">
  30166. <summary>
  30167. Implementation of Nested Diagnostic Contexts.
  30168. </summary>
  30169. <remarks>
  30170. <note>
  30171. <para>
  30172. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30173. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30174. </para>
  30175. </note>
  30176. <para>
  30177. A Nested Diagnostic Context, or NDC in short, is an instrument
  30178. to distinguish interleaved log output from different sources. Log
  30179. output is typically interleaved when a server handles multiple
  30180. clients near-simultaneously.
  30181. </para>
  30182. <para>
  30183. Interleaved log output can still be meaningful if each log entry
  30184. from different contexts had a distinctive stamp. This is where NDCs
  30185. come into play.
  30186. </para>
  30187. <para>
  30188. Note that NDCs are managed on a per thread basis. The NDC class
  30189. is made up of static methods that operate on the context of the
  30190. calling thread.
  30191. </para>
  30192. </remarks>
  30193. <example>How to push a message into the context
  30194. <code lang="C#">
  30195. using(NDC.Push("my context message"))
  30196. {
  30197. ... all log calls will have 'my context message' included ...
  30198. } // at the end of the using block the message is automatically removed
  30199. </code>
  30200. </example>
  30201. <threadsafety static="true" instance="true"/>
  30202. <author>Nicko Cadell</author>
  30203. <author>Gert Driesen</author>
  30204. </member>
  30205. <member name="M:log4net.NDC.#ctor">
  30206. <summary>
  30207. Initializes a new instance of the <see cref="T:log4net.NDC"/> class.
  30208. </summary>
  30209. <remarks>
  30210. Uses a private access modifier to prevent instantiation of this class.
  30211. </remarks>
  30212. </member>
  30213. <member name="M:log4net.NDC.Clear">
  30214. <summary>
  30215. Clears all the contextual information held on the current thread.
  30216. </summary>
  30217. <remarks>
  30218. <note>
  30219. <para>
  30220. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30221. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30222. </para>
  30223. </note>
  30224. <para>
  30225. Clears the stack of NDC data held on the current thread.
  30226. </para>
  30227. </remarks>
  30228. </member>
  30229. <member name="M:log4net.NDC.CloneStack">
  30230. <summary>
  30231. Creates a clone of the stack of context information.
  30232. </summary>
  30233. <returns>A clone of the context info for this thread.</returns>
  30234. <remarks>
  30235. <note>
  30236. <para>
  30237. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30238. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30239. </para>
  30240. </note>
  30241. <para>
  30242. The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
  30243. method to allow child threads to inherit the context of their
  30244. parent thread.
  30245. </para>
  30246. </remarks>
  30247. </member>
  30248. <member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
  30249. <summary>
  30250. Inherits the contextual information from another thread.
  30251. </summary>
  30252. <param name="stack">The context stack to inherit.</param>
  30253. <remarks>
  30254. <note>
  30255. <para>
  30256. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30257. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30258. </para>
  30259. </note>
  30260. <para>
  30261. This thread will use the context information from the stack
  30262. supplied. This can be used to initialize child threads with
  30263. the same contextual information as their parent threads. These
  30264. contexts will <b>NOT</b> be shared. Any further contexts that
  30265. are pushed onto the stack will not be visible to the other.
  30266. Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
  30267. this method.
  30268. </para>
  30269. </remarks>
  30270. </member>
  30271. <member name="M:log4net.NDC.Pop">
  30272. <summary>
  30273. Removes the top context from the stack.
  30274. </summary>
  30275. <returns>
  30276. The message in the context that was removed from the top
  30277. of the stack.
  30278. </returns>
  30279. <remarks>
  30280. <note>
  30281. <para>
  30282. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30283. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30284. </para>
  30285. </note>
  30286. <para>
  30287. Remove the top context from the stack, and return
  30288. it to the caller. If the stack is empty then an
  30289. empty string (not <c>null</c>) is returned.
  30290. </para>
  30291. </remarks>
  30292. </member>
  30293. <member name="M:log4net.NDC.Push(System.String)">
  30294. <summary>
  30295. Pushes a new context message.
  30296. </summary>
  30297. <param name="message">The new context message.</param>
  30298. <returns>
  30299. An <see cref="T:System.IDisposable"/> that can be used to clean up
  30300. the context stack.
  30301. </returns>
  30302. <remarks>
  30303. <note>
  30304. <para>
  30305. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30306. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30307. </para>
  30308. </note>
  30309. <para>
  30310. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  30311. is returned that can be used to clean up the context stack. This
  30312. can be easily combined with the <c>using</c> keyword to scope the
  30313. context.
  30314. </para>
  30315. </remarks>
  30316. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  30317. <code lang="C#">
  30318. using(log4net.NDC.Push("NDC_Message"))
  30319. {
  30320. log.Warn("This should have an NDC message");
  30321. }
  30322. </code>
  30323. </example>
  30324. </member>
  30325. <member name="M:log4net.NDC.Remove">
  30326. <summary>
  30327. Removes the context information for this thread. It is
  30328. not required to call this method.
  30329. </summary>
  30330. <remarks>
  30331. <note>
  30332. <para>
  30333. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30334. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30335. </para>
  30336. </note>
  30337. <para>
  30338. This method is not implemented.
  30339. </para>
  30340. </remarks>
  30341. </member>
  30342. <member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
  30343. <summary>
  30344. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  30345. </summary>
  30346. <param name="maxDepth">The maximum depth of the stack</param>
  30347. <remarks>
  30348. <note>
  30349. <para>
  30350. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30351. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30352. </para>
  30353. </note>
  30354. <para>
  30355. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  30356. This may truncate the head of the stack. This only affects the
  30357. stack in the current thread. Also it does not prevent it from
  30358. growing, it only sets the maximum depth at the time of the
  30359. call. This can be used to return to a known context depth.
  30360. </para>
  30361. </remarks>
  30362. </member>
  30363. <member name="P:log4net.NDC.Depth">
  30364. <summary>
  30365. Gets the current context depth.
  30366. </summary>
  30367. <value>The current context depth.</value>
  30368. <remarks>
  30369. <note>
  30370. <para>
  30371. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  30372. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  30373. </para>
  30374. </note>
  30375. <para>
  30376. The number of context values pushed onto the context stack.
  30377. </para>
  30378. <para>
  30379. Used to record the current depth of the context. This can then
  30380. be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
  30381. </para>
  30382. </remarks>
  30383. <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
  30384. </member>
  30385. <member name="T:log4net.ThreadContext">
  30386. <summary>
  30387. The log4net Thread Context.
  30388. </summary>
  30389. <remarks>
  30390. <para>
  30391. The <c>ThreadContext</c> provides a location for thread specific debugging
  30392. information to be stored.
  30393. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  30394. properties with the same name.
  30395. </para>
  30396. <para>
  30397. The thread context has a properties map and a stack.
  30398. The properties and stack can
  30399. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  30400. supports selecting and outputting these properties.
  30401. </para>
  30402. <para>
  30403. The Thread Context provides a diagnostic context for the current thread.
  30404. This is an instrument for distinguishing interleaved log
  30405. output from different sources. Log output is typically interleaved
  30406. when a server handles multiple clients near-simultaneously.
  30407. </para>
  30408. <para>
  30409. The Thread Context is managed on a per thread basis.
  30410. </para>
  30411. </remarks>
  30412. <example>Example of using the thread context properties to store a username.
  30413. <code lang="C#">
  30414. ThreadContext.Properties["user"] = userName;
  30415. log.Info("This log message has a ThreadContext Property called 'user'");
  30416. </code>
  30417. </example>
  30418. <example>Example of how to push a message into the context stack
  30419. <code lang="C#">
  30420. using(ThreadContext.Stacks["NDC"].Push("my context message"))
  30421. {
  30422. log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
  30423. } // at the end of the using block the message is automatically popped
  30424. </code>
  30425. </example>
  30426. <threadsafety static="true" instance="true"/>
  30427. <author>Nicko Cadell</author>
  30428. </member>
  30429. <member name="M:log4net.ThreadContext.#ctor">
  30430. <summary>
  30431. Private Constructor.
  30432. </summary>
  30433. <remarks>
  30434. <para>
  30435. Uses a private access modifier to prevent instantiation of this class.
  30436. </para>
  30437. </remarks>
  30438. </member>
  30439. <member name="F:log4net.ThreadContext.s_properties">
  30440. <summary>
  30441. The thread context properties instance
  30442. </summary>
  30443. </member>
  30444. <member name="F:log4net.ThreadContext.s_stacks">
  30445. <summary>
  30446. The thread context stacks instance
  30447. </summary>
  30448. </member>
  30449. <member name="P:log4net.ThreadContext.Properties">
  30450. <summary>
  30451. The thread properties map
  30452. </summary>
  30453. <value>
  30454. The thread properties map
  30455. </value>
  30456. <remarks>
  30457. <para>
  30458. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  30459. properties with the same name.
  30460. </para>
  30461. </remarks>
  30462. </member>
  30463. <member name="P:log4net.ThreadContext.Stacks">
  30464. <summary>
  30465. The thread stacks
  30466. </summary>
  30467. <value>
  30468. stack map
  30469. </value>
  30470. <remarks>
  30471. <para>
  30472. The thread local stacks.
  30473. </para>
  30474. </remarks>
  30475. </member>
  30476. </members>
  30477. </doc>