log4net.xml 1.3 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757
  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="M:log4net.Appender.AdoNetAppender.#ctor">
  100. <summary>
  101. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppender" /> class.
  102. </summary>
  103. <remarks>
  104. Public default constructor to initialize a new instance of this class.
  105. </remarks>
  106. </member>
  107. <member name="P:log4net.Appender.AdoNetAppender.ConnectionString">
  108. <summary>
  109. Gets or sets the database connection string that is used to connect to
  110. the database.
  111. </summary>
  112. <value>
  113. The database connection string used to connect to the database.
  114. </value>
  115. <remarks>
  116. <para>
  117. The connections string is specific to the connection type.
  118. See <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> for more information.
  119. </para>
  120. </remarks>
  121. <example>Connection string for MS Access via ODBC:
  122. <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>
  123. </example>
  124. <example>Another connection string for MS Access via ODBC:
  125. <code>"Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;"</code>
  126. </example>
  127. <example>Connection string for MS Access via OLE DB:
  128. <code>"Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;"</code>
  129. </example>
  130. </member>
  131. <member name="P:log4net.Appender.AdoNetAppender.AppSettingsKey">
  132. <summary>
  133. The appSettings key from App.Config that contains the connection string.
  134. </summary>
  135. </member>
  136. <member name="P:log4net.Appender.AdoNetAppender.ConnectionStringName">
  137. <summary>
  138. The connectionStrings key from App.Config that contains the connection string.
  139. </summary>
  140. <remarks>
  141. This property requires at least .NET 2.0.
  142. </remarks>
  143. </member>
  144. <member name="P:log4net.Appender.AdoNetAppender.ConnectionType">
  145. <summary>
  146. Gets or sets the type name of the <see cref="T:System.Data.IDbConnection"/> connection
  147. that should be created.
  148. </summary>
  149. <value>
  150. The type name of the <see cref="T:System.Data.IDbConnection"/> connection.
  151. </value>
  152. <remarks>
  153. <para>
  154. The type name of the ADO.NET provider to use.
  155. </para>
  156. <para>
  157. The default is to use the OLE DB provider.
  158. </para>
  159. </remarks>
  160. <example>Use the OLE DB Provider. This is the default value.
  161. <code>System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  162. </example>
  163. <example>Use the MS SQL Server Provider.
  164. <code>System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  165. </example>
  166. <example>Use the ODBC Provider.
  167. <code>Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral</code>
  168. This is an optional package that you can download from
  169. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  170. search for <b>ODBC .NET Data Provider</b>.
  171. </example>
  172. <example>Use the Oracle Provider.
  173. <code>System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</code>
  174. This is an optional package that you can download from
  175. <a href="http://msdn.microsoft.com/downloads">http://msdn.microsoft.com/downloads</a>
  176. search for <b>.NET Managed Provider for Oracle</b>.
  177. </example>
  178. </member>
  179. <member name="P:log4net.Appender.AdoNetAppender.CommandText">
  180. <summary>
  181. Gets or sets the command text that is used to insert logging events
  182. into the database.
  183. </summary>
  184. <value>
  185. The command text used to insert logging events into the database.
  186. </value>
  187. <remarks>
  188. <para>
  189. Either the text of the prepared statement or the
  190. name of the stored procedure to execute to write into
  191. the database.
  192. </para>
  193. <para>
  194. The <see cref="P:log4net.Appender.AdoNetAppender.CommandType"/> property determines if
  195. this text is a prepared statement or a stored procedure.
  196. </para>
  197. <para>
  198. If this property is not set, the command text is retrieved by invoking
  199. <see cref="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)"/>.
  200. </para>
  201. </remarks>
  202. </member>
  203. <member name="P:log4net.Appender.AdoNetAppender.CommandType">
  204. <summary>
  205. Gets or sets the command type to execute.
  206. </summary>
  207. <value>
  208. The command type to execute.
  209. </value>
  210. <remarks>
  211. <para>
  212. This value may be either <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>) to specify
  213. that the <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> is a prepared statement to execute,
  214. or <see cref="F:System.Data.CommandType.StoredProcedure"/> (<c>System.Data.CommandType.StoredProcedure</c>) to specify that the
  215. <see cref="P:log4net.Appender.AdoNetAppender.CommandText"/> property is the name of a stored procedure
  216. to execute.
  217. </para>
  218. <para>
  219. The default value is <see cref="F:System.Data.CommandType.Text"/> (<c>System.Data.CommandType.Text</c>).
  220. </para>
  221. </remarks>
  222. </member>
  223. <member name="P:log4net.Appender.AdoNetAppender.UseTransactions">
  224. <summary>
  225. Should transactions be used to insert logging events in the database.
  226. </summary>
  227. <value>
  228. <c>true</c> if transactions should be used to insert logging events in
  229. the database, otherwise <c>false</c>. The default value is <c>true</c>.
  230. </value>
  231. <remarks>
  232. <para>
  233. Gets or sets a value that indicates whether transactions should be used
  234. to insert logging events in the database.
  235. </para>
  236. <para>
  237. When set a single transaction will be used to insert the buffered events
  238. into the database. Otherwise each event will be inserted without using
  239. an explicit transaction.
  240. </para>
  241. </remarks>
  242. </member>
  243. <member name="P:log4net.Appender.AdoNetAppender.SecurityContext">
  244. <summary>
  245. Gets or sets the <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  246. </summary>
  247. <value>
  248. The <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> used to call the NetSend method.
  249. </value>
  250. <remarks>
  251. <para>
  252. Unless a <see cref="P:log4net.Appender.AdoNetAppender.SecurityContext"/> specified here for this appender
  253. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  254. security context to use. The default behavior is to use the security context
  255. of the current thread.
  256. </para>
  257. </remarks>
  258. </member>
  259. <member name="P:log4net.Appender.AdoNetAppender.ReconnectOnError">
  260. <summary>
  261. Should this appender try to reconnect to the database on error.
  262. </summary>
  263. <value>
  264. <c>true</c> if the appender should try to reconnect to the database after an
  265. error has occurred, otherwise <c>false</c>. The default value is <c>false</c>,
  266. i.e. not to try to reconnect.
  267. </value>
  268. <remarks>
  269. <para>
  270. The default behaviour is for the appender not to try to reconnect to the
  271. database if an error occurs. Subsequent logging events are discarded.
  272. </para>
  273. <para>
  274. To force the appender to attempt to reconnect to the database set this
  275. property to <c>true</c>.
  276. </para>
  277. <note>
  278. When the appender attempts to connect to the database there may be a
  279. delay of up to the connection timeout specified in the connection string.
  280. This delay will block the calling application's thread.
  281. Until the connection can be reestablished this potential delay may occur multiple times.
  282. </note>
  283. </remarks>
  284. </member>
  285. <member name="P:log4net.Appender.AdoNetAppender.Connection">
  286. <summary>
  287. Gets or sets the underlying <see cref="T:System.Data.IDbConnection" />.
  288. </summary>
  289. <value>
  290. The underlying <see cref="T:System.Data.IDbConnection" />.
  291. </value>
  292. <remarks>
  293. <see cref="T:log4net.Appender.AdoNetAppender" /> creates a <see cref="T:System.Data.IDbConnection" /> to insert
  294. logging events into a database. Classes deriving from <see cref="T:log4net.Appender.AdoNetAppender" />
  295. can use this property to get or set this <see cref="T:System.Data.IDbConnection" />. Use the
  296. underlying <see cref="T:System.Data.IDbConnection" /> returned from <see cref="P:log4net.Appender.AdoNetAppender.Connection" /> if
  297. you require access beyond that which <see cref="T:log4net.Appender.AdoNetAppender" /> provides.
  298. </remarks>
  299. </member>
  300. <member name="M:log4net.Appender.AdoNetAppender.ActivateOptions">
  301. <summary>
  302. Initialize the appender based on the options set
  303. </summary>
  304. <remarks>
  305. <para>
  306. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  307. activation scheme. The <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> method must
  308. be called on this object after the configuration properties have
  309. been set. Until <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> is called this
  310. object is in an undefined state and must not be used.
  311. </para>
  312. <para>
  313. If any of the configuration properties are modified then
  314. <see cref="M:log4net.Appender.AdoNetAppender.ActivateOptions"/> must be called again.
  315. </para>
  316. </remarks>
  317. </member>
  318. <member name="M:log4net.Appender.AdoNetAppender.OnClose">
  319. <summary>
  320. Override the parent method to close the database
  321. </summary>
  322. <remarks>
  323. <para>
  324. Closes the database command and database connection.
  325. </para>
  326. </remarks>
  327. </member>
  328. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  329. <summary>
  330. Inserts the events into the database.
  331. </summary>
  332. <param name="events">The events to insert into the database.</param>
  333. <remarks>
  334. <para>
  335. Insert all the events specified in the <paramref name="events"/>
  336. array into the database.
  337. </para>
  338. </remarks>
  339. </member>
  340. <member name="M:log4net.Appender.AdoNetAppender.AddParameter(log4net.Appender.AdoNetAppenderParameter)">
  341. <summary>
  342. Adds a parameter to the command.
  343. </summary>
  344. <param name="parameter">The parameter to add to the command.</param>
  345. <remarks>
  346. <para>
  347. Adds a parameter to the ordered list of command parameters.
  348. </para>
  349. </remarks>
  350. </member>
  351. <member name="M:log4net.Appender.AdoNetAppender.SendBuffer(System.Data.IDbTransaction,log4net.Core.LoggingEvent[])">
  352. <summary>
  353. Writes the events to the database using the transaction specified.
  354. </summary>
  355. <param name="dbTran">The transaction that the events will be executed under.</param>
  356. <param name="events">The array of events to insert into the database.</param>
  357. <remarks>
  358. <para>
  359. The transaction argument can be <c>null</c> if the appender has been
  360. configured not to use transactions. See <see cref="P:log4net.Appender.AdoNetAppender.UseTransactions"/>
  361. property for more information.
  362. </para>
  363. </remarks>
  364. </member>
  365. <member name="M:log4net.Appender.AdoNetAppender.Prepare(System.Data.IDbCommand)">
  366. <summary>
  367. Prepare entire database command object to be executed.
  368. </summary>
  369. <param name="dbCmd">The command to prepare.</param>
  370. </member>
  371. <member name="M:log4net.Appender.AdoNetAppender.GetLogStatement(log4net.Core.LoggingEvent)">
  372. <summary>
  373. Formats the log message into database statement text.
  374. </summary>
  375. <param name="logEvent">The event being logged.</param>
  376. <remarks>
  377. This method can be overridden by subclasses to provide
  378. more control over the format of the database statement.
  379. </remarks>
  380. <returns>
  381. Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
  382. </returns>
  383. </member>
  384. <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
  385. <summary>
  386. Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
  387. </summary>
  388. <remarks>
  389. This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
  390. </remarks>
  391. <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
  392. <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
  393. <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
  394. </member>
  395. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
  396. <summary>
  397. Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
  398. property.
  399. </summary>
  400. <remarks>
  401. ConnectiongStringName is only supported on .NET 2.0 and higher.
  402. </remarks>
  403. <param name="connectionStringContext">Additional information describing the connection string.</param>
  404. <returns>A connection string used to connect to the database.</returns>
  405. </member>
  406. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
  407. <summary>
  408. Retrieves the class type of the ADO.NET provider.
  409. </summary>
  410. <remarks>
  411. <para>
  412. Gets the Type of the ADO.NET provider to use to connect to the
  413. database. This method resolves the type specified in the
  414. <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
  415. </para>
  416. <para>
  417. Subclasses can override this method to return a different type
  418. if necessary.
  419. </para>
  420. </remarks>
  421. <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
  422. </member>
  423. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
  424. <summary>
  425. Connects to the database.
  426. </summary>
  427. </member>
  428. <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
  429. <summary>
  430. Cleanup the existing connection.
  431. </summary>
  432. <remarks>
  433. Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
  434. </remarks>
  435. </member>
  436. <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
  437. <summary>
  438. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  439. </summary>
  440. <remarks>
  441. <para>
  442. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  443. </para>
  444. </remarks>
  445. </member>
  446. <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
  447. <summary>
  448. The security context to use for privileged calls
  449. </summary>
  450. </member>
  451. <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
  452. <summary>
  453. The <see cref="T:System.Data.IDbConnection" /> that will be used
  454. to insert logging events into a database.
  455. </summary>
  456. </member>
  457. <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
  458. <summary>
  459. Database connection string.
  460. </summary>
  461. </member>
  462. <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
  463. <summary>
  464. The appSettings key from App.Config that contains the connection string.
  465. </summary>
  466. </member>
  467. <member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName">
  468. <summary>
  469. The connectionStrings key from App.Config that contains the connection string.
  470. </summary>
  471. </member>
  472. <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
  473. <summary>
  474. String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
  475. </summary>
  476. </member>
  477. <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
  478. <summary>
  479. The text of the command.
  480. </summary>
  481. </member>
  482. <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
  483. <summary>
  484. The command type.
  485. </summary>
  486. </member>
  487. <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
  488. <summary>
  489. Indicates whether to use transactions when writing to the database.
  490. </summary>
  491. </member>
  492. <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
  493. <summary>
  494. Indicates whether to reconnect when a connection is lost.
  495. </summary>
  496. </member>
  497. <member name="F:log4net.Appender.AdoNetAppender.declaringType">
  498. <summary>
  499. The fully qualified type of the AdoNetAppender class.
  500. </summary>
  501. <remarks>
  502. Used by the internal logger to record the Type of the
  503. log message.
  504. </remarks>
  505. </member>
  506. <member name="T:log4net.Appender.AdoNetAppenderParameter">
  507. <summary>
  508. Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
  509. </summary>
  510. <remarks>
  511. <para>
  512. This class provides the basic database parameter properties
  513. as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
  514. </para>
  515. <para>This type can be subclassed to provide database specific
  516. functionality. The two methods that are called externally are
  517. <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
  518. </para>
  519. </remarks>
  520. </member>
  521. <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
  522. <summary>
  523. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter" /> class.
  524. </summary>
  525. <remarks>
  526. Default constructor for the AdoNetAppenderParameter class.
  527. </remarks>
  528. </member>
  529. <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
  530. <summary>
  531. Gets or sets the name of this parameter.
  532. </summary>
  533. <value>
  534. The name of this parameter.
  535. </value>
  536. <remarks>
  537. <para>
  538. The name of this parameter. The parameter name
  539. must match up to a named parameter to the SQL stored procedure
  540. or prepared statement.
  541. </para>
  542. </remarks>
  543. </member>
  544. <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
  545. <summary>
  546. Gets or sets the database type for this parameter.
  547. </summary>
  548. <value>
  549. The database type for this parameter.
  550. </value>
  551. <remarks>
  552. <para>
  553. The database type for this parameter. This property should
  554. be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
  555. enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
  556. </para>
  557. <para>
  558. This property is optional. If not specified the ADO.NET provider
  559. will attempt to infer the type from the value.
  560. </para>
  561. </remarks>
  562. <seealso cref="P:System.Data.IDataParameter.DbType" />
  563. </member>
  564. <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
  565. <summary>
  566. Gets or sets the precision for this parameter.
  567. </summary>
  568. <value>
  569. The precision for this parameter.
  570. </value>
  571. <remarks>
  572. <para>
  573. The maximum number of digits used to represent the Value.
  574. </para>
  575. <para>
  576. This property is optional. If not specified the ADO.NET provider
  577. will attempt to infer the precision from the value.
  578. </para>
  579. </remarks>
  580. <seealso cref="P:System.Data.IDbDataParameter.Precision" />
  581. </member>
  582. <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
  583. <summary>
  584. Gets or sets the scale for this parameter.
  585. </summary>
  586. <value>
  587. The scale for this parameter.
  588. </value>
  589. <remarks>
  590. <para>
  591. The number of decimal places to which Value is resolved.
  592. </para>
  593. <para>
  594. This property is optional. If not specified the ADO.NET provider
  595. will attempt to infer the scale from the value.
  596. </para>
  597. </remarks>
  598. <seealso cref="P:System.Data.IDbDataParameter.Scale" />
  599. </member>
  600. <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
  601. <summary>
  602. Gets or sets the size for this parameter.
  603. </summary>
  604. <value>
  605. The size for this parameter.
  606. </value>
  607. <remarks>
  608. <para>
  609. The maximum size, in bytes, of the data within the column.
  610. </para>
  611. <para>
  612. This property is optional. If not specified the ADO.NET provider
  613. will attempt to infer the size from the value.
  614. </para>
  615. <para>
  616. For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
  617. </para>
  618. </remarks>
  619. <seealso cref="P:System.Data.IDbDataParameter.Size" />
  620. </member>
  621. <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
  622. <summary>
  623. Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
  624. render the logging event into an object for this
  625. parameter.
  626. </summary>
  627. <value>
  628. The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
  629. logging event into an object for this parameter.
  630. </value>
  631. <remarks>
  632. <para>
  633. The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
  634. parameter.
  635. </para>
  636. <para>
  637. The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
  638. any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
  639. for use in the property.
  640. </para>
  641. </remarks>
  642. </member>
  643. <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
  644. <summary>
  645. Prepare the specified database command object.
  646. </summary>
  647. <param name="command">The command to prepare.</param>
  648. <remarks>
  649. <para>
  650. Prepares the database command object by adding
  651. this parameter to its collection of parameters.
  652. </para>
  653. </remarks>
  654. </member>
  655. <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
  656. <summary>
  657. Renders the logging event and set the parameter value in the command.
  658. </summary>
  659. <param name="command">The command containing the parameter.</param>
  660. <param name="loggingEvent">The event to be rendered.</param>
  661. <remarks>
  662. <para>
  663. Renders the logging event using this parameters layout
  664. object. Sets the value of the parameter on the command object.
  665. </para>
  666. </remarks>
  667. </member>
  668. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
  669. <summary>
  670. The name of this parameter.
  671. </summary>
  672. </member>
  673. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
  674. <summary>
  675. The database type for this parameter.
  676. </summary>
  677. </member>
  678. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
  679. <summary>
  680. Flag to infer type rather than use the DbType
  681. </summary>
  682. </member>
  683. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
  684. <summary>
  685. The precision for this parameter.
  686. </summary>
  687. </member>
  688. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
  689. <summary>
  690. The scale for this parameter.
  691. </summary>
  692. </member>
  693. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
  694. <summary>
  695. The size for this parameter.
  696. </summary>
  697. </member>
  698. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
  699. <summary>
  700. The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
  701. logging event into an object for this parameter.
  702. </summary>
  703. </member>
  704. <member name="T:log4net.Appender.AnsiColorTerminalAppender">
  705. <summary>
  706. Appends logging events to the terminal using ANSI color escape sequences.
  707. </summary>
  708. <remarks>
  709. <para>
  710. AnsiColorTerminalAppender appends log events to the standard output stream
  711. or the error output stream using a layout specified by the
  712. user. It also allows the color of a specific level of message to be set.
  713. </para>
  714. <note>
  715. This appender expects the terminal to understand the VT100 control set
  716. in order to interpret the color codes. If the terminal or console does not
  717. understand the control codes the behavior is not defined.
  718. </note>
  719. <para>
  720. By default, all output is written to the console's standard output stream.
  721. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
  722. error stream.
  723. </para>
  724. <para>
  725. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  726. <c>System.Console.Error</c> that is set at the time the event is appended.
  727. Therefore it is possible to programmatically redirect the output of this appender
  728. (for example NUnit does this to capture program output). While this is the desired
  729. behavior of this appender it may have security implications in your application.
  730. </para>
  731. <para>
  732. When configuring the ANSI colored terminal appender, a mapping should be
  733. specified to map a logging level to a color. For example:
  734. </para>
  735. <code lang="XML" escaped="true">
  736. <mapping>
  737. <level value="ERROR" />
  738. <foreColor value="White" />
  739. <backColor value="Red" />
  740. <attributes value="Bright,Underscore" />
  741. </mapping>
  742. <mapping>
  743. <level value="DEBUG" />
  744. <backColor value="Green" />
  745. </mapping>
  746. </code>
  747. <para>
  748. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  749. of the following values:
  750. <list type="bullet">
  751. <item><term>Blue</term><description></description></item>
  752. <item><term>Green</term><description></description></item>
  753. <item><term>Red</term><description></description></item>
  754. <item><term>White</term><description></description></item>
  755. <item><term>Yellow</term><description></description></item>
  756. <item><term>Purple</term><description></description></item>
  757. <item><term>Cyan</term><description></description></item>
  758. </list>
  759. These color values cannot be combined together to make new colors.
  760. </para>
  761. <para>
  762. The attributes can be any combination of the following:
  763. <list type="bullet">
  764. <item><term>Bright</term><description>foreground is brighter</description></item>
  765. <item><term>Dim</term><description>foreground is dimmer</description></item>
  766. <item><term>Underscore</term><description>message is underlined</description></item>
  767. <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
  768. <item><term>Reverse</term><description>foreground and background are reversed</description></item>
  769. <item><term>Hidden</term><description>output is hidden</description></item>
  770. <item><term>Strikethrough</term><description>message has a line through it</description></item>
  771. </list>
  772. While any of these attributes may be combined together not all combinations
  773. work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
  774. no sense.
  775. </para>
  776. </remarks>
  777. <author>Patrick Wagstrom</author>
  778. <author>Nicko Cadell</author>
  779. </member>
  780. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
  781. <summary>
  782. The enum of possible display attributes
  783. </summary>
  784. <remarks>
  785. <para>
  786. The following flags can be combined together to
  787. form the ANSI color attributes.
  788. </para>
  789. </remarks>
  790. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender" />
  791. </member>
  792. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
  793. <summary>
  794. text is bright
  795. </summary>
  796. </member>
  797. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
  798. <summary>
  799. text is dim
  800. </summary>
  801. </member>
  802. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
  803. <summary>
  804. text is underlined
  805. </summary>
  806. </member>
  807. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
  808. <summary>
  809. text is blinking
  810. </summary>
  811. <remarks>
  812. Not all terminals support this attribute
  813. </remarks>
  814. </member>
  815. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
  816. <summary>
  817. text and background colors are reversed
  818. </summary>
  819. </member>
  820. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
  821. <summary>
  822. text is hidden
  823. </summary>
  824. </member>
  825. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
  826. <summary>
  827. text is displayed with a strikethrough
  828. </summary>
  829. </member>
  830. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
  831. <summary>
  832. text color is light
  833. </summary>
  834. </member>
  835. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
  836. <summary>
  837. The enum of possible foreground or background color values for
  838. use with the color mapping method
  839. </summary>
  840. <remarks>
  841. <para>
  842. The output can be in one for the following ANSI colors.
  843. </para>
  844. </remarks>
  845. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender" />
  846. </member>
  847. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
  848. <summary>
  849. color is black
  850. </summary>
  851. </member>
  852. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
  853. <summary>
  854. color is red
  855. </summary>
  856. </member>
  857. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
  858. <summary>
  859. color is green
  860. </summary>
  861. </member>
  862. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
  863. <summary>
  864. color is yellow
  865. </summary>
  866. </member>
  867. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
  868. <summary>
  869. color is blue
  870. </summary>
  871. </member>
  872. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
  873. <summary>
  874. color is magenta
  875. </summary>
  876. </member>
  877. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
  878. <summary>
  879. color is cyan
  880. </summary>
  881. </member>
  882. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
  883. <summary>
  884. color is white
  885. </summary>
  886. </member>
  887. <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
  888. <summary>
  889. Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender" /> class.
  890. </summary>
  891. <remarks>
  892. The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender" /> class is set up to write
  893. to the standard output stream.
  894. </remarks>
  895. </member>
  896. <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
  897. <summary>
  898. Target is the value of the console output stream.
  899. </summary>
  900. <value>
  901. Target is the value of the console output stream.
  902. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  903. </value>
  904. <remarks>
  905. <para>
  906. Target is the value of the console output stream.
  907. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  908. </para>
  909. </remarks>
  910. </member>
  911. <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
  912. <summary>
  913. Add a mapping of level to color
  914. </summary>
  915. <param name="mapping">The mapping to add</param>
  916. <remarks>
  917. <para>
  918. Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
  919. Each mapping defines the foreground and background colours
  920. for a level.
  921. </para>
  922. </remarks>
  923. </member>
  924. <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
  925. <summary>
  926. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  927. </summary>
  928. <param name="loggingEvent">The event to log.</param>
  929. <remarks>
  930. <para>
  931. Writes the event to the console.
  932. </para>
  933. <para>
  934. The format of the output will depend on the appender's layout.
  935. </para>
  936. </remarks>
  937. </member>
  938. <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
  939. <summary>
  940. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  941. </summary>
  942. <value><c>true</c></value>
  943. <remarks>
  944. <para>
  945. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  946. </para>
  947. </remarks>
  948. </member>
  949. <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
  950. <summary>
  951. Initialize the options for this appender
  952. </summary>
  953. <remarks>
  954. <para>
  955. Initialize the level to color mappings set on this appender.
  956. </para>
  957. </remarks>
  958. </member>
  959. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
  960. <summary>
  961. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  962. standard output stream.
  963. </summary>
  964. <remarks>
  965. <para>
  966. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  967. standard output stream.
  968. </para>
  969. </remarks>
  970. </member>
  971. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
  972. <summary>
  973. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  974. standard error output stream.
  975. </summary>
  976. <remarks>
  977. <para>
  978. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  979. standard error output stream.
  980. </para>
  981. </remarks>
  982. </member>
  983. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
  984. <summary>
  985. Flag to write output to the error stream rather than the standard output stream
  986. </summary>
  987. </member>
  988. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
  989. <summary>
  990. Mapping from level object to color value
  991. </summary>
  992. </member>
  993. <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
  994. <summary>
  995. Ansi code to reset terminal
  996. </summary>
  997. </member>
  998. <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
  999. <summary>
  1000. A class to act as a mapping between the level that a logging call is made at and
  1001. the color it should be displayed as.
  1002. </summary>
  1003. <remarks>
  1004. <para>
  1005. Defines the mapping between a level and the color it should be displayed in.
  1006. </para>
  1007. </remarks>
  1008. </member>
  1009. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
  1010. <summary>
  1011. The mapped foreground color for the specified level
  1012. </summary>
  1013. <remarks>
  1014. <para>
  1015. Required property.
  1016. The mapped foreground color for the specified level
  1017. </para>
  1018. </remarks>
  1019. </member>
  1020. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
  1021. <summary>
  1022. The mapped background color for the specified level
  1023. </summary>
  1024. <remarks>
  1025. <para>
  1026. Required property.
  1027. The mapped background color for the specified level
  1028. </para>
  1029. </remarks>
  1030. </member>
  1031. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
  1032. <summary>
  1033. The color attributes for the specified level
  1034. </summary>
  1035. <remarks>
  1036. <para>
  1037. Required property.
  1038. The color attributes for the specified level
  1039. </para>
  1040. </remarks>
  1041. </member>
  1042. <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
  1043. <summary>
  1044. Initialize the options for the object
  1045. </summary>
  1046. <remarks>
  1047. <para>
  1048. Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
  1049. and append the attributes.
  1050. </para>
  1051. </remarks>
  1052. </member>
  1053. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
  1054. <summary>
  1055. The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
  1056. <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
  1057. </summary>
  1058. </member>
  1059. <member name="T:log4net.Appender.AppenderCollection">
  1060. <summary>
  1061. A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
  1062. </summary>
  1063. <author>Nicko Cadell</author>
  1064. </member>
  1065. <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
  1066. <summary>
  1067. Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  1068. </summary>
  1069. <exclude/>
  1070. </member>
  1071. <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
  1072. <summary>
  1073. Gets the current element in the collection.
  1074. </summary>
  1075. </member>
  1076. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
  1077. <summary>
  1078. Advances the enumerator to the next element in the collection.
  1079. </summary>
  1080. <returns>
  1081. <c>true</c> if the enumerator was successfully advanced to the next element;
  1082. <c>false</c> if the enumerator has passed the end of the collection.
  1083. </returns>
  1084. <exception cref="T:System.InvalidOperationException">
  1085. The collection was modified after the enumerator was created.
  1086. </exception>
  1087. </member>
  1088. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
  1089. <summary>
  1090. Sets the enumerator to its initial position, before the first element in the collection.
  1091. </summary>
  1092. </member>
  1093. <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
  1094. <summary>
  1095. Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
  1096. </summary>
  1097. <param name="list">list to create a readonly wrapper arround</param>
  1098. <returns>
  1099. An <c>AppenderCollection</c> wrapper that is read-only.
  1100. </returns>
  1101. </member>
  1102. <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
  1103. <summary>
  1104. An empty readonly static AppenderCollection
  1105. </summary>
  1106. </member>
  1107. <member name="M:log4net.Appender.AppenderCollection.#ctor">
  1108. <summary>
  1109. Initializes a new instance of the <c>AppenderCollection</c> class
  1110. that is empty and has the default initial capacity.
  1111. </summary>
  1112. </member>
  1113. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
  1114. <summary>
  1115. Initializes a new instance of the <c>AppenderCollection</c> class
  1116. that has the specified initial capacity.
  1117. </summary>
  1118. <param name="capacity">
  1119. The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
  1120. </param>
  1121. </member>
  1122. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
  1123. <summary>
  1124. Initializes a new instance of the <c>AppenderCollection</c> class
  1125. that contains elements copied from the specified <c>AppenderCollection</c>.
  1126. </summary>
  1127. <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
  1128. </member>
  1129. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
  1130. <summary>
  1131. Initializes a new instance of the <c>AppenderCollection</c> class
  1132. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
  1133. </summary>
  1134. <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
  1135. </member>
  1136. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
  1137. <summary>
  1138. Initializes a new instance of the <c>AppenderCollection</c> class
  1139. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
  1140. </summary>
  1141. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
  1142. </member>
  1143. <member name="T:log4net.Appender.AppenderCollection.Tag">
  1144. <summary>
  1145. Type visible only to our subclasses
  1146. Used to access protected constructor
  1147. </summary>
  1148. <exclude/>
  1149. </member>
  1150. <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
  1151. <summary>
  1152. A value
  1153. </summary>
  1154. </member>
  1155. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
  1156. <summary>
  1157. Allow subclasses to avoid our default constructors
  1158. </summary>
  1159. <param name="tag"></param>
  1160. <exclude/>
  1161. </member>
  1162. <member name="P:log4net.Appender.AppenderCollection.Count">
  1163. <summary>
  1164. Gets the number of elements actually contained in the <c>AppenderCollection</c>.
  1165. </summary>
  1166. </member>
  1167. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
  1168. <summary>
  1169. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  1170. <see cref="T:log4net.Appender.IAppender"/> array.
  1171. </summary>
  1172. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  1173. </member>
  1174. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
  1175. <summary>
  1176. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  1177. <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
  1178. </summary>
  1179. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  1180. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  1181. </member>
  1182. <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
  1183. <summary>
  1184. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  1185. </summary>
  1186. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  1187. </member>
  1188. <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
  1189. <summary>
  1190. Gets an object that can be used to synchronize access to the collection.
  1191. </summary>
  1192. </member>
  1193. <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
  1194. <summary>
  1195. Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
  1196. </summary>
  1197. <param name="index">The zero-based index of the element to get or set.</param>
  1198. <exception cref="T:System.ArgumentOutOfRangeException">
  1199. <para><paramref name="index"/> is less than zero</para>
  1200. <para>-or-</para>
  1201. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1202. </exception>
  1203. </member>
  1204. <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
  1205. <summary>
  1206. Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
  1207. </summary>
  1208. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
  1209. <returns>The index at which the value has been added.</returns>
  1210. </member>
  1211. <member name="M:log4net.Appender.AppenderCollection.Clear">
  1212. <summary>
  1213. Removes all elements from the <c>AppenderCollection</c>.
  1214. </summary>
  1215. </member>
  1216. <member name="M:log4net.Appender.AppenderCollection.Clone">
  1217. <summary>
  1218. Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
  1219. </summary>
  1220. <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
  1221. </member>
  1222. <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
  1223. <summary>
  1224. Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
  1225. </summary>
  1226. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
  1227. <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
  1228. </member>
  1229. <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
  1230. <summary>
  1231. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
  1232. in the <c>AppenderCollection</c>.
  1233. </summary>
  1234. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
  1235. <returns>
  1236. The zero-based index of the first occurrence of <paramref name="item"/>
  1237. in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
  1238. </returns>
  1239. </member>
  1240. <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
  1241. <summary>
  1242. Inserts an element into the <c>AppenderCollection</c> at the specified index.
  1243. </summary>
  1244. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  1245. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
  1246. <exception cref="T:System.ArgumentOutOfRangeException">
  1247. <para><paramref name="index"/> is less than zero</para>
  1248. <para>-or-</para>
  1249. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1250. </exception>
  1251. </member>
  1252. <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
  1253. <summary>
  1254. Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
  1255. </summary>
  1256. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
  1257. <exception cref="T:System.ArgumentException">
  1258. The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
  1259. </exception>
  1260. </member>
  1261. <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
  1262. <summary>
  1263. Removes the element at the specified index of the <c>AppenderCollection</c>.
  1264. </summary>
  1265. <param name="index">The zero-based index of the element to remove.</param>
  1266. <exception cref="T:System.ArgumentOutOfRangeException">
  1267. <para><paramref name="index"/> is less than zero</para>
  1268. <para>-or-</para>
  1269. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1270. </exception>
  1271. </member>
  1272. <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
  1273. <summary>
  1274. Gets a value indicating whether the collection has a fixed size.
  1275. </summary>
  1276. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  1277. </member>
  1278. <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
  1279. <summary>
  1280. Gets a value indicating whether the IList is read-only.
  1281. </summary>
  1282. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  1283. </member>
  1284. <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
  1285. <summary>
  1286. Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
  1287. </summary>
  1288. <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
  1289. </member>
  1290. <member name="P:log4net.Appender.AppenderCollection.Capacity">
  1291. <summary>
  1292. Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
  1293. </summary>
  1294. </member>
  1295. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
  1296. <summary>
  1297. Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
  1298. </summary>
  1299. <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
  1300. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1301. </member>
  1302. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
  1303. <summary>
  1304. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
  1305. </summary>
  1306. <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>
  1307. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1308. </member>
  1309. <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
  1310. <summary>
  1311. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
  1312. </summary>
  1313. <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>
  1314. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1315. </member>
  1316. <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
  1317. <summary>
  1318. Sets the capacity to the actual number of elements.
  1319. </summary>
  1320. </member>
  1321. <member name="M:log4net.Appender.AppenderCollection.ToArray">
  1322. <summary>
  1323. Return the collection elements as an array
  1324. </summary>
  1325. <returns>the array</returns>
  1326. </member>
  1327. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
  1328. <exception cref="T:System.ArgumentOutOfRangeException">
  1329. <para><paramref name="i"/> is less than zero</para>
  1330. <para>-or-</para>
  1331. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1332. </exception>
  1333. </member>
  1334. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
  1335. <exception cref="T:System.ArgumentOutOfRangeException">
  1336. <para><paramref name="i"/> is less than zero</para>
  1337. <para>-or-</para>
  1338. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1339. </exception>
  1340. </member>
  1341. <member name="T:log4net.Appender.AppenderCollection.Enumerator">
  1342. <summary>
  1343. Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  1344. </summary>
  1345. <exclude/>
  1346. </member>
  1347. <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
  1348. <summary>
  1349. Initializes a new instance of the <c>Enumerator</c> class.
  1350. </summary>
  1351. <param name="tc"></param>
  1352. </member>
  1353. <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
  1354. <summary>
  1355. Gets the current element in the collection.
  1356. </summary>
  1357. </member>
  1358. <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
  1359. <summary>
  1360. Advances the enumerator to the next element in the collection.
  1361. </summary>
  1362. <returns>
  1363. <c>true</c> if the enumerator was successfully advanced to the next element;
  1364. <c>false</c> if the enumerator has passed the end of the collection.
  1365. </returns>
  1366. <exception cref="T:System.InvalidOperationException">
  1367. The collection was modified after the enumerator was created.
  1368. </exception>
  1369. </member>
  1370. <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
  1371. <summary>
  1372. Sets the enumerator to its initial position, before the first element in the collection.
  1373. </summary>
  1374. </member>
  1375. <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
  1376. <exclude/>
  1377. </member>
  1378. <member name="T:log4net.Appender.AppenderSkeleton">
  1379. <summary>
  1380. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
  1381. </summary>
  1382. <remarks>
  1383. <para>
  1384. This class provides the code for common functionality, such
  1385. as support for threshold filtering and support for general filters.
  1386. </para>
  1387. <para>
  1388. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  1389. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  1390. be called after the appenders properties have been configured.
  1391. </para>
  1392. </remarks>
  1393. <author>Nicko Cadell</author>
  1394. <author>Gert Driesen</author>
  1395. </member>
  1396. <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
  1397. <summary>
  1398. Default constructor
  1399. </summary>
  1400. <remarks>
  1401. <para>Empty default constructor</para>
  1402. </remarks>
  1403. </member>
  1404. <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
  1405. <summary>
  1406. Finalizes this appender by calling the implementation's
  1407. <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
  1408. </summary>
  1409. <remarks>
  1410. <para>
  1411. If this appender has not been closed then the <c>Finalize</c> method
  1412. will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
  1413. </para>
  1414. </remarks>
  1415. </member>
  1416. <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
  1417. <summary>
  1418. Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
  1419. </summary>
  1420. <value>
  1421. The threshold <see cref="T:log4net.Core.Level"/> of the appender.
  1422. </value>
  1423. <remarks>
  1424. <para>
  1425. All log events with lower level than the threshold level are ignored
  1426. by the appender.
  1427. </para>
  1428. <para>
  1429. In configuration files this option is specified by setting the
  1430. value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
  1431. string, such as "DEBUG", "INFO" and so on.
  1432. </para>
  1433. </remarks>
  1434. </member>
  1435. <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
  1436. <summary>
  1437. Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  1438. </summary>
  1439. <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
  1440. <remarks>
  1441. <para>
  1442. The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
  1443. implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
  1444. </para>
  1445. </remarks>
  1446. </member>
  1447. <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
  1448. <summary>
  1449. The filter chain.
  1450. </summary>
  1451. <value>The head of the filter chain filter chain.</value>
  1452. <remarks>
  1453. <para>
  1454. Returns the head Filter. The Filters are organized in a linked list
  1455. and so all Filters on this Appender are available through the result.
  1456. </para>
  1457. </remarks>
  1458. </member>
  1459. <member name="P:log4net.Appender.AppenderSkeleton.Layout">
  1460. <summary>
  1461. Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
  1462. </summary>
  1463. <value>The layout of the appender.</value>
  1464. <remarks>
  1465. <para>
  1466. See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
  1467. </para>
  1468. </remarks>
  1469. <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
  1470. </member>
  1471. <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
  1472. <summary>
  1473. Initialize the appender based on the options set
  1474. </summary>
  1475. <remarks>
  1476. <para>
  1477. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  1478. activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
  1479. be called on this object after the configuration properties have
  1480. been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
  1481. object is in an undefined state and must not be used.
  1482. </para>
  1483. <para>
  1484. If any of the configuration properties are modified then
  1485. <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
  1486. </para>
  1487. </remarks>
  1488. </member>
  1489. <member name="P:log4net.Appender.AppenderSkeleton.Name">
  1490. <summary>
  1491. Gets or sets the name of this appender.
  1492. </summary>
  1493. <value>The name of the appender.</value>
  1494. <remarks>
  1495. <para>
  1496. The name uniquely identifies the appender.
  1497. </para>
  1498. </remarks>
  1499. </member>
  1500. <member name="M:log4net.Appender.AppenderSkeleton.Close">
  1501. <summary>
  1502. Closes the appender and release resources.
  1503. </summary>
  1504. <remarks>
  1505. <para>
  1506. Release any resources allocated within the appender such as file handles,
  1507. network connections, etc.
  1508. </para>
  1509. <para>
  1510. It is a programming error to append to a closed appender.
  1511. </para>
  1512. <para>
  1513. This method cannot be overridden by subclasses. This method
  1514. delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
  1515. method which must be overridden in the subclass.
  1516. </para>
  1517. </remarks>
  1518. </member>
  1519. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
  1520. <summary>
  1521. Performs threshold checks and invokes filters before
  1522. delegating actual logging to the subclasses specific
  1523. <see cref="M:Append(LoggingEvent)"/> method.
  1524. </summary>
  1525. <param name="loggingEvent">The event to log.</param>
  1526. <remarks>
  1527. <para>
  1528. This method cannot be overridden by derived classes. A
  1529. derived class should override the <see cref="M:Append(LoggingEvent)"/> method
  1530. which is called by this method.
  1531. </para>
  1532. <para>
  1533. The implementation of this method is as follows:
  1534. </para>
  1535. <para>
  1536. <list type="bullet">
  1537. <item>
  1538. <description>
  1539. Checks that the severity of the <paramref name="loggingEvent"/>
  1540. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1541. appender.</description>
  1542. </item>
  1543. <item>
  1544. <description>
  1545. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1546. <paramref name="loggingEvent"/>.
  1547. </description>
  1548. </item>
  1549. <item>
  1550. <description>
  1551. Calls <see cref="M:PreAppendCheck()"/> and checks that
  1552. it returns <c>true</c>.</description>
  1553. </item>
  1554. </list>
  1555. </para>
  1556. <para>
  1557. If all of the above steps succeed then the <paramref name="loggingEvent"/>
  1558. will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  1559. </para>
  1560. </remarks>
  1561. </member>
  1562. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
  1563. <summary>
  1564. Performs threshold checks and invokes filters before
  1565. delegating actual logging to the subclasses specific
  1566. <see cref="M:Append(LoggingEvent[])"/> method.
  1567. </summary>
  1568. <param name="loggingEvents">The array of events to log.</param>
  1569. <remarks>
  1570. <para>
  1571. This method cannot be overridden by derived classes. A
  1572. derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
  1573. which is called by this method.
  1574. </para>
  1575. <para>
  1576. The implementation of this method is as follows:
  1577. </para>
  1578. <para>
  1579. <list type="bullet">
  1580. <item>
  1581. <description>
  1582. Checks that the severity of the <paramref name="loggingEvents"/>
  1583. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1584. appender.</description>
  1585. </item>
  1586. <item>
  1587. <description>
  1588. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1589. <paramref name="loggingEvents"/>.
  1590. </description>
  1591. </item>
  1592. <item>
  1593. <description>
  1594. Calls <see cref="M:PreAppendCheck()"/> and checks that
  1595. it returns <c>true</c>.</description>
  1596. </item>
  1597. </list>
  1598. </para>
  1599. <para>
  1600. If all of the above steps succeed then the <paramref name="loggingEvents"/>
  1601. will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
  1602. </para>
  1603. </remarks>
  1604. </member>
  1605. <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
  1606. <summary>
  1607. Test if the logging event should we output by this appender
  1608. </summary>
  1609. <param name="loggingEvent">the event to test</param>
  1610. <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
  1611. <remarks>
  1612. <para>
  1613. This method checks the logging event against the threshold level set
  1614. on this appender and also against the filters specified on this
  1615. appender.
  1616. </para>
  1617. <para>
  1618. The implementation of this method is as follows:
  1619. </para>
  1620. <para>
  1621. <list type="bullet">
  1622. <item>
  1623. <description>
  1624. Checks that the severity of the <paramref name="loggingEvent"/>
  1625. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1626. appender.</description>
  1627. </item>
  1628. <item>
  1629. <description>
  1630. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1631. <paramref name="loggingEvent"/>.
  1632. </description>
  1633. </item>
  1634. </list>
  1635. </para>
  1636. </remarks>
  1637. </member>
  1638. <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
  1639. <summary>
  1640. Adds a filter to the end of the filter chain.
  1641. </summary>
  1642. <param name="filter">the filter to add to this appender</param>
  1643. <remarks>
  1644. <para>
  1645. The Filters are organized in a linked list.
  1646. </para>
  1647. <para>
  1648. Setting this property causes the new filter to be pushed onto the
  1649. back of the filter chain.
  1650. </para>
  1651. </remarks>
  1652. </member>
  1653. <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
  1654. <summary>
  1655. Clears the filter list for this appender.
  1656. </summary>
  1657. <remarks>
  1658. <para>
  1659. Clears the filter list for this appender.
  1660. </para>
  1661. </remarks>
  1662. </member>
  1663. <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
  1664. <summary>
  1665. Checks if the message level is below this appender's threshold.
  1666. </summary>
  1667. <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
  1668. <remarks>
  1669. <para>
  1670. If there is no threshold set, then the return value is always <c>true</c>.
  1671. </para>
  1672. </remarks>
  1673. <returns>
  1674. <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
  1675. requirements of this appender.
  1676. </returns>
  1677. </member>
  1678. <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
  1679. <summary>
  1680. Is called when the appender is closed. Derived classes should override
  1681. this method if resources need to be released.
  1682. </summary>
  1683. <remarks>
  1684. <para>
  1685. Releases any resources allocated within the appender such as file handles,
  1686. network connections, etc.
  1687. </para>
  1688. <para>
  1689. It is a programming error to append to a closed appender.
  1690. </para>
  1691. </remarks>
  1692. </member>
  1693. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  1694. <summary>
  1695. Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
  1696. to perform actual logging.
  1697. </summary>
  1698. <param name="loggingEvent">The event to append.</param>
  1699. <remarks>
  1700. <para>
  1701. A subclass must implement this method to perform
  1702. logging of the <paramref name="loggingEvent"/>.
  1703. </para>
  1704. <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
  1705. if all the conditions listed for that method are met.
  1706. </para>
  1707. <para>
  1708. To restrict the logging of events in the appender
  1709. override the <see cref="M:PreAppendCheck()"/> method.
  1710. </para>
  1711. </remarks>
  1712. </member>
  1713. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
  1714. <summary>
  1715. Append a bulk array of logging events.
  1716. </summary>
  1717. <param name="loggingEvents">the array of logging events</param>
  1718. <remarks>
  1719. <para>
  1720. This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
  1721. method for each element in the bulk array.
  1722. </para>
  1723. <para>
  1724. A sub class that can better process a bulk array of events should
  1725. override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
  1726. </para>
  1727. </remarks>
  1728. </member>
  1729. <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
  1730. <summary>
  1731. Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
  1732. </summary>
  1733. <remarks>
  1734. <para>
  1735. This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
  1736. before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  1737. </para>
  1738. <para>
  1739. This method can be overridden in a subclass to extend the checks
  1740. made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
  1741. </para>
  1742. <para>
  1743. A subclass should ensure that they delegate this call to
  1744. this base class if it is overridden.
  1745. </para>
  1746. </remarks>
  1747. <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
  1748. </member>
  1749. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
  1750. <summary>
  1751. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  1752. </summary>
  1753. <param name="loggingEvent">The event to render.</param>
  1754. <returns>The event rendered as a string.</returns>
  1755. <remarks>
  1756. <para>
  1757. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  1758. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  1759. set to render the <paramref name="loggingEvent"/> to
  1760. a string.
  1761. </para>
  1762. <para>If there is exception data in the logging event and
  1763. the layout does not process the exception, this method
  1764. will append the exception text to the rendered string.
  1765. </para>
  1766. <para>
  1767. Where possible use the alternative version of this method
  1768. <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
  1769. That method streams the rendering onto an existing Writer
  1770. which can give better performance if the caller already has
  1771. a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
  1772. </para>
  1773. </remarks>
  1774. </member>
  1775. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  1776. <summary>
  1777. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  1778. </summary>
  1779. <param name="loggingEvent">The event to render.</param>
  1780. <param name="writer">The TextWriter to write the formatted event to</param>
  1781. <remarks>
  1782. <para>
  1783. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  1784. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  1785. set to render the <paramref name="loggingEvent"/> to
  1786. a string.
  1787. </para>
  1788. <para>If there is exception data in the logging event and
  1789. the layout does not process the exception, this method
  1790. will append the exception text to the rendered string.
  1791. </para>
  1792. <para>
  1793. Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
  1794. where possible. If, however, the caller needs to render the event
  1795. to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
  1796. provide an efficient mechanism for doing so.
  1797. </para>
  1798. </remarks>
  1799. </member>
  1800. <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
  1801. <summary>
  1802. Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  1803. </summary>
  1804. <remarks>
  1805. <para>
  1806. In the rather exceptional case, where the appender
  1807. implementation admits a layout but can also work without it,
  1808. then the appender should return <c>true</c>.
  1809. </para>
  1810. <para>
  1811. This default implementation always returns <c>false</c>.
  1812. </para>
  1813. </remarks>
  1814. <returns>
  1815. <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
  1816. </returns>
  1817. </member>
  1818. <member name="M:log4net.Appender.AppenderSkeleton.Flush(System.Int32)">
  1819. <summary>
  1820. Flushes any buffered log data.
  1821. </summary>
  1822. <remarks>
  1823. This implementation doesn't flush anything and always returns true
  1824. </remarks>
  1825. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  1826. </member>
  1827. <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
  1828. <summary>
  1829. The layout of this appender.
  1830. </summary>
  1831. <remarks>
  1832. See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
  1833. </remarks>
  1834. </member>
  1835. <member name="F:log4net.Appender.AppenderSkeleton.m_name">
  1836. <summary>
  1837. The name of this appender.
  1838. </summary>
  1839. <remarks>
  1840. See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
  1841. </remarks>
  1842. </member>
  1843. <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
  1844. <summary>
  1845. The level threshold of this appender.
  1846. </summary>
  1847. <remarks>
  1848. <para>
  1849. There is no level threshold filtering by default.
  1850. </para>
  1851. <para>
  1852. See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
  1853. </para>
  1854. </remarks>
  1855. </member>
  1856. <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
  1857. <summary>
  1858. It is assumed and enforced that errorHandler is never null.
  1859. </summary>
  1860. <remarks>
  1861. <para>
  1862. It is assumed and enforced that errorHandler is never null.
  1863. </para>
  1864. <para>
  1865. See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
  1866. </para>
  1867. </remarks>
  1868. </member>
  1869. <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
  1870. <summary>
  1871. The first filter in the filter chain.
  1872. </summary>
  1873. <remarks>
  1874. <para>
  1875. Set to <c>null</c> initially.
  1876. </para>
  1877. <para>
  1878. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  1879. </para>
  1880. </remarks>
  1881. </member>
  1882. <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
  1883. <summary>
  1884. The last filter in the filter chain.
  1885. </summary>
  1886. <remarks>
  1887. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  1888. </remarks>
  1889. </member>
  1890. <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
  1891. <summary>
  1892. Flag indicating if this appender is closed.
  1893. </summary>
  1894. <remarks>
  1895. See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
  1896. </remarks>
  1897. </member>
  1898. <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
  1899. <summary>
  1900. The guard prevents an appender from repeatedly calling its own DoAppend method
  1901. </summary>
  1902. </member>
  1903. <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
  1904. <summary>
  1905. StringWriter used to render events
  1906. </summary>
  1907. </member>
  1908. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
  1909. <summary>
  1910. Initial buffer size
  1911. </summary>
  1912. </member>
  1913. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
  1914. <summary>
  1915. Maximum buffer size before it is recycled
  1916. </summary>
  1917. </member>
  1918. <member name="F:log4net.Appender.AppenderSkeleton.declaringType">
  1919. <summary>
  1920. The fully qualified type of the AppenderSkeleton class.
  1921. </summary>
  1922. <remarks>
  1923. Used by the internal logger to record the Type of the
  1924. log message.
  1925. </remarks>
  1926. </member>
  1927. <member name="T:log4net.Appender.BufferingAppenderSkeleton">
  1928. <summary>
  1929. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
  1930. buffers events in a fixed size buffer.
  1931. </summary>
  1932. <remarks>
  1933. <para>
  1934. This base class should be used by appenders that need to buffer a
  1935. number of events before logging them.
  1936. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
  1937. buffers events and then submits the entire contents of the buffer to
  1938. the underlying database in one go.
  1939. </para>
  1940. <para>
  1941. Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
  1942. method to deliver the buffered events.
  1943. </para>
  1944. <para>The BufferingAppenderSkeleton maintains a fixed size cyclic
  1945. buffer of events. The size of the buffer is set using
  1946. the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
  1947. </para>
  1948. <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
  1949. each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  1950. triggers, then the current buffer is sent immediately
  1951. (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
  1952. is stored in the buffer. For example, an evaluator can be used to
  1953. deliver the events immediately when an ERROR event arrives.
  1954. </para>
  1955. <para>
  1956. The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
  1957. By default the appender is NOT lossy. When the buffer is full all
  1958. the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
  1959. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
  1960. buffer will not be sent when it is full, and new events arriving
  1961. in the appender will overwrite the oldest event in the buffer.
  1962. In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  1963. triggers. This can be useful behavior when you need to know about
  1964. ERROR events but not about events with a lower level, configure an
  1965. evaluator that will trigger when an ERROR event arrives, the whole
  1966. buffer will be sent which gives a history of events leading up to
  1967. the ERROR event.
  1968. </para>
  1969. </remarks>
  1970. <author>Nicko Cadell</author>
  1971. <author>Gert Driesen</author>
  1972. </member>
  1973. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
  1974. <summary>
  1975. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton" /> class.
  1976. </summary>
  1977. <remarks>
  1978. <para>
  1979. Protected default constructor to allow subclassing.
  1980. </para>
  1981. </remarks>
  1982. </member>
  1983. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
  1984. <summary>
  1985. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton" /> class.
  1986. </summary>
  1987. <param name="eventMustBeFixed">the events passed through this appender must be
  1988. fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
  1989. <remarks>
  1990. <para>
  1991. Protected constructor to allow subclassing.
  1992. </para>
  1993. <para>
  1994. The <paramref name="eventMustBeFixed"/> should be set if the subclass
  1995. expects the events delivered to be fixed even if the
  1996. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
  1997. </para>
  1998. </remarks>
  1999. </member>
  2000. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
  2001. <summary>
  2002. Gets or sets a value that indicates whether the appender is lossy.
  2003. </summary>
  2004. <value>
  2005. <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
  2006. </value>
  2007. <remarks>
  2008. <para>
  2009. This appender uses a buffer to store logging events before
  2010. delivering them. A triggering event causes the whole buffer
  2011. to be send to the remote sink. If the buffer overruns before
  2012. a triggering event then logging events could be lost. Set
  2013. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
  2014. from being lost.
  2015. </para>
  2016. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  2017. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  2018. </remarks>
  2019. </member>
  2020. <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
  2021. <summary>
  2022. Gets or sets the size of the cyclic buffer used to hold the
  2023. logging events.
  2024. </summary>
  2025. <value>
  2026. The size of the cyclic buffer used to hold the logging events.
  2027. </value>
  2028. <remarks>
  2029. <para>
  2030. The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
  2031. representing the maximum number of logging events to collect in
  2032. a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
  2033. oldest events are deleted as new events are added to the
  2034. buffer. By default the size of the cyclic buffer is 512 events.
  2035. </para>
  2036. <para>
  2037. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
  2038. or equal to 1 then no buffering will occur. The logging event
  2039. will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
  2040. and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
  2041. be buffered.
  2042. </para>
  2043. </remarks>
  2044. </member>
  2045. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
  2046. <summary>
  2047. Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
  2048. buffer to be sent immediately.
  2049. </summary>
  2050. <value>
  2051. The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
  2052. sent immediately.
  2053. </value>
  2054. <remarks>
  2055. <para>
  2056. The evaluator will be called for each event that is appended to this
  2057. appender. If the evaluator triggers then the current buffer will
  2058. immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  2059. </para>
  2060. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  2061. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  2062. </remarks>
  2063. </member>
  2064. <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
  2065. <summary>
  2066. Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  2067. </summary>
  2068. <value>
  2069. The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  2070. </value>
  2071. <remarks>
  2072. <para>
  2073. The evaluator will be called for each event that is discarded from this
  2074. appender. If the evaluator triggers then the current buffer will immediately
  2075. be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  2076. </para>
  2077. </remarks>
  2078. </member>
  2079. <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
  2080. <summary>
  2081. Gets or sets a value indicating if only part of the logging event data
  2082. should be fixed.
  2083. </summary>
  2084. <value>
  2085. <c>true</c> if the appender should only fix part of the logging event
  2086. data, otherwise <c>false</c>. The default is <c>false</c>.
  2087. </value>
  2088. <remarks>
  2089. <para>
  2090. Setting this property to <c>true</c> will cause only part of the
  2091. event data to be fixed and serialized. This will improve performance.
  2092. </para>
  2093. <para>
  2094. See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
  2095. </para>
  2096. </remarks>
  2097. </member>
  2098. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
  2099. <summary>
  2100. Gets or sets a the fields that will be fixed in the event
  2101. </summary>
  2102. <value>
  2103. The event fields that will be fixed before the event is buffered
  2104. </value>
  2105. <remarks>
  2106. <para>
  2107. The logging event needs to have certain thread specific values
  2108. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  2109. for details.
  2110. </para>
  2111. </remarks>
  2112. <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
  2113. </member>
  2114. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Int32)">
  2115. <summary>
  2116. Flushes any buffered log data.
  2117. </summary>
  2118. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  2119. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  2120. </member>
  2121. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
  2122. <summary>
  2123. Flush the currently buffered events
  2124. </summary>
  2125. <remarks>
  2126. <para>
  2127. Flushes any events that have been buffered.
  2128. </para>
  2129. <para>
  2130. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  2131. of the buffer will NOT be flushed to the appender.
  2132. </para>
  2133. </remarks>
  2134. </member>
  2135. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
  2136. <summary>
  2137. Flush the currently buffered events
  2138. </summary>
  2139. <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
  2140. <remarks>
  2141. <para>
  2142. Flushes events that have been buffered. If <paramref name="flushLossyBuffer" /> is
  2143. <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
  2144. </para>
  2145. <para>
  2146. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  2147. of the buffer will only be flushed if <paramref name="flushLossyBuffer" /> is <c>true</c>.
  2148. In this case the contents of the buffer will be tested against the
  2149. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
  2150. events will be discarded.
  2151. </para>
  2152. <para>
  2153. If <paramref name="flushLossyBuffer" /> is <c>true</c> then the buffer will always
  2154. be emptied by calling this method.
  2155. </para>
  2156. </remarks>
  2157. </member>
  2158. <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
  2159. <summary>
  2160. Initialize the appender based on the options set
  2161. </summary>
  2162. <remarks>
  2163. <para>
  2164. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  2165. activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
  2166. be called on this object after the configuration properties have
  2167. been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
  2168. object is in an undefined state and must not be used.
  2169. </para>
  2170. <para>
  2171. If any of the configuration properties are modified then
  2172. <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
  2173. </para>
  2174. </remarks>
  2175. </member>
  2176. <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
  2177. <summary>
  2178. Close this appender instance.
  2179. </summary>
  2180. <remarks>
  2181. <para>
  2182. Close this appender instance. If this appender is marked
  2183. as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
  2184. the buffer must be sent when the appender is closed.
  2185. </para>
  2186. </remarks>
  2187. </member>
  2188. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  2189. <summary>
  2190. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  2191. </summary>
  2192. <param name="loggingEvent">the event to log</param>
  2193. <remarks>
  2194. <para>
  2195. Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
  2196. </para>
  2197. <para>
  2198. The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
  2199. method) if one of the following conditions is met:
  2200. </para>
  2201. <list type="bullet">
  2202. <item>
  2203. <description>The cyclic buffer is full and this appender is
  2204. marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
  2205. </item>
  2206. <item>
  2207. <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
  2208. it is triggered for the <paramref name="loggingEvent"/>
  2209. specified.</description>
  2210. </item>
  2211. </list>
  2212. <para>
  2213. Before the event is stored in the buffer it is fixed
  2214. (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
  2215. any data referenced by the event will be valid when the buffer
  2216. is processed.
  2217. </para>
  2218. </remarks>
  2219. </member>
  2220. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
  2221. <summary>
  2222. Sends the contents of the buffer.
  2223. </summary>
  2224. <param name="firstLoggingEvent">The first logging event.</param>
  2225. <param name="buffer">The buffer containing the events that need to be send.</param>
  2226. <remarks>
  2227. <para>
  2228. The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
  2229. </para>
  2230. </remarks>
  2231. </member>
  2232. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
  2233. <summary>
  2234. Sends the events.
  2235. </summary>
  2236. <param name="events">The events that need to be send.</param>
  2237. <remarks>
  2238. <para>
  2239. The subclass must override this method to process the buffered events.
  2240. </para>
  2241. </remarks>
  2242. </member>
  2243. <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
  2244. <summary>
  2245. The default buffer size.
  2246. </summary>
  2247. <remarks>
  2248. The default size of the cyclic buffer used to store events.
  2249. This is set to 512 by default.
  2250. </remarks>
  2251. </member>
  2252. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
  2253. <summary>
  2254. The size of the cyclic buffer used to hold the logging events.
  2255. </summary>
  2256. <remarks>
  2257. Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
  2258. </remarks>
  2259. </member>
  2260. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
  2261. <summary>
  2262. The cyclic buffer used to store the logging events.
  2263. </summary>
  2264. </member>
  2265. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
  2266. <summary>
  2267. The triggering event evaluator that causes the buffer to be sent immediately.
  2268. </summary>
  2269. <remarks>
  2270. The object that is used to determine if an event causes the entire
  2271. buffer to be sent immediately. This field can be <c>null</c>, which
  2272. indicates that event triggering is not to be done. The evaluator
  2273. can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
  2274. has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
  2275. <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
  2276. </remarks>
  2277. </member>
  2278. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
  2279. <summary>
  2280. Indicates if the appender should overwrite events in the cyclic buffer
  2281. when it becomes full, or if the buffer should be flushed when the
  2282. buffer is full.
  2283. </summary>
  2284. <remarks>
  2285. If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
  2286. be set.
  2287. </remarks>
  2288. </member>
  2289. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
  2290. <summary>
  2291. The triggering event evaluator filters discarded events.
  2292. </summary>
  2293. <remarks>
  2294. The object that is used to determine if an event that is discarded should
  2295. really be discarded or if it should be sent to the appenders.
  2296. This field can be <c>null</c>, which indicates that all discarded events will
  2297. be discarded.
  2298. </remarks>
  2299. </member>
  2300. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
  2301. <summary>
  2302. Value indicating which fields in the event should be fixed
  2303. </summary>
  2304. <remarks>
  2305. By default all fields are fixed
  2306. </remarks>
  2307. </member>
  2308. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
  2309. <summary>
  2310. The events delivered to the subclass must be fixed.
  2311. </summary>
  2312. </member>
  2313. <member name="T:log4net.Appender.BufferingForwardingAppender">
  2314. <summary>
  2315. Buffers events and then forwards them to attached appenders.
  2316. </summary>
  2317. <remarks>
  2318. <para>
  2319. The events are buffered in this appender until conditions are
  2320. met to allow the appender to deliver the events to the attached
  2321. appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
  2322. conditions that cause the buffer to be sent.
  2323. </para>
  2324. <para>The forwarding appender can be used to specify different
  2325. thresholds and filters for the same appender at different locations
  2326. within the hierarchy.
  2327. </para>
  2328. </remarks>
  2329. <author>Nicko Cadell</author>
  2330. <author>Gert Driesen</author>
  2331. </member>
  2332. <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
  2333. <summary>
  2334. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender" /> class.
  2335. </summary>
  2336. <remarks>
  2337. <para>
  2338. Default constructor.
  2339. </para>
  2340. </remarks>
  2341. </member>
  2342. <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
  2343. <summary>
  2344. Closes the appender and releases resources.
  2345. </summary>
  2346. <remarks>
  2347. <para>
  2348. Releases any resources allocated within the appender such as file handles,
  2349. network connections, etc.
  2350. </para>
  2351. <para>
  2352. It is a programming error to append to a closed appender.
  2353. </para>
  2354. </remarks>
  2355. </member>
  2356. <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  2357. <summary>
  2358. Send the events.
  2359. </summary>
  2360. <param name="events">The events that need to be send.</param>
  2361. <remarks>
  2362. <para>
  2363. Forwards the events to the attached appenders.
  2364. </para>
  2365. </remarks>
  2366. </member>
  2367. <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  2368. <summary>
  2369. Adds an <see cref="T:log4net.Appender.IAppender" /> to the list of appenders of this
  2370. instance.
  2371. </summary>
  2372. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender" /> to add to this appender.</param>
  2373. <remarks>
  2374. <para>
  2375. If the specified <see cref="T:log4net.Appender.IAppender" /> is already in the list of
  2376. appenders, then it won't be added again.
  2377. </para>
  2378. </remarks>
  2379. </member>
  2380. <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
  2381. <summary>
  2382. Gets the appenders contained in this appender as an
  2383. <see cref="T:System.Collections.ICollection"/>.
  2384. </summary>
  2385. <remarks>
  2386. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  2387. is returned.
  2388. </remarks>
  2389. <returns>
  2390. A collection of the appenders in this appender.
  2391. </returns>
  2392. </member>
  2393. <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
  2394. <summary>
  2395. Looks for the appender with the specified name.
  2396. </summary>
  2397. <param name="name">The name of the appender to lookup.</param>
  2398. <returns>
  2399. The appender with the specified name, or <c>null</c>.
  2400. </returns>
  2401. <remarks>
  2402. <para>
  2403. Get the named appender attached to this buffering appender.
  2404. </para>
  2405. </remarks>
  2406. </member>
  2407. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
  2408. <summary>
  2409. Removes all previously added appenders from this appender.
  2410. </summary>
  2411. <remarks>
  2412. <para>
  2413. This is useful when re-reading configuration information.
  2414. </para>
  2415. </remarks>
  2416. </member>
  2417. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  2418. <summary>
  2419. Removes the specified appender from the list of appenders.
  2420. </summary>
  2421. <param name="appender">The appender to remove.</param>
  2422. <returns>The appender removed from the list</returns>
  2423. <remarks>
  2424. The appender removed is not closed.
  2425. If you are discarding the appender you must call
  2426. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2427. </remarks>
  2428. </member>
  2429. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
  2430. <summary>
  2431. Removes the appender with the specified name from the list of appenders.
  2432. </summary>
  2433. <param name="name">The name of the appender to remove.</param>
  2434. <returns>The appender removed from the list</returns>
  2435. <remarks>
  2436. The appender removed is not closed.
  2437. If you are discarding the appender you must call
  2438. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2439. </remarks>
  2440. </member>
  2441. <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
  2442. <summary>
  2443. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  2444. </summary>
  2445. </member>
  2446. <member name="T:log4net.Appender.ConsoleAppender">
  2447. <summary>
  2448. Appends logging events to the console.
  2449. </summary>
  2450. <remarks>
  2451. <para>
  2452. ConsoleAppender appends log events to the standard output stream
  2453. or the error output stream using a layout specified by the
  2454. user.
  2455. </para>
  2456. <para>
  2457. By default, all output is written to the console's standard output stream.
  2458. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
  2459. error stream.
  2460. </para>
  2461. <para>
  2462. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  2463. <c>System.Console.Error</c> that is set at the time the event is appended.
  2464. Therefore it is possible to programmatically redirect the output of this appender
  2465. (for example NUnit does this to capture program output). While this is the desired
  2466. behavior of this appender it may have security implications in your application.
  2467. </para>
  2468. </remarks>
  2469. <author>Nicko Cadell</author>
  2470. <author>Gert Driesen</author>
  2471. </member>
  2472. <member name="M:log4net.Appender.ConsoleAppender.#ctor">
  2473. <summary>
  2474. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class.
  2475. </summary>
  2476. <remarks>
  2477. The instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class is set up to write
  2478. to the standard output stream.
  2479. </remarks>
  2480. </member>
  2481. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2482. <summary>
  2483. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class
  2484. with the specified layout.
  2485. </summary>
  2486. <param name="layout">the layout to use for this appender</param>
  2487. <remarks>
  2488. The instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class is set up to write
  2489. to the standard output stream.
  2490. </remarks>
  2491. </member>
  2492. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2493. <summary>
  2494. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class
  2495. with the specified layout.
  2496. </summary>
  2497. <param name="layout">the layout to use for this appender</param>
  2498. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2499. <remarks>
  2500. When <paramref name="writeToErrorStream" /> is set to <c>true</c>, output is written to
  2501. the standard error output stream. Otherwise, output is written to the standard
  2502. output stream.
  2503. </remarks>
  2504. </member>
  2505. <member name="P:log4net.Appender.ConsoleAppender.Target">
  2506. <summary>
  2507. Target is the value of the console output stream.
  2508. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2509. </summary>
  2510. <value>
  2511. Target is the value of the console output stream.
  2512. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2513. </value>
  2514. <remarks>
  2515. <para>
  2516. Target is the value of the console output stream.
  2517. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2518. </para>
  2519. </remarks>
  2520. </member>
  2521. <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2522. <summary>
  2523. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  2524. </summary>
  2525. <param name="loggingEvent">The event to log.</param>
  2526. <remarks>
  2527. <para>
  2528. Writes the event to the console.
  2529. </para>
  2530. <para>
  2531. The format of the output will depend on the appender's layout.
  2532. </para>
  2533. </remarks>
  2534. </member>
  2535. <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
  2536. <summary>
  2537. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2538. </summary>
  2539. <value><c>true</c></value>
  2540. <remarks>
  2541. <para>
  2542. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2543. </para>
  2544. </remarks>
  2545. </member>
  2546. <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
  2547. <summary>
  2548. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2549. standard output stream.
  2550. </summary>
  2551. <remarks>
  2552. <para>
  2553. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2554. standard output stream.
  2555. </para>
  2556. </remarks>
  2557. </member>
  2558. <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
  2559. <summary>
  2560. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2561. standard error output stream.
  2562. </summary>
  2563. <remarks>
  2564. <para>
  2565. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2566. standard error output stream.
  2567. </para>
  2568. </remarks>
  2569. </member>
  2570. <member name="T:log4net.Appender.DebugAppender">
  2571. <summary>
  2572. Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
  2573. </summary>
  2574. <remarks>
  2575. <para>
  2576. The application configuration file can be used to control what listeners
  2577. are actually used. See the MSDN documentation for the
  2578. <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
  2579. debug system.
  2580. </para>
  2581. <para>
  2582. Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
  2583. method. The event's logger name is passed as the value for the category name to the Write method.
  2584. </para>
  2585. </remarks>
  2586. <author>Nicko Cadell</author>
  2587. </member>
  2588. <member name="M:log4net.Appender.DebugAppender.#ctor">
  2589. <summary>
  2590. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender" />.
  2591. </summary>
  2592. <remarks>
  2593. <para>
  2594. Default constructor.
  2595. </para>
  2596. </remarks>
  2597. </member>
  2598. <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
  2599. <summary>
  2600. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender" />
  2601. with a specified layout.
  2602. </summary>
  2603. <param name="layout">The layout to use with this appender.</param>
  2604. <remarks>
  2605. <para>
  2606. Obsolete constructor.
  2607. </para>
  2608. </remarks>
  2609. </member>
  2610. <member name="P:log4net.Appender.DebugAppender.Category">
  2611. <summary>
  2612. Formats the category parameter sent to the Debug method.
  2613. </summary>
  2614. <remarks>
  2615. <para>
  2616. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern which will use the logger name of the current
  2617. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  2618. </para>
  2619. <para>
  2620. </para>
  2621. </remarks>
  2622. </member>
  2623. <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
  2624. <summary>
  2625. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  2626. </summary>
  2627. <param name="loggingEvent">The event to log.</param>
  2628. <remarks>
  2629. <para>
  2630. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  2631. </para>
  2632. </remarks>
  2633. </member>
  2634. <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
  2635. <summary>
  2636. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2637. </summary>
  2638. <value><c>true</c></value>
  2639. <remarks>
  2640. <para>
  2641. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2642. </para>
  2643. </remarks>
  2644. </member>
  2645. <member name="F:log4net.Appender.DebugAppender.m_category">
  2646. <summary>
  2647. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern.
  2648. </summary>
  2649. </member>
  2650. <member name="T:log4net.Appender.FileAppender">
  2651. <summary>
  2652. Appends logging events to a file.
  2653. </summary>
  2654. <remarks>
  2655. <para>
  2656. Logging events are sent to the file specified by
  2657. the <see cref="P:log4net.Appender.FileAppender.File"/> property.
  2658. </para>
  2659. <para>
  2660. The file can be opened in either append or overwrite mode
  2661. by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
  2662. If the file path is relative it is taken as relative from
  2663. the application base directory. The file encoding can be
  2664. specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
  2665. </para>
  2666. <para>
  2667. The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  2668. values will be written each time the file is opened and closed
  2669. respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
  2670. then the file may contain multiple copies of the header and footer.
  2671. </para>
  2672. <para>
  2673. This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
  2674. is called. This will typically be during configuration.
  2675. If the file cannot be opened for writing the appender will attempt
  2676. to open the file again each time a message is logged to the appender.
  2677. If the file cannot be opened for writing when a message is logged then
  2678. the message will be discarded by this appender.
  2679. </para>
  2680. <para>
  2681. The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
  2682. the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
  2683. The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
  2684. is to obtain an exclusive write lock on the file until this appender is closed.
  2685. The alternative models only hold a
  2686. write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
  2687. or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
  2688. </para>
  2689. <para>
  2690. All locking strategies have issues and you should seriously consider using a different strategy that
  2691. avoids having multiple processes logging to the same file.
  2692. </para>
  2693. </remarks>
  2694. <author>Nicko Cadell</author>
  2695. <author>Gert Driesen</author>
  2696. <author>Rodrigo B. de Oliveira</author>
  2697. <author>Douglas de la Torre</author>
  2698. <author>Niall Daley</author>
  2699. </member>
  2700. <member name="T:log4net.Appender.FileAppender.LockingStream">
  2701. <summary>
  2702. Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
  2703. to manage access to an underlying resource.
  2704. </summary>
  2705. </member>
  2706. <member name="T:log4net.Appender.FileAppender.LockingModelBase">
  2707. <summary>
  2708. Locking model base class
  2709. </summary>
  2710. <remarks>
  2711. <para>
  2712. Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
  2713. </para>
  2714. </remarks>
  2715. </member>
  2716. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  2717. <summary>
  2718. Open the output file
  2719. </summary>
  2720. <param name="filename">The filename to use</param>
  2721. <param name="append">Whether to append to the file, or overwrite</param>
  2722. <param name="encoding">The encoding to use</param>
  2723. <remarks>
  2724. <para>
  2725. Open the file specified and prepare for logging.
  2726. No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
  2727. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
  2728. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
  2729. </para>
  2730. </remarks>
  2731. </member>
  2732. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
  2733. <summary>
  2734. Close the file
  2735. </summary>
  2736. <remarks>
  2737. <para>
  2738. Close the file. No further writes will be made.
  2739. </para>
  2740. </remarks>
  2741. </member>
  2742. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ActivateOptions">
  2743. <summary>
  2744. Initializes all resources used by this locking model.
  2745. </summary>
  2746. </member>
  2747. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OnClose">
  2748. <summary>
  2749. Disposes all resources that were initialized by this locking model.
  2750. </summary>
  2751. </member>
  2752. <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
  2753. <summary>
  2754. Acquire the lock on the file
  2755. </summary>
  2756. <returns>A stream that is ready to be written to.</returns>
  2757. <remarks>
  2758. <para>
  2759. Acquire the lock on the file in preparation for writing to it.
  2760. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
  2761. must be called to release the lock on the output file.
  2762. </para>
  2763. </remarks>
  2764. </member>
  2765. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
  2766. <summary>
  2767. Release the lock on the file
  2768. </summary>
  2769. <remarks>
  2770. <para>
  2771. Release the lock on the file. No further writes will be made to the
  2772. stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
  2773. </para>
  2774. </remarks>
  2775. </member>
  2776. <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
  2777. <summary>
  2778. Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  2779. </summary>
  2780. <value>
  2781. The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  2782. </value>
  2783. <remarks>
  2784. <para>
  2785. The file appender this locking model is attached to and working on
  2786. behalf of.
  2787. </para>
  2788. <para>
  2789. The file appender is used to locate the security context and the error handler to use.
  2790. </para>
  2791. <para>
  2792. 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
  2793. called.
  2794. </para>
  2795. </remarks>
  2796. </member>
  2797. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
  2798. <summary>
  2799. Helper method that creates a FileStream under CurrentAppender's SecurityContext.
  2800. </summary>
  2801. <remarks>
  2802. <para>
  2803. Typically called during OpenFile or AcquireLock.
  2804. </para>
  2805. <para>
  2806. If the directory portion of the <paramref name="filename"/> does not exist, it is created
  2807. via Directory.CreateDirecctory.
  2808. </para>
  2809. </remarks>
  2810. <param name="filename"></param>
  2811. <param name="append"></param>
  2812. <param name="fileShare"></param>
  2813. <returns></returns>
  2814. </member>
  2815. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
  2816. <summary>
  2817. Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
  2818. </summary>
  2819. <remarks>
  2820. Does not set <paramref name="stream"/> to null.
  2821. </remarks>
  2822. <param name="stream"></param>
  2823. </member>
  2824. <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
  2825. <summary>
  2826. Hold an exclusive lock on the output file
  2827. </summary>
  2828. <remarks>
  2829. <para>
  2830. Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
  2831. Maintains an exclusive lock on the file during this time.
  2832. </para>
  2833. </remarks>
  2834. </member>
  2835. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  2836. <summary>
  2837. Open the file specified and prepare for logging.
  2838. </summary>
  2839. <param name="filename">The filename to use</param>
  2840. <param name="append">Whether to append to the file, or overwrite</param>
  2841. <param name="encoding">The encoding to use</param>
  2842. <remarks>
  2843. <para>
  2844. Open the file specified and prepare for logging.
  2845. No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
  2846. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
  2847. <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
  2848. </para>
  2849. </remarks>
  2850. </member>
  2851. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
  2852. <summary>
  2853. Close the file
  2854. </summary>
  2855. <remarks>
  2856. <para>
  2857. Close the file. No further writes will be made.
  2858. </para>
  2859. </remarks>
  2860. </member>
  2861. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
  2862. <summary>
  2863. Acquire the lock on the file
  2864. </summary>
  2865. <returns>A stream that is ready to be written to.</returns>
  2866. <remarks>
  2867. <para>
  2868. Does nothing. The lock is already taken
  2869. </para>
  2870. </remarks>
  2871. </member>
  2872. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
  2873. <summary>
  2874. Release the lock on the file
  2875. </summary>
  2876. <remarks>
  2877. <para>
  2878. Does nothing. The lock will be released when the file is closed.
  2879. </para>
  2880. </remarks>
  2881. </member>
  2882. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ActivateOptions">
  2883. <summary>
  2884. Initializes all resources used by this locking model.
  2885. </summary>
  2886. </member>
  2887. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OnClose">
  2888. <summary>
  2889. Disposes all resources that were initialized by this locking model.
  2890. </summary>
  2891. </member>
  2892. <member name="T:log4net.Appender.FileAppender.MinimalLock">
  2893. <summary>
  2894. Acquires the file lock for each write
  2895. </summary>
  2896. <remarks>
  2897. <para>
  2898. Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
  2899. thus holding the lock for the minimal amount of time. This method of locking
  2900. is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
  2901. other processes to move/delete the log file whilst logging continues.
  2902. </para>
  2903. </remarks>
  2904. </member>
  2905. <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  2906. <summary>
  2907. Prepares to open the file when the first message is logged.
  2908. </summary>
  2909. <param name="filename">The filename to use</param>
  2910. <param name="append">Whether to append to the file, or overwrite</param>
  2911. <param name="encoding">The encoding to use</param>
  2912. <remarks>
  2913. <para>
  2914. Open the file specified and prepare for logging.
  2915. No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
  2916. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
  2917. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
  2918. </para>
  2919. </remarks>
  2920. </member>
  2921. <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
  2922. <summary>
  2923. Close the file
  2924. </summary>
  2925. <remarks>
  2926. <para>
  2927. Close the file. No further writes will be made.
  2928. </para>
  2929. </remarks>
  2930. </member>
  2931. <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
  2932. <summary>
  2933. Acquire the lock on the file
  2934. </summary>
  2935. <returns>A stream that is ready to be written to.</returns>
  2936. <remarks>
  2937. <para>
  2938. Acquire the lock on the file in preparation for writing to it.
  2939. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
  2940. must be called to release the lock on the output file.
  2941. </para>
  2942. </remarks>
  2943. </member>
  2944. <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
  2945. <summary>
  2946. Release the lock on the file
  2947. </summary>
  2948. <remarks>
  2949. <para>
  2950. Release the lock on the file. No further writes will be made to the
  2951. stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
  2952. </para>
  2953. </remarks>
  2954. </member>
  2955. <member name="M:log4net.Appender.FileAppender.MinimalLock.ActivateOptions">
  2956. <summary>
  2957. Initializes all resources used by this locking model.
  2958. </summary>
  2959. </member>
  2960. <member name="M:log4net.Appender.FileAppender.MinimalLock.OnClose">
  2961. <summary>
  2962. Disposes all resources that were initialized by this locking model.
  2963. </summary>
  2964. </member>
  2965. <member name="T:log4net.Appender.FileAppender.InterProcessLock">
  2966. <summary>
  2967. Provides cross-process file locking.
  2968. </summary>
  2969. <author>Ron Grabowski</author>
  2970. <author>Steve Wranovsky</author>
  2971. </member>
  2972. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  2973. <summary>
  2974. Open the file specified and prepare for logging.
  2975. </summary>
  2976. <param name="filename">The filename to use</param>
  2977. <param name="append">Whether to append to the file, or overwrite</param>
  2978. <param name="encoding">The encoding to use</param>
  2979. <remarks>
  2980. <para>
  2981. Open the file specified and prepare for logging.
  2982. No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
  2983. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
  2984. -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
  2985. </para>
  2986. </remarks>
  2987. </member>
  2988. <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
  2989. <summary>
  2990. Close the file
  2991. </summary>
  2992. <remarks>
  2993. <para>
  2994. Close the file. No further writes will be made.
  2995. </para>
  2996. </remarks>
  2997. </member>
  2998. <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
  2999. <summary>
  3000. Acquire the lock on the file
  3001. </summary>
  3002. <returns>A stream that is ready to be written to.</returns>
  3003. <remarks>
  3004. <para>
  3005. Does nothing. The lock is already taken
  3006. </para>
  3007. </remarks>
  3008. </member>
  3009. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
  3010. <summary>
  3011. Releases the lock and allows others to acquire a lock.
  3012. </summary>
  3013. </member>
  3014. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ActivateOptions">
  3015. <summary>
  3016. Initializes all resources used by this locking model.
  3017. </summary>
  3018. </member>
  3019. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OnClose">
  3020. <summary>
  3021. Disposes all resources that were initialized by this locking model.
  3022. </summary>
  3023. </member>
  3024. <member name="M:log4net.Appender.FileAppender.#ctor">
  3025. <summary>
  3026. Default constructor
  3027. </summary>
  3028. <remarks>
  3029. <para>
  3030. Default constructor
  3031. </para>
  3032. </remarks>
  3033. </member>
  3034. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
  3035. <summary>
  3036. Construct a new appender using the layout, file and append mode.
  3037. </summary>
  3038. <param name="layout">the layout to use with this appender</param>
  3039. <param name="filename">the full path to the file to write to</param>
  3040. <param name="append">flag to indicate if the file should be appended to</param>
  3041. <remarks>
  3042. <para>
  3043. Obsolete constructor.
  3044. </para>
  3045. </remarks>
  3046. </member>
  3047. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
  3048. <summary>
  3049. Construct a new appender using the layout and file specified.
  3050. The file will be appended to.
  3051. </summary>
  3052. <param name="layout">the layout to use with this appender</param>
  3053. <param name="filename">the full path to the file to write to</param>
  3054. <remarks>
  3055. <para>
  3056. Obsolete constructor.
  3057. </para>
  3058. </remarks>
  3059. </member>
  3060. <member name="P:log4net.Appender.FileAppender.File">
  3061. <summary>
  3062. Gets or sets the path to the file that logging will be written to.
  3063. </summary>
  3064. <value>
  3065. The path to the file that logging will be written to.
  3066. </value>
  3067. <remarks>
  3068. <para>
  3069. If the path is relative it is taken as relative from
  3070. the application base directory.
  3071. </para>
  3072. </remarks>
  3073. </member>
  3074. <member name="P:log4net.Appender.FileAppender.AppendToFile">
  3075. <summary>
  3076. Gets or sets a flag that indicates whether the file should be
  3077. appended to or overwritten.
  3078. </summary>
  3079. <value>
  3080. Indicates whether the file should be appended to or overwritten.
  3081. </value>
  3082. <remarks>
  3083. <para>
  3084. If the value is set to false then the file will be overwritten, if
  3085. it is set to true then the file will be appended to.
  3086. </para>
  3087. The default value is true.
  3088. </remarks>
  3089. </member>
  3090. <member name="P:log4net.Appender.FileAppender.Encoding">
  3091. <summary>
  3092. Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  3093. </summary>
  3094. <value>
  3095. The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  3096. </value>
  3097. <remarks>
  3098. <para>
  3099. The default encoding set is <see cref="!:System.Text.Encoding.Default"/>
  3100. which is the encoding for the system's current ANSI code page.
  3101. </para>
  3102. </remarks>
  3103. </member>
  3104. <member name="P:log4net.Appender.FileAppender.SecurityContext">
  3105. <summary>
  3106. Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  3107. </summary>
  3108. <value>
  3109. The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  3110. </value>
  3111. <remarks>
  3112. <para>
  3113. Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
  3114. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3115. security context to use. The default behavior is to use the security context
  3116. of the current thread.
  3117. </para>
  3118. </remarks>
  3119. </member>
  3120. <member name="P:log4net.Appender.FileAppender.LockingModel">
  3121. <summary>
  3122. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  3123. </summary>
  3124. <value>
  3125. The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
  3126. </value>
  3127. <remarks>
  3128. <para>
  3129. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  3130. </para>
  3131. <para>
  3132. 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"/> .
  3133. The first locks the file from the start of logging to the end, the
  3134. second locks only for the minimal amount of time when logging each message
  3135. and the last synchronizes processes using a named system wide Mutex.
  3136. </para>
  3137. <para>
  3138. The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
  3139. </para>
  3140. </remarks>
  3141. </member>
  3142. <member name="M:log4net.Appender.FileAppender.ActivateOptions">
  3143. <summary>
  3144. Activate the options on the file appender.
  3145. </summary>
  3146. <remarks>
  3147. <para>
  3148. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3149. activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
  3150. be called on this object after the configuration properties have
  3151. been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
  3152. object is in an undefined state and must not be used.
  3153. </para>
  3154. <para>
  3155. If any of the configuration properties are modified then
  3156. <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
  3157. </para>
  3158. <para>
  3159. This will cause the file to be opened.
  3160. </para>
  3161. </remarks>
  3162. </member>
  3163. <member name="M:log4net.Appender.FileAppender.Reset">
  3164. <summary>
  3165. Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
  3166. </summary>
  3167. <remarks>
  3168. <para>
  3169. Resets the filename and the file stream.
  3170. </para>
  3171. </remarks>
  3172. </member>
  3173. <member name="M:log4net.Appender.FileAppender.OnClose">
  3174. <summary>
  3175. Close this appender instance. The underlying stream or writer is also closed.
  3176. </summary>
  3177. </member>
  3178. <member name="M:log4net.Appender.FileAppender.PrepareWriter">
  3179. <summary>
  3180. Called to initialize the file writer
  3181. </summary>
  3182. <remarks>
  3183. <para>
  3184. Will be called for each logged message until the file is
  3185. successfully opened.
  3186. </para>
  3187. </remarks>
  3188. </member>
  3189. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
  3190. <summary>
  3191. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3192. method.
  3193. </summary>
  3194. <param name="loggingEvent">The event to log.</param>
  3195. <remarks>
  3196. <para>
  3197. Writes a log statement to the output stream if the output stream exists
  3198. and is writable.
  3199. </para>
  3200. <para>
  3201. The format of the output will depend on the appender's layout.
  3202. </para>
  3203. </remarks>
  3204. </member>
  3205. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
  3206. <summary>
  3207. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  3208. method.
  3209. </summary>
  3210. <param name="loggingEvents">The array of events to log.</param>
  3211. <remarks>
  3212. <para>
  3213. Acquires the output file locks once before writing all the events to
  3214. the stream.
  3215. </para>
  3216. </remarks>
  3217. </member>
  3218. <member name="M:log4net.Appender.FileAppender.WriteFooter">
  3219. <summary>
  3220. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3221. </summary>
  3222. <remarks>
  3223. <para>
  3224. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3225. </para>
  3226. </remarks>
  3227. </member>
  3228. <member name="M:log4net.Appender.FileAppender.WriteHeader">
  3229. <summary>
  3230. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3231. </summary>
  3232. <remarks>
  3233. <para>
  3234. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3235. </para>
  3236. </remarks>
  3237. </member>
  3238. <member name="M:log4net.Appender.FileAppender.CloseWriter">
  3239. <summary>
  3240. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3241. </summary>
  3242. <remarks>
  3243. <para>
  3244. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3245. </para>
  3246. </remarks>
  3247. </member>
  3248. <member name="M:log4net.Appender.FileAppender.CloseFile">
  3249. <summary>
  3250. Closes the previously opened file.
  3251. </summary>
  3252. <remarks>
  3253. <para>
  3254. Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
  3255. closes the file.
  3256. </para>
  3257. </remarks>
  3258. </member>
  3259. <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
  3260. <summary>
  3261. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3262. </summary>
  3263. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3264. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3265. <remarks>
  3266. <para>
  3267. Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
  3268. Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
  3269. </para>
  3270. </remarks>
  3271. </member>
  3272. <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
  3273. <summary>
  3274. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3275. </summary>
  3276. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3277. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3278. <remarks>
  3279. <para>
  3280. If there was already an opened file, then the previous file
  3281. is closed first.
  3282. </para>
  3283. <para>
  3284. This method will ensure that the directory structure
  3285. for the <paramref name="fileName"/> specified exists.
  3286. </para>
  3287. </remarks>
  3288. </member>
  3289. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
  3290. <summary>
  3291. Sets the quiet writer used for file output
  3292. </summary>
  3293. <param name="fileStream">the file stream that has been opened for writing</param>
  3294. <remarks>
  3295. <para>
  3296. This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
  3297. over the <paramref name="fileStream"/> and passes it to the
  3298. <see cref="M:SetQWForFiles(TextWriter)"/> method.
  3299. </para>
  3300. <para>
  3301. This method can be overridden by sub classes that want to wrap the
  3302. <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
  3303. data using a <c>System.Security.Cryptography.CryptoStream</c>.
  3304. </para>
  3305. </remarks>
  3306. </member>
  3307. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
  3308. <summary>
  3309. Sets the quiet writer being used.
  3310. </summary>
  3311. <param name="writer">the writer over the file stream that has been opened for writing</param>
  3312. <remarks>
  3313. <para>
  3314. This method can be overridden by sub classes that want to
  3315. wrap the <see cref="T:System.IO.TextWriter"/> in some way.
  3316. </para>
  3317. </remarks>
  3318. </member>
  3319. <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
  3320. <summary>
  3321. Convert a path into a fully qualified path.
  3322. </summary>
  3323. <param name="path">The path to convert.</param>
  3324. <returns>The fully qualified path.</returns>
  3325. <remarks>
  3326. <para>
  3327. Converts the path specified to a fully
  3328. qualified path. If the path is relative it is
  3329. taken as relative from the application base
  3330. directory.
  3331. </para>
  3332. </remarks>
  3333. </member>
  3334. <member name="F:log4net.Appender.FileAppender.m_appendToFile">
  3335. <summary>
  3336. Flag to indicate if we should append to the file
  3337. or overwrite the file. The default is to append.
  3338. </summary>
  3339. </member>
  3340. <member name="F:log4net.Appender.FileAppender.m_fileName">
  3341. <summary>
  3342. The name of the log file.
  3343. </summary>
  3344. </member>
  3345. <member name="F:log4net.Appender.FileAppender.m_encoding">
  3346. <summary>
  3347. The encoding to use for the file stream.
  3348. </summary>
  3349. </member>
  3350. <member name="F:log4net.Appender.FileAppender.m_securityContext">
  3351. <summary>
  3352. The security context to use for privileged calls
  3353. </summary>
  3354. </member>
  3355. <member name="F:log4net.Appender.FileAppender.m_stream">
  3356. <summary>
  3357. The stream to log to. Has added locking semantics
  3358. </summary>
  3359. </member>
  3360. <member name="F:log4net.Appender.FileAppender.m_lockingModel">
  3361. <summary>
  3362. The locking model to use
  3363. </summary>
  3364. </member>
  3365. <member name="F:log4net.Appender.FileAppender.declaringType">
  3366. <summary>
  3367. The fully qualified type of the FileAppender class.
  3368. </summary>
  3369. <remarks>
  3370. Used by the internal logger to record the Type of the
  3371. log message.
  3372. </remarks>
  3373. </member>
  3374. <member name="T:log4net.Appender.ForwardingAppender">
  3375. <summary>
  3376. This appender forwards logging events to attached appenders.
  3377. </summary>
  3378. <remarks>
  3379. <para>
  3380. The forwarding appender can be used to specify different thresholds
  3381. and filters for the same appender at different locations within the hierarchy.
  3382. </para>
  3383. </remarks>
  3384. <author>Nicko Cadell</author>
  3385. <author>Gert Driesen</author>
  3386. </member>
  3387. <member name="M:log4net.Appender.ForwardingAppender.#ctor">
  3388. <summary>
  3389. Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender" /> class.
  3390. </summary>
  3391. <remarks>
  3392. <para>
  3393. Default constructor.
  3394. </para>
  3395. </remarks>
  3396. </member>
  3397. <member name="M:log4net.Appender.ForwardingAppender.OnClose">
  3398. <summary>
  3399. Closes the appender and releases resources.
  3400. </summary>
  3401. <remarks>
  3402. <para>
  3403. Releases any resources allocated within the appender such as file handles,
  3404. network connections, etc.
  3405. </para>
  3406. <para>
  3407. It is a programming error to append to a closed appender.
  3408. </para>
  3409. </remarks>
  3410. </member>
  3411. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
  3412. <summary>
  3413. Forward the logging event to the attached appenders
  3414. </summary>
  3415. <param name="loggingEvent">The event to log.</param>
  3416. <remarks>
  3417. <para>
  3418. Delivers the logging event to all the attached appenders.
  3419. </para>
  3420. </remarks>
  3421. </member>
  3422. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
  3423. <summary>
  3424. Forward the logging events to the attached appenders
  3425. </summary>
  3426. <param name="loggingEvents">The array of events to log.</param>
  3427. <remarks>
  3428. <para>
  3429. Delivers the logging events to all the attached appenders.
  3430. </para>
  3431. </remarks>
  3432. </member>
  3433. <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  3434. <summary>
  3435. Adds an <see cref="T:log4net.Appender.IAppender" /> to the list of appenders of this
  3436. instance.
  3437. </summary>
  3438. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender" /> to add to this appender.</param>
  3439. <remarks>
  3440. <para>
  3441. If the specified <see cref="T:log4net.Appender.IAppender" /> is already in the list of
  3442. appenders, then it won't be added again.
  3443. </para>
  3444. </remarks>
  3445. </member>
  3446. <member name="P:log4net.Appender.ForwardingAppender.Appenders">
  3447. <summary>
  3448. Gets the appenders contained in this appender as an
  3449. <see cref="T:System.Collections.ICollection"/>.
  3450. </summary>
  3451. <remarks>
  3452. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  3453. is returned.
  3454. </remarks>
  3455. <returns>
  3456. A collection of the appenders in this appender.
  3457. </returns>
  3458. </member>
  3459. <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
  3460. <summary>
  3461. Looks for the appender with the specified name.
  3462. </summary>
  3463. <param name="name">The name of the appender to lookup.</param>
  3464. <returns>
  3465. The appender with the specified name, or <c>null</c>.
  3466. </returns>
  3467. <remarks>
  3468. <para>
  3469. Get the named appender attached to this appender.
  3470. </para>
  3471. </remarks>
  3472. </member>
  3473. <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
  3474. <summary>
  3475. Removes all previously added appenders from this appender.
  3476. </summary>
  3477. <remarks>
  3478. <para>
  3479. This is useful when re-reading configuration information.
  3480. </para>
  3481. </remarks>
  3482. </member>
  3483. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  3484. <summary>
  3485. Removes the specified appender from the list of appenders.
  3486. </summary>
  3487. <param name="appender">The appender to remove.</param>
  3488. <returns>The appender removed from the list</returns>
  3489. <remarks>
  3490. The appender removed is not closed.
  3491. If you are discarding the appender you must call
  3492. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  3493. </remarks>
  3494. </member>
  3495. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
  3496. <summary>
  3497. Removes the appender with the specified name from the list of appenders.
  3498. </summary>
  3499. <param name="name">The name of the appender to remove.</param>
  3500. <returns>The appender removed from the list</returns>
  3501. <remarks>
  3502. The appender removed is not closed.
  3503. If you are discarding the appender you must call
  3504. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  3505. </remarks>
  3506. </member>
  3507. <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
  3508. <summary>
  3509. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  3510. </summary>
  3511. </member>
  3512. <member name="T:log4net.Appender.IAppender">
  3513. <summary>
  3514. Implement this interface for your own strategies for printing log statements.
  3515. </summary>
  3516. <remarks>
  3517. <para>
  3518. Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
  3519. class which provides a default implementation of this interface.
  3520. </para>
  3521. <para>
  3522. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  3523. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  3524. be called after the appenders properties have been configured.
  3525. </para>
  3526. </remarks>
  3527. <author>Nicko Cadell</author>
  3528. <author>Gert Driesen</author>
  3529. </member>
  3530. <member name="M:log4net.Appender.IAppender.Close">
  3531. <summary>
  3532. Closes the appender and releases resources.
  3533. </summary>
  3534. <remarks>
  3535. <para>
  3536. Releases any resources allocated within the appender such as file handles,
  3537. network connections, etc.
  3538. </para>
  3539. <para>
  3540. It is a programming error to append to a closed appender.
  3541. </para>
  3542. </remarks>
  3543. </member>
  3544. <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
  3545. <summary>
  3546. Log the logging event in Appender specific way.
  3547. </summary>
  3548. <param name="loggingEvent">The event to log</param>
  3549. <remarks>
  3550. <para>
  3551. This method is called to log a message into this appender.
  3552. </para>
  3553. </remarks>
  3554. </member>
  3555. <member name="P:log4net.Appender.IAppender.Name">
  3556. <summary>
  3557. Gets or sets the name of this appender.
  3558. </summary>
  3559. <value>The name of the appender.</value>
  3560. <remarks>
  3561. <para>The name uniquely identifies the appender.</para>
  3562. </remarks>
  3563. </member>
  3564. <member name="T:log4net.Appender.IBulkAppender">
  3565. <summary>
  3566. Interface for appenders that support bulk logging.
  3567. </summary>
  3568. <remarks>
  3569. <para>
  3570. This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
  3571. support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
  3572. should only implement this interface if they can bulk log efficiently.
  3573. </para>
  3574. </remarks>
  3575. <author>Nicko Cadell</author>
  3576. </member>
  3577. <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
  3578. <summary>
  3579. Log the array of logging events in Appender specific way.
  3580. </summary>
  3581. <param name="loggingEvents">The events to log</param>
  3582. <remarks>
  3583. <para>
  3584. This method is called to log an array of events into this appender.
  3585. </para>
  3586. </remarks>
  3587. </member>
  3588. <member name="T:log4net.Appender.IFlushable">
  3589. <summary>
  3590. Interface that can be implemented by Appenders that buffer logging data and expose a <see cref="M:log4net.Appender.IFlushable.Flush(System.Int32)"/> method.
  3591. </summary>
  3592. </member>
  3593. <member name="M:log4net.Appender.IFlushable.Flush(System.Int32)">
  3594. <summary>
  3595. Flushes any buffered log data.
  3596. </summary>
  3597. <remarks>
  3598. Appenders that implement the <see cref="M:log4net.Appender.IFlushable.Flush(System.Int32)"/> method must do so in a thread-safe manner: it can be called concurrently with
  3599. the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  3600. <para>
  3601. Typically this is done by locking on the Appender instance, e.g.:
  3602. <code>
  3603. <![CDATA[
  3604. public bool Flush(int millisecondsTimeout)
  3605. {
  3606. lock(this)
  3607. {
  3608. // Flush buffered logging data
  3609. ...
  3610. }
  3611. }
  3612. ]]>
  3613. </code>
  3614. </para>
  3615. <para>
  3616. The <paramref name="millisecondsTimeout"/> parameter is only relevant for appenders that process logging events asynchronously,
  3617. such as <see cref="!:RemotingAppender"/>.
  3618. </para>
  3619. </remarks>
  3620. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  3621. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  3622. </member>
  3623. <member name="T:log4net.Appender.LocalSyslogAppender">
  3624. <summary>
  3625. Logs events to a local syslog service.
  3626. </summary>
  3627. <remarks>
  3628. <note>
  3629. This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
  3630. If these functions are not available on the local system then this appender will not work!
  3631. </note>
  3632. <para>
  3633. The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
  3634. POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
  3635. </para>
  3636. <para>
  3637. This appender talks to a local syslog service. If you need to log to a remote syslog
  3638. daemon and you cannot configure your local syslog service to do this you may be
  3639. able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
  3640. </para>
  3641. <para>
  3642. Syslog messages must have a facility and and a severity. The severity
  3643. is derived from the Level of the logging event.
  3644. The facility must be chosen from the set of defined syslog
  3645. <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  3646. and cannot be extended.
  3647. </para>
  3648. <para>
  3649. An identifier is specified with each log message. This can be specified
  3650. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  3651. as the tag) must not contain white space. The default value for the
  3652. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  3653. </para>
  3654. </remarks>
  3655. <author>Rob Lyon</author>
  3656. <author>Nicko Cadell</author>
  3657. </member>
  3658. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
  3659. <summary>
  3660. syslog severities
  3661. </summary>
  3662. <remarks>
  3663. <para>
  3664. The log4net Level maps to a syslog severity using the
  3665. <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
  3666. class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
  3667. </para>
  3668. </remarks>
  3669. </member>
  3670. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
  3671. <summary>
  3672. system is unusable
  3673. </summary>
  3674. </member>
  3675. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
  3676. <summary>
  3677. action must be taken immediately
  3678. </summary>
  3679. </member>
  3680. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
  3681. <summary>
  3682. critical conditions
  3683. </summary>
  3684. </member>
  3685. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
  3686. <summary>
  3687. error conditions
  3688. </summary>
  3689. </member>
  3690. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
  3691. <summary>
  3692. warning conditions
  3693. </summary>
  3694. </member>
  3695. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
  3696. <summary>
  3697. normal but significant condition
  3698. </summary>
  3699. </member>
  3700. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
  3701. <summary>
  3702. informational
  3703. </summary>
  3704. </member>
  3705. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
  3706. <summary>
  3707. debug-level messages
  3708. </summary>
  3709. </member>
  3710. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
  3711. <summary>
  3712. syslog facilities
  3713. </summary>
  3714. <remarks>
  3715. <para>
  3716. The syslog facility defines which subsystem the logging comes from.
  3717. This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
  3718. </para>
  3719. </remarks>
  3720. </member>
  3721. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
  3722. <summary>
  3723. kernel messages
  3724. </summary>
  3725. </member>
  3726. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
  3727. <summary>
  3728. random user-level messages
  3729. </summary>
  3730. </member>
  3731. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
  3732. <summary>
  3733. mail system
  3734. </summary>
  3735. </member>
  3736. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
  3737. <summary>
  3738. system daemons
  3739. </summary>
  3740. </member>
  3741. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
  3742. <summary>
  3743. security/authorization messages
  3744. </summary>
  3745. </member>
  3746. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
  3747. <summary>
  3748. messages generated internally by syslogd
  3749. </summary>
  3750. </member>
  3751. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
  3752. <summary>
  3753. line printer subsystem
  3754. </summary>
  3755. </member>
  3756. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
  3757. <summary>
  3758. network news subsystem
  3759. </summary>
  3760. </member>
  3761. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
  3762. <summary>
  3763. UUCP subsystem
  3764. </summary>
  3765. </member>
  3766. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
  3767. <summary>
  3768. clock (cron/at) daemon
  3769. </summary>
  3770. </member>
  3771. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
  3772. <summary>
  3773. security/authorization messages (private)
  3774. </summary>
  3775. </member>
  3776. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
  3777. <summary>
  3778. ftp daemon
  3779. </summary>
  3780. </member>
  3781. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
  3782. <summary>
  3783. NTP subsystem
  3784. </summary>
  3785. </member>
  3786. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
  3787. <summary>
  3788. log audit
  3789. </summary>
  3790. </member>
  3791. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
  3792. <summary>
  3793. log alert
  3794. </summary>
  3795. </member>
  3796. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
  3797. <summary>
  3798. clock daemon
  3799. </summary>
  3800. </member>
  3801. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
  3802. <summary>
  3803. reserved for local use
  3804. </summary>
  3805. </member>
  3806. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
  3807. <summary>
  3808. reserved for local use
  3809. </summary>
  3810. </member>
  3811. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
  3812. <summary>
  3813. reserved for local use
  3814. </summary>
  3815. </member>
  3816. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
  3817. <summary>
  3818. reserved for local use
  3819. </summary>
  3820. </member>
  3821. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
  3822. <summary>
  3823. reserved for local use
  3824. </summary>
  3825. </member>
  3826. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
  3827. <summary>
  3828. reserved for local use
  3829. </summary>
  3830. </member>
  3831. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
  3832. <summary>
  3833. reserved for local use
  3834. </summary>
  3835. </member>
  3836. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
  3837. <summary>
  3838. reserved for local use
  3839. </summary>
  3840. </member>
  3841. <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
  3842. <summary>
  3843. Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender" /> class.
  3844. </summary>
  3845. <remarks>
  3846. This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender" /> class is set up to write
  3847. to a local syslog service.
  3848. </remarks>
  3849. </member>
  3850. <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
  3851. <summary>
  3852. Message identity
  3853. </summary>
  3854. <remarks>
  3855. <para>
  3856. An identifier is specified with each log message. This can be specified
  3857. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  3858. as the tag) must not contain white space. The default value for the
  3859. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  3860. </para>
  3861. </remarks>
  3862. </member>
  3863. <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
  3864. <summary>
  3865. Syslog facility
  3866. </summary>
  3867. <remarks>
  3868. Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
  3869. facilities is predefined and cannot be extended. The default value
  3870. is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  3871. </remarks>
  3872. </member>
  3873. <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
  3874. <summary>
  3875. Add a mapping of level to severity
  3876. </summary>
  3877. <param name="mapping">The mapping to add</param>
  3878. <remarks>
  3879. <para>
  3880. Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
  3881. </para>
  3882. </remarks>
  3883. </member>
  3884. <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
  3885. <summary>
  3886. Initialize the appender based on the options set.
  3887. </summary>
  3888. <remarks>
  3889. <para>
  3890. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3891. activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
  3892. be called on this object after the configuration properties have
  3893. been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
  3894. object is in an undefined state and must not be used.
  3895. </para>
  3896. <para>
  3897. If any of the configuration properties are modified then
  3898. <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
  3899. </para>
  3900. </remarks>
  3901. </member>
  3902. <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
  3903. <summary>
  3904. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  3905. </summary>
  3906. <param name="loggingEvent">The event to log.</param>
  3907. <remarks>
  3908. <para>
  3909. Writes the event to a remote syslog daemon.
  3910. </para>
  3911. <para>
  3912. The format of the output will depend on the appender's layout.
  3913. </para>
  3914. </remarks>
  3915. </member>
  3916. <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
  3917. <summary>
  3918. Close the syslog when the appender is closed
  3919. </summary>
  3920. <remarks>
  3921. <para>
  3922. Close the syslog when the appender is closed
  3923. </para>
  3924. </remarks>
  3925. </member>
  3926. <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
  3927. <summary>
  3928. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  3929. </summary>
  3930. <value><c>true</c></value>
  3931. <remarks>
  3932. <para>
  3933. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  3934. </para>
  3935. </remarks>
  3936. </member>
  3937. <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
  3938. <summary>
  3939. Translates a log4net level to a syslog severity.
  3940. </summary>
  3941. <param name="level">A log4net level.</param>
  3942. <returns>A syslog severity.</returns>
  3943. <remarks>
  3944. <para>
  3945. Translates a log4net level to a syslog severity.
  3946. </para>
  3947. </remarks>
  3948. </member>
  3949. <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
  3950. <summary>
  3951. Generate a syslog priority.
  3952. </summary>
  3953. <param name="facility">The syslog facility.</param>
  3954. <param name="severity">The syslog severity.</param>
  3955. <returns>A syslog priority.</returns>
  3956. </member>
  3957. <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
  3958. <summary>
  3959. The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  3960. </summary>
  3961. </member>
  3962. <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
  3963. <summary>
  3964. The message identity
  3965. </summary>
  3966. </member>
  3967. <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
  3968. <summary>
  3969. Marshaled handle to the identity string. We have to hold on to the
  3970. string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
  3971. pointer to the ident and dereference it for each log message.
  3972. </summary>
  3973. </member>
  3974. <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
  3975. <summary>
  3976. Mapping from level object to syslog severity
  3977. </summary>
  3978. </member>
  3979. <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
  3980. <summary>
  3981. Open connection to system logger.
  3982. </summary>
  3983. </member>
  3984. <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
  3985. <summary>
  3986. Generate a log message.
  3987. </summary>
  3988. <remarks>
  3989. <para>
  3990. The libc syslog method takes a format string and a variable argument list similar
  3991. to the classic printf function. As this type of vararg list is not supported
  3992. by C# we need to specify the arguments explicitly. Here we have specified the
  3993. format string with a single message argument. The caller must set the format
  3994. string to <c>"%s"</c>.
  3995. </para>
  3996. </remarks>
  3997. </member>
  3998. <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
  3999. <summary>
  4000. Close descriptor used to write to system logger.
  4001. </summary>
  4002. </member>
  4003. <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
  4004. <summary>
  4005. A class to act as a mapping between the level that a logging call is made at and
  4006. the syslog severity that is should be logged at.
  4007. </summary>
  4008. <remarks>
  4009. <para>
  4010. A class to act as a mapping between the level that a logging call is made at and
  4011. the syslog severity that is should be logged at.
  4012. </para>
  4013. </remarks>
  4014. </member>
  4015. <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
  4016. <summary>
  4017. The mapped syslog severity for the specified level
  4018. </summary>
  4019. <remarks>
  4020. <para>
  4021. Required property.
  4022. The mapped syslog severity for the specified level
  4023. </para>
  4024. </remarks>
  4025. </member>
  4026. <member name="T:log4net.Appender.ManagedColoredConsoleAppender">
  4027. <summary>
  4028. Appends colorful logging events to the console, using the .NET 2
  4029. built-in capabilities.
  4030. </summary>
  4031. <remarks>
  4032. <para>
  4033. ManagedColoredConsoleAppender appends log events to the standard output stream
  4034. or the error output stream using a layout specified by the
  4035. user. It also allows the color of a specific type of message to be set.
  4036. </para>
  4037. <para>
  4038. By default, all output is written to the console's standard output stream.
  4039. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the
  4040. error stream.
  4041. </para>
  4042. <para>
  4043. When configuring the colored console appender, mappings should be
  4044. specified to map logging levels to colors. For example:
  4045. </para>
  4046. <code lang="XML" escaped="true">
  4047. <mapping>
  4048. <level value="ERROR" />
  4049. <foreColor value="DarkRed" />
  4050. <backColor value="White" />
  4051. </mapping>
  4052. <mapping>
  4053. <level value="WARN" />
  4054. <foreColor value="Yellow" />
  4055. </mapping>
  4056. <mapping>
  4057. <level value="INFO" />
  4058. <foreColor value="White" />
  4059. </mapping>
  4060. <mapping>
  4061. <level value="DEBUG" />
  4062. <foreColor value="Blue" />
  4063. </mapping>
  4064. </code>
  4065. <para>
  4066. The Level is the standard log4net logging level while
  4067. ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/>
  4068. enumeration.
  4069. </para>
  4070. <para>
  4071. Based on the ColoredConsoleAppender
  4072. </para>
  4073. </remarks>
  4074. <author>Rick Hobbs</author>
  4075. <author>Nicko Cadell</author>
  4076. <author>Pavlos Touboulidis</author>
  4077. </member>
  4078. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor">
  4079. <summary>
  4080. Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender" /> class.
  4081. </summary>
  4082. <remarks>
  4083. The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender" /> class is set up to write
  4084. to the standard output stream.
  4085. </remarks>
  4086. </member>
  4087. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target">
  4088. <summary>
  4089. Target is the value of the console output stream.
  4090. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4091. </summary>
  4092. <value>
  4093. Target is the value of the console output stream.
  4094. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4095. </value>
  4096. <remarks>
  4097. <para>
  4098. Target is the value of the console output stream.
  4099. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4100. </para>
  4101. </remarks>
  4102. </member>
  4103. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)">
  4104. <summary>
  4105. Add a mapping of level to color - done by the config file
  4106. </summary>
  4107. <param name="mapping">The mapping to add</param>
  4108. <remarks>
  4109. <para>
  4110. Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender.
  4111. Each mapping defines the foreground and background colors
  4112. for a level.
  4113. </para>
  4114. </remarks>
  4115. </member>
  4116. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  4117. <summary>
  4118. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  4119. </summary>
  4120. <param name="loggingEvent">The event to log.</param>
  4121. <remarks>
  4122. <para>
  4123. Writes the event to the console.
  4124. </para>
  4125. <para>
  4126. The format of the output will depend on the appender's layout.
  4127. </para>
  4128. </remarks>
  4129. </member>
  4130. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout">
  4131. <summary>
  4132. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4133. </summary>
  4134. <value><c>true</c></value>
  4135. <remarks>
  4136. <para>
  4137. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4138. </para>
  4139. </remarks>
  4140. </member>
  4141. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions">
  4142. <summary>
  4143. Initialize the options for this appender
  4144. </summary>
  4145. <remarks>
  4146. <para>
  4147. Initialize the level to color mappings set on this appender.
  4148. </para>
  4149. </remarks>
  4150. </member>
  4151. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut">
  4152. <summary>
  4153. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4154. standard output stream.
  4155. </summary>
  4156. <remarks>
  4157. <para>
  4158. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4159. standard output stream.
  4160. </para>
  4161. </remarks>
  4162. </member>
  4163. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError">
  4164. <summary>
  4165. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4166. standard error output stream.
  4167. </summary>
  4168. <remarks>
  4169. <para>
  4170. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4171. standard error output stream.
  4172. </para>
  4173. </remarks>
  4174. </member>
  4175. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream">
  4176. <summary>
  4177. Flag to write output to the error stream rather than the standard output stream
  4178. </summary>
  4179. </member>
  4180. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping">
  4181. <summary>
  4182. Mapping from level object to color value
  4183. </summary>
  4184. </member>
  4185. <member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors">
  4186. <summary>
  4187. A class to act as a mapping between the level that a logging call is made at and
  4188. the color it should be displayed as.
  4189. </summary>
  4190. <remarks>
  4191. <para>
  4192. Defines the mapping between a level and the color it should be displayed in.
  4193. </para>
  4194. </remarks>
  4195. </member>
  4196. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor">
  4197. <summary>
  4198. The mapped foreground color for the specified level
  4199. </summary>
  4200. <remarks>
  4201. <para>
  4202. Required property.
  4203. The mapped foreground color for the specified level.
  4204. </para>
  4205. </remarks>
  4206. </member>
  4207. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor">
  4208. <summary>
  4209. The mapped background color for the specified level
  4210. </summary>
  4211. <remarks>
  4212. <para>
  4213. Required property.
  4214. The mapped background color for the specified level.
  4215. </para>
  4216. </remarks>
  4217. </member>
  4218. <member name="T:log4net.Appender.MemoryAppender">
  4219. <summary>
  4220. Stores logging events in an array.
  4221. </summary>
  4222. <remarks>
  4223. <para>
  4224. The memory appender stores all the logging events
  4225. that are appended in an in-memory array.
  4226. </para>
  4227. <para>
  4228. Use the <see cref="M:PopAllEvents()"/> method to get
  4229. and clear the current list of events that have been appended.
  4230. </para>
  4231. <para>
  4232. Use the <see cref="M:GetEvents()"/> method to get the current
  4233. list of events that have been appended. Note there is a
  4234. race-condition when calling <see cref="M:GetEvents()"/> and
  4235. <see cref="M:Clear()"/> in pairs, you better use <see
  4236. mref="M:PopAllEvents()"/> in that case.
  4237. </para>
  4238. <para>
  4239. Use the <see cref="M:Clear()"/> method to clear the
  4240. current list of events. Note there is a
  4241. race-condition when calling <see cref="M:GetEvents()"/> and
  4242. <see cref="M:Clear()"/> in pairs, you better use <see
  4243. mref="M:PopAllEvents()"/> in that case.
  4244. </para>
  4245. </remarks>
  4246. <author>Julian Biddle</author>
  4247. <author>Nicko Cadell</author>
  4248. <author>Gert Driesen</author>
  4249. </member>
  4250. <member name="M:log4net.Appender.MemoryAppender.#ctor">
  4251. <summary>
  4252. Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender" /> class.
  4253. </summary>
  4254. <remarks>
  4255. <para>
  4256. Default constructor.
  4257. </para>
  4258. </remarks>
  4259. </member>
  4260. <member name="M:log4net.Appender.MemoryAppender.GetEvents">
  4261. <summary>
  4262. Gets the events that have been logged.
  4263. </summary>
  4264. <returns>The events that have been logged</returns>
  4265. <remarks>
  4266. <para>
  4267. Gets the events that have been logged.
  4268. </para>
  4269. </remarks>
  4270. </member>
  4271. <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
  4272. <summary>
  4273. Gets or sets a value indicating whether only part of the logging event
  4274. data should be fixed.
  4275. </summary>
  4276. <value>
  4277. <c>true</c> if the appender should only fix part of the logging event
  4278. data, otherwise <c>false</c>. The default is <c>false</c>.
  4279. </value>
  4280. <remarks>
  4281. <para>
  4282. Setting this property to <c>true</c> will cause only part of the event
  4283. data to be fixed and stored in the appender, hereby improving performance.
  4284. </para>
  4285. <para>
  4286. See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
  4287. </para>
  4288. </remarks>
  4289. </member>
  4290. <member name="P:log4net.Appender.MemoryAppender.Fix">
  4291. <summary>
  4292. Gets or sets the fields that will be fixed in the event
  4293. </summary>
  4294. <remarks>
  4295. <para>
  4296. The logging event needs to have certain thread specific values
  4297. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  4298. for details.
  4299. </para>
  4300. </remarks>
  4301. </member>
  4302. <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
  4303. <summary>
  4304. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4305. </summary>
  4306. <param name="loggingEvent">the event to log</param>
  4307. <remarks>
  4308. <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
  4309. </remarks>
  4310. </member>
  4311. <member name="M:log4net.Appender.MemoryAppender.Clear">
  4312. <summary>
  4313. Clear the list of events
  4314. </summary>
  4315. <remarks>
  4316. Clear the list of events
  4317. </remarks>
  4318. </member>
  4319. <member name="M:log4net.Appender.MemoryAppender.PopAllEvents">
  4320. <summary>
  4321. Gets the events that have been logged and clears the list of events.
  4322. </summary>
  4323. <returns>The events that have been logged</returns>
  4324. <remarks>
  4325. <para>
  4326. Gets the events that have been logged and clears the list of events.
  4327. </para>
  4328. </remarks>
  4329. </member>
  4330. <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
  4331. <summary>
  4332. The list of events that have been appended.
  4333. </summary>
  4334. </member>
  4335. <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
  4336. <summary>
  4337. Value indicating which fields in the event should be fixed
  4338. </summary>
  4339. <remarks>
  4340. By default all fields are fixed
  4341. </remarks>
  4342. </member>
  4343. <member name="T:log4net.Appender.NetSendAppender">
  4344. <summary>
  4345. Logs entries by sending network messages using the
  4346. <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)" /> native function.
  4347. </summary>
  4348. <remarks>
  4349. <para>
  4350. You can send messages only to names that are active
  4351. on the network. If you send the message to a user name,
  4352. that user must be logged on and running the Messenger
  4353. service to receive the message.
  4354. </para>
  4355. <para>
  4356. The receiver will get a top most window displaying the
  4357. messages one at a time, therefore this appender should
  4358. not be used to deliver a high volume of messages.
  4359. </para>
  4360. <para>
  4361. The following table lists some possible uses for this appender :
  4362. </para>
  4363. <para>
  4364. <list type="table">
  4365. <listheader>
  4366. <term>Action</term>
  4367. <description>Property Value(s)</description>
  4368. </listheader>
  4369. <item>
  4370. <term>Send a message to a user account on the local machine</term>
  4371. <description>
  4372. <para>
  4373. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine&gt;
  4374. </para>
  4375. <para>
  4376. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  4377. </para>
  4378. </description>
  4379. </item>
  4380. <item>
  4381. <term>Send a message to a user account on a remote machine</term>
  4382. <description>
  4383. <para>
  4384. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the remote machine&gt;
  4385. </para>
  4386. <para>
  4387. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  4388. </para>
  4389. </description>
  4390. </item>
  4391. <item>
  4392. <term>Send a message to a domain user account</term>
  4393. <description>
  4394. <para>
  4395. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of a domain controller | uninitialized&gt;
  4396. </para>
  4397. <para>
  4398. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  4399. </para>
  4400. </description>
  4401. </item>
  4402. <item>
  4403. <term>Send a message to all the names in a workgroup or domain</term>
  4404. <description>
  4405. <para>
  4406. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;workgroup name | domain name&gt;*
  4407. </para>
  4408. </description>
  4409. </item>
  4410. <item>
  4411. <term>Send a message from the local machine to a remote machine</term>
  4412. <description>
  4413. <para>
  4414. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine | uninitialized&gt;
  4415. </para>
  4416. <para>
  4417. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;name of the remote machine&gt;
  4418. </para>
  4419. </description>
  4420. </item>
  4421. </list>
  4422. </para>
  4423. <para>
  4424. <b>Note :</b> security restrictions apply for sending
  4425. network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)" />
  4426. for more information.
  4427. </para>
  4428. </remarks>
  4429. <example>
  4430. <para>
  4431. An example configuration section to log information
  4432. using this appender from the local machine, named
  4433. LOCAL_PC, to machine OPERATOR_PC :
  4434. </para>
  4435. <code lang="XML" escaped="true">
  4436. <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
  4437. <server value="LOCAL_PC" />
  4438. <recipient value="OPERATOR_PC" />
  4439. <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n" />
  4440. </appender>
  4441. </code>
  4442. </example>
  4443. <author>Nicko Cadell</author>
  4444. <author>Gert Driesen</author>
  4445. </member>
  4446. <member name="F:log4net.Appender.NetSendAppender.m_server">
  4447. <summary>
  4448. The DNS or NetBIOS name of the server on which the function is to execute.
  4449. </summary>
  4450. </member>
  4451. <member name="F:log4net.Appender.NetSendAppender.m_sender">
  4452. <summary>
  4453. The sender of the network message.
  4454. </summary>
  4455. </member>
  4456. <member name="F:log4net.Appender.NetSendAppender.m_recipient">
  4457. <summary>
  4458. The message alias to which the message should be sent.
  4459. </summary>
  4460. </member>
  4461. <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
  4462. <summary>
  4463. The security context to use for privileged calls
  4464. </summary>
  4465. </member>
  4466. <member name="M:log4net.Appender.NetSendAppender.#ctor">
  4467. <summary>
  4468. Initializes the appender.
  4469. </summary>
  4470. <remarks>
  4471. The default constructor initializes all fields to their default values.
  4472. </remarks>
  4473. </member>
  4474. <member name="P:log4net.Appender.NetSendAppender.Sender">
  4475. <summary>
  4476. Gets or sets the sender of the message.
  4477. </summary>
  4478. <value>
  4479. The sender of the message.
  4480. </value>
  4481. <remarks>
  4482. If this property is not specified, the message is sent from the local computer.
  4483. </remarks>
  4484. </member>
  4485. <member name="P:log4net.Appender.NetSendAppender.Recipient">
  4486. <summary>
  4487. Gets or sets the message alias to which the message should be sent.
  4488. </summary>
  4489. <value>
  4490. The recipient of the message.
  4491. </value>
  4492. <remarks>
  4493. This property should always be specified in order to send a message.
  4494. </remarks>
  4495. </member>
  4496. <member name="P:log4net.Appender.NetSendAppender.Server">
  4497. <summary>
  4498. Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
  4499. </summary>
  4500. <value>
  4501. DNS or NetBIOS name of the remote server on which the function is to execute.
  4502. </value>
  4503. <remarks>
  4504. <para>
  4505. For Windows NT 4.0 and earlier, the string should begin with \\.
  4506. </para>
  4507. <para>
  4508. If this property is not specified, the local computer is used.
  4509. </para>
  4510. </remarks>
  4511. </member>
  4512. <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
  4513. <summary>
  4514. Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  4515. </summary>
  4516. <value>
  4517. The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  4518. </value>
  4519. <remarks>
  4520. <para>
  4521. Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
  4522. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  4523. security context to use. The default behavior is to use the security context
  4524. of the current thread.
  4525. </para>
  4526. </remarks>
  4527. </member>
  4528. <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
  4529. <summary>
  4530. Initialize the appender based on the options set.
  4531. </summary>
  4532. <remarks>
  4533. <para>
  4534. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4535. activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
  4536. be called on this object after the configuration properties have
  4537. been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
  4538. object is in an undefined state and must not be used.
  4539. </para>
  4540. <para>
  4541. If any of the configuration properties are modified then
  4542. <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
  4543. </para>
  4544. <para>
  4545. The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient" /> was specified.
  4546. </para>
  4547. </remarks>
  4548. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient" /> was not specified.</exception>
  4549. </member>
  4550. <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
  4551. <summary>
  4552. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4553. </summary>
  4554. <param name="loggingEvent">The event to log.</param>
  4555. <remarks>
  4556. <para>
  4557. Sends the event using a network message.
  4558. </para>
  4559. </remarks>
  4560. </member>
  4561. <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
  4562. <summary>
  4563. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4564. </summary>
  4565. <value><c>true</c></value>
  4566. <remarks>
  4567. <para>
  4568. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4569. </para>
  4570. </remarks>
  4571. </member>
  4572. <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
  4573. <summary>
  4574. Sends a buffer of information to a registered message alias.
  4575. </summary>
  4576. <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
  4577. <param name="msgName">The message alias to which the message buffer should be sent</param>
  4578. <param name="fromName">The originator of the message.</param>
  4579. <param name="buffer">The message text.</param>
  4580. <param name="bufferSize">The length, in bytes, of the message text.</param>
  4581. <remarks>
  4582. <para>
  4583. The following restrictions apply for sending network messages:
  4584. </para>
  4585. <para>
  4586. <list type="table">
  4587. <listheader>
  4588. <term>Platform</term>
  4589. <description>Requirements</description>
  4590. </listheader>
  4591. <item>
  4592. <term>Windows NT</term>
  4593. <description>
  4594. <para>
  4595. No special group membership is required to send a network message.
  4596. </para>
  4597. <para>
  4598. Admin, Accounts, Print, or Server Operator group membership is required to
  4599. successfully send a network message on a remote server.
  4600. </para>
  4601. </description>
  4602. </item>
  4603. <item>
  4604. <term>Windows 2000 or later</term>
  4605. <description>
  4606. <para>
  4607. If you send a message on a domain controller that is running Active Directory,
  4608. access is allowed or denied based on the access control list (ACL) for the securable
  4609. object. The default ACL permits only Domain Admins and Account Operators to send a network message.
  4610. </para>
  4611. <para>
  4612. On a member server or workstation, only Administrators and Server Operators can send a network message.
  4613. </para>
  4614. </description>
  4615. </item>
  4616. </list>
  4617. </para>
  4618. <para>
  4619. 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>.
  4620. </para>
  4621. </remarks>
  4622. <returns>
  4623. <para>
  4624. If the function succeeds, the return value is zero.
  4625. </para>
  4626. </returns>
  4627. </member>
  4628. <member name="T:log4net.Appender.OutputDebugStringAppender">
  4629. <summary>
  4630. Appends log events to the OutputDebugString system.
  4631. </summary>
  4632. <remarks>
  4633. <para>
  4634. OutputDebugStringAppender appends log events to the
  4635. OutputDebugString system.
  4636. </para>
  4637. <para>
  4638. The string is passed to the native <c>OutputDebugString</c>
  4639. function.
  4640. </para>
  4641. </remarks>
  4642. <author>Nicko Cadell</author>
  4643. <author>Gert Driesen</author>
  4644. </member>
  4645. <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
  4646. <summary>
  4647. Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender" /> class.
  4648. </summary>
  4649. <remarks>
  4650. <para>
  4651. Default constructor.
  4652. </para>
  4653. </remarks>
  4654. </member>
  4655. <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
  4656. <summary>
  4657. Write the logging event to the output debug string API
  4658. </summary>
  4659. <param name="loggingEvent">the event to log</param>
  4660. <remarks>
  4661. <para>
  4662. Write the logging event to the output debug string API
  4663. </para>
  4664. </remarks>
  4665. </member>
  4666. <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
  4667. <summary>
  4668. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4669. </summary>
  4670. <value><c>true</c></value>
  4671. <remarks>
  4672. <para>
  4673. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4674. </para>
  4675. </remarks>
  4676. </member>
  4677. <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
  4678. <summary>
  4679. Stub for OutputDebugString native method
  4680. </summary>
  4681. <param name="message">the string to output</param>
  4682. <remarks>
  4683. <para>
  4684. Stub for OutputDebugString native method
  4685. </para>
  4686. </remarks>
  4687. </member>
  4688. <member name="T:log4net.Appender.RemoteSyslogAppender">
  4689. <summary>
  4690. Logs events to a remote syslog daemon.
  4691. </summary>
  4692. <remarks>
  4693. <para>
  4694. The BSD syslog protocol is used to remotely log to
  4695. a syslog daemon. The syslogd listens for for messages
  4696. on UDP port 514.
  4697. </para>
  4698. <para>
  4699. The syslog UDP protocol is not authenticated. Most syslog daemons
  4700. do not accept remote log messages because of the security implications.
  4701. You may be able to use the LocalSyslogAppender to talk to a local
  4702. syslog service.
  4703. </para>
  4704. <para>
  4705. There is an RFC 3164 that claims to document the BSD Syslog Protocol.
  4706. This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
  4707. This appender generates what the RFC calls an "Original Device Message",
  4708. i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
  4709. this format of message will be accepted by all current syslog daemon
  4710. implementations. The daemon will attach the current time and the source
  4711. hostname or IP address to any messages received.
  4712. </para>
  4713. <para>
  4714. Syslog messages must have a facility and and a severity. The severity
  4715. is derived from the Level of the logging event.
  4716. The facility must be chosen from the set of defined syslog
  4717. <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  4718. and cannot be extended.
  4719. </para>
  4720. <para>
  4721. An identifier is specified with each log message. This can be specified
  4722. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  4723. as the tag) must not contain white space. The default value for the
  4724. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  4725. </para>
  4726. </remarks>
  4727. <author>Rob Lyon</author>
  4728. <author>Nicko Cadell</author>
  4729. </member>
  4730. <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
  4731. <summary>
  4732. Syslog port 514
  4733. </summary>
  4734. </member>
  4735. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
  4736. <summary>
  4737. syslog severities
  4738. </summary>
  4739. <remarks>
  4740. <para>
  4741. The syslog severities.
  4742. </para>
  4743. </remarks>
  4744. </member>
  4745. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
  4746. <summary>
  4747. system is unusable
  4748. </summary>
  4749. </member>
  4750. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
  4751. <summary>
  4752. action must be taken immediately
  4753. </summary>
  4754. </member>
  4755. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
  4756. <summary>
  4757. critical conditions
  4758. </summary>
  4759. </member>
  4760. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
  4761. <summary>
  4762. error conditions
  4763. </summary>
  4764. </member>
  4765. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
  4766. <summary>
  4767. warning conditions
  4768. </summary>
  4769. </member>
  4770. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
  4771. <summary>
  4772. normal but significant condition
  4773. </summary>
  4774. </member>
  4775. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
  4776. <summary>
  4777. informational
  4778. </summary>
  4779. </member>
  4780. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
  4781. <summary>
  4782. debug-level messages
  4783. </summary>
  4784. </member>
  4785. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
  4786. <summary>
  4787. syslog facilities
  4788. </summary>
  4789. <remarks>
  4790. <para>
  4791. The syslog facilities
  4792. </para>
  4793. </remarks>
  4794. </member>
  4795. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
  4796. <summary>
  4797. kernel messages
  4798. </summary>
  4799. </member>
  4800. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
  4801. <summary>
  4802. random user-level messages
  4803. </summary>
  4804. </member>
  4805. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
  4806. <summary>
  4807. mail system
  4808. </summary>
  4809. </member>
  4810. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
  4811. <summary>
  4812. system daemons
  4813. </summary>
  4814. </member>
  4815. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
  4816. <summary>
  4817. security/authorization messages
  4818. </summary>
  4819. </member>
  4820. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
  4821. <summary>
  4822. messages generated internally by syslogd
  4823. </summary>
  4824. </member>
  4825. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
  4826. <summary>
  4827. line printer subsystem
  4828. </summary>
  4829. </member>
  4830. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
  4831. <summary>
  4832. network news subsystem
  4833. </summary>
  4834. </member>
  4835. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
  4836. <summary>
  4837. UUCP subsystem
  4838. </summary>
  4839. </member>
  4840. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
  4841. <summary>
  4842. clock (cron/at) daemon
  4843. </summary>
  4844. </member>
  4845. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
  4846. <summary>
  4847. security/authorization messages (private)
  4848. </summary>
  4849. </member>
  4850. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
  4851. <summary>
  4852. ftp daemon
  4853. </summary>
  4854. </member>
  4855. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
  4856. <summary>
  4857. NTP subsystem
  4858. </summary>
  4859. </member>
  4860. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
  4861. <summary>
  4862. log audit
  4863. </summary>
  4864. </member>
  4865. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
  4866. <summary>
  4867. log alert
  4868. </summary>
  4869. </member>
  4870. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
  4871. <summary>
  4872. clock daemon
  4873. </summary>
  4874. </member>
  4875. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
  4876. <summary>
  4877. reserved for local use
  4878. </summary>
  4879. </member>
  4880. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
  4881. <summary>
  4882. reserved for local use
  4883. </summary>
  4884. </member>
  4885. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
  4886. <summary>
  4887. reserved for local use
  4888. </summary>
  4889. </member>
  4890. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
  4891. <summary>
  4892. reserved for local use
  4893. </summary>
  4894. </member>
  4895. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
  4896. <summary>
  4897. reserved for local use
  4898. </summary>
  4899. </member>
  4900. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
  4901. <summary>
  4902. reserved for local use
  4903. </summary>
  4904. </member>
  4905. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
  4906. <summary>
  4907. reserved for local use
  4908. </summary>
  4909. </member>
  4910. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
  4911. <summary>
  4912. reserved for local use
  4913. </summary>
  4914. </member>
  4915. <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
  4916. <summary>
  4917. Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender" /> class.
  4918. </summary>
  4919. <remarks>
  4920. This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender" /> class is set up to write
  4921. to a remote syslog daemon.
  4922. </remarks>
  4923. </member>
  4924. <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
  4925. <summary>
  4926. Message identity
  4927. </summary>
  4928. <remarks>
  4929. <para>
  4930. An identifier is specified with each log message. This can be specified
  4931. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  4932. as the tag) must not contain white space. The default value for the
  4933. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  4934. </para>
  4935. </remarks>
  4936. </member>
  4937. <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
  4938. <summary>
  4939. Syslog facility
  4940. </summary>
  4941. <remarks>
  4942. Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
  4943. facilities is predefined and cannot be extended. The default value
  4944. is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  4945. </remarks>
  4946. </member>
  4947. <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
  4948. <summary>
  4949. Add a mapping of level to severity
  4950. </summary>
  4951. <param name="mapping">The mapping to add</param>
  4952. <remarks>
  4953. <para>
  4954. Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
  4955. </para>
  4956. </remarks>
  4957. </member>
  4958. <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
  4959. <summary>
  4960. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4961. </summary>
  4962. <param name="loggingEvent">The event to log.</param>
  4963. <remarks>
  4964. <para>
  4965. Writes the event to a remote syslog daemon.
  4966. </para>
  4967. <para>
  4968. The format of the output will depend on the appender's layout.
  4969. </para>
  4970. </remarks>
  4971. </member>
  4972. <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
  4973. <summary>
  4974. Initialize the options for this appender
  4975. </summary>
  4976. <remarks>
  4977. <para>
  4978. Initialize the level to syslog severity mappings set on this appender.
  4979. </para>
  4980. </remarks>
  4981. </member>
  4982. <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
  4983. <summary>
  4984. Translates a log4net level to a syslog severity.
  4985. </summary>
  4986. <param name="level">A log4net level.</param>
  4987. <returns>A syslog severity.</returns>
  4988. <remarks>
  4989. <para>
  4990. Translates a log4net level to a syslog severity.
  4991. </para>
  4992. </remarks>
  4993. </member>
  4994. <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
  4995. <summary>
  4996. Generate a syslog priority.
  4997. </summary>
  4998. <param name="facility">The syslog facility.</param>
  4999. <param name="severity">The syslog severity.</param>
  5000. <returns>A syslog priority.</returns>
  5001. <remarks>
  5002. <para>
  5003. Generate a syslog priority.
  5004. </para>
  5005. </remarks>
  5006. </member>
  5007. <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
  5008. <summary>
  5009. The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  5010. </summary>
  5011. </member>
  5012. <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
  5013. <summary>
  5014. The message identity
  5015. </summary>
  5016. </member>
  5017. <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
  5018. <summary>
  5019. Mapping from level object to syslog severity
  5020. </summary>
  5021. </member>
  5022. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
  5023. <summary>
  5024. Initial buffer size
  5025. </summary>
  5026. </member>
  5027. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
  5028. <summary>
  5029. Maximum buffer size before it is recycled
  5030. </summary>
  5031. </member>
  5032. <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
  5033. <summary>
  5034. A class to act as a mapping between the level that a logging call is made at and
  5035. the syslog severity that is should be logged at.
  5036. </summary>
  5037. <remarks>
  5038. <para>
  5039. A class to act as a mapping between the level that a logging call is made at and
  5040. the syslog severity that is should be logged at.
  5041. </para>
  5042. </remarks>
  5043. </member>
  5044. <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
  5045. <summary>
  5046. The mapped syslog severity for the specified level
  5047. </summary>
  5048. <remarks>
  5049. <para>
  5050. Required property.
  5051. The mapped syslog severity for the specified level
  5052. </para>
  5053. </remarks>
  5054. </member>
  5055. <member name="T:log4net.Appender.RollingFileAppender">
  5056. <summary>
  5057. Appender that rolls log files based on size or date or both.
  5058. </summary>
  5059. <remarks>
  5060. <para>
  5061. RollingFileAppender can roll log files based on size or date or both
  5062. depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
  5063. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
  5064. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  5065. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
  5066. once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  5067. is crossed.
  5068. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
  5069. rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  5070. is crossed, but within a date boundary the file will also be rolled
  5071. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  5072. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
  5073. the appender is configured. This effectively means that the log file can be
  5074. rolled once per program execution.
  5075. </para>
  5076. <para>
  5077. A of few additional optional features have been added:
  5078. <list type="bullet">
  5079. <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
  5080. <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
  5081. <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
  5082. </list>
  5083. </para>
  5084. <note>
  5085. <para>
  5086. For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
  5087. greater than zero is highly recommended, otherwise all the backup files need
  5088. to be renamed each time a new backup is created.
  5089. </para>
  5090. <para>
  5091. When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  5092. to <see langword="true"/> will reduce the number of file renamings to few or none.
  5093. </para>
  5094. </note>
  5095. <note type="caution">
  5096. <para>
  5097. Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
  5098. the log file directory of backup files will cause unexpected and unwanted side effects.
  5099. </para>
  5100. </note>
  5101. <para>
  5102. If Date/Time based rolling is enabled this appender will attempt to roll existing files
  5103. in the directory without a Date/Time tag based on the last write date of the base log file.
  5104. The appender only rolls the log file when a message is logged. If Date/Time based rolling
  5105. is enabled then the appender will not roll the log file at the Date/Time boundary but
  5106. at the point when the next message is logged after the boundary has been crossed.
  5107. </para>
  5108. <para>
  5109. The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
  5110. has the same behavior when opening the log file.
  5111. The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
  5112. is called. This will typically be during configuration.
  5113. If the file cannot be opened for writing the appender will attempt
  5114. to open the file again each time a message is logged to the appender.
  5115. If the file cannot be opened for writing when a message is logged then
  5116. the message will be discarded by this appender.
  5117. </para>
  5118. <para>
  5119. When rolling a backup file necessitates deleting an older backup file the
  5120. file to be deleted is moved to a temporary name before being deleted.
  5121. </para>
  5122. <note type="caution">
  5123. <para>
  5124. A maximum number of backup files when rolling on date/time boundaries is not supported.
  5125. </para>
  5126. </note>
  5127. </remarks>
  5128. <author>Nicko Cadell</author>
  5129. <author>Gert Driesen</author>
  5130. <author>Aspi Havewala</author>
  5131. <author>Douglas de la Torre</author>
  5132. <author>Edward Smit</author>
  5133. </member>
  5134. <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
  5135. <summary>
  5136. Style of rolling to use
  5137. </summary>
  5138. <remarks>
  5139. <para>
  5140. Style of rolling to use
  5141. </para>
  5142. </remarks>
  5143. </member>
  5144. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
  5145. <summary>
  5146. Roll files once per program execution
  5147. </summary>
  5148. <remarks>
  5149. <para>
  5150. Roll files once per program execution.
  5151. Well really once each time this appender is
  5152. configured.
  5153. </para>
  5154. <para>
  5155. Setting this option also sets <c>AppendToFile</c> to
  5156. <c>false</c> on the <c>RollingFileAppender</c>, otherwise
  5157. this appender would just be a normal file appender.
  5158. </para>
  5159. </remarks>
  5160. </member>
  5161. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
  5162. <summary>
  5163. Roll files based only on the size of the file
  5164. </summary>
  5165. </member>
  5166. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
  5167. <summary>
  5168. Roll files based only on the date
  5169. </summary>
  5170. </member>
  5171. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
  5172. <summary>
  5173. Roll files based on both the size and date of the file
  5174. </summary>
  5175. </member>
  5176. <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
  5177. <summary>
  5178. The code assumes that the following 'time' constants are in a increasing sequence.
  5179. </summary>
  5180. <remarks>
  5181. <para>
  5182. The code assumes that the following 'time' constants are in a increasing sequence.
  5183. </para>
  5184. </remarks>
  5185. </member>
  5186. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
  5187. <summary>
  5188. Roll the log not based on the date
  5189. </summary>
  5190. </member>
  5191. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
  5192. <summary>
  5193. Roll the log for each minute
  5194. </summary>
  5195. </member>
  5196. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
  5197. <summary>
  5198. Roll the log for each hour
  5199. </summary>
  5200. </member>
  5201. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
  5202. <summary>
  5203. Roll the log twice a day (midday and midnight)
  5204. </summary>
  5205. </member>
  5206. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
  5207. <summary>
  5208. Roll the log each day (midnight)
  5209. </summary>
  5210. </member>
  5211. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
  5212. <summary>
  5213. Roll the log each week
  5214. </summary>
  5215. </member>
  5216. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
  5217. <summary>
  5218. Roll the log each month
  5219. </summary>
  5220. </member>
  5221. <member name="M:log4net.Appender.RollingFileAppender.#ctor">
  5222. <summary>
  5223. Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender" /> class.
  5224. </summary>
  5225. <remarks>
  5226. <para>
  5227. Default constructor.
  5228. </para>
  5229. </remarks>
  5230. </member>
  5231. <member name="M:log4net.Appender.RollingFileAppender.Finalize">
  5232. <summary>
  5233. Cleans up all resources used by this appender.
  5234. </summary>
  5235. </member>
  5236. <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
  5237. <summary>
  5238. Gets or sets the strategy for determining the current date and time. The default
  5239. implementation is to use LocalDateTime which internally calls through to DateTime.Now.
  5240. DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
  5241. <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  5242. </summary>
  5243. <value>
  5244. An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
  5245. </value>
  5246. <remarks>
  5247. <para>
  5248. Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
  5249. </para>
  5250. <para>
  5251. There are two built strategies for determining the current date and time,
  5252. <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>
  5253. and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  5254. </para>
  5255. <para>
  5256. The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
  5257. </para>
  5258. </remarks>
  5259. </member>
  5260. <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
  5261. <summary>
  5262. Gets or sets the date pattern to be used for generating file names
  5263. when rolling over on date.
  5264. </summary>
  5265. <value>
  5266. The date pattern to be used for generating file names when rolling
  5267. over on date.
  5268. </value>
  5269. <remarks>
  5270. <para>
  5271. Takes a string in the same format as expected by
  5272. <see cref="T:log4net.DateFormatter.SimpleDateFormatter" />.
  5273. </para>
  5274. <para>
  5275. This property determines the rollover schedule when rolling over
  5276. on date.
  5277. </para>
  5278. </remarks>
  5279. </member>
  5280. <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
  5281. <summary>
  5282. Gets or sets the maximum number of backup files that are kept before
  5283. the oldest is erased.
  5284. </summary>
  5285. <value>
  5286. The maximum number of backup files that are kept before the oldest is
  5287. erased.
  5288. </value>
  5289. <remarks>
  5290. <para>
  5291. If set to zero, then there will be no backup files and the log file
  5292. will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
  5293. </para>
  5294. <para>
  5295. If a negative number is supplied then no deletions will be made. Note
  5296. that this could result in very slow performance as a large number of
  5297. files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
  5298. </para>
  5299. <para>
  5300. The maximum applies to <b>each</b> time based group of files and
  5301. <b>not</b> the total.
  5302. </para>
  5303. </remarks>
  5304. </member>
  5305. <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
  5306. <summary>
  5307. Gets or sets the maximum size that the output file is allowed to reach
  5308. before being rolled over to backup files.
  5309. </summary>
  5310. <value>
  5311. The maximum size in bytes that the output file is allowed to reach before being
  5312. rolled over to backup files.
  5313. </value>
  5314. <remarks>
  5315. <para>
  5316. This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
  5317. that it is required for differentiating the setter taking a
  5318. <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
  5319. argument.
  5320. </para>
  5321. <para>
  5322. The default maximum file size is 10MB (10*1024*1024).
  5323. </para>
  5324. </remarks>
  5325. </member>
  5326. <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
  5327. <summary>
  5328. Gets or sets the maximum size that the output file is allowed to reach
  5329. before being rolled over to backup files.
  5330. </summary>
  5331. <value>
  5332. The maximum size that the output file is allowed to reach before being
  5333. rolled over to backup files.
  5334. </value>
  5335. <remarks>
  5336. <para>
  5337. This property allows you to specify the maximum size with the
  5338. suffixes "KB", "MB" or "GB" so that the size is interpreted being
  5339. expressed respectively in kilobytes, megabytes or gigabytes.
  5340. </para>
  5341. <para>
  5342. For example, the value "10KB" will be interpreted as 10240 bytes.
  5343. </para>
  5344. <para>
  5345. The default maximum file size is 10MB.
  5346. </para>
  5347. <para>
  5348. If you have the option to set the maximum file size programmatically
  5349. consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
  5350. allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
  5351. </para>
  5352. </remarks>
  5353. </member>
  5354. <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
  5355. <summary>
  5356. Gets or sets the rolling file count direction.
  5357. </summary>
  5358. <value>
  5359. The rolling file count direction.
  5360. </value>
  5361. <remarks>
  5362. <para>
  5363. Indicates if the current file is the lowest numbered file or the
  5364. highest numbered file.
  5365. </para>
  5366. <para>
  5367. By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &lt; 0),
  5368. i.e. log.1 is most recent, log.5 is the 5th backup, etc...
  5369. </para>
  5370. <para>
  5371. <see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &gt;= 0 does the opposite i.e.
  5372. log.1 is the first backup made, log.5 is the 5th backup made, etc.
  5373. For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &gt;= 0 to reduce
  5374. rollover costs.
  5375. </para>
  5376. <para>The default file count direction is -1.</para>
  5377. </remarks>
  5378. </member>
  5379. <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
  5380. <summary>
  5381. Gets or sets the rolling style.
  5382. </summary>
  5383. <value>The rolling style.</value>
  5384. <remarks>
  5385. <para>
  5386. The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite" />.
  5387. </para>
  5388. <para>
  5389. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
  5390. <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
  5391. the appender would append to a single file rather than rolling
  5392. the file each time it is opened.
  5393. </para>
  5394. </remarks>
  5395. </member>
  5396. <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
  5397. <summary>
  5398. Gets or sets a value indicating whether to preserve the file name extension when rolling.
  5399. </summary>
  5400. <value>
  5401. <c>true</c> if the file name extension should be preserved.
  5402. </value>
  5403. <remarks>
  5404. <para>
  5405. By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
  5406. However, under Windows the new file name will loose any program associations as the
  5407. extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
  5408. file.curSizeRollBackup.log to maintain any program associations.
  5409. </para>
  5410. </remarks>
  5411. </member>
  5412. <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
  5413. <summary>
  5414. Gets or sets a value indicating whether to always log to
  5415. the same file.
  5416. </summary>
  5417. <value>
  5418. <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
  5419. </value>
  5420. <remarks>
  5421. <para>
  5422. By default file.log is always the current file. Optionally
  5423. file.log.yyyy-mm-dd for current formatted datePattern can by the currently
  5424. logging file (or file.log.curSizeRollBackup or even
  5425. file.log.yyyy-mm-dd.curSizeRollBackup).
  5426. </para>
  5427. <para>
  5428. This will make time based rollovers with a large number of backups
  5429. much faster as the appender it won't have to rename all the backups!
  5430. </para>
  5431. </remarks>
  5432. </member>
  5433. <member name="F:log4net.Appender.RollingFileAppender.declaringType">
  5434. <summary>
  5435. The fully qualified type of the RollingFileAppender class.
  5436. </summary>
  5437. <remarks>
  5438. Used by the internal logger to record the Type of the
  5439. log message.
  5440. </remarks>
  5441. </member>
  5442. <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
  5443. <summary>
  5444. Sets the quiet writer being used.
  5445. </summary>
  5446. <remarks>
  5447. This method can be overridden by sub classes.
  5448. </remarks>
  5449. <param name="writer">the writer to set</param>
  5450. </member>
  5451. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
  5452. <summary>
  5453. Write out a logging event.
  5454. </summary>
  5455. <param name="loggingEvent">the event to write to file.</param>
  5456. <remarks>
  5457. <para>
  5458. Handles append time behavior for RollingFileAppender. This checks
  5459. if a roll over either by date (checked first) or time (checked second)
  5460. is need and then appends to the file last.
  5461. </para>
  5462. </remarks>
  5463. </member>
  5464. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
  5465. <summary>
  5466. Write out an array of logging events.
  5467. </summary>
  5468. <param name="loggingEvents">the events to write to file.</param>
  5469. <remarks>
  5470. <para>
  5471. Handles append time behavior for RollingFileAppender. This checks
  5472. if a roll over either by date (checked first) or time (checked second)
  5473. is need and then appends to the file last.
  5474. </para>
  5475. </remarks>
  5476. </member>
  5477. <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
  5478. <summary>
  5479. Performs any required rolling before outputting the next event
  5480. </summary>
  5481. <remarks>
  5482. <para>
  5483. Handles append time behavior for RollingFileAppender. This checks
  5484. if a roll over either by date (checked first) or time (checked second)
  5485. is need and then appends to the file last.
  5486. </para>
  5487. </remarks>
  5488. </member>
  5489. <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
  5490. <summary>
  5491. Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  5492. is false then the fully qualified name is determined and used.
  5493. </summary>
  5494. <param name="fileName">the name of the file to open</param>
  5495. <param name="append">true to append to existing file</param>
  5496. <remarks>
  5497. <para>This method will ensure that the directory structure
  5498. for the <paramref name="fileName"/> specified exists.</para>
  5499. </remarks>
  5500. </member>
  5501. <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
  5502. <summary>
  5503. Get the current output file name
  5504. </summary>
  5505. <param name="fileName">the base file name</param>
  5506. <returns>the output file name</returns>
  5507. <remarks>
  5508. The output file name is based on the base fileName specified.
  5509. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
  5510. file name is the same as the base file passed in. Otherwise
  5511. the output file depends on the date pattern, on the count
  5512. direction or both.
  5513. </remarks>
  5514. </member>
  5515. <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
  5516. <summary>
  5517. Determines curSizeRollBackups (only within the current roll point)
  5518. </summary>
  5519. </member>
  5520. <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
  5521. <summary>
  5522. Generates a wildcard pattern that can be used to find all files
  5523. that are similar to the base file name.
  5524. </summary>
  5525. <param name="baseFileName"></param>
  5526. <returns></returns>
  5527. </member>
  5528. <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
  5529. <summary>
  5530. Builds a list of filenames for all files matching the base filename plus a file
  5531. pattern.
  5532. </summary>
  5533. <param name="baseFilePath"></param>
  5534. <returns></returns>
  5535. </member>
  5536. <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
  5537. <summary>
  5538. Initiates a roll over if needed for crossing a date boundary since the last run.
  5539. </summary>
  5540. </member>
  5541. <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
  5542. <summary>
  5543. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  5544. </summary>
  5545. <remarks>
  5546. <para>
  5547. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  5548. The following is done
  5549. <list type="bullet">
  5550. <item>determine curSizeRollBackups (only within the current roll point)</item>
  5551. <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
  5552. </list>
  5553. </para>
  5554. </remarks>
  5555. </member>
  5556. <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
  5557. <summary>
  5558. Does the work of bumping the 'current' file counter higher
  5559. to the highest count when an incremental file name is seen.
  5560. The highest count is either the first file (when count direction
  5561. is greater than 0) or the last file (when count direction less than 0).
  5562. In either case, we want to know the highest count that is present.
  5563. </summary>
  5564. <param name="baseFile"></param>
  5565. <param name="curFileName"></param>
  5566. </member>
  5567. <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
  5568. <summary>
  5569. Attempts to extract a number from the end of the file name that indicates
  5570. the number of the times the file has been rolled over.
  5571. </summary>
  5572. <remarks>
  5573. Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
  5574. </remarks>
  5575. <param name="curFileName"></param>
  5576. <returns></returns>
  5577. </member>
  5578. <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
  5579. <summary>
  5580. Takes a list of files and a base file name, and looks for
  5581. 'incremented' versions of the base file. Bumps the max
  5582. count up to the highest count seen.
  5583. </summary>
  5584. <param name="baseFile"></param>
  5585. <param name="arrayFiles"></param>
  5586. </member>
  5587. <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
  5588. <summary>
  5589. Calculates the RollPoint for the datePattern supplied.
  5590. </summary>
  5591. <param name="datePattern">the date pattern to calculate the check period for</param>
  5592. <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
  5593. <remarks>
  5594. Essentially the date pattern is examined to determine what the
  5595. most suitable roll point is. The roll point chosen is the roll point
  5596. with the smallest period that can be detected using the date pattern
  5597. supplied. i.e. if the date pattern only outputs the year, month, day
  5598. and hour then the smallest roll point that can be detected would be
  5599. and hourly roll point as minutes could not be detected.
  5600. </remarks>
  5601. </member>
  5602. <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
  5603. <summary>
  5604. Initialize the appender based on the options set
  5605. </summary>
  5606. <remarks>
  5607. <para>
  5608. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5609. activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
  5610. be called on this object after the configuration properties have
  5611. been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
  5612. object is in an undefined state and must not be used.
  5613. </para>
  5614. <para>
  5615. If any of the configuration properties are modified then
  5616. <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
  5617. </para>
  5618. <para>
  5619. Sets initial conditions including date/time roll over information, first check,
  5620. scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
  5621. the current number of backups.
  5622. </para>
  5623. </remarks>
  5624. </member>
  5625. <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
  5626. <summary>
  5627. </summary>
  5628. <param name="path1"></param>
  5629. <param name="path2">.1, .2, .3, etc.</param>
  5630. <returns></returns>
  5631. </member>
  5632. <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
  5633. <summary>
  5634. Rollover the file(s) to date/time tagged file(s).
  5635. </summary>
  5636. <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
  5637. <remarks>
  5638. <para>
  5639. Rollover the file(s) to date/time tagged file(s).
  5640. Resets curSizeRollBackups.
  5641. If fileIsOpen is set then the new file is opened (through SafeOpenFile).
  5642. </para>
  5643. </remarks>
  5644. </member>
  5645. <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
  5646. <summary>
  5647. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
  5648. </summary>
  5649. <param name="fromFile">Name of existing file to roll.</param>
  5650. <param name="toFile">New name for file.</param>
  5651. <remarks>
  5652. <para>
  5653. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
  5654. also checks for existence of target file and deletes if it does.
  5655. </para>
  5656. </remarks>
  5657. </member>
  5658. <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
  5659. <summary>
  5660. Test if a file exists at a specified path
  5661. </summary>
  5662. <param name="path">the path to the file</param>
  5663. <returns>true if the file exists</returns>
  5664. <remarks>
  5665. <para>
  5666. Test if a file exists at a specified path
  5667. </para>
  5668. </remarks>
  5669. </member>
  5670. <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
  5671. <summary>
  5672. Deletes the specified file if it exists.
  5673. </summary>
  5674. <param name="fileName">The file to delete.</param>
  5675. <remarks>
  5676. <para>
  5677. Delete a file if is exists.
  5678. The file is first moved to a new filename then deleted.
  5679. This allows the file to be removed even when it cannot
  5680. be deleted, but it still can be moved.
  5681. </para>
  5682. </remarks>
  5683. </member>
  5684. <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
  5685. <summary>
  5686. Implements file roll base on file size.
  5687. </summary>
  5688. <remarks>
  5689. <para>
  5690. If the maximum number of size based backups is reached
  5691. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  5692. file is deleted -- its index determined by the sign of countDirection.
  5693. If <c>countDirection</c> &lt; 0, then files
  5694. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  5695. are renamed to {<c>File.2</c>, ...,
  5696. <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
  5697. renamed <c>File.1</c> and closed.
  5698. </para>
  5699. <para>
  5700. A new file is created to receive further log output.
  5701. </para>
  5702. <para>
  5703. If <c>maxSizeRollBackups</c> is equal to zero, then the
  5704. <c>File</c> is truncated with no backup files created.
  5705. </para>
  5706. <para>
  5707. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  5708. renamed if needed and no files are deleted.
  5709. </para>
  5710. </remarks>
  5711. </member>
  5712. <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
  5713. <summary>
  5714. Implements file roll.
  5715. </summary>
  5716. <param name="baseFileName">the base name to rename</param>
  5717. <remarks>
  5718. <para>
  5719. If the maximum number of size based backups is reached
  5720. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  5721. file is deleted -- its index determined by the sign of countDirection.
  5722. If <c>countDirection</c> &lt; 0, then files
  5723. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  5724. are renamed to {<c>File.2</c>, ...,
  5725. <c>File.curSizeRollBackups</c>}.
  5726. </para>
  5727. <para>
  5728. If <c>maxSizeRollBackups</c> is equal to zero, then the
  5729. <c>File</c> is truncated with no backup files created.
  5730. </para>
  5731. <para>
  5732. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  5733. renamed if needed and no files are deleted.
  5734. </para>
  5735. <para>
  5736. This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
  5737. </para>
  5738. </remarks>
  5739. </member>
  5740. <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
  5741. <summary>
  5742. Get the start time of the next window for the current rollpoint
  5743. </summary>
  5744. <param name="currentDateTime">the current date</param>
  5745. <param name="rollPoint">the type of roll point we are working with</param>
  5746. <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
  5747. <remarks>
  5748. <para>
  5749. Returns the date of the next roll point after the currentDateTime date passed to the method.
  5750. </para>
  5751. <para>
  5752. The basic strategy is to subtract the time parts that are less significant
  5753. than the rollpoint from the current time. This should roll the time back to
  5754. the start of the time window for the current rollpoint. Then we add 1 window
  5755. worth of time and get the start time of the next window for the rollpoint.
  5756. </para>
  5757. </remarks>
  5758. </member>
  5759. <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
  5760. <summary>
  5761. This object supplies the current date/time. Allows test code to plug in
  5762. a method to control this class when testing date/time based rolling. The default
  5763. implementation uses the underlying value of DateTime.Now.
  5764. </summary>
  5765. </member>
  5766. <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
  5767. <summary>
  5768. The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
  5769. meaning daily rollover.
  5770. </summary>
  5771. </member>
  5772. <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
  5773. <summary>
  5774. The actual formatted filename that is currently being written to
  5775. or will be the file transferred to on roll over
  5776. (based on staticLogFileName).
  5777. </summary>
  5778. </member>
  5779. <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
  5780. <summary>
  5781. The timestamp when we shall next recompute the filename.
  5782. </summary>
  5783. </member>
  5784. <member name="F:log4net.Appender.RollingFileAppender.m_now">
  5785. <summary>
  5786. Holds date of last roll over
  5787. </summary>
  5788. </member>
  5789. <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
  5790. <summary>
  5791. The type of rolling done
  5792. </summary>
  5793. </member>
  5794. <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
  5795. <summary>
  5796. The default maximum file size is 10MB
  5797. </summary>
  5798. </member>
  5799. <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
  5800. <summary>
  5801. There is zero backup files by default
  5802. </summary>
  5803. </member>
  5804. <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
  5805. <summary>
  5806. How many sized based backups have been made so far
  5807. </summary>
  5808. </member>
  5809. <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
  5810. <summary>
  5811. The rolling file count direction.
  5812. </summary>
  5813. </member>
  5814. <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
  5815. <summary>
  5816. The rolling mode used in this appender.
  5817. </summary>
  5818. </member>
  5819. <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
  5820. <summary>
  5821. Cache flag set if we are rolling by date.
  5822. </summary>
  5823. </member>
  5824. <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
  5825. <summary>
  5826. Cache flag set if we are rolling by size.
  5827. </summary>
  5828. </member>
  5829. <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
  5830. <summary>
  5831. Value indicating whether to always log to the same file.
  5832. </summary>
  5833. </member>
  5834. <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
  5835. <summary>
  5836. Value indicating whether to preserve the file name extension when rolling.
  5837. </summary>
  5838. </member>
  5839. <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
  5840. <summary>
  5841. FileName provided in configuration. Used for rolling properly
  5842. </summary>
  5843. </member>
  5844. <member name="F:log4net.Appender.RollingFileAppender.m_mutexForRolling">
  5845. <summary>
  5846. A mutex that is used to lock rolling of files.
  5847. </summary>
  5848. </member>
  5849. <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
  5850. <summary>
  5851. The 1st of January 1970 in UTC
  5852. </summary>
  5853. </member>
  5854. <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
  5855. <summary>
  5856. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  5857. </summary>
  5858. <remarks>
  5859. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  5860. Used primarily to allow test classes to plug themselves in so they can
  5861. supply test date/times.
  5862. </remarks>
  5863. </member>
  5864. <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
  5865. <summary>
  5866. Gets the <i>current</i> time.
  5867. </summary>
  5868. <value>The <i>current</i> time.</value>
  5869. <remarks>
  5870. <para>
  5871. Gets the <i>current</i> time.
  5872. </para>
  5873. </remarks>
  5874. </member>
  5875. <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
  5876. <summary>
  5877. Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
  5878. </summary>
  5879. </member>
  5880. <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
  5881. <summary>
  5882. Gets the <b>current</b> time.
  5883. </summary>
  5884. <value>The <b>current</b> time.</value>
  5885. <remarks>
  5886. <para>
  5887. Gets the <b>current</b> time.
  5888. </para>
  5889. </remarks>
  5890. </member>
  5891. <member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime">
  5892. <summary>
  5893. Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC).
  5894. </summary>
  5895. </member>
  5896. <member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now">
  5897. <summary>
  5898. Gets the <b>current</b> time.
  5899. </summary>
  5900. <value>The <b>current</b> time.</value>
  5901. <remarks>
  5902. <para>
  5903. Gets the <b>current</b> time.
  5904. </para>
  5905. </remarks>
  5906. </member>
  5907. <member name="T:log4net.Appender.SmtpPickupDirAppender">
  5908. <summary>
  5909. Send an email when a specific logging event occurs, typically on errors
  5910. or fatal errors. Rather than sending via smtp it writes a file into the
  5911. directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
  5912. as the IIS SMTP agent to manage sending the messages.
  5913. </summary>
  5914. <remarks>
  5915. <para>
  5916. The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
  5917. except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
  5918. <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
  5919. </para>
  5920. <para>
  5921. The number of logging events delivered in this e-mail depend on
  5922. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  5923. <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
  5924. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  5925. cyclic buffer. This keeps memory requirements at a reasonable level while
  5926. still delivering useful application context.
  5927. </para>
  5928. </remarks>
  5929. <author>Niall Daley</author>
  5930. <author>Nicko Cadell</author>
  5931. </member>
  5932. <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
  5933. <summary>
  5934. Default constructor
  5935. </summary>
  5936. <remarks>
  5937. <para>
  5938. Default constructor
  5939. </para>
  5940. </remarks>
  5941. </member>
  5942. <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
  5943. <summary>
  5944. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  5945. </summary>
  5946. <value>
  5947. A semicolon-delimited list of e-mail addresses.
  5948. </value>
  5949. <remarks>
  5950. <para>
  5951. A semicolon-delimited list of e-mail addresses.
  5952. </para>
  5953. </remarks>
  5954. </member>
  5955. <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
  5956. <summary>
  5957. Gets or sets the e-mail address of the sender.
  5958. </summary>
  5959. <value>
  5960. The e-mail address of the sender.
  5961. </value>
  5962. <remarks>
  5963. <para>
  5964. The e-mail address of the sender.
  5965. </para>
  5966. </remarks>
  5967. </member>
  5968. <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
  5969. <summary>
  5970. Gets or sets the subject line of the e-mail message.
  5971. </summary>
  5972. <value>
  5973. The subject line of the e-mail message.
  5974. </value>
  5975. <remarks>
  5976. <para>
  5977. The subject line of the e-mail message.
  5978. </para>
  5979. </remarks>
  5980. </member>
  5981. <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
  5982. <summary>
  5983. Gets or sets the path to write the messages to.
  5984. </summary>
  5985. <remarks>
  5986. <para>
  5987. Gets or sets the path to write the messages to. This should be the same
  5988. as that used by the agent sending the messages.
  5989. </para>
  5990. </remarks>
  5991. </member>
  5992. <member name="P:log4net.Appender.SmtpPickupDirAppender.FileExtension">
  5993. <summary>
  5994. Gets or sets the file extension for the generated files
  5995. </summary>
  5996. <value>
  5997. The file extension for the generated files
  5998. </value>
  5999. <remarks>
  6000. <para>
  6001. The file extension for the generated files
  6002. </para>
  6003. </remarks>
  6004. </member>
  6005. <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
  6006. <summary>
  6007. Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  6008. </summary>
  6009. <value>
  6010. The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  6011. </value>
  6012. <remarks>
  6013. <para>
  6014. Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
  6015. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  6016. security context to use. The default behavior is to use the security context
  6017. of the current thread.
  6018. </para>
  6019. </remarks>
  6020. </member>
  6021. <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  6022. <summary>
  6023. Sends the contents of the cyclic buffer as an e-mail message.
  6024. </summary>
  6025. <param name="events">The logging events to send.</param>
  6026. <remarks>
  6027. <para>
  6028. Sends the contents of the cyclic buffer as an e-mail message.
  6029. </para>
  6030. </remarks>
  6031. </member>
  6032. <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
  6033. <summary>
  6034. Activate the options on this appender.
  6035. </summary>
  6036. <remarks>
  6037. <para>
  6038. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6039. activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
  6040. be called on this object after the configuration properties have
  6041. been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
  6042. object is in an undefined state and must not be used.
  6043. </para>
  6044. <para>
  6045. If any of the configuration properties are modified then
  6046. <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
  6047. </para>
  6048. </remarks>
  6049. </member>
  6050. <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
  6051. <summary>
  6052. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6053. </summary>
  6054. <value><c>true</c></value>
  6055. <remarks>
  6056. <para>
  6057. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6058. </para>
  6059. </remarks>
  6060. </member>
  6061. <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
  6062. <summary>
  6063. Convert a path into a fully qualified path.
  6064. </summary>
  6065. <param name="path">The path to convert.</param>
  6066. <returns>The fully qualified path.</returns>
  6067. <remarks>
  6068. <para>
  6069. Converts the path specified to a fully
  6070. qualified path. If the path is relative it is
  6071. taken as relative from the application base
  6072. directory.
  6073. </para>
  6074. </remarks>
  6075. </member>
  6076. <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
  6077. <summary>
  6078. The security context to use for privileged calls
  6079. </summary>
  6080. </member>
  6081. <member name="T:log4net.Appender.TelnetAppender">
  6082. <summary>
  6083. Appender that allows clients to connect via Telnet to receive log messages
  6084. </summary>
  6085. <remarks>
  6086. <para>
  6087. The TelnetAppender accepts socket connections and streams logging messages
  6088. back to the client.
  6089. The output is provided in a telnet-friendly way so that a log can be monitored
  6090. over a TCP/IP socket.
  6091. This allows simple remote monitoring of application logging.
  6092. </para>
  6093. <para>
  6094. The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
  6095. </para>
  6096. </remarks>
  6097. <author>Keith Long</author>
  6098. <author>Nicko Cadell</author>
  6099. </member>
  6100. <member name="M:log4net.Appender.TelnetAppender.#ctor">
  6101. <summary>
  6102. Default constructor
  6103. </summary>
  6104. <remarks>
  6105. <para>
  6106. Default constructor
  6107. </para>
  6108. </remarks>
  6109. </member>
  6110. <member name="F:log4net.Appender.TelnetAppender.declaringType">
  6111. <summary>
  6112. The fully qualified type of the TelnetAppender class.
  6113. </summary>
  6114. <remarks>
  6115. Used by the internal logger to record the Type of the
  6116. log message.
  6117. </remarks>
  6118. </member>
  6119. <member name="P:log4net.Appender.TelnetAppender.Port">
  6120. <summary>
  6121. Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  6122. </summary>
  6123. <value>
  6124. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  6125. indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  6126. </value>
  6127. <remarks>
  6128. <para>
  6129. The default value is 23 (the telnet port).
  6130. </para>
  6131. </remarks>
  6132. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort" />
  6133. or greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
  6134. </member>
  6135. <member name="M:log4net.Appender.TelnetAppender.OnClose">
  6136. <summary>
  6137. Overrides the parent method to close the socket handler
  6138. </summary>
  6139. <remarks>
  6140. <para>
  6141. Closes all the outstanding connections.
  6142. </para>
  6143. </remarks>
  6144. </member>
  6145. <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
  6146. <summary>
  6147. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6148. </summary>
  6149. <value><c>true</c></value>
  6150. <remarks>
  6151. <para>
  6152. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6153. </para>
  6154. </remarks>
  6155. </member>
  6156. <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
  6157. <summary>
  6158. Initialize the appender based on the options set.
  6159. </summary>
  6160. <remarks>
  6161. <para>
  6162. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6163. activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
  6164. be called on this object after the configuration properties have
  6165. been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
  6166. object is in an undefined state and must not be used.
  6167. </para>
  6168. <para>
  6169. If any of the configuration properties are modified then
  6170. <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
  6171. </para>
  6172. <para>
  6173. Create the socket handler and wait for connections
  6174. </para>
  6175. </remarks>
  6176. </member>
  6177. <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
  6178. <summary>
  6179. Writes the logging event to each connected client.
  6180. </summary>
  6181. <param name="loggingEvent">The event to log.</param>
  6182. <remarks>
  6183. <para>
  6184. Writes the logging event to each connected client.
  6185. </para>
  6186. </remarks>
  6187. </member>
  6188. <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
  6189. <summary>
  6190. Helper class to manage connected clients
  6191. </summary>
  6192. <remarks>
  6193. <para>
  6194. The SocketHandler class is used to accept connections from
  6195. clients. It is threaded so that clients can connect/disconnect
  6196. asynchronously.
  6197. </para>
  6198. </remarks>
  6199. </member>
  6200. <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
  6201. <summary>
  6202. Class that represents a client connected to this handler
  6203. </summary>
  6204. <remarks>
  6205. <para>
  6206. Class that represents a client connected to this handler
  6207. </para>
  6208. </remarks>
  6209. </member>
  6210. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
  6211. <summary>
  6212. Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
  6213. </summary>
  6214. <param name="socket">the client's socket</param>
  6215. <remarks>
  6216. <para>
  6217. Opens a stream writer on the socket.
  6218. </para>
  6219. </remarks>
  6220. </member>
  6221. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
  6222. <summary>
  6223. Write a string to the client
  6224. </summary>
  6225. <param name="message">string to send</param>
  6226. <remarks>
  6227. <para>
  6228. Write a string to the client
  6229. </para>
  6230. </remarks>
  6231. </member>
  6232. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
  6233. <summary>
  6234. Cleanup the clients connection
  6235. </summary>
  6236. <remarks>
  6237. <para>
  6238. Close the socket connection.
  6239. </para>
  6240. </remarks>
  6241. </member>
  6242. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
  6243. <summary>
  6244. Opens a new server port on <paramref ref="port"/>
  6245. </summary>
  6246. <param name="port">the local port to listen on for connections</param>
  6247. <remarks>
  6248. <para>
  6249. Creates a socket handler on the specified local server port.
  6250. </para>
  6251. </remarks>
  6252. </member>
  6253. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
  6254. <summary>
  6255. Sends a string message to each of the connected clients
  6256. </summary>
  6257. <param name="message">the text to send</param>
  6258. <remarks>
  6259. <para>
  6260. Sends a string message to each of the connected clients
  6261. </para>
  6262. </remarks>
  6263. </member>
  6264. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  6265. <summary>
  6266. Add a client to the internal clients list
  6267. </summary>
  6268. <param name="client">client to add</param>
  6269. </member>
  6270. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  6271. <summary>
  6272. Remove a client from the internal clients list
  6273. </summary>
  6274. <param name="client">client to remove</param>
  6275. </member>
  6276. <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
  6277. <summary>
  6278. Test if this handler has active connections
  6279. </summary>
  6280. <value>
  6281. <c>true</c> if this handler has active connections
  6282. </value>
  6283. <remarks>
  6284. <para>
  6285. This property will be <c>true</c> while this handler has
  6286. active connections, that is at least one connection that
  6287. the handler will attempt to send a message to.
  6288. </para>
  6289. </remarks>
  6290. </member>
  6291. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
  6292. <summary>
  6293. Close all network connections
  6294. </summary>
  6295. <remarks>
  6296. <para>
  6297. Make sure we close all network connections
  6298. </para>
  6299. </remarks>
  6300. </member>
  6301. <member name="T:log4net.Appender.TextWriterAppender">
  6302. <summary>
  6303. Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
  6304. </summary>
  6305. <remarks>
  6306. <para>
  6307. An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
  6308. </para>
  6309. <para>
  6310. This appender may be used stand alone if initialized with an appropriate
  6311. writer, however it is typically used as a base class for an appender that
  6312. can open a <see cref="T:System.IO.TextWriter"/> to write to.
  6313. </para>
  6314. </remarks>
  6315. <author>Nicko Cadell</author>
  6316. <author>Gert Driesen</author>
  6317. <author>Douglas de la Torre</author>
  6318. </member>
  6319. <member name="M:log4net.Appender.TextWriterAppender.#ctor">
  6320. <summary>
  6321. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class.
  6322. </summary>
  6323. <remarks>
  6324. <para>
  6325. Default constructor.
  6326. </para>
  6327. </remarks>
  6328. </member>
  6329. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
  6330. <summary>
  6331. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class and
  6332. sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
  6333. with the specified <see cref="T:System.IO.Stream"/>.
  6334. </summary>
  6335. <param name="layout">The layout to use with this appender.</param>
  6336. <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
  6337. <remarks>
  6338. <para>
  6339. Obsolete constructor.
  6340. </para>
  6341. </remarks>
  6342. </member>
  6343. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
  6344. <summary>
  6345. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class and sets
  6346. the output destination to the specified <see cref="T:System.IO.StreamWriter" />.
  6347. </summary>
  6348. <param name="layout">The layout to use with this appender</param>
  6349. <param name="writer">The <see cref="T:System.IO.TextWriter" /> to output to</param>
  6350. <remarks>
  6351. The <see cref="T:System.IO.TextWriter" /> must have been previously opened.
  6352. </remarks>
  6353. <remarks>
  6354. <para>
  6355. Obsolete constructor.
  6356. </para>
  6357. </remarks>
  6358. </member>
  6359. <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
  6360. <summary>
  6361. Gets or set whether the appender will flush at the end
  6362. of each append operation.
  6363. </summary>
  6364. <value>
  6365. <para>
  6366. The default behavior is to flush at the end of each
  6367. append operation.
  6368. </para>
  6369. <para>
  6370. If this option is set to <c>false</c>, then the underlying
  6371. stream can defer persisting the logging event to a later
  6372. time.
  6373. </para>
  6374. </value>
  6375. <remarks>
  6376. Avoiding the flush operation at the end of each append results in
  6377. a performance gain of 10 to 20 percent. However, there is safety
  6378. trade-off involved in skipping flushing. Indeed, when flushing is
  6379. skipped, then it is likely that the last few log events will not
  6380. be recorded on disk when the application exits. This is a high
  6381. price to pay even for a 20% performance gain.
  6382. </remarks>
  6383. </member>
  6384. <member name="P:log4net.Appender.TextWriterAppender.Writer">
  6385. <summary>
  6386. Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
  6387. </summary>
  6388. <remarks>
  6389. <para>
  6390. The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
  6391. </para>
  6392. <para>
  6393. The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
  6394. instance is closed.
  6395. </para>
  6396. <para>
  6397. <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
  6398. </para>
  6399. </remarks>
  6400. </member>
  6401. <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
  6402. <summary>
  6403. This method determines if there is a sense in attempting to append.
  6404. </summary>
  6405. <remarks>
  6406. <para>
  6407. This method checks if an output target has been set and if a
  6408. layout has been set.
  6409. </para>
  6410. </remarks>
  6411. <returns><c>false</c> if any of the preconditions fail.</returns>
  6412. </member>
  6413. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
  6414. <summary>
  6415. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  6416. method.
  6417. </summary>
  6418. <param name="loggingEvent">The event to log.</param>
  6419. <remarks>
  6420. <para>
  6421. Writes a log statement to the output stream if the output stream exists
  6422. and is writable.
  6423. </para>
  6424. <para>
  6425. The format of the output will depend on the appender's layout.
  6426. </para>
  6427. </remarks>
  6428. </member>
  6429. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
  6430. <summary>
  6431. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  6432. method.
  6433. </summary>
  6434. <param name="loggingEvents">The array of events to log.</param>
  6435. <remarks>
  6436. <para>
  6437. This method writes all the bulk logged events to the output writer
  6438. before flushing the stream.
  6439. </para>
  6440. </remarks>
  6441. </member>
  6442. <member name="M:log4net.Appender.TextWriterAppender.OnClose">
  6443. <summary>
  6444. Close this appender instance. The underlying stream or writer is also closed.
  6445. </summary>
  6446. <remarks>
  6447. Closed appenders cannot be reused.
  6448. </remarks>
  6449. </member>
  6450. <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
  6451. <summary>
  6452. Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
  6453. <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
  6454. </summary>
  6455. <value>
  6456. The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  6457. </value>
  6458. </member>
  6459. <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
  6460. <summary>
  6461. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6462. </summary>
  6463. <value><c>true</c></value>
  6464. <remarks>
  6465. <para>
  6466. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6467. </para>
  6468. </remarks>
  6469. </member>
  6470. <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
  6471. <summary>
  6472. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  6473. </summary>
  6474. <remarks>
  6475. <para>
  6476. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  6477. </para>
  6478. </remarks>
  6479. </member>
  6480. <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
  6481. <summary>
  6482. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  6483. </summary>
  6484. <remarks>
  6485. <para>
  6486. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  6487. </para>
  6488. </remarks>
  6489. </member>
  6490. <member name="M:log4net.Appender.TextWriterAppender.Reset">
  6491. <summary>
  6492. Clears internal references to the underlying <see cref="T:System.IO.TextWriter" />
  6493. and other variables.
  6494. </summary>
  6495. <remarks>
  6496. <para>
  6497. Subclasses can override this method for an alternate closing behavior.
  6498. </para>
  6499. </remarks>
  6500. </member>
  6501. <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
  6502. <summary>
  6503. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  6504. </summary>
  6505. <remarks>
  6506. <para>
  6507. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  6508. </para>
  6509. </remarks>
  6510. </member>
  6511. <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
  6512. <summary>
  6513. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  6514. </summary>
  6515. <remarks>
  6516. <para>
  6517. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  6518. </para>
  6519. </remarks>
  6520. </member>
  6521. <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
  6522. <summary>
  6523. Called to allow a subclass to lazily initialize the writer
  6524. </summary>
  6525. <remarks>
  6526. <para>
  6527. This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
  6528. <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
  6529. attempt to initialize the writer multiple times.
  6530. </para>
  6531. </remarks>
  6532. </member>
  6533. <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
  6534. <summary>
  6535. Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  6536. will be written to.
  6537. </summary>
  6538. <value>
  6539. The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
  6540. </value>
  6541. <remarks>
  6542. <para>
  6543. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  6544. will be written to.
  6545. </para>
  6546. </remarks>
  6547. </member>
  6548. <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
  6549. <summary>
  6550. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  6551. will be written to.
  6552. </summary>
  6553. </member>
  6554. <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
  6555. <summary>
  6556. Immediate flush means that the underlying <see cref="T:System.IO.TextWriter" />
  6557. or output stream will be flushed at the end of each append operation.
  6558. </summary>
  6559. <remarks>
  6560. <para>
  6561. Immediate flush is slower but ensures that each append request is
  6562. actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
  6563. <c>false</c>, then there is a good chance that the last few
  6564. logging events are not actually persisted if and when the application
  6565. crashes.
  6566. </para>
  6567. <para>
  6568. The default value is <c>true</c>.
  6569. </para>
  6570. </remarks>
  6571. </member>
  6572. <member name="F:log4net.Appender.TextWriterAppender.declaringType">
  6573. <summary>
  6574. The fully qualified type of the TextWriterAppender class.
  6575. </summary>
  6576. <remarks>
  6577. Used by the internal logger to record the Type of the
  6578. log message.
  6579. </remarks>
  6580. </member>
  6581. <member name="M:log4net.Appender.TextWriterAppender.Flush(System.Int32)">
  6582. <summary>
  6583. Flushes any buffered log data.
  6584. </summary>
  6585. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  6586. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  6587. </member>
  6588. <member name="T:log4net.Appender.TraceAppender">
  6589. <summary>
  6590. Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
  6591. </summary>
  6592. <remarks>
  6593. <para>
  6594. The application configuration file can be used to control what listeners
  6595. are actually used. See the MSDN documentation for the
  6596. <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
  6597. trace system.
  6598. </para>
  6599. <para>
  6600. Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
  6601. method. The event's logger name is the default value for the category parameter
  6602. of the Write method.
  6603. </para>
  6604. <para>
  6605. <b>Compact Framework</b><br />
  6606. The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
  6607. class for any operation except <c>Assert</c>. When using the Compact Framework this
  6608. appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
  6609. the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
  6610. </para>
  6611. </remarks>
  6612. <author>Douglas de la Torre</author>
  6613. <author>Nicko Cadell</author>
  6614. <author>Gert Driesen</author>
  6615. <author>Ron Grabowski</author>
  6616. </member>
  6617. <member name="M:log4net.Appender.TraceAppender.#ctor">
  6618. <summary>
  6619. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender" />.
  6620. </summary>
  6621. <remarks>
  6622. <para>
  6623. Default constructor.
  6624. </para>
  6625. </remarks>
  6626. </member>
  6627. <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
  6628. <summary>
  6629. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender" />
  6630. with a specified layout.
  6631. </summary>
  6632. <param name="layout">The layout to use with this appender.</param>
  6633. <remarks>
  6634. <para>
  6635. Obsolete constructor.
  6636. </para>
  6637. </remarks>
  6638. </member>
  6639. <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
  6640. <summary>
  6641. Gets or sets a value that indicates whether the appender will
  6642. flush at the end of each write.
  6643. </summary>
  6644. <remarks>
  6645. <para>The default behavior is to flush at the end of each
  6646. write. If the option is set to<c>false</c>, then the underlying
  6647. stream can defer writing to physical medium to a later time.
  6648. </para>
  6649. <para>
  6650. Avoiding the flush operation at the end of each append results
  6651. in a performance gain of 10 to 20 percent. However, there is safety
  6652. trade-off involved in skipping flushing. Indeed, when flushing is
  6653. skipped, then it is likely that the last few log events will not
  6654. be recorded on disk when the application exits. This is a high
  6655. price to pay even for a 20% performance gain.
  6656. </para>
  6657. </remarks>
  6658. </member>
  6659. <member name="P:log4net.Appender.TraceAppender.Category">
  6660. <summary>
  6661. The category parameter sent to the Trace method.
  6662. </summary>
  6663. <remarks>
  6664. <para>
  6665. Defaults to %logger which will use the logger name of the current
  6666. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  6667. </para>
  6668. <para>
  6669. </para>
  6670. </remarks>
  6671. </member>
  6672. <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
  6673. <summary>
  6674. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  6675. </summary>
  6676. <param name="loggingEvent">The event to log.</param>
  6677. <remarks>
  6678. <para>
  6679. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  6680. </para>
  6681. </remarks>
  6682. </member>
  6683. <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
  6684. <summary>
  6685. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6686. </summary>
  6687. <value><c>true</c></value>
  6688. <remarks>
  6689. <para>
  6690. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6691. </para>
  6692. </remarks>
  6693. </member>
  6694. <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
  6695. <summary>
  6696. Immediate flush means that the underlying writer or output stream
  6697. will be flushed at the end of each append operation.
  6698. </summary>
  6699. <remarks>
  6700. <para>
  6701. Immediate flush is slower but ensures that each append request is
  6702. actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
  6703. <c>false</c>, then there is a good chance that the last few
  6704. logs events are not actually written to persistent media if and
  6705. when the application crashes.
  6706. </para>
  6707. <para>
  6708. The default value is <c>true</c>.</para>
  6709. </remarks>
  6710. </member>
  6711. <member name="F:log4net.Appender.TraceAppender.m_category">
  6712. <summary>
  6713. Defaults to %logger
  6714. </summary>
  6715. </member>
  6716. <member name="M:log4net.Appender.TraceAppender.Flush(System.Int32)">
  6717. <summary>
  6718. Flushes any buffered log data.
  6719. </summary>
  6720. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  6721. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  6722. </member>
  6723. <member name="T:log4net.Appender.UdpAppender">
  6724. <summary>
  6725. Sends logging events as connectionless UDP datagrams to a remote host or a
  6726. multicast group using an <see cref="T:System.Net.Sockets.UdpClient" />.
  6727. </summary>
  6728. <remarks>
  6729. <para>
  6730. UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
  6731. </para>
  6732. <para>
  6733. To view the logging results, a custom application can be developed that listens for logging
  6734. events.
  6735. </para>
  6736. <para>
  6737. When decoding events send via this appender remember to use the same encoding
  6738. to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
  6739. property to specify the encoding to use.
  6740. </para>
  6741. </remarks>
  6742. <example>
  6743. This example shows how to log receive logging events that are sent
  6744. on IP address 244.0.0.1 and port 8080 to the console. The event is
  6745. encoded in the packet as a unicode string and it is decoded as such.
  6746. <code lang="C#">
  6747. IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
  6748. UdpClient udpClient;
  6749. byte[] buffer;
  6750. string loggingEvent;
  6751. try
  6752. {
  6753. udpClient = new UdpClient(8080);
  6754. while(true)
  6755. {
  6756. buffer = udpClient.Receive(ref remoteEndPoint);
  6757. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
  6758. Console.WriteLine(loggingEvent);
  6759. }
  6760. }
  6761. catch(Exception e)
  6762. {
  6763. Console.WriteLine(e.ToString());
  6764. }
  6765. </code>
  6766. <code lang="Visual Basic">
  6767. Dim remoteEndPoint as IPEndPoint
  6768. Dim udpClient as UdpClient
  6769. Dim buffer as Byte()
  6770. Dim loggingEvent as String
  6771. Try
  6772. remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
  6773. udpClient = new UdpClient(8080)
  6774. While True
  6775. buffer = udpClient.Receive(ByRef remoteEndPoint)
  6776. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
  6777. Console.WriteLine(loggingEvent)
  6778. Wend
  6779. Catch e As Exception
  6780. Console.WriteLine(e.ToString())
  6781. End Try
  6782. </code>
  6783. <para>
  6784. An example configuration section to log information using this appender to the
  6785. IP 224.0.0.1 on port 8080:
  6786. </para>
  6787. <code lang="XML" escaped="true">
  6788. <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
  6789. <remoteAddress value="224.0.0.1" />
  6790. <remotePort value="8080" />
  6791. <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline" />
  6792. </appender>
  6793. </code>
  6794. </example>
  6795. <author>Gert Driesen</author>
  6796. <author>Nicko Cadell</author>
  6797. </member>
  6798. <member name="M:log4net.Appender.UdpAppender.#ctor">
  6799. <summary>
  6800. Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender" /> class.
  6801. </summary>
  6802. <remarks>
  6803. The default constructor initializes all fields to their default values.
  6804. </remarks>
  6805. </member>
  6806. <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
  6807. <summary>
  6808. Gets or sets the IP address of the remote host or multicast group to which
  6809. the underlying <see cref="T:System.Net.Sockets.UdpClient" /> should sent the logging event.
  6810. </summary>
  6811. <value>
  6812. The IP address of the remote host or multicast group to which the logging event
  6813. will be sent.
  6814. </value>
  6815. <remarks>
  6816. <para>
  6817. Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
  6818. 239.255.255.255). Multicast packets can pass across different networks through routers, so
  6819. it is possible to use multicasts in an Internet scenario as long as your network provider
  6820. supports multicasting.
  6821. </para>
  6822. <para>
  6823. Hosts that want to receive particular multicast messages must register their interest by joining
  6824. the multicast group. Multicast messages are not sent to networks where no host has joined
  6825. the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
  6826. them from normal host addresses, allowing nodes to easily detect if a message is of interest.
  6827. </para>
  6828. <para>
  6829. Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
  6830. </para>
  6831. <para>
  6832. <list type="table">
  6833. <listheader>
  6834. <term>IP Address</term>
  6835. <description>Description</description>
  6836. </listheader>
  6837. <item>
  6838. <term>224.0.0.1</term>
  6839. <description>
  6840. <para>
  6841. Sends a message to all system on the subnet.
  6842. </para>
  6843. </description>
  6844. </item>
  6845. <item>
  6846. <term>224.0.0.2</term>
  6847. <description>
  6848. <para>
  6849. Sends a message to all routers on the subnet.
  6850. </para>
  6851. </description>
  6852. </item>
  6853. <item>
  6854. <term>224.0.0.12</term>
  6855. <description>
  6856. <para>
  6857. The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
  6858. </para>
  6859. </description>
  6860. </item>
  6861. </list>
  6862. </para>
  6863. <para>
  6864. A complete list of actually reserved multicast addresses and their owners in the ranges
  6865. defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
  6866. </para>
  6867. <para>
  6868. The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
  6869. addresses. These addresses can be reused with other local groups. Routers are typically
  6870. configured with filters to prevent multicast traffic in this range from flowing outside
  6871. of the local network.
  6872. </para>
  6873. </remarks>
  6874. </member>
  6875. <member name="P:log4net.Appender.UdpAppender.RemotePort">
  6876. <summary>
  6877. Gets or sets the TCP port number of the remote host or multicast group to which
  6878. the underlying <see cref="T:System.Net.Sockets.UdpClient" /> should sent the logging event.
  6879. </summary>
  6880. <value>
  6881. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  6882. indicating the TCP port number of the remote host or multicast group to which the logging event
  6883. will be sent.
  6884. </value>
  6885. <remarks>
  6886. The underlying <see cref="T:System.Net.Sockets.UdpClient" /> will send messages to this TCP port number
  6887. on the remote host or multicast group.
  6888. </remarks>
  6889. <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>
  6890. </member>
  6891. <member name="P:log4net.Appender.UdpAppender.LocalPort">
  6892. <summary>
  6893. Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  6894. </summary>
  6895. <value>
  6896. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  6897. indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  6898. </value>
  6899. <remarks>
  6900. <para>
  6901. The underlying <see cref="T:System.Net.Sockets.UdpClient" /> will bind to this port for sending messages.
  6902. </para>
  6903. <para>
  6904. Setting the value to 0 (the default) will cause the udp client not to bind to
  6905. a local port.
  6906. </para>
  6907. </remarks>
  6908. <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>
  6909. </member>
  6910. <member name="P:log4net.Appender.UdpAppender.Encoding">
  6911. <summary>
  6912. Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6913. </summary>
  6914. <value>
  6915. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6916. </value>
  6917. <remarks>
  6918. <para>
  6919. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6920. </para>
  6921. </remarks>
  6922. </member>
  6923. <member name="P:log4net.Appender.UdpAppender.Client">
  6924. <summary>
  6925. Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient" />.
  6926. </summary>
  6927. <value>
  6928. The underlying <see cref="T:System.Net.Sockets.UdpClient" />.
  6929. </value>
  6930. <remarks>
  6931. <see cref="T:log4net.Appender.UdpAppender" /> creates a <see cref="T:System.Net.Sockets.UdpClient" /> to send logging events
  6932. over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender" /> can use this
  6933. property to get or set this <see cref="T:System.Net.Sockets.UdpClient" />. Use the underlying <see cref="T:System.Net.Sockets.UdpClient" />
  6934. returned from <see cref="P:log4net.Appender.UdpAppender.Client" /> if you require access beyond that which
  6935. <see cref="T:log4net.Appender.UdpAppender" /> provides.
  6936. </remarks>
  6937. </member>
  6938. <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
  6939. <summary>
  6940. Gets or sets the cached remote endpoint to which the logging events should be sent.
  6941. </summary>
  6942. <value>
  6943. The cached remote endpoint to which the logging events will be sent.
  6944. </value>
  6945. <remarks>
  6946. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions" /> method will initialize the remote endpoint
  6947. with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
  6948. properties.
  6949. </remarks>
  6950. </member>
  6951. <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
  6952. <summary>
  6953. Initialize the appender based on the options set.
  6954. </summary>
  6955. <remarks>
  6956. <para>
  6957. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6958. activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
  6959. be called on this object after the configuration properties have
  6960. been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
  6961. object is in an undefined state and must not be used.
  6962. </para>
  6963. <para>
  6964. If any of the configuration properties are modified then
  6965. <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
  6966. </para>
  6967. <para>
  6968. The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> was specified or
  6969. an invalid remote or local TCP port number was specified.
  6970. </para>
  6971. </remarks>
  6972. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> was not specified.</exception>
  6973. <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>
  6974. </member>
  6975. <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
  6976. <summary>
  6977. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  6978. </summary>
  6979. <param name="loggingEvent">The event to log.</param>
  6980. <remarks>
  6981. <para>
  6982. Sends the event using an UDP datagram.
  6983. </para>
  6984. <para>
  6985. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  6986. </para>
  6987. </remarks>
  6988. </member>
  6989. <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
  6990. <summary>
  6991. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6992. </summary>
  6993. <value><c>true</c></value>
  6994. <remarks>
  6995. <para>
  6996. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6997. </para>
  6998. </remarks>
  6999. </member>
  7000. <member name="M:log4net.Appender.UdpAppender.OnClose">
  7001. <summary>
  7002. Closes the UDP connection and releases all resources associated with
  7003. this <see cref="T:log4net.Appender.UdpAppender" /> instance.
  7004. </summary>
  7005. <remarks>
  7006. <para>
  7007. Disables the underlying <see cref="T:System.Net.Sockets.UdpClient" /> and releases all managed
  7008. and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender" />.
  7009. </para>
  7010. </remarks>
  7011. </member>
  7012. <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
  7013. <summary>
  7014. Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient" /> connection.
  7015. </summary>
  7016. <remarks>
  7017. <para>
  7018. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
  7019. port number from which you intend to communicate.
  7020. </para>
  7021. <para>
  7022. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  7023. </para>
  7024. </remarks>
  7025. </member>
  7026. <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
  7027. <summary>
  7028. The IP address of the remote host or multicast group to which
  7029. the logging event will be sent.
  7030. </summary>
  7031. </member>
  7032. <member name="F:log4net.Appender.UdpAppender.m_remotePort">
  7033. <summary>
  7034. The TCP port number of the remote host or multicast group to
  7035. which the logging event will be sent.
  7036. </summary>
  7037. </member>
  7038. <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
  7039. <summary>
  7040. The cached remote endpoint to which the logging events will be sent.
  7041. </summary>
  7042. </member>
  7043. <member name="F:log4net.Appender.UdpAppender.m_localPort">
  7044. <summary>
  7045. The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  7046. </summary>
  7047. </member>
  7048. <member name="F:log4net.Appender.UdpAppender.m_client">
  7049. <summary>
  7050. The <see cref="T:System.Net.Sockets.UdpClient" /> instance that will be used for sending the
  7051. logging events.
  7052. </summary>
  7053. </member>
  7054. <member name="F:log4net.Appender.UdpAppender.m_encoding">
  7055. <summary>
  7056. The encoding to use for the packet.
  7057. </summary>
  7058. </member>
  7059. <member name="T:log4net.Config.AliasDomainAttribute">
  7060. <summary>
  7061. Assembly level attribute that specifies a domain to alias to this assembly's repository.
  7062. </summary>
  7063. <remarks>
  7064. <para>
  7065. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  7066. </para>
  7067. <para>
  7068. An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
  7069. however this can be overridden by an assembly loaded before the target assembly.
  7070. </para>
  7071. <para>
  7072. An assembly can alias another assembly's domain to its repository by
  7073. specifying this attribute with the name of the target domain.
  7074. </para>
  7075. <para>
  7076. This attribute can only be specified on the assembly and may be used
  7077. as many times as necessary to alias all the required domains.
  7078. </para>
  7079. </remarks>
  7080. <author>Nicko Cadell</author>
  7081. <author>Gert Driesen</author>
  7082. </member>
  7083. <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
  7084. <summary>
  7085. Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute" /> class with
  7086. the specified domain to alias to this assembly's repository.
  7087. </summary>
  7088. <param name="name">The domain to alias to this assemby's repository.</param>
  7089. <remarks>
  7090. <para>
  7091. Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
  7092. </para>
  7093. </remarks>
  7094. </member>
  7095. <member name="T:log4net.Config.AliasRepositoryAttribute">
  7096. <summary>
  7097. Assembly level attribute that specifies a repository to alias to this assembly's repository.
  7098. </summary>
  7099. <remarks>
  7100. <para>
  7101. An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
  7102. however this can be overridden by an assembly loaded before the target assembly.
  7103. </para>
  7104. <para>
  7105. An assembly can alias another assembly's repository to its repository by
  7106. specifying this attribute with the name of the target repository.
  7107. </para>
  7108. <para>
  7109. This attribute can only be specified on the assembly and may be used
  7110. as many times as necessary to alias all the required repositories.
  7111. </para>
  7112. </remarks>
  7113. <author>Nicko Cadell</author>
  7114. <author>Gert Driesen</author>
  7115. </member>
  7116. <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
  7117. <summary>
  7118. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute" /> class with
  7119. the specified repository to alias to this assembly's repository.
  7120. </summary>
  7121. <param name="name">The repository to alias to this assemby's repository.</param>
  7122. <remarks>
  7123. <para>
  7124. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute" /> class with
  7125. the specified repository to alias to this assembly's repository.
  7126. </para>
  7127. </remarks>
  7128. </member>
  7129. <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
  7130. <summary>
  7131. Gets or sets the repository to alias to this assemby's repository.
  7132. </summary>
  7133. <value>
  7134. The repository to alias to this assemby's repository.
  7135. </value>
  7136. <remarks>
  7137. <para>
  7138. The name of the repository to alias to this assemby's repository.
  7139. </para>
  7140. </remarks>
  7141. </member>
  7142. <member name="T:log4net.Config.BasicConfigurator">
  7143. <summary>
  7144. Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  7145. </summary>
  7146. <remarks>
  7147. <para>
  7148. Allows very simple programmatic configuration of log4net.
  7149. </para>
  7150. <para>
  7151. Only one appender can be configured using this configurator.
  7152. The appender is set at the root of the hierarchy and all logging
  7153. events will be delivered to that appender.
  7154. </para>
  7155. <para>
  7156. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  7157. they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
  7158. be called after the appenders properties have been configured.
  7159. </para>
  7160. </remarks>
  7161. <author>Nicko Cadell</author>
  7162. <author>Gert Driesen</author>
  7163. </member>
  7164. <member name="F:log4net.Config.BasicConfigurator.declaringType">
  7165. <summary>
  7166. The fully qualified type of the BasicConfigurator class.
  7167. </summary>
  7168. <remarks>
  7169. Used by the internal logger to record the Type of the
  7170. log message.
  7171. </remarks>
  7172. </member>
  7173. <member name="M:log4net.Config.BasicConfigurator.#ctor">
  7174. <summary>
  7175. Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator" /> class.
  7176. </summary>
  7177. <remarks>
  7178. <para>
  7179. Uses a private access modifier to prevent instantiation of this class.
  7180. </para>
  7181. </remarks>
  7182. </member>
  7183. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  7184. <summary>
  7185. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
  7186. </summary>
  7187. <param name="repository">The repository to configure.</param>
  7188. <remarks>
  7189. <para>
  7190. Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  7191. that will write to <c>Console.Out</c>. The log messages are
  7192. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  7193. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  7194. layout style.
  7195. </para>
  7196. </remarks>
  7197. </member>
  7198. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
  7199. <summary>
  7200. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  7201. </summary>
  7202. <param name="repository">The repository to configure.</param>
  7203. <param name="appender">The appender to use to log all logging events.</param>
  7204. <remarks>
  7205. <para>
  7206. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  7207. </para>
  7208. </remarks>
  7209. </member>
  7210. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
  7211. <summary>
  7212. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
  7213. </summary>
  7214. <param name="repository">The repository to configure.</param>
  7215. <param name="appenders">The appenders to use to log all logging events.</param>
  7216. <remarks>
  7217. <para>
  7218. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  7219. </para>
  7220. </remarks>
  7221. </member>
  7222. <member name="T:log4net.Config.ConfiguratorAttribute">
  7223. <summary>
  7224. Base class for all log4net configuration attributes.
  7225. </summary>
  7226. <remarks>
  7227. This is an abstract class that must be extended by
  7228. specific configurators. This attribute allows the
  7229. configurator to be parameterized by an assembly level
  7230. attribute.
  7231. </remarks>
  7232. <author>Nicko Cadell</author>
  7233. <author>Gert Driesen</author>
  7234. </member>
  7235. <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
  7236. <summary>
  7237. Constructor used by subclasses.
  7238. </summary>
  7239. <param name="priority">the ordering priority for this configurator</param>
  7240. <remarks>
  7241. <para>
  7242. The <paramref name="priority"/> is used to order the configurator
  7243. attributes before they are invoked. Higher priority configurators are executed
  7244. before lower priority ones.
  7245. </para>
  7246. </remarks>
  7247. </member>
  7248. <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  7249. <summary>
  7250. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  7251. </summary>
  7252. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  7253. <param name="targetRepository">The repository to configure.</param>
  7254. <remarks>
  7255. <para>
  7256. Abstract method implemented by a subclass. When this method is called
  7257. the subclass should configure the <paramref name="targetRepository"/>.
  7258. </para>
  7259. </remarks>
  7260. </member>
  7261. <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
  7262. <summary>
  7263. Compare this instance to another ConfiguratorAttribute
  7264. </summary>
  7265. <param name="obj">the object to compare to</param>
  7266. <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
  7267. <remarks>
  7268. <para>
  7269. Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
  7270. Sorts by priority in descending order. Objects with the same priority are
  7271. randomly ordered.
  7272. </para>
  7273. </remarks>
  7274. </member>
  7275. <member name="T:log4net.Config.DomainAttribute">
  7276. <summary>
  7277. Assembly level attribute that specifies the logging domain for the assembly.
  7278. </summary>
  7279. <remarks>
  7280. <para>
  7281. <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
  7282. </para>
  7283. <para>
  7284. Assemblies are mapped to logging domains. Each domain has its own
  7285. logging repository. This attribute specified on the assembly controls
  7286. the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  7287. of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  7288. specifies the type of the repository objects to create for the domain. If
  7289. this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
  7290. then the assembly will be part of the default shared logging domain.
  7291. </para>
  7292. <para>
  7293. This attribute can only be specified on the assembly and may only be used
  7294. once per assembly.
  7295. </para>
  7296. </remarks>
  7297. <author>Nicko Cadell</author>
  7298. <author>Gert Driesen</author>
  7299. </member>
  7300. <member name="M:log4net.Config.DomainAttribute.#ctor">
  7301. <summary>
  7302. Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute" /> class.
  7303. </summary>
  7304. <remarks>
  7305. <para>
  7306. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  7307. </para>
  7308. </remarks>
  7309. </member>
  7310. <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
  7311. <summary>
  7312. Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute" /> class
  7313. with the name of the domain.
  7314. </summary>
  7315. <param name="name">The name of the domain.</param>
  7316. <remarks>
  7317. <para>
  7318. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  7319. </para>
  7320. </remarks>
  7321. </member>
  7322. <member name="T:log4net.Config.DOMConfiguratorAttribute">
  7323. <summary>
  7324. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  7325. </summary>
  7326. <remarks>
  7327. <para>
  7328. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  7329. </para>
  7330. <para>
  7331. This attribute may only be used at the assembly scope and can only
  7332. be used once per assembly.
  7333. </para>
  7334. <para>
  7335. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  7336. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  7337. methods.
  7338. </para>
  7339. </remarks>
  7340. <author>Nicko Cadell</author>
  7341. <author>Gert Driesen</author>
  7342. </member>
  7343. <member name="T:log4net.Config.PluginAttribute">
  7344. <summary>
  7345. Assembly level attribute that specifies a plugin to attach to
  7346. the repository.
  7347. </summary>
  7348. <remarks>
  7349. <para>
  7350. Specifies the type of a plugin to create and attach to the
  7351. assembly's repository. The plugin type must implement the
  7352. <see cref="T:log4net.Plugin.IPlugin"/> interface.
  7353. </para>
  7354. </remarks>
  7355. <author>Nicko Cadell</author>
  7356. <author>Gert Driesen</author>
  7357. </member>
  7358. <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
  7359. <summary>
  7360. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute" /> class
  7361. with the specified type.
  7362. </summary>
  7363. <param name="type">The type of plugin to create.</param>
  7364. <remarks>
  7365. <para>
  7366. Create the attribute with the plugin type specified.
  7367. </para>
  7368. </remarks>
  7369. </member>
  7370. <member name="P:log4net.Config.PluginAttribute.Type">
  7371. <summary>
  7372. Gets or sets the type for the plugin.
  7373. </summary>
  7374. <value>
  7375. The type for the plugin.
  7376. </value>
  7377. <remarks>
  7378. <para>
  7379. The type for the plugin.
  7380. </para>
  7381. </remarks>
  7382. </member>
  7383. <member name="P:log4net.Config.PluginAttribute.TypeName">
  7384. <summary>
  7385. Gets or sets the type name for the plugin.
  7386. </summary>
  7387. <value>
  7388. The type name for the plugin.
  7389. </value>
  7390. <remarks>
  7391. <para>
  7392. The type name for the plugin.
  7393. </para>
  7394. <para>
  7395. Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
  7396. </para>
  7397. </remarks>
  7398. </member>
  7399. <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
  7400. <summary>
  7401. Creates the plugin object defined by this attribute.
  7402. </summary>
  7403. <remarks>
  7404. <para>
  7405. Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
  7406. specified by this attribute.
  7407. </para>
  7408. </remarks>
  7409. <returns>The plugin object.</returns>
  7410. </member>
  7411. <member name="M:log4net.Config.PluginAttribute.ToString">
  7412. <summary>
  7413. Returns a representation of the properties of this object.
  7414. </summary>
  7415. <remarks>
  7416. <para>
  7417. Overrides base class <see cref="M:Object.ToString()" /> method to
  7418. return a representation of the properties of this object.
  7419. </para>
  7420. </remarks>
  7421. <returns>A representation of the properties of this object</returns>
  7422. </member>
  7423. <member name="T:log4net.Config.RepositoryAttribute">
  7424. <summary>
  7425. Assembly level attribute that specifies the logging repository for the assembly.
  7426. </summary>
  7427. <remarks>
  7428. <para>
  7429. Assemblies are mapped to logging repository. This attribute specified
  7430. on the assembly controls
  7431. the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  7432. of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  7433. specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
  7434. to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
  7435. is not specified then the assembly will be part of the default shared logging repository.
  7436. </para>
  7437. <para>
  7438. This attribute can only be specified on the assembly and may only be used
  7439. once per assembly.
  7440. </para>
  7441. </remarks>
  7442. <author>Nicko Cadell</author>
  7443. <author>Gert Driesen</author>
  7444. </member>
  7445. <member name="M:log4net.Config.RepositoryAttribute.#ctor">
  7446. <summary>
  7447. Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute" /> class.
  7448. </summary>
  7449. <remarks>
  7450. <para>
  7451. Default constructor.
  7452. </para>
  7453. </remarks>
  7454. </member>
  7455. <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
  7456. <summary>
  7457. Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute" /> class
  7458. with the name of the repository.
  7459. </summary>
  7460. <param name="name">The name of the repository.</param>
  7461. <remarks>
  7462. <para>
  7463. Initialize the attribute with the name for the assembly's repository.
  7464. </para>
  7465. </remarks>
  7466. </member>
  7467. <member name="P:log4net.Config.RepositoryAttribute.Name">
  7468. <summary>
  7469. Gets or sets the name of the logging repository.
  7470. </summary>
  7471. <value>
  7472. The string name to use as the name of the repository associated with this
  7473. assembly.
  7474. </value>
  7475. <remarks>
  7476. <para>
  7477. This value does not have to be unique. Several assemblies can share the
  7478. same repository. They will share the logging configuration of the repository.
  7479. </para>
  7480. </remarks>
  7481. </member>
  7482. <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
  7483. <summary>
  7484. Gets or sets the type of repository to create for this assembly.
  7485. </summary>
  7486. <value>
  7487. The type of repository to create for this assembly.
  7488. </value>
  7489. <remarks>
  7490. <para>
  7491. The type of the repository to create for the assembly.
  7492. The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
  7493. interface.
  7494. </para>
  7495. <para>
  7496. This will be the type of repository created when
  7497. the repository is created. If multiple assemblies reference the
  7498. same repository then the repository is only created once using the
  7499. <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType" /> of the first assembly to call into the
  7500. repository.
  7501. </para>
  7502. </remarks>
  7503. </member>
  7504. <member name="T:log4net.Config.SecurityContextProviderAttribute">
  7505. <summary>
  7506. Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
  7507. </summary>
  7508. <remarks>
  7509. <para>
  7510. This attribute may only be used at the assembly scope and can only
  7511. be used once per assembly.
  7512. </para>
  7513. <para>
  7514. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  7515. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  7516. methods.
  7517. </para>
  7518. </remarks>
  7519. <author>Nicko Cadell</author>
  7520. </member>
  7521. <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
  7522. <summary>
  7523. Construct provider attribute with type specified
  7524. </summary>
  7525. <param name="providerType">the type of the provider to use</param>
  7526. <remarks>
  7527. <para>
  7528. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  7529. class.
  7530. </para>
  7531. </remarks>
  7532. </member>
  7533. <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
  7534. <summary>
  7535. Gets or sets the type of the provider to use.
  7536. </summary>
  7537. <value>
  7538. the type of the provider to use.
  7539. </value>
  7540. <remarks>
  7541. <para>
  7542. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  7543. class.
  7544. </para>
  7545. </remarks>
  7546. </member>
  7547. <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  7548. <summary>
  7549. Configures the SecurityContextProvider
  7550. </summary>
  7551. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  7552. <param name="targetRepository">The repository to configure.</param>
  7553. <remarks>
  7554. <para>
  7555. Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
  7556. Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
  7557. </para>
  7558. </remarks>
  7559. </member>
  7560. <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
  7561. <summary>
  7562. The fully qualified type of the SecurityContextProviderAttribute class.
  7563. </summary>
  7564. <remarks>
  7565. Used by the internal logger to record the Type of the
  7566. log message.
  7567. </remarks>
  7568. </member>
  7569. <member name="T:log4net.Config.XmlConfigurator">
  7570. <summary>
  7571. Use this class to initialize the log4net environment using an Xml tree.
  7572. </summary>
  7573. <remarks>
  7574. <para>
  7575. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  7576. </para>
  7577. </remarks>
  7578. <author>Nicko Cadell</author>
  7579. <author>Gert Driesen</author>
  7580. </member>
  7581. <member name="M:log4net.Config.XmlConfigurator.#ctor">
  7582. <summary>
  7583. Private constructor
  7584. </summary>
  7585. </member>
  7586. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  7587. <summary>
  7588. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  7589. stored in the application's configuration file.
  7590. </summary>
  7591. <remarks>
  7592. <para>
  7593. Each application has a configuration file. This has the
  7594. same name as the application with '.config' appended.
  7595. This file is XML and calling this function prompts the
  7596. configurator to look in that file for a section called
  7597. <c>log4net</c> that contains the configuration data.
  7598. </para>
  7599. <para>
  7600. To use this method to configure log4net you must specify
  7601. the <see cref="!:Log4NetConfigurationSectionHandler"/> section
  7602. handler for the <c>log4net</c> configuration section. See the
  7603. <see cref="!:Log4NetConfigurationSectionHandler"/> for an example.
  7604. </para>
  7605. </remarks>
  7606. <param name="repository">The repository to configure.</param>
  7607. </member>
  7608. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  7609. <summary>
  7610. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  7611. element.
  7612. </summary>
  7613. <remarks>
  7614. Loads the log4net configuration from the XML element
  7615. supplied as <paramref name="element"/>.
  7616. </remarks>
  7617. <param name="repository">The repository to configure.</param>
  7618. <param name="element">The element to parse.</param>
  7619. </member>
  7620. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  7621. <summary>
  7622. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  7623. file.
  7624. </summary>
  7625. <param name="repository">The repository to configure.</param>
  7626. <param name="configFile">The XML file to load the configuration from.</param>
  7627. <remarks>
  7628. <para>
  7629. The configuration file must be valid XML. It must contain
  7630. at least one element called <c>log4net</c> that holds
  7631. the configuration data.
  7632. </para>
  7633. <para>
  7634. The log4net configuration file can possible be specified in the application's
  7635. configuration file (either <c>MyAppName.exe.config</c> for a
  7636. normal application on <c>Web.config</c> for an ASP.NET application).
  7637. </para>
  7638. <para>
  7639. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  7640. configuration. If this file is also a .NET .config file then you must specify
  7641. a configuration section for the <c>log4net</c> element otherwise .NET will
  7642. complain. Set the type for the section handler to <see cref="!:System.Configuration.IgnoreSectionHandler"/>, for example:
  7643. <code lang="XML" escaped="true">
  7644. <configSections>
  7645. <section name="log4net" type="System.Configuration.IgnoreSectionHandler" />
  7646. </configSections>
  7647. </code>
  7648. </para>
  7649. <example>
  7650. The following example configures log4net using a configuration file, of which the
  7651. location is stored in the application's configuration file :
  7652. </example>
  7653. <code lang="C#">
  7654. using log4net.Config;
  7655. using System.IO;
  7656. using System.Configuration;
  7657. ...
  7658. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  7659. </code>
  7660. <para>
  7661. In the <c>.config</c> file, the path to the log4net can be specified like this :
  7662. </para>
  7663. <code lang="XML" escaped="true">
  7664. <configuration>
  7665. <appSettings>
  7666. <add key="log4net-config-file" value="log.config"/>
  7667. </appSettings>
  7668. </configuration>
  7669. </code>
  7670. </remarks>
  7671. </member>
  7672. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
  7673. <summary>
  7674. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  7675. URI.
  7676. </summary>
  7677. <param name="repository">The repository to configure.</param>
  7678. <param name="configUri">A URI to load the XML configuration from.</param>
  7679. <remarks>
  7680. <para>
  7681. The configuration data must be valid XML. It must contain
  7682. at least one element called <c>log4net</c> that holds
  7683. the configuration data.
  7684. </para>
  7685. <para>
  7686. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  7687. </para>
  7688. </remarks>
  7689. </member>
  7690. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  7691. <summary>
  7692. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  7693. file.
  7694. </summary>
  7695. <param name="repository">The repository to configure.</param>
  7696. <param name="configStream">The stream to load the XML configuration from.</param>
  7697. <remarks>
  7698. <para>
  7699. The configuration data must be valid XML. It must contain
  7700. at least one element called <c>log4net</c> that holds
  7701. the configuration data.
  7702. </para>
  7703. <para>
  7704. Note that this method will NOT close the stream parameter.
  7705. </para>
  7706. </remarks>
  7707. </member>
  7708. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  7709. <summary>
  7710. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  7711. monitors the file for changes and reloads the configuration if a change
  7712. is detected.
  7713. </summary>
  7714. <param name="repository">The repository to configure.</param>
  7715. <param name="configFile">The XML file to load the configuration from.</param>
  7716. <remarks>
  7717. <para>
  7718. The configuration file must be valid XML. It must contain
  7719. at least one element called <c>log4net</c> that holds
  7720. the configuration data.
  7721. </para>
  7722. <para>
  7723. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  7724. and depends on the behavior of that class.
  7725. </para>
  7726. <para>
  7727. For more information on how to configure log4net using
  7728. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  7729. </para>
  7730. </remarks>
  7731. <seealso cref="M:Configure(FileInfo)"/>
  7732. </member>
  7733. <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
  7734. <summary>
  7735. Class used to watch config files.
  7736. </summary>
  7737. <remarks>
  7738. <para>
  7739. Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
  7740. changes to a specified file. Because multiple change notifications
  7741. may be raised when the file is modified, a timer is used to
  7742. compress the notifications into a single event. The timer
  7743. waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
  7744. the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
  7745. change notifications arrive while the timer is waiting it
  7746. is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
  7747. elapse.
  7748. </para>
  7749. </remarks>
  7750. </member>
  7751. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
  7752. <summary>
  7753. Holds the FileInfo used to configure the XmlConfigurator
  7754. </summary>
  7755. </member>
  7756. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
  7757. <summary>
  7758. Holds the repository being configured.
  7759. </summary>
  7760. </member>
  7761. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
  7762. <summary>
  7763. The timer used to compress the notification events.
  7764. </summary>
  7765. </member>
  7766. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
  7767. <summary>
  7768. The default amount of time to wait after receiving notification
  7769. before reloading the config file.
  7770. </summary>
  7771. </member>
  7772. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
  7773. <summary>
  7774. Watches file for changes. This object should be disposed when no longer
  7775. needed to free system handles on the watched resources.
  7776. </summary>
  7777. </member>
  7778. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  7779. <summary>
  7780. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler" /> class to
  7781. watch a specified config file used to configure a repository.
  7782. </summary>
  7783. <param name="repository">The repository to configure.</param>
  7784. <param name="configFile">The configuration file to watch.</param>
  7785. <remarks>
  7786. <para>
  7787. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler" /> class.
  7788. </para>
  7789. </remarks>
  7790. </member>
  7791. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
  7792. <summary>
  7793. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  7794. </summary>
  7795. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  7796. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  7797. <remarks>
  7798. <para>
  7799. This handler reloads the configuration from the file when the event is fired.
  7800. </para>
  7801. </remarks>
  7802. </member>
  7803. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
  7804. <summary>
  7805. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  7806. </summary>
  7807. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  7808. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  7809. <remarks>
  7810. <para>
  7811. This handler reloads the configuration from the file when the event is fired.
  7812. </para>
  7813. </remarks>
  7814. </member>
  7815. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
  7816. <summary>
  7817. Called by the timer when the configuration has been updated.
  7818. </summary>
  7819. <param name="state">null</param>
  7820. </member>
  7821. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
  7822. <summary>
  7823. Release the handles held by the watcher and timer.
  7824. </summary>
  7825. </member>
  7826. <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  7827. <summary>
  7828. Configures the specified repository using a <c>log4net</c> element.
  7829. </summary>
  7830. <param name="repository">The hierarchy to configure.</param>
  7831. <param name="element">The element to parse.</param>
  7832. <remarks>
  7833. <para>
  7834. Loads the log4net configuration from the XML element
  7835. supplied as <paramref name="element"/>.
  7836. </para>
  7837. <para>
  7838. This method is ultimately called by one of the Configure methods
  7839. to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
  7840. </para>
  7841. </remarks>
  7842. </member>
  7843. <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
  7844. <summary>
  7845. Maps repository names to ConfigAndWatchHandler instances to allow a particular
  7846. ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
  7847. reconfigured.
  7848. </summary>
  7849. </member>
  7850. <member name="F:log4net.Config.XmlConfigurator.declaringType">
  7851. <summary>
  7852. The fully qualified type of the XmlConfigurator class.
  7853. </summary>
  7854. <remarks>
  7855. Used by the internal logger to record the Type of the
  7856. log message.
  7857. </remarks>
  7858. </member>
  7859. <member name="T:log4net.Config.XmlConfiguratorAttribute">
  7860. <summary>
  7861. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  7862. </summary>
  7863. <remarks>
  7864. <para>
  7865. This attribute may only be used at the assembly scope and can only
  7866. be used once per assembly.
  7867. </para>
  7868. <para>
  7869. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  7870. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  7871. methods.
  7872. </para>
  7873. <para>
  7874. If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
  7875. properties are set the configuration is loaded from the application's .config file.
  7876. If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
  7877. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
  7878. specifies a path to a file to load the config from. The path is relative to the
  7879. application's base directory; <see cref="!:AppDomain.BaseDirectory"/>.
  7880. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
  7881. The config file must be located in the application's base directory; <see cref="!:AppDomain.BaseDirectory"/>.
  7882. For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
  7883. <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
  7884. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
  7885. </para>
  7886. <para>
  7887. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
  7888. to watch the configuration file for changes.
  7889. </para>
  7890. <note>
  7891. <para>
  7892. Log4net will only look for assembly level configuration attributes once.
  7893. When using the log4net assembly level attributes to control the configuration
  7894. of log4net you must ensure that the first call to any of the
  7895. <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
  7896. attributes.
  7897. </para>
  7898. <para>
  7899. If you cannot guarantee the order in which log4net calls will be made from
  7900. different assemblies you must use programmatic configuration instead, i.e.
  7901. call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
  7902. </para>
  7903. </note>
  7904. </remarks>
  7905. <author>Nicko Cadell</author>
  7906. <author>Gert Driesen</author>
  7907. </member>
  7908. <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
  7909. <summary>
  7910. Default constructor
  7911. </summary>
  7912. <remarks>
  7913. <para>
  7914. Default constructor
  7915. </para>
  7916. </remarks>
  7917. </member>
  7918. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
  7919. <summary>
  7920. Gets or sets the filename of the configuration file.
  7921. </summary>
  7922. <value>
  7923. The filename of the configuration file.
  7924. </value>
  7925. <remarks>
  7926. <para>
  7927. If specified, this is the name of the configuration file to use with
  7928. the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
  7929. <b>application base</b> directory (<see cref="!:AppDomain.BaseDirectory"/>).
  7930. </para>
  7931. <para>
  7932. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  7933. </para>
  7934. </remarks>
  7935. </member>
  7936. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
  7937. <summary>
  7938. Gets or sets the extension of the configuration file.
  7939. </summary>
  7940. <value>
  7941. The extension of the configuration file.
  7942. </value>
  7943. <remarks>
  7944. <para>
  7945. If specified this is the extension for the configuration file.
  7946. The path to the config file is built by using the <b>application
  7947. base</b> directory (<see cref="!:AppDomain.BaseDirectory"/>),
  7948. the <b>assembly file name</b> and the config file extension.
  7949. </para>
  7950. <para>
  7951. If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
  7952. possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
  7953. <c>MyClassLibrary.dll.MyExt</c>.
  7954. </para>
  7955. <para>
  7956. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  7957. </para>
  7958. </remarks>
  7959. </member>
  7960. <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
  7961. <summary>
  7962. Gets or sets a value indicating whether to watch the configuration file.
  7963. </summary>
  7964. <value>
  7965. <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
  7966. </value>
  7967. <remarks>
  7968. <para>
  7969. If this flag is specified and set to <c>true</c> then the framework
  7970. will watch the configuration file and will reload the config each time
  7971. the file is modified.
  7972. </para>
  7973. <para>
  7974. The config file can only be watched if it is loaded from local disk.
  7975. In a No-Touch (Smart Client) deployment where the application is downloaded
  7976. from a web server the config file may not reside on the local disk
  7977. and therefore it may not be able to watch it.
  7978. </para>
  7979. <note>
  7980. Watching configuration is not supported on the SSCLI.
  7981. </note>
  7982. </remarks>
  7983. </member>
  7984. <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  7985. <summary>
  7986. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  7987. </summary>
  7988. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  7989. <param name="targetRepository">The repository to configure.</param>
  7990. <remarks>
  7991. <para>
  7992. Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
  7993. The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  7994. class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
  7995. configure it.
  7996. </para>
  7997. </remarks>
  7998. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository" /> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
  7999. </member>
  8000. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8001. <summary>
  8002. Attempt to load configuration from the local file system
  8003. </summary>
  8004. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8005. <param name="targetRepository">The repository to configure.</param>
  8006. </member>
  8007. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8008. <summary>
  8009. Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
  8010. </summary>
  8011. <param name="targetRepository">The repository to configure.</param>
  8012. <param name="configFile">the FileInfo pointing to the config file</param>
  8013. </member>
  8014. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8015. <summary>
  8016. Attempt to load configuration from a URI
  8017. </summary>
  8018. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8019. <param name="targetRepository">The repository to configure.</param>
  8020. </member>
  8021. <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
  8022. <summary>
  8023. The fully qualified type of the XmlConfiguratorAttribute class.
  8024. </summary>
  8025. <remarks>
  8026. Used by the internal logger to record the Type of the
  8027. log message.
  8028. </remarks>
  8029. </member>
  8030. <member name="T:log4net.Core.CompactRepositorySelector">
  8031. <summary>
  8032. The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
  8033. for use with the compact framework
  8034. </summary>
  8035. <remarks>
  8036. <para>
  8037. This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
  8038. mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
  8039. object.
  8040. </para>
  8041. <para>
  8042. The .NET Compact Framework 1.0 does not support retrieving assembly
  8043. level attributes therefore unlike the <c>DefaultRepositorySelector</c>
  8044. this selector does not examine the calling assembly for attributes.
  8045. </para>
  8046. </remarks>
  8047. <author>Nicko Cadell</author>
  8048. </member>
  8049. <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
  8050. <summary>
  8051. Create a new repository selector
  8052. </summary>
  8053. <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  8054. <remarks>
  8055. <para>
  8056. Create an new compact repository selector.
  8057. The default type for repositories must be specified,
  8058. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8059. </para>
  8060. </remarks>
  8061. <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
  8062. <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
  8063. </member>
  8064. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
  8065. <summary>
  8066. Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
  8067. </summary>
  8068. <param name="assembly">not used</param>
  8069. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  8070. <remarks>
  8071. <para>
  8072. The <paramref name="assembly"/> argument is not used. This selector does not create a
  8073. separate repository for each assembly.
  8074. </para>
  8075. <para>
  8076. As a named repository is not specified the default repository is
  8077. returned. The default repository is named <c>log4net-default-repository</c>.
  8078. </para>
  8079. </remarks>
  8080. </member>
  8081. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
  8082. <summary>
  8083. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
  8084. </summary>
  8085. <param name="repositoryName">the name of the repository to lookup</param>
  8086. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  8087. <remarks>
  8088. <para>
  8089. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
  8090. repository is <c>log4net-default-repository</c>. Other repositories
  8091. must be created using the <see cref="M:CreateRepository(string, Type)"/>.
  8092. If the named repository does not exist an exception is thrown.
  8093. </para>
  8094. </remarks>
  8095. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  8096. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
  8097. </member>
  8098. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  8099. <summary>
  8100. Create a new repository for the assembly specified
  8101. </summary>
  8102. <param name="assembly">not used</param>
  8103. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  8104. <returns>the repository created</returns>
  8105. <remarks>
  8106. <para>
  8107. The <paramref name="assembly"/> argument is not used. This selector does not create a
  8108. separate repository for each assembly.
  8109. </para>
  8110. <para>
  8111. If the <paramref name="repositoryType"/> is <c>null</c> then the
  8112. default repository type specified to the constructor is used.
  8113. </para>
  8114. <para>
  8115. As a named repository is not specified the default repository is
  8116. returned. The default repository is named <c>log4net-default-repository</c>.
  8117. </para>
  8118. </remarks>
  8119. </member>
  8120. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
  8121. <summary>
  8122. Create a new repository for the repository specified
  8123. </summary>
  8124. <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  8125. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8126. If this param is null then the default repository type is used.</param>
  8127. <returns>the repository created</returns>
  8128. <remarks>
  8129. <para>
  8130. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  8131. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  8132. same repository specified will return the same repository instance.
  8133. </para>
  8134. <para>
  8135. If the named repository already exists an exception will be thrown.
  8136. </para>
  8137. <para>
  8138. If <paramref name="repositoryType"/> is <c>null</c> then the default
  8139. repository type specified to the constructor is used.
  8140. </para>
  8141. </remarks>
  8142. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  8143. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
  8144. </member>
  8145. <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
  8146. <summary>
  8147. Test if a named repository exists
  8148. </summary>
  8149. <param name="repositoryName">the named repository to check</param>
  8150. <returns><c>true</c> if the repository exists</returns>
  8151. <remarks>
  8152. <para>
  8153. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  8154. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  8155. a repository.
  8156. </para>
  8157. </remarks>
  8158. </member>
  8159. <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
  8160. <summary>
  8161. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  8162. </summary>
  8163. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  8164. <remarks>
  8165. <para>
  8166. Gets an array of all of the repositories created by this selector.
  8167. </para>
  8168. </remarks>
  8169. </member>
  8170. <member name="F:log4net.Core.CompactRepositorySelector.declaringType">
  8171. <summary>
  8172. The fully qualified type of the CompactRepositorySelector class.
  8173. </summary>
  8174. <remarks>
  8175. Used by the internal logger to record the Type of the
  8176. log message.
  8177. </remarks>
  8178. </member>
  8179. <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
  8180. <summary>
  8181. Event to notify that a logger repository has been created.
  8182. </summary>
  8183. <value>
  8184. Event to notify that a logger repository has been created.
  8185. </value>
  8186. <remarks>
  8187. <para>
  8188. Event raised when a new repository is created.
  8189. The event source will be this selector. The event args will
  8190. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  8191. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8192. </para>
  8193. </remarks>
  8194. </member>
  8195. <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  8196. <summary>
  8197. Notify the registered listeners that the repository has been created
  8198. </summary>
  8199. <param name="repository">The repository that has been created</param>
  8200. <remarks>
  8201. <para>
  8202. Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
  8203. event.
  8204. </para>
  8205. </remarks>
  8206. </member>
  8207. <member name="T:log4net.Core.DefaultRepositorySelector">
  8208. <summary>
  8209. The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
  8210. </summary>
  8211. <remarks>
  8212. <para>
  8213. Uses attributes defined on the calling assembly to determine how to
  8214. configure the hierarchy for the repository.
  8215. </para>
  8216. </remarks>
  8217. <author>Nicko Cadell</author>
  8218. <author>Gert Driesen</author>
  8219. </member>
  8220. <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
  8221. <summary>
  8222. Event to notify that a logger repository has been created.
  8223. </summary>
  8224. <value>
  8225. Event to notify that a logger repository has been created.
  8226. </value>
  8227. <remarks>
  8228. <para>
  8229. Event raised when a new repository is created.
  8230. The event source will be this selector. The event args will
  8231. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  8232. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8233. </para>
  8234. </remarks>
  8235. </member>
  8236. <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
  8237. <summary>
  8238. Creates a new repository selector.
  8239. </summary>
  8240. <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  8241. <remarks>
  8242. <para>
  8243. Create an new repository selector.
  8244. The default type for repositories must be specified,
  8245. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8246. </para>
  8247. </remarks>
  8248. <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null" />.</exception>
  8249. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
  8250. </member>
  8251. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
  8252. <summary>
  8253. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8254. </summary>
  8255. <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8256. <remarks>
  8257. <para>
  8258. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
  8259. to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
  8260. attribute on the <paramref name="repositoryAssembly"/>.
  8261. </para>
  8262. <para>
  8263. The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  8264. implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  8265. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  8266. </para>
  8267. <para>
  8268. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
  8269. any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
  8270. the <paramref name="repositoryAssembly"/>.
  8271. </para>
  8272. </remarks>
  8273. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
  8274. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  8275. </member>
  8276. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
  8277. <summary>
  8278. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
  8279. </summary>
  8280. <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8281. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
  8282. <remarks>
  8283. <para>
  8284. Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
  8285. a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
  8286. does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
  8287. </para>
  8288. <para>
  8289. Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
  8290. </para>
  8291. </remarks>
  8292. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null" />.</exception>
  8293. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
  8294. </member>
  8295. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  8296. <summary>
  8297. Create a new repository for the assembly specified
  8298. </summary>
  8299. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8300. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8301. <returns>The repository created.</returns>
  8302. <remarks>
  8303. <para>
  8304. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  8305. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  8306. same assembly specified will return the same repository instance.
  8307. </para>
  8308. <para>
  8309. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  8310. the repository to create can be overridden by specifying the
  8311. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  8312. <paramref name="repositoryAssembly"/>. The default values are to use the
  8313. <paramref name="repositoryType"/> implementation of the
  8314. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  8315. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  8316. </para>
  8317. <para>
  8318. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  8319. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  8320. attributes defined on the <paramref name="repositoryAssembly"/>.
  8321. </para>
  8322. <para>
  8323. If a repository for the <paramref name="repositoryAssembly"/> already exists
  8324. that repository will be returned. An error will not be raised and that
  8325. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  8326. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  8327. assembly may be used to override the repository type specified in
  8328. <paramref name="repositoryType"/>.
  8329. </para>
  8330. </remarks>
  8331. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  8332. </member>
  8333. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
  8334. <summary>
  8335. Creates a new repository for the assembly specified.
  8336. </summary>
  8337. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8338. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8339. <param name="repositoryName">The name to assign to the created repository</param>
  8340. <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
  8341. <returns>The repository created.</returns>
  8342. <remarks>
  8343. <para>
  8344. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  8345. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  8346. same assembly specified will return the same repository instance.
  8347. </para>
  8348. <para>
  8349. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  8350. the repository to create can be overridden by specifying the
  8351. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  8352. <paramref name="repositoryAssembly"/>. The default values are to use the
  8353. <paramref name="repositoryType"/> implementation of the
  8354. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  8355. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  8356. </para>
  8357. <para>
  8358. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  8359. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  8360. attributes defined on the <paramref name="repositoryAssembly"/>.
  8361. </para>
  8362. <para>
  8363. If a repository for the <paramref name="repositoryAssembly"/> already exists
  8364. that repository will be returned. An error will not be raised and that
  8365. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  8366. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  8367. assembly may be used to override the repository type specified in
  8368. <paramref name="repositoryType"/>.
  8369. </para>
  8370. </remarks>
  8371. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  8372. </member>
  8373. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
  8374. <summary>
  8375. Creates a new repository for the specified repository.
  8376. </summary>
  8377. <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8378. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8379. If this param is <see langword="null" /> then the default repository type is used.</param>
  8380. <returns>The new repository.</returns>
  8381. <remarks>
  8382. <para>
  8383. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  8384. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  8385. same repository specified will return the same repository instance.
  8386. </para>
  8387. </remarks>
  8388. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null" />.</exception>
  8389. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
  8390. </member>
  8391. <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
  8392. <summary>
  8393. Test if a named repository exists
  8394. </summary>
  8395. <param name="repositoryName">the named repository to check</param>
  8396. <returns><c>true</c> if the repository exists</returns>
  8397. <remarks>
  8398. <para>
  8399. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  8400. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  8401. a repository.
  8402. </para>
  8403. </remarks>
  8404. </member>
  8405. <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
  8406. <summary>
  8407. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  8408. </summary>
  8409. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  8410. <remarks>
  8411. <para>
  8412. Gets an array of all of the repositories created by this selector.
  8413. </para>
  8414. </remarks>
  8415. </member>
  8416. <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
  8417. <summary>
  8418. Aliases a repository to an existing repository.
  8419. </summary>
  8420. <param name="repositoryAlias">The repository to alias.</param>
  8421. <param name="repositoryTarget">The repository that the repository is aliased to.</param>
  8422. <remarks>
  8423. <para>
  8424. The repository specified will be aliased to the repository when created.
  8425. The repository must not already exist.
  8426. </para>
  8427. <para>
  8428. When the repository is created it must utilize the same repository type as
  8429. the repository it is aliased to, otherwise the aliasing will fail.
  8430. </para>
  8431. </remarks>
  8432. <exception cref="T:System.ArgumentNullException">
  8433. <para><paramref name="repositoryAlias" /> is <see langword="null" />.</para>
  8434. <para>-or-</para>
  8435. <para><paramref name="repositoryTarget" /> is <see langword="null" />.</para>
  8436. </exception>
  8437. </member>
  8438. <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  8439. <summary>
  8440. Notifies the registered listeners that the repository has been created.
  8441. </summary>
  8442. <param name="repository">The repository that has been created.</param>
  8443. <remarks>
  8444. <para>
  8445. Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  8446. </para>
  8447. </remarks>
  8448. </member>
  8449. <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
  8450. <summary>
  8451. Gets the repository name and repository type for the specified assembly.
  8452. </summary>
  8453. <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
  8454. <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>
  8455. <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>
  8456. <exception cref="T:System.ArgumentNullException"><paramref name="assembly" /> is <see langword="null" />.</exception>
  8457. </member>
  8458. <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8459. <summary>
  8460. Configures the repository using information from the assembly.
  8461. </summary>
  8462. <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  8463. attributes which define the configuration for the repository.</param>
  8464. <param name="repository">The repository to configure.</param>
  8465. <exception cref="T:System.ArgumentNullException">
  8466. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  8467. <para>-or-</para>
  8468. <para><paramref name="repository" /> is <see langword="null" />.</para>
  8469. </exception>
  8470. </member>
  8471. <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8472. <summary>
  8473. Loads the attribute defined plugins on the assembly.
  8474. </summary>
  8475. <param name="assembly">The assembly that contains the attributes.</param>
  8476. <param name="repository">The repository to add the plugins to.</param>
  8477. <exception cref="T:System.ArgumentNullException">
  8478. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  8479. <para>-or-</para>
  8480. <para><paramref name="repository" /> is <see langword="null" />.</para>
  8481. </exception>
  8482. </member>
  8483. <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8484. <summary>
  8485. Loads the attribute defined aliases on the assembly.
  8486. </summary>
  8487. <param name="assembly">The assembly that contains the attributes.</param>
  8488. <param name="repository">The repository to alias to.</param>
  8489. <exception cref="T:System.ArgumentNullException">
  8490. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  8491. <para>-or-</para>
  8492. <para><paramref name="repository" /> is <see langword="null" />.</para>
  8493. </exception>
  8494. </member>
  8495. <member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
  8496. <summary>
  8497. The fully qualified type of the DefaultRepositorySelector class.
  8498. </summary>
  8499. <remarks>
  8500. Used by the internal logger to record the Type of the
  8501. log message.
  8502. </remarks>
  8503. </member>
  8504. <member name="T:log4net.Core.ErrorCode">
  8505. <summary>
  8506. Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  8507. </summary>
  8508. <remarks>
  8509. <para>
  8510. Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  8511. </para>
  8512. </remarks>
  8513. <author>Nicko Cadell</author>
  8514. </member>
  8515. <member name="F:log4net.Core.ErrorCode.GenericFailure">
  8516. <summary>
  8517. A general error
  8518. </summary>
  8519. </member>
  8520. <member name="F:log4net.Core.ErrorCode.WriteFailure">
  8521. <summary>
  8522. Error while writing output
  8523. </summary>
  8524. </member>
  8525. <member name="F:log4net.Core.ErrorCode.FlushFailure">
  8526. <summary>
  8527. Failed to flush file
  8528. </summary>
  8529. </member>
  8530. <member name="F:log4net.Core.ErrorCode.CloseFailure">
  8531. <summary>
  8532. Failed to close file
  8533. </summary>
  8534. </member>
  8535. <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
  8536. <summary>
  8537. Unable to open output file
  8538. </summary>
  8539. </member>
  8540. <member name="F:log4net.Core.ErrorCode.MissingLayout">
  8541. <summary>
  8542. No layout specified
  8543. </summary>
  8544. </member>
  8545. <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
  8546. <summary>
  8547. Failed to parse address
  8548. </summary>
  8549. </member>
  8550. <member name="T:log4net.Core.ExceptionEvaluator">
  8551. <summary>
  8552. An evaluator that triggers on an Exception type
  8553. </summary>
  8554. <remarks>
  8555. <para>
  8556. This evaluator will trigger if the type of the Exception
  8557. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  8558. is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
  8559. </para>
  8560. </remarks>
  8561. <author>Drew Schaeffer</author>
  8562. </member>
  8563. <member name="F:log4net.Core.ExceptionEvaluator.m_type">
  8564. <summary>
  8565. The type that causes the trigger to fire.
  8566. </summary>
  8567. </member>
  8568. <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
  8569. <summary>
  8570. Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
  8571. </summary>
  8572. </member>
  8573. <member name="M:log4net.Core.ExceptionEvaluator.#ctor">
  8574. <summary>
  8575. Default ctor to allow dynamic creation through a configurator.
  8576. </summary>
  8577. </member>
  8578. <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
  8579. <summary>
  8580. Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
  8581. </summary>
  8582. <param name="exType">the type that triggers this evaluator.</param>
  8583. <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
  8584. </member>
  8585. <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
  8586. <summary>
  8587. The type that triggers this evaluator.
  8588. </summary>
  8589. </member>
  8590. <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
  8591. <summary>
  8592. If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  8593. </summary>
  8594. </member>
  8595. <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  8596. <summary>
  8597. Is this <paramref name="loggingEvent"/> the triggering event?
  8598. </summary>
  8599. <param name="loggingEvent">The event to check</param>
  8600. <returns>This method returns <c>true</c>, if the logging event Exception
  8601. Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  8602. Otherwise it returns <c>false</c></returns>
  8603. <remarks>
  8604. <para>
  8605. This evaluator will trigger if the Exception Type of the event
  8606. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  8607. is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  8608. </para>
  8609. </remarks>
  8610. </member>
  8611. <member name="T:log4net.Core.IAppenderAttachable">
  8612. <summary>
  8613. Interface for attaching appenders to objects.
  8614. </summary>
  8615. <remarks>
  8616. <para>
  8617. Interface for attaching, removing and retrieving appenders.
  8618. </para>
  8619. </remarks>
  8620. <author>Nicko Cadell</author>
  8621. <author>Gert Driesen</author>
  8622. </member>
  8623. <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
  8624. <summary>
  8625. Attaches an appender.
  8626. </summary>
  8627. <param name="appender">The appender to add.</param>
  8628. <remarks>
  8629. <para>
  8630. Add the specified appender. The implementation may
  8631. choose to allow or deny duplicate appenders.
  8632. </para>
  8633. </remarks>
  8634. </member>
  8635. <member name="P:log4net.Core.IAppenderAttachable.Appenders">
  8636. <summary>
  8637. Gets all attached appenders.
  8638. </summary>
  8639. <value>
  8640. A collection of attached appenders.
  8641. </value>
  8642. <remarks>
  8643. <para>
  8644. Gets a collection of attached appenders.
  8645. If there are no attached appenders the
  8646. implementation should return an empty
  8647. collection rather than <c>null</c>.
  8648. </para>
  8649. </remarks>
  8650. </member>
  8651. <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
  8652. <summary>
  8653. Gets an attached appender with the specified name.
  8654. </summary>
  8655. <param name="name">The name of the appender to get.</param>
  8656. <returns>
  8657. The appender with the name specified, or <c>null</c> if no appender with the
  8658. specified name is found.
  8659. </returns>
  8660. <remarks>
  8661. <para>
  8662. Returns an attached appender with the <paramref name="name"/> specified.
  8663. If no appender with the specified name is found <c>null</c> will be
  8664. returned.
  8665. </para>
  8666. </remarks>
  8667. </member>
  8668. <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
  8669. <summary>
  8670. Removes all attached appenders.
  8671. </summary>
  8672. <remarks>
  8673. <para>
  8674. Removes and closes all attached appenders
  8675. </para>
  8676. </remarks>
  8677. </member>
  8678. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
  8679. <summary>
  8680. Removes the specified appender from the list of attached appenders.
  8681. </summary>
  8682. <param name="appender">The appender to remove.</param>
  8683. <returns>The appender removed from the list</returns>
  8684. <remarks>
  8685. <para>
  8686. The appender removed is not closed.
  8687. If you are discarding the appender you must call
  8688. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  8689. </para>
  8690. </remarks>
  8691. </member>
  8692. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
  8693. <summary>
  8694. Removes the appender with the specified name from the list of appenders.
  8695. </summary>
  8696. <param name="name">The name of the appender to remove.</param>
  8697. <returns>The appender removed from the list</returns>
  8698. <remarks>
  8699. <para>
  8700. The appender removed is not closed.
  8701. If you are discarding the appender you must call
  8702. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  8703. </para>
  8704. </remarks>
  8705. </member>
  8706. <member name="T:log4net.Core.IErrorHandler">
  8707. <summary>
  8708. Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler" />.
  8709. </summary>
  8710. <remarks>
  8711. <para>
  8712. Error handling is a particularly tedious to get right because by
  8713. definition errors are hard to predict and to reproduce.
  8714. </para>
  8715. </remarks>
  8716. <author>Nicko Cadell</author>
  8717. <author>Gert Driesen</author>
  8718. </member>
  8719. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  8720. <summary>
  8721. Handles the error and information about the error condition is passed as
  8722. a parameter.
  8723. </summary>
  8724. <param name="message">The message associated with the error.</param>
  8725. <param name="e">The <see cref="T:System.Exception" /> that was thrown when the error occurred.</param>
  8726. <param name="errorCode">The error code associated with the error.</param>
  8727. <remarks>
  8728. <para>
  8729. Handles the error and information about the error condition is passed as
  8730. a parameter.
  8731. </para>
  8732. </remarks>
  8733. </member>
  8734. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
  8735. <summary>
  8736. Prints the error message passed as a parameter.
  8737. </summary>
  8738. <param name="message">The message associated with the error.</param>
  8739. <param name="e">The <see cref="T:System.Exception" /> that was thrown when the error occurred.</param>
  8740. <remarks>
  8741. <para>
  8742. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  8743. </para>
  8744. </remarks>
  8745. </member>
  8746. <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
  8747. <summary>
  8748. Prints the error message passed as a parameter.
  8749. </summary>
  8750. <param name="message">The message associated with the error.</param>
  8751. <remarks>
  8752. <para>
  8753. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  8754. </para>
  8755. </remarks>
  8756. </member>
  8757. <member name="T:log4net.Core.IFixingRequired">
  8758. <summary>
  8759. Interface for objects that require fixing.
  8760. </summary>
  8761. <remarks>
  8762. <para>
  8763. Interface that indicates that the object requires fixing before it
  8764. can be taken outside the context of the appender's
  8765. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  8766. </para>
  8767. <para>
  8768. When objects that implement this interface are stored
  8769. in the context properties maps <see cref="T:log4net.GlobalContext"/>
  8770. <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
  8771. <see cref="P:log4net.ThreadContext.Properties"/> are fixed
  8772. (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
  8773. method will be called.
  8774. </para>
  8775. </remarks>
  8776. <author>Nicko Cadell</author>
  8777. </member>
  8778. <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
  8779. <summary>
  8780. Get a portable version of this object
  8781. </summary>
  8782. <returns>the portable instance of this object</returns>
  8783. <remarks>
  8784. <para>
  8785. Get a portable instance object that represents the current
  8786. state of this object. The portable object can be stored
  8787. and logged from any thread with identical results.
  8788. </para>
  8789. </remarks>
  8790. </member>
  8791. <member name="T:log4net.Core.ILogger">
  8792. <summary>
  8793. Interface that all loggers implement
  8794. </summary>
  8795. <remarks>
  8796. <para>
  8797. This interface supports logging events and testing if a level
  8798. is enabled for logging.
  8799. </para>
  8800. <para>
  8801. These methods will not throw exceptions. Note to implementor, ensure
  8802. that the implementation of these methods cannot allow an exception
  8803. to be thrown to the caller.
  8804. </para>
  8805. </remarks>
  8806. <author>Nicko Cadell</author>
  8807. <author>Gert Driesen</author>
  8808. </member>
  8809. <member name="P:log4net.Core.ILogger.Name">
  8810. <summary>
  8811. Gets the name of the logger.
  8812. </summary>
  8813. <value>
  8814. The name of the logger.
  8815. </value>
  8816. <remarks>
  8817. <para>
  8818. The name of this logger
  8819. </para>
  8820. </remarks>
  8821. </member>
  8822. <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  8823. <summary>
  8824. This generic form is intended to be used by wrappers.
  8825. </summary>
  8826. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  8827. the stack boundary into the logging system for this call.</param>
  8828. <param name="level">The level of the message to be logged.</param>
  8829. <param name="message">The message object to log.</param>
  8830. <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
  8831. <remarks>
  8832. <para>
  8833. Generates a logging event for the specified <paramref name="level"/> using
  8834. the <paramref name="message"/> and <paramref name="exception"/>.
  8835. </para>
  8836. </remarks>
  8837. </member>
  8838. <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
  8839. <summary>
  8840. This is the most generic printing method that is intended to be used
  8841. by wrappers.
  8842. </summary>
  8843. <param name="logEvent">The event being logged.</param>
  8844. <remarks>
  8845. <para>
  8846. Logs the specified logging event through this logger.
  8847. </para>
  8848. </remarks>
  8849. </member>
  8850. <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
  8851. <summary>
  8852. Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
  8853. </summary>
  8854. <param name="level">The level to check.</param>
  8855. <returns>
  8856. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  8857. </returns>
  8858. <remarks>
  8859. <para>
  8860. Test if this logger is going to log events of the specified <paramref name="level"/>.
  8861. </para>
  8862. </remarks>
  8863. </member>
  8864. <member name="P:log4net.Core.ILogger.Repository">
  8865. <summary>
  8866. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  8867. <c>Logger</c> instance is attached to.
  8868. </summary>
  8869. <value>
  8870. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this logger belongs to.
  8871. </value>
  8872. <remarks>
  8873. <para>
  8874. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  8875. <c>Logger</c> instance is attached to.
  8876. </para>
  8877. </remarks>
  8878. </member>
  8879. <member name="T:log4net.Core.ILoggerWrapper">
  8880. <summary>
  8881. Base interface for all wrappers
  8882. </summary>
  8883. <remarks>
  8884. <para>
  8885. Base interface for all wrappers.
  8886. </para>
  8887. <para>
  8888. All wrappers must implement this interface.
  8889. </para>
  8890. </remarks>
  8891. <author>Nicko Cadell</author>
  8892. </member>
  8893. <member name="P:log4net.Core.ILoggerWrapper.Logger">
  8894. <summary>
  8895. Get the implementation behind this wrapper object.
  8896. </summary>
  8897. <value>
  8898. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
  8899. </value>
  8900. <remarks>
  8901. <para>
  8902. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
  8903. object. The <c>Logger</c> object may not
  8904. be the same object as this object because of logger decorators.
  8905. This gets the actual underlying objects that is used to process
  8906. the log events.
  8907. </para>
  8908. </remarks>
  8909. </member>
  8910. <member name="T:log4net.Core.IOptionHandler">
  8911. <summary>
  8912. Interface used to delay activate a configured object.
  8913. </summary>
  8914. <remarks>
  8915. <para>
  8916. This allows an object to defer activation of its options until all
  8917. options have been set. This is required for components which have
  8918. related options that remain ambiguous until all are set.
  8919. </para>
  8920. <para>
  8921. If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
  8922. must be called by the container after its all the configured properties have been set
  8923. and before the component can be used.
  8924. </para>
  8925. </remarks>
  8926. <author>Nicko Cadell</author>
  8927. </member>
  8928. <member name="M:log4net.Core.IOptionHandler.ActivateOptions">
  8929. <summary>
  8930. Activate the options that were previously set with calls to properties.
  8931. </summary>
  8932. <remarks>
  8933. <para>
  8934. This allows an object to defer activation of its options until all
  8935. options have been set. This is required for components which have
  8936. related options that remain ambiguous until all are set.
  8937. </para>
  8938. <para>
  8939. If a component implements this interface then this method must be called
  8940. after its properties have been set before the component can be used.
  8941. </para>
  8942. </remarks>
  8943. </member>
  8944. <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
  8945. <summary>
  8946. Delegate used to handle logger repository creation event notifications
  8947. </summary>
  8948. <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
  8949. <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
  8950. that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
  8951. <remarks>
  8952. <para>
  8953. Delegate used to handle logger repository creation event notifications.
  8954. </para>
  8955. </remarks>
  8956. </member>
  8957. <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
  8958. <summary>
  8959. Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  8960. </summary>
  8961. <remarks>
  8962. <para>
  8963. A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
  8964. event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
  8965. </para>
  8966. </remarks>
  8967. </member>
  8968. <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
  8969. <summary>
  8970. The <see cref="T:log4net.Repository.ILoggerRepository"/> created
  8971. </summary>
  8972. </member>
  8973. <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
  8974. <summary>
  8975. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  8976. </summary>
  8977. <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
  8978. <remarks>
  8979. <para>
  8980. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  8981. </para>
  8982. </remarks>
  8983. </member>
  8984. <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
  8985. <summary>
  8986. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  8987. </summary>
  8988. <value>
  8989. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  8990. </value>
  8991. <remarks>
  8992. <para>
  8993. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  8994. </para>
  8995. </remarks>
  8996. </member>
  8997. <member name="T:log4net.Core.IRepositorySelector">
  8998. <summary>
  8999. Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9000. </summary>
  9001. <remarks>
  9002. <para>
  9003. The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
  9004. to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
  9005. to return to the caller.
  9006. </para>
  9007. </remarks>
  9008. <author>Nicko Cadell</author>
  9009. <author>Gert Driesen</author>
  9010. </member>
  9011. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9012. <summary>
  9013. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9014. </summary>
  9015. <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9016. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
  9017. <remarks>
  9018. <para>
  9019. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9020. </para>
  9021. <para>
  9022. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9023. is made is not defined. The implementation may choose any method for
  9024. this association. The results of this method must be repeatable, i.e.
  9025. when called again with the same arguments the result must be the
  9026. save value.
  9027. </para>
  9028. </remarks>
  9029. </member>
  9030. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
  9031. <summary>
  9032. Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9033. </summary>
  9034. <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9035. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9036. <remarks>
  9037. Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
  9038. calling <see cref="M:CreateRepository(string,Type)"/>.
  9039. </remarks>
  9040. </member>
  9041. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9042. <summary>
  9043. Creates a new repository for the assembly specified.
  9044. </summary>
  9045. <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9046. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9047. <returns>The repository created.</returns>
  9048. <remarks>
  9049. <para>
  9050. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
  9051. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  9052. same assembly specified will return the same repository instance.
  9053. </para>
  9054. <para>
  9055. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9056. is made is not defined. The implementation may choose any method for
  9057. this association.
  9058. </para>
  9059. </remarks>
  9060. </member>
  9061. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
  9062. <summary>
  9063. Creates a new repository with the name specified.
  9064. </summary>
  9065. <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9066. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9067. <returns>The repository created.</returns>
  9068. <remarks>
  9069. <para>
  9070. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
  9071. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  9072. same name will return the same repository instance.
  9073. </para>
  9074. </remarks>
  9075. </member>
  9076. <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
  9077. <summary>
  9078. Test if a named repository exists
  9079. </summary>
  9080. <param name="repositoryName">the named repository to check</param>
  9081. <returns><c>true</c> if the repository exists</returns>
  9082. <remarks>
  9083. <para>
  9084. Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
  9085. to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
  9086. a repository.
  9087. </para>
  9088. </remarks>
  9089. </member>
  9090. <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
  9091. <summary>
  9092. Gets an array of all currently defined repositories.
  9093. </summary>
  9094. <returns>
  9095. An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
  9096. this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
  9097. <remarks>
  9098. <para>
  9099. Gets an array of all of the repositories created by this selector.
  9100. </para>
  9101. </remarks>
  9102. </member>
  9103. <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
  9104. <summary>
  9105. Event to notify that a logger repository has been created.
  9106. </summary>
  9107. <value>
  9108. Event to notify that a logger repository has been created.
  9109. </value>
  9110. <remarks>
  9111. <para>
  9112. Event raised when a new repository is created.
  9113. The event source will be this selector. The event args will
  9114. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9115. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9116. </para>
  9117. </remarks>
  9118. </member>
  9119. <member name="T:log4net.Core.ITriggeringEventEvaluator">
  9120. <summary>
  9121. Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
  9122. </summary>
  9123. <remarks>
  9124. <para>
  9125. Implementations of this interface allow certain appenders to decide
  9126. when to perform an appender specific action.
  9127. </para>
  9128. <para>
  9129. The action or behavior triggered is defined by the implementation.
  9130. </para>
  9131. </remarks>
  9132. <author>Nicko Cadell</author>
  9133. </member>
  9134. <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  9135. <summary>
  9136. Test if this event triggers the action
  9137. </summary>
  9138. <param name="loggingEvent">The event to check</param>
  9139. <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
  9140. <remarks>
  9141. <para>
  9142. Return <c>true</c> if this event triggers the action
  9143. </para>
  9144. </remarks>
  9145. </member>
  9146. <member name="T:log4net.Core.Level">
  9147. <summary>
  9148. Defines the default set of levels recognized by the system.
  9149. </summary>
  9150. <remarks>
  9151. <para>
  9152. Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
  9153. </para>
  9154. <para>
  9155. Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
  9156. ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
  9157. are deemed to be equivalent.
  9158. </para>
  9159. <para>
  9160. The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
  9161. and each repository can have different levels defined. The levels are stored
  9162. in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
  9163. looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
  9164. </para>
  9165. <para>
  9166. When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
  9167. the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
  9168. <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
  9169. </para>
  9170. <para>
  9171. Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
  9172. <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
  9173. the display name is the same as the level name, but this can be used to alias levels
  9174. or to localize the log output.
  9175. </para>
  9176. <para>
  9177. Some of the predefined levels recognized by the system are:
  9178. </para>
  9179. <list type="bullet">
  9180. <item>
  9181. <description><see cref="F:log4net.Core.Level.Off"/>.</description>
  9182. </item>
  9183. <item>
  9184. <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
  9185. </item>
  9186. <item>
  9187. <description><see cref="F:log4net.Core.Level.Error"/>.</description>
  9188. </item>
  9189. <item>
  9190. <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
  9191. </item>
  9192. <item>
  9193. <description><see cref="F:log4net.Core.Level.Info"/>.</description>
  9194. </item>
  9195. <item>
  9196. <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
  9197. </item>
  9198. <item>
  9199. <description><see cref="F:log4net.Core.Level.All"/>.</description>
  9200. </item>
  9201. </list>
  9202. </remarks>
  9203. <author>Nicko Cadell</author>
  9204. <author>Gert Driesen</author>
  9205. </member>
  9206. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
  9207. <summary>
  9208. Constructor
  9209. </summary>
  9210. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  9211. <param name="levelName">The string name of this level.</param>
  9212. <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
  9213. <remarks>
  9214. <para>
  9215. Initializes a new instance of the <see cref="T:log4net.Core.Level" /> class with
  9216. the specified level name and value.
  9217. </para>
  9218. </remarks>
  9219. </member>
  9220. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
  9221. <summary>
  9222. Constructor
  9223. </summary>
  9224. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  9225. <param name="levelName">The string name of this level.</param>
  9226. <remarks>
  9227. <para>
  9228. Initializes a new instance of the <see cref="T:log4net.Core.Level" /> class with
  9229. the specified level name and value.
  9230. </para>
  9231. </remarks>
  9232. </member>
  9233. <member name="P:log4net.Core.Level.Name">
  9234. <summary>
  9235. Gets the name of this level.
  9236. </summary>
  9237. <value>
  9238. The name of this level.
  9239. </value>
  9240. <remarks>
  9241. <para>
  9242. Gets the name of this level.
  9243. </para>
  9244. </remarks>
  9245. </member>
  9246. <member name="P:log4net.Core.Level.Value">
  9247. <summary>
  9248. Gets the value of this level.
  9249. </summary>
  9250. <value>
  9251. The value of this level.
  9252. </value>
  9253. <remarks>
  9254. <para>
  9255. Gets the value of this level.
  9256. </para>
  9257. </remarks>
  9258. </member>
  9259. <member name="P:log4net.Core.Level.DisplayName">
  9260. <summary>
  9261. Gets the display name of this level.
  9262. </summary>
  9263. <value>
  9264. The display name of this level.
  9265. </value>
  9266. <remarks>
  9267. <para>
  9268. Gets the display name of this level.
  9269. </para>
  9270. </remarks>
  9271. </member>
  9272. <member name="M:log4net.Core.Level.ToString">
  9273. <summary>
  9274. Returns the <see cref="T:System.String" /> representation of the current
  9275. <see cref="T:log4net.Core.Level" />.
  9276. </summary>
  9277. <returns>
  9278. A <see cref="T:System.String" /> representation of the current <see cref="T:log4net.Core.Level" />.
  9279. </returns>
  9280. <remarks>
  9281. <para>
  9282. Returns the level <see cref="P:log4net.Core.Level.Name"/>.
  9283. </para>
  9284. </remarks>
  9285. </member>
  9286. <member name="M:log4net.Core.Level.Equals(System.Object)">
  9287. <summary>
  9288. Compares levels.
  9289. </summary>
  9290. <param name="o">The object to compare against.</param>
  9291. <returns><c>true</c> if the objects are equal.</returns>
  9292. <remarks>
  9293. <para>
  9294. Compares the levels of <see cref="T:log4net.Core.Level" /> instances, and
  9295. defers to base class if the target object is not a <see cref="T:log4net.Core.Level" />
  9296. instance.
  9297. </para>
  9298. </remarks>
  9299. </member>
  9300. <member name="M:log4net.Core.Level.GetHashCode">
  9301. <summary>
  9302. Returns a hash code
  9303. </summary>
  9304. <returns>A hash code for the current <see cref="T:log4net.Core.Level" />.</returns>
  9305. <remarks>
  9306. <para>
  9307. Returns a hash code suitable for use in hashing algorithms and data
  9308. structures like a hash table.
  9309. </para>
  9310. <para>
  9311. Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
  9312. </para>
  9313. </remarks>
  9314. </member>
  9315. <member name="M:log4net.Core.Level.CompareTo(System.Object)">
  9316. <summary>
  9317. Compares this instance to a specified object and returns an
  9318. indication of their relative values.
  9319. </summary>
  9320. <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null" /> to compare with this instance.</param>
  9321. <returns>
  9322. A 32-bit signed integer that indicates the relative order of the
  9323. values compared. The return value has these meanings:
  9324. <list type="table">
  9325. <listheader>
  9326. <term>Value</term>
  9327. <description>Meaning</description>
  9328. </listheader>
  9329. <item>
  9330. <term>Less than zero</term>
  9331. <description>This instance is less than <paramref name="r" />.</description>
  9332. </item>
  9333. <item>
  9334. <term>Zero</term>
  9335. <description>This instance is equal to <paramref name="r" />.</description>
  9336. </item>
  9337. <item>
  9338. <term>Greater than zero</term>
  9339. <description>
  9340. <para>This instance is greater than <paramref name="r" />.</para>
  9341. <para>-or-</para>
  9342. <para><paramref name="r" /> is <see langword="null" />.</para>
  9343. </description>
  9344. </item>
  9345. </list>
  9346. </returns>
  9347. <remarks>
  9348. <para>
  9349. <paramref name="r" /> must be an instance of <see cref="T:log4net.Core.Level" />
  9350. or <see langword="null" />; otherwise, an exception is thrown.
  9351. </para>
  9352. </remarks>
  9353. <exception cref="T:System.ArgumentException"><paramref name="r" /> is not a <see cref="T:log4net.Core.Level" />.</exception>
  9354. </member>
  9355. <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
  9356. <summary>
  9357. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  9358. is greater than another specified <see cref="T:log4net.Core.Level" />.
  9359. </summary>
  9360. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  9361. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  9362. <returns>
  9363. <c>true</c> if <paramref name="l" /> is greater than
  9364. <paramref name="r" />; otherwise, <c>false</c>.
  9365. </returns>
  9366. <remarks>
  9367. <para>
  9368. Compares two levels.
  9369. </para>
  9370. </remarks>
  9371. </member>
  9372. <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
  9373. <summary>
  9374. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  9375. is less than another specified <see cref="T:log4net.Core.Level" />.
  9376. </summary>
  9377. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  9378. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  9379. <returns>
  9380. <c>true</c> if <paramref name="l" /> is less than
  9381. <paramref name="r" />; otherwise, <c>false</c>.
  9382. </returns>
  9383. <remarks>
  9384. <para>
  9385. Compares two levels.
  9386. </para>
  9387. </remarks>
  9388. </member>
  9389. <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  9390. <summary>
  9391. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  9392. is greater than or equal to another specified <see cref="T:log4net.Core.Level" />.
  9393. </summary>
  9394. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  9395. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  9396. <returns>
  9397. <c>true</c> if <paramref name="l" /> is greater than or equal to
  9398. <paramref name="r" />; otherwise, <c>false</c>.
  9399. </returns>
  9400. <remarks>
  9401. <para>
  9402. Compares two levels.
  9403. </para>
  9404. </remarks>
  9405. </member>
  9406. <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  9407. <summary>
  9408. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  9409. is less than or equal to another specified <see cref="T:log4net.Core.Level" />.
  9410. </summary>
  9411. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  9412. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  9413. <returns>
  9414. <c>true</c> if <paramref name="l" /> is less than or equal to
  9415. <paramref name="r" />; otherwise, <c>false</c>.
  9416. </returns>
  9417. <remarks>
  9418. <para>
  9419. Compares two levels.
  9420. </para>
  9421. </remarks>
  9422. </member>
  9423. <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
  9424. <summary>
  9425. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level" />
  9426. objects have the same value.
  9427. </summary>
  9428. <param name="l">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  9429. <param name="r">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  9430. <returns>
  9431. <c>true</c> if the value of <paramref name="l" /> is the same as the
  9432. value of <paramref name="r" />; otherwise, <c>false</c>.
  9433. </returns>
  9434. <remarks>
  9435. <para>
  9436. Compares two levels.
  9437. </para>
  9438. </remarks>
  9439. </member>
  9440. <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
  9441. <summary>
  9442. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level" />
  9443. objects have different values.
  9444. </summary>
  9445. <param name="l">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  9446. <param name="r">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  9447. <returns>
  9448. <c>true</c> if the value of <paramref name="l" /> is different from
  9449. the value of <paramref name="r" />; otherwise, <c>false</c>.
  9450. </returns>
  9451. <remarks>
  9452. <para>
  9453. Compares two levels.
  9454. </para>
  9455. </remarks>
  9456. </member>
  9457. <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
  9458. <summary>
  9459. Compares two specified <see cref="T:log4net.Core.Level"/> instances.
  9460. </summary>
  9461. <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
  9462. <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
  9463. <returns>
  9464. A 32-bit signed integer that indicates the relative order of the
  9465. two values compared. The return value has these meanings:
  9466. <list type="table">
  9467. <listheader>
  9468. <term>Value</term>
  9469. <description>Meaning</description>
  9470. </listheader>
  9471. <item>
  9472. <term>Less than zero</term>
  9473. <description><paramref name="l" /> is less than <paramref name="r" />.</description>
  9474. </item>
  9475. <item>
  9476. <term>Zero</term>
  9477. <description><paramref name="l" /> is equal to <paramref name="r" />.</description>
  9478. </item>
  9479. <item>
  9480. <term>Greater than zero</term>
  9481. <description><paramref name="l" /> is greater than <paramref name="r" />.</description>
  9482. </item>
  9483. </list>
  9484. </returns>
  9485. <remarks>
  9486. <para>
  9487. Compares two levels.
  9488. </para>
  9489. </remarks>
  9490. </member>
  9491. <member name="F:log4net.Core.Level.Off">
  9492. <summary>
  9493. The <see cref="F:log4net.Core.Level.Off" /> level designates a higher level than all the rest.
  9494. </summary>
  9495. </member>
  9496. <member name="F:log4net.Core.Level.Log4Net_Debug">
  9497. <summary>
  9498. The <see cref="F:log4net.Core.Level.Emergency" /> level designates very severe error events.
  9499. System unusable, emergencies.
  9500. </summary>
  9501. </member>
  9502. <member name="F:log4net.Core.Level.Emergency">
  9503. <summary>
  9504. The <see cref="F:log4net.Core.Level.Emergency" /> level designates very severe error events.
  9505. System unusable, emergencies.
  9506. </summary>
  9507. </member>
  9508. <member name="F:log4net.Core.Level.Fatal">
  9509. <summary>
  9510. The <see cref="F:log4net.Core.Level.Fatal" /> level designates very severe error events
  9511. that will presumably lead the application to abort.
  9512. </summary>
  9513. </member>
  9514. <member name="F:log4net.Core.Level.Alert">
  9515. <summary>
  9516. The <see cref="F:log4net.Core.Level.Alert" /> level designates very severe error events.
  9517. Take immediate action, alerts.
  9518. </summary>
  9519. </member>
  9520. <member name="F:log4net.Core.Level.Critical">
  9521. <summary>
  9522. The <see cref="F:log4net.Core.Level.Critical" /> level designates very severe error events.
  9523. Critical condition, critical.
  9524. </summary>
  9525. </member>
  9526. <member name="F:log4net.Core.Level.Severe">
  9527. <summary>
  9528. The <see cref="F:log4net.Core.Level.Severe" /> level designates very severe error events.
  9529. </summary>
  9530. </member>
  9531. <member name="F:log4net.Core.Level.Error">
  9532. <summary>
  9533. The <see cref="F:log4net.Core.Level.Error" /> level designates error events that might
  9534. still allow the application to continue running.
  9535. </summary>
  9536. </member>
  9537. <member name="F:log4net.Core.Level.Warn">
  9538. <summary>
  9539. The <see cref="F:log4net.Core.Level.Warn" /> level designates potentially harmful
  9540. situations.
  9541. </summary>
  9542. </member>
  9543. <member name="F:log4net.Core.Level.Notice">
  9544. <summary>
  9545. The <see cref="F:log4net.Core.Level.Notice" /> level designates informational messages
  9546. that highlight the progress of the application at the highest level.
  9547. </summary>
  9548. </member>
  9549. <member name="F:log4net.Core.Level.Info">
  9550. <summary>
  9551. The <see cref="F:log4net.Core.Level.Info" /> level designates informational messages that
  9552. highlight the progress of the application at coarse-grained level.
  9553. </summary>
  9554. </member>
  9555. <member name="F:log4net.Core.Level.Debug">
  9556. <summary>
  9557. The <see cref="F:log4net.Core.Level.Debug" /> level designates fine-grained informational
  9558. events that are most useful to debug an application.
  9559. </summary>
  9560. </member>
  9561. <member name="F:log4net.Core.Level.Fine">
  9562. <summary>
  9563. The <see cref="F:log4net.Core.Level.Fine" /> level designates fine-grained informational
  9564. events that are most useful to debug an application.
  9565. </summary>
  9566. </member>
  9567. <member name="F:log4net.Core.Level.Trace">
  9568. <summary>
  9569. The <see cref="F:log4net.Core.Level.Trace" /> level designates fine-grained informational
  9570. events that are most useful to debug an application.
  9571. </summary>
  9572. </member>
  9573. <member name="F:log4net.Core.Level.Finer">
  9574. <summary>
  9575. The <see cref="F:log4net.Core.Level.Finer" /> level designates fine-grained informational
  9576. events that are most useful to debug an application.
  9577. </summary>
  9578. </member>
  9579. <member name="F:log4net.Core.Level.Verbose">
  9580. <summary>
  9581. The <see cref="F:log4net.Core.Level.Verbose" /> level designates fine-grained informational
  9582. events that are most useful to debug an application.
  9583. </summary>
  9584. </member>
  9585. <member name="F:log4net.Core.Level.Finest">
  9586. <summary>
  9587. The <see cref="F:log4net.Core.Level.Finest" /> level designates fine-grained informational
  9588. events that are most useful to debug an application.
  9589. </summary>
  9590. </member>
  9591. <member name="F:log4net.Core.Level.All">
  9592. <summary>
  9593. The <see cref="F:log4net.Core.Level.All" /> level designates the lowest level possible.
  9594. </summary>
  9595. </member>
  9596. <member name="T:log4net.Core.LevelCollection">
  9597. <summary>
  9598. A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
  9599. </summary>
  9600. <author>Nicko Cadell</author>
  9601. </member>
  9602. <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
  9603. <summary>
  9604. Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  9605. </summary>
  9606. </member>
  9607. <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
  9608. <summary>
  9609. Gets the current element in the collection.
  9610. </summary>
  9611. </member>
  9612. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
  9613. <summary>
  9614. Advances the enumerator to the next element in the collection.
  9615. </summary>
  9616. <returns>
  9617. <c>true</c> if the enumerator was successfully advanced to the next element;
  9618. <c>false</c> if the enumerator has passed the end of the collection.
  9619. </returns>
  9620. <exception cref="T:System.InvalidOperationException">
  9621. The collection was modified after the enumerator was created.
  9622. </exception>
  9623. </member>
  9624. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
  9625. <summary>
  9626. Sets the enumerator to its initial position, before the first element in the collection.
  9627. </summary>
  9628. </member>
  9629. <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
  9630. <summary>
  9631. Creates a read-only wrapper for a <c>LevelCollection</c> instance.
  9632. </summary>
  9633. <param name="list">list to create a readonly wrapper arround</param>
  9634. <returns>
  9635. A <c>LevelCollection</c> wrapper that is read-only.
  9636. </returns>
  9637. </member>
  9638. <member name="M:log4net.Core.LevelCollection.#ctor">
  9639. <summary>
  9640. Initializes a new instance of the <c>LevelCollection</c> class
  9641. that is empty and has the default initial capacity.
  9642. </summary>
  9643. </member>
  9644. <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
  9645. <summary>
  9646. Initializes a new instance of the <c>LevelCollection</c> class
  9647. that has the specified initial capacity.
  9648. </summary>
  9649. <param name="capacity">
  9650. The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
  9651. </param>
  9652. </member>
  9653. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
  9654. <summary>
  9655. Initializes a new instance of the <c>LevelCollection</c> class
  9656. that contains elements copied from the specified <c>LevelCollection</c>.
  9657. </summary>
  9658. <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
  9659. </member>
  9660. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
  9661. <summary>
  9662. Initializes a new instance of the <c>LevelCollection</c> class
  9663. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
  9664. </summary>
  9665. <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
  9666. </member>
  9667. <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
  9668. <summary>
  9669. Initializes a new instance of the <c>LevelCollection</c> class
  9670. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
  9671. </summary>
  9672. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
  9673. </member>
  9674. <member name="T:log4net.Core.LevelCollection.Tag">
  9675. <summary>
  9676. Type visible only to our subclasses
  9677. Used to access protected constructor
  9678. </summary>
  9679. </member>
  9680. <member name="F:log4net.Core.LevelCollection.Tag.Default">
  9681. <summary>
  9682. A value
  9683. </summary>
  9684. </member>
  9685. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
  9686. <summary>
  9687. Allow subclasses to avoid our default constructors
  9688. </summary>
  9689. <param name="tag"></param>
  9690. </member>
  9691. <member name="P:log4net.Core.LevelCollection.Count">
  9692. <summary>
  9693. Gets the number of elements actually contained in the <c>LevelCollection</c>.
  9694. </summary>
  9695. </member>
  9696. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
  9697. <summary>
  9698. Copies the entire <c>LevelCollection</c> to a one-dimensional
  9699. <see cref="T:log4net.Core.Level"/> array.
  9700. </summary>
  9701. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  9702. </member>
  9703. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
  9704. <summary>
  9705. Copies the entire <c>LevelCollection</c> to a one-dimensional
  9706. <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
  9707. </summary>
  9708. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  9709. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  9710. </member>
  9711. <member name="P:log4net.Core.LevelCollection.IsSynchronized">
  9712. <summary>
  9713. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  9714. </summary>
  9715. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  9716. </member>
  9717. <member name="P:log4net.Core.LevelCollection.SyncRoot">
  9718. <summary>
  9719. Gets an object that can be used to synchronize access to the collection.
  9720. </summary>
  9721. </member>
  9722. <member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
  9723. <summary>
  9724. Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
  9725. </summary>
  9726. <param name="index">The zero-based index of the element to get or set.</param>
  9727. <exception cref="T:System.ArgumentOutOfRangeException">
  9728. <para><paramref name="index"/> is less than zero</para>
  9729. <para>-or-</para>
  9730. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9731. </exception>
  9732. </member>
  9733. <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
  9734. <summary>
  9735. Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
  9736. </summary>
  9737. <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
  9738. <returns>The index at which the value has been added.</returns>
  9739. </member>
  9740. <member name="M:log4net.Core.LevelCollection.Clear">
  9741. <summary>
  9742. Removes all elements from the <c>LevelCollection</c>.
  9743. </summary>
  9744. </member>
  9745. <member name="M:log4net.Core.LevelCollection.Clone">
  9746. <summary>
  9747. Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
  9748. </summary>
  9749. <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
  9750. </member>
  9751. <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
  9752. <summary>
  9753. Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
  9754. </summary>
  9755. <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
  9756. <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
  9757. </member>
  9758. <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
  9759. <summary>
  9760. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
  9761. in the <c>LevelCollection</c>.
  9762. </summary>
  9763. <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
  9764. <returns>
  9765. The zero-based index of the first occurrence of <paramref name="item"/>
  9766. in the entire <c>LevelCollection</c>, if found; otherwise, -1.
  9767. </returns>
  9768. </member>
  9769. <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
  9770. <summary>
  9771. Inserts an element into the <c>LevelCollection</c> at the specified index.
  9772. </summary>
  9773. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  9774. <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
  9775. <exception cref="T:System.ArgumentOutOfRangeException">
  9776. <para><paramref name="index"/> is less than zero</para>
  9777. <para>-or-</para>
  9778. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9779. </exception>
  9780. </member>
  9781. <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
  9782. <summary>
  9783. Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
  9784. </summary>
  9785. <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
  9786. <exception cref="T:System.ArgumentException">
  9787. The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
  9788. </exception>
  9789. </member>
  9790. <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
  9791. <summary>
  9792. Removes the element at the specified index of the <c>LevelCollection</c>.
  9793. </summary>
  9794. <param name="index">The zero-based index of the element to remove.</param>
  9795. <exception cref="T:System.ArgumentOutOfRangeException">
  9796. <para><paramref name="index"/> is less than zero</para>
  9797. <para>-or-</para>
  9798. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9799. </exception>
  9800. </member>
  9801. <member name="P:log4net.Core.LevelCollection.IsFixedSize">
  9802. <summary>
  9803. Gets a value indicating whether the collection has a fixed size.
  9804. </summary>
  9805. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  9806. </member>
  9807. <member name="P:log4net.Core.LevelCollection.IsReadOnly">
  9808. <summary>
  9809. Gets a value indicating whether the IList is read-only.
  9810. </summary>
  9811. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  9812. </member>
  9813. <member name="M:log4net.Core.LevelCollection.GetEnumerator">
  9814. <summary>
  9815. Returns an enumerator that can iterate through the <c>LevelCollection</c>.
  9816. </summary>
  9817. <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
  9818. </member>
  9819. <member name="P:log4net.Core.LevelCollection.Capacity">
  9820. <summary>
  9821. Gets or sets the number of elements the <c>LevelCollection</c> can contain.
  9822. </summary>
  9823. </member>
  9824. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
  9825. <summary>
  9826. Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
  9827. </summary>
  9828. <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
  9829. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  9830. </member>
  9831. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
  9832. <summary>
  9833. Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
  9834. </summary>
  9835. <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>
  9836. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  9837. </member>
  9838. <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
  9839. <summary>
  9840. Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
  9841. </summary>
  9842. <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>
  9843. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  9844. </member>
  9845. <member name="M:log4net.Core.LevelCollection.TrimToSize">
  9846. <summary>
  9847. Sets the capacity to the actual number of elements.
  9848. </summary>
  9849. </member>
  9850. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
  9851. <exception cref="T:System.ArgumentOutOfRangeException">
  9852. <para><paramref name="i"/> is less than zero</para>
  9853. <para>-or-</para>
  9854. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9855. </exception>
  9856. </member>
  9857. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
  9858. <exception cref="T:System.ArgumentOutOfRangeException">
  9859. <para><paramref name="i"/> is less than zero</para>
  9860. <para>-or-</para>
  9861. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9862. </exception>
  9863. </member>
  9864. <member name="T:log4net.Core.LevelCollection.Enumerator">
  9865. <summary>
  9866. Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  9867. </summary>
  9868. </member>
  9869. <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
  9870. <summary>
  9871. Initializes a new instance of the <c>Enumerator</c> class.
  9872. </summary>
  9873. <param name="tc"></param>
  9874. </member>
  9875. <member name="P:log4net.Core.LevelCollection.Enumerator.Current">
  9876. <summary>
  9877. Gets the current element in the collection.
  9878. </summary>
  9879. </member>
  9880. <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
  9881. <summary>
  9882. Advances the enumerator to the next element in the collection.
  9883. </summary>
  9884. <returns>
  9885. <c>true</c> if the enumerator was successfully advanced to the next element;
  9886. <c>false</c> if the enumerator has passed the end of the collection.
  9887. </returns>
  9888. <exception cref="T:System.InvalidOperationException">
  9889. The collection was modified after the enumerator was created.
  9890. </exception>
  9891. </member>
  9892. <member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
  9893. <summary>
  9894. Sets the enumerator to its initial position, before the first element in the collection.
  9895. </summary>
  9896. </member>
  9897. <member name="T:log4net.Core.LevelEvaluator">
  9898. <summary>
  9899. An evaluator that triggers at a threshold level
  9900. </summary>
  9901. <remarks>
  9902. <para>
  9903. This evaluator will trigger if the level of the event
  9904. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9905. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9906. level.
  9907. </para>
  9908. </remarks>
  9909. <author>Nicko Cadell</author>
  9910. </member>
  9911. <member name="F:log4net.Core.LevelEvaluator.m_threshold">
  9912. <summary>
  9913. The threshold for triggering
  9914. </summary>
  9915. </member>
  9916. <member name="M:log4net.Core.LevelEvaluator.#ctor">
  9917. <summary>
  9918. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  9919. </summary>
  9920. <remarks>
  9921. <para>
  9922. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  9923. </para>
  9924. <para>
  9925. This evaluator will trigger if the level of the event
  9926. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9927. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9928. level.
  9929. </para>
  9930. </remarks>
  9931. </member>
  9932. <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
  9933. <summary>
  9934. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  9935. </summary>
  9936. <param name="threshold">the threshold to trigger at</param>
  9937. <remarks>
  9938. <para>
  9939. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  9940. </para>
  9941. <para>
  9942. This evaluator will trigger if the level of the event
  9943. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9944. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9945. level.
  9946. </para>
  9947. </remarks>
  9948. </member>
  9949. <member name="P:log4net.Core.LevelEvaluator.Threshold">
  9950. <summary>
  9951. the threshold to trigger at
  9952. </summary>
  9953. <value>
  9954. The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
  9955. </value>
  9956. <remarks>
  9957. <para>
  9958. This evaluator will trigger if the level of the event
  9959. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9960. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9961. level.
  9962. </para>
  9963. </remarks>
  9964. </member>
  9965. <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  9966. <summary>
  9967. Is this <paramref name="loggingEvent"/> the triggering event?
  9968. </summary>
  9969. <param name="loggingEvent">The event to check</param>
  9970. <returns>This method returns <c>true</c>, if the event level
  9971. is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
  9972. Otherwise it returns <c>false</c></returns>
  9973. <remarks>
  9974. <para>
  9975. This evaluator will trigger if the level of the event
  9976. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9977. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9978. level.
  9979. </para>
  9980. </remarks>
  9981. </member>
  9982. <member name="T:log4net.Core.LevelMap">
  9983. <summary>
  9984. Mapping between string name and Level object
  9985. </summary>
  9986. <remarks>
  9987. <para>
  9988. Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
  9989. This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9990. The level name is case insensitive.
  9991. </para>
  9992. </remarks>
  9993. <author>Nicko Cadell</author>
  9994. </member>
  9995. <member name="F:log4net.Core.LevelMap.m_mapName2Level">
  9996. <summary>
  9997. Mapping from level name to Level object. The
  9998. level name is case insensitive
  9999. </summary>
  10000. </member>
  10001. <member name="M:log4net.Core.LevelMap.#ctor">
  10002. <summary>
  10003. Construct the level map
  10004. </summary>
  10005. <remarks>
  10006. <para>
  10007. Construct the level map.
  10008. </para>
  10009. </remarks>
  10010. </member>
  10011. <member name="M:log4net.Core.LevelMap.Clear">
  10012. <summary>
  10013. Clear the internal maps of all levels
  10014. </summary>
  10015. <remarks>
  10016. <para>
  10017. Clear the internal maps of all levels
  10018. </para>
  10019. </remarks>
  10020. </member>
  10021. <member name="P:log4net.Core.LevelMap.Item(System.String)">
  10022. <summary>
  10023. Lookup a <see cref="T:log4net.Core.Level"/> by name
  10024. </summary>
  10025. <param name="name">The name of the Level to lookup</param>
  10026. <returns>a Level from the map with the name specified</returns>
  10027. <remarks>
  10028. <para>
  10029. Returns the <see cref="T:log4net.Core.Level"/> from the
  10030. map with the name specified. If the no level is
  10031. found then <c>null</c> is returned.
  10032. </para>
  10033. </remarks>
  10034. </member>
  10035. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
  10036. <summary>
  10037. Create a new Level and add it to the map
  10038. </summary>
  10039. <param name="name">the string to display for the Level</param>
  10040. <param name="value">the level value to give to the Level</param>
  10041. <remarks>
  10042. <para>
  10043. Create a new Level and add it to the map
  10044. </para>
  10045. </remarks>
  10046. <seealso cref="M:Add(string,int,string)"/>
  10047. </member>
  10048. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
  10049. <summary>
  10050. Create a new Level and add it to the map
  10051. </summary>
  10052. <param name="name">the string to display for the Level</param>
  10053. <param name="value">the level value to give to the Level</param>
  10054. <param name="displayName">the display name to give to the Level</param>
  10055. <remarks>
  10056. <para>
  10057. Create a new Level and add it to the map
  10058. </para>
  10059. </remarks>
  10060. </member>
  10061. <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
  10062. <summary>
  10063. Add a Level to the map
  10064. </summary>
  10065. <param name="level">the Level to add</param>
  10066. <remarks>
  10067. <para>
  10068. Add a Level to the map
  10069. </para>
  10070. </remarks>
  10071. </member>
  10072. <member name="P:log4net.Core.LevelMap.AllLevels">
  10073. <summary>
  10074. Return all possible levels as a list of Level objects.
  10075. </summary>
  10076. <returns>all possible levels as a list of Level objects</returns>
  10077. <remarks>
  10078. <para>
  10079. Return all possible levels as a list of Level objects.
  10080. </para>
  10081. </remarks>
  10082. </member>
  10083. <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
  10084. <summary>
  10085. Lookup a named level from the map
  10086. </summary>
  10087. <param name="defaultLevel">the name of the level to lookup is taken from this level.
  10088. If the level is not set on the map then this level is added</param>
  10089. <returns>the level in the map with the name specified</returns>
  10090. <remarks>
  10091. <para>
  10092. Lookup a named level from the map. The name of the level to lookup is taken
  10093. from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
  10094. argument.
  10095. </para>
  10096. <para>
  10097. If no level with the specified name is found then the
  10098. <paramref name="defaultLevel"/> argument is added to the level map
  10099. and returned.
  10100. </para>
  10101. </remarks>
  10102. </member>
  10103. <member name="T:log4net.Core.LocationInfo">
  10104. <summary>
  10105. The internal representation of caller location information.
  10106. </summary>
  10107. <remarks>
  10108. <para>
  10109. This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
  10110. a call stack. The caller's information is then extracted from this stack.
  10111. </para>
  10112. <para>
  10113. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  10114. .NET Compact Framework 1.0 therefore caller location information is not
  10115. available on that framework.
  10116. </para>
  10117. <para>
  10118. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  10119. </para>
  10120. <para>
  10121. "StackTrace information will be most informative with Debug build configurations.
  10122. By default, Debug builds include debug symbols, while Release builds do not. The
  10123. debug symbols contain most of the file, method name, line number, and column
  10124. information used in constructing StackFrame and StackTrace objects. StackTrace
  10125. might not report as many method calls as expected, due to code transformations
  10126. that occur during optimization."
  10127. </para>
  10128. <para>
  10129. This means that in a Release build the caller information may be incomplete or may
  10130. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  10131. </para>
  10132. </remarks>
  10133. <author>Nicko Cadell</author>
  10134. <author>Gert Driesen</author>
  10135. </member>
  10136. <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
  10137. <summary>
  10138. Constructor
  10139. </summary>
  10140. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  10141. the stack boundary into the logging system for this call.</param>
  10142. <remarks>
  10143. <para>
  10144. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo" />
  10145. class based on the current thread.
  10146. </para>
  10147. </remarks>
  10148. </member>
  10149. <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
  10150. <summary>
  10151. Constructor
  10152. </summary>
  10153. <param name="className">The fully qualified class name.</param>
  10154. <param name="methodName">The method name.</param>
  10155. <param name="fileName">The file name.</param>
  10156. <param name="lineNumber">The line number of the method within the file.</param>
  10157. <remarks>
  10158. <para>
  10159. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo" />
  10160. class with the specified data.
  10161. </para>
  10162. </remarks>
  10163. </member>
  10164. <member name="P:log4net.Core.LocationInfo.ClassName">
  10165. <summary>
  10166. Gets the fully qualified class name of the caller making the logging
  10167. request.
  10168. </summary>
  10169. <value>
  10170. The fully qualified class name of the caller making the logging
  10171. request.
  10172. </value>
  10173. <remarks>
  10174. <para>
  10175. Gets the fully qualified class name of the caller making the logging
  10176. request.
  10177. </para>
  10178. </remarks>
  10179. </member>
  10180. <member name="P:log4net.Core.LocationInfo.FileName">
  10181. <summary>
  10182. Gets the file name of the caller.
  10183. </summary>
  10184. <value>
  10185. The file name of the caller.
  10186. </value>
  10187. <remarks>
  10188. <para>
  10189. Gets the file name of the caller.
  10190. </para>
  10191. </remarks>
  10192. </member>
  10193. <member name="P:log4net.Core.LocationInfo.LineNumber">
  10194. <summary>
  10195. Gets the line number of the caller.
  10196. </summary>
  10197. <value>
  10198. The line number of the caller.
  10199. </value>
  10200. <remarks>
  10201. <para>
  10202. Gets the line number of the caller.
  10203. </para>
  10204. </remarks>
  10205. </member>
  10206. <member name="P:log4net.Core.LocationInfo.MethodName">
  10207. <summary>
  10208. Gets the method name of the caller.
  10209. </summary>
  10210. <value>
  10211. The method name of the caller.
  10212. </value>
  10213. <remarks>
  10214. <para>
  10215. Gets the method name of the caller.
  10216. </para>
  10217. </remarks>
  10218. </member>
  10219. <member name="P:log4net.Core.LocationInfo.FullInfo">
  10220. <summary>
  10221. Gets all available caller information
  10222. </summary>
  10223. <value>
  10224. All available caller information, in the format
  10225. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  10226. </value>
  10227. <remarks>
  10228. <para>
  10229. Gets all available caller information, in the format
  10230. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  10231. </para>
  10232. </remarks>
  10233. </member>
  10234. <member name="F:log4net.Core.LocationInfo.declaringType">
  10235. <summary>
  10236. The fully qualified type of the LocationInfo class.
  10237. </summary>
  10238. <remarks>
  10239. Used by the internal logger to record the Type of the
  10240. log message.
  10241. </remarks>
  10242. </member>
  10243. <member name="F:log4net.Core.LocationInfo.NA">
  10244. <summary>
  10245. When location information is not available the constant
  10246. <c>NA</c> is returned. Current value of this string
  10247. constant is <b>?</b>.
  10248. </summary>
  10249. </member>
  10250. <member name="T:log4net.Core.LogException">
  10251. <summary>
  10252. Exception base type for log4net.
  10253. </summary>
  10254. <remarks>
  10255. <para>
  10256. This type extends <see cref="!:ApplicationException"/>. It
  10257. does not add any new functionality but does differentiate the
  10258. type of exception being thrown.
  10259. </para>
  10260. </remarks>
  10261. <author>Nicko Cadell</author>
  10262. <author>Gert Driesen</author>
  10263. </member>
  10264. <member name="M:log4net.Core.LogException.#ctor">
  10265. <summary>
  10266. Constructor
  10267. </summary>
  10268. <remarks>
  10269. <para>
  10270. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class.
  10271. </para>
  10272. </remarks>
  10273. </member>
  10274. <member name="M:log4net.Core.LogException.#ctor(System.String)">
  10275. <summary>
  10276. Constructor
  10277. </summary>
  10278. <param name="message">A message to include with the exception.</param>
  10279. <remarks>
  10280. <para>
  10281. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class with
  10282. the specified message.
  10283. </para>
  10284. </remarks>
  10285. </member>
  10286. <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
  10287. <summary>
  10288. Constructor
  10289. </summary>
  10290. <param name="message">A message to include with the exception.</param>
  10291. <param name="innerException">A nested exception to include.</param>
  10292. <remarks>
  10293. <para>
  10294. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class
  10295. with the specified message and inner exception.
  10296. </para>
  10297. </remarks>
  10298. </member>
  10299. <member name="T:log4net.Core.LoggerManager">
  10300. <summary>
  10301. Static manager that controls the creation of repositories
  10302. </summary>
  10303. <remarks>
  10304. <para>
  10305. Static manager that controls the creation of repositories
  10306. </para>
  10307. <para>
  10308. This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
  10309. to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
  10310. </para>
  10311. <para>
  10312. This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
  10313. lookup and create repositories. The selector can be set either programmatically using
  10314. the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
  10315. AppSetting in the applications config file to the fully qualified type name of the
  10316. selector to use.
  10317. </para>
  10318. </remarks>
  10319. <author>Nicko Cadell</author>
  10320. <author>Gert Driesen</author>
  10321. </member>
  10322. <member name="M:log4net.Core.LoggerManager.#ctor">
  10323. <summary>
  10324. Private constructor to prevent instances. Only static methods should be used.
  10325. </summary>
  10326. <remarks>
  10327. <para>
  10328. Private constructor to prevent instances. Only static methods should be used.
  10329. </para>
  10330. </remarks>
  10331. </member>
  10332. <member name="M:log4net.Core.LoggerManager.#cctor">
  10333. <summary>
  10334. Hook the shutdown event
  10335. </summary>
  10336. <remarks>
  10337. <para>
  10338. On the full .NET runtime, the static constructor hooks up the
  10339. <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
  10340. These are used to shutdown the log4net system as the application exits.
  10341. </para>
  10342. </remarks>
  10343. </member>
  10344. <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
  10345. <summary>
  10346. Register for ProcessExit and DomainUnload events on the AppDomain
  10347. </summary>
  10348. <remarks>
  10349. <para>
  10350. This needs to be in a separate method because the events make
  10351. a LinkDemand for the ControlAppDomain SecurityPermission. Because
  10352. this is a LinkDemand it is demanded at JIT time. Therefore we cannot
  10353. catch the exception in the method itself, we have to catch it in the
  10354. caller.
  10355. </para>
  10356. </remarks>
  10357. </member>
  10358. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
  10359. <summary>
  10360. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10361. </summary>
  10362. <param name="repository">the repository to lookup in</param>
  10363. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  10364. <remarks>
  10365. <para>
  10366. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  10367. by the <paramref name="repository"/> argument.
  10368. </para>
  10369. </remarks>
  10370. </member>
  10371. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
  10372. <summary>
  10373. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10374. </summary>
  10375. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10376. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  10377. </member>
  10378. <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
  10379. <summary>
  10380. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10381. </summary>
  10382. <param name="repository">the repository to lookup in</param>
  10383. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  10384. <remarks>
  10385. <para>
  10386. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  10387. by the <paramref name="repository"/> argument.
  10388. </para>
  10389. </remarks>
  10390. </member>
  10391. <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
  10392. <summary>
  10393. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10394. </summary>
  10395. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10396. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  10397. <remarks>
  10398. <para>
  10399. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10400. </para>
  10401. </remarks>
  10402. </member>
  10403. <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
  10404. <summary>
  10405. Returns the named logger if it exists.
  10406. </summary>
  10407. <param name="repository">The repository to lookup in.</param>
  10408. <param name="name">The fully qualified logger name to look for.</param>
  10409. <returns>
  10410. The logger found, or <c>null</c> if the named logger does not exist in the
  10411. specified repository.
  10412. </returns>
  10413. <remarks>
  10414. <para>
  10415. If the named logger exists (in the specified repository) then it
  10416. returns a reference to the logger, otherwise it returns
  10417. <c>null</c>.
  10418. </para>
  10419. </remarks>
  10420. </member>
  10421. <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
  10422. <summary>
  10423. Returns the named logger if it exists.
  10424. </summary>
  10425. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10426. <param name="name">The fully qualified logger name to look for.</param>
  10427. <returns>
  10428. The logger found, or <c>null</c> if the named logger does not exist in the
  10429. specified assembly's repository.
  10430. </returns>
  10431. <remarks>
  10432. <para>
  10433. If the named logger exists (in the specified assembly's repository) then it
  10434. returns a reference to the logger, otherwise it returns
  10435. <c>null</c>.
  10436. </para>
  10437. </remarks>
  10438. </member>
  10439. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
  10440. <summary>
  10441. Returns all the currently defined loggers in the specified repository.
  10442. </summary>
  10443. <param name="repository">The repository to lookup in.</param>
  10444. <returns>All the defined loggers.</returns>
  10445. <remarks>
  10446. <para>
  10447. The root logger is <b>not</b> included in the returned array.
  10448. </para>
  10449. </remarks>
  10450. </member>
  10451. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
  10452. <summary>
  10453. Returns all the currently defined loggers in the specified assembly's repository.
  10454. </summary>
  10455. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10456. <returns>All the defined loggers.</returns>
  10457. <remarks>
  10458. <para>
  10459. The root logger is <b>not</b> included in the returned array.
  10460. </para>
  10461. </remarks>
  10462. </member>
  10463. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
  10464. <summary>
  10465. Retrieves or creates a named logger.
  10466. </summary>
  10467. <param name="repository">The repository to lookup in.</param>
  10468. <param name="name">The name of the logger to retrieve.</param>
  10469. <returns>The logger with the name specified.</returns>
  10470. <remarks>
  10471. <para>
  10472. Retrieves a logger named as the <paramref name="name"/>
  10473. parameter. If the named logger already exists, then the
  10474. existing instance will be returned. Otherwise, a new instance is
  10475. created.
  10476. </para>
  10477. <para>
  10478. By default, loggers do not have a set level but inherit
  10479. it from the hierarchy. This is one of the central features of
  10480. log4net.
  10481. </para>
  10482. </remarks>
  10483. </member>
  10484. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
  10485. <summary>
  10486. Retrieves or creates a named logger.
  10487. </summary>
  10488. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10489. <param name="name">The name of the logger to retrieve.</param>
  10490. <returns>The logger with the name specified.</returns>
  10491. <remarks>
  10492. <para>
  10493. Retrieves a logger named as the <paramref name="name"/>
  10494. parameter. If the named logger already exists, then the
  10495. existing instance will be returned. Otherwise, a new instance is
  10496. created.
  10497. </para>
  10498. <para>
  10499. By default, loggers do not have a set level but inherit
  10500. it from the hierarchy. This is one of the central features of
  10501. log4net.
  10502. </para>
  10503. </remarks>
  10504. </member>
  10505. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
  10506. <summary>
  10507. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  10508. </summary>
  10509. <param name="repository">The repository to lookup in.</param>
  10510. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  10511. <returns>The logger with the name specified.</returns>
  10512. <remarks>
  10513. <para>
  10514. Gets the logger for the fully qualified name of the type specified.
  10515. </para>
  10516. </remarks>
  10517. </member>
  10518. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
  10519. <summary>
  10520. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  10521. </summary>
  10522. <param name="repositoryAssembly">the assembly to use to lookup the repository</param>
  10523. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  10524. <returns>The logger with the name specified.</returns>
  10525. <remarks>
  10526. <para>
  10527. Gets the logger for the fully qualified name of the type specified.
  10528. </para>
  10529. </remarks>
  10530. </member>
  10531. <member name="M:log4net.Core.LoggerManager.Shutdown">
  10532. <summary>
  10533. Shuts down the log4net system.
  10534. </summary>
  10535. <remarks>
  10536. <para>
  10537. Calling this method will <b>safely</b> close and remove all
  10538. appenders in all the loggers including root contained in all the
  10539. default repositories.
  10540. </para>
  10541. <para>
  10542. Some appenders need to be closed before the application exists.
  10543. Otherwise, pending logging events might be lost.
  10544. </para>
  10545. <para>
  10546. The <c>shutdown</c> method is careful to close nested
  10547. appenders before closing regular appenders. This is allows
  10548. configurations where a regular appender is attached to a logger
  10549. and again to a nested appender.
  10550. </para>
  10551. </remarks>
  10552. </member>
  10553. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
  10554. <summary>
  10555. Shuts down the repository for the repository specified.
  10556. </summary>
  10557. <param name="repository">The repository to shutdown.</param>
  10558. <remarks>
  10559. <para>
  10560. Calling this method will <b>safely</b> close and remove all
  10561. appenders in all the loggers including root contained in the
  10562. repository for the <paramref name="repository"/> specified.
  10563. </para>
  10564. <para>
  10565. Some appenders need to be closed before the application exists.
  10566. Otherwise, pending logging events might be lost.
  10567. </para>
  10568. <para>
  10569. The <c>shutdown</c> method is careful to close nested
  10570. appenders before closing regular appenders. This is allows
  10571. configurations where a regular appender is attached to a logger
  10572. and again to a nested appender.
  10573. </para>
  10574. </remarks>
  10575. </member>
  10576. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
  10577. <summary>
  10578. Shuts down the repository for the repository specified.
  10579. </summary>
  10580. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10581. <remarks>
  10582. <para>
  10583. Calling this method will <b>safely</b> close and remove all
  10584. appenders in all the loggers including root contained in the
  10585. repository for the repository. The repository is looked up using
  10586. the <paramref name="repositoryAssembly"/> specified.
  10587. </para>
  10588. <para>
  10589. Some appenders need to be closed before the application exists.
  10590. Otherwise, pending logging events might be lost.
  10591. </para>
  10592. <para>
  10593. The <c>shutdown</c> method is careful to close nested
  10594. appenders before closing regular appenders. This is allows
  10595. configurations where a regular appender is attached to a logger
  10596. and again to a nested appender.
  10597. </para>
  10598. </remarks>
  10599. </member>
  10600. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
  10601. <summary>
  10602. Resets all values contained in this repository instance to their defaults.
  10603. </summary>
  10604. <param name="repository">The repository to reset.</param>
  10605. <remarks>
  10606. <para>
  10607. Resets all values contained in the repository instance to their
  10608. defaults. This removes all appenders from all loggers, sets
  10609. the level of all non-root loggers to <c>null</c>,
  10610. sets their additivity flag to <c>true</c> and sets the level
  10611. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  10612. message disabling is set its default "off" value.
  10613. </para>
  10614. </remarks>
  10615. </member>
  10616. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
  10617. <summary>
  10618. Resets all values contained in this repository instance to their defaults.
  10619. </summary>
  10620. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  10621. <remarks>
  10622. <para>
  10623. Resets all values contained in the repository instance to their
  10624. defaults. This removes all appenders from all loggers, sets
  10625. the level of all non-root loggers to <c>null</c>,
  10626. sets their additivity flag to <c>true</c> and sets the level
  10627. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  10628. message disabling is set its default "off" value.
  10629. </para>
  10630. </remarks>
  10631. </member>
  10632. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
  10633. <summary>
  10634. Creates a repository with the specified name.
  10635. </summary>
  10636. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  10637. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10638. <remarks>
  10639. <para>
  10640. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  10641. </para>
  10642. <para>
  10643. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  10644. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  10645. </para>
  10646. <para>
  10647. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  10648. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  10649. </para>
  10650. </remarks>
  10651. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  10652. </member>
  10653. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
  10654. <summary>
  10655. Creates a repository with the specified name.
  10656. </summary>
  10657. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  10658. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10659. <remarks>
  10660. <para>
  10661. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  10662. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  10663. </para>
  10664. <para>
  10665. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  10666. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  10667. </para>
  10668. </remarks>
  10669. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  10670. </member>
  10671. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
  10672. <summary>
  10673. Creates a repository with the specified name and repository type.
  10674. </summary>
  10675. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  10676. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  10677. and has a no arg constructor. An instance of this type will be created to act
  10678. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  10679. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10680. <remarks>
  10681. <para>
  10682. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  10683. </para>
  10684. <para>
  10685. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  10686. An Exception will be thrown if the repository already exists.
  10687. </para>
  10688. </remarks>
  10689. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  10690. </member>
  10691. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
  10692. <summary>
  10693. Creates a repository with the specified name and repository type.
  10694. </summary>
  10695. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  10696. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  10697. and has a no arg constructor. An instance of this type will be created to act
  10698. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  10699. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10700. <remarks>
  10701. <para>
  10702. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  10703. An Exception will be thrown if the repository already exists.
  10704. </para>
  10705. </remarks>
  10706. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  10707. </member>
  10708. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  10709. <summary>
  10710. Creates a repository for the specified assembly and repository type.
  10711. </summary>
  10712. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  10713. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  10714. and has a no arg constructor. An instance of this type will be created to act
  10715. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  10716. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10717. <remarks>
  10718. <para>
  10719. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  10720. </para>
  10721. <para>
  10722. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10723. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10724. same assembly specified will return the same repository instance.
  10725. </para>
  10726. </remarks>
  10727. </member>
  10728. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  10729. <summary>
  10730. Creates a repository for the specified assembly and repository type.
  10731. </summary>
  10732. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  10733. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  10734. and has a no arg constructor. An instance of this type will be created to act
  10735. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  10736. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10737. <remarks>
  10738. <para>
  10739. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10740. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10741. same assembly specified will return the same repository instance.
  10742. </para>
  10743. </remarks>
  10744. </member>
  10745. <member name="M:log4net.Core.LoggerManager.GetAllRepositories">
  10746. <summary>
  10747. Gets an array of all currently defined repositories.
  10748. </summary>
  10749. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  10750. <remarks>
  10751. <para>
  10752. Gets an array of all currently defined repositories.
  10753. </para>
  10754. </remarks>
  10755. </member>
  10756. <member name="P:log4net.Core.LoggerManager.RepositorySelector">
  10757. <summary>
  10758. Gets or sets the repository selector used by the <see cref="T:log4net.LogManager" />.
  10759. </summary>
  10760. <value>
  10761. The repository selector used by the <see cref="T:log4net.LogManager" />.
  10762. </value>
  10763. <remarks>
  10764. <para>
  10765. The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
  10766. the <see cref="T:log4net.LogManager"/> to create and select repositories
  10767. (<see cref="T:log4net.Repository.ILoggerRepository"/>).
  10768. </para>
  10769. <para>
  10770. The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
  10771. or an assembly (if not supplied the assembly is inferred using
  10772. <see cref="M:Assembly.GetCallingAssembly()"/>).
  10773. </para>
  10774. <para>
  10775. This context is used by the selector to lookup a specific repository.
  10776. </para>
  10777. <para>
  10778. For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
  10779. for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
  10780. repository.
  10781. </para>
  10782. </remarks>
  10783. </member>
  10784. <member name="M:log4net.Core.LoggerManager.GetVersionInfo">
  10785. <summary>
  10786. Internal method to get pertinent version info.
  10787. </summary>
  10788. <returns>A string of version info.</returns>
  10789. </member>
  10790. <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
  10791. <summary>
  10792. Called when the <see cref="!:AppDomain.DomainUnload"/> event fires
  10793. </summary>
  10794. <param name="sender">the <see cref="!:AppDomain"/> that is exiting</param>
  10795. <param name="e">null</param>
  10796. <remarks>
  10797. <para>
  10798. Called when the <see cref="!:AppDomain.DomainUnload"/> event fires.
  10799. </para>
  10800. <para>
  10801. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  10802. </para>
  10803. </remarks>
  10804. </member>
  10805. <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
  10806. <summary>
  10807. Called when the <see cref="!:AppDomain.ProcessExit"/> event fires
  10808. </summary>
  10809. <param name="sender">the <see cref="!:AppDomain"/> that is exiting</param>
  10810. <param name="e">null</param>
  10811. <remarks>
  10812. <para>
  10813. Called when the <see cref="!:AppDomain.ProcessExit"/> event fires.
  10814. </para>
  10815. <para>
  10816. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  10817. </para>
  10818. </remarks>
  10819. </member>
  10820. <member name="F:log4net.Core.LoggerManager.declaringType">
  10821. <summary>
  10822. The fully qualified type of the LoggerManager class.
  10823. </summary>
  10824. <remarks>
  10825. Used by the internal logger to record the Type of the
  10826. log message.
  10827. </remarks>
  10828. </member>
  10829. <member name="F:log4net.Core.LoggerManager.s_repositorySelector">
  10830. <summary>
  10831. Initialize the default repository selector
  10832. </summary>
  10833. </member>
  10834. <member name="T:log4net.Core.LoggerWrapperImpl">
  10835. <summary>
  10836. Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
  10837. </summary>
  10838. <remarks>
  10839. <para>
  10840. This class should be used as the base for all wrapper implementations.
  10841. </para>
  10842. </remarks>
  10843. <author>Nicko Cadell</author>
  10844. <author>Gert Driesen</author>
  10845. </member>
  10846. <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
  10847. <summary>
  10848. Constructs a new wrapper for the specified logger.
  10849. </summary>
  10850. <param name="logger">The logger to wrap.</param>
  10851. <remarks>
  10852. <para>
  10853. Constructs a new wrapper for the specified logger.
  10854. </para>
  10855. </remarks>
  10856. </member>
  10857. <member name="P:log4net.Core.LoggerWrapperImpl.Logger">
  10858. <summary>
  10859. Gets the implementation behind this wrapper object.
  10860. </summary>
  10861. <value>
  10862. The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
  10863. </value>
  10864. <remarks>
  10865. <para>
  10866. The <c>Logger</c> object may not be the same object as this object
  10867. because of logger decorators.
  10868. </para>
  10869. <para>
  10870. This gets the actual underlying objects that is used to process
  10871. the log events.
  10872. </para>
  10873. </remarks>
  10874. </member>
  10875. <member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
  10876. <summary>
  10877. The logger that this object is wrapping
  10878. </summary>
  10879. </member>
  10880. <member name="T:log4net.Core.LoggingEventData">
  10881. <summary>
  10882. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  10883. </summary>
  10884. <remarks>
  10885. <para>
  10886. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  10887. </para>
  10888. </remarks>
  10889. <author>Nicko Cadell</author>
  10890. </member>
  10891. <member name="F:log4net.Core.LoggingEventData.LoggerName">
  10892. <summary>
  10893. The logger name.
  10894. </summary>
  10895. <remarks>
  10896. <para>
  10897. The logger name.
  10898. </para>
  10899. </remarks>
  10900. </member>
  10901. <member name="F:log4net.Core.LoggingEventData.Level">
  10902. <summary>
  10903. Level of logging event.
  10904. </summary>
  10905. <remarks>
  10906. <para>
  10907. Level of logging event. Level cannot be Serializable
  10908. because it is a flyweight. Due to its special serialization it
  10909. cannot be declared final either.
  10910. </para>
  10911. </remarks>
  10912. </member>
  10913. <member name="F:log4net.Core.LoggingEventData.Message">
  10914. <summary>
  10915. The application supplied message.
  10916. </summary>
  10917. <remarks>
  10918. <para>
  10919. The application supplied message of logging event.
  10920. </para>
  10921. </remarks>
  10922. </member>
  10923. <member name="F:log4net.Core.LoggingEventData.ThreadName">
  10924. <summary>
  10925. The name of thread
  10926. </summary>
  10927. <remarks>
  10928. <para>
  10929. The name of thread in which this logging event was generated
  10930. </para>
  10931. </remarks>
  10932. </member>
  10933. <member name="F:log4net.Core.LoggingEventData.TimeStamp">
  10934. <summary>
  10935. Gets or sets the local time the event was logged
  10936. </summary>
  10937. <remarks>
  10938. <para>
  10939. Prefer using the <see cref="P:log4net.Core.LoggingEventData.TimeStampUtc"/> setter, since local time can be ambiguous.
  10940. </para>
  10941. </remarks>
  10942. </member>
  10943. <member name="P:log4net.Core.LoggingEventData.TimeStampUtc">
  10944. <summary>
  10945. Gets or sets the UTC time the event was logged
  10946. </summary>
  10947. <remarks>
  10948. <para>
  10949. The TimeStamp is stored in the UTC time zone.
  10950. </para>
  10951. </remarks>
  10952. </member>
  10953. <member name="F:log4net.Core.LoggingEventData.LocationInfo">
  10954. <summary>
  10955. Location information for the caller.
  10956. </summary>
  10957. <remarks>
  10958. <para>
  10959. Location information for the caller.
  10960. </para>
  10961. </remarks>
  10962. </member>
  10963. <member name="F:log4net.Core.LoggingEventData.UserName">
  10964. <summary>
  10965. String representation of the user
  10966. </summary>
  10967. <remarks>
  10968. <para>
  10969. String representation of the user's windows name,
  10970. like DOMAIN\username
  10971. </para>
  10972. </remarks>
  10973. </member>
  10974. <member name="F:log4net.Core.LoggingEventData.Identity">
  10975. <summary>
  10976. String representation of the identity.
  10977. </summary>
  10978. <remarks>
  10979. <para>
  10980. String representation of the current thread's principal identity.
  10981. </para>
  10982. </remarks>
  10983. </member>
  10984. <member name="F:log4net.Core.LoggingEventData.ExceptionString">
  10985. <summary>
  10986. The string representation of the exception
  10987. </summary>
  10988. <remarks>
  10989. <para>
  10990. The string representation of the exception
  10991. </para>
  10992. </remarks>
  10993. </member>
  10994. <member name="F:log4net.Core.LoggingEventData.Domain">
  10995. <summary>
  10996. String representation of the AppDomain.
  10997. </summary>
  10998. <remarks>
  10999. <para>
  11000. String representation of the AppDomain.
  11001. </para>
  11002. </remarks>
  11003. </member>
  11004. <member name="F:log4net.Core.LoggingEventData.Properties">
  11005. <summary>
  11006. Additional event specific properties
  11007. </summary>
  11008. <remarks>
  11009. <para>
  11010. A logger or an appender may attach additional
  11011. properties to specific events. These properties
  11012. have a string key and an object value.
  11013. </para>
  11014. </remarks>
  11015. </member>
  11016. <member name="T:log4net.Core.FixFlags">
  11017. <summary>
  11018. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  11019. </summary>
  11020. <remarks>
  11021. <para>
  11022. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  11023. </para>
  11024. </remarks>
  11025. <author>Nicko Cadell</author>
  11026. </member>
  11027. <member name="F:log4net.Core.FixFlags.Mdc">
  11028. <summary>
  11029. Fix the MDC
  11030. </summary>
  11031. </member>
  11032. <member name="F:log4net.Core.FixFlags.Ndc">
  11033. <summary>
  11034. Fix the NDC
  11035. </summary>
  11036. </member>
  11037. <member name="F:log4net.Core.FixFlags.Message">
  11038. <summary>
  11039. Fix the rendered message
  11040. </summary>
  11041. </member>
  11042. <member name="F:log4net.Core.FixFlags.ThreadName">
  11043. <summary>
  11044. Fix the thread name
  11045. </summary>
  11046. </member>
  11047. <member name="F:log4net.Core.FixFlags.LocationInfo">
  11048. <summary>
  11049. Fix the callers location information
  11050. </summary>
  11051. <remarks>
  11052. CAUTION: Very slow to generate
  11053. </remarks>
  11054. </member>
  11055. <member name="F:log4net.Core.FixFlags.UserName">
  11056. <summary>
  11057. Fix the callers windows user name
  11058. </summary>
  11059. <remarks>
  11060. CAUTION: Slow to generate
  11061. </remarks>
  11062. </member>
  11063. <member name="F:log4net.Core.FixFlags.Domain">
  11064. <summary>
  11065. Fix the domain friendly name
  11066. </summary>
  11067. </member>
  11068. <member name="F:log4net.Core.FixFlags.Identity">
  11069. <summary>
  11070. Fix the callers principal name
  11071. </summary>
  11072. <remarks>
  11073. CAUTION: May be slow to generate
  11074. </remarks>
  11075. </member>
  11076. <member name="F:log4net.Core.FixFlags.Exception">
  11077. <summary>
  11078. Fix the exception text
  11079. </summary>
  11080. </member>
  11081. <member name="F:log4net.Core.FixFlags.Properties">
  11082. <summary>
  11083. Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
  11084. </summary>
  11085. </member>
  11086. <member name="F:log4net.Core.FixFlags.None">
  11087. <summary>
  11088. No fields fixed
  11089. </summary>
  11090. </member>
  11091. <member name="F:log4net.Core.FixFlags.All">
  11092. <summary>
  11093. All fields fixed
  11094. </summary>
  11095. </member>
  11096. <member name="F:log4net.Core.FixFlags.Partial">
  11097. <summary>
  11098. Partial fields fixed
  11099. </summary>
  11100. <remarks>
  11101. <para>
  11102. This set of partial fields gives good performance. The following fields are fixed:
  11103. </para>
  11104. <list type="bullet">
  11105. <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
  11106. <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
  11107. <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
  11108. <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
  11109. <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
  11110. </list>
  11111. </remarks>
  11112. </member>
  11113. <member name="T:log4net.Core.LoggingEvent">
  11114. <summary>
  11115. The internal representation of logging events.
  11116. </summary>
  11117. <remarks>
  11118. <para>
  11119. When an affirmative decision is made to log then a
  11120. <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
  11121. is passed around to the different log4net components.
  11122. </para>
  11123. <para>
  11124. This class is of concern to those wishing to extend log4net.
  11125. </para>
  11126. <para>
  11127. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  11128. are considered volatile, that is the values are correct at the
  11129. time the event is delivered to appenders, but will not be consistent
  11130. at any time afterwards. If an event is to be stored and then processed
  11131. at a later time these volatile values must be fixed by calling
  11132. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  11133. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  11134. is essential to maintaining data consistency.
  11135. </para>
  11136. </remarks>
  11137. <author>Nicko Cadell</author>
  11138. <author>Gert Driesen</author>
  11139. <author>Douglas de la Torre</author>
  11140. <author>Daniel Cazzulino</author>
  11141. </member>
  11142. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
  11143. <summary>
  11144. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11145. from the supplied parameters.
  11146. </summary>
  11147. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11148. the stack boundary into the logging system for this call.</param>
  11149. <param name="repository">The repository this event is logged in.</param>
  11150. <param name="loggerName">The name of the logger of this event.</param>
  11151. <param name="level">The level of this event.</param>
  11152. <param name="message">The message of this event.</param>
  11153. <param name="exception">The exception for this event.</param>
  11154. <remarks>
  11155. <para>
  11156. Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
  11157. all fields of <c>LoggingEvent</c> are filled when actually needed. Call
  11158. <see cref="M:FixVolatileData()"/> to cache all data locally
  11159. to prevent inconsistencies.
  11160. </para>
  11161. <para>This method is called by the log4net framework
  11162. to create a logging event.
  11163. </para>
  11164. </remarks>
  11165. </member>
  11166. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
  11167. <summary>
  11168. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11169. using specific data.
  11170. </summary>
  11171. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11172. the stack boundary into the logging system for this call.</param>
  11173. <param name="repository">The repository this event is logged in.</param>
  11174. <param name="data">Data used to initialize the logging event.</param>
  11175. <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
  11176. <remarks>
  11177. <para>
  11178. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  11179. to be created independently of the log4net framework. This can
  11180. be useful if you require a custom serialization scheme.
  11181. </para>
  11182. <para>
  11183. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  11184. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  11185. </para>
  11186. <para>
  11187. The <paramref name="fixedData"/> parameter should be used to specify which fields in the
  11188. <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
  11189. will be captured from the environment if requested or fixed.
  11190. </para>
  11191. </remarks>
  11192. </member>
  11193. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
  11194. <summary>
  11195. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11196. using specific data.
  11197. </summary>
  11198. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11199. the stack boundary into the logging system for this call.</param>
  11200. <param name="repository">The repository this event is logged in.</param>
  11201. <param name="data">Data used to initialize the logging event.</param>
  11202. <remarks>
  11203. <para>
  11204. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  11205. to be created independently of the log4net framework. This can
  11206. be useful if you require a custom serialization scheme.
  11207. </para>
  11208. <para>
  11209. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  11210. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  11211. </para>
  11212. <para>
  11213. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  11214. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  11215. parameter and no other data should be captured from the environment.
  11216. </para>
  11217. </remarks>
  11218. </member>
  11219. <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
  11220. <summary>
  11221. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11222. using specific data.
  11223. </summary>
  11224. <param name="data">Data used to initialize the logging event.</param>
  11225. <remarks>
  11226. <para>
  11227. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  11228. to be created independently of the log4net framework. This can
  11229. be useful if you require a custom serialization scheme.
  11230. </para>
  11231. <para>
  11232. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  11233. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  11234. </para>
  11235. <para>
  11236. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  11237. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  11238. parameter and no other data should be captured from the environment.
  11239. </para>
  11240. </remarks>
  11241. </member>
  11242. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  11243. <summary>
  11244. Serialization constructor
  11245. </summary>
  11246. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  11247. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  11248. <remarks>
  11249. <para>
  11250. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11251. with serialized data.
  11252. </para>
  11253. </remarks>
  11254. </member>
  11255. <member name="P:log4net.Core.LoggingEvent.StartTime">
  11256. <summary>
  11257. Gets the time when the current process started.
  11258. </summary>
  11259. <value>
  11260. This is the time when this process started.
  11261. </value>
  11262. <remarks>
  11263. <para>
  11264. The TimeStamp is stored internally in UTC and converted to the local time zone for this computer.
  11265. </para>
  11266. <para>
  11267. Tries to get the start time for the current process.
  11268. Failing that it returns the time of the first call to
  11269. this property.
  11270. </para>
  11271. <para>
  11272. Note that AppDomains may be loaded and unloaded within the
  11273. same process without the process terminating and therefore
  11274. without the process start time being reset.
  11275. </para>
  11276. </remarks>
  11277. </member>
  11278. <member name="P:log4net.Core.LoggingEvent.StartTimeUtc">
  11279. <summary>
  11280. Gets the UTC time when the current process started.
  11281. </summary>
  11282. <value>
  11283. This is the UTC time when this process started.
  11284. </value>
  11285. <remarks>
  11286. <para>
  11287. Tries to get the start time for the current process.
  11288. Failing that it returns the time of the first call to
  11289. this property.
  11290. </para>
  11291. <para>
  11292. Note that AppDomains may be loaded and unloaded within the
  11293. same process without the process terminating and therefore
  11294. without the process start time being reset.
  11295. </para>
  11296. </remarks>
  11297. </member>
  11298. <member name="P:log4net.Core.LoggingEvent.Level">
  11299. <summary>
  11300. Gets the <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  11301. </summary>
  11302. <value>
  11303. The <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  11304. </value>
  11305. <remarks>
  11306. <para>
  11307. Gets the <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  11308. </para>
  11309. </remarks>
  11310. </member>
  11311. <member name="P:log4net.Core.LoggingEvent.TimeStamp">
  11312. <summary>
  11313. Gets the time of the logging event.
  11314. </summary>
  11315. <value>
  11316. The time of the logging event.
  11317. </value>
  11318. <remarks>
  11319. <para>
  11320. The TimeStamp is stored in UTC and converted to the local time zone for this computer.
  11321. </para>
  11322. </remarks>
  11323. </member>
  11324. <member name="P:log4net.Core.LoggingEvent.TimeStampUtc">
  11325. <summary>
  11326. Gets UTC the time of the logging event.
  11327. </summary>
  11328. <value>
  11329. The UTC time of the logging event.
  11330. </value>
  11331. </member>
  11332. <member name="P:log4net.Core.LoggingEvent.LoggerName">
  11333. <summary>
  11334. Gets the name of the logger that logged the event.
  11335. </summary>
  11336. <value>
  11337. The name of the logger that logged the event.
  11338. </value>
  11339. <remarks>
  11340. <para>
  11341. Gets the name of the logger that logged the event.
  11342. </para>
  11343. </remarks>
  11344. </member>
  11345. <member name="P:log4net.Core.LoggingEvent.LocationInformation">
  11346. <summary>
  11347. Gets the location information for this logging event.
  11348. </summary>
  11349. <value>
  11350. The location information for this logging event.
  11351. </value>
  11352. <remarks>
  11353. <para>
  11354. The collected information is cached for future use.
  11355. </para>
  11356. <para>
  11357. See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
  11358. supported frameworks and the different behavior in Debug and
  11359. Release builds.
  11360. </para>
  11361. </remarks>
  11362. </member>
  11363. <member name="P:log4net.Core.LoggingEvent.MessageObject">
  11364. <summary>
  11365. Gets the message object used to initialize this event.
  11366. </summary>
  11367. <value>
  11368. The message object used to initialize this event.
  11369. </value>
  11370. <remarks>
  11371. <para>
  11372. Gets the message object used to initialize this event.
  11373. Note that this event may not have a valid message object.
  11374. If the event is serialized the message object will not
  11375. be transferred. To get the text of the message the
  11376. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
  11377. not this property.
  11378. </para>
  11379. <para>
  11380. If there is no defined message object for this event then
  11381. null will be returned.
  11382. </para>
  11383. </remarks>
  11384. </member>
  11385. <member name="P:log4net.Core.LoggingEvent.ExceptionObject">
  11386. <summary>
  11387. Gets the exception object used to initialize this event.
  11388. </summary>
  11389. <value>
  11390. The exception object used to initialize this event.
  11391. </value>
  11392. <remarks>
  11393. <para>
  11394. Gets the exception object used to initialize this event.
  11395. Note that this event may not have a valid exception object.
  11396. If the event is serialized the exception object will not
  11397. be transferred. To get the text of the exception the
  11398. <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
  11399. not this property.
  11400. </para>
  11401. <para>
  11402. If there is no defined exception object for this event then
  11403. null will be returned.
  11404. </para>
  11405. </remarks>
  11406. </member>
  11407. <member name="P:log4net.Core.LoggingEvent.Repository">
  11408. <summary>
  11409. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  11410. </summary>
  11411. <remarks>
  11412. <para>
  11413. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  11414. </para>
  11415. </remarks>
  11416. </member>
  11417. <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
  11418. <summary>
  11419. Ensure that the repository is set.
  11420. </summary>
  11421. <param name="repository">the value for the repository</param>
  11422. </member>
  11423. <member name="P:log4net.Core.LoggingEvent.RenderedMessage">
  11424. <summary>
  11425. Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11426. </summary>
  11427. <value>
  11428. The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11429. </value>
  11430. <remarks>
  11431. <para>
  11432. The collected information is cached for future use.
  11433. </para>
  11434. </remarks>
  11435. </member>
  11436. <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
  11437. <summary>
  11438. Write the rendered message to a TextWriter
  11439. </summary>
  11440. <param name="writer">the writer to write the message to</param>
  11441. <remarks>
  11442. <para>
  11443. Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
  11444. does store the message data in the internal cache. Therefore
  11445. if called only once this method should be faster than the
  11446. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
  11447. to be accessed multiple times then the property will be more efficient.
  11448. </para>
  11449. </remarks>
  11450. </member>
  11451. <member name="P:log4net.Core.LoggingEvent.ThreadName">
  11452. <summary>
  11453. Gets the name of the current thread.
  11454. </summary>
  11455. <value>
  11456. The name of the current thread, or the thread ID when
  11457. the name is not available.
  11458. </value>
  11459. <remarks>
  11460. <para>
  11461. The collected information is cached for future use.
  11462. </para>
  11463. </remarks>
  11464. </member>
  11465. <member name="P:log4net.Core.LoggingEvent.UserName">
  11466. <summary>
  11467. Gets the name of the current user.
  11468. </summary>
  11469. <value>
  11470. The name of the current user, or <c>NOT AVAILABLE</c> when the
  11471. underlying runtime has no support for retrieving the name of the
  11472. current user.
  11473. </value>
  11474. <remarks>
  11475. <para>
  11476. Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
  11477. the current windows user.
  11478. </para>
  11479. <para>
  11480. To improve performance, we could cache the string representation of
  11481. the name, and reuse that as long as the identity stayed constant.
  11482. Once the identity changed, we would need to re-assign and re-render
  11483. the string.
  11484. </para>
  11485. <para>
  11486. However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
  11487. return different objects every time, so the current implementation
  11488. doesn't do this type of caching.
  11489. </para>
  11490. <para>
  11491. Timing for these operations:
  11492. </para>
  11493. <list type="table">
  11494. <listheader>
  11495. <term>Method</term>
  11496. <description>Results</description>
  11497. </listheader>
  11498. <item>
  11499. <term><c>WindowsIdentity.GetCurrent()</c></term>
  11500. <description>10000 loops, 00:00:00.2031250 seconds</description>
  11501. </item>
  11502. <item>
  11503. <term><c>WindowsIdentity.GetCurrent().Name</c></term>
  11504. <description>10000 loops, 00:00:08.0468750 seconds</description>
  11505. </item>
  11506. </list>
  11507. <para>
  11508. This means we could speed things up almost 40 times by caching the
  11509. value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
  11510. this takes (8.04-0.20) = 7.84375 seconds.
  11511. </para>
  11512. </remarks>
  11513. </member>
  11514. <member name="P:log4net.Core.LoggingEvent.Identity">
  11515. <summary>
  11516. Gets the identity of the current thread principal.
  11517. </summary>
  11518. <value>
  11519. The string name of the identity of the current thread principal.
  11520. </value>
  11521. <remarks>
  11522. <para>
  11523. Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
  11524. the name of the current thread principal.
  11525. </para>
  11526. </remarks>
  11527. </member>
  11528. <member name="P:log4net.Core.LoggingEvent.Domain">
  11529. <summary>
  11530. Gets the AppDomain friendly name.
  11531. </summary>
  11532. <value>
  11533. The AppDomain friendly name.
  11534. </value>
  11535. <remarks>
  11536. <para>
  11537. Gets the AppDomain friendly name.
  11538. </para>
  11539. </remarks>
  11540. </member>
  11541. <member name="P:log4net.Core.LoggingEvent.Properties">
  11542. <summary>
  11543. Additional event specific properties.
  11544. </summary>
  11545. <value>
  11546. Additional event specific properties.
  11547. </value>
  11548. <remarks>
  11549. <para>
  11550. A logger or an appender may attach additional
  11551. properties to specific events. These properties
  11552. have a string key and an object value.
  11553. </para>
  11554. <para>
  11555. This property is for events that have been added directly to
  11556. this event. The aggregate properties (which include these
  11557. event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
  11558. and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
  11559. </para>
  11560. <para>
  11561. Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
  11562. returns the combined cached properties. This ensures that updates to
  11563. this property are always reflected in the underlying storage. When
  11564. returning the combined properties there may be more keys in the
  11565. Dictionary than expected.
  11566. </para>
  11567. </remarks>
  11568. </member>
  11569. <member name="P:log4net.Core.LoggingEvent.Fix">
  11570. <summary>
  11571. The fixed fields in this event
  11572. </summary>
  11573. <value>
  11574. The set of fields that are fixed in this event
  11575. </value>
  11576. <remarks>
  11577. <para>
  11578. Fields will not be fixed if they have previously been fixed.
  11579. It is not possible to 'unfix' a field.
  11580. </para>
  11581. </remarks>
  11582. </member>
  11583. <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  11584. <summary>
  11585. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  11586. </summary>
  11587. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
  11588. <param name="context">The destination for this serialization.</param>
  11589. <remarks>
  11590. <para>
  11591. The data in this event must be fixed before it can be serialized.
  11592. </para>
  11593. <para>
  11594. The <see cref="M:FixVolatileData()"/> method must be called during the
  11595. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
  11596. is to be used outside that method.
  11597. </para>
  11598. </remarks>
  11599. </member>
  11600. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
  11601. <summary>
  11602. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent" />.
  11603. </summary>
  11604. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  11605. <remarks>
  11606. <para>
  11607. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  11608. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  11609. </para>
  11610. <para>
  11611. Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
  11612. in the logging event before returning the event data.
  11613. </para>
  11614. </remarks>
  11615. </member>
  11616. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
  11617. <summary>
  11618. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent" />.
  11619. </summary>
  11620. <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
  11621. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  11622. <remarks>
  11623. <para>
  11624. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  11625. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  11626. </para>
  11627. </remarks>
  11628. </member>
  11629. <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
  11630. <summary>
  11631. Returns this event's exception's rendered using the
  11632. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11633. </summary>
  11634. <returns>
  11635. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11636. </returns>
  11637. <remarks>
  11638. <para>
  11639. <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
  11640. </para>
  11641. </remarks>
  11642. </member>
  11643. <member name="M:log4net.Core.LoggingEvent.GetExceptionString">
  11644. <summary>
  11645. Returns this event's exception's rendered using the
  11646. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11647. </summary>
  11648. <returns>
  11649. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11650. </returns>
  11651. <remarks>
  11652. <para>
  11653. Returns this event's exception's rendered using the
  11654. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11655. </para>
  11656. </remarks>
  11657. </member>
  11658. <member name="M:log4net.Core.LoggingEvent.FixVolatileData">
  11659. <summary>
  11660. Fix instance fields that hold volatile data.
  11661. </summary>
  11662. <remarks>
  11663. <para>
  11664. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  11665. are considered volatile, that is the values are correct at the
  11666. time the event is delivered to appenders, but will not be consistent
  11667. at any time afterwards. If an event is to be stored and then processed
  11668. at a later time these volatile values must be fixed by calling
  11669. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  11670. incurred by calling <see cref="M:FixVolatileData()"/> but it
  11671. is essential to maintaining data consistency.
  11672. </para>
  11673. <para>
  11674. Calling <see cref="M:FixVolatileData()"/> is equivalent to
  11675. calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
  11676. <c>false</c>.
  11677. </para>
  11678. <para>
  11679. See <see cref="M:FixVolatileData(bool)"/> for more
  11680. information.
  11681. </para>
  11682. </remarks>
  11683. </member>
  11684. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
  11685. <summary>
  11686. Fixes instance fields that hold volatile data.
  11687. </summary>
  11688. <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
  11689. <remarks>
  11690. <para>
  11691. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  11692. are considered volatile, that is the values are correct at the
  11693. time the event is delivered to appenders, but will not be consistent
  11694. at any time afterwards. If an event is to be stored and then processed
  11695. at a later time these volatile values must be fixed by calling
  11696. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  11697. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  11698. is essential to maintaining data consistency.
  11699. </para>
  11700. <para>
  11701. The <paramref name="fastButLoose"/> param controls the data that
  11702. is fixed. Some of the data that can be fixed takes a long time to
  11703. generate, therefore if you do not require those settings to be fixed
  11704. they can be ignored by setting the <paramref name="fastButLoose"/> param
  11705. to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
  11706. and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
  11707. </para>
  11708. <para>
  11709. Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
  11710. settings are fixed.
  11711. </para>
  11712. </remarks>
  11713. </member>
  11714. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
  11715. <summary>
  11716. Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
  11717. </summary>
  11718. <param name="flags">the fields to fix</param>
  11719. <remarks>
  11720. <para>
  11721. Only fields specified in the <paramref name="flags"/> will be fixed.
  11722. Fields will not be fixed if they have previously been fixed.
  11723. It is not possible to 'unfix' a field.
  11724. </para>
  11725. </remarks>
  11726. </member>
  11727. <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
  11728. <summary>
  11729. Lookup a composite property in this event
  11730. </summary>
  11731. <param name="key">the key for the property to lookup</param>
  11732. <returns>the value for the property</returns>
  11733. <remarks>
  11734. <para>
  11735. This event has composite properties that combine together properties from
  11736. several different contexts in the following order:
  11737. <list type="definition">
  11738. <item>
  11739. <term>this events properties</term>
  11740. <description>
  11741. This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  11742. properties are specific to this event only.
  11743. </description>
  11744. </item>
  11745. <item>
  11746. <term>the thread properties</term>
  11747. <description>
  11748. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  11749. thread. These properties are shared by all events logged on this thread.
  11750. </description>
  11751. </item>
  11752. <item>
  11753. <term>the global properties</term>
  11754. <description>
  11755. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  11756. properties are shared by all the threads in the AppDomain.
  11757. </description>
  11758. </item>
  11759. </list>
  11760. </para>
  11761. </remarks>
  11762. </member>
  11763. <member name="M:log4net.Core.LoggingEvent.GetProperties">
  11764. <summary>
  11765. Get all the composite properties in this event
  11766. </summary>
  11767. <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
  11768. <remarks>
  11769. <para>
  11770. See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
  11771. stored by the event.
  11772. </para>
  11773. <para>
  11774. This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
  11775. properties defined for this event.
  11776. </para>
  11777. </remarks>
  11778. </member>
  11779. <member name="F:log4net.Core.LoggingEvent.m_data">
  11780. <summary>
  11781. The internal logging event data.
  11782. </summary>
  11783. </member>
  11784. <member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
  11785. <summary>
  11786. The internal logging event data.
  11787. </summary>
  11788. </member>
  11789. <member name="F:log4net.Core.LoggingEvent.m_eventProperties">
  11790. <summary>
  11791. The internal logging event data.
  11792. </summary>
  11793. </member>
  11794. <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
  11795. <summary>
  11796. The fully qualified Type of the calling
  11797. logger class in the stack frame (i.e. the declaring type of the method).
  11798. </summary>
  11799. </member>
  11800. <member name="F:log4net.Core.LoggingEvent.m_message">
  11801. <summary>
  11802. The application supplied message of logging event.
  11803. </summary>
  11804. </member>
  11805. <member name="F:log4net.Core.LoggingEvent.m_thrownException">
  11806. <summary>
  11807. The exception that was thrown.
  11808. </summary>
  11809. <remarks>
  11810. This is not serialized. The string representation
  11811. is serialized instead.
  11812. </remarks>
  11813. </member>
  11814. <member name="F:log4net.Core.LoggingEvent.m_repository">
  11815. <summary>
  11816. The repository that generated the logging event
  11817. </summary>
  11818. <remarks>
  11819. This is not serialized.
  11820. </remarks>
  11821. </member>
  11822. <member name="F:log4net.Core.LoggingEvent.m_fixFlags">
  11823. <summary>
  11824. The fix state for this event
  11825. </summary>
  11826. <remarks>
  11827. These flags indicate which fields have been fixed.
  11828. Not serialized.
  11829. </remarks>
  11830. </member>
  11831. <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
  11832. <summary>
  11833. Indicated that the internal cache is updateable (ie not fixed)
  11834. </summary>
  11835. <remarks>
  11836. This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
  11837. changes in the caching strategy.
  11838. </remarks>
  11839. </member>
  11840. <member name="F:log4net.Core.LoggingEvent.HostNameProperty">
  11841. <summary>
  11842. The key into the Properties map for the host name value.
  11843. </summary>
  11844. </member>
  11845. <member name="F:log4net.Core.LoggingEvent.IdentityProperty">
  11846. <summary>
  11847. The key into the Properties map for the thread identity value.
  11848. </summary>
  11849. </member>
  11850. <member name="F:log4net.Core.LoggingEvent.UserNameProperty">
  11851. <summary>
  11852. The key into the Properties map for the user name value.
  11853. </summary>
  11854. </member>
  11855. <member name="T:log4net.Core.LogImpl">
  11856. <summary>
  11857. Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
  11858. </summary>
  11859. <remarks>
  11860. <para>
  11861. This implementation of the <see cref="T:log4net.ILog"/> interface
  11862. forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
  11863. </para>
  11864. <para>
  11865. This logger has methods to allow the caller to log at the following
  11866. levels:
  11867. </para>
  11868. <list type="definition">
  11869. <item>
  11870. <term>DEBUG</term>
  11871. <description>
  11872. The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
  11873. at the <c>DEBUG</c> level. That is the level with that name defined in the
  11874. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11875. for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  11876. property tests if this level is enabled for logging.
  11877. </description>
  11878. </item>
  11879. <item>
  11880. <term>INFO</term>
  11881. <description>
  11882. The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
  11883. at the <c>INFO</c> level. That is the level with that name defined in the
  11884. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11885. for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
  11886. property tests if this level is enabled for logging.
  11887. </description>
  11888. </item>
  11889. <item>
  11890. <term>WARN</term>
  11891. <description>
  11892. The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
  11893. at the <c>WARN</c> level. That is the level with that name defined in the
  11894. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11895. for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
  11896. property tests if this level is enabled for logging.
  11897. </description>
  11898. </item>
  11899. <item>
  11900. <term>ERROR</term>
  11901. <description>
  11902. The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
  11903. at the <c>ERROR</c> level. That is the level with that name defined in the
  11904. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11905. for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
  11906. property tests if this level is enabled for logging.
  11907. </description>
  11908. </item>
  11909. <item>
  11910. <term>FATAL</term>
  11911. <description>
  11912. The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
  11913. at the <c>FATAL</c> level. That is the level with that name defined in the
  11914. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11915. for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
  11916. property tests if this level is enabled for logging.
  11917. </description>
  11918. </item>
  11919. </list>
  11920. <para>
  11921. The values for these levels and their semantic meanings can be changed by
  11922. configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
  11923. </para>
  11924. </remarks>
  11925. <author>Nicko Cadell</author>
  11926. <author>Gert Driesen</author>
  11927. </member>
  11928. <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
  11929. <summary>
  11930. Construct a new wrapper for the specified logger.
  11931. </summary>
  11932. <param name="logger">The logger to wrap.</param>
  11933. <remarks>
  11934. <para>
  11935. Construct a new wrapper for the specified logger.
  11936. </para>
  11937. </remarks>
  11938. </member>
  11939. <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
  11940. <summary>
  11941. Virtual method called when the configuration of the repository changes
  11942. </summary>
  11943. <param name="repository">the repository holding the levels</param>
  11944. <remarks>
  11945. <para>
  11946. Virtual method called when the configuration of the repository changes
  11947. </para>
  11948. </remarks>
  11949. </member>
  11950. <member name="M:log4net.Core.LogImpl.Debug(System.Object)">
  11951. <summary>
  11952. Logs a message object with the <c>DEBUG</c> level.
  11953. </summary>
  11954. <param name="message">The message object to log.</param>
  11955. <remarks>
  11956. <para>
  11957. This method first checks if this logger is <c>DEBUG</c>
  11958. enabled by comparing the level of this logger with the
  11959. <c>DEBUG</c> level. If this logger is
  11960. <c>DEBUG</c> enabled, then it converts the message object
  11961. (passed as parameter) to a string by invoking the appropriate
  11962. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  11963. proceeds to call all the registered appenders in this logger
  11964. and also higher in the hierarchy depending on the value of the
  11965. additivity flag.
  11966. </para>
  11967. <para>
  11968. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  11969. to this method will print the name of the <see cref="T:System.Exception"/>
  11970. but no stack trace. To print a stack trace use the
  11971. <see cref="M:Debug(object,Exception)"/> form instead.
  11972. </para>
  11973. </remarks>
  11974. </member>
  11975. <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
  11976. <summary>
  11977. Logs a message object with the <c>DEBUG</c> level
  11978. </summary>
  11979. <param name="message">The message object to log.</param>
  11980. <param name="exception">The exception to log, including its stack trace.</param>
  11981. <remarks>
  11982. <para>
  11983. Logs a message object with the <c>DEBUG</c> level including
  11984. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
  11985. as a parameter.
  11986. </para>
  11987. <para>
  11988. See the <see cref="M:Debug(object)"/> form for more detailed information.
  11989. </para>
  11990. </remarks>
  11991. <seealso cref="M:Debug(object)"/>
  11992. </member>
  11993. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
  11994. <summary>
  11995. Logs a formatted message string with the <c>DEBUG</c> level.
  11996. </summary>
  11997. <param name="format">A String containing zero or more format items</param>
  11998. <param name="args">An Object array containing zero or more objects to format</param>
  11999. <remarks>
  12000. <para>
  12001. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12002. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12003. of the formatting.
  12004. </para>
  12005. <para>
  12006. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12007. format provider. To specify a localized provider use the
  12008. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  12009. </para>
  12010. <para>
  12011. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12012. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12013. methods instead.
  12014. </para>
  12015. </remarks>
  12016. </member>
  12017. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
  12018. <summary>
  12019. Logs a formatted message string with the <c>DEBUG</c> level.
  12020. </summary>
  12021. <param name="format">A String containing zero or more format items</param>
  12022. <param name="arg0">An Object to format</param>
  12023. <remarks>
  12024. <para>
  12025. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12026. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12027. of the formatting.
  12028. </para>
  12029. <para>
  12030. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12031. format provider. To specify a localized provider use the
  12032. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  12033. </para>
  12034. <para>
  12035. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12036. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12037. methods instead.
  12038. </para>
  12039. </remarks>
  12040. </member>
  12041. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
  12042. <summary>
  12043. Logs a formatted message string with the <c>DEBUG</c> level.
  12044. </summary>
  12045. <param name="format">A String containing zero or more format items</param>
  12046. <param name="arg0">An Object to format</param>
  12047. <param name="arg1">An Object to format</param>
  12048. <remarks>
  12049. <para>
  12050. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12051. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12052. of the formatting.
  12053. </para>
  12054. <para>
  12055. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12056. format provider. To specify a localized provider use the
  12057. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  12058. </para>
  12059. <para>
  12060. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12061. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12062. methods instead.
  12063. </para>
  12064. </remarks>
  12065. </member>
  12066. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  12067. <summary>
  12068. Logs a formatted message string with the <c>DEBUG</c> level.
  12069. </summary>
  12070. <param name="format">A String containing zero or more format items</param>
  12071. <param name="arg0">An Object to format</param>
  12072. <param name="arg1">An Object to format</param>
  12073. <param name="arg2">An Object to format</param>
  12074. <remarks>
  12075. <para>
  12076. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12077. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12078. of the formatting.
  12079. </para>
  12080. <para>
  12081. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12082. format provider. To specify a localized provider use the
  12083. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  12084. </para>
  12085. <para>
  12086. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12087. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12088. methods instead.
  12089. </para>
  12090. </remarks>
  12091. </member>
  12092. <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  12093. <summary>
  12094. Logs a formatted message string with the <c>DEBUG</c> level.
  12095. </summary>
  12096. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12097. <param name="format">A String containing zero or more format items</param>
  12098. <param name="args">An Object array containing zero or more objects to format</param>
  12099. <remarks>
  12100. <para>
  12101. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12102. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12103. of the formatting.
  12104. </para>
  12105. <para>
  12106. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12107. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12108. methods instead.
  12109. </para>
  12110. </remarks>
  12111. </member>
  12112. <member name="M:log4net.Core.LogImpl.Info(System.Object)">
  12113. <summary>
  12114. Logs a message object with the <c>INFO</c> level.
  12115. </summary>
  12116. <param name="message">The message object to log.</param>
  12117. <remarks>
  12118. <para>
  12119. This method first checks if this logger is <c>INFO</c>
  12120. enabled by comparing the level of this logger with the
  12121. <c>INFO</c> level. If this logger is
  12122. <c>INFO</c> enabled, then it converts the message object
  12123. (passed as parameter) to a string by invoking the appropriate
  12124. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  12125. proceeds to call all the registered appenders in this logger
  12126. and also higher in the hierarchy depending on the value of
  12127. the additivity flag.
  12128. </para>
  12129. <para>
  12130. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  12131. to this method will print the name of the <see cref="T:System.Exception"/>
  12132. but no stack trace. To print a stack trace use the
  12133. <see cref="M:Info(object,Exception)"/> form instead.
  12134. </para>
  12135. </remarks>
  12136. </member>
  12137. <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
  12138. <summary>
  12139. Logs a message object with the <c>INFO</c> level.
  12140. </summary>
  12141. <param name="message">The message object to log.</param>
  12142. <param name="exception">The exception to log, including its stack trace.</param>
  12143. <remarks>
  12144. <para>
  12145. Logs a message object with the <c>INFO</c> level including
  12146. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  12147. passed as a parameter.
  12148. </para>
  12149. <para>
  12150. See the <see cref="M:Info(object)"/> form for more detailed information.
  12151. </para>
  12152. </remarks>
  12153. <seealso cref="M:Info(object)"/>
  12154. </member>
  12155. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
  12156. <summary>
  12157. Logs a formatted message string with the <c>INFO</c> level.
  12158. </summary>
  12159. <param name="format">A String containing zero or more format items</param>
  12160. <param name="args">An Object array containing zero or more objects to format</param>
  12161. <remarks>
  12162. <para>
  12163. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12164. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12165. of the formatting.
  12166. </para>
  12167. <para>
  12168. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12169. format provider. To specify a localized provider use the
  12170. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  12171. </para>
  12172. <para>
  12173. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12174. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12175. methods instead.
  12176. </para>
  12177. </remarks>
  12178. </member>
  12179. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
  12180. <summary>
  12181. Logs a formatted message string with the <c>INFO</c> level.
  12182. </summary>
  12183. <param name="format">A String containing zero or more format items</param>
  12184. <param name="arg0">An Object to format</param>
  12185. <remarks>
  12186. <para>
  12187. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12188. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12189. of the formatting.
  12190. </para>
  12191. <para>
  12192. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12193. format provider. To specify a localized provider use the
  12194. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  12195. </para>
  12196. <para>
  12197. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12198. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12199. methods instead.
  12200. </para>
  12201. </remarks>
  12202. </member>
  12203. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
  12204. <summary>
  12205. Logs a formatted message string with the <c>INFO</c> level.
  12206. </summary>
  12207. <param name="format">A String containing zero or more format items</param>
  12208. <param name="arg0">An Object to format</param>
  12209. <param name="arg1">An Object to format</param>
  12210. <remarks>
  12211. <para>
  12212. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12213. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12214. of the formatting.
  12215. </para>
  12216. <para>
  12217. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12218. format provider. To specify a localized provider use the
  12219. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  12220. </para>
  12221. <para>
  12222. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12223. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12224. methods instead.
  12225. </para>
  12226. </remarks>
  12227. </member>
  12228. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  12229. <summary>
  12230. Logs a formatted message string with the <c>INFO</c> level.
  12231. </summary>
  12232. <param name="format">A String containing zero or more format items</param>
  12233. <param name="arg0">An Object to format</param>
  12234. <param name="arg1">An Object to format</param>
  12235. <param name="arg2">An Object to format</param>
  12236. <remarks>
  12237. <para>
  12238. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12239. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12240. of the formatting.
  12241. </para>
  12242. <para>
  12243. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12244. format provider. To specify a localized provider use the
  12245. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  12246. </para>
  12247. <para>
  12248. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12249. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12250. methods instead.
  12251. </para>
  12252. </remarks>
  12253. </member>
  12254. <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  12255. <summary>
  12256. Logs a formatted message string with the <c>INFO</c> level.
  12257. </summary>
  12258. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12259. <param name="format">A String containing zero or more format items</param>
  12260. <param name="args">An Object array containing zero or more objects to format</param>
  12261. <remarks>
  12262. <para>
  12263. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12264. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12265. of the formatting.
  12266. </para>
  12267. <para>
  12268. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12269. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12270. methods instead.
  12271. </para>
  12272. </remarks>
  12273. </member>
  12274. <member name="M:log4net.Core.LogImpl.Warn(System.Object)">
  12275. <summary>
  12276. Logs a message object with the <c>WARN</c> level.
  12277. </summary>
  12278. <param name="message">the message object to log</param>
  12279. <remarks>
  12280. <para>
  12281. This method first checks if this logger is <c>WARN</c>
  12282. enabled by comparing the level of this logger with the
  12283. <c>WARN</c> level. If this logger is
  12284. <c>WARN</c> enabled, then it converts the message object
  12285. (passed as parameter) to a string by invoking the appropriate
  12286. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  12287. proceeds to call all the registered appenders in this logger and
  12288. also higher in the hierarchy depending on the value of the
  12289. additivity flag.
  12290. </para>
  12291. <para>
  12292. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  12293. method will print the name of the <see cref="T:System.Exception"/> but no
  12294. stack trace. To print a stack trace use the
  12295. <see cref="M:Warn(object,Exception)"/> form instead.
  12296. </para>
  12297. </remarks>
  12298. </member>
  12299. <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
  12300. <summary>
  12301. Logs a message object with the <c>WARN</c> level
  12302. </summary>
  12303. <param name="message">The message object to log.</param>
  12304. <param name="exception">The exception to log, including its stack trace.</param>
  12305. <remarks>
  12306. <para>
  12307. Logs a message object with the <c>WARN</c> level including
  12308. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  12309. passed as a parameter.
  12310. </para>
  12311. <para>
  12312. See the <see cref="M:Warn(object)"/> form for more detailed information.
  12313. </para>
  12314. </remarks>
  12315. <seealso cref="M:Warn(object)"/>
  12316. </member>
  12317. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
  12318. <summary>
  12319. Logs a formatted message string with the <c>WARN</c> level.
  12320. </summary>
  12321. <param name="format">A String containing zero or more format items</param>
  12322. <param name="args">An Object array containing zero or more objects to format</param>
  12323. <remarks>
  12324. <para>
  12325. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12326. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12327. of the formatting.
  12328. </para>
  12329. <para>
  12330. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12331. format provider. To specify a localized provider use the
  12332. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  12333. </para>
  12334. <para>
  12335. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12336. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12337. methods instead.
  12338. </para>
  12339. </remarks>
  12340. </member>
  12341. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
  12342. <summary>
  12343. Logs a formatted message string with the <c>WARN</c> level.
  12344. </summary>
  12345. <param name="format">A String containing zero or more format items</param>
  12346. <param name="arg0">An Object to format</param>
  12347. <remarks>
  12348. <para>
  12349. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12350. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12351. of the formatting.
  12352. </para>
  12353. <para>
  12354. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12355. format provider. To specify a localized provider use the
  12356. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  12357. </para>
  12358. <para>
  12359. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12360. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12361. methods instead.
  12362. </para>
  12363. </remarks>
  12364. </member>
  12365. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
  12366. <summary>
  12367. Logs a formatted message string with the <c>WARN</c> level.
  12368. </summary>
  12369. <param name="format">A String containing zero or more format items</param>
  12370. <param name="arg0">An Object to format</param>
  12371. <param name="arg1">An Object to format</param>
  12372. <remarks>
  12373. <para>
  12374. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12375. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12376. of the formatting.
  12377. </para>
  12378. <para>
  12379. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12380. format provider. To specify a localized provider use the
  12381. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  12382. </para>
  12383. <para>
  12384. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12385. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12386. methods instead.
  12387. </para>
  12388. </remarks>
  12389. </member>
  12390. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  12391. <summary>
  12392. Logs a formatted message string with the <c>WARN</c> level.
  12393. </summary>
  12394. <param name="format">A String containing zero or more format items</param>
  12395. <param name="arg0">An Object to format</param>
  12396. <param name="arg1">An Object to format</param>
  12397. <param name="arg2">An Object to format</param>
  12398. <remarks>
  12399. <para>
  12400. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12401. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12402. of the formatting.
  12403. </para>
  12404. <para>
  12405. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12406. format provider. To specify a localized provider use the
  12407. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  12408. </para>
  12409. <para>
  12410. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12411. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12412. methods instead.
  12413. </para>
  12414. </remarks>
  12415. </member>
  12416. <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  12417. <summary>
  12418. Logs a formatted message string with the <c>WARN</c> level.
  12419. </summary>
  12420. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12421. <param name="format">A String containing zero or more format items</param>
  12422. <param name="args">An Object array containing zero or more objects to format</param>
  12423. <remarks>
  12424. <para>
  12425. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12426. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12427. of the formatting.
  12428. </para>
  12429. <para>
  12430. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12431. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12432. methods instead.
  12433. </para>
  12434. </remarks>
  12435. </member>
  12436. <member name="M:log4net.Core.LogImpl.Error(System.Object)">
  12437. <summary>
  12438. Logs a message object with the <c>ERROR</c> level.
  12439. </summary>
  12440. <param name="message">The message object to log.</param>
  12441. <remarks>
  12442. <para>
  12443. This method first checks if this logger is <c>ERROR</c>
  12444. enabled by comparing the level of this logger with the
  12445. <c>ERROR</c> level. If this logger is
  12446. <c>ERROR</c> enabled, then it converts the message object
  12447. (passed as parameter) to a string by invoking the appropriate
  12448. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  12449. proceeds to call all the registered appenders in this logger and
  12450. also higher in the hierarchy depending on the value of the
  12451. additivity flag.
  12452. </para>
  12453. <para>
  12454. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  12455. method will print the name of the <see cref="T:System.Exception"/> but no
  12456. stack trace. To print a stack trace use the
  12457. <see cref="M:Error(object,Exception)"/> form instead.
  12458. </para>
  12459. </remarks>
  12460. </member>
  12461. <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
  12462. <summary>
  12463. Logs a message object with the <c>ERROR</c> level
  12464. </summary>
  12465. <param name="message">The message object to log.</param>
  12466. <param name="exception">The exception to log, including its stack trace.</param>
  12467. <remarks>
  12468. <para>
  12469. Logs a message object with the <c>ERROR</c> level including
  12470. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  12471. passed as a parameter.
  12472. </para>
  12473. <para>
  12474. See the <see cref="M:Error(object)"/> form for more detailed information.
  12475. </para>
  12476. </remarks>
  12477. <seealso cref="M:Error(object)"/>
  12478. </member>
  12479. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
  12480. <summary>
  12481. Logs a formatted message string with the <c>ERROR</c> level.
  12482. </summary>
  12483. <param name="format">A String containing zero or more format items</param>
  12484. <param name="args">An Object array containing zero or more objects to format</param>
  12485. <remarks>
  12486. <para>
  12487. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12488. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12489. of the formatting.
  12490. </para>
  12491. <para>
  12492. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12493. format provider. To specify a localized provider use the
  12494. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  12495. </para>
  12496. <para>
  12497. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12498. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12499. methods instead.
  12500. </para>
  12501. </remarks>
  12502. </member>
  12503. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
  12504. <summary>
  12505. Logs a formatted message string with the <c>ERROR</c> level.
  12506. </summary>
  12507. <param name="format">A String containing zero or more format items</param>
  12508. <param name="arg0">An Object to format</param>
  12509. <remarks>
  12510. <para>
  12511. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12512. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12513. of the formatting.
  12514. </para>
  12515. <para>
  12516. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12517. format provider. To specify a localized provider use the
  12518. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  12519. </para>
  12520. <para>
  12521. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12522. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12523. methods instead.
  12524. </para>
  12525. </remarks>
  12526. </member>
  12527. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
  12528. <summary>
  12529. Logs a formatted message string with the <c>ERROR</c> level.
  12530. </summary>
  12531. <param name="format">A String containing zero or more format items</param>
  12532. <param name="arg0">An Object to format</param>
  12533. <param name="arg1">An Object to format</param>
  12534. <remarks>
  12535. <para>
  12536. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12537. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12538. of the formatting.
  12539. </para>
  12540. <para>
  12541. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12542. format provider. To specify a localized provider use the
  12543. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  12544. </para>
  12545. <para>
  12546. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12547. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12548. methods instead.
  12549. </para>
  12550. </remarks>
  12551. </member>
  12552. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  12553. <summary>
  12554. Logs a formatted message string with the <c>ERROR</c> level.
  12555. </summary>
  12556. <param name="format">A String containing zero or more format items</param>
  12557. <param name="arg0">An Object to format</param>
  12558. <param name="arg1">An Object to format</param>
  12559. <param name="arg2">An Object to format</param>
  12560. <remarks>
  12561. <para>
  12562. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12563. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12564. of the formatting.
  12565. </para>
  12566. <para>
  12567. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12568. format provider. To specify a localized provider use the
  12569. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  12570. </para>
  12571. <para>
  12572. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12573. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12574. methods instead.
  12575. </para>
  12576. </remarks>
  12577. </member>
  12578. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  12579. <summary>
  12580. Logs a formatted message string with the <c>ERROR</c> level.
  12581. </summary>
  12582. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12583. <param name="format">A String containing zero or more format items</param>
  12584. <param name="args">An Object array containing zero or more objects to format</param>
  12585. <remarks>
  12586. <para>
  12587. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12588. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12589. of the formatting.
  12590. </para>
  12591. <para>
  12592. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12593. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12594. methods instead.
  12595. </para>
  12596. </remarks>
  12597. </member>
  12598. <member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
  12599. <summary>
  12600. Logs a message object with the <c>FATAL</c> level.
  12601. </summary>
  12602. <param name="message">The message object to log.</param>
  12603. <remarks>
  12604. <para>
  12605. This method first checks if this logger is <c>FATAL</c>
  12606. enabled by comparing the level of this logger with the
  12607. <c>FATAL</c> level. If this logger is
  12608. <c>FATAL</c> enabled, then it converts the message object
  12609. (passed as parameter) to a string by invoking the appropriate
  12610. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  12611. proceeds to call all the registered appenders in this logger and
  12612. also higher in the hierarchy depending on the value of the
  12613. additivity flag.
  12614. </para>
  12615. <para>
  12616. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  12617. method will print the name of the <see cref="T:System.Exception"/> but no
  12618. stack trace. To print a stack trace use the
  12619. <see cref="M:Fatal(object,Exception)"/> form instead.
  12620. </para>
  12621. </remarks>
  12622. </member>
  12623. <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
  12624. <summary>
  12625. Logs a message object with the <c>FATAL</c> level
  12626. </summary>
  12627. <param name="message">The message object to log.</param>
  12628. <param name="exception">The exception to log, including its stack trace.</param>
  12629. <remarks>
  12630. <para>
  12631. Logs a message object with the <c>FATAL</c> level including
  12632. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  12633. passed as a parameter.
  12634. </para>
  12635. <para>
  12636. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  12637. </para>
  12638. </remarks>
  12639. <seealso cref="M:Fatal(object)"/>
  12640. </member>
  12641. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
  12642. <summary>
  12643. Logs a formatted message string with the <c>FATAL</c> level.
  12644. </summary>
  12645. <param name="format">A String containing zero or more format items</param>
  12646. <param name="args">An Object array containing zero or more objects to format</param>
  12647. <remarks>
  12648. <para>
  12649. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12650. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12651. of the formatting.
  12652. </para>
  12653. <para>
  12654. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12655. format provider. To specify a localized provider use the
  12656. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  12657. </para>
  12658. <para>
  12659. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12660. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12661. methods instead.
  12662. </para>
  12663. </remarks>
  12664. </member>
  12665. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
  12666. <summary>
  12667. Logs a formatted message string with the <c>FATAL</c> level.
  12668. </summary>
  12669. <param name="format">A String containing zero or more format items</param>
  12670. <param name="arg0">An Object to format</param>
  12671. <remarks>
  12672. <para>
  12673. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12674. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12675. of the formatting.
  12676. </para>
  12677. <para>
  12678. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12679. format provider. To specify a localized provider use the
  12680. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  12681. </para>
  12682. <para>
  12683. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12684. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12685. methods instead.
  12686. </para>
  12687. </remarks>
  12688. </member>
  12689. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
  12690. <summary>
  12691. Logs a formatted message string with the <c>FATAL</c> level.
  12692. </summary>
  12693. <param name="format">A String containing zero or more format items</param>
  12694. <param name="arg0">An Object to format</param>
  12695. <param name="arg1">An Object to format</param>
  12696. <remarks>
  12697. <para>
  12698. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12699. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12700. of the formatting.
  12701. </para>
  12702. <para>
  12703. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12704. format provider. To specify a localized provider use the
  12705. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  12706. </para>
  12707. <para>
  12708. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12709. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12710. methods instead.
  12711. </para>
  12712. </remarks>
  12713. </member>
  12714. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  12715. <summary>
  12716. Logs a formatted message string with the <c>FATAL</c> level.
  12717. </summary>
  12718. <param name="format">A String containing zero or more format items</param>
  12719. <param name="arg0">An Object to format</param>
  12720. <param name="arg1">An Object to format</param>
  12721. <param name="arg2">An Object to format</param>
  12722. <remarks>
  12723. <para>
  12724. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12725. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12726. of the formatting.
  12727. </para>
  12728. <para>
  12729. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12730. format provider. To specify a localized provider use the
  12731. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  12732. </para>
  12733. <para>
  12734. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12735. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12736. methods instead.
  12737. </para>
  12738. </remarks>
  12739. </member>
  12740. <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  12741. <summary>
  12742. Logs a formatted message string with the <c>FATAL</c> level.
  12743. </summary>
  12744. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12745. <param name="format">A String containing zero or more format items</param>
  12746. <param name="args">An Object array containing zero or more objects to format</param>
  12747. <remarks>
  12748. <para>
  12749. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12750. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12751. of the formatting.
  12752. </para>
  12753. <para>
  12754. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12755. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12756. methods instead.
  12757. </para>
  12758. </remarks>
  12759. </member>
  12760. <member name="P:log4net.Core.LogImpl.IsDebugEnabled">
  12761. <summary>
  12762. Checks if this logger is enabled for the <c>DEBUG</c>
  12763. level.
  12764. </summary>
  12765. <value>
  12766. <c>true</c> if this logger is enabled for <c>DEBUG</c> events,
  12767. <c>false</c> otherwise.
  12768. </value>
  12769. <remarks>
  12770. <para>
  12771. This function is intended to lessen the computational cost of
  12772. disabled log debug statements.
  12773. </para>
  12774. <para>
  12775. For some <c>log</c> Logger object, when you write:
  12776. </para>
  12777. <code lang="C#">
  12778. log.Debug("This is entry number: " + i );
  12779. </code>
  12780. <para>
  12781. You incur the cost constructing the message, concatenation in
  12782. this case, regardless of whether the message is logged or not.
  12783. </para>
  12784. <para>
  12785. If you are worried about speed, then you should write:
  12786. </para>
  12787. <code lang="C#">
  12788. if (log.IsDebugEnabled())
  12789. {
  12790. log.Debug("This is entry number: " + i );
  12791. }
  12792. </code>
  12793. <para>
  12794. This way you will not incur the cost of parameter
  12795. construction if debugging is disabled for <c>log</c>. On
  12796. the other hand, if the <c>log</c> is debug enabled, you
  12797. will incur the cost of evaluating whether the logger is debug
  12798. enabled twice. Once in <c>IsDebugEnabled</c> and once in
  12799. the <c>Debug</c>. This is an insignificant overhead
  12800. since evaluating a logger takes about 1% of the time it
  12801. takes to actually log.
  12802. </para>
  12803. </remarks>
  12804. </member>
  12805. <member name="P:log4net.Core.LogImpl.IsInfoEnabled">
  12806. <summary>
  12807. Checks if this logger is enabled for the <c>INFO</c> level.
  12808. </summary>
  12809. <value>
  12810. <c>true</c> if this logger is enabled for <c>INFO</c> events,
  12811. <c>false</c> otherwise.
  12812. </value>
  12813. <remarks>
  12814. <para>
  12815. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  12816. of using this method.
  12817. </para>
  12818. </remarks>
  12819. <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  12820. </member>
  12821. <member name="P:log4net.Core.LogImpl.IsWarnEnabled">
  12822. <summary>
  12823. Checks if this logger is enabled for the <c>WARN</c> level.
  12824. </summary>
  12825. <value>
  12826. <c>true</c> if this logger is enabled for <c>WARN</c> events,
  12827. <c>false</c> otherwise.
  12828. </value>
  12829. <remarks>
  12830. <para>
  12831. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  12832. of using this method.
  12833. </para>
  12834. </remarks>
  12835. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  12836. </member>
  12837. <member name="P:log4net.Core.LogImpl.IsErrorEnabled">
  12838. <summary>
  12839. Checks if this logger is enabled for the <c>ERROR</c> level.
  12840. </summary>
  12841. <value>
  12842. <c>true</c> if this logger is enabled for <c>ERROR</c> events,
  12843. <c>false</c> otherwise.
  12844. </value>
  12845. <remarks>
  12846. <para>
  12847. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  12848. </para>
  12849. </remarks>
  12850. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  12851. </member>
  12852. <member name="P:log4net.Core.LogImpl.IsFatalEnabled">
  12853. <summary>
  12854. Checks if this logger is enabled for the <c>FATAL</c> level.
  12855. </summary>
  12856. <value>
  12857. <c>true</c> if this logger is enabled for <c>FATAL</c> events,
  12858. <c>false</c> otherwise.
  12859. </value>
  12860. <remarks>
  12861. <para>
  12862. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  12863. </para>
  12864. </remarks>
  12865. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  12866. </member>
  12867. <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
  12868. <summary>
  12869. Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
  12870. </summary>
  12871. <param name="sender">the repository</param>
  12872. <param name="e">Empty</param>
  12873. </member>
  12874. <member name="F:log4net.Core.LogImpl.ThisDeclaringType">
  12875. <summary>
  12876. The fully qualified name of this declaring type not the type of any subclass.
  12877. </summary>
  12878. </member>
  12879. <member name="T:log4net.Core.MethodItem">
  12880. <summary>
  12881. provides method information without actually referencing a System.Reflection.MethodBase
  12882. as that would require that the containing assembly is loaded.
  12883. </summary>
  12884. </member>
  12885. <member name="M:log4net.Core.MethodItem.#ctor">
  12886. <summary>
  12887. constructs a method item for an unknown method.
  12888. </summary>
  12889. </member>
  12890. <member name="M:log4net.Core.MethodItem.#ctor(System.String)">
  12891. <summary>
  12892. constructs a method item from the name of the method.
  12893. </summary>
  12894. <param name="name"></param>
  12895. </member>
  12896. <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
  12897. <summary>
  12898. constructs a method item from the name of the method and its parameters.
  12899. </summary>
  12900. <param name="name"></param>
  12901. <param name="parameters"></param>
  12902. </member>
  12903. <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
  12904. <summary>
  12905. constructs a method item from a method base by determining the method name and its parameters.
  12906. </summary>
  12907. <param name="methodBase"></param>
  12908. </member>
  12909. <member name="P:log4net.Core.MethodItem.Name">
  12910. <summary>
  12911. Gets the method name of the caller making the logging
  12912. request.
  12913. </summary>
  12914. <value>
  12915. The method name of the caller making the logging
  12916. request.
  12917. </value>
  12918. <remarks>
  12919. <para>
  12920. Gets the method name of the caller making the logging
  12921. request.
  12922. </para>
  12923. </remarks>
  12924. </member>
  12925. <member name="P:log4net.Core.MethodItem.Parameters">
  12926. <summary>
  12927. Gets the method parameters of the caller making
  12928. the logging request.
  12929. </summary>
  12930. <value>
  12931. The method parameters of the caller making
  12932. the logging request
  12933. </value>
  12934. <remarks>
  12935. <para>
  12936. Gets the method parameters of the caller making
  12937. the logging request.
  12938. </para>
  12939. </remarks>
  12940. </member>
  12941. <member name="F:log4net.Core.MethodItem.declaringType">
  12942. <summary>
  12943. The fully qualified type of the StackFrameItem class.
  12944. </summary>
  12945. <remarks>
  12946. Used by the internal logger to record the Type of the
  12947. log message.
  12948. </remarks>
  12949. </member>
  12950. <member name="F:log4net.Core.MethodItem.NA">
  12951. <summary>
  12952. When location information is not available the constant
  12953. <c>NA</c> is returned. Current value of this string
  12954. constant is <b>?</b>.
  12955. </summary>
  12956. </member>
  12957. <member name="T:log4net.Core.SecurityContext">
  12958. <summary>
  12959. A SecurityContext used by log4net when interacting with protected resources
  12960. </summary>
  12961. <remarks>
  12962. <para>
  12963. A SecurityContext used by log4net when interacting with protected resources
  12964. for example with operating system services. This can be used to impersonate
  12965. a principal that has been granted privileges on the system resources.
  12966. </para>
  12967. </remarks>
  12968. <author>Nicko Cadell</author>
  12969. </member>
  12970. <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
  12971. <summary>
  12972. Impersonate this SecurityContext
  12973. </summary>
  12974. <param name="state">State supplied by the caller</param>
  12975. <returns>An <see cref="T:System.IDisposable"/> instance that will
  12976. revoke the impersonation of this SecurityContext, or <c>null</c></returns>
  12977. <remarks>
  12978. <para>
  12979. Impersonate this security context. Further calls on the current
  12980. thread should now be made in the security context provided
  12981. by this object. When the <see cref="T:System.IDisposable"/> result
  12982. <see cref="M:System.IDisposable.Dispose"/> method is called the security
  12983. context of the thread should be reverted to the state it was in
  12984. before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
  12985. </para>
  12986. </remarks>
  12987. </member>
  12988. <member name="T:log4net.Core.SecurityContextProvider">
  12989. <summary>
  12990. The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
  12991. </summary>
  12992. <remarks>
  12993. <para>
  12994. A configured component that interacts with potentially protected system
  12995. resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
  12996. privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
  12997. been not been explicitly provided to the component then the component
  12998. will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
  12999. </para>
  13000. <para>
  13001. By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
  13002. an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
  13003. <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
  13004. where the privileges required are not know by the system.
  13005. </para>
  13006. <para>
  13007. This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
  13008. and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
  13009. the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
  13010. can be replaced by programmatically setting the value of the
  13011. <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
  13012. </para>
  13013. <para>
  13014. An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
  13015. This attribute can be applied to an assembly in the same way as the
  13016. <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
  13017. the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
  13018. </para>
  13019. </remarks>
  13020. <author>Nicko Cadell</author>
  13021. </member>
  13022. <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
  13023. <summary>
  13024. The default provider
  13025. </summary>
  13026. </member>
  13027. <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
  13028. <summary>
  13029. Gets or sets the default SecurityContextProvider
  13030. </summary>
  13031. <value>
  13032. The default SecurityContextProvider
  13033. </value>
  13034. <remarks>
  13035. <para>
  13036. The default provider is used by configured components that
  13037. require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
  13038. given to them.
  13039. </para>
  13040. <para>
  13041. By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
  13042. that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
  13043. </para>
  13044. <para>
  13045. The default provider can be set programmatically by setting
  13046. the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
  13047. that has the desired behavior.
  13048. </para>
  13049. </remarks>
  13050. </member>
  13051. <member name="M:log4net.Core.SecurityContextProvider.#ctor">
  13052. <summary>
  13053. Protected default constructor to allow subclassing
  13054. </summary>
  13055. <remarks>
  13056. <para>
  13057. Protected default constructor to allow subclassing
  13058. </para>
  13059. </remarks>
  13060. </member>
  13061. <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
  13062. <summary>
  13063. Create a SecurityContext for a consumer
  13064. </summary>
  13065. <param name="consumer">The consumer requesting the SecurityContext</param>
  13066. <returns>An impersonation context</returns>
  13067. <remarks>
  13068. <para>
  13069. The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
  13070. </para>
  13071. <para>
  13072. Subclasses should override this method to provide their own
  13073. behavior.
  13074. </para>
  13075. </remarks>
  13076. </member>
  13077. <member name="T:log4net.Core.StackFrameItem">
  13078. <summary>
  13079. provides stack frame information without actually referencing a System.Diagnostics.StackFrame
  13080. as that would require that the containing assembly is loaded.
  13081. </summary>
  13082. </member>
  13083. <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
  13084. <summary>
  13085. returns a stack frame item from a stack frame. This
  13086. </summary>
  13087. <param name="frame"></param>
  13088. <returns></returns>
  13089. </member>
  13090. <member name="P:log4net.Core.StackFrameItem.ClassName">
  13091. <summary>
  13092. Gets the fully qualified class name of the caller making the logging
  13093. request.
  13094. </summary>
  13095. <value>
  13096. The fully qualified class name of the caller making the logging
  13097. request.
  13098. </value>
  13099. <remarks>
  13100. <para>
  13101. Gets the fully qualified class name of the caller making the logging
  13102. request.
  13103. </para>
  13104. </remarks>
  13105. </member>
  13106. <member name="P:log4net.Core.StackFrameItem.FileName">
  13107. <summary>
  13108. Gets the file name of the caller.
  13109. </summary>
  13110. <value>
  13111. The file name of the caller.
  13112. </value>
  13113. <remarks>
  13114. <para>
  13115. Gets the file name of the caller.
  13116. </para>
  13117. </remarks>
  13118. </member>
  13119. <member name="P:log4net.Core.StackFrameItem.LineNumber">
  13120. <summary>
  13121. Gets the line number of the caller.
  13122. </summary>
  13123. <value>
  13124. The line number of the caller.
  13125. </value>
  13126. <remarks>
  13127. <para>
  13128. Gets the line number of the caller.
  13129. </para>
  13130. </remarks>
  13131. </member>
  13132. <member name="P:log4net.Core.StackFrameItem.Method">
  13133. <summary>
  13134. Gets the method name of the caller.
  13135. </summary>
  13136. <value>
  13137. The method name of the caller.
  13138. </value>
  13139. <remarks>
  13140. <para>
  13141. Gets the method name of the caller.
  13142. </para>
  13143. </remarks>
  13144. </member>
  13145. <member name="P:log4net.Core.StackFrameItem.FullInfo">
  13146. <summary>
  13147. Gets all available caller information
  13148. </summary>
  13149. <value>
  13150. All available caller information, in the format
  13151. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  13152. </value>
  13153. <remarks>
  13154. <para>
  13155. Gets all available caller information, in the format
  13156. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  13157. </para>
  13158. </remarks>
  13159. </member>
  13160. <member name="F:log4net.Core.StackFrameItem.declaringType">
  13161. <summary>
  13162. The fully qualified type of the StackFrameItem class.
  13163. </summary>
  13164. <remarks>
  13165. Used by the internal logger to record the Type of the
  13166. log message.
  13167. </remarks>
  13168. </member>
  13169. <member name="F:log4net.Core.StackFrameItem.NA">
  13170. <summary>
  13171. When location information is not available the constant
  13172. <c>NA</c> is returned. Current value of this string
  13173. constant is <b>?</b>.
  13174. </summary>
  13175. </member>
  13176. <member name="T:log4net.Core.TimeEvaluator">
  13177. <summary>
  13178. An evaluator that triggers after specified number of seconds.
  13179. </summary>
  13180. <remarks>
  13181. <para>
  13182. This evaluator will trigger if the specified time period
  13183. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13184. </para>
  13185. </remarks>
  13186. <author>Robert Sevcik</author>
  13187. </member>
  13188. <member name="F:log4net.Core.TimeEvaluator.m_interval">
  13189. <summary>
  13190. The time threshold for triggering in seconds. Zero means it won't trigger at all.
  13191. </summary>
  13192. </member>
  13193. <member name="F:log4net.Core.TimeEvaluator.m_lastTimeUtc">
  13194. <summary>
  13195. The UTC time of last check. This gets updated when the object is created and when the evaluator triggers.
  13196. </summary>
  13197. </member>
  13198. <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
  13199. <summary>
  13200. The default time threshold for triggering in seconds. Zero means it won't trigger at all.
  13201. </summary>
  13202. </member>
  13203. <member name="M:log4net.Core.TimeEvaluator.#ctor">
  13204. <summary>
  13205. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  13206. </summary>
  13207. <remarks>
  13208. <para>
  13209. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  13210. </para>
  13211. <para>
  13212. This evaluator will trigger if the specified time period
  13213. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13214. </para>
  13215. </remarks>
  13216. </member>
  13217. <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
  13218. <summary>
  13219. Create a new evaluator using the specified time threshold in seconds.
  13220. </summary>
  13221. <param name="interval">
  13222. The time threshold in seconds to trigger after.
  13223. Zero means it won't trigger at all.
  13224. </param>
  13225. <remarks>
  13226. <para>
  13227. Create a new evaluator using the specified time threshold in seconds.
  13228. </para>
  13229. <para>
  13230. This evaluator will trigger if the specified time period
  13231. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13232. </para>
  13233. </remarks>
  13234. </member>
  13235. <member name="P:log4net.Core.TimeEvaluator.Interval">
  13236. <summary>
  13237. The time threshold in seconds to trigger after
  13238. </summary>
  13239. <value>
  13240. The time threshold in seconds to trigger after.
  13241. Zero means it won't trigger at all.
  13242. </value>
  13243. <remarks>
  13244. <para>
  13245. This evaluator will trigger if the specified time period
  13246. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13247. </para>
  13248. </remarks>
  13249. </member>
  13250. <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  13251. <summary>
  13252. Is this <paramref name="loggingEvent"/> the triggering event?
  13253. </summary>
  13254. <param name="loggingEvent">The event to check</param>
  13255. <returns>This method returns <c>true</c>, if the specified time period
  13256. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
  13257. Otherwise it returns <c>false</c></returns>
  13258. <remarks>
  13259. <para>
  13260. This evaluator will trigger if the specified time period
  13261. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13262. </para>
  13263. </remarks>
  13264. </member>
  13265. <member name="T:log4net.Core.WrapperCreationHandler">
  13266. <summary>
  13267. Delegate used to handle creation of new wrappers.
  13268. </summary>
  13269. <param name="logger">The logger to wrap in a wrapper.</param>
  13270. <remarks>
  13271. <para>
  13272. Delegate used to handle creation of new wrappers. This delegate
  13273. is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  13274. method to construct the wrapper for the specified logger.
  13275. </para>
  13276. <para>
  13277. The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
  13278. constructor.
  13279. </para>
  13280. </remarks>
  13281. </member>
  13282. <member name="T:log4net.Core.WrapperMap">
  13283. <summary>
  13284. Maps between logger objects and wrapper objects.
  13285. </summary>
  13286. <remarks>
  13287. <para>
  13288. This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
  13289. <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
  13290. lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
  13291. </para>
  13292. <para>
  13293. New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  13294. method. The default behavior is for this method to delegate construction
  13295. of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
  13296. to the constructor. This allows specialization of the behavior without
  13297. requiring subclassing of this type.
  13298. </para>
  13299. </remarks>
  13300. <author>Nicko Cadell</author>
  13301. <author>Gert Driesen</author>
  13302. </member>
  13303. <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
  13304. <summary>
  13305. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap" />
  13306. </summary>
  13307. <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
  13308. <remarks>
  13309. <para>
  13310. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap" /> class with
  13311. the specified handler to create the wrapper objects.
  13312. </para>
  13313. </remarks>
  13314. </member>
  13315. <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
  13316. <summary>
  13317. Gets the wrapper object for the specified logger.
  13318. </summary>
  13319. <returns>The wrapper object for the specified logger</returns>
  13320. <remarks>
  13321. <para>
  13322. If the logger is null then the corresponding wrapper is null.
  13323. </para>
  13324. <para>
  13325. Looks up the wrapper it it has previously been requested and
  13326. returns it. If the wrapper has never been requested before then
  13327. the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
  13328. called.
  13329. </para>
  13330. </remarks>
  13331. </member>
  13332. <member name="P:log4net.Core.WrapperMap.Repositories">
  13333. <summary>
  13334. Gets the map of logger repositories.
  13335. </summary>
  13336. <value>
  13337. Map of logger repositories.
  13338. </value>
  13339. <remarks>
  13340. <para>
  13341. Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
  13342. values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
  13343. value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
  13344. </para>
  13345. </remarks>
  13346. </member>
  13347. <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
  13348. <summary>
  13349. Creates the wrapper object for the specified logger.
  13350. </summary>
  13351. <param name="logger">The logger to wrap in a wrapper.</param>
  13352. <returns>The wrapper object for the logger.</returns>
  13353. <remarks>
  13354. <para>
  13355. This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
  13356. passed to the constructor to create the wrapper. This method
  13357. can be overridden in a subclass.
  13358. </para>
  13359. </remarks>
  13360. </member>
  13361. <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
  13362. <summary>
  13363. Called when a monitored repository shutdown event is received.
  13364. </summary>
  13365. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
  13366. <remarks>
  13367. <para>
  13368. This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
  13369. <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
  13370. event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
  13371. behavior of this method is to release the references to the loggers
  13372. and their wrappers generated for this repository.
  13373. </para>
  13374. </remarks>
  13375. </member>
  13376. <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
  13377. <summary>
  13378. Event handler for repository shutdown event.
  13379. </summary>
  13380. <param name="sender">The sender of the event.</param>
  13381. <param name="e">The event args.</param>
  13382. </member>
  13383. <member name="F:log4net.Core.WrapperMap.m_repositories">
  13384. <summary>
  13385. Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
  13386. </summary>
  13387. </member>
  13388. <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
  13389. <summary>
  13390. The handler to use to create the extension wrapper objects.
  13391. </summary>
  13392. </member>
  13393. <member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
  13394. <summary>
  13395. Internal reference to the delegate used to register for repository shutdown events.
  13396. </summary>
  13397. </member>
  13398. <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
  13399. <summary>
  13400. Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
  13401. </summary>
  13402. <remarks>
  13403. <para>
  13404. Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  13405. </para>
  13406. </remarks>
  13407. <author>Nicko Cadell</author>
  13408. <author>Gert Driesen</author>
  13409. </member>
  13410. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  13411. <summary>
  13412. Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
  13413. </summary>
  13414. <param name="dateToFormat">The date to render into a string.</param>
  13415. <param name="buffer">The string builder to write to.</param>
  13416. <remarks>
  13417. <para>
  13418. Subclasses should override this method to render the date
  13419. into a string using a precision up to the second. This method
  13420. will be called at most once per second and the result will be
  13421. reused if it is needed again during the same second.
  13422. </para>
  13423. </remarks>
  13424. </member>
  13425. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  13426. <summary>
  13427. Renders the date into a string. Format is "HH:mm:ss,fff".
  13428. </summary>
  13429. <param name="dateToFormat">The date to render into a string.</param>
  13430. <param name="writer">The writer to write to.</param>
  13431. <remarks>
  13432. <para>
  13433. Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
  13434. time string up to the seconds and then appends the current
  13435. milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
  13436. cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
  13437. per second.
  13438. </para>
  13439. <para>
  13440. Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
  13441. rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
  13442. </para>
  13443. </remarks>
  13444. </member>
  13445. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
  13446. <summary>
  13447. String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
  13448. </summary>
  13449. </member>
  13450. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
  13451. <summary>
  13452. String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
  13453. </summary>
  13454. </member>
  13455. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
  13456. <summary>
  13457. String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
  13458. </summary>
  13459. </member>
  13460. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
  13461. <summary>
  13462. Last stored time with precision up to the second.
  13463. </summary>
  13464. </member>
  13465. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
  13466. <summary>
  13467. Last stored time with precision up to the second, formatted
  13468. as a string.
  13469. </summary>
  13470. </member>
  13471. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
  13472. <summary>
  13473. Last stored time with precision up to the second, formatted
  13474. as a string.
  13475. </summary>
  13476. </member>
  13477. <member name="T:log4net.DateFormatter.DateTimeDateFormatter">
  13478. <summary>
  13479. Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
  13480. </summary>
  13481. <remarks>
  13482. <para>
  13483. Formats a <see cref="T:System.DateTime"/> in the format
  13484. <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
  13485. <c>"06 Nov 1994 15:49:37,459"</c>.
  13486. </para>
  13487. </remarks>
  13488. <author>Nicko Cadell</author>
  13489. <author>Gert Driesen</author>
  13490. <author>Angelika Schnagl</author>
  13491. </member>
  13492. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
  13493. <summary>
  13494. Default constructor.
  13495. </summary>
  13496. <remarks>
  13497. <para>
  13498. Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter" /> class.
  13499. </para>
  13500. </remarks>
  13501. </member>
  13502. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  13503. <summary>
  13504. Formats the date without the milliseconds part
  13505. </summary>
  13506. <param name="dateToFormat">The date to format.</param>
  13507. <param name="buffer">The string builder to write to.</param>
  13508. <remarks>
  13509. <para>
  13510. Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
  13511. for example, <c>"06 Nov 1994 15:49:37"</c>.
  13512. </para>
  13513. <para>
  13514. The base class will append the <c>",fff"</c> milliseconds section.
  13515. This method will only be called at most once per second.
  13516. </para>
  13517. </remarks>
  13518. </member>
  13519. <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
  13520. <summary>
  13521. The format info for the invariant culture.
  13522. </summary>
  13523. </member>
  13524. <member name="T:log4net.DateFormatter.IDateFormatter">
  13525. <summary>
  13526. Render a <see cref="T:System.DateTime"/> as a string.
  13527. </summary>
  13528. <remarks>
  13529. <para>
  13530. Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
  13531. instance into a string.
  13532. </para>
  13533. <para>
  13534. The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
  13535. date to a text writer.
  13536. </para>
  13537. </remarks>
  13538. <author>Nicko Cadell</author>
  13539. <author>Gert Driesen</author>
  13540. </member>
  13541. <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  13542. <summary>
  13543. Formats the specified date as a string.
  13544. </summary>
  13545. <param name="dateToFormat">The date to format.</param>
  13546. <param name="writer">The writer to write to.</param>
  13547. <remarks>
  13548. <para>
  13549. Format the <see cref="T:System.DateTime"/> as a string and write it
  13550. to the <see cref="T:System.IO.TextWriter"/> provided.
  13551. </para>
  13552. </remarks>
  13553. </member>
  13554. <member name="T:log4net.DateFormatter.Iso8601DateFormatter">
  13555. <summary>
  13556. Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  13557. </summary>
  13558. <remarks>
  13559. <para>
  13560. Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  13561. </para>
  13562. </remarks>
  13563. <author>Nicko Cadell</author>
  13564. <author>Gert Driesen</author>
  13565. </member>
  13566. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
  13567. <summary>
  13568. Default constructor
  13569. </summary>
  13570. <remarks>
  13571. <para>
  13572. Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter" /> class.
  13573. </para>
  13574. </remarks>
  13575. </member>
  13576. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  13577. <summary>
  13578. Formats the date without the milliseconds part
  13579. </summary>
  13580. <param name="dateToFormat">The date to format.</param>
  13581. <param name="buffer">The string builder to write to.</param>
  13582. <remarks>
  13583. <para>
  13584. Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
  13585. </para>
  13586. <para>
  13587. The base class will append the <c>",fff"</c> milliseconds section.
  13588. This method will only be called at most once per second.
  13589. </para>
  13590. </remarks>
  13591. </member>
  13592. <member name="T:log4net.DateFormatter.SimpleDateFormatter">
  13593. <summary>
  13594. Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  13595. </summary>
  13596. <remarks>
  13597. <para>
  13598. Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  13599. </para>
  13600. </remarks>
  13601. <author>Nicko Cadell</author>
  13602. <author>Gert Driesen</author>
  13603. </member>
  13604. <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
  13605. <summary>
  13606. Constructor
  13607. </summary>
  13608. <param name="format">The format string.</param>
  13609. <remarks>
  13610. <para>
  13611. Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter" /> class
  13612. with the specified format string.
  13613. </para>
  13614. <para>
  13615. The format string must be compatible with the options
  13616. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  13617. </para>
  13618. </remarks>
  13619. </member>
  13620. <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  13621. <summary>
  13622. Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  13623. </summary>
  13624. <param name="dateToFormat">The date to convert to a string.</param>
  13625. <param name="writer">The writer to write to.</param>
  13626. <remarks>
  13627. <para>
  13628. Uses the date format string supplied to the constructor to call
  13629. the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
  13630. </para>
  13631. </remarks>
  13632. </member>
  13633. <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
  13634. <summary>
  13635. The format string used to format the <see cref="T:System.DateTime" />.
  13636. </summary>
  13637. <remarks>
  13638. <para>
  13639. The format string must be compatible with the options
  13640. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  13641. </para>
  13642. </remarks>
  13643. </member>
  13644. <member name="T:log4net.Filter.DenyAllFilter">
  13645. <summary>
  13646. This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
  13647. </summary>
  13648. <remarks>
  13649. <para>
  13650. You can add this filter to the end of a filter chain to
  13651. switch from the default "accept all unless instructed otherwise"
  13652. filtering behavior to a "deny all unless instructed otherwise"
  13653. behavior.
  13654. </para>
  13655. </remarks>
  13656. <author>Nicko Cadell</author>
  13657. <author>Gert Driesen</author>
  13658. </member>
  13659. <member name="M:log4net.Filter.DenyAllFilter.#ctor">
  13660. <summary>
  13661. Default constructor
  13662. </summary>
  13663. </member>
  13664. <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
  13665. <summary>
  13666. Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  13667. </summary>
  13668. <param name="loggingEvent">the LoggingEvent to filter</param>
  13669. <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
  13670. <remarks>
  13671. <para>
  13672. Ignores the event being logged and just returns
  13673. <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
  13674. chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
  13675. should only be used as the last filter in the chain
  13676. as any further filters will be ignored!
  13677. </para>
  13678. </remarks>
  13679. </member>
  13680. <member name="T:log4net.Filter.FilterDecision">
  13681. <summary>
  13682. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  13683. </summary>
  13684. <remarks>
  13685. <para>
  13686. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  13687. </para>
  13688. </remarks>
  13689. </member>
  13690. <member name="F:log4net.Filter.FilterDecision.Deny">
  13691. <summary>
  13692. The log event must be dropped immediately without
  13693. consulting with the remaining filters, if any, in the chain.
  13694. </summary>
  13695. </member>
  13696. <member name="F:log4net.Filter.FilterDecision.Neutral">
  13697. <summary>
  13698. This filter is neutral with respect to the log event.
  13699. The remaining filters, if any, should be consulted for a final decision.
  13700. </summary>
  13701. </member>
  13702. <member name="F:log4net.Filter.FilterDecision.Accept">
  13703. <summary>
  13704. The log event must be logged immediately without
  13705. consulting with the remaining filters, if any, in the chain.
  13706. </summary>
  13707. </member>
  13708. <member name="T:log4net.Filter.FilterSkeleton">
  13709. <summary>
  13710. Subclass this type to implement customized logging event filtering
  13711. </summary>
  13712. <remarks>
  13713. <para>
  13714. Users should extend this class to implement customized logging
  13715. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  13716. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  13717. appenders, have built-in filtering rules. It is suggested that you
  13718. first use and understand the built-in rules before rushing to write
  13719. your own custom filters.
  13720. </para>
  13721. <para>
  13722. This abstract class assumes and also imposes that filters be
  13723. organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
  13724. method of each filter is called sequentially, in the order of their
  13725. addition to the chain.
  13726. </para>
  13727. <para>
  13728. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
  13729. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  13730. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  13731. </para>
  13732. <para>
  13733. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  13734. immediately without consulting with the remaining filters.
  13735. </para>
  13736. <para>
  13737. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  13738. in the chain is consulted. If there are no more filters in the
  13739. chain, then the log event is logged. Thus, in the presence of no
  13740. filters, the default behavior is to log all logging events.
  13741. </para>
  13742. <para>
  13743. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  13744. event is logged without consulting the remaining filters.
  13745. </para>
  13746. <para>
  13747. The philosophy of log4net filters is largely inspired from the
  13748. Linux ipchains.
  13749. </para>
  13750. </remarks>
  13751. <author>Nicko Cadell</author>
  13752. <author>Gert Driesen</author>
  13753. </member>
  13754. <member name="F:log4net.Filter.FilterSkeleton.m_next">
  13755. <summary>
  13756. Points to the next filter in the filter chain.
  13757. </summary>
  13758. <remarks>
  13759. <para>
  13760. See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
  13761. </para>
  13762. </remarks>
  13763. </member>
  13764. <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
  13765. <summary>
  13766. Initialize the filter with the options set
  13767. </summary>
  13768. <remarks>
  13769. <para>
  13770. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  13771. activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
  13772. be called on this object after the configuration properties have
  13773. been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
  13774. object is in an undefined state and must not be used.
  13775. </para>
  13776. <para>
  13777. If any of the configuration properties are modified then
  13778. <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
  13779. </para>
  13780. <para>
  13781. Typically filter's options become active immediately on set,
  13782. however this method must still be called.
  13783. </para>
  13784. </remarks>
  13785. </member>
  13786. <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
  13787. <summary>
  13788. Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
  13789. </summary>
  13790. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
  13791. <returns>The decision of the filter</returns>
  13792. <remarks>
  13793. <para>
  13794. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  13795. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  13796. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  13797. the event will be logged without consulting with other filters in
  13798. the chain.
  13799. </para>
  13800. <para>
  13801. This method is marked <c>abstract</c> and must be implemented
  13802. in a subclass.
  13803. </para>
  13804. </remarks>
  13805. </member>
  13806. <member name="P:log4net.Filter.FilterSkeleton.Next">
  13807. <summary>
  13808. Property to get and set the next filter
  13809. </summary>
  13810. <value>
  13811. The next filter in the chain
  13812. </value>
  13813. <remarks>
  13814. <para>
  13815. Filters are typically composed into chains. This property allows the next filter in
  13816. the chain to be accessed.
  13817. </para>
  13818. </remarks>
  13819. </member>
  13820. <member name="T:log4net.Filter.IFilter">
  13821. <summary>
  13822. Implement this interface to provide customized logging event filtering
  13823. </summary>
  13824. <remarks>
  13825. <para>
  13826. Users should implement this interface to implement customized logging
  13827. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  13828. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  13829. appenders, have built-in filtering rules. It is suggested that you
  13830. first use and understand the built-in rules before rushing to write
  13831. your own custom filters.
  13832. </para>
  13833. <para>
  13834. This abstract class assumes and also imposes that filters be
  13835. organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  13836. method of each filter is called sequentially, in the order of their
  13837. addition to the chain.
  13838. </para>
  13839. <para>
  13840. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
  13841. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  13842. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  13843. </para>
  13844. <para>
  13845. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  13846. immediately without consulting with the remaining filters.
  13847. </para>
  13848. <para>
  13849. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  13850. in the chain is consulted. If there are no more filters in the
  13851. chain, then the log event is logged. Thus, in the presence of no
  13852. filters, the default behavior is to log all logging events.
  13853. </para>
  13854. <para>
  13855. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  13856. event is logged without consulting the remaining filters.
  13857. </para>
  13858. <para>
  13859. The philosophy of log4net filters is largely inspired from the
  13860. Linux ipchains.
  13861. </para>
  13862. </remarks>
  13863. <author>Nicko Cadell</author>
  13864. <author>Gert Driesen</author>
  13865. </member>
  13866. <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
  13867. <summary>
  13868. Decide if the logging event should be logged through an appender.
  13869. </summary>
  13870. <param name="loggingEvent">The LoggingEvent to decide upon</param>
  13871. <returns>The decision of the filter</returns>
  13872. <remarks>
  13873. <para>
  13874. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  13875. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  13876. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  13877. the event will be logged without consulting with other filters in
  13878. the chain.
  13879. </para>
  13880. </remarks>
  13881. </member>
  13882. <member name="P:log4net.Filter.IFilter.Next">
  13883. <summary>
  13884. Property to get and set the next filter
  13885. </summary>
  13886. <value>
  13887. The next filter in the chain
  13888. </value>
  13889. <remarks>
  13890. <para>
  13891. Filters are typically composed into chains. This property allows the next filter in
  13892. the chain to be accessed.
  13893. </para>
  13894. </remarks>
  13895. </member>
  13896. <member name="T:log4net.Filter.LevelMatchFilter">
  13897. <summary>
  13898. This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  13899. </summary>
  13900. <remarks>
  13901. <para>
  13902. The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
  13903. <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
  13904. of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
  13905. <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
  13906. case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
  13907. to <c>true</c>, if it is <c>false</c> then
  13908. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
  13909. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  13910. </para>
  13911. </remarks>
  13912. <author>Nicko Cadell</author>
  13913. <author>Gert Driesen</author>
  13914. </member>
  13915. <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
  13916. <summary>
  13917. flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
  13918. </summary>
  13919. </member>
  13920. <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
  13921. <summary>
  13922. the <see cref="T:log4net.Core.Level"/> to match against
  13923. </summary>
  13924. </member>
  13925. <member name="M:log4net.Filter.LevelMatchFilter.#ctor">
  13926. <summary>
  13927. Default constructor
  13928. </summary>
  13929. </member>
  13930. <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
  13931. <summary>
  13932. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
  13933. </summary>
  13934. <remarks>
  13935. <para>
  13936. The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
  13937. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  13938. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  13939. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  13940. </para>
  13941. <para>
  13942. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  13943. </para>
  13944. </remarks>
  13945. </member>
  13946. <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
  13947. <summary>
  13948. The <see cref="T:log4net.Core.Level"/> that the filter will match
  13949. </summary>
  13950. <remarks>
  13951. <para>
  13952. The level that this filter will attempt to match against the
  13953. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  13954. the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
  13955. </para>
  13956. </remarks>
  13957. </member>
  13958. <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
  13959. <summary>
  13960. Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
  13961. </summary>
  13962. <param name="loggingEvent">the event to filter</param>
  13963. <returns>see remarks</returns>
  13964. <remarks>
  13965. <para>
  13966. If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
  13967. filter then the result of the function depends on the
  13968. value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
  13969. the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
  13970. will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
  13971. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  13972. </para>
  13973. </remarks>
  13974. </member>
  13975. <member name="T:log4net.Filter.LevelRangeFilter">
  13976. <summary>
  13977. This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  13978. </summary>
  13979. <remarks>
  13980. <para>
  13981. The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  13982. that determine the range of priorities that are matched, and
  13983. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
  13984. of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
  13985. <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"/>
  13986. option value is set to <c>true</c>, if it is <c>false</c>
  13987. then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  13988. </para>
  13989. </remarks>
  13990. <author>Nicko Cadell</author>
  13991. <author>Gert Driesen</author>
  13992. </member>
  13993. <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
  13994. <summary>
  13995. Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
  13996. </summary>
  13997. </member>
  13998. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
  13999. <summary>
  14000. the minimum <see cref="T:log4net.Core.Level"/> value to match
  14001. </summary>
  14002. </member>
  14003. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
  14004. <summary>
  14005. the maximum <see cref="T:log4net.Core.Level"/> value to match
  14006. </summary>
  14007. </member>
  14008. <member name="M:log4net.Filter.LevelRangeFilter.#ctor">
  14009. <summary>
  14010. Default constructor
  14011. </summary>
  14012. </member>
  14013. <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
  14014. <summary>
  14015. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  14016. </summary>
  14017. <remarks>
  14018. <para>
  14019. The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
  14020. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  14021. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  14022. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  14023. </para>
  14024. <para>
  14025. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  14026. </para>
  14027. </remarks>
  14028. </member>
  14029. <member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
  14030. <summary>
  14031. Set the minimum matched <see cref="T:log4net.Core.Level"/>
  14032. </summary>
  14033. <remarks>
  14034. <para>
  14035. The minimum level that this filter will attempt to match against the
  14036. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  14037. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  14038. </para>
  14039. </remarks>
  14040. </member>
  14041. <member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
  14042. <summary>
  14043. Sets the maximum matched <see cref="T:log4net.Core.Level"/>
  14044. </summary>
  14045. <remarks>
  14046. <para>
  14047. The maximum level that this filter will attempt to match against the
  14048. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  14049. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  14050. </para>
  14051. </remarks>
  14052. </member>
  14053. <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
  14054. <summary>
  14055. Check if the event should be logged.
  14056. </summary>
  14057. <param name="loggingEvent">the logging event to check</param>
  14058. <returns>see remarks</returns>
  14059. <remarks>
  14060. <para>
  14061. If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
  14062. matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  14063. is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
  14064. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
  14065. <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
  14066. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
  14067. </para>
  14068. </remarks>
  14069. </member>
  14070. <member name="T:log4net.Filter.LoggerMatchFilter">
  14071. <summary>
  14072. Simple filter to match a string in the event's logger name.
  14073. </summary>
  14074. <remarks>
  14075. <para>
  14076. The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
  14077. options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
  14078. <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
  14079. with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
  14080. <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
  14081. case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
  14082. if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  14083. </para>
  14084. </remarks>
  14085. <author>Daniel Cazzulino</author>
  14086. </member>
  14087. <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
  14088. <summary>
  14089. Flag to indicate the behavior when we have a match
  14090. </summary>
  14091. </member>
  14092. <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
  14093. <summary>
  14094. The logger name string to substring match against the event
  14095. </summary>
  14096. </member>
  14097. <member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
  14098. <summary>
  14099. Default constructor
  14100. </summary>
  14101. </member>
  14102. <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
  14103. <summary>
  14104. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
  14105. </summary>
  14106. <remarks>
  14107. <para>
  14108. The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
  14109. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  14110. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  14111. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  14112. </para>
  14113. <para>
  14114. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  14115. </para>
  14116. </remarks>
  14117. </member>
  14118. <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
  14119. <summary>
  14120. The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
  14121. </summary>
  14122. <remarks>
  14123. <para>
  14124. This filter will attempt to match this value against logger name in
  14125. the following way. The match will be done against the beginning of the
  14126. logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
  14127. case sensitive. If a match is found then
  14128. the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
  14129. </para>
  14130. </remarks>
  14131. </member>
  14132. <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
  14133. <summary>
  14134. Check if this filter should allow the event to be logged
  14135. </summary>
  14136. <param name="loggingEvent">the event being logged</param>
  14137. <returns>see remarks</returns>
  14138. <remarks>
  14139. <para>
  14140. The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
  14141. If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
  14142. the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
  14143. then a match will have occurred. If no match occurs
  14144. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  14145. allowing other filters to check the event. If a match occurs then
  14146. the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
  14147. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  14148. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  14149. </para>
  14150. </remarks>
  14151. </member>
  14152. <member name="T:log4net.Filter.MdcFilter">
  14153. <summary>
  14154. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  14155. </summary>
  14156. <remarks>
  14157. <para>
  14158. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  14159. </para>
  14160. <para>
  14161. As the MDC has been replaced with layered properties the
  14162. <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
  14163. </para>
  14164. </remarks>
  14165. <author>Nicko Cadell</author>
  14166. <author>Gert Driesen</author>
  14167. </member>
  14168. <member name="T:log4net.Filter.NdcFilter">
  14169. <summary>
  14170. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  14171. </summary>
  14172. <remarks>
  14173. <para>
  14174. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  14175. </para>
  14176. <para>
  14177. As the MDC has been replaced with named stacks stored in the
  14178. properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
  14179. be used instead.
  14180. </para>
  14181. </remarks>
  14182. <author>Nicko Cadell</author>
  14183. <author>Gert Driesen</author>
  14184. </member>
  14185. <member name="M:log4net.Filter.NdcFilter.#ctor">
  14186. <summary>
  14187. Default constructor
  14188. </summary>
  14189. <remarks>
  14190. <para>
  14191. Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
  14192. </para>
  14193. </remarks>
  14194. </member>
  14195. <member name="T:log4net.Filter.PropertyFilter">
  14196. <summary>
  14197. Simple filter to match a string an event property
  14198. </summary>
  14199. <remarks>
  14200. <para>
  14201. Simple filter to match a string in the value for a
  14202. specific event property
  14203. </para>
  14204. </remarks>
  14205. <author>Nicko Cadell</author>
  14206. </member>
  14207. <member name="F:log4net.Filter.PropertyFilter.m_key">
  14208. <summary>
  14209. The key to use to lookup the string from the event properties
  14210. </summary>
  14211. </member>
  14212. <member name="M:log4net.Filter.PropertyFilter.#ctor">
  14213. <summary>
  14214. Default constructor
  14215. </summary>
  14216. </member>
  14217. <member name="P:log4net.Filter.PropertyFilter.Key">
  14218. <summary>
  14219. The key to lookup in the event properties and then match against.
  14220. </summary>
  14221. <remarks>
  14222. <para>
  14223. The key name to use to lookup in the properties map of the
  14224. <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
  14225. the value of this property if it exists.
  14226. </para>
  14227. </remarks>
  14228. </member>
  14229. <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
  14230. <summary>
  14231. Check if this filter should allow the event to be logged
  14232. </summary>
  14233. <param name="loggingEvent">the event being logged</param>
  14234. <returns>see remarks</returns>
  14235. <remarks>
  14236. <para>
  14237. The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
  14238. the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  14239. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  14240. the property value then a match will have occurred. If no match occurs
  14241. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  14242. allowing other filters to check the event. If a match occurs then
  14243. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  14244. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  14245. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  14246. </para>
  14247. </remarks>
  14248. </member>
  14249. <member name="T:log4net.Filter.StringMatchFilter">
  14250. <summary>
  14251. Simple filter to match a string in the rendered message
  14252. </summary>
  14253. <remarks>
  14254. <para>
  14255. Simple filter to match a string in the rendered message
  14256. </para>
  14257. </remarks>
  14258. <author>Nicko Cadell</author>
  14259. <author>Gert Driesen</author>
  14260. </member>
  14261. <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
  14262. <summary>
  14263. Flag to indicate the behavior when we have a match
  14264. </summary>
  14265. </member>
  14266. <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
  14267. <summary>
  14268. The string to substring match against the message
  14269. </summary>
  14270. </member>
  14271. <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
  14272. <summary>
  14273. A string regex to match
  14274. </summary>
  14275. </member>
  14276. <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
  14277. <summary>
  14278. A regex object to match (generated from m_stringRegexToMatch)
  14279. </summary>
  14280. </member>
  14281. <member name="M:log4net.Filter.StringMatchFilter.#ctor">
  14282. <summary>
  14283. Default constructor
  14284. </summary>
  14285. </member>
  14286. <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
  14287. <summary>
  14288. Initialize and precompile the Regex if required
  14289. </summary>
  14290. <remarks>
  14291. <para>
  14292. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  14293. activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
  14294. be called on this object after the configuration properties have
  14295. been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
  14296. object is in an undefined state and must not be used.
  14297. </para>
  14298. <para>
  14299. If any of the configuration properties are modified then
  14300. <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
  14301. </para>
  14302. </remarks>
  14303. </member>
  14304. <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
  14305. <summary>
  14306. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  14307. </summary>
  14308. <remarks>
  14309. <para>
  14310. The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
  14311. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  14312. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  14313. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  14314. </para>
  14315. <para>
  14316. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  14317. </para>
  14318. </remarks>
  14319. </member>
  14320. <member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
  14321. <summary>
  14322. Sets the static string to match
  14323. </summary>
  14324. <remarks>
  14325. <para>
  14326. The string that will be substring matched against
  14327. the rendered message. If the message contains this
  14328. string then the filter will match. If a match is found then
  14329. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  14330. </para>
  14331. <para>
  14332. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  14333. must be specified.
  14334. </para>
  14335. </remarks>
  14336. </member>
  14337. <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
  14338. <summary>
  14339. Sets the regular expression to match
  14340. </summary>
  14341. <remarks>
  14342. <para>
  14343. The regular expression pattern that will be matched against
  14344. the rendered message. If the message matches this
  14345. pattern then the filter will match. If a match is found then
  14346. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  14347. </para>
  14348. <para>
  14349. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  14350. must be specified.
  14351. </para>
  14352. </remarks>
  14353. </member>
  14354. <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
  14355. <summary>
  14356. Check if this filter should allow the event to be logged
  14357. </summary>
  14358. <param name="loggingEvent">the event being logged</param>
  14359. <returns>see remarks</returns>
  14360. <remarks>
  14361. <para>
  14362. The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  14363. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  14364. the message then a match will have occurred. If no match occurs
  14365. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  14366. allowing other filters to check the event. If a match occurs then
  14367. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  14368. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  14369. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  14370. </para>
  14371. </remarks>
  14372. </member>
  14373. <member name="T:log4net.GlobalContext">
  14374. <summary>
  14375. The log4net Global Context.
  14376. </summary>
  14377. <remarks>
  14378. <para>
  14379. The <c>GlobalContext</c> provides a location for global debugging
  14380. information to be stored.
  14381. </para>
  14382. <para>
  14383. The global context has a properties map and these properties can
  14384. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  14385. supports selecting and outputing these properties.
  14386. </para>
  14387. <para>
  14388. By default the <c>log4net:HostName</c> property is set to the name of
  14389. the current machine.
  14390. </para>
  14391. </remarks>
  14392. <example>
  14393. <code lang="C#">
  14394. GlobalContext.Properties["hostname"] = Environment.MachineName;
  14395. </code>
  14396. </example>
  14397. <threadsafety static="true" instance="true" />
  14398. <author>Nicko Cadell</author>
  14399. </member>
  14400. <member name="M:log4net.GlobalContext.#ctor">
  14401. <summary>
  14402. Private Constructor.
  14403. </summary>
  14404. <remarks>
  14405. Uses a private access modifier to prevent instantiation of this class.
  14406. </remarks>
  14407. </member>
  14408. <member name="P:log4net.GlobalContext.Properties">
  14409. <summary>
  14410. The global properties map.
  14411. </summary>
  14412. <value>
  14413. The global properties map.
  14414. </value>
  14415. <remarks>
  14416. <para>
  14417. The global properties map.
  14418. </para>
  14419. </remarks>
  14420. </member>
  14421. <member name="F:log4net.GlobalContext.s_properties">
  14422. <summary>
  14423. The global context properties instance
  14424. </summary>
  14425. </member>
  14426. <member name="T:log4net.ILog">
  14427. <summary>
  14428. The ILog interface is use by application to log messages into
  14429. the log4net framework.
  14430. </summary>
  14431. <remarks>
  14432. <para>
  14433. Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
  14434. that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
  14435. static method is used to get logger instances.
  14436. </para>
  14437. <para>
  14438. This class contains methods for logging at different levels and also
  14439. has properties for determining if those logging levels are
  14440. enabled in the current configuration.
  14441. </para>
  14442. <para>
  14443. This interface can be implemented in different ways. This documentation
  14444. specifies reasonable behavior that a caller can expect from the actual
  14445. implementation, however different implementations reserve the right to
  14446. do things differently.
  14447. </para>
  14448. </remarks>
  14449. <example>Simple example of logging messages
  14450. <code lang="C#">
  14451. ILog log = LogManager.GetLogger("application-log");
  14452. log.Info("Application Start");
  14453. log.Debug("This is a debug message");
  14454. if (log.IsDebugEnabled)
  14455. {
  14456. log.Debug("This is another debug message");
  14457. }
  14458. </code>
  14459. </example>
  14460. <seealso cref="T:log4net.LogManager"/>
  14461. <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
  14462. <author>Nicko Cadell</author>
  14463. <author>Gert Driesen</author>
  14464. </member>
  14465. <member name="M:log4net.ILog.Debug(System.Object)">
  14466. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  14467. <summary>
  14468. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14469. </summary>
  14470. <param name="message">The message object to log.</param>
  14471. <remarks>
  14472. <para>
  14473. This method first checks if this logger is <c>DEBUG</c>
  14474. enabled by comparing the level of this logger with the
  14475. <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
  14476. <c>DEBUG</c> enabled, then it converts the message object
  14477. (passed as parameter) to a string by invoking the appropriate
  14478. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14479. proceeds to call all the registered appenders in this logger
  14480. and also higher in the hierarchy depending on the value of
  14481. the additivity flag.
  14482. </para>
  14483. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14484. to this method will print the name of the <see cref="T:System.Exception"/>
  14485. but no stack trace. To print a stack trace use the
  14486. <see cref="M:Debug(object,Exception)"/> form instead.
  14487. </para>
  14488. </remarks>
  14489. <seealso cref="M:Debug(object,Exception)"/>
  14490. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14491. </member>
  14492. <member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
  14493. <summary>
  14494. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  14495. the stack trace of the <see cref="T:System.Exception"/> passed
  14496. as a parameter.
  14497. </summary>
  14498. <param name="message">The message object to log.</param>
  14499. <param name="exception">The exception to log, including its stack trace.</param>
  14500. <remarks>
  14501. <para>
  14502. See the <see cref="M:Debug(object)"/> form for more detailed information.
  14503. </para>
  14504. </remarks>
  14505. <seealso cref="M:Debug(object)"/>
  14506. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14507. </member>
  14508. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
  14509. <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  14510. <summary>
  14511. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14512. </summary>
  14513. <param name="format">A String containing zero or more format items</param>
  14514. <param name="args">An Object array containing zero or more objects to format</param>
  14515. <remarks>
  14516. <para>
  14517. The message is formatted using the <c>String.Format</c> method. See
  14518. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14519. of the formatting.
  14520. </para>
  14521. <para>
  14522. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14523. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14524. methods instead.
  14525. </para>
  14526. </remarks>
  14527. <seealso cref="M:Debug(object)"/>
  14528. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14529. </member>
  14530. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
  14531. <summary>
  14532. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14533. </summary>
  14534. <param name="format">A String containing zero or more format items</param>
  14535. <param name="arg0">An Object to format</param>
  14536. <remarks>
  14537. <para>
  14538. The message is formatted using the <c>String.Format</c> method. See
  14539. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14540. of the formatting.
  14541. </para>
  14542. <para>
  14543. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14544. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14545. methods instead.
  14546. </para>
  14547. </remarks>
  14548. <seealso cref="M:Debug(object)"/>
  14549. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14550. </member>
  14551. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
  14552. <summary>
  14553. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14554. </summary>
  14555. <param name="format">A String containing zero or more format items</param>
  14556. <param name="arg0">An Object to format</param>
  14557. <param name="arg1">An Object to format</param>
  14558. <remarks>
  14559. <para>
  14560. The message is formatted using the <c>String.Format</c> method. See
  14561. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14562. of the formatting.
  14563. </para>
  14564. <para>
  14565. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14566. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14567. methods instead.
  14568. </para>
  14569. </remarks>
  14570. <seealso cref="M:Debug(object)"/>
  14571. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14572. </member>
  14573. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  14574. <summary>
  14575. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14576. </summary>
  14577. <param name="format">A String containing zero or more format items</param>
  14578. <param name="arg0">An Object to format</param>
  14579. <param name="arg1">An Object to format</param>
  14580. <param name="arg2">An Object to format</param>
  14581. <remarks>
  14582. <para>
  14583. The message is formatted using the <c>String.Format</c> method. See
  14584. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14585. of the formatting.
  14586. </para>
  14587. <para>
  14588. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14589. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14590. methods instead.
  14591. </para>
  14592. </remarks>
  14593. <seealso cref="M:Debug(object)"/>
  14594. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14595. </member>
  14596. <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  14597. <summary>
  14598. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14599. </summary>
  14600. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14601. <param name="format">A String containing zero or more format items</param>
  14602. <param name="args">An Object array containing zero or more objects to format</param>
  14603. <remarks>
  14604. <para>
  14605. The message is formatted using the <c>String.Format</c> method. See
  14606. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14607. of the formatting.
  14608. </para>
  14609. <para>
  14610. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14611. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14612. methods instead.
  14613. </para>
  14614. </remarks>
  14615. <seealso cref="M:Debug(object)"/>
  14616. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14617. </member>
  14618. <member name="M:log4net.ILog.Info(System.Object)">
  14619. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  14620. <summary>
  14621. Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  14622. </summary>
  14623. <remarks>
  14624. <para>
  14625. This method first checks if this logger is <c>INFO</c>
  14626. enabled by comparing the level of this logger with the
  14627. <see cref="F:log4net.Core.Level.Info"/> level. If this logger is
  14628. <c>INFO</c> enabled, then it converts the message object
  14629. (passed as parameter) to a string by invoking the appropriate
  14630. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14631. proceeds to call all the registered appenders in this logger
  14632. and also higher in the hierarchy depending on the value of the
  14633. additivity flag.
  14634. </para>
  14635. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14636. to this method will print the name of the <see cref="T:System.Exception"/>
  14637. but no stack trace. To print a stack trace use the
  14638. <see cref="M:Info(object,Exception)"/> form instead.
  14639. </para>
  14640. </remarks>
  14641. <param name="message">The message object to log.</param>
  14642. <seealso cref="M:Info(object,Exception)"/>
  14643. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14644. </member>
  14645. <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
  14646. <summary>
  14647. Logs a message object with the <c>INFO</c> level including
  14648. the stack trace of the <see cref="T:System.Exception"/> passed
  14649. as a parameter.
  14650. </summary>
  14651. <param name="message">The message object to log.</param>
  14652. <param name="exception">The exception to log, including its stack trace.</param>
  14653. <remarks>
  14654. <para>
  14655. See the <see cref="M:Info(object)"/> form for more detailed information.
  14656. </para>
  14657. </remarks>
  14658. <seealso cref="M:Info(object)"/>
  14659. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14660. </member>
  14661. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
  14662. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  14663. <summary>
  14664. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14665. </summary>
  14666. <param name="format">A String containing zero or more format items</param>
  14667. <param name="args">An Object array containing zero or more objects to format</param>
  14668. <remarks>
  14669. <para>
  14670. The message is formatted using the <c>String.Format</c> method. See
  14671. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14672. of the formatting.
  14673. </para>
  14674. <para>
  14675. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14676. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14677. methods instead.
  14678. </para>
  14679. </remarks>
  14680. <seealso cref="M:Info(object,Exception)"/>
  14681. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14682. </member>
  14683. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
  14684. <summary>
  14685. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14686. </summary>
  14687. <param name="format">A String containing zero or more format items</param>
  14688. <param name="arg0">An Object to format</param>
  14689. <remarks>
  14690. <para>
  14691. The message is formatted using the <c>String.Format</c> method. See
  14692. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14693. of the formatting.
  14694. </para>
  14695. <para>
  14696. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14697. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14698. methods instead.
  14699. </para>
  14700. </remarks>
  14701. <seealso cref="M:Info(object)"/>
  14702. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14703. </member>
  14704. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
  14705. <summary>
  14706. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14707. </summary>
  14708. <param name="format">A String containing zero or more format items</param>
  14709. <param name="arg0">An Object to format</param>
  14710. <param name="arg1">An Object to format</param>
  14711. <remarks>
  14712. <para>
  14713. The message is formatted using the <c>String.Format</c> method. See
  14714. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14715. of the formatting.
  14716. </para>
  14717. <para>
  14718. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14719. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14720. methods instead.
  14721. </para>
  14722. </remarks>
  14723. <seealso cref="M:Info(object)"/>
  14724. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14725. </member>
  14726. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  14727. <summary>
  14728. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14729. </summary>
  14730. <param name="format">A String containing zero or more format items</param>
  14731. <param name="arg0">An Object to format</param>
  14732. <param name="arg1">An Object to format</param>
  14733. <param name="arg2">An Object to format</param>
  14734. <remarks>
  14735. <para>
  14736. The message is formatted using the <c>String.Format</c> method. See
  14737. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14738. of the formatting.
  14739. </para>
  14740. <para>
  14741. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14742. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14743. methods instead.
  14744. </para>
  14745. </remarks>
  14746. <seealso cref="M:Info(object)"/>
  14747. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14748. </member>
  14749. <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  14750. <summary>
  14751. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14752. </summary>
  14753. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14754. <param name="format">A String containing zero or more format items</param>
  14755. <param name="args">An Object array containing zero or more objects to format</param>
  14756. <remarks>
  14757. <para>
  14758. The message is formatted using the <c>String.Format</c> method. See
  14759. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14760. of the formatting.
  14761. </para>
  14762. <para>
  14763. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14764. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14765. methods instead.
  14766. </para>
  14767. </remarks>
  14768. <seealso cref="M:Info(object,Exception)"/>
  14769. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14770. </member>
  14771. <member name="M:log4net.ILog.Warn(System.Object)">
  14772. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  14773. <summary>
  14774. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14775. </summary>
  14776. <remarks>
  14777. <para>
  14778. This method first checks if this logger is <c>WARN</c>
  14779. enabled by comparing the level of this logger with the
  14780. <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
  14781. <c>WARN</c> enabled, then it converts the message object
  14782. (passed as parameter) to a string by invoking the appropriate
  14783. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14784. proceeds to call all the registered appenders in this logger
  14785. and also higher in the hierarchy depending on the value of the
  14786. additivity flag.
  14787. </para>
  14788. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14789. to this method will print the name of the <see cref="T:System.Exception"/>
  14790. but no stack trace. To print a stack trace use the
  14791. <see cref="M:Warn(object,Exception)"/> form instead.
  14792. </para>
  14793. </remarks>
  14794. <param name="message">The message object to log.</param>
  14795. <seealso cref="M:Warn(object,Exception)"/>
  14796. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14797. </member>
  14798. <member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
  14799. <summary>
  14800. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  14801. the stack trace of the <see cref="T:System.Exception"/> passed
  14802. as a parameter.
  14803. </summary>
  14804. <param name="message">The message object to log.</param>
  14805. <param name="exception">The exception to log, including its stack trace.</param>
  14806. <remarks>
  14807. <para>
  14808. See the <see cref="M:Warn(object)"/> form for more detailed information.
  14809. </para>
  14810. </remarks>
  14811. <seealso cref="M:Warn(object)"/>
  14812. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14813. </member>
  14814. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
  14815. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  14816. <summary>
  14817. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14818. </summary>
  14819. <param name="format">A String containing zero or more format items</param>
  14820. <param name="args">An Object array containing zero or more objects to format</param>
  14821. <remarks>
  14822. <para>
  14823. The message is formatted using the <c>String.Format</c> method. See
  14824. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14825. of the formatting.
  14826. </para>
  14827. <para>
  14828. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14829. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14830. methods instead.
  14831. </para>
  14832. </remarks>
  14833. <seealso cref="M:Warn(object,Exception)"/>
  14834. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14835. </member>
  14836. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
  14837. <summary>
  14838. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14839. </summary>
  14840. <param name="format">A String containing zero or more format items</param>
  14841. <param name="arg0">An Object to format</param>
  14842. <remarks>
  14843. <para>
  14844. The message is formatted using the <c>String.Format</c> method. See
  14845. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14846. of the formatting.
  14847. </para>
  14848. <para>
  14849. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14850. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14851. methods instead.
  14852. </para>
  14853. </remarks>
  14854. <seealso cref="M:Warn(object)"/>
  14855. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14856. </member>
  14857. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
  14858. <summary>
  14859. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14860. </summary>
  14861. <param name="format">A String containing zero or more format items</param>
  14862. <param name="arg0">An Object to format</param>
  14863. <param name="arg1">An Object to format</param>
  14864. <remarks>
  14865. <para>
  14866. The message is formatted using the <c>String.Format</c> method. See
  14867. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14868. of the formatting.
  14869. </para>
  14870. <para>
  14871. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14872. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14873. methods instead.
  14874. </para>
  14875. </remarks>
  14876. <seealso cref="M:Warn(object)"/>
  14877. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14878. </member>
  14879. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  14880. <summary>
  14881. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14882. </summary>
  14883. <param name="format">A String containing zero or more format items</param>
  14884. <param name="arg0">An Object to format</param>
  14885. <param name="arg1">An Object to format</param>
  14886. <param name="arg2">An Object to format</param>
  14887. <remarks>
  14888. <para>
  14889. The message is formatted using the <c>String.Format</c> method. See
  14890. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14891. of the formatting.
  14892. </para>
  14893. <para>
  14894. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14895. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14896. methods instead.
  14897. </para>
  14898. </remarks>
  14899. <seealso cref="M:Warn(object)"/>
  14900. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14901. </member>
  14902. <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  14903. <summary>
  14904. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14905. </summary>
  14906. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14907. <param name="format">A String containing zero or more format items</param>
  14908. <param name="args">An Object array containing zero or more objects to format</param>
  14909. <remarks>
  14910. <para>
  14911. The message is formatted using the <c>String.Format</c> method. See
  14912. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14913. of the formatting.
  14914. </para>
  14915. <para>
  14916. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14917. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14918. methods instead.
  14919. </para>
  14920. </remarks>
  14921. <seealso cref="M:Warn(object,Exception)"/>
  14922. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14923. </member>
  14924. <member name="M:log4net.ILog.Error(System.Object)">
  14925. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  14926. <summary>
  14927. Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  14928. </summary>
  14929. <param name="message">The message object to log.</param>
  14930. <remarks>
  14931. <para>
  14932. This method first checks if this logger is <c>ERROR</c>
  14933. enabled by comparing the level of this logger with the
  14934. <see cref="F:log4net.Core.Level.Error"/> level. If this logger is
  14935. <c>ERROR</c> enabled, then it converts the message object
  14936. (passed as parameter) to a string by invoking the appropriate
  14937. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14938. proceeds to call all the registered appenders in this logger
  14939. and also higher in the hierarchy depending on the value of the
  14940. additivity flag.
  14941. </para>
  14942. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14943. to this method will print the name of the <see cref="T:System.Exception"/>
  14944. but no stack trace. To print a stack trace use the
  14945. <see cref="M:Error(object,Exception)"/> form instead.
  14946. </para>
  14947. </remarks>
  14948. <seealso cref="M:Error(object,Exception)"/>
  14949. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14950. </member>
  14951. <member name="M:log4net.ILog.Error(System.Object,System.Exception)">
  14952. <summary>
  14953. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  14954. the stack trace of the <see cref="T:System.Exception"/> passed
  14955. as a parameter.
  14956. </summary>
  14957. <param name="message">The message object to log.</param>
  14958. <param name="exception">The exception to log, including its stack trace.</param>
  14959. <remarks>
  14960. <para>
  14961. See the <see cref="M:Error(object)"/> form for more detailed information.
  14962. </para>
  14963. </remarks>
  14964. <seealso cref="M:Error(object)"/>
  14965. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14966. </member>
  14967. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
  14968. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  14969. <summary>
  14970. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14971. </summary>
  14972. <param name="format">A String containing zero or more format items</param>
  14973. <param name="args">An Object array containing zero or more objects to format</param>
  14974. <remarks>
  14975. <para>
  14976. The message is formatted using the <c>String.Format</c> method. See
  14977. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14978. of the formatting.
  14979. </para>
  14980. <para>
  14981. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14982. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14983. methods instead.
  14984. </para>
  14985. </remarks>
  14986. <seealso cref="M:Error(object,Exception)"/>
  14987. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14988. </member>
  14989. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
  14990. <summary>
  14991. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14992. </summary>
  14993. <param name="format">A String containing zero or more format items</param>
  14994. <param name="arg0">An Object to format</param>
  14995. <remarks>
  14996. <para>
  14997. The message is formatted using the <c>String.Format</c> method. See
  14998. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14999. of the formatting.
  15000. </para>
  15001. <para>
  15002. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15003. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  15004. methods instead.
  15005. </para>
  15006. </remarks>
  15007. <seealso cref="M:Error(object)"/>
  15008. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  15009. </member>
  15010. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
  15011. <summary>
  15012. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  15013. </summary>
  15014. <param name="format">A String containing zero or more format items</param>
  15015. <param name="arg0">An Object to format</param>
  15016. <param name="arg1">An Object to format</param>
  15017. <remarks>
  15018. <para>
  15019. The message is formatted using the <c>String.Format</c> method. See
  15020. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15021. of the formatting.
  15022. </para>
  15023. <para>
  15024. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15025. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  15026. methods instead.
  15027. </para>
  15028. </remarks>
  15029. <seealso cref="M:Error(object)"/>
  15030. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  15031. </member>
  15032. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  15033. <summary>
  15034. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  15035. </summary>
  15036. <param name="format">A String containing zero or more format items</param>
  15037. <param name="arg0">An Object to format</param>
  15038. <param name="arg1">An Object to format</param>
  15039. <param name="arg2">An Object to format</param>
  15040. <remarks>
  15041. <para>
  15042. The message is formatted using the <c>String.Format</c> method. See
  15043. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15044. of the formatting.
  15045. </para>
  15046. <para>
  15047. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15048. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  15049. methods instead.
  15050. </para>
  15051. </remarks>
  15052. <seealso cref="M:Error(object)"/>
  15053. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  15054. </member>
  15055. <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  15056. <summary>
  15057. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  15058. </summary>
  15059. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15060. <param name="format">A String containing zero or more format items</param>
  15061. <param name="args">An Object array containing zero or more objects to format</param>
  15062. <remarks>
  15063. <para>
  15064. The message is formatted using the <c>String.Format</c> method. See
  15065. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15066. of the formatting.
  15067. </para>
  15068. <para>
  15069. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15070. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15071. methods instead.
  15072. </para>
  15073. </remarks>
  15074. <seealso cref="M:Error(object,Exception)"/>
  15075. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  15076. </member>
  15077. <member name="M:log4net.ILog.Fatal(System.Object)">
  15078. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  15079. <summary>
  15080. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15081. </summary>
  15082. <remarks>
  15083. <para>
  15084. This method first checks if this logger is <c>FATAL</c>
  15085. enabled by comparing the level of this logger with the
  15086. <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
  15087. <c>FATAL</c> enabled, then it converts the message object
  15088. (passed as parameter) to a string by invoking the appropriate
  15089. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15090. proceeds to call all the registered appenders in this logger
  15091. and also higher in the hierarchy depending on the value of the
  15092. additivity flag.
  15093. </para>
  15094. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  15095. to this method will print the name of the <see cref="T:System.Exception"/>
  15096. but no stack trace. To print a stack trace use the
  15097. <see cref="M:Fatal(object,Exception)"/> form instead.
  15098. </para>
  15099. </remarks>
  15100. <param name="message">The message object to log.</param>
  15101. <seealso cref="M:Fatal(object,Exception)"/>
  15102. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15103. </member>
  15104. <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
  15105. <summary>
  15106. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  15107. the stack trace of the <see cref="T:System.Exception"/> passed
  15108. as a parameter.
  15109. </summary>
  15110. <param name="message">The message object to log.</param>
  15111. <param name="exception">The exception to log, including its stack trace.</param>
  15112. <remarks>
  15113. <para>
  15114. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  15115. </para>
  15116. </remarks>
  15117. <seealso cref="M:Fatal(object)"/>
  15118. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15119. </member>
  15120. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
  15121. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  15122. <summary>
  15123. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15124. </summary>
  15125. <param name="format">A String containing zero or more format items</param>
  15126. <param name="args">An Object array containing zero or more objects to format</param>
  15127. <remarks>
  15128. <para>
  15129. The message is formatted using the <c>String.Format</c> method. See
  15130. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15131. of the formatting.
  15132. </para>
  15133. <para>
  15134. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15135. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15136. methods instead.
  15137. </para>
  15138. </remarks>
  15139. <seealso cref="M:Fatal(object,Exception)"/>
  15140. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15141. </member>
  15142. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
  15143. <summary>
  15144. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15145. </summary>
  15146. <param name="format">A String containing zero or more format items</param>
  15147. <param name="arg0">An Object to format</param>
  15148. <remarks>
  15149. <para>
  15150. The message is formatted using the <c>String.Format</c> method. See
  15151. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15152. of the formatting.
  15153. </para>
  15154. <para>
  15155. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15156. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  15157. methods instead.
  15158. </para>
  15159. </remarks>
  15160. <seealso cref="M:Fatal(object)"/>
  15161. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15162. </member>
  15163. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
  15164. <summary>
  15165. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15166. </summary>
  15167. <param name="format">A String containing zero or more format items</param>
  15168. <param name="arg0">An Object to format</param>
  15169. <param name="arg1">An Object to format</param>
  15170. <remarks>
  15171. <para>
  15172. The message is formatted using the <c>String.Format</c> method. See
  15173. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15174. of the formatting.
  15175. </para>
  15176. <para>
  15177. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15178. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  15179. methods instead.
  15180. </para>
  15181. </remarks>
  15182. <seealso cref="M:Fatal(object)"/>
  15183. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15184. </member>
  15185. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  15186. <summary>
  15187. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15188. </summary>
  15189. <param name="format">A String containing zero or more format items</param>
  15190. <param name="arg0">An Object to format</param>
  15191. <param name="arg1">An Object to format</param>
  15192. <param name="arg2">An Object to format</param>
  15193. <remarks>
  15194. <para>
  15195. The message is formatted using the <c>String.Format</c> method. See
  15196. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15197. of the formatting.
  15198. </para>
  15199. <para>
  15200. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15201. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  15202. methods instead.
  15203. </para>
  15204. </remarks>
  15205. <seealso cref="M:Fatal(object)"/>
  15206. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15207. </member>
  15208. <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  15209. <summary>
  15210. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15211. </summary>
  15212. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15213. <param name="format">A String containing zero or more format items</param>
  15214. <param name="args">An Object array containing zero or more objects to format</param>
  15215. <remarks>
  15216. <para>
  15217. The message is formatted using the <c>String.Format</c> method. See
  15218. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15219. of the formatting.
  15220. </para>
  15221. <para>
  15222. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15223. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15224. methods instead.
  15225. </para>
  15226. </remarks>
  15227. <seealso cref="M:Fatal(object,Exception)"/>
  15228. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15229. </member>
  15230. <member name="P:log4net.ILog.IsDebugEnabled">
  15231. <summary>
  15232. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
  15233. </summary>
  15234. <value>
  15235. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
  15236. </value>
  15237. <remarks>
  15238. <para>
  15239. This function is intended to lessen the computational cost of
  15240. disabled log debug statements.
  15241. </para>
  15242. <para> For some ILog interface <c>log</c>, when you write:</para>
  15243. <code lang="C#">
  15244. log.Debug("This is entry number: " + i );
  15245. </code>
  15246. <para>
  15247. You incur the cost constructing the message, string construction and concatenation in
  15248. this case, regardless of whether the message is logged or not.
  15249. </para>
  15250. <para>
  15251. If you are worried about speed (who isn't), then you should write:
  15252. </para>
  15253. <code lang="C#">
  15254. if (log.IsDebugEnabled)
  15255. {
  15256. log.Debug("This is entry number: " + i );
  15257. }
  15258. </code>
  15259. <para>
  15260. This way you will not incur the cost of parameter
  15261. construction if debugging is disabled for <c>log</c>. On
  15262. the other hand, if the <c>log</c> is debug enabled, you
  15263. will incur the cost of evaluating whether the logger is debug
  15264. enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
  15265. the <see cref="M:Debug(object)"/>. This is an insignificant overhead
  15266. since evaluating a logger takes about 1% of the time it
  15267. takes to actually log. This is the preferred style of logging.
  15268. </para>
  15269. <para>Alternatively if your logger is available statically then the is debug
  15270. enabled state can be stored in a static variable like this:
  15271. </para>
  15272. <code lang="C#">
  15273. private static readonly bool isDebugEnabled = log.IsDebugEnabled;
  15274. </code>
  15275. <para>
  15276. Then when you come to log you can write:
  15277. </para>
  15278. <code lang="C#">
  15279. if (isDebugEnabled)
  15280. {
  15281. log.Debug("This is entry number: " + i );
  15282. }
  15283. </code>
  15284. <para>
  15285. This way the debug enabled state is only queried once
  15286. when the class is loaded. Using a <c>private static readonly</c>
  15287. variable is the most efficient because it is a run time constant
  15288. and can be heavily optimized by the JIT compiler.
  15289. </para>
  15290. <para>
  15291. Of course if you use a static readonly variable to
  15292. hold the enabled state of the logger then you cannot
  15293. change the enabled state at runtime to vary the logging
  15294. that is produced. You have to decide if you need absolute
  15295. speed or runtime flexibility.
  15296. </para>
  15297. </remarks>
  15298. <seealso cref="M:Debug(object)"/>
  15299. <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
  15300. </member>
  15301. <member name="P:log4net.ILog.IsInfoEnabled">
  15302. <summary>
  15303. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
  15304. </summary>
  15305. <value>
  15306. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
  15307. </value>
  15308. <remarks>
  15309. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  15310. </remarks>
  15311. <seealso cref="M:Info(object)"/>
  15312. <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
  15313. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15314. </member>
  15315. <member name="P:log4net.ILog.IsWarnEnabled">
  15316. <summary>
  15317. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
  15318. </summary>
  15319. <value>
  15320. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
  15321. </value>
  15322. <remarks>
  15323. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  15324. </remarks>
  15325. <seealso cref="M:Warn(object)"/>
  15326. <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
  15327. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15328. </member>
  15329. <member name="P:log4net.ILog.IsErrorEnabled">
  15330. <summary>
  15331. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
  15332. </summary>
  15333. <value>
  15334. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
  15335. </value>
  15336. <remarks>
  15337. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  15338. </remarks>
  15339. <seealso cref="M:Error(object)"/>
  15340. <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
  15341. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15342. </member>
  15343. <member name="P:log4net.ILog.IsFatalEnabled">
  15344. <summary>
  15345. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15346. </summary>
  15347. <value>
  15348. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
  15349. </value>
  15350. <remarks>
  15351. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  15352. </remarks>
  15353. <seealso cref="M:Fatal(object)"/>
  15354. <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
  15355. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15356. </member>
  15357. <member name="T:log4net.Layout.DynamicPatternLayout">
  15358. <summary>
  15359. A flexible layout configurable with pattern string that re-evaluates on each call.
  15360. </summary>
  15361. <remarks>
  15362. <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
  15363. features and capabilities of PatternLayout. PatternLayout is a 'static' class
  15364. in that its layout is done once at configuration time. This class will recreate
  15365. the layout on each reference.</para>
  15366. <para>One important difference between PatternLayout and DynamicPatternLayout is the
  15367. treatment of the Header and Footer parameters in the configuration. The Header and Footer
  15368. parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
  15369. but should not be marked as type log4net.Util.PatternString. Doing so causes the
  15370. pattern to be statically converted at configuration time and causes DynamicPatternLayout
  15371. to perform the same as PatternLayout.</para>
  15372. <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
  15373. <example>
  15374. &lt;layout type="log4net.Layout.DynamicPatternLayout"&gt;
  15375. &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;
  15376. &lt;param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  15377. &lt;/layout&gt;
  15378. </example>
  15379. </remarks>
  15380. </member>
  15381. <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
  15382. <summary>
  15383. The header PatternString
  15384. </summary>
  15385. </member>
  15386. <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
  15387. <summary>
  15388. The footer PatternString
  15389. </summary>
  15390. </member>
  15391. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
  15392. <summary>
  15393. Constructs a DynamicPatternLayout using the DefaultConversionPattern
  15394. </summary>
  15395. <remarks>
  15396. <para>
  15397. The default pattern just produces the application supplied message.
  15398. </para>
  15399. </remarks>
  15400. </member>
  15401. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
  15402. <summary>
  15403. Constructs a DynamicPatternLayout using the supplied conversion pattern
  15404. </summary>
  15405. <param name="pattern">the pattern to use</param>
  15406. <remarks>
  15407. </remarks>
  15408. </member>
  15409. <member name="P:log4net.Layout.DynamicPatternLayout.Header">
  15410. <summary>
  15411. The header for the layout format.
  15412. </summary>
  15413. <value>the layout header</value>
  15414. <remarks>
  15415. <para>
  15416. The Header text will be appended before any logging events
  15417. are formatted and appended.
  15418. </para>
  15419. The pattern will be formatted on each get operation.
  15420. </remarks>
  15421. </member>
  15422. <member name="P:log4net.Layout.DynamicPatternLayout.Footer">
  15423. <summary>
  15424. The footer for the layout format.
  15425. </summary>
  15426. <value>the layout footer</value>
  15427. <remarks>
  15428. <para>
  15429. The Footer text will be appended after all the logging events
  15430. have been formatted and appended.
  15431. </para>
  15432. The pattern will be formatted on each get operation.
  15433. </remarks>
  15434. </member>
  15435. <member name="T:log4net.Layout.ExceptionLayout">
  15436. <summary>
  15437. A Layout that renders only the Exception text from the logging event
  15438. </summary>
  15439. <remarks>
  15440. <para>
  15441. A Layout that renders only the Exception text from the logging event.
  15442. </para>
  15443. <para>
  15444. This Layout should only be used with appenders that utilize multiple
  15445. layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
  15446. </para>
  15447. </remarks>
  15448. <author>Nicko Cadell</author>
  15449. <author>Gert Driesen</author>
  15450. </member>
  15451. <member name="M:log4net.Layout.ExceptionLayout.#ctor">
  15452. <summary>
  15453. Default constructor
  15454. </summary>
  15455. <remarks>
  15456. <para>
  15457. Constructs a ExceptionLayout
  15458. </para>
  15459. </remarks>
  15460. </member>
  15461. <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
  15462. <summary>
  15463. Activate component options
  15464. </summary>
  15465. <remarks>
  15466. <para>
  15467. Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
  15468. framework.
  15469. </para>
  15470. <para>
  15471. This method does nothing as options become effective immediately.
  15472. </para>
  15473. </remarks>
  15474. </member>
  15475. <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  15476. <summary>
  15477. Gets the exception text from the logging event
  15478. </summary>
  15479. <param name="writer">The TextWriter to write the formatted event to</param>
  15480. <param name="loggingEvent">the event being logged</param>
  15481. <remarks>
  15482. <para>
  15483. Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
  15484. The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
  15485. </para>
  15486. </remarks>
  15487. </member>
  15488. <member name="T:log4net.Layout.ILayout">
  15489. <summary>
  15490. Interface implemented by layout objects
  15491. </summary>
  15492. <remarks>
  15493. <para>
  15494. An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  15495. as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
  15496. appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
  15497. </para>
  15498. <para>
  15499. The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  15500. text that is appender before any events and after all the events respectively.
  15501. </para>
  15502. </remarks>
  15503. <author>Nicko Cadell</author>
  15504. <author>Gert Driesen</author>
  15505. </member>
  15506. <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  15507. <summary>
  15508. Implement this method to create your own layout format.
  15509. </summary>
  15510. <param name="writer">The TextWriter to write the formatted event to</param>
  15511. <param name="loggingEvent">The event to format</param>
  15512. <remarks>
  15513. <para>
  15514. This method is called by an appender to format
  15515. the <paramref name="loggingEvent"/> as text and output to a writer.
  15516. </para>
  15517. <para>
  15518. If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
  15519. event to be formatted as a <see cref="T:System.String"/> then the following
  15520. code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
  15521. </para>
  15522. <code lang="C#">
  15523. StringWriter writer = new StringWriter();
  15524. Layout.Format(writer, loggingEvent);
  15525. string formattedEvent = writer.ToString();
  15526. </code>
  15527. </remarks>
  15528. </member>
  15529. <member name="P:log4net.Layout.ILayout.ContentType">
  15530. <summary>
  15531. The content type output by this layout.
  15532. </summary>
  15533. <value>The content type</value>
  15534. <remarks>
  15535. <para>
  15536. The content type output by this layout.
  15537. </para>
  15538. <para>
  15539. This is a MIME type e.g. <c>"text/plain"</c>.
  15540. </para>
  15541. </remarks>
  15542. </member>
  15543. <member name="P:log4net.Layout.ILayout.Header">
  15544. <summary>
  15545. The header for the layout format.
  15546. </summary>
  15547. <value>the layout header</value>
  15548. <remarks>
  15549. <para>
  15550. The Header text will be appended before any logging events
  15551. are formatted and appended.
  15552. </para>
  15553. </remarks>
  15554. </member>
  15555. <member name="P:log4net.Layout.ILayout.Footer">
  15556. <summary>
  15557. The footer for the layout format.
  15558. </summary>
  15559. <value>the layout footer</value>
  15560. <remarks>
  15561. <para>
  15562. The Footer text will be appended after all the logging events
  15563. have been formatted and appended.
  15564. </para>
  15565. </remarks>
  15566. </member>
  15567. <member name="P:log4net.Layout.ILayout.IgnoresException">
  15568. <summary>
  15569. Flag indicating if this layout handle exceptions
  15570. </summary>
  15571. <value><c>false</c> if this layout handles exceptions</value>
  15572. <remarks>
  15573. <para>
  15574. If this layout handles the exception object contained within
  15575. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  15576. <c>false</c>. Otherwise, if the layout ignores the exception
  15577. object, then the layout should return <c>true</c>.
  15578. </para>
  15579. </remarks>
  15580. </member>
  15581. <member name="T:log4net.Layout.IRawLayout">
  15582. <summary>
  15583. Interface for raw layout objects
  15584. </summary>
  15585. <remarks>
  15586. <para>
  15587. Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  15588. to an object.
  15589. </para>
  15590. <para>
  15591. This interface should not be confused with the
  15592. <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
  15593. only certain specialized situations where a raw object is
  15594. required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
  15595. is not generally useful than this interface.
  15596. </para>
  15597. </remarks>
  15598. <author>Nicko Cadell</author>
  15599. <author>Gert Driesen</author>
  15600. </member>
  15601. <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
  15602. <summary>
  15603. Implement this method to create your own layout format.
  15604. </summary>
  15605. <param name="loggingEvent">The event to format</param>
  15606. <returns>returns the formatted event</returns>
  15607. <remarks>
  15608. <para>
  15609. Implement this method to create your own layout format.
  15610. </para>
  15611. </remarks>
  15612. </member>
  15613. <member name="T:log4net.Layout.Layout2RawLayoutAdapter">
  15614. <summary>
  15615. Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
  15616. </summary>
  15617. <remarks>
  15618. <para>
  15619. Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
  15620. allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
  15621. </para>
  15622. </remarks>
  15623. <author>Nicko Cadell</author>
  15624. <author>Gert Driesen</author>
  15625. </member>
  15626. <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
  15627. <summary>
  15628. The layout to adapt
  15629. </summary>
  15630. </member>
  15631. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
  15632. <summary>
  15633. Construct a new adapter
  15634. </summary>
  15635. <param name="layout">the layout to adapt</param>
  15636. <remarks>
  15637. <para>
  15638. Create the adapter for the specified <paramref name="layout"/>.
  15639. </para>
  15640. </remarks>
  15641. </member>
  15642. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
  15643. <summary>
  15644. Format the logging event as an object.
  15645. </summary>
  15646. <param name="loggingEvent">The event to format</param>
  15647. <returns>returns the formatted event</returns>
  15648. <remarks>
  15649. <para>
  15650. Format the logging event as an object.
  15651. </para>
  15652. <para>
  15653. Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
  15654. the constructor to perform the formatting.
  15655. </para>
  15656. </remarks>
  15657. </member>
  15658. <member name="T:log4net.Layout.LayoutSkeleton">
  15659. <summary>
  15660. Extend this abstract class to create your own log layout format.
  15661. </summary>
  15662. <remarks>
  15663. <para>
  15664. This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
  15665. interface. Most layout objects should extend this class.
  15666. </para>
  15667. </remarks>
  15668. <remarks>
  15669. <note type="inheritinfo">
  15670. <para>
  15671. Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
  15672. method.
  15673. </para>
  15674. <para>
  15675. Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
  15676. constructor.
  15677. </para>
  15678. </note>
  15679. </remarks>
  15680. <author>Nicko Cadell</author>
  15681. <author>Gert Driesen</author>
  15682. </member>
  15683. <member name="F:log4net.Layout.LayoutSkeleton.m_header">
  15684. <summary>
  15685. The header text
  15686. </summary>
  15687. <remarks>
  15688. <para>
  15689. See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
  15690. </para>
  15691. </remarks>
  15692. </member>
  15693. <member name="F:log4net.Layout.LayoutSkeleton.m_footer">
  15694. <summary>
  15695. The footer text
  15696. </summary>
  15697. <remarks>
  15698. <para>
  15699. See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
  15700. </para>
  15701. </remarks>
  15702. </member>
  15703. <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
  15704. <summary>
  15705. Flag indicating if this layout handles exceptions
  15706. </summary>
  15707. <remarks>
  15708. <para>
  15709. <c>false</c> if this layout handles exceptions
  15710. </para>
  15711. </remarks>
  15712. </member>
  15713. <member name="M:log4net.Layout.LayoutSkeleton.#ctor">
  15714. <summary>
  15715. Empty default constructor
  15716. </summary>
  15717. <remarks>
  15718. <para>
  15719. Empty default constructor
  15720. </para>
  15721. </remarks>
  15722. </member>
  15723. <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
  15724. <summary>
  15725. Activate component options
  15726. </summary>
  15727. <remarks>
  15728. <para>
  15729. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  15730. activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
  15731. be called on this object after the configuration properties have
  15732. been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
  15733. object is in an undefined state and must not be used.
  15734. </para>
  15735. <para>
  15736. If any of the configuration properties are modified then
  15737. <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
  15738. </para>
  15739. <para>
  15740. This method must be implemented by the subclass.
  15741. </para>
  15742. </remarks>
  15743. </member>
  15744. <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  15745. <summary>
  15746. Implement this method to create your own layout format.
  15747. </summary>
  15748. <param name="writer">The TextWriter to write the formatted event to</param>
  15749. <param name="loggingEvent">The event to format</param>
  15750. <remarks>
  15751. <para>
  15752. This method is called by an appender to format
  15753. the <paramref name="loggingEvent"/> as text.
  15754. </para>
  15755. </remarks>
  15756. </member>
  15757. <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
  15758. <summary>
  15759. Convenience method for easily formatting the logging event into a string variable.
  15760. </summary>
  15761. <param name="loggingEvent"></param>
  15762. <remarks>
  15763. Creates a new StringWriter instance to store the formatted logging event.
  15764. </remarks>
  15765. </member>
  15766. <member name="P:log4net.Layout.LayoutSkeleton.ContentType">
  15767. <summary>
  15768. The content type output by this layout.
  15769. </summary>
  15770. <value>The content type is <c>"text/plain"</c></value>
  15771. <remarks>
  15772. <para>
  15773. The content type output by this layout.
  15774. </para>
  15775. <para>
  15776. This base class uses the value <c>"text/plain"</c>.
  15777. To change this value a subclass must override this
  15778. property.
  15779. </para>
  15780. </remarks>
  15781. </member>
  15782. <member name="P:log4net.Layout.LayoutSkeleton.Header">
  15783. <summary>
  15784. The header for the layout format.
  15785. </summary>
  15786. <value>the layout header</value>
  15787. <remarks>
  15788. <para>
  15789. The Header text will be appended before any logging events
  15790. are formatted and appended.
  15791. </para>
  15792. </remarks>
  15793. </member>
  15794. <member name="P:log4net.Layout.LayoutSkeleton.Footer">
  15795. <summary>
  15796. The footer for the layout format.
  15797. </summary>
  15798. <value>the layout footer</value>
  15799. <remarks>
  15800. <para>
  15801. The Footer text will be appended after all the logging events
  15802. have been formatted and appended.
  15803. </para>
  15804. </remarks>
  15805. </member>
  15806. <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
  15807. <summary>
  15808. Flag indicating if this layout handles exceptions
  15809. </summary>
  15810. <value><c>false</c> if this layout handles exceptions</value>
  15811. <remarks>
  15812. <para>
  15813. If this layout handles the exception object contained within
  15814. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  15815. <c>false</c>. Otherwise, if the layout ignores the exception
  15816. object, then the layout should return <c>true</c>.
  15817. </para>
  15818. <para>
  15819. Set this value to override a this default setting. The default
  15820. value is <c>true</c>, this layout does not handle the exception.
  15821. </para>
  15822. </remarks>
  15823. </member>
  15824. <member name="T:log4net.Layout.PatternLayout">
  15825. <summary>
  15826. A flexible layout configurable with pattern string.
  15827. </summary>
  15828. <remarks>
  15829. <para>
  15830. The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
  15831. <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
  15832. depend on the <i>conversion pattern</i>.
  15833. </para>
  15834. <para>
  15835. The conversion pattern is closely related to the conversion
  15836. pattern of the printf function in C. A conversion pattern is
  15837. composed of literal text and format control expressions called
  15838. <i>conversion specifiers</i>.
  15839. </para>
  15840. <para>
  15841. <i>You are free to insert any literal text within the conversion
  15842. pattern.</i>
  15843. </para>
  15844. <para>
  15845. Each conversion specifier starts with a percent sign (%) and is
  15846. followed by optional <i>format modifiers</i> and a <i>conversion
  15847. pattern name</i>. The conversion pattern name specifies the type of
  15848. data, e.g. logger, level, date, thread name. The format
  15849. modifiers control such things as field width, padding, left and
  15850. right justification. The following is a simple example.
  15851. </para>
  15852. <para>
  15853. Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
  15854. that the log4net environment was set to use a PatternLayout. Then the
  15855. statements
  15856. </para>
  15857. <code lang="C#">
  15858. ILog log = LogManager.GetLogger(typeof(TestApp));
  15859. log.Debug("Message 1");
  15860. log.Warn("Message 2");
  15861. </code>
  15862. <para>would yield the output</para>
  15863. <code>
  15864. DEBUG [main]: Message 1
  15865. WARN [main]: Message 2
  15866. </code>
  15867. <para>
  15868. Note that there is no explicit separator between text and
  15869. conversion specifiers. The pattern parser knows when it has reached
  15870. the end of a conversion specifier when it reads a conversion
  15871. character. In the example above the conversion specifier
  15872. <b>%-5level</b> means the level of the logging event should be left
  15873. justified to a width of five characters.
  15874. </para>
  15875. <para>
  15876. The recognized conversion pattern names are:
  15877. </para>
  15878. <list type="table">
  15879. <listheader>
  15880. <term>Conversion Pattern Name</term>
  15881. <description>Effect</description>
  15882. </listheader>
  15883. <item>
  15884. <term>a</term>
  15885. <description>Equivalent to <b>appdomain</b></description>
  15886. </item>
  15887. <item>
  15888. <term>appdomain</term>
  15889. <description>
  15890. Used to output the friendly name of the AppDomain where the
  15891. logging event was generated.
  15892. </description>
  15893. </item>
  15894. <item>
  15895. <term>aspnet-cache</term>
  15896. <description>
  15897. <para>
  15898. 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>
  15899. </para>
  15900. <para>
  15901. This pattern is not available for Compact Framework or Client Profile assemblies.
  15902. </para>
  15903. </description>
  15904. </item>
  15905. <item>
  15906. <term>aspnet-context</term>
  15907. <description>
  15908. <para>
  15909. 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>
  15910. </para>
  15911. <para>
  15912. This pattern is not available for Compact Framework or Client Profile assemblies.
  15913. </para>
  15914. </description>
  15915. </item>
  15916. <item>
  15917. <term>aspnet-request</term>
  15918. <description>
  15919. <para>
  15920. 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>
  15921. </para>
  15922. <para>
  15923. This pattern is not available for Compact Framework or Client Profile assemblies.
  15924. </para>
  15925. </description>
  15926. </item>
  15927. <item>
  15928. <term>aspnet-session</term>
  15929. <description>
  15930. <para>
  15931. 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>
  15932. </para>
  15933. <para>
  15934. This pattern is not available for Compact Framework or Client Profile assemblies.
  15935. </para>
  15936. </description>
  15937. </item>
  15938. <item>
  15939. <term>c</term>
  15940. <description>Equivalent to <b>logger</b></description>
  15941. </item>
  15942. <item>
  15943. <term>C</term>
  15944. <description>Equivalent to <b>type</b></description>
  15945. </item>
  15946. <item>
  15947. <term>class</term>
  15948. <description>Equivalent to <b>type</b></description>
  15949. </item>
  15950. <item>
  15951. <term>d</term>
  15952. <description>Equivalent to <b>date</b></description>
  15953. </item>
  15954. <item>
  15955. <term>date</term>
  15956. <description>
  15957. <para>
  15958. Used to output the date of the logging event in the local time zone.
  15959. To output the date in universal time use the <c>%utcdate</c> pattern.
  15960. The date conversion
  15961. specifier may be followed by a <i>date format specifier</i> enclosed
  15962. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  15963. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  15964. given then ISO8601 format is
  15965. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  15966. </para>
  15967. <para>
  15968. The date format specifier admits the same syntax as the
  15969. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  15970. </para>
  15971. <para>
  15972. For better results it is recommended to use the log4net date
  15973. formatters. These can be specified using one of the strings
  15974. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  15975. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  15976. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  15977. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  15978. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  15979. </para>
  15980. <para>
  15981. These dedicated date formatters perform significantly
  15982. better than <see cref="M:DateTime.ToString(string)"/>.
  15983. </para>
  15984. </description>
  15985. </item>
  15986. <item>
  15987. <term>exception</term>
  15988. <description>
  15989. <para>
  15990. Used to output the exception passed in with the log message.
  15991. </para>
  15992. <para>
  15993. If an exception object is stored in the logging event
  15994. it will be rendered into the pattern output with a
  15995. trailing newline.
  15996. If there is no exception then nothing will be output
  15997. and no trailing newline will be appended.
  15998. It is typical to put a newline before the exception
  15999. and to have the exception as the last data in the pattern.
  16000. </para>
  16001. </description>
  16002. </item>
  16003. <item>
  16004. <term>F</term>
  16005. <description>Equivalent to <b>file</b></description>
  16006. </item>
  16007. <item>
  16008. <term>file</term>
  16009. <description>
  16010. <para>
  16011. Used to output the file name where the logging request was
  16012. issued.
  16013. </para>
  16014. <para>
  16015. <b>WARNING</b> Generating caller location information is
  16016. extremely slow. Its use should be avoided unless execution speed
  16017. is not an issue.
  16018. </para>
  16019. <para>
  16020. See the note below on the availability of caller location information.
  16021. </para>
  16022. </description>
  16023. </item>
  16024. <item>
  16025. <term>identity</term>
  16026. <description>
  16027. <para>
  16028. Used to output the user name for the currently active user
  16029. (Principal.Identity.Name).
  16030. </para>
  16031. <para>
  16032. <b>WARNING</b> Generating caller information is
  16033. extremely slow. Its use should be avoided unless execution speed
  16034. is not an issue.
  16035. </para>
  16036. </description>
  16037. </item>
  16038. <item>
  16039. <term>l</term>
  16040. <description>Equivalent to <b>location</b></description>
  16041. </item>
  16042. <item>
  16043. <term>L</term>
  16044. <description>Equivalent to <b>line</b></description>
  16045. </item>
  16046. <item>
  16047. <term>location</term>
  16048. <description>
  16049. <para>
  16050. Used to output location information of the caller which generated
  16051. the logging event.
  16052. </para>
  16053. <para>
  16054. The location information depends on the CLI implementation but
  16055. usually consists of the fully qualified name of the calling
  16056. method followed by the callers source the file name and line
  16057. number between parentheses.
  16058. </para>
  16059. <para>
  16060. The location information can be very useful. However, its
  16061. generation is <b>extremely</b> slow. Its use should be avoided
  16062. unless execution speed is not an issue.
  16063. </para>
  16064. <para>
  16065. See the note below on the availability of caller location information.
  16066. </para>
  16067. </description>
  16068. </item>
  16069. <item>
  16070. <term>level</term>
  16071. <description>
  16072. <para>
  16073. Used to output the level of the logging event.
  16074. </para>
  16075. </description>
  16076. </item>
  16077. <item>
  16078. <term>line</term>
  16079. <description>
  16080. <para>
  16081. Used to output the line number from where the logging request
  16082. was issued.
  16083. </para>
  16084. <para>
  16085. <b>WARNING</b> Generating caller location information is
  16086. extremely slow. Its use should be avoided unless execution speed
  16087. is not an issue.
  16088. </para>
  16089. <para>
  16090. See the note below on the availability of caller location information.
  16091. </para>
  16092. </description>
  16093. </item>
  16094. <item>
  16095. <term>logger</term>
  16096. <description>
  16097. <para>
  16098. Used to output the logger of the logging event. The
  16099. logger conversion specifier can be optionally followed by
  16100. <i>precision specifier</i>, that is a decimal constant in
  16101. brackets.
  16102. </para>
  16103. <para>
  16104. If a precision specifier is given, then only the corresponding
  16105. number of right most components of the logger name will be
  16106. printed. By default the logger name is printed in full.
  16107. </para>
  16108. <para>
  16109. For example, for the logger name "a.b.c" the pattern
  16110. <b>%logger{2}</b> will output "b.c".
  16111. </para>
  16112. </description>
  16113. </item>
  16114. <item>
  16115. <term>m</term>
  16116. <description>Equivalent to <b>message</b></description>
  16117. </item>
  16118. <item>
  16119. <term>M</term>
  16120. <description>Equivalent to <b>method</b></description>
  16121. </item>
  16122. <item>
  16123. <term>message</term>
  16124. <description>
  16125. <para>
  16126. Used to output the application supplied message associated with
  16127. the logging event.
  16128. </para>
  16129. </description>
  16130. </item>
  16131. <item>
  16132. <term>mdc</term>
  16133. <description>
  16134. <para>
  16135. The MDC (old name for the ThreadContext.Properties) is now part of the
  16136. combined event properties. This pattern is supported for compatibility
  16137. but is equivalent to <b>property</b>.
  16138. </para>
  16139. </description>
  16140. </item>
  16141. <item>
  16142. <term>method</term>
  16143. <description>
  16144. <para>
  16145. Used to output the method name where the logging request was
  16146. issued.
  16147. </para>
  16148. <para>
  16149. <b>WARNING</b> Generating caller location information is
  16150. extremely slow. Its use should be avoided unless execution speed
  16151. is not an issue.
  16152. </para>
  16153. <para>
  16154. See the note below on the availability of caller location information.
  16155. </para>
  16156. </description>
  16157. </item>
  16158. <item>
  16159. <term>n</term>
  16160. <description>Equivalent to <b>newline</b></description>
  16161. </item>
  16162. <item>
  16163. <term>newline</term>
  16164. <description>
  16165. <para>
  16166. Outputs the platform dependent line separator character or
  16167. characters.
  16168. </para>
  16169. <para>
  16170. This conversion pattern offers the same performance as using
  16171. non-portable line separator strings such as "\n", or "\r\n".
  16172. Thus, it is the preferred way of specifying a line separator.
  16173. </para>
  16174. </description>
  16175. </item>
  16176. <item>
  16177. <term>ndc</term>
  16178. <description>
  16179. <para>
  16180. Used to output the NDC (nested diagnostic context) associated
  16181. with the thread that generated the logging event.
  16182. </para>
  16183. </description>
  16184. </item>
  16185. <item>
  16186. <term>p</term>
  16187. <description>Equivalent to <b>level</b></description>
  16188. </item>
  16189. <item>
  16190. <term>P</term>
  16191. <description>Equivalent to <b>property</b></description>
  16192. </item>
  16193. <item>
  16194. <term>properties</term>
  16195. <description>Equivalent to <b>property</b></description>
  16196. </item>
  16197. <item>
  16198. <term>property</term>
  16199. <description>
  16200. <para>
  16201. Used to output the an event specific property. The key to
  16202. lookup must be specified within braces and directly following the
  16203. pattern specifier, e.g. <b>%property{user}</b> would include the value
  16204. from the property that is keyed by the string 'user'. Each property value
  16205. that is to be included in the log must be specified separately.
  16206. Properties are added to events by loggers or appenders. By default
  16207. the <c>log4net:HostName</c> property is set to the name of machine on
  16208. which the event was originally logged.
  16209. </para>
  16210. <para>
  16211. If no key is specified, e.g. <b>%property</b> then all the keys and their
  16212. values are printed in a comma separated list.
  16213. </para>
  16214. <para>
  16215. The properties of an event are combined from a number of different
  16216. contexts. These are listed below in the order in which they are searched.
  16217. </para>
  16218. <list type="definition">
  16219. <item>
  16220. <term>the event properties</term>
  16221. <description>
  16222. The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  16223. properties are specific to this event only.
  16224. </description>
  16225. </item>
  16226. <item>
  16227. <term>the thread properties</term>
  16228. <description>
  16229. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  16230. thread. These properties are shared by all events logged on this thread.
  16231. </description>
  16232. </item>
  16233. <item>
  16234. <term>the global properties</term>
  16235. <description>
  16236. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  16237. properties are shared by all the threads in the AppDomain.
  16238. </description>
  16239. </item>
  16240. </list>
  16241. </description>
  16242. </item>
  16243. <item>
  16244. <term>r</term>
  16245. <description>Equivalent to <b>timestamp</b></description>
  16246. </item>
  16247. <item>
  16248. <term>stacktrace</term>
  16249. <description>
  16250. <para>
  16251. Used to output the stack trace of the logging event
  16252. The stack trace level specifier may be enclosed
  16253. between braces. For example, <b>%stacktrace{level}</b>.
  16254. If no stack trace level specifier is given then 1 is assumed
  16255. </para>
  16256. <para>
  16257. Output uses the format:
  16258. type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
  16259. </para>
  16260. <para>
  16261. This pattern is not available for Compact Framework assemblies.
  16262. </para>
  16263. </description>
  16264. </item>
  16265. <item>
  16266. <term>stacktracedetail</term>
  16267. <description>
  16268. <para>
  16269. Used to output the stack trace of the logging event
  16270. The stack trace level specifier may be enclosed
  16271. between braces. For example, <b>%stacktracedetail{level}</b>.
  16272. If no stack trace level specifier is given then 1 is assumed
  16273. </para>
  16274. <para>
  16275. Output uses the format:
  16276. type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
  16277. </para>
  16278. <para>
  16279. This pattern is not available for Compact Framework assemblies.
  16280. </para>
  16281. </description>
  16282. </item>
  16283. <item>
  16284. <term>t</term>
  16285. <description>Equivalent to <b>thread</b></description>
  16286. </item>
  16287. <item>
  16288. <term>timestamp</term>
  16289. <description>
  16290. <para>
  16291. Used to output the number of milliseconds elapsed since the start
  16292. of the application until the creation of the logging event.
  16293. </para>
  16294. </description>
  16295. </item>
  16296. <item>
  16297. <term>thread</term>
  16298. <description>
  16299. <para>
  16300. Used to output the name of the thread that generated the
  16301. logging event. Uses the thread number if no name is available.
  16302. </para>
  16303. </description>
  16304. </item>
  16305. <item>
  16306. <term>type</term>
  16307. <description>
  16308. <para>
  16309. Used to output the fully qualified type name of the caller
  16310. issuing the logging request. This conversion specifier
  16311. can be optionally followed by <i>precision specifier</i>, that
  16312. is a decimal constant in brackets.
  16313. </para>
  16314. <para>
  16315. If a precision specifier is given, then only the corresponding
  16316. number of right most components of the class name will be
  16317. printed. By default the class name is output in fully qualified form.
  16318. </para>
  16319. <para>
  16320. For example, for the class name "log4net.Layout.PatternLayout", the
  16321. pattern <b>%type{1}</b> will output "PatternLayout".
  16322. </para>
  16323. <para>
  16324. <b>WARNING</b> Generating the caller class information is
  16325. slow. Thus, its use should be avoided unless execution speed is
  16326. not an issue.
  16327. </para>
  16328. <para>
  16329. See the note below on the availability of caller location information.
  16330. </para>
  16331. </description>
  16332. </item>
  16333. <item>
  16334. <term>u</term>
  16335. <description>Equivalent to <b>identity</b></description>
  16336. </item>
  16337. <item>
  16338. <term>username</term>
  16339. <description>
  16340. <para>
  16341. Used to output the WindowsIdentity for the currently
  16342. active user.
  16343. </para>
  16344. <para>
  16345. <b>WARNING</b> Generating caller WindowsIdentity information is
  16346. extremely slow. Its use should be avoided unless execution speed
  16347. is not an issue.
  16348. </para>
  16349. </description>
  16350. </item>
  16351. <item>
  16352. <term>utcdate</term>
  16353. <description>
  16354. <para>
  16355. Used to output the date of the logging event in universal time.
  16356. The date conversion
  16357. specifier may be followed by a <i>date format specifier</i> enclosed
  16358. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  16359. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  16360. given then ISO8601 format is
  16361. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  16362. </para>
  16363. <para>
  16364. The date format specifier admits the same syntax as the
  16365. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  16366. </para>
  16367. <para>
  16368. For better results it is recommended to use the log4net date
  16369. formatters. These can be specified using one of the strings
  16370. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  16371. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  16372. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  16373. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  16374. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  16375. </para>
  16376. <para>
  16377. These dedicated date formatters perform significantly
  16378. better than <see cref="M:DateTime.ToString(string)"/>.
  16379. </para>
  16380. </description>
  16381. </item>
  16382. <item>
  16383. <term>w</term>
  16384. <description>Equivalent to <b>username</b></description>
  16385. </item>
  16386. <item>
  16387. <term>x</term>
  16388. <description>Equivalent to <b>ndc</b></description>
  16389. </item>
  16390. <item>
  16391. <term>X</term>
  16392. <description>Equivalent to <b>mdc</b></description>
  16393. </item>
  16394. <item>
  16395. <term>%</term>
  16396. <description>
  16397. <para>
  16398. The sequence %% outputs a single percent sign.
  16399. </para>
  16400. </description>
  16401. </item>
  16402. </list>
  16403. <para>
  16404. The single letter patterns are deprecated in favor of the
  16405. longer more descriptive pattern names.
  16406. </para>
  16407. <para>
  16408. By default the relevant information is output as is. However,
  16409. with the aid of format modifiers it is possible to change the
  16410. minimum field width, the maximum field width and justification.
  16411. </para>
  16412. <para>
  16413. The optional format modifier is placed between the percent sign
  16414. and the conversion pattern name.
  16415. </para>
  16416. <para>
  16417. The first optional format modifier is the <i>left justification
  16418. flag</i> which is just the minus (-) character. Then comes the
  16419. optional <i>minimum field width</i> modifier. This is a decimal
  16420. constant that represents the minimum number of characters to
  16421. output. If the data item requires fewer characters, it is padded on
  16422. either the left or the right until the minimum width is
  16423. reached. The default is to pad on the left (right justify) but you
  16424. can specify right padding with the left justification flag. The
  16425. padding character is space. If the data item is larger than the
  16426. minimum field width, the field is expanded to accommodate the
  16427. data. The value is never truncated.
  16428. </para>
  16429. <para>
  16430. This behavior can be changed using the <i>maximum field
  16431. width</i> modifier which is designated by a period followed by a
  16432. decimal constant. If the data item is longer than the maximum
  16433. field, then the extra characters are removed from the
  16434. <i>beginning</i> of the data item and not from the end. For
  16435. example, it the maximum field width is eight and the data item is
  16436. ten characters long, then the first two characters of the data item
  16437. are dropped. This behavior deviates from the printf function in C
  16438. where truncation is done from the end.
  16439. </para>
  16440. <para>
  16441. Below are various format modifier examples for the logger
  16442. conversion specifier.
  16443. </para>
  16444. <div class="tablediv">
  16445. <table class="dtTABLE" cellspacing="0">
  16446. <tr>
  16447. <th>Format modifier</th>
  16448. <th>left justify</th>
  16449. <th>minimum width</th>
  16450. <th>maximum width</th>
  16451. <th>comment</th>
  16452. </tr>
  16453. <tr>
  16454. <td align="center">%20logger</td>
  16455. <td align="center">false</td>
  16456. <td align="center">20</td>
  16457. <td align="center">none</td>
  16458. <td>
  16459. <para>
  16460. Left pad with spaces if the logger name is less than 20
  16461. characters long.
  16462. </para>
  16463. </td>
  16464. </tr>
  16465. <tr>
  16466. <td align="center">%-20logger</td>
  16467. <td align="center">true</td>
  16468. <td align="center">20</td>
  16469. <td align="center">none</td>
  16470. <td>
  16471. <para>
  16472. Right pad with spaces if the logger
  16473. name is less than 20 characters long.
  16474. </para>
  16475. </td>
  16476. </tr>
  16477. <tr>
  16478. <td align="center">%.30logger</td>
  16479. <td align="center">NA</td>
  16480. <td align="center">none</td>
  16481. <td align="center">30</td>
  16482. <td>
  16483. <para>
  16484. Truncate from the beginning if the logger
  16485. name is longer than 30 characters.
  16486. </para>
  16487. </td>
  16488. </tr>
  16489. <tr>
  16490. <td align="center"><nobr>%20.30logger</nobr></td>
  16491. <td align="center">false</td>
  16492. <td align="center">20</td>
  16493. <td align="center">30</td>
  16494. <td>
  16495. <para>
  16496. Left pad with spaces if the logger name is shorter than 20
  16497. characters. However, if logger name is longer than 30 characters,
  16498. then truncate from the beginning.
  16499. </para>
  16500. </td>
  16501. </tr>
  16502. <tr>
  16503. <td align="center">%-20.30logger</td>
  16504. <td align="center">true</td>
  16505. <td align="center">20</td>
  16506. <td align="center">30</td>
  16507. <td>
  16508. <para>
  16509. Right pad with spaces if the logger name is shorter than 20
  16510. characters. However, if logger name is longer than 30 characters,
  16511. then truncate from the beginning.
  16512. </para>
  16513. </td>
  16514. </tr>
  16515. </table>
  16516. </div>
  16517. <para>
  16518. <b>Note about caller location information.</b><br />
  16519. The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
  16520. all generate caller location information.
  16521. Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
  16522. a call stack. The caller's information is then extracted from this stack.
  16523. </para>
  16524. <note type="caution">
  16525. <para>
  16526. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  16527. .NET Compact Framework 1.0 therefore caller location information is not
  16528. available on that framework.
  16529. </para>
  16530. </note>
  16531. <note type="caution">
  16532. <para>
  16533. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  16534. </para>
  16535. <para>
  16536. "StackTrace information will be most informative with Debug build configurations.
  16537. By default, Debug builds include debug symbols, while Release builds do not. The
  16538. debug symbols contain most of the file, method name, line number, and column
  16539. information used in constructing StackFrame and StackTrace objects. StackTrace
  16540. might not report as many method calls as expected, due to code transformations
  16541. that occur during optimization."
  16542. </para>
  16543. <para>
  16544. This means that in a Release build the caller information may be incomplete or may
  16545. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  16546. </para>
  16547. </note>
  16548. <para>
  16549. Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
  16550. instance using the <see cref="M:AddConverter(string, Type)"/> method.
  16551. </para>
  16552. </remarks>
  16553. <example>
  16554. This is a more detailed pattern.
  16555. <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
  16556. </example>
  16557. <example>
  16558. A similar pattern except that the relative time is
  16559. right padded if less than 6 digits, thread name is right padded if
  16560. less than 15 characters and truncated if longer and the logger
  16561. name is left padded if shorter than 30 characters and truncated if
  16562. longer.
  16563. <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
  16564. </example>
  16565. <author>Nicko Cadell</author>
  16566. <author>Gert Driesen</author>
  16567. <author>Douglas de la Torre</author>
  16568. <author>Daniel Cazzulino</author>
  16569. </member>
  16570. <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
  16571. <summary>
  16572. Default pattern string for log output.
  16573. </summary>
  16574. <remarks>
  16575. <para>
  16576. Default pattern string for log output.
  16577. Currently set to the string <b>"%message%newline"</b>
  16578. which just prints the application supplied message.
  16579. </para>
  16580. </remarks>
  16581. </member>
  16582. <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
  16583. <summary>
  16584. A detailed conversion pattern
  16585. </summary>
  16586. <remarks>
  16587. <para>
  16588. A conversion pattern which includes Time, Thread, Logger, and Nested Context.
  16589. Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
  16590. </para>
  16591. </remarks>
  16592. </member>
  16593. <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
  16594. <summary>
  16595. Internal map of converter identifiers to converter types.
  16596. </summary>
  16597. <remarks>
  16598. <para>
  16599. This static map is overridden by the m_converterRegistry instance map
  16600. </para>
  16601. </remarks>
  16602. </member>
  16603. <member name="F:log4net.Layout.PatternLayout.m_pattern">
  16604. <summary>
  16605. the pattern
  16606. </summary>
  16607. </member>
  16608. <member name="F:log4net.Layout.PatternLayout.m_head">
  16609. <summary>
  16610. the head of the pattern converter chain
  16611. </summary>
  16612. </member>
  16613. <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
  16614. <summary>
  16615. patterns defined on this PatternLayout only
  16616. </summary>
  16617. </member>
  16618. <member name="M:log4net.Layout.PatternLayout.#cctor">
  16619. <summary>
  16620. Initialize the global registry
  16621. </summary>
  16622. <remarks>
  16623. <para>
  16624. Defines the builtin global rules.
  16625. </para>
  16626. </remarks>
  16627. </member>
  16628. <member name="M:log4net.Layout.PatternLayout.#ctor">
  16629. <summary>
  16630. Constructs a PatternLayout using the DefaultConversionPattern
  16631. </summary>
  16632. <remarks>
  16633. <para>
  16634. The default pattern just produces the application supplied message.
  16635. </para>
  16636. <para>
  16637. Note to Inheritors: This constructor calls the virtual method
  16638. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  16639. aware that it will be called before your is called constructor.
  16640. </para>
  16641. <para>
  16642. As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
  16643. method must be called after the properties on this object have been
  16644. configured.
  16645. </para>
  16646. </remarks>
  16647. </member>
  16648. <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
  16649. <summary>
  16650. Constructs a PatternLayout using the supplied conversion pattern
  16651. </summary>
  16652. <param name="pattern">the pattern to use</param>
  16653. <remarks>
  16654. <para>
  16655. Note to Inheritors: This constructor calls the virtual method
  16656. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  16657. aware that it will be called before your is called constructor.
  16658. </para>
  16659. <para>
  16660. When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
  16661. need not be called. This may not be the case when using a subclass.
  16662. </para>
  16663. </remarks>
  16664. </member>
  16665. <member name="P:log4net.Layout.PatternLayout.ConversionPattern">
  16666. <summary>
  16667. The pattern formatting string
  16668. </summary>
  16669. <remarks>
  16670. <para>
  16671. The <b>ConversionPattern</b> option. This is the string which
  16672. controls formatting and consists of a mix of literal content and
  16673. conversion specifiers.
  16674. </para>
  16675. </remarks>
  16676. </member>
  16677. <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
  16678. <summary>
  16679. Create the pattern parser instance
  16680. </summary>
  16681. <param name="pattern">the pattern to parse</param>
  16682. <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
  16683. <remarks>
  16684. <para>
  16685. Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
  16686. global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
  16687. </para>
  16688. </remarks>
  16689. </member>
  16690. <member name="M:log4net.Layout.PatternLayout.ActivateOptions">
  16691. <summary>
  16692. Initialize layout options
  16693. </summary>
  16694. <remarks>
  16695. <para>
  16696. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16697. activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
  16698. be called on this object after the configuration properties have
  16699. been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
  16700. object is in an undefined state and must not be used.
  16701. </para>
  16702. <para>
  16703. If any of the configuration properties are modified then
  16704. <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
  16705. </para>
  16706. </remarks>
  16707. </member>
  16708. <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16709. <summary>
  16710. Produces a formatted string as specified by the conversion pattern.
  16711. </summary>
  16712. <param name="loggingEvent">the event being logged</param>
  16713. <param name="writer">The TextWriter to write the formatted event to</param>
  16714. <remarks>
  16715. <para>
  16716. Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
  16717. specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
  16718. </para>
  16719. </remarks>
  16720. </member>
  16721. <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
  16722. <summary>
  16723. Add a converter to this PatternLayout
  16724. </summary>
  16725. <param name="converterInfo">the converter info</param>
  16726. <remarks>
  16727. <para>
  16728. This version of the method is used by the configurator.
  16729. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  16730. </para>
  16731. </remarks>
  16732. </member>
  16733. <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
  16734. <summary>
  16735. Add a converter to this PatternLayout
  16736. </summary>
  16737. <param name="name">the name of the conversion pattern for this converter</param>
  16738. <param name="type">the type of the converter</param>
  16739. <remarks>
  16740. <para>
  16741. Add a named pattern converter to this instance. This
  16742. converter will be used in the formatting of the event.
  16743. This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
  16744. </para>
  16745. <para>
  16746. The <paramref name="type"/> specified must extend the
  16747. <see cref="T:log4net.Util.PatternConverter"/> type.
  16748. </para>
  16749. </remarks>
  16750. </member>
  16751. <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
  16752. <summary>
  16753. Write the event appdomain name to the output
  16754. </summary>
  16755. <remarks>
  16756. <para>
  16757. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
  16758. </para>
  16759. </remarks>
  16760. <author>Daniel Cazzulino</author>
  16761. <author>Nicko Cadell</author>
  16762. </member>
  16763. <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16764. <summary>
  16765. Write the event appdomain name to the output
  16766. </summary>
  16767. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16768. <param name="loggingEvent">the event being logged</param>
  16769. <remarks>
  16770. <para>
  16771. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
  16772. </para>
  16773. </remarks>
  16774. </member>
  16775. <member name="T:log4net.Layout.Pattern.DatePatternConverter">
  16776. <summary>
  16777. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  16778. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  16779. </summary>
  16780. <remarks>
  16781. <para>
  16782. Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
  16783. </para>
  16784. <para>
  16785. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  16786. the formatting of the date. The following values are allowed:
  16787. <list type="definition">
  16788. <listheader>
  16789. <term>Option value</term>
  16790. <description>Output</description>
  16791. </listheader>
  16792. <item>
  16793. <term>ISO8601</term>
  16794. <description>
  16795. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  16796. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  16797. </description>
  16798. </item>
  16799. <item>
  16800. <term>DATE</term>
  16801. <description>
  16802. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  16803. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  16804. </description>
  16805. </item>
  16806. <item>
  16807. <term>ABSOLUTE</term>
  16808. <description>
  16809. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  16810. Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
  16811. </description>
  16812. </item>
  16813. <item>
  16814. <term>other</term>
  16815. <description>
  16816. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  16817. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  16818. <see cref="M:DateTime.ToString(string)"/> method.
  16819. For details on valid patterns see
  16820. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  16821. </description>
  16822. </item>
  16823. </list>
  16824. </para>
  16825. <para>
  16826. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
  16827. To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
  16828. </para>
  16829. </remarks>
  16830. <author>Nicko Cadell</author>
  16831. </member>
  16832. <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
  16833. <summary>
  16834. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  16835. </summary>
  16836. <remarks>
  16837. <para>
  16838. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  16839. </para>
  16840. </remarks>
  16841. </member>
  16842. <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
  16843. <summary>
  16844. Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  16845. </summary>
  16846. <remarks>
  16847. <para>
  16848. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16849. activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
  16850. be called on this object after the configuration properties have
  16851. been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
  16852. object is in an undefined state and must not be used.
  16853. </para>
  16854. <para>
  16855. If any of the configuration properties are modified then
  16856. <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
  16857. </para>
  16858. </remarks>
  16859. </member>
  16860. <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16861. <summary>
  16862. Convert the pattern into the rendered message
  16863. </summary>
  16864. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16865. <param name="loggingEvent">the event being logged</param>
  16866. <remarks>
  16867. <para>
  16868. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  16869. for it to render it to the writer.
  16870. </para>
  16871. <para>
  16872. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
  16873. </para>
  16874. </remarks>
  16875. </member>
  16876. <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
  16877. <summary>
  16878. The fully qualified type of the DatePatternConverter class.
  16879. </summary>
  16880. <remarks>
  16881. Used by the internal logger to record the Type of the
  16882. log message.
  16883. </remarks>
  16884. </member>
  16885. <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
  16886. <summary>
  16887. Write the exception text to the output
  16888. </summary>
  16889. <remarks>
  16890. <para>
  16891. If an exception object is stored in the logging event
  16892. it will be rendered into the pattern output with a
  16893. trailing newline.
  16894. </para>
  16895. <para>
  16896. If there is no exception then nothing will be output
  16897. and no trailing newline will be appended.
  16898. It is typical to put a newline before the exception
  16899. and to have the exception as the last data in the pattern.
  16900. </para>
  16901. </remarks>
  16902. <author>Nicko Cadell</author>
  16903. </member>
  16904. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
  16905. <summary>
  16906. Default constructor
  16907. </summary>
  16908. </member>
  16909. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16910. <summary>
  16911. Write the exception text to the output
  16912. </summary>
  16913. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16914. <param name="loggingEvent">the event being logged</param>
  16915. <remarks>
  16916. <para>
  16917. If an exception object is stored in the logging event
  16918. it will be rendered into the pattern output with a
  16919. trailing newline.
  16920. </para>
  16921. <para>
  16922. If there is no exception or the exception property specified
  16923. by the Option value does not exist then nothing will be output
  16924. and no trailing newline will be appended.
  16925. It is typical to put a newline before the exception
  16926. and to have the exception as the last data in the pattern.
  16927. </para>
  16928. <para>
  16929. Recognized values for the Option parameter are:
  16930. </para>
  16931. <list type="bullet">
  16932. <item>
  16933. <description>Message</description>
  16934. </item>
  16935. <item>
  16936. <description>Source</description>
  16937. </item>
  16938. <item>
  16939. <description>StackTrace</description>
  16940. </item>
  16941. <item>
  16942. <description>TargetSite</description>
  16943. </item>
  16944. <item>
  16945. <description>HelpLink</description>
  16946. </item>
  16947. </list>
  16948. </remarks>
  16949. </member>
  16950. <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
  16951. <summary>
  16952. Writes the caller location file name to the output
  16953. </summary>
  16954. <remarks>
  16955. <para>
  16956. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  16957. the event to the output writer.
  16958. </para>
  16959. </remarks>
  16960. <author>Nicko Cadell</author>
  16961. </member>
  16962. <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16963. <summary>
  16964. Write the caller location file name to the output
  16965. </summary>
  16966. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16967. <param name="loggingEvent">the event being logged</param>
  16968. <remarks>
  16969. <para>
  16970. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  16971. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  16972. </para>
  16973. </remarks>
  16974. </member>
  16975. <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
  16976. <summary>
  16977. Write the caller location info to the output
  16978. </summary>
  16979. <remarks>
  16980. <para>
  16981. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  16982. </para>
  16983. </remarks>
  16984. <author>Nicko Cadell</author>
  16985. </member>
  16986. <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16987. <summary>
  16988. Write the caller location info to the output
  16989. </summary>
  16990. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16991. <param name="loggingEvent">the event being logged</param>
  16992. <remarks>
  16993. <para>
  16994. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  16995. </para>
  16996. </remarks>
  16997. </member>
  16998. <member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
  16999. <summary>
  17000. Writes the event identity to the output
  17001. </summary>
  17002. <remarks>
  17003. <para>
  17004. Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17005. the output writer.
  17006. </para>
  17007. </remarks>
  17008. <author>Daniel Cazzulino</author>
  17009. <author>Nicko Cadell</author>
  17010. </member>
  17011. <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17012. <summary>
  17013. Writes the event identity to the output
  17014. </summary>
  17015. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17016. <param name="loggingEvent">the event being logged</param>
  17017. <remarks>
  17018. <para>
  17019. Writes the value of the <paramref name="loggingEvent"/>
  17020. <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17021. the output <paramref name="writer"/>.
  17022. </para>
  17023. </remarks>
  17024. </member>
  17025. <member name="T:log4net.Layout.Pattern.LevelPatternConverter">
  17026. <summary>
  17027. Write the event level to the output
  17028. </summary>
  17029. <remarks>
  17030. <para>
  17031. Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17032. to the writer.
  17033. </para>
  17034. </remarks>
  17035. <author>Nicko Cadell</author>
  17036. </member>
  17037. <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17038. <summary>
  17039. Write the event level to the output
  17040. </summary>
  17041. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17042. <param name="loggingEvent">the event being logged</param>
  17043. <remarks>
  17044. <para>
  17045. Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17046. to the <paramref name="writer"/>.
  17047. </para>
  17048. </remarks>
  17049. </member>
  17050. <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
  17051. <summary>
  17052. Write the caller location line number to the output
  17053. </summary>
  17054. <remarks>
  17055. <para>
  17056. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17057. the event to the output writer.
  17058. </para>
  17059. </remarks>
  17060. <author>Nicko Cadell</author>
  17061. </member>
  17062. <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17063. <summary>
  17064. Write the caller location line number to the output
  17065. </summary>
  17066. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17067. <param name="loggingEvent">the event being logged</param>
  17068. <remarks>
  17069. <para>
  17070. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17071. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  17072. </para>
  17073. </remarks>
  17074. </member>
  17075. <member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
  17076. <summary>
  17077. Converter for logger name
  17078. </summary>
  17079. <remarks>
  17080. <para>
  17081. Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
  17082. </para>
  17083. </remarks>
  17084. <author>Nicko Cadell</author>
  17085. </member>
  17086. <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17087. <summary>
  17088. Gets the fully qualified name of the logger
  17089. </summary>
  17090. <param name="loggingEvent">the event being logged</param>
  17091. <returns>The fully qualified logger name</returns>
  17092. <remarks>
  17093. <para>
  17094. Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
  17095. </para>
  17096. </remarks>
  17097. </member>
  17098. <member name="T:log4net.Layout.Pattern.MessagePatternConverter">
  17099. <summary>
  17100. Writes the event message to the output
  17101. </summary>
  17102. <remarks>
  17103. <para>
  17104. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  17105. to write out the event message.
  17106. </para>
  17107. </remarks>
  17108. <author>Nicko Cadell</author>
  17109. </member>
  17110. <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17111. <summary>
  17112. Writes the event message 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 event being logged</param>
  17116. <remarks>
  17117. <para>
  17118. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  17119. to write out the event message.
  17120. </para>
  17121. </remarks>
  17122. </member>
  17123. <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
  17124. <summary>
  17125. Write the method name to the output
  17126. </summary>
  17127. <remarks>
  17128. <para>
  17129. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  17130. the output.
  17131. </para>
  17132. </remarks>
  17133. <author>Nicko Cadell</author>
  17134. </member>
  17135. <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17136. <summary>
  17137. Write the method name to the output
  17138. </summary>
  17139. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17140. <param name="loggingEvent">the event being logged</param>
  17141. <remarks>
  17142. <para>
  17143. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  17144. the output.
  17145. </para>
  17146. </remarks>
  17147. </member>
  17148. <member name="T:log4net.Layout.Pattern.NamedPatternConverter">
  17149. <summary>
  17150. Converter to output and truncate <c>'.'</c> separated strings
  17151. </summary>
  17152. <remarks>
  17153. <para>
  17154. This abstract class supports truncating a <c>'.'</c> separated string
  17155. to show a specified number of elements from the right hand side.
  17156. This is used to truncate class names that are fully qualified.
  17157. </para>
  17158. <para>
  17159. Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
  17160. return the fully qualified string.
  17161. </para>
  17162. </remarks>
  17163. <author>Nicko Cadell</author>
  17164. </member>
  17165. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
  17166. <summary>
  17167. Initialize the converter
  17168. </summary>
  17169. <remarks>
  17170. <para>
  17171. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17172. activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
  17173. be called on this object after the configuration properties have
  17174. been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
  17175. object is in an undefined state and must not be used.
  17176. </para>
  17177. <para>
  17178. If any of the configuration properties are modified then
  17179. <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
  17180. </para>
  17181. </remarks>
  17182. </member>
  17183. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17184. <summary>
  17185. Get the fully qualified string data
  17186. </summary>
  17187. <param name="loggingEvent">the event being logged</param>
  17188. <returns>the fully qualified name</returns>
  17189. <remarks>
  17190. <para>
  17191. Overridden by subclasses to get the fully qualified name before the
  17192. precision is applied to it.
  17193. </para>
  17194. <para>
  17195. Return the fully qualified <c>'.'</c> (dot/period) separated string.
  17196. </para>
  17197. </remarks>
  17198. </member>
  17199. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17200. <summary>
  17201. Convert the pattern to the rendered message
  17202. </summary>
  17203. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17204. <param name="loggingEvent">the event being logged</param>
  17205. <remarks>
  17206. Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
  17207. specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  17208. </remarks>
  17209. </member>
  17210. <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
  17211. <summary>
  17212. The fully qualified type of the NamedPatternConverter class.
  17213. </summary>
  17214. <remarks>
  17215. Used by the internal logger to record the Type of the
  17216. log message.
  17217. </remarks>
  17218. </member>
  17219. <member name="T:log4net.Layout.Pattern.NdcPatternConverter">
  17220. <summary>
  17221. Converter to include event NDC
  17222. </summary>
  17223. <remarks>
  17224. <para>
  17225. Outputs the value of the event property named <c>NDC</c>.
  17226. </para>
  17227. <para>
  17228. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  17229. </para>
  17230. </remarks>
  17231. <author>Nicko Cadell</author>
  17232. </member>
  17233. <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17234. <summary>
  17235. Write the event NDC to the output
  17236. </summary>
  17237. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17238. <param name="loggingEvent">the event being logged</param>
  17239. <remarks>
  17240. <para>
  17241. As the thread context stacks are now stored in named event properties
  17242. this converter simply looks up the value of the <c>NDC</c> property.
  17243. </para>
  17244. <para>
  17245. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  17246. </para>
  17247. </remarks>
  17248. </member>
  17249. <member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
  17250. <summary>
  17251. Abstract class that provides the formatting functionality that
  17252. derived classes need.
  17253. </summary>
  17254. <remarks>
  17255. Conversion specifiers in a conversion patterns are parsed to
  17256. individual PatternConverters. Each of which is responsible for
  17257. converting a logging event in a converter specific manner.
  17258. </remarks>
  17259. <author>Nicko Cadell</author>
  17260. </member>
  17261. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
  17262. <summary>
  17263. Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter" /> class.
  17264. </summary>
  17265. </member>
  17266. <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
  17267. <summary>
  17268. Flag indicating if this converter handles the logging event exception
  17269. </summary>
  17270. <value><c>false</c> if this converter handles the logging event exception</value>
  17271. <remarks>
  17272. <para>
  17273. If this converter handles the exception object contained within
  17274. <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
  17275. <c>false</c>. Otherwise, if the layout ignores the exception
  17276. object, then the property should be set to <c>true</c>.
  17277. </para>
  17278. <para>
  17279. Set this value to override a this default setting. The default
  17280. value is <c>true</c>, this converter does not handle the exception.
  17281. </para>
  17282. </remarks>
  17283. </member>
  17284. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17285. <summary>
  17286. Derived pattern converters must override this method in order to
  17287. convert conversion specifiers in the correct way.
  17288. </summary>
  17289. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17290. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent" /> on which the pattern converter should be executed.</param>
  17291. </member>
  17292. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
  17293. <summary>
  17294. Derived pattern converters must override this method in order to
  17295. convert conversion specifiers in the correct way.
  17296. </summary>
  17297. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17298. <param name="state">The state object on which the pattern converter should be executed.</param>
  17299. </member>
  17300. <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
  17301. <summary>
  17302. Flag indicating if this converter handles exceptions
  17303. </summary>
  17304. <remarks>
  17305. <c>false</c> if this converter handles exceptions
  17306. </remarks>
  17307. </member>
  17308. <member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
  17309. <summary>
  17310. Property pattern converter
  17311. </summary>
  17312. <remarks>
  17313. <para>
  17314. Writes out the value of a named property. The property name
  17315. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17316. property.
  17317. </para>
  17318. <para>
  17319. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  17320. then all the properties are written as key value pairs.
  17321. </para>
  17322. </remarks>
  17323. <author>Nicko Cadell</author>
  17324. </member>
  17325. <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17326. <summary>
  17327. Write the property value to the output
  17328. </summary>
  17329. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17330. <param name="loggingEvent">the event being logged</param>
  17331. <remarks>
  17332. <para>
  17333. Writes out the value of a named property. The property name
  17334. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17335. property.
  17336. </para>
  17337. <para>
  17338. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  17339. then all the properties are written as key value pairs.
  17340. </para>
  17341. </remarks>
  17342. </member>
  17343. <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
  17344. <summary>
  17345. Converter to output the relative time of the event
  17346. </summary>
  17347. <remarks>
  17348. <para>
  17349. Converter to output the time of the event relative to the start of the program.
  17350. </para>
  17351. </remarks>
  17352. <author>Nicko Cadell</author>
  17353. </member>
  17354. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17355. <summary>
  17356. Write the relative time to the output
  17357. </summary>
  17358. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17359. <param name="loggingEvent">the event being logged</param>
  17360. <remarks>
  17361. <para>
  17362. Writes out the relative time of the event in milliseconds.
  17363. That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  17364. and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
  17365. </para>
  17366. </remarks>
  17367. </member>
  17368. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
  17369. <summary>
  17370. Helper method to get the time difference between two DateTime objects
  17371. </summary>
  17372. <param name="start">start time (in the current local time zone)</param>
  17373. <param name="end">end time (in the current local time zone)</param>
  17374. <returns>the time difference in milliseconds</returns>
  17375. </member>
  17376. <member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
  17377. <summary>
  17378. Converter to include event thread name
  17379. </summary>
  17380. <remarks>
  17381. <para>
  17382. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
  17383. </para>
  17384. </remarks>
  17385. <author>Nicko Cadell</author>
  17386. </member>
  17387. <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17388. <summary>
  17389. Write the ThreadName to the output
  17390. </summary>
  17391. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17392. <param name="loggingEvent">the event being logged</param>
  17393. <remarks>
  17394. <para>
  17395. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer" />.
  17396. </para>
  17397. </remarks>
  17398. </member>
  17399. <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
  17400. <summary>
  17401. Pattern converter for the class name
  17402. </summary>
  17403. <remarks>
  17404. <para>
  17405. Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
  17406. </para>
  17407. </remarks>
  17408. <author>Nicko Cadell</author>
  17409. </member>
  17410. <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17411. <summary>
  17412. Gets the fully qualified name of the class
  17413. </summary>
  17414. <param name="loggingEvent">the event being logged</param>
  17415. <returns>The fully qualified type name for the caller location</returns>
  17416. <remarks>
  17417. <para>
  17418. Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
  17419. </para>
  17420. </remarks>
  17421. </member>
  17422. <member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
  17423. <summary>
  17424. Converter to include event user name
  17425. </summary>
  17426. <author>Douglas de la Torre</author>
  17427. <author>Nicko Cadell</author>
  17428. </member>
  17429. <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17430. <summary>
  17431. Convert the pattern to the rendered message
  17432. </summary>
  17433. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17434. <param name="loggingEvent">the event being logged</param>
  17435. </member>
  17436. <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
  17437. <summary>
  17438. Write the TimeStamp to the output
  17439. </summary>
  17440. <remarks>
  17441. <para>
  17442. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  17443. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  17444. </para>
  17445. <para>
  17446. Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  17447. in Universal time.
  17448. </para>
  17449. <para>
  17450. See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
  17451. </para>
  17452. </remarks>
  17453. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  17454. <author>Nicko Cadell</author>
  17455. </member>
  17456. <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17457. <summary>
  17458. Write the TimeStamp to the output
  17459. </summary>
  17460. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17461. <param name="loggingEvent">the event being logged</param>
  17462. <remarks>
  17463. <para>
  17464. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  17465. for it to render it to the writer.
  17466. </para>
  17467. <para>
  17468. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
  17469. to Universal time before it is rendered.
  17470. </para>
  17471. </remarks>
  17472. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  17473. </member>
  17474. <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
  17475. <summary>
  17476. The fully qualified type of the UtcDatePatternConverter class.
  17477. </summary>
  17478. <remarks>
  17479. Used by the internal logger to record the Type of the
  17480. log message.
  17481. </remarks>
  17482. </member>
  17483. <member name="T:log4net.Layout.RawLayoutConverter">
  17484. <summary>
  17485. Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
  17486. </summary>
  17487. <remarks>
  17488. <para>
  17489. Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
  17490. Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
  17491. the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
  17492. </para>
  17493. </remarks>
  17494. <author>Nicko Cadell</author>
  17495. <author>Gert Driesen</author>
  17496. </member>
  17497. <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
  17498. <summary>
  17499. Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
  17500. </summary>
  17501. <param name="sourceType">the source to be to be converted</param>
  17502. <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
  17503. <remarks>
  17504. <para>
  17505. Test if the <paramref name="sourceType"/> can be converted to a
  17506. <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
  17507. as the <paramref name="sourceType"/>.
  17508. </para>
  17509. </remarks>
  17510. </member>
  17511. <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
  17512. <summary>
  17513. Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
  17514. </summary>
  17515. <param name="source">the value to convert</param>
  17516. <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
  17517. <remarks>
  17518. <para>
  17519. Convert the <paramref name="source"/> object to a
  17520. <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
  17521. is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
  17522. is used to adapt between the two interfaces, otherwise an
  17523. exception is thrown.
  17524. </para>
  17525. </remarks>
  17526. </member>
  17527. <member name="T:log4net.Layout.RawPropertyLayout">
  17528. <summary>
  17529. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  17530. </summary>
  17531. <remarks>
  17532. <para>
  17533. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  17534. </para>
  17535. </remarks>
  17536. <author>Nicko Cadell</author>
  17537. </member>
  17538. <member name="M:log4net.Layout.RawPropertyLayout.#ctor">
  17539. <summary>
  17540. Constructs a RawPropertyLayout
  17541. </summary>
  17542. </member>
  17543. <member name="P:log4net.Layout.RawPropertyLayout.Key">
  17544. <summary>
  17545. The name of the value to lookup in the LoggingEvent Properties collection.
  17546. </summary>
  17547. <value>
  17548. Value to lookup in the LoggingEvent Properties collection
  17549. </value>
  17550. <remarks>
  17551. <para>
  17552. String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
  17553. </para>
  17554. </remarks>
  17555. </member>
  17556. <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
  17557. <summary>
  17558. Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
  17559. </summary>
  17560. <param name="loggingEvent">The event to format</param>
  17561. <returns>returns property value</returns>
  17562. <remarks>
  17563. <para>
  17564. Looks up and returns the object value of the property
  17565. named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
  17566. with than name then <c>null</c> will be returned.
  17567. </para>
  17568. </remarks>
  17569. </member>
  17570. <member name="T:log4net.Layout.RawTimeStampLayout">
  17571. <summary>
  17572. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  17573. </summary>
  17574. <remarks>
  17575. <para>
  17576. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  17577. </para>
  17578. </remarks>
  17579. <author>Nicko Cadell</author>
  17580. <author>Gert Driesen</author>
  17581. </member>
  17582. <member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
  17583. <summary>
  17584. Constructs a RawTimeStampLayout
  17585. </summary>
  17586. </member>
  17587. <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  17588. <summary>
  17589. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  17590. </summary>
  17591. <param name="loggingEvent">The event to format</param>
  17592. <returns>returns the time stamp</returns>
  17593. <remarks>
  17594. <para>
  17595. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  17596. </para>
  17597. <para>
  17598. The time stamp is in local time. To format the time stamp
  17599. in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
  17600. </para>
  17601. </remarks>
  17602. </member>
  17603. <member name="T:log4net.Layout.RawUtcTimeStampLayout">
  17604. <summary>
  17605. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  17606. </summary>
  17607. <remarks>
  17608. <para>
  17609. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  17610. </para>
  17611. </remarks>
  17612. <author>Nicko Cadell</author>
  17613. <author>Gert Driesen</author>
  17614. </member>
  17615. <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
  17616. <summary>
  17617. Constructs a RawUtcTimeStampLayout
  17618. </summary>
  17619. </member>
  17620. <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  17621. <summary>
  17622. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  17623. </summary>
  17624. <param name="loggingEvent">The event to format</param>
  17625. <returns>returns the time stamp</returns>
  17626. <remarks>
  17627. <para>
  17628. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  17629. </para>
  17630. <para>
  17631. The time stamp is in universal time. To format the time stamp
  17632. in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
  17633. </para>
  17634. </remarks>
  17635. </member>
  17636. <member name="T:log4net.Layout.SimpleLayout">
  17637. <summary>
  17638. A very simple layout
  17639. </summary>
  17640. <remarks>
  17641. <para>
  17642. SimpleLayout consists of the level of the log statement,
  17643. followed by " - " and then the log message itself. For example,
  17644. <code>
  17645. DEBUG - Hello world
  17646. </code>
  17647. </para>
  17648. </remarks>
  17649. <author>Nicko Cadell</author>
  17650. <author>Gert Driesen</author>
  17651. </member>
  17652. <member name="M:log4net.Layout.SimpleLayout.#ctor">
  17653. <summary>
  17654. Constructs a SimpleLayout
  17655. </summary>
  17656. </member>
  17657. <member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
  17658. <summary>
  17659. Initialize layout options
  17660. </summary>
  17661. <remarks>
  17662. <para>
  17663. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17664. activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
  17665. be called on this object after the configuration properties have
  17666. been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
  17667. object is in an undefined state and must not be used.
  17668. </para>
  17669. <para>
  17670. If any of the configuration properties are modified then
  17671. <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
  17672. </para>
  17673. </remarks>
  17674. </member>
  17675. <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17676. <summary>
  17677. Produces a simple formatted output.
  17678. </summary>
  17679. <param name="loggingEvent">the event being logged</param>
  17680. <param name="writer">The TextWriter to write the formatted event to</param>
  17681. <remarks>
  17682. <para>
  17683. Formats the event as the level of the even,
  17684. followed by " - " and then the log message itself. The
  17685. output is terminated by a newline.
  17686. </para>
  17687. </remarks>
  17688. </member>
  17689. <member name="T:log4net.Layout.XmlLayout">
  17690. <summary>
  17691. Layout that formats the log events as XML elements.
  17692. </summary>
  17693. <remarks>
  17694. <para>
  17695. The output of the <see cref="T:log4net.Layout.XmlLayout" /> consists of a series of
  17696. log4net:event elements. It does not output a complete well-formed XML
  17697. file. The output is designed to be included as an <em>external entity</em>
  17698. in a separate file to form a correct XML file.
  17699. </para>
  17700. <para>
  17701. For example, if <c>abc</c> is the name of the file where
  17702. the <see cref="T:log4net.Layout.XmlLayout" /> output goes, then a well-formed XML file would
  17703. be:
  17704. </para>
  17705. <code lang="XML">
  17706. &lt;?xml version="1.0" ?&gt;
  17707. &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
  17708. &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
  17709. &amp;data;
  17710. &lt;/log4net:events&gt;
  17711. </code>
  17712. <para>
  17713. This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout" />
  17714. and the appender where it is embedded.
  17715. </para>
  17716. <para>
  17717. The <c>version</c> attribute helps components to correctly
  17718. interpret output generated by <see cref="T:log4net.Layout.XmlLayout" />. The value of
  17719. this attribute should be "1.2" for release 1.2 and later.
  17720. </para>
  17721. <para>
  17722. Alternatively the <c>Header</c> and <c>Footer</c> properties can be
  17723. configured to output the correct XML header, open tag and close tag.
  17724. When setting the <c>Header</c> and <c>Footer</c> properties it is essential
  17725. that the underlying data store not be appendable otherwise the data
  17726. will become invalid XML.
  17727. </para>
  17728. </remarks>
  17729. <author>Nicko Cadell</author>
  17730. <author>Gert Driesen</author>
  17731. </member>
  17732. <member name="M:log4net.Layout.XmlLayout.#ctor">
  17733. <summary>
  17734. Constructs an XmlLayout
  17735. </summary>
  17736. </member>
  17737. <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
  17738. <summary>
  17739. Constructs an XmlLayout.
  17740. </summary>
  17741. <remarks>
  17742. <para>
  17743. The <b>LocationInfo</b> option takes a boolean value. By
  17744. default, it is set to false which means there will be no location
  17745. information output by this layout. If the the option is set to
  17746. true, then the file name and line number of the statement
  17747. at the origin of the log statement will be output.
  17748. </para>
  17749. <para>
  17750. If you are embedding this layout within an SmtpAppender
  17751. then make sure to set the <b>LocationInfo</b> option of that
  17752. appender as well.
  17753. </para>
  17754. </remarks>
  17755. </member>
  17756. <member name="P:log4net.Layout.XmlLayout.Prefix">
  17757. <summary>
  17758. The prefix to use for all element names
  17759. </summary>
  17760. <remarks>
  17761. <para>
  17762. The default prefix is <b>log4net</b>. Set this property
  17763. to change the prefix. If the prefix is set to an empty string
  17764. then no prefix will be written.
  17765. </para>
  17766. </remarks>
  17767. </member>
  17768. <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
  17769. <summary>
  17770. Set whether or not to base64 encode the message.
  17771. </summary>
  17772. <remarks>
  17773. <para>
  17774. By default the log message will be written as text to the xml
  17775. output. This can cause problems when the message contains binary
  17776. data. By setting this to true the contents of the message will be
  17777. base64 encoded. If this is set then invalid character replacement
  17778. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  17779. on the log message.
  17780. </para>
  17781. </remarks>
  17782. </member>
  17783. <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
  17784. <summary>
  17785. Set whether or not to base64 encode the property values.
  17786. </summary>
  17787. <remarks>
  17788. <para>
  17789. By default the properties will be written as text to the xml
  17790. output. This can cause problems when one or more properties contain
  17791. binary data. By setting this to true the values of the properties
  17792. will be base64 encoded. If this is set then invalid character replacement
  17793. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  17794. on the property values.
  17795. </para>
  17796. </remarks>
  17797. </member>
  17798. <member name="M:log4net.Layout.XmlLayout.ActivateOptions">
  17799. <summary>
  17800. Initialize layout options
  17801. </summary>
  17802. <remarks>
  17803. <para>
  17804. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17805. activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
  17806. be called on this object after the configuration properties have
  17807. been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
  17808. object is in an undefined state and must not be used.
  17809. </para>
  17810. <para>
  17811. If any of the configuration properties are modified then
  17812. <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
  17813. </para>
  17814. <para>
  17815. Builds a cache of the element names
  17816. </para>
  17817. </remarks>
  17818. </member>
  17819. <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  17820. <summary>
  17821. Does the actual writing of the XML.
  17822. </summary>
  17823. <param name="writer">The writer to use to output the event to.</param>
  17824. <param name="loggingEvent">The event to write.</param>
  17825. <remarks>
  17826. <para>
  17827. Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
  17828. to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
  17829. </para>
  17830. </remarks>
  17831. </member>
  17832. <member name="F:log4net.Layout.XmlLayout.m_prefix">
  17833. <summary>
  17834. The prefix to use for all generated element names
  17835. </summary>
  17836. </member>
  17837. <member name="T:log4net.Layout.XmlLayoutBase">
  17838. <summary>
  17839. Layout that formats the log events as XML elements.
  17840. </summary>
  17841. <remarks>
  17842. <para>
  17843. This is an abstract class that must be subclassed by an implementation
  17844. to conform to a specific schema.
  17845. </para>
  17846. <para>
  17847. Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
  17848. </para>
  17849. </remarks>
  17850. <author>Nicko Cadell</author>
  17851. <author>Gert Driesen</author>
  17852. </member>
  17853. <member name="M:log4net.Layout.XmlLayoutBase.#ctor">
  17854. <summary>
  17855. Protected constructor to support subclasses
  17856. </summary>
  17857. <remarks>
  17858. <para>
  17859. Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase" /> class
  17860. with no location info.
  17861. </para>
  17862. </remarks>
  17863. </member>
  17864. <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
  17865. <summary>
  17866. Protected constructor to support subclasses
  17867. </summary>
  17868. <remarks>
  17869. <para>
  17870. The <paramref name="locationInfo" /> parameter determines whether
  17871. location information will be output by the layout. If
  17872. <paramref name="locationInfo" /> is set to <c>true</c>, then the
  17873. file name and line number of the statement at the origin of the log
  17874. statement will be output.
  17875. </para>
  17876. <para>
  17877. If you are embedding this layout within an SMTPAppender
  17878. then make sure to set the <b>LocationInfo</b> option of that
  17879. appender as well.
  17880. </para>
  17881. </remarks>
  17882. </member>
  17883. <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
  17884. <summary>
  17885. Gets a value indicating whether to include location information in
  17886. the XML events.
  17887. </summary>
  17888. <value>
  17889. <c>true</c> if location information should be included in the XML
  17890. events; otherwise, <c>false</c>.
  17891. </value>
  17892. <remarks>
  17893. <para>
  17894. If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo" /> is set to <c>true</c>, then the file
  17895. name and line number of the statement at the origin of the log
  17896. statement will be output.
  17897. </para>
  17898. <para>
  17899. If you are embedding this layout within an <c>SMTPAppender</c>
  17900. then make sure to set the <b>LocationInfo</b> option of that
  17901. appender as well.
  17902. </para>
  17903. </remarks>
  17904. </member>
  17905. <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
  17906. <summary>
  17907. The string to replace characters that can not be expressed in XML with.
  17908. <remarks>
  17909. <para>
  17910. Not all characters may be expressed in XML. This property contains the
  17911. string to replace those that can not with. This defaults to a ?. Set it
  17912. to the empty string to simply remove offending characters. For more
  17913. details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
  17914. Character replacement will occur in the log message, the property names
  17915. and the property values.
  17916. </para>
  17917. </remarks>
  17918. </summary>
  17919. </member>
  17920. <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
  17921. <summary>
  17922. Initialize layout options
  17923. </summary>
  17924. <remarks>
  17925. <para>
  17926. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17927. activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
  17928. be called on this object after the configuration properties have
  17929. been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
  17930. object is in an undefined state and must not be used.
  17931. </para>
  17932. <para>
  17933. If any of the configuration properties are modified then
  17934. <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
  17935. </para>
  17936. </remarks>
  17937. </member>
  17938. <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
  17939. <summary>
  17940. Gets the content type output by this layout.
  17941. </summary>
  17942. <value>
  17943. As this is the XML layout, the value is always <c>"text/xml"</c>.
  17944. </value>
  17945. <remarks>
  17946. <para>
  17947. As this is the XML layout, the value is always <c>"text/xml"</c>.
  17948. </para>
  17949. </remarks>
  17950. </member>
  17951. <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17952. <summary>
  17953. Produces a formatted string.
  17954. </summary>
  17955. <param name="loggingEvent">The event being logged.</param>
  17956. <param name="writer">The TextWriter to write the formatted event to</param>
  17957. <remarks>
  17958. <para>
  17959. Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
  17960. </para>
  17961. <para>
  17962. This method creates an <see cref="!:XmlTextWriter"/> that writes to the
  17963. <paramref name="writer"/>. The <see cref="!:XmlTextWriter"/> is passed
  17964. to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
  17965. <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
  17966. </para>
  17967. </remarks>
  17968. </member>
  17969. <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  17970. <summary>
  17971. Does the actual writing of the XML.
  17972. </summary>
  17973. <param name="writer">The writer to use to output the event to.</param>
  17974. <param name="loggingEvent">The event to write.</param>
  17975. <remarks>
  17976. <para>
  17977. Subclasses should override this method to format
  17978. the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
  17979. </para>
  17980. </remarks>
  17981. </member>
  17982. <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
  17983. <summary>
  17984. Flag to indicate if location information should be included in
  17985. the XML events.
  17986. </summary>
  17987. </member>
  17988. <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
  17989. <summary>
  17990. The string to replace invalid chars with
  17991. </summary>
  17992. </member>
  17993. <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
  17994. <summary>
  17995. Layout that formats the log events as XML elements compatible with the log4j schema
  17996. </summary>
  17997. <remarks>
  17998. <para>
  17999. Formats the log events according to the http://logging.apache.org/log4j schema.
  18000. </para>
  18001. </remarks>
  18002. <author>Nicko Cadell</author>
  18003. </member>
  18004. <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
  18005. <summary>
  18006. The 1st of January 1970 in UTC
  18007. </summary>
  18008. </member>
  18009. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
  18010. <summary>
  18011. Constructs an XMLLayoutSchemaLog4j
  18012. </summary>
  18013. </member>
  18014. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
  18015. <summary>
  18016. Constructs an XMLLayoutSchemaLog4j.
  18017. </summary>
  18018. <remarks>
  18019. <para>
  18020. The <b>LocationInfo</b> option takes a boolean value. By
  18021. default, it is set to false which means there will be no location
  18022. information output by this layout. If the the option is set to
  18023. true, then the file name and line number of the statement
  18024. at the origin of the log statement will be output.
  18025. </para>
  18026. <para>
  18027. If you are embedding this layout within an SMTPAppender
  18028. then make sure to set the <b>LocationInfo</b> option of that
  18029. appender as well.
  18030. </para>
  18031. </remarks>
  18032. </member>
  18033. <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
  18034. <summary>
  18035. The version of the log4j schema to use.
  18036. </summary>
  18037. <remarks>
  18038. <para>
  18039. Only version 1.2 of the log4j schema is supported.
  18040. </para>
  18041. </remarks>
  18042. </member>
  18043. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  18044. <summary>
  18045. Actually do the writing of the xml
  18046. </summary>
  18047. <param name="writer">the writer to use</param>
  18048. <param name="loggingEvent">the event to write</param>
  18049. <remarks>
  18050. <para>
  18051. Generate XML that is compatible with the log4j schema.
  18052. </para>
  18053. </remarks>
  18054. </member>
  18055. <member name="T:log4net.LogicalThreadContext">
  18056. <summary>
  18057. The log4net Logical Thread Context.
  18058. </summary>
  18059. <remarks>
  18060. <para>
  18061. The <c>LogicalThreadContext</c> provides a location for <see cref="!:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
  18062. information to be stored.
  18063. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
  18064. properties with the same name.
  18065. </para>
  18066. <para>
  18067. For .NET Standard 1.3 this class uses
  18068. System.Threading.AsyncLocal rather than <see
  18069. cref="!:System.Runtime.Remoting.Messaging.CallContext"/>.
  18070. </para>
  18071. <para>
  18072. The Logical Thread Context has a properties map and a stack.
  18073. The properties and stack can
  18074. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  18075. supports selecting and outputting these properties.
  18076. </para>
  18077. <para>
  18078. The Logical Thread Context provides a diagnostic context for the current call context.
  18079. This is an instrument for distinguishing interleaved log
  18080. output from different sources. Log output is typically interleaved
  18081. when a server handles multiple clients near-simultaneously.
  18082. </para>
  18083. <para>
  18084. The Logical Thread Context is managed on a per <see cref="!:System.Runtime.Remoting.Messaging.CallContext"/> basis.
  18085. </para>
  18086. <para>
  18087. The <see cref="!:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  18088. <see cref="!:System.Security.Permissions.SecurityPermission"/> for the
  18089. <see cref="!:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  18090. If the calling code does not have this permission then this context will be disabled.
  18091. It will not store any property values set on it.
  18092. </para>
  18093. </remarks>
  18094. <example>Example of using the thread context properties to store a username.
  18095. <code lang="C#">
  18096. LogicalThreadContext.Properties["user"] = userName;
  18097. log.Info("This log message has a LogicalThreadContext Property called 'user'");
  18098. </code>
  18099. </example>
  18100. <example>Example of how to push a message into the context stack
  18101. <code lang="C#">
  18102. using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
  18103. {
  18104. log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
  18105. } // at the end of the using block the message is automatically popped
  18106. </code>
  18107. </example>
  18108. <threadsafety static="true" instance="true" />
  18109. <author>Nicko Cadell</author>
  18110. </member>
  18111. <member name="M:log4net.LogicalThreadContext.#ctor">
  18112. <summary>
  18113. Private Constructor.
  18114. </summary>
  18115. <remarks>
  18116. <para>
  18117. Uses a private access modifier to prevent instantiation of this class.
  18118. </para>
  18119. </remarks>
  18120. </member>
  18121. <member name="P:log4net.LogicalThreadContext.Properties">
  18122. <summary>
  18123. The thread properties map
  18124. </summary>
  18125. <value>
  18126. The thread properties map
  18127. </value>
  18128. <remarks>
  18129. <para>
  18130. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
  18131. or <see cref="T:log4net.GlobalContext"/> properties with the same name.
  18132. </para>
  18133. </remarks>
  18134. </member>
  18135. <member name="P:log4net.LogicalThreadContext.Stacks">
  18136. <summary>
  18137. The thread stacks
  18138. </summary>
  18139. <value>
  18140. stack map
  18141. </value>
  18142. <remarks>
  18143. <para>
  18144. The logical thread stacks.
  18145. </para>
  18146. </remarks>
  18147. </member>
  18148. <member name="F:log4net.LogicalThreadContext.s_properties">
  18149. <summary>
  18150. The thread context properties instance
  18151. </summary>
  18152. </member>
  18153. <member name="F:log4net.LogicalThreadContext.s_stacks">
  18154. <summary>
  18155. The thread context stacks instance
  18156. </summary>
  18157. </member>
  18158. <member name="T:log4net.LogManager">
  18159. <summary>
  18160. This class is used by client applications to request logger instances.
  18161. </summary>
  18162. <remarks>
  18163. <para>
  18164. This class has static methods that are used by a client to request
  18165. a logger instance. The <see cref="M:GetLogger(string)"/> method is
  18166. used to retrieve a logger.
  18167. </para>
  18168. <para>
  18169. See the <see cref="T:log4net.ILog"/> interface for more details.
  18170. </para>
  18171. </remarks>
  18172. <example>Simple example of logging messages
  18173. <code lang="C#">
  18174. ILog log = LogManager.GetLogger("application-log");
  18175. log.Info("Application Start");
  18176. log.Debug("This is a debug message");
  18177. if (log.IsDebugEnabled)
  18178. {
  18179. log.Debug("This is another debug message");
  18180. }
  18181. </code>
  18182. </example>
  18183. <threadsafety static="true" instance="true" />
  18184. <seealso cref="T:log4net.ILog"/>
  18185. <author>Nicko Cadell</author>
  18186. <author>Gert Driesen</author>
  18187. </member>
  18188. <member name="M:log4net.LogManager.#ctor">
  18189. <summary>
  18190. Initializes a new instance of the <see cref="T:log4net.LogManager" /> class.
  18191. </summary>
  18192. <remarks>
  18193. Uses a private access modifier to prevent instantiation of this class.
  18194. </remarks>
  18195. </member>
  18196. <member name="M:log4net.LogManager.Exists(System.String,System.String)">
  18197. <summary>
  18198. Returns the named logger if it exists.
  18199. </summary>
  18200. <remarks>
  18201. <para>
  18202. If the named logger exists (in the specified repository) then it
  18203. returns a reference to the logger, otherwise it returns
  18204. <c>null</c>.
  18205. </para>
  18206. </remarks>
  18207. <param name="repository">The repository to lookup in.</param>
  18208. <param name="name">The fully qualified logger name to look for.</param>
  18209. <returns>
  18210. The logger found, or <c>null</c> if the logger doesn't exist in the specified
  18211. repository.
  18212. </returns>
  18213. </member>
  18214. <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
  18215. <summary>
  18216. Returns the named logger if it exists.
  18217. </summary>
  18218. <remarks>
  18219. <para>
  18220. If the named logger exists (in the repository for the specified assembly) then it
  18221. returns a reference to the logger, otherwise it returns
  18222. <c>null</c>.
  18223. </para>
  18224. </remarks>
  18225. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18226. <param name="name">The fully qualified logger name to look for.</param>
  18227. <returns>
  18228. The logger, or <c>null</c> if the logger doesn't exist in the specified
  18229. assembly's repository.
  18230. </returns>
  18231. </member>
  18232. <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
  18233. <summary>
  18234. Returns all the currently defined loggers in the specified repository.
  18235. </summary>
  18236. <param name="repository">The repository to lookup in.</param>
  18237. <remarks>
  18238. The root logger is <b>not</b> included in the returned array.
  18239. </remarks>
  18240. <returns>All the defined loggers.</returns>
  18241. </member>
  18242. <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
  18243. <summary>
  18244. Returns all the currently defined loggers in the specified assembly's repository.
  18245. </summary>
  18246. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18247. <remarks>
  18248. The root logger is <b>not</b> included in the returned array.
  18249. </remarks>
  18250. <returns>All the defined loggers.</returns>
  18251. </member>
  18252. <member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
  18253. <summary>
  18254. Retrieves or creates a named logger.
  18255. </summary>
  18256. <remarks>
  18257. <para>
  18258. Retrieve a logger named as the <paramref name="name"/>
  18259. parameter. If the named logger already exists, then the
  18260. existing instance will be returned. Otherwise, a new instance is
  18261. created.
  18262. </para>
  18263. <para>
  18264. By default, loggers do not have a set level but inherit
  18265. it from the hierarchy. This is one of the central features of
  18266. log4net.
  18267. </para>
  18268. </remarks>
  18269. <param name="repository">The repository to lookup in.</param>
  18270. <param name="name">The name of the logger to retrieve.</param>
  18271. <returns>The logger with the name specified.</returns>
  18272. </member>
  18273. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
  18274. <summary>
  18275. Retrieves or creates a named logger.
  18276. </summary>
  18277. <remarks>
  18278. <para>
  18279. Retrieve a logger named as the <paramref name="name"/>
  18280. parameter. If the named logger already exists, then the
  18281. existing instance will be returned. Otherwise, a new instance is
  18282. created.
  18283. </para>
  18284. <para>
  18285. By default, loggers do not have a set level but inherit
  18286. it from the hierarchy. This is one of the central features of
  18287. log4net.
  18288. </para>
  18289. </remarks>
  18290. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18291. <param name="name">The name of the logger to retrieve.</param>
  18292. <returns>The logger with the name specified.</returns>
  18293. </member>
  18294. <member name="M:log4net.LogManager.GetLogger(System.Type)">
  18295. <summary>
  18296. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  18297. </summary>
  18298. <remarks>
  18299. Get the logger for the fully qualified name of the type specified.
  18300. </remarks>
  18301. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  18302. <returns>The logger with the name specified.</returns>
  18303. </member>
  18304. <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
  18305. <summary>
  18306. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  18307. </summary>
  18308. <remarks>
  18309. Gets the logger for the fully qualified name of the type specified.
  18310. </remarks>
  18311. <param name="repository">The repository to lookup in.</param>
  18312. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  18313. <returns>The logger with the name specified.</returns>
  18314. </member>
  18315. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
  18316. <summary>
  18317. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  18318. </summary>
  18319. <remarks>
  18320. Gets the logger for the fully qualified name of the type specified.
  18321. </remarks>
  18322. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18323. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  18324. <returns>The logger with the name specified.</returns>
  18325. </member>
  18326. <member name="M:log4net.LogManager.Shutdown">
  18327. <summary>
  18328. Shuts down the log4net system.
  18329. </summary>
  18330. <remarks>
  18331. <para>
  18332. Calling this method will <b>safely</b> close and remove all
  18333. appenders in all the loggers including root contained in all the
  18334. default repositories.
  18335. </para>
  18336. <para>
  18337. Some appenders need to be closed before the application exists.
  18338. Otherwise, pending logging events might be lost.
  18339. </para>
  18340. <para>The <c>shutdown</c> method is careful to close nested
  18341. appenders before closing regular appenders. This is allows
  18342. configurations where a regular appender is attached to a logger
  18343. and again to a nested appender.
  18344. </para>
  18345. </remarks>
  18346. </member>
  18347. <member name="M:log4net.LogManager.ShutdownRepository(System.String)">
  18348. <summary>
  18349. Shuts down the repository for the repository specified.
  18350. </summary>
  18351. <remarks>
  18352. <para>
  18353. Calling this method will <b>safely</b> close and remove all
  18354. appenders in all the loggers including root contained in the
  18355. <paramref name="repository"/> specified.
  18356. </para>
  18357. <para>
  18358. Some appenders need to be closed before the application exists.
  18359. Otherwise, pending logging events might be lost.
  18360. </para>
  18361. <para>The <c>shutdown</c> method is careful to close nested
  18362. appenders before closing regular appenders. This is allows
  18363. configurations where a regular appender is attached to a logger
  18364. and again to a nested appender.
  18365. </para>
  18366. </remarks>
  18367. <param name="repository">The repository to shutdown.</param>
  18368. </member>
  18369. <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
  18370. <summary>
  18371. Shuts down the repository specified.
  18372. </summary>
  18373. <remarks>
  18374. <para>
  18375. Calling this method will <b>safely</b> close and remove all
  18376. appenders in all the loggers including root contained in the
  18377. repository. The repository is looked up using
  18378. the <paramref name="repositoryAssembly"/> specified.
  18379. </para>
  18380. <para>
  18381. Some appenders need to be closed before the application exists.
  18382. Otherwise, pending logging events might be lost.
  18383. </para>
  18384. <para>
  18385. The <c>shutdown</c> method is careful to close nested
  18386. appenders before closing regular appenders. This is allows
  18387. configurations where a regular appender is attached to a logger
  18388. and again to a nested appender.
  18389. </para>
  18390. </remarks>
  18391. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18392. </member>
  18393. <member name="M:log4net.LogManager.ResetConfiguration(System.String)">
  18394. <summary>
  18395. Resets all values contained in this repository instance to their defaults.
  18396. </summary>
  18397. <remarks>
  18398. <para>
  18399. Reset all values contained in the repository instance to their
  18400. defaults. This removes all appenders from all loggers, sets
  18401. the level of all non-root loggers to <c>null</c>,
  18402. sets their additivity flag to <c>true</c> and sets the level
  18403. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  18404. message disabling is set to its default "off" value.
  18405. </para>
  18406. </remarks>
  18407. <param name="repository">The repository to reset.</param>
  18408. </member>
  18409. <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
  18410. <summary>
  18411. Resets all values contained in this repository instance to their defaults.
  18412. </summary>
  18413. <remarks>
  18414. <para>
  18415. Reset all values contained in the repository instance to their
  18416. defaults. This removes all appenders from all loggers, sets
  18417. the level of all non-root loggers to <c>null</c>,
  18418. sets their additivity flag to <c>true</c> and sets the level
  18419. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  18420. message disabling is set to its default "off" value.
  18421. </para>
  18422. </remarks>
  18423. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  18424. </member>
  18425. <member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
  18426. <summary>
  18427. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  18428. </summary>
  18429. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  18430. <remarks>
  18431. <para>
  18432. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  18433. by the <paramref name="repository"/> argument.
  18434. </para>
  18435. </remarks>
  18436. <param name="repository">The repository to lookup in.</param>
  18437. </member>
  18438. <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
  18439. <summary>
  18440. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  18441. </summary>
  18442. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  18443. <remarks>
  18444. <para>
  18445. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  18446. by the <paramref name="repositoryAssembly"/> argument.
  18447. </para>
  18448. </remarks>
  18449. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18450. </member>
  18451. <member name="M:log4net.LogManager.GetRepository(System.String)">
  18452. <summary>
  18453. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  18454. </summary>
  18455. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  18456. <remarks>
  18457. <para>
  18458. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  18459. by the <paramref name="repository"/> argument.
  18460. </para>
  18461. </remarks>
  18462. <param name="repository">The repository to lookup in.</param>
  18463. </member>
  18464. <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
  18465. <summary>
  18466. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  18467. </summary>
  18468. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  18469. <remarks>
  18470. <para>
  18471. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  18472. by the <paramref name="repositoryAssembly"/> argument.
  18473. </para>
  18474. </remarks>
  18475. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18476. </member>
  18477. <member name="M:log4net.LogManager.CreateDomain(System.String)">
  18478. <summary>
  18479. Creates a repository with the specified name.
  18480. </summary>
  18481. <remarks>
  18482. <para>
  18483. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  18484. </para>
  18485. <para>
  18486. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  18487. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  18488. </para>
  18489. <para>
  18490. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  18491. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  18492. </para>
  18493. </remarks>
  18494. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  18495. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18496. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  18497. </member>
  18498. <member name="M:log4net.LogManager.CreateRepository(System.String)">
  18499. <summary>
  18500. Creates a repository with the specified name.
  18501. </summary>
  18502. <remarks>
  18503. <para>
  18504. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  18505. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  18506. </para>
  18507. <para>
  18508. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  18509. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  18510. </para>
  18511. </remarks>
  18512. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  18513. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18514. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  18515. </member>
  18516. <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
  18517. <summary>
  18518. Creates a repository with the specified name and repository type.
  18519. </summary>
  18520. <remarks>
  18521. <para>
  18522. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  18523. </para>
  18524. <para>
  18525. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  18526. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  18527. </para>
  18528. </remarks>
  18529. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  18530. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  18531. and has a no arg constructor. An instance of this type will be created to act
  18532. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  18533. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18534. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  18535. </member>
  18536. <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
  18537. <summary>
  18538. Creates a repository with the specified name and repository type.
  18539. </summary>
  18540. <remarks>
  18541. <para>
  18542. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  18543. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  18544. </para>
  18545. </remarks>
  18546. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  18547. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  18548. and has a no arg constructor. An instance of this type will be created to act
  18549. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  18550. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18551. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  18552. </member>
  18553. <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  18554. <summary>
  18555. Creates a repository for the specified assembly and repository type.
  18556. </summary>
  18557. <remarks>
  18558. <para>
  18559. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  18560. </para>
  18561. <para>
  18562. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  18563. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  18564. same assembly specified will return the same repository instance.
  18565. </para>
  18566. </remarks>
  18567. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  18568. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  18569. and has a no arg constructor. An instance of this type will be created to act
  18570. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  18571. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18572. </member>
  18573. <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  18574. <summary>
  18575. Creates a repository for the specified assembly and repository type.
  18576. </summary>
  18577. <remarks>
  18578. <para>
  18579. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  18580. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  18581. same assembly specified will return the same repository instance.
  18582. </para>
  18583. </remarks>
  18584. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  18585. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  18586. and has a no arg constructor. An instance of this type will be created to act
  18587. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  18588. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18589. </member>
  18590. <member name="M:log4net.LogManager.GetAllRepositories">
  18591. <summary>
  18592. Gets the list of currently defined repositories.
  18593. </summary>
  18594. <remarks>
  18595. <para>
  18596. Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
  18597. </para>
  18598. </remarks>
  18599. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  18600. </member>
  18601. <member name="M:log4net.LogManager.Flush(System.Int32)">
  18602. <summary>
  18603. Flushes logging events buffered in all configured appenders in the default repository.
  18604. </summary>
  18605. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed.</param>
  18606. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  18607. </member>
  18608. <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
  18609. <summary>
  18610. Looks up the wrapper object for the logger specified.
  18611. </summary>
  18612. <param name="logger">The logger to get the wrapper for.</param>
  18613. <returns>The wrapper for the logger specified.</returns>
  18614. </member>
  18615. <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
  18616. <summary>
  18617. Looks up the wrapper objects for the loggers specified.
  18618. </summary>
  18619. <param name="loggers">The loggers to get the wrappers for.</param>
  18620. <returns>The wrapper objects for the loggers specified.</returns>
  18621. </member>
  18622. <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
  18623. <summary>
  18624. Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
  18625. this manager.
  18626. </summary>
  18627. <param name="logger">The logger to wrap.</param>
  18628. <returns>The wrapper for the logger specified.</returns>
  18629. </member>
  18630. <member name="F:log4net.LogManager.s_wrapperMap">
  18631. <summary>
  18632. The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
  18633. </summary>
  18634. </member>
  18635. <member name="T:log4net.MDC">
  18636. <summary>
  18637. Implementation of Mapped Diagnostic Contexts.
  18638. </summary>
  18639. <remarks>
  18640. <note>
  18641. <para>
  18642. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18643. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18644. </para>
  18645. </note>
  18646. <para>
  18647. The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
  18648. based on a map instead of a stack. It provides <i>mapped
  18649. diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
  18650. MDC in short, is an instrument for distinguishing interleaved log
  18651. output from different sources. Log output is typically interleaved
  18652. when a server handles multiple clients near-simultaneously.
  18653. </para>
  18654. <para>
  18655. The MDC is managed on a per thread basis.
  18656. </para>
  18657. </remarks>
  18658. <threadsafety static="true" instance="true" />
  18659. <author>Nicko Cadell</author>
  18660. <author>Gert Driesen</author>
  18661. </member>
  18662. <member name="M:log4net.MDC.#ctor">
  18663. <summary>
  18664. Initializes a new instance of the <see cref="T:log4net.MDC" /> class.
  18665. </summary>
  18666. <remarks>
  18667. Uses a private access modifier to prevent instantiation of this class.
  18668. </remarks>
  18669. </member>
  18670. <member name="M:log4net.MDC.Get(System.String)">
  18671. <summary>
  18672. Gets the context value identified by the <paramref name="key" /> parameter.
  18673. </summary>
  18674. <param name="key">The key to lookup in the MDC.</param>
  18675. <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
  18676. <remarks>
  18677. <note>
  18678. <para>
  18679. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18680. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18681. </para>
  18682. </note>
  18683. <para>
  18684. If the <paramref name="key" /> parameter does not look up to a
  18685. previously defined context then <c>null</c> will be returned.
  18686. </para>
  18687. </remarks>
  18688. </member>
  18689. <member name="M:log4net.MDC.Set(System.String,System.String)">
  18690. <summary>
  18691. Add an entry to the MDC
  18692. </summary>
  18693. <param name="key">The key to store the value under.</param>
  18694. <param name="value">The value to store.</param>
  18695. <remarks>
  18696. <note>
  18697. <para>
  18698. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18699. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18700. </para>
  18701. </note>
  18702. <para>
  18703. Puts a context value (the <paramref name="value" /> parameter) as identified
  18704. with the <paramref name="key" /> parameter into the current thread's
  18705. context map.
  18706. </para>
  18707. <para>
  18708. If a value is already defined for the <paramref name="key" />
  18709. specified then the value will be replaced. If the <paramref name="value" />
  18710. is specified as <c>null</c> then the key value mapping will be removed.
  18711. </para>
  18712. </remarks>
  18713. </member>
  18714. <member name="M:log4net.MDC.Remove(System.String)">
  18715. <summary>
  18716. Removes the key value mapping for the key specified.
  18717. </summary>
  18718. <param name="key">The key to remove.</param>
  18719. <remarks>
  18720. <note>
  18721. <para>
  18722. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18723. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18724. </para>
  18725. </note>
  18726. <para>
  18727. Remove the specified entry from this thread's MDC
  18728. </para>
  18729. </remarks>
  18730. </member>
  18731. <member name="M:log4net.MDC.Clear">
  18732. <summary>
  18733. Clear all entries in the MDC
  18734. </summary>
  18735. <remarks>
  18736. <note>
  18737. <para>
  18738. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18739. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18740. </para>
  18741. </note>
  18742. <para>
  18743. Remove all the entries from this thread's MDC
  18744. </para>
  18745. </remarks>
  18746. </member>
  18747. <member name="T:log4net.NDC">
  18748. <summary>
  18749. Implementation of Nested Diagnostic Contexts.
  18750. </summary>
  18751. <remarks>
  18752. <note>
  18753. <para>
  18754. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18755. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18756. </para>
  18757. </note>
  18758. <para>
  18759. A Nested Diagnostic Context, or NDC in short, is an instrument
  18760. to distinguish interleaved log output from different sources. Log
  18761. output is typically interleaved when a server handles multiple
  18762. clients near-simultaneously.
  18763. </para>
  18764. <para>
  18765. Interleaved log output can still be meaningful if each log entry
  18766. from different contexts had a distinctive stamp. This is where NDCs
  18767. come into play.
  18768. </para>
  18769. <para>
  18770. Note that NDCs are managed on a per thread basis. The NDC class
  18771. is made up of static methods that operate on the context of the
  18772. calling thread.
  18773. </para>
  18774. </remarks>
  18775. <example>How to push a message into the context
  18776. <code lang="C#">
  18777. using(NDC.Push("my context message"))
  18778. {
  18779. ... all log calls will have 'my context message' included ...
  18780. } // at the end of the using block the message is automatically removed
  18781. </code>
  18782. </example>
  18783. <threadsafety static="true" instance="true" />
  18784. <author>Nicko Cadell</author>
  18785. <author>Gert Driesen</author>
  18786. </member>
  18787. <member name="M:log4net.NDC.#ctor">
  18788. <summary>
  18789. Initializes a new instance of the <see cref="T:log4net.NDC" /> class.
  18790. </summary>
  18791. <remarks>
  18792. Uses a private access modifier to prevent instantiation of this class.
  18793. </remarks>
  18794. </member>
  18795. <member name="P:log4net.NDC.Depth">
  18796. <summary>
  18797. Gets the current context depth.
  18798. </summary>
  18799. <value>The current context depth.</value>
  18800. <remarks>
  18801. <note>
  18802. <para>
  18803. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18804. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18805. </para>
  18806. </note>
  18807. <para>
  18808. The number of context values pushed onto the context stack.
  18809. </para>
  18810. <para>
  18811. Used to record the current depth of the context. This can then
  18812. be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
  18813. </para>
  18814. </remarks>
  18815. <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
  18816. </member>
  18817. <member name="M:log4net.NDC.Clear">
  18818. <summary>
  18819. Clears all the contextual information held on the current thread.
  18820. </summary>
  18821. <remarks>
  18822. <note>
  18823. <para>
  18824. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18825. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18826. </para>
  18827. </note>
  18828. <para>
  18829. Clears the stack of NDC data held on the current thread.
  18830. </para>
  18831. </remarks>
  18832. </member>
  18833. <member name="M:log4net.NDC.CloneStack">
  18834. <summary>
  18835. Creates a clone of the stack of context information.
  18836. </summary>
  18837. <returns>A clone of the context info for this thread.</returns>
  18838. <remarks>
  18839. <note>
  18840. <para>
  18841. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18842. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18843. </para>
  18844. </note>
  18845. <para>
  18846. The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
  18847. method to allow child threads to inherit the context of their
  18848. parent thread.
  18849. </para>
  18850. </remarks>
  18851. </member>
  18852. <member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
  18853. <summary>
  18854. Inherits the contextual information from another thread.
  18855. </summary>
  18856. <param name="stack">The context stack to inherit.</param>
  18857. <remarks>
  18858. <note>
  18859. <para>
  18860. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18861. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18862. </para>
  18863. </note>
  18864. <para>
  18865. This thread will use the context information from the stack
  18866. supplied. This can be used to initialize child threads with
  18867. the same contextual information as their parent threads. These
  18868. contexts will <b>NOT</b> be shared. Any further contexts that
  18869. are pushed onto the stack will not be visible to the other.
  18870. Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
  18871. this method.
  18872. </para>
  18873. </remarks>
  18874. </member>
  18875. <member name="M:log4net.NDC.Pop">
  18876. <summary>
  18877. Removes the top context from the stack.
  18878. </summary>
  18879. <returns>
  18880. The message in the context that was removed from the top
  18881. of the stack.
  18882. </returns>
  18883. <remarks>
  18884. <note>
  18885. <para>
  18886. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18887. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18888. </para>
  18889. </note>
  18890. <para>
  18891. Remove the top context from the stack, and return
  18892. it to the caller. If the stack is empty then an
  18893. empty string (not <c>null</c>) is returned.
  18894. </para>
  18895. </remarks>
  18896. </member>
  18897. <member name="M:log4net.NDC.Push(System.String)">
  18898. <summary>
  18899. Pushes a new context message.
  18900. </summary>
  18901. <param name="message">The new context message.</param>
  18902. <returns>
  18903. An <see cref="T:System.IDisposable"/> that can be used to clean up
  18904. the context stack.
  18905. </returns>
  18906. <remarks>
  18907. <note>
  18908. <para>
  18909. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18910. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18911. </para>
  18912. </note>
  18913. <para>
  18914. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  18915. is returned that can be used to clean up the context stack. This
  18916. can be easily combined with the <c>using</c> keyword to scope the
  18917. context.
  18918. </para>
  18919. </remarks>
  18920. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  18921. <code lang="C#">
  18922. using(log4net.NDC.Push("NDC_Message"))
  18923. {
  18924. log.Warn("This should have an NDC message");
  18925. }
  18926. </code>
  18927. </example>
  18928. </member>
  18929. <member name="M:log4net.NDC.PushFormat(System.String,System.Object[])">
  18930. <summary>
  18931. Pushes a new context message.
  18932. </summary>
  18933. <param name="messageFormat">The new context message string format.</param>
  18934. <param name="args">Arguments to be passed into messageFormat.</param>
  18935. <returns>
  18936. An <see cref="T:System.IDisposable"/> that can be used to clean up
  18937. the context stack.
  18938. </returns>
  18939. <remarks>
  18940. <note>
  18941. <para>
  18942. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18943. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18944. </para>
  18945. </note>
  18946. <para>
  18947. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  18948. is returned that can be used to clean up the context stack. This
  18949. can be easily combined with the <c>using</c> keyword to scope the
  18950. context.
  18951. </para>
  18952. </remarks>
  18953. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  18954. <code lang="C#">
  18955. var someValue = "ExampleContext"
  18956. using(log4net.NDC.PushFormat("NDC_Message {0}", someValue))
  18957. {
  18958. log.Warn("This should have an NDC message");
  18959. }
  18960. </code>
  18961. </example>
  18962. </member>
  18963. <member name="M:log4net.NDC.Remove">
  18964. <summary>
  18965. Removes the context information for this thread. It is
  18966. not required to call this method.
  18967. </summary>
  18968. <remarks>
  18969. <note>
  18970. <para>
  18971. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18972. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18973. </para>
  18974. </note>
  18975. <para>
  18976. This method is not implemented.
  18977. </para>
  18978. </remarks>
  18979. </member>
  18980. <member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
  18981. <summary>
  18982. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  18983. </summary>
  18984. <param name="maxDepth">The maximum depth of the stack</param>
  18985. <remarks>
  18986. <note>
  18987. <para>
  18988. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18989. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18990. </para>
  18991. </note>
  18992. <para>
  18993. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  18994. This may truncate the head of the stack. This only affects the
  18995. stack in the current thread. Also it does not prevent it from
  18996. growing, it only sets the maximum depth at the time of the
  18997. call. This can be used to return to a known context depth.
  18998. </para>
  18999. </remarks>
  19000. </member>
  19001. <member name="T:log4net.ObjectRenderer.DefaultRenderer">
  19002. <summary>
  19003. The default object Renderer.
  19004. </summary>
  19005. <remarks>
  19006. <para>
  19007. The default renderer supports rendering objects and collections to strings.
  19008. </para>
  19009. <para>
  19010. See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
  19011. </para>
  19012. </remarks>
  19013. <author>Nicko Cadell</author>
  19014. <author>Gert Driesen</author>
  19015. </member>
  19016. <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
  19017. <summary>
  19018. Default constructor
  19019. </summary>
  19020. <remarks>
  19021. <para>
  19022. Default constructor
  19023. </para>
  19024. </remarks>
  19025. </member>
  19026. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  19027. <summary>
  19028. Render the object <paramref name="obj"/> to a string
  19029. </summary>
  19030. <param name="rendererMap">The map used to lookup renderers</param>
  19031. <param name="obj">The object to render</param>
  19032. <param name="writer">The writer to render to</param>
  19033. <remarks>
  19034. <para>
  19035. Render the object <paramref name="obj"/> to a string.
  19036. </para>
  19037. <para>
  19038. The <paramref name="rendererMap"/> parameter is
  19039. provided to lookup and render other objects. This is
  19040. very useful where <paramref name="obj"/> contains
  19041. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
  19042. method can be used to render these objects.
  19043. </para>
  19044. <para>
  19045. The default renderer supports rendering objects to strings as follows:
  19046. </para>
  19047. <list type="table">
  19048. <listheader>
  19049. <term>Value</term>
  19050. <description>Rendered String</description>
  19051. </listheader>
  19052. <item>
  19053. <term><c>null</c></term>
  19054. <description>
  19055. <para>"(null)"</para>
  19056. </description>
  19057. </item>
  19058. <item>
  19059. <term><see cref="T:System.Array"/></term>
  19060. <description>
  19061. <para>
  19062. For a one dimensional array this is the
  19063. array type name, an open brace, followed by a comma
  19064. separated list of the elements (using the appropriate
  19065. renderer), followed by a close brace.
  19066. </para>
  19067. <para>
  19068. For example: <c>int[] {1, 2, 3}</c>.
  19069. </para>
  19070. <para>
  19071. If the array is not one dimensional the
  19072. <c>Array.ToString()</c> is returned.
  19073. </para>
  19074. </description>
  19075. </item>
  19076. <item>
  19077. <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> &amp; <see cref="T:System.Collections.IEnumerator"/></term>
  19078. <description>
  19079. <para>
  19080. Rendered as an open brace, followed by a comma
  19081. separated list of the elements (using the appropriate
  19082. renderer), followed by a close brace.
  19083. </para>
  19084. <para>
  19085. For example: <c>{a, b, c}</c>.
  19086. </para>
  19087. <para>
  19088. All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
  19089. or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
  19090. </para>
  19091. </description>
  19092. </item>
  19093. <item>
  19094. <term><see cref="T:System.Collections.DictionaryEntry"/></term>
  19095. <description>
  19096. <para>
  19097. Rendered as the key, an equals sign ('='), and the value (using the appropriate
  19098. renderer).
  19099. </para>
  19100. <para>
  19101. For example: <c>key=value</c>.
  19102. </para>
  19103. </description>
  19104. </item>
  19105. <item>
  19106. <term>other</term>
  19107. <description>
  19108. <para><c>Object.ToString()</c></para>
  19109. </description>
  19110. </item>
  19111. </list>
  19112. </remarks>
  19113. </member>
  19114. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
  19115. <summary>
  19116. Render the array argument into a string
  19117. </summary>
  19118. <param name="rendererMap">The map used to lookup renderers</param>
  19119. <param name="array">the array to render</param>
  19120. <param name="writer">The writer to render to</param>
  19121. <remarks>
  19122. <para>
  19123. For a one dimensional array this is the
  19124. array type name, an open brace, followed by a comma
  19125. separated list of the elements (using the appropriate
  19126. renderer), followed by a close brace. For example:
  19127. <c>int[] {1, 2, 3}</c>.
  19128. </para>
  19129. <para>
  19130. If the array is not one dimensional the
  19131. <c>Array.ToString()</c> is returned.
  19132. </para>
  19133. </remarks>
  19134. </member>
  19135. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
  19136. <summary>
  19137. Render the enumerator argument into a string
  19138. </summary>
  19139. <param name="rendererMap">The map used to lookup renderers</param>
  19140. <param name="enumerator">the enumerator to render</param>
  19141. <param name="writer">The writer to render to</param>
  19142. <remarks>
  19143. <para>
  19144. Rendered as an open brace, followed by a comma
  19145. separated list of the elements (using the appropriate
  19146. renderer), followed by a close brace. For example:
  19147. <c>{a, b, c}</c>.
  19148. </para>
  19149. </remarks>
  19150. </member>
  19151. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
  19152. <summary>
  19153. Render the DictionaryEntry argument into a string
  19154. </summary>
  19155. <param name="rendererMap">The map used to lookup renderers</param>
  19156. <param name="entry">the DictionaryEntry to render</param>
  19157. <param name="writer">The writer to render to</param>
  19158. <remarks>
  19159. <para>
  19160. Render the key, an equals sign ('='), and the value (using the appropriate
  19161. renderer). For example: <c>key=value</c>.
  19162. </para>
  19163. </remarks>
  19164. </member>
  19165. <member name="T:log4net.ObjectRenderer.IObjectRenderer">
  19166. <summary>
  19167. Implement this interface in order to render objects as strings
  19168. </summary>
  19169. <remarks>
  19170. <para>
  19171. Certain types require special case conversion to
  19172. string form. This conversion is done by an object renderer.
  19173. Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
  19174. interface.
  19175. </para>
  19176. </remarks>
  19177. <author>Nicko Cadell</author>
  19178. <author>Gert Driesen</author>
  19179. </member>
  19180. <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  19181. <summary>
  19182. Render the object <paramref name="obj"/> to a string
  19183. </summary>
  19184. <param name="rendererMap">The map used to lookup renderers</param>
  19185. <param name="obj">The object to render</param>
  19186. <param name="writer">The writer to render to</param>
  19187. <remarks>
  19188. <para>
  19189. Render the object <paramref name="obj"/> to a
  19190. string.
  19191. </para>
  19192. <para>
  19193. The <paramref name="rendererMap"/> parameter is
  19194. provided to lookup and render other objects. This is
  19195. very useful where <paramref name="obj"/> contains
  19196. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
  19197. method can be used to render these objects.
  19198. </para>
  19199. </remarks>
  19200. </member>
  19201. <member name="T:log4net.ObjectRenderer.RendererMap">
  19202. <summary>
  19203. Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  19204. </summary>
  19205. <remarks>
  19206. <para>
  19207. Maintains a mapping between types that require special
  19208. rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
  19209. is used to render them.
  19210. </para>
  19211. <para>
  19212. The <see cref="M:FindAndRender(object)"/> method is used to render an
  19213. <c>object</c> using the appropriate renderers defined in this map.
  19214. </para>
  19215. </remarks>
  19216. <author>Nicko Cadell</author>
  19217. <author>Gert Driesen</author>
  19218. </member>
  19219. <member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
  19220. <summary>
  19221. Default Constructor
  19222. </summary>
  19223. <remarks>
  19224. <para>
  19225. Default constructor.
  19226. </para>
  19227. </remarks>
  19228. </member>
  19229. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
  19230. <summary>
  19231. Render <paramref name="obj"/> using the appropriate renderer.
  19232. </summary>
  19233. <param name="obj">the object to render to a string</param>
  19234. <returns>the object rendered as a string</returns>
  19235. <remarks>
  19236. <para>
  19237. This is a convenience method used to render an object to a string.
  19238. The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
  19239. should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
  19240. </para>
  19241. </remarks>
  19242. </member>
  19243. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
  19244. <summary>
  19245. Render <paramref name="obj"/> using the appropriate renderer.
  19246. </summary>
  19247. <param name="obj">the object to render to a string</param>
  19248. <param name="writer">The writer to render to</param>
  19249. <remarks>
  19250. <para>
  19251. Find the appropriate renderer for the type of the
  19252. <paramref name="obj"/> parameter. This is accomplished by calling the
  19253. <see cref="M:Get(Type)"/> method. Once a renderer is found, it is
  19254. applied on the object <paramref name="obj"/> and the result is returned
  19255. as a <see cref="T:System.String"/>.
  19256. </para>
  19257. </remarks>
  19258. </member>
  19259. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
  19260. <summary>
  19261. Gets the renderer for the specified object type
  19262. </summary>
  19263. <param name="obj">the object to lookup the renderer for</param>
  19264. <returns>the renderer for <paramref name="obj"/></returns>
  19265. <remarks>
  19266. <param>
  19267. Gets the renderer for the specified object type.
  19268. </param>
  19269. <param>
  19270. Syntactic sugar method that calls <see cref="M:Get(Type)"/>
  19271. with the type of the object parameter.
  19272. </param>
  19273. </remarks>
  19274. </member>
  19275. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
  19276. <summary>
  19277. Gets the renderer for the specified type
  19278. </summary>
  19279. <param name="type">the type to lookup the renderer for</param>
  19280. <returns>the renderer for the specified type</returns>
  19281. <remarks>
  19282. <para>
  19283. Returns the renderer for the specified type.
  19284. If no specific renderer has been defined the
  19285. <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
  19286. </para>
  19287. </remarks>
  19288. </member>
  19289. <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
  19290. <summary>
  19291. Internal function to recursively search interfaces
  19292. </summary>
  19293. <param name="type">the type to lookup the renderer for</param>
  19294. <returns>the renderer for the specified type</returns>
  19295. </member>
  19296. <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
  19297. <summary>
  19298. Get the default renderer instance
  19299. </summary>
  19300. <value>the default renderer</value>
  19301. <remarks>
  19302. <para>
  19303. Get the default renderer
  19304. </para>
  19305. </remarks>
  19306. </member>
  19307. <member name="M:log4net.ObjectRenderer.RendererMap.Clear">
  19308. <summary>
  19309. Clear the map of renderers
  19310. </summary>
  19311. <remarks>
  19312. <para>
  19313. Clear the custom renderers defined by using
  19314. <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
  19315. cannot be removed.
  19316. </para>
  19317. </remarks>
  19318. </member>
  19319. <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  19320. <summary>
  19321. Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
  19322. </summary>
  19323. <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
  19324. <param name="renderer">the renderer for <paramref name="typeToRender"/></param>
  19325. <remarks>
  19326. <para>
  19327. Register an object renderer for a specific source type.
  19328. This renderer will be returned from a call to <see cref="M:Get(Type)"/>
  19329. specifying the same <paramref name="typeToRender"/> as an argument.
  19330. </para>
  19331. </remarks>
  19332. </member>
  19333. <member name="T:log4net.Plugin.IPlugin">
  19334. <summary>
  19335. Interface implemented by logger repository plugins.
  19336. </summary>
  19337. <remarks>
  19338. <para>
  19339. Plugins define additional behavior that can be associated
  19340. with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  19341. The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
  19342. property is used to store the plugins for a repository.
  19343. </para>
  19344. <para>
  19345. The <c>log4net.Config.PluginAttribute</c> can be used to
  19346. attach plugins to repositories created using configuration
  19347. attributes.
  19348. </para>
  19349. </remarks>
  19350. <author>Nicko Cadell</author>
  19351. <author>Gert Driesen</author>
  19352. </member>
  19353. <member name="P:log4net.Plugin.IPlugin.Name">
  19354. <summary>
  19355. Gets the name of the plugin.
  19356. </summary>
  19357. <value>
  19358. The name of the plugin.
  19359. </value>
  19360. <remarks>
  19361. <para>
  19362. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  19363. keyed by name. Each plugin instance attached to a
  19364. repository must be a unique name.
  19365. </para>
  19366. </remarks>
  19367. </member>
  19368. <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
  19369. <summary>
  19370. Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  19371. </summary>
  19372. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  19373. <remarks>
  19374. <para>
  19375. A plugin may only be attached to a single repository.
  19376. </para>
  19377. <para>
  19378. This method is called when the plugin is attached to the repository.
  19379. </para>
  19380. </remarks>
  19381. </member>
  19382. <member name="M:log4net.Plugin.IPlugin.Shutdown">
  19383. <summary>
  19384. Is called when the plugin is to shutdown.
  19385. </summary>
  19386. <remarks>
  19387. <para>
  19388. This method is called to notify the plugin that
  19389. it should stop operating and should detach from
  19390. the repository.
  19391. </para>
  19392. </remarks>
  19393. </member>
  19394. <member name="T:log4net.Plugin.IPluginFactory">
  19395. <summary>
  19396. Interface used to create plugins.
  19397. </summary>
  19398. <remarks>
  19399. <para>
  19400. Interface used to create a plugin.
  19401. </para>
  19402. </remarks>
  19403. <author>Nicko Cadell</author>
  19404. <author>Gert Driesen</author>
  19405. </member>
  19406. <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
  19407. <summary>
  19408. Creates the plugin object.
  19409. </summary>
  19410. <returns>the new plugin instance</returns>
  19411. <remarks>
  19412. <para>
  19413. Create and return a new plugin instance.
  19414. </para>
  19415. </remarks>
  19416. </member>
  19417. <member name="T:log4net.Plugin.PluginCollection">
  19418. <summary>
  19419. A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  19420. </summary>
  19421. <author>Nicko Cadell</author>
  19422. </member>
  19423. <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
  19424. <summary>
  19425. Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  19426. </summary>
  19427. <exclude/>
  19428. </member>
  19429. <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
  19430. <summary>
  19431. Gets the current element in the collection.
  19432. </summary>
  19433. </member>
  19434. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
  19435. <summary>
  19436. Advances the enumerator to the next element in the collection.
  19437. </summary>
  19438. <returns>
  19439. <c>true</c> if the enumerator was successfully advanced to the next element;
  19440. <c>false</c> if the enumerator has passed the end of the collection.
  19441. </returns>
  19442. <exception cref="T:System.InvalidOperationException">
  19443. The collection was modified after the enumerator was created.
  19444. </exception>
  19445. </member>
  19446. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
  19447. <summary>
  19448. Sets the enumerator to its initial position, before the first element in the collection.
  19449. </summary>
  19450. </member>
  19451. <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
  19452. <summary>
  19453. Creates a read-only wrapper for a <c>PluginCollection</c> instance.
  19454. </summary>
  19455. <param name="list">list to create a readonly wrapper arround</param>
  19456. <returns>
  19457. A <c>PluginCollection</c> wrapper that is read-only.
  19458. </returns>
  19459. </member>
  19460. <member name="M:log4net.Plugin.PluginCollection.#ctor">
  19461. <summary>
  19462. Initializes a new instance of the <c>PluginCollection</c> class
  19463. that is empty and has the default initial capacity.
  19464. </summary>
  19465. </member>
  19466. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
  19467. <summary>
  19468. Initializes a new instance of the <c>PluginCollection</c> class
  19469. that has the specified initial capacity.
  19470. </summary>
  19471. <param name="capacity">
  19472. The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
  19473. </param>
  19474. </member>
  19475. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
  19476. <summary>
  19477. Initializes a new instance of the <c>PluginCollection</c> class
  19478. that contains elements copied from the specified <c>PluginCollection</c>.
  19479. </summary>
  19480. <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
  19481. </member>
  19482. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
  19483. <summary>
  19484. Initializes a new instance of the <c>PluginCollection</c> class
  19485. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
  19486. </summary>
  19487. <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
  19488. </member>
  19489. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
  19490. <summary>
  19491. Initializes a new instance of the <c>PluginCollection</c> class
  19492. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
  19493. </summary>
  19494. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
  19495. </member>
  19496. <member name="T:log4net.Plugin.PluginCollection.Tag">
  19497. <summary>
  19498. Type visible only to our subclasses
  19499. Used to access protected constructor
  19500. </summary>
  19501. <exclude/>
  19502. </member>
  19503. <member name="F:log4net.Plugin.PluginCollection.Tag.Default">
  19504. <summary>
  19505. A value
  19506. </summary>
  19507. </member>
  19508. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
  19509. <summary>
  19510. Allow subclasses to avoid our default constructors
  19511. </summary>
  19512. <param name="tag"></param>
  19513. <exclude/>
  19514. </member>
  19515. <member name="P:log4net.Plugin.PluginCollection.Count">
  19516. <summary>
  19517. Gets the number of elements actually contained in the <c>PluginCollection</c>.
  19518. </summary>
  19519. </member>
  19520. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
  19521. <summary>
  19522. Copies the entire <c>PluginCollection</c> to a one-dimensional
  19523. <see cref="T:log4net.Plugin.IPlugin"/> array.
  19524. </summary>
  19525. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  19526. </member>
  19527. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
  19528. <summary>
  19529. Copies the entire <c>PluginCollection</c> to a one-dimensional
  19530. <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
  19531. </summary>
  19532. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  19533. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  19534. </member>
  19535. <member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
  19536. <summary>
  19537. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  19538. </summary>
  19539. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  19540. </member>
  19541. <member name="P:log4net.Plugin.PluginCollection.SyncRoot">
  19542. <summary>
  19543. Gets an object that can be used to synchronize access to the collection.
  19544. </summary>
  19545. <value>
  19546. An object that can be used to synchronize access to the collection.
  19547. </value>
  19548. </member>
  19549. <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
  19550. <summary>
  19551. Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  19552. </summary>
  19553. <value>
  19554. The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  19555. </value>
  19556. <param name="index">The zero-based index of the element to get or set.</param>
  19557. <exception cref="T:System.ArgumentOutOfRangeException">
  19558. <para><paramref name="index"/> is less than zero.</para>
  19559. <para>-or-</para>
  19560. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19561. </exception>
  19562. </member>
  19563. <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
  19564. <summary>
  19565. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
  19566. </summary>
  19567. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
  19568. <returns>The index at which the value has been added.</returns>
  19569. </member>
  19570. <member name="M:log4net.Plugin.PluginCollection.Clear">
  19571. <summary>
  19572. Removes all elements from the <c>PluginCollection</c>.
  19573. </summary>
  19574. </member>
  19575. <member name="M:log4net.Plugin.PluginCollection.Clone">
  19576. <summary>
  19577. Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
  19578. </summary>
  19579. <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
  19580. </member>
  19581. <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
  19582. <summary>
  19583. Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
  19584. </summary>
  19585. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
  19586. <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
  19587. </member>
  19588. <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
  19589. <summary>
  19590. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
  19591. in the <c>PluginCollection</c>.
  19592. </summary>
  19593. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
  19594. <returns>
  19595. The zero-based index of the first occurrence of <paramref name="item"/>
  19596. in the entire <c>PluginCollection</c>, if found; otherwise, -1.
  19597. </returns>
  19598. </member>
  19599. <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
  19600. <summary>
  19601. Inserts an element into the <c>PluginCollection</c> at the specified index.
  19602. </summary>
  19603. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  19604. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
  19605. <exception cref="T:System.ArgumentOutOfRangeException">
  19606. <para><paramref name="index"/> is less than zero</para>
  19607. <para>-or-</para>
  19608. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19609. </exception>
  19610. </member>
  19611. <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
  19612. <summary>
  19613. Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
  19614. </summary>
  19615. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
  19616. <exception cref="T:System.ArgumentException">
  19617. The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
  19618. </exception>
  19619. </member>
  19620. <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
  19621. <summary>
  19622. Removes the element at the specified index of the <c>PluginCollection</c>.
  19623. </summary>
  19624. <param name="index">The zero-based index of the element to remove.</param>
  19625. <exception cref="T:System.ArgumentOutOfRangeException">
  19626. <para><paramref name="index"/> is less than zero.</para>
  19627. <para>-or-</para>
  19628. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19629. </exception>
  19630. </member>
  19631. <member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
  19632. <summary>
  19633. Gets a value indicating whether the collection has a fixed size.
  19634. </summary>
  19635. <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  19636. </member>
  19637. <member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
  19638. <summary>
  19639. Gets a value indicating whether the IList is read-only.
  19640. </summary>
  19641. <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  19642. </member>
  19643. <member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
  19644. <summary>
  19645. Returns an enumerator that can iterate through the <c>PluginCollection</c>.
  19646. </summary>
  19647. <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
  19648. </member>
  19649. <member name="P:log4net.Plugin.PluginCollection.Capacity">
  19650. <summary>
  19651. Gets or sets the number of elements the <c>PluginCollection</c> can contain.
  19652. </summary>
  19653. <value>
  19654. The number of elements the <c>PluginCollection</c> can contain.
  19655. </value>
  19656. </member>
  19657. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
  19658. <summary>
  19659. Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
  19660. </summary>
  19661. <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
  19662. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  19663. </member>
  19664. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
  19665. <summary>
  19666. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
  19667. </summary>
  19668. <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>
  19669. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  19670. </member>
  19671. <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
  19672. <summary>
  19673. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
  19674. </summary>
  19675. <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>
  19676. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  19677. </member>
  19678. <member name="M:log4net.Plugin.PluginCollection.TrimToSize">
  19679. <summary>
  19680. Sets the capacity to the actual number of elements.
  19681. </summary>
  19682. </member>
  19683. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
  19684. <exception cref="T:System.ArgumentOutOfRangeException">
  19685. <para><paramref name="i"/> is less than zero.</para>
  19686. <para>-or-</para>
  19687. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19688. </exception>
  19689. </member>
  19690. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
  19691. <exception cref="T:System.ArgumentOutOfRangeException">
  19692. <para><paramref name="i"/> is less than zero.</para>
  19693. <para>-or-</para>
  19694. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19695. </exception>
  19696. </member>
  19697. <member name="T:log4net.Plugin.PluginCollection.Enumerator">
  19698. <summary>
  19699. Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  19700. </summary>
  19701. <exclude/>
  19702. </member>
  19703. <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
  19704. <summary>
  19705. Initializes a new instance of the <c>Enumerator</c> class.
  19706. </summary>
  19707. <param name="tc"></param>
  19708. </member>
  19709. <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
  19710. <summary>
  19711. Gets the current element in the collection.
  19712. </summary>
  19713. <value>
  19714. The current element in the collection.
  19715. </value>
  19716. </member>
  19717. <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
  19718. <summary>
  19719. Advances the enumerator to the next element in the collection.
  19720. </summary>
  19721. <returns>
  19722. <c>true</c> if the enumerator was successfully advanced to the next element;
  19723. <c>false</c> if the enumerator has passed the end of the collection.
  19724. </returns>
  19725. <exception cref="T:System.InvalidOperationException">
  19726. The collection was modified after the enumerator was created.
  19727. </exception>
  19728. </member>
  19729. <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
  19730. <summary>
  19731. Sets the enumerator to its initial position, before the first element in the collection.
  19732. </summary>
  19733. </member>
  19734. <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
  19735. <exclude/>
  19736. </member>
  19737. <member name="T:log4net.Plugin.PluginMap">
  19738. <summary>
  19739. Map of repository plugins.
  19740. </summary>
  19741. <remarks>
  19742. <para>
  19743. This class is a name keyed map of the plugins that are
  19744. attached to a repository.
  19745. </para>
  19746. </remarks>
  19747. <author>Nicko Cadell</author>
  19748. <author>Gert Driesen</author>
  19749. </member>
  19750. <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
  19751. <summary>
  19752. Constructor
  19753. </summary>
  19754. <param name="repository">The repository that the plugins should be attached to.</param>
  19755. <remarks>
  19756. <para>
  19757. Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap" /> class with a
  19758. repository that the plugins should be attached to.
  19759. </para>
  19760. </remarks>
  19761. </member>
  19762. <member name="P:log4net.Plugin.PluginMap.Item(System.String)">
  19763. <summary>
  19764. Gets a <see cref="T:log4net.Plugin.IPlugin" /> by name.
  19765. </summary>
  19766. <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin" /> to lookup.</param>
  19767. <returns>
  19768. The <see cref="T:log4net.Plugin.IPlugin" /> from the map with the name specified, or
  19769. <c>null</c> if no plugin is found.
  19770. </returns>
  19771. <remarks>
  19772. <para>
  19773. Lookup a plugin by name. If the plugin is not found <c>null</c>
  19774. will be returned.
  19775. </para>
  19776. </remarks>
  19777. </member>
  19778. <member name="P:log4net.Plugin.PluginMap.AllPlugins">
  19779. <summary>
  19780. Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin" /> objects.
  19781. </summary>
  19782. <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin" /> objects.</value>
  19783. <remarks>
  19784. <para>
  19785. Get a collection of all the plugins defined in this map.
  19786. </para>
  19787. </remarks>
  19788. </member>
  19789. <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
  19790. <summary>
  19791. Adds a <see cref="T:log4net.Plugin.IPlugin" /> to the map.
  19792. </summary>
  19793. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin" /> to add to the map.</param>
  19794. <remarks>
  19795. <para>
  19796. The <see cref="T:log4net.Plugin.IPlugin" /> will be attached to the repository when added.
  19797. </para>
  19798. <para>
  19799. If there already exists a plugin with the same name
  19800. attached to the repository then the old plugin will
  19801. be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
  19802. the new plugin.
  19803. </para>
  19804. </remarks>
  19805. </member>
  19806. <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
  19807. <summary>
  19808. Removes a <see cref="T:log4net.Plugin.IPlugin" /> from the map.
  19809. </summary>
  19810. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin" /> to remove from the map.</param>
  19811. <remarks>
  19812. <para>
  19813. Remove a specific plugin from this map.
  19814. </para>
  19815. </remarks>
  19816. </member>
  19817. <member name="T:log4net.Plugin.PluginSkeleton">
  19818. <summary>
  19819. Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
  19820. </summary>
  19821. <remarks>
  19822. <para>
  19823. Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
  19824. interface. This base class can be used by implementors
  19825. of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
  19826. </para>
  19827. </remarks>
  19828. <author>Nicko Cadell</author>
  19829. <author>Gert Driesen</author>
  19830. </member>
  19831. <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
  19832. <summary>
  19833. Constructor
  19834. </summary>
  19835. <param name="name">the name of the plugin</param>
  19836. <remarks>
  19837. Initializes a new Plugin with the specified name.
  19838. </remarks>
  19839. </member>
  19840. <member name="P:log4net.Plugin.PluginSkeleton.Name">
  19841. <summary>
  19842. Gets or sets the name of the plugin.
  19843. </summary>
  19844. <value>
  19845. The name of the plugin.
  19846. </value>
  19847. <remarks>
  19848. <para>
  19849. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  19850. keyed by name. Each plugin instance attached to a
  19851. repository must be a unique name.
  19852. </para>
  19853. <para>
  19854. The name of the plugin must not change one the
  19855. plugin has been attached to a repository.
  19856. </para>
  19857. </remarks>
  19858. </member>
  19859. <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
  19860. <summary>
  19861. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  19862. </summary>
  19863. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  19864. <remarks>
  19865. <para>
  19866. A plugin may only be attached to a single repository.
  19867. </para>
  19868. <para>
  19869. This method is called when the plugin is attached to the repository.
  19870. </para>
  19871. </remarks>
  19872. </member>
  19873. <member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
  19874. <summary>
  19875. Is called when the plugin is to shutdown.
  19876. </summary>
  19877. <remarks>
  19878. <para>
  19879. This method is called to notify the plugin that
  19880. it should stop operating and should detach from
  19881. the repository.
  19882. </para>
  19883. </remarks>
  19884. </member>
  19885. <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
  19886. <summary>
  19887. The repository for this plugin
  19888. </summary>
  19889. <value>
  19890. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this plugin is attached to.
  19891. </value>
  19892. <remarks>
  19893. <para>
  19894. Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository" /> that this plugin is
  19895. attached to.
  19896. </para>
  19897. </remarks>
  19898. </member>
  19899. <member name="F:log4net.Plugin.PluginSkeleton.m_name">
  19900. <summary>
  19901. The name of this plugin.
  19902. </summary>
  19903. </member>
  19904. <member name="F:log4net.Plugin.PluginSkeleton.m_repository">
  19905. <summary>
  19906. The repository this plugin is attached to.
  19907. </summary>
  19908. </member>
  19909. <member name="T:log4net.Repository.ConfigurationChangedEventArgs">
  19910. <summary>
  19911. </summary>
  19912. </member>
  19913. <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
  19914. <summary>
  19915. </summary>
  19916. <param name="configurationMessages"></param>
  19917. </member>
  19918. <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
  19919. <summary>
  19920. </summary>
  19921. </member>
  19922. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
  19923. <summary>
  19924. Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  19925. </summary>
  19926. <remarks>
  19927. <para>
  19928. This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  19929. interface is used to create the default subclass
  19930. of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
  19931. </para>
  19932. </remarks>
  19933. <author>Nicko Cadell</author>
  19934. <author>Gert Driesen</author>
  19935. </member>
  19936. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
  19937. <summary>
  19938. Default constructor
  19939. </summary>
  19940. <remarks>
  19941. <para>
  19942. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory" /> class.
  19943. </para>
  19944. </remarks>
  19945. </member>
  19946. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  19947. <summary>
  19948. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance
  19949. </summary>
  19950. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository" /> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  19951. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  19952. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance for the specified name.</returns>
  19953. <remarks>
  19954. <para>
  19955. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance with the
  19956. specified name.
  19957. </para>
  19958. <para>
  19959. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  19960. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  19961. </para>
  19962. <para>
  19963. If the <paramref name="name"/> is <c>null</c> then the root logger
  19964. must be returned.
  19965. </para>
  19966. </remarks>
  19967. </member>
  19968. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
  19969. <summary>
  19970. Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  19971. </summary>
  19972. <remarks>
  19973. <para>
  19974. This subclass has no additional behavior over the
  19975. <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
  19976. to be created.
  19977. </para>
  19978. </remarks>
  19979. </member>
  19980. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
  19981. <summary>
  19982. Construct a new Logger
  19983. </summary>
  19984. <param name="name">the name of the logger</param>
  19985. <remarks>
  19986. <para>
  19987. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl" /> class
  19988. with the specified name.
  19989. </para>
  19990. </remarks>
  19991. </member>
  19992. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
  19993. <summary>
  19994. Delegate used to handle logger creation event notifications.
  19995. </summary>
  19996. <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>
  19997. <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>
  19998. <remarks>
  19999. <para>
  20000. Delegate used to handle logger creation event notifications.
  20001. </para>
  20002. </remarks>
  20003. </member>
  20004. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
  20005. <summary>
  20006. Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
  20007. </summary>
  20008. <remarks>
  20009. <para>
  20010. A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
  20011. <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
  20012. </para>
  20013. </remarks>
  20014. </member>
  20015. <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
  20016. <summary>
  20017. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
  20018. </summary>
  20019. </member>
  20020. <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
  20021. <summary>
  20022. Constructor
  20023. </summary>
  20024. <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
  20025. <remarks>
  20026. <para>
  20027. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs" /> event argument
  20028. class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
  20029. </para>
  20030. </remarks>
  20031. </member>
  20032. <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
  20033. <summary>
  20034. Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  20035. </summary>
  20036. <value>
  20037. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  20038. </value>
  20039. <remarks>
  20040. <para>
  20041. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  20042. </para>
  20043. </remarks>
  20044. </member>
  20045. <member name="T:log4net.Repository.Hierarchy.Hierarchy">
  20046. <summary>
  20047. Hierarchical organization of loggers
  20048. </summary>
  20049. <remarks>
  20050. <para>
  20051. <i>The casual user should not have to deal with this class
  20052. directly.</i>
  20053. </para>
  20054. <para>
  20055. This class is specialized in retrieving loggers by name and
  20056. also maintaining the logger hierarchy. Implements the
  20057. <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  20058. </para>
  20059. <para>
  20060. The structure of the logger hierarchy is maintained by the
  20061. <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
  20062. link to their parent but parents do not have any references to their
  20063. children. Moreover, loggers can be instantiated in any order, in
  20064. particular descendant before ancestor.
  20065. </para>
  20066. <para>
  20067. In case a descendant is created before a particular ancestor,
  20068. then it creates a provision node for the ancestor and adds itself
  20069. to the provision node. Other descendants of the same ancestor add
  20070. themselves to the previously created provision node.
  20071. </para>
  20072. </remarks>
  20073. <author>Nicko Cadell</author>
  20074. <author>Gert Driesen</author>
  20075. </member>
  20076. <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
  20077. <summary>
  20078. Event used to notify that a logger has been created.
  20079. </summary>
  20080. <remarks>
  20081. <para>
  20082. Event raised when a logger is created.
  20083. </para>
  20084. </remarks>
  20085. </member>
  20086. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
  20087. <summary>
  20088. Default constructor
  20089. </summary>
  20090. <remarks>
  20091. <para>
  20092. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class.
  20093. </para>
  20094. </remarks>
  20095. </member>
  20096. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
  20097. <summary>
  20098. Construct with properties
  20099. </summary>
  20100. <param name="properties">The properties to pass to this repository.</param>
  20101. <remarks>
  20102. <para>
  20103. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class.
  20104. </para>
  20105. </remarks>
  20106. </member>
  20107. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
  20108. <summary>
  20109. Construct with a logger factory
  20110. </summary>
  20111. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  20112. <remarks>
  20113. <para>
  20114. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class with
  20115. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" />.
  20116. </para>
  20117. </remarks>
  20118. </member>
  20119. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
  20120. <summary>
  20121. Construct with properties and a logger factory
  20122. </summary>
  20123. <param name="properties">The properties to pass to this repository.</param>
  20124. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  20125. <remarks>
  20126. <para>
  20127. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class with
  20128. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" />.
  20129. </para>
  20130. </remarks>
  20131. </member>
  20132. <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
  20133. <summary>
  20134. Has no appender warning been emitted
  20135. </summary>
  20136. <remarks>
  20137. <para>
  20138. Flag to indicate if we have already issued a warning
  20139. about not having an appender warning.
  20140. </para>
  20141. </remarks>
  20142. </member>
  20143. <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
  20144. <summary>
  20145. Get the root of this hierarchy
  20146. </summary>
  20147. <remarks>
  20148. <para>
  20149. Get the root of this hierarchy.
  20150. </para>
  20151. </remarks>
  20152. </member>
  20153. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
  20154. <summary>
  20155. Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" /> instance.
  20156. </summary>
  20157. <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" /></value>
  20158. <remarks>
  20159. <para>
  20160. The logger factory is used to create logger instances.
  20161. </para>
  20162. </remarks>
  20163. </member>
  20164. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
  20165. <summary>
  20166. Test if a logger exists
  20167. </summary>
  20168. <param name="name">The name of the logger to lookup</param>
  20169. <returns>The Logger object with the name specified</returns>
  20170. <remarks>
  20171. <para>
  20172. Check if the named logger exists in the hierarchy. If so return
  20173. its reference, otherwise returns <c>null</c>.
  20174. </para>
  20175. </remarks>
  20176. </member>
  20177. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
  20178. <summary>
  20179. Returns all the currently defined loggers in the hierarchy as an Array
  20180. </summary>
  20181. <returns>All the defined loggers</returns>
  20182. <remarks>
  20183. <para>
  20184. Returns all the currently defined loggers in the hierarchy as an Array.
  20185. The root logger is <b>not</b> included in the returned
  20186. enumeration.
  20187. </para>
  20188. </remarks>
  20189. </member>
  20190. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
  20191. <summary>
  20192. Return a new logger instance named as the first parameter using
  20193. the default factory.
  20194. </summary>
  20195. <remarks>
  20196. <para>
  20197. Return a new logger instance named as the first parameter using
  20198. the default factory.
  20199. </para>
  20200. <para>
  20201. If a logger of that name already exists, then it will be
  20202. returned. Otherwise, a new logger will be instantiated and
  20203. then linked with its existing ancestors as well as children.
  20204. </para>
  20205. </remarks>
  20206. <param name="name">The name of the logger to retrieve</param>
  20207. <returns>The logger object with the name specified</returns>
  20208. </member>
  20209. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
  20210. <summary>
  20211. Shutting down a hierarchy will <i>safely</i> close and remove
  20212. all appenders in all loggers including the root logger.
  20213. </summary>
  20214. <remarks>
  20215. <para>
  20216. Shutting down a hierarchy will <i>safely</i> close and remove
  20217. all appenders in all loggers including the root logger.
  20218. </para>
  20219. <para>
  20220. Some appenders need to be closed before the
  20221. application exists. Otherwise, pending logging events might be
  20222. lost.
  20223. </para>
  20224. <para>
  20225. The <c>Shutdown</c> method is careful to close nested
  20226. appenders before closing regular appenders. This is allows
  20227. configurations where a regular appender is attached to a logger
  20228. and again to a nested appender.
  20229. </para>
  20230. </remarks>
  20231. </member>
  20232. <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
  20233. <summary>
  20234. Reset all values contained in this hierarchy instance to their default.
  20235. </summary>
  20236. <remarks>
  20237. <para>
  20238. Reset all values contained in this hierarchy instance to their
  20239. default. This removes all appenders from all loggers, sets
  20240. the level of all non-root loggers to <c>null</c>,
  20241. sets their additivity flag to <c>true</c> and sets the level
  20242. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  20243. message disabling is set its default "off" value.
  20244. </para>
  20245. <para>
  20246. Existing loggers are not removed. They are just reset.
  20247. </para>
  20248. <para>
  20249. This method should be used sparingly and with care as it will
  20250. block all logging until it is completed.
  20251. </para>
  20252. </remarks>
  20253. </member>
  20254. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
  20255. <summary>
  20256. Log the logEvent through this hierarchy.
  20257. </summary>
  20258. <param name="logEvent">the event to log</param>
  20259. <remarks>
  20260. <para>
  20261. This method should not normally be used to log.
  20262. The <see cref="T:log4net.ILog"/> interface should be used
  20263. for routine logging. This interface can be obtained
  20264. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  20265. </para>
  20266. <para>
  20267. The <c>logEvent</c> is delivered to the appropriate logger and
  20268. that logger is then responsible for logging the event.
  20269. </para>
  20270. </remarks>
  20271. </member>
  20272. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
  20273. <summary>
  20274. Returns all the Appenders that are currently configured
  20275. </summary>
  20276. <returns>An array containing all the currently configured appenders</returns>
  20277. <remarks>
  20278. <para>
  20279. Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
  20280. All the loggers are searched for appenders. The appenders may also be containers
  20281. for appenders and these are also searched for additional loggers.
  20282. </para>
  20283. <para>
  20284. The list returned is unordered but does not contain duplicates.
  20285. </para>
  20286. </remarks>
  20287. </member>
  20288. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
  20289. <summary>
  20290. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
  20291. The appender may also be a container.
  20292. </summary>
  20293. <param name="appenderList"></param>
  20294. <param name="appender"></param>
  20295. </member>
  20296. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
  20297. <summary>
  20298. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
  20299. </summary>
  20300. <param name="appenderList"></param>
  20301. <param name="container"></param>
  20302. </member>
  20303. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)">
  20304. <summary>
  20305. Initialize the log4net system using the specified appender
  20306. </summary>
  20307. <param name="appender">the appender to use to log all logging events</param>
  20308. </member>
  20309. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender[])">
  20310. <summary>
  20311. Initialize the log4net system using the specified appenders
  20312. </summary>
  20313. <param name="appenders">the appenders to use to log all logging events</param>
  20314. </member>
  20315. <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(log4net.Appender.IAppender[])">
  20316. <summary>
  20317. Initialize the log4net system using the specified appenders
  20318. </summary>
  20319. <param name="appenders">the appenders to use to log all logging events</param>
  20320. <remarks>
  20321. <para>
  20322. This method provides the same functionality as the
  20323. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  20324. on this object, but it is protected and therefore can be called by subclasses.
  20325. </para>
  20326. </remarks>
  20327. </member>
  20328. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)">
  20329. <summary>
  20330. Initialize the log4net system using the specified config
  20331. </summary>
  20332. <param name="element">the element containing the root of the config</param>
  20333. </member>
  20334. <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(System.Xml.XmlElement)">
  20335. <summary>
  20336. Initialize the log4net system using the specified config
  20337. </summary>
  20338. <param name="element">the element containing the root of the config</param>
  20339. <remarks>
  20340. <para>
  20341. This method provides the same functionality as the
  20342. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  20343. on this object, but it is protected and therefore can be called by subclasses.
  20344. </para>
  20345. </remarks>
  20346. </member>
  20347. <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
  20348. <summary>
  20349. Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
  20350. </summary>
  20351. <param name="level">The level to check against.</param>
  20352. <returns>
  20353. <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
  20354. </returns>
  20355. <remarks>
  20356. <para>
  20357. If this hierarchy has not been configured then this method will
  20358. always return <c>true</c>.
  20359. </para>
  20360. <para>
  20361. This method will return <c>true</c> if this repository is
  20362. disabled for <c>level</c> object passed as parameter and
  20363. <c>false</c> otherwise.
  20364. </para>
  20365. <para>
  20366. See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
  20367. </para>
  20368. </remarks>
  20369. </member>
  20370. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
  20371. <summary>
  20372. Clear all logger definitions from the internal hashtable
  20373. </summary>
  20374. <remarks>
  20375. <para>
  20376. This call will clear all logger definitions from the internal
  20377. hashtable. Invoking this method will irrevocably mess up the
  20378. logger hierarchy.
  20379. </para>
  20380. <para>
  20381. You should <b>really</b> know what you are doing before
  20382. invoking this method.
  20383. </para>
  20384. </remarks>
  20385. </member>
  20386. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
  20387. <summary>
  20388. Return a new logger instance named as the first parameter using
  20389. <paramref name="factory"/>.
  20390. </summary>
  20391. <param name="name">The name of the logger to retrieve</param>
  20392. <param name="factory">The factory that will make the new logger instance</param>
  20393. <returns>The logger object with the name specified</returns>
  20394. <remarks>
  20395. <para>
  20396. If a logger of that name already exists, then it will be
  20397. returned. Otherwise, a new logger will be instantiated by the
  20398. <paramref name="factory"/> parameter and linked with its existing
  20399. ancestors as well as children.
  20400. </para>
  20401. </remarks>
  20402. </member>
  20403. <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
  20404. <summary>
  20405. Sends a logger creation event to all registered listeners
  20406. </summary>
  20407. <param name="logger">The newly created logger</param>
  20408. <remarks>
  20409. Raises the logger creation event.
  20410. </remarks>
  20411. </member>
  20412. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
  20413. <summary>
  20414. Updates all the parents of the specified logger
  20415. </summary>
  20416. <param name="log">The logger to update the parents for</param>
  20417. <remarks>
  20418. <para>
  20419. This method loops through all the <i>potential</i> parents of
  20420. <paramref name="log"/>. There 3 possible cases:
  20421. </para>
  20422. <list type="number">
  20423. <item>
  20424. <term>No entry for the potential parent of <paramref name="log"/> exists</term>
  20425. <description>
  20426. We create a ProvisionNode for this potential
  20427. parent and insert <paramref name="log"/> in that provision node.
  20428. </description>
  20429. </item>
  20430. <item>
  20431. <term>The entry is of type Logger for the potential parent.</term>
  20432. <description>
  20433. The entry is <paramref name="log"/>'s nearest existing parent. We
  20434. update <paramref name="log"/>'s parent field with this entry. We also break from
  20435. he loop because updating our parent's parent is our parent's
  20436. responsibility.
  20437. </description>
  20438. </item>
  20439. <item>
  20440. <term>The entry is of type ProvisionNode for this potential parent.</term>
  20441. <description>
  20442. We add <paramref name="log"/> to the list of children for this
  20443. potential parent.
  20444. </description>
  20445. </item>
  20446. </list>
  20447. </remarks>
  20448. </member>
  20449. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
  20450. <summary>
  20451. Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
  20452. </summary>
  20453. <param name="pn"></param>
  20454. <param name="log"></param>
  20455. <remarks>
  20456. <para>
  20457. We update the links for all the children that placed themselves
  20458. in the provision node 'pn'. The second argument 'log' is a
  20459. reference for the newly created Logger, parent of all the
  20460. children in 'pn'.
  20461. </para>
  20462. <para>
  20463. We loop on all the children 'c' in 'pn'.
  20464. </para>
  20465. <para>
  20466. If the child 'c' has been already linked to a child of
  20467. 'log' then there is no need to update 'c'.
  20468. </para>
  20469. <para>
  20470. Otherwise, we set log's parent field to c's parent and set
  20471. c's parent field to log.
  20472. </para>
  20473. </remarks>
  20474. </member>
  20475. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
  20476. <summary>
  20477. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  20478. </summary>
  20479. <param name="levelEntry">the level values</param>
  20480. <remarks>
  20481. <para>
  20482. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  20483. </para>
  20484. <para>
  20485. Supports setting levels via the configuration file.
  20486. </para>
  20487. </remarks>
  20488. </member>
  20489. <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
  20490. <summary>
  20491. A class to hold the value, name and display name for a level
  20492. </summary>
  20493. <remarks>
  20494. <para>
  20495. A class to hold the value, name and display name for a level
  20496. </para>
  20497. </remarks>
  20498. </member>
  20499. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
  20500. <summary>
  20501. Value of the level
  20502. </summary>
  20503. <remarks>
  20504. <para>
  20505. If the value is not set (defaults to -1) the value will be looked
  20506. up for the current level with the same name.
  20507. </para>
  20508. </remarks>
  20509. </member>
  20510. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
  20511. <summary>
  20512. Name of the level
  20513. </summary>
  20514. <value>
  20515. The name of the level
  20516. </value>
  20517. <remarks>
  20518. <para>
  20519. The name of the level.
  20520. </para>
  20521. </remarks>
  20522. </member>
  20523. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
  20524. <summary>
  20525. Display name for the level
  20526. </summary>
  20527. <value>
  20528. The display name of the level
  20529. </value>
  20530. <remarks>
  20531. <para>
  20532. The display name of the level.
  20533. </para>
  20534. </remarks>
  20535. </member>
  20536. <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
  20537. <summary>
  20538. Override <c>Object.ToString</c> to return sensible debug info
  20539. </summary>
  20540. <returns>string info about this object</returns>
  20541. </member>
  20542. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
  20543. <summary>
  20544. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  20545. </summary>
  20546. <param name="propertyEntry">the property value</param>
  20547. <remarks>
  20548. <para>
  20549. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
  20550. </para>
  20551. <para>
  20552. Supports setting property values via the configuration file.
  20553. </para>
  20554. </remarks>
  20555. </member>
  20556. <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
  20557. <summary>
  20558. The fully qualified type of the Hierarchy class.
  20559. </summary>
  20560. <remarks>
  20561. Used by the internal logger to record the Type of the
  20562. log message.
  20563. </remarks>
  20564. </member>
  20565. <member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
  20566. <summary>
  20567. Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
  20568. </summary>
  20569. <remarks>
  20570. <para>
  20571. This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
  20572. create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
  20573. </para>
  20574. <para>
  20575. The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
  20576. to create a named <see cref="T:log4net.Repository.Hierarchy.Logger" />.
  20577. </para>
  20578. <para>
  20579. Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger" />.
  20580. </para>
  20581. </remarks>
  20582. <author>Nicko Cadell</author>
  20583. <author>Gert Driesen</author>
  20584. </member>
  20585. <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  20586. <summary>
  20587. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance
  20588. </summary>
  20589. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository" /> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  20590. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  20591. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance for the specified name.</returns>
  20592. <remarks>
  20593. <para>
  20594. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance with the
  20595. specified name.
  20596. </para>
  20597. <para>
  20598. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  20599. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  20600. </para>
  20601. <para>
  20602. If the <paramref name="name"/> is <c>null</c> then the root logger
  20603. must be returned.
  20604. </para>
  20605. </remarks>
  20606. </member>
  20607. <member name="T:log4net.Repository.Hierarchy.Logger">
  20608. <summary>
  20609. Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
  20610. </summary>
  20611. <remarks>
  20612. <para>
  20613. Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
  20614. interface. Applications should use <see cref="T:log4net.LogManager"/> to get
  20615. logger instances.
  20616. </para>
  20617. <para>
  20618. This is one of the central classes in the log4net implementation. One of the
  20619. distinctive features of log4net are hierarchical loggers and their
  20620. evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  20621. instances into a rooted tree hierarchy.
  20622. </para>
  20623. <para>
  20624. The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
  20625. <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  20626. is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  20627. </para>
  20628. </remarks>
  20629. <author>Nicko Cadell</author>
  20630. <author>Gert Driesen</author>
  20631. <author>Aspi Havewala</author>
  20632. <author>Douglas de la Torre</author>
  20633. </member>
  20634. <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
  20635. <summary>
  20636. This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance and
  20637. sets its name.
  20638. </summary>
  20639. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  20640. <remarks>
  20641. <para>
  20642. This constructor is protected and designed to be used by
  20643. a subclass that is not abstract.
  20644. </para>
  20645. <para>
  20646. Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  20647. objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
  20648. logger creator.
  20649. </para>
  20650. </remarks>
  20651. </member>
  20652. <member name="P:log4net.Repository.Hierarchy.Logger.Parent">
  20653. <summary>
  20654. Gets or sets the parent logger in the hierarchy.
  20655. </summary>
  20656. <value>
  20657. The parent logger in the hierarchy.
  20658. </value>
  20659. <remarks>
  20660. <para>
  20661. Part of the Composite pattern that makes the hierarchy.
  20662. The hierarchy is parent linked rather than child linked.
  20663. </para>
  20664. </remarks>
  20665. </member>
  20666. <member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
  20667. <summary>
  20668. Gets or sets a value indicating if child loggers inherit their parent's appenders.
  20669. </summary>
  20670. <value>
  20671. <c>true</c> if child loggers inherit their parent's appenders.
  20672. </value>
  20673. <remarks>
  20674. <para>
  20675. Additivity is set to <c>true</c> by default, that is children inherit
  20676. the appenders of their ancestors by default. If this variable is
  20677. set to <c>false</c> then the appenders found in the
  20678. ancestors of this logger are not used. However, the children
  20679. of this logger will inherit its appenders, unless the children
  20680. have their additivity flag set to <c>false</c> too. See
  20681. the user manual for more details.
  20682. </para>
  20683. </remarks>
  20684. </member>
  20685. <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
  20686. <summary>
  20687. Gets the effective level for this logger.
  20688. </summary>
  20689. <returns>The nearest level in the logger hierarchy.</returns>
  20690. <remarks>
  20691. <para>
  20692. Starting from this logger, searches the logger hierarchy for a
  20693. non-null level and returns it. Otherwise, returns the level of the
  20694. root logger.
  20695. </para>
  20696. <para>The Logger class is designed so that this method executes as
  20697. quickly as possible.</para>
  20698. </remarks>
  20699. </member>
  20700. <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
  20701. <summary>
  20702. Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
  20703. <c>Logger</c> instance is attached to.
  20704. </summary>
  20705. <value>The hierarchy that this logger belongs to.</value>
  20706. <remarks>
  20707. <para>
  20708. This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  20709. </para>
  20710. </remarks>
  20711. </member>
  20712. <member name="P:log4net.Repository.Hierarchy.Logger.Level">
  20713. <summary>
  20714. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
  20715. </summary>
  20716. <value>
  20717. The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
  20718. </value>
  20719. <remarks>
  20720. <para>
  20721. The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
  20722. </para>
  20723. </remarks>
  20724. </member>
  20725. <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
  20726. <summary>
  20727. Add <paramref name="newAppender"/> to the list of appenders of this
  20728. Logger instance.
  20729. </summary>
  20730. <param name="newAppender">An appender to add to this logger</param>
  20731. <remarks>
  20732. <para>
  20733. Add <paramref name="newAppender"/> to the list of appenders of this
  20734. Logger instance.
  20735. </para>
  20736. <para>
  20737. If <paramref name="newAppender"/> is already in the list of
  20738. appenders, then it won't be added again.
  20739. </para>
  20740. </remarks>
  20741. </member>
  20742. <member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
  20743. <summary>
  20744. Get the appenders contained in this logger as an
  20745. <see cref="T:System.Collections.ICollection"/>.
  20746. </summary>
  20747. <returns>A collection of the appenders in this logger</returns>
  20748. <remarks>
  20749. <para>
  20750. Get the appenders contained in this logger as an
  20751. <see cref="T:System.Collections.ICollection"/>. If no appenders
  20752. can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  20753. </para>
  20754. </remarks>
  20755. </member>
  20756. <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
  20757. <summary>
  20758. Look for the appender named as <c>name</c>
  20759. </summary>
  20760. <param name="name">The name of the appender to lookup</param>
  20761. <returns>The appender with the name specified, or <c>null</c>.</returns>
  20762. <remarks>
  20763. <para>
  20764. Returns the named appender, or null if the appender is not found.
  20765. </para>
  20766. </remarks>
  20767. </member>
  20768. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
  20769. <summary>
  20770. Remove all previously added appenders from this Logger instance.
  20771. </summary>
  20772. <remarks>
  20773. <para>
  20774. Remove all previously added appenders from this Logger instance.
  20775. </para>
  20776. <para>
  20777. This is useful when re-reading configuration information.
  20778. </para>
  20779. </remarks>
  20780. </member>
  20781. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
  20782. <summary>
  20783. Remove the appender passed as parameter form the list of appenders.
  20784. </summary>
  20785. <param name="appender">The appender to remove</param>
  20786. <returns>The appender removed from the list</returns>
  20787. <remarks>
  20788. <para>
  20789. Remove the appender passed as parameter form the list of appenders.
  20790. The appender removed is not closed.
  20791. If you are discarding the appender you must call
  20792. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  20793. </para>
  20794. </remarks>
  20795. </member>
  20796. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
  20797. <summary>
  20798. Remove the appender passed as parameter form the list of appenders.
  20799. </summary>
  20800. <param name="name">The name of the appender to remove</param>
  20801. <returns>The appender removed from the list</returns>
  20802. <remarks>
  20803. <para>
  20804. Remove the named appender passed as parameter form the list of appenders.
  20805. The appender removed is not closed.
  20806. If you are discarding the appender you must call
  20807. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  20808. </para>
  20809. </remarks>
  20810. </member>
  20811. <member name="P:log4net.Repository.Hierarchy.Logger.Name">
  20812. <summary>
  20813. Gets the logger name.
  20814. </summary>
  20815. <value>
  20816. The name of the logger.
  20817. </value>
  20818. <remarks>
  20819. <para>
  20820. The name of this logger
  20821. </para>
  20822. </remarks>
  20823. </member>
  20824. <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  20825. <summary>
  20826. This generic form is intended to be used by wrappers.
  20827. </summary>
  20828. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  20829. the stack boundary into the logging system for this call.</param>
  20830. <param name="level">The level of the message to be logged.</param>
  20831. <param name="message">The message object to log.</param>
  20832. <param name="exception">The exception to log, including its stack trace.</param>
  20833. <remarks>
  20834. <para>
  20835. Generate a logging event for the specified <paramref name="level"/> using
  20836. the <paramref name="message"/> and <paramref name="exception"/>.
  20837. </para>
  20838. <para>
  20839. This method must not throw any exception to the caller.
  20840. </para>
  20841. </remarks>
  20842. </member>
  20843. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
  20844. <summary>
  20845. This is the most generic printing method that is intended to be used
  20846. by wrappers.
  20847. </summary>
  20848. <param name="logEvent">The event being logged.</param>
  20849. <remarks>
  20850. <para>
  20851. Logs the specified logging event through this logger.
  20852. </para>
  20853. <para>
  20854. This method must not throw any exception to the caller.
  20855. </para>
  20856. </remarks>
  20857. </member>
  20858. <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
  20859. <summary>
  20860. Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
  20861. </summary>
  20862. <param name="level">The level to check.</param>
  20863. <returns>
  20864. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  20865. </returns>
  20866. <remarks>
  20867. <para>
  20868. Test if this logger is going to log events of the specified <paramref name="level"/>.
  20869. </para>
  20870. <para>
  20871. This method must not throw any exception to the caller.
  20872. </para>
  20873. </remarks>
  20874. </member>
  20875. <member name="P:log4net.Repository.Hierarchy.Logger.Repository">
  20876. <summary>
  20877. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  20878. <c>Logger</c> instance is attached to.
  20879. </summary>
  20880. <value>
  20881. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this logger belongs to.
  20882. </value>
  20883. <remarks>
  20884. <para>
  20885. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  20886. <c>Logger</c> instance is attached to.
  20887. </para>
  20888. </remarks>
  20889. </member>
  20890. <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
  20891. <summary>
  20892. Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
  20893. </summary>
  20894. <param name="loggingEvent">The event to log.</param>
  20895. <remarks>
  20896. <para>
  20897. Call the appenders in the hierarchy starting at
  20898. <c>this</c>. If no appenders could be found, emit a
  20899. warning.
  20900. </para>
  20901. <para>
  20902. This method calls all the appenders inherited from the
  20903. hierarchy circumventing any evaluation of whether to log or not
  20904. to log the particular log request.
  20905. </para>
  20906. </remarks>
  20907. </member>
  20908. <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
  20909. <summary>
  20910. Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  20911. </summary>
  20912. <remarks>
  20913. <para>
  20914. Used to ensure that the appenders are correctly shutdown.
  20915. </para>
  20916. </remarks>
  20917. </member>
  20918. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
  20919. <summary>
  20920. This is the most generic printing method. This generic form is intended to be used by wrappers
  20921. </summary>
  20922. <param name="level">The level of the message to be logged.</param>
  20923. <param name="message">The message object to log.</param>
  20924. <param name="exception">The exception to log, including its stack trace.</param>
  20925. <remarks>
  20926. <para>
  20927. Generate a logging event for the specified <paramref name="level"/> using
  20928. the <paramref name="message"/>.
  20929. </para>
  20930. </remarks>
  20931. </member>
  20932. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  20933. <summary>
  20934. Creates a new logging event and logs the event without further checks.
  20935. </summary>
  20936. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  20937. the stack boundary into the logging system for this call.</param>
  20938. <param name="level">The level of the message to be logged.</param>
  20939. <param name="message">The message object to log.</param>
  20940. <param name="exception">The exception to log, including its stack trace.</param>
  20941. <remarks>
  20942. <para>
  20943. Generates a logging event and delivers it to the attached
  20944. appenders.
  20945. </para>
  20946. </remarks>
  20947. </member>
  20948. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
  20949. <summary>
  20950. Creates a new logging event and logs the event without further checks.
  20951. </summary>
  20952. <param name="logEvent">The event being logged.</param>
  20953. <remarks>
  20954. <para>
  20955. Delivers the logging event to the attached appenders.
  20956. </para>
  20957. </remarks>
  20958. </member>
  20959. <member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
  20960. <summary>
  20961. The fully qualified type of the Logger class.
  20962. </summary>
  20963. </member>
  20964. <member name="F:log4net.Repository.Hierarchy.Logger.m_name">
  20965. <summary>
  20966. The name of this logger.
  20967. </summary>
  20968. </member>
  20969. <member name="F:log4net.Repository.Hierarchy.Logger.m_level">
  20970. <summary>
  20971. The assigned level of this logger.
  20972. </summary>
  20973. <remarks>
  20974. <para>
  20975. The <c>level</c> variable need not be
  20976. assigned a value in which case it is inherited
  20977. form the hierarchy.
  20978. </para>
  20979. </remarks>
  20980. </member>
  20981. <member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
  20982. <summary>
  20983. The parent of this logger.
  20984. </summary>
  20985. <remarks>
  20986. <para>
  20987. The parent of this logger.
  20988. All loggers have at least one ancestor which is the root logger.
  20989. </para>
  20990. </remarks>
  20991. </member>
  20992. <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
  20993. <summary>
  20994. Loggers need to know what Hierarchy they are in.
  20995. </summary>
  20996. <remarks>
  20997. <para>
  20998. Loggers need to know what Hierarchy they are in.
  20999. The hierarchy that this logger is a member of is stored
  21000. here.
  21001. </para>
  21002. </remarks>
  21003. </member>
  21004. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
  21005. <summary>
  21006. Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  21007. </summary>
  21008. </member>
  21009. <member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
  21010. <summary>
  21011. Flag indicating if child loggers inherit their parents appenders
  21012. </summary>
  21013. <remarks>
  21014. <para>
  21015. Additivity is set to true by default, that is children inherit
  21016. the appenders of their ancestors by default. If this variable is
  21017. set to <c>false</c> then the appenders found in the
  21018. ancestors of this logger are not used. However, the children
  21019. of this logger will inherit its appenders, unless the children
  21020. have their additivity flag set to <c>false</c> too. See
  21021. the user manual for more details.
  21022. </para>
  21023. </remarks>
  21024. </member>
  21025. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
  21026. <summary>
  21027. Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
  21028. </summary>
  21029. </member>
  21030. <member name="T:log4net.Repository.Hierarchy.LoggerKey">
  21031. <summary>
  21032. Used internally to accelerate hash table searches.
  21033. </summary>
  21034. <remarks>
  21035. <para>
  21036. Internal class used to improve performance of
  21037. string keyed hashtables.
  21038. </para>
  21039. <para>
  21040. The hashcode of the string is cached for reuse.
  21041. The string is stored as an interned value.
  21042. When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
  21043. the reference equality of the interned strings is compared.
  21044. </para>
  21045. </remarks>
  21046. <author>Nicko Cadell</author>
  21047. <author>Gert Driesen</author>
  21048. </member>
  21049. <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
  21050. <summary>
  21051. Construct key with string name
  21052. </summary>
  21053. <remarks>
  21054. <para>
  21055. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey" /> class
  21056. with the specified name.
  21057. </para>
  21058. <para>
  21059. Stores the hashcode of the string and interns
  21060. the string key to optimize comparisons.
  21061. </para>
  21062. <note>
  21063. The Compact Framework 1.0 the <see cref="!:String.Intern"/>
  21064. method does not work. On the Compact Framework
  21065. the string keys are not interned nor are they
  21066. compared by reference.
  21067. </note>
  21068. </remarks>
  21069. <param name="name">The name of the logger.</param>
  21070. </member>
  21071. <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
  21072. <summary>
  21073. Returns a hash code for the current instance.
  21074. </summary>
  21075. <returns>A hash code for the current instance.</returns>
  21076. <remarks>
  21077. <para>
  21078. Returns the cached hashcode.
  21079. </para>
  21080. </remarks>
  21081. </member>
  21082. <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
  21083. <summary>
  21084. Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey" /> instances
  21085. are equal.
  21086. </summary>
  21087. <param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey" />.</param>
  21088. <returns>
  21089. <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>.
  21090. </returns>
  21091. <remarks>
  21092. <para>
  21093. Compares the references of the interned strings.
  21094. </para>
  21095. </remarks>
  21096. </member>
  21097. <member name="T:log4net.Repository.Hierarchy.ProvisionNode">
  21098. <summary>
  21099. Provision nodes are used where no logger instance has been specified
  21100. </summary>
  21101. <remarks>
  21102. <para>
  21103. <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
  21104. <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> when there is no specified
  21105. <see cref="T:log4net.Repository.Hierarchy.Logger" /> for that node.
  21106. </para>
  21107. <para>
  21108. A provision node holds a list of child loggers on behalf of
  21109. a logger that does not exist.
  21110. </para>
  21111. </remarks>
  21112. <author>Nicko Cadell</author>
  21113. <author>Gert Driesen</author>
  21114. </member>
  21115. <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
  21116. <summary>
  21117. Create a new provision node with child node
  21118. </summary>
  21119. <param name="log">A child logger to add to this node.</param>
  21120. <remarks>
  21121. <para>
  21122. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode" /> class
  21123. with the specified child logger.
  21124. </para>
  21125. </remarks>
  21126. </member>
  21127. <member name="T:log4net.Repository.Hierarchy.RootLogger">
  21128. <summary>
  21129. The <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> sits at the root of the logger hierarchy tree.
  21130. </summary>
  21131. <remarks>
  21132. <para>
  21133. The <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger" /> except
  21134. that it provides several guarantees.
  21135. </para>
  21136. <para>
  21137. First, it cannot be assigned a <c>null</c>
  21138. level. Second, since the root logger cannot have a parent, the
  21139. <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
  21140. level field without walking the hierarchy.
  21141. </para>
  21142. </remarks>
  21143. <author>Nicko Cadell</author>
  21144. <author>Gert Driesen</author>
  21145. </member>
  21146. <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
  21147. <summary>
  21148. Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
  21149. </summary>
  21150. <param name="level">The level to assign to the root logger.</param>
  21151. <remarks>
  21152. <para>
  21153. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> class with
  21154. the specified logging level.
  21155. </para>
  21156. <para>
  21157. The root logger names itself as "root". However, the root
  21158. logger cannot be retrieved by name.
  21159. </para>
  21160. </remarks>
  21161. </member>
  21162. <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
  21163. <summary>
  21164. Gets the assigned level value without walking the logger hierarchy.
  21165. </summary>
  21166. <value>The assigned level value without walking the logger hierarchy.</value>
  21167. <remarks>
  21168. <para>
  21169. Because the root logger cannot have a parent and its level
  21170. must not be <c>null</c> this property just returns the
  21171. value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
  21172. </para>
  21173. </remarks>
  21174. </member>
  21175. <member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
  21176. <summary>
  21177. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
  21178. </summary>
  21179. <value>
  21180. The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
  21181. </value>
  21182. <remarks>
  21183. <para>
  21184. Setting the level of the root logger to a <c>null</c> reference
  21185. may have catastrophic results. We prevent this here.
  21186. </para>
  21187. </remarks>
  21188. </member>
  21189. <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
  21190. <summary>
  21191. The fully qualified type of the RootLogger class.
  21192. </summary>
  21193. <remarks>
  21194. Used by the internal logger to record the Type of the
  21195. log message.
  21196. </remarks>
  21197. </member>
  21198. <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
  21199. <summary>
  21200. Initializes the log4net environment using an XML DOM.
  21201. </summary>
  21202. <remarks>
  21203. <para>
  21204. Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
  21205. </para>
  21206. </remarks>
  21207. <author>Nicko Cadell</author>
  21208. <author>Gert Driesen</author>
  21209. </member>
  21210. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
  21211. <summary>
  21212. Construct the configurator for a hierarchy
  21213. </summary>
  21214. <param name="hierarchy">The hierarchy to build.</param>
  21215. <remarks>
  21216. <para>
  21217. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator" /> class
  21218. with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy" />.
  21219. </para>
  21220. </remarks>
  21221. </member>
  21222. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
  21223. <summary>
  21224. Configure the hierarchy by parsing a DOM tree of XML elements.
  21225. </summary>
  21226. <param name="element">The root element to parse.</param>
  21227. <remarks>
  21228. <para>
  21229. Configure the hierarchy by parsing a DOM tree of XML elements.
  21230. </para>
  21231. </remarks>
  21232. </member>
  21233. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
  21234. <summary>
  21235. Parse appenders by IDREF.
  21236. </summary>
  21237. <param name="appenderRef">The appender ref element.</param>
  21238. <returns>The instance of the appender that the ref refers to.</returns>
  21239. <remarks>
  21240. <para>
  21241. Parse an XML element that represents an appender and return
  21242. the appender.
  21243. </para>
  21244. </remarks>
  21245. </member>
  21246. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
  21247. <summary>
  21248. Parses an appender element.
  21249. </summary>
  21250. <param name="appenderElement">The appender element.</param>
  21251. <returns>The appender instance or <c>null</c> when parsing failed.</returns>
  21252. <remarks>
  21253. <para>
  21254. Parse an XML element that represents an appender and return
  21255. the appender instance.
  21256. </para>
  21257. </remarks>
  21258. </member>
  21259. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
  21260. <summary>
  21261. Parses a logger element.
  21262. </summary>
  21263. <param name="loggerElement">The logger element.</param>
  21264. <remarks>
  21265. <para>
  21266. Parse an XML element that represents a logger.
  21267. </para>
  21268. </remarks>
  21269. </member>
  21270. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
  21271. <summary>
  21272. Parses the root logger element.
  21273. </summary>
  21274. <param name="rootElement">The root element.</param>
  21275. <remarks>
  21276. <para>
  21277. Parse an XML element that represents the root logger.
  21278. </para>
  21279. </remarks>
  21280. </member>
  21281. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  21282. <summary>
  21283. Parses the children of a logger element.
  21284. </summary>
  21285. <param name="catElement">The category element.</param>
  21286. <param name="log">The logger instance.</param>
  21287. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  21288. <remarks>
  21289. <para>
  21290. Parse the child elements of a &lt;logger&gt; element.
  21291. </para>
  21292. </remarks>
  21293. </member>
  21294. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
  21295. <summary>
  21296. Parses an object renderer.
  21297. </summary>
  21298. <param name="element">The renderer element.</param>
  21299. <remarks>
  21300. <para>
  21301. Parse an XML element that represents a renderer.
  21302. </para>
  21303. </remarks>
  21304. </member>
  21305. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  21306. <summary>
  21307. Parses a level element.
  21308. </summary>
  21309. <param name="element">The level element.</param>
  21310. <param name="log">The logger object to set the level on.</param>
  21311. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  21312. <remarks>
  21313. <para>
  21314. Parse an XML element that represents a level.
  21315. </para>
  21316. </remarks>
  21317. </member>
  21318. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
  21319. <summary>
  21320. Sets a parameter on an object.
  21321. </summary>
  21322. <param name="element">The parameter element.</param>
  21323. <param name="target">The object to set the parameter on.</param>
  21324. <remarks>
  21325. The parameter name must correspond to a writable property
  21326. on the object. The value of the parameter is a string,
  21327. therefore this function will attempt to set a string
  21328. property first. If unable to set a string property it
  21329. will inspect the property and its argument type. It will
  21330. attempt to call a static method called <c>Parse</c> on the
  21331. type of the property. This method will take a single
  21332. string argument and return a value that can be used to
  21333. set the property.
  21334. </remarks>
  21335. </member>
  21336. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
  21337. <summary>
  21338. Test if an element has no attributes or child elements
  21339. </summary>
  21340. <param name="element">the element to inspect</param>
  21341. <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
  21342. </member>
  21343. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
  21344. <summary>
  21345. Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
  21346. </summary>
  21347. <param name="type">the type to inspect</param>
  21348. <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
  21349. </member>
  21350. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
  21351. <summary>
  21352. Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
  21353. </summary>
  21354. <param name="targetType">the type that has the method</param>
  21355. <param name="name">the name of the method</param>
  21356. <returns>the method info found</returns>
  21357. <remarks>
  21358. <para>
  21359. The method must be a public instance method on the <paramref name="targetType"/>.
  21360. The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
  21361. The method must take a single parameter.
  21362. </para>
  21363. </remarks>
  21364. </member>
  21365. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
  21366. <summary>
  21367. Converts a string value to a target type.
  21368. </summary>
  21369. <param name="type">The type of object to convert the string to.</param>
  21370. <param name="value">The string value to use as the value of the object.</param>
  21371. <returns>
  21372. <para>
  21373. An object of type <paramref name="type"/> with value <paramref name="value"/> or
  21374. <c>null</c> when the conversion could not be performed.
  21375. </para>
  21376. </returns>
  21377. </member>
  21378. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
  21379. <summary>
  21380. Creates an object as specified in XML.
  21381. </summary>
  21382. <param name="element">The XML element that contains the definition of the object.</param>
  21383. <param name="defaultTargetType">The object type to use if not explicitly specified.</param>
  21384. <param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
  21385. <returns>The object or <c>null</c></returns>
  21386. <remarks>
  21387. <para>
  21388. Parse an XML element and create an object instance based on the configuration
  21389. data.
  21390. </para>
  21391. <para>
  21392. The type of the instance may be specified in the XML. If not
  21393. specified then the <paramref name="defaultTargetType"/> is used
  21394. as the type. However the type is specified it must support the
  21395. <paramref name="typeConstraint"/> type.
  21396. </para>
  21397. </remarks>
  21398. </member>
  21399. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
  21400. <summary>
  21401. key: appenderName, value: appender.
  21402. </summary>
  21403. </member>
  21404. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
  21405. <summary>
  21406. The Hierarchy being configured.
  21407. </summary>
  21408. </member>
  21409. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
  21410. <summary>
  21411. The fully qualified type of the XmlHierarchyConfigurator class.
  21412. </summary>
  21413. <remarks>
  21414. Used by the internal logger to record the Type of the
  21415. log message.
  21416. </remarks>
  21417. </member>
  21418. <member name="T:log4net.Repository.IBasicRepositoryConfigurator">
  21419. <summary>
  21420. Basic Configurator interface for repositories
  21421. </summary>
  21422. <remarks>
  21423. <para>
  21424. Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
  21425. with a default <see cref="T:log4net.Appender.IAppender"/>.
  21426. </para>
  21427. <para>
  21428. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  21429. configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
  21430. </para>
  21431. </remarks>
  21432. <author>Nicko Cadell</author>
  21433. <author>Gert Driesen</author>
  21434. </member>
  21435. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
  21436. <summary>
  21437. Initialize the repository using the specified appender
  21438. </summary>
  21439. <param name="appender">the appender to use to log all logging events</param>
  21440. <remarks>
  21441. <para>
  21442. Configure the repository to route all logging events to the
  21443. specified appender.
  21444. </para>
  21445. </remarks>
  21446. </member>
  21447. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
  21448. <summary>
  21449. Initialize the repository using the specified appenders
  21450. </summary>
  21451. <param name="appenders">the appenders to use to log all logging events</param>
  21452. <remarks>
  21453. <para>
  21454. Configure the repository to route all logging events to the
  21455. specified appenders.
  21456. </para>
  21457. </remarks>
  21458. </member>
  21459. <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
  21460. <summary>
  21461. Delegate used to handle logger repository shutdown event notifications
  21462. </summary>
  21463. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
  21464. <param name="e">Empty event args</param>
  21465. <remarks>
  21466. <para>
  21467. Delegate used to handle logger repository shutdown event notifications.
  21468. </para>
  21469. </remarks>
  21470. </member>
  21471. <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
  21472. <summary>
  21473. Delegate used to handle logger repository configuration reset event notifications
  21474. </summary>
  21475. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
  21476. <param name="e">Empty event args</param>
  21477. <remarks>
  21478. <para>
  21479. Delegate used to handle logger repository configuration reset event notifications.
  21480. </para>
  21481. </remarks>
  21482. </member>
  21483. <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
  21484. <summary>
  21485. Delegate used to handle event notifications for logger repository configuration changes.
  21486. </summary>
  21487. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
  21488. <param name="e">Empty event arguments.</param>
  21489. <remarks>
  21490. <para>
  21491. Delegate used to handle event notifications for logger repository configuration changes.
  21492. </para>
  21493. </remarks>
  21494. </member>
  21495. <member name="T:log4net.Repository.ILoggerRepository">
  21496. <summary>
  21497. Interface implemented by logger repositories.
  21498. </summary>
  21499. <remarks>
  21500. <para>
  21501. This interface is implemented by logger repositories. e.g.
  21502. <see cref="N:log4net.Repository.Hierarchy"/>.
  21503. </para>
  21504. <para>
  21505. This interface is used by the <see cref="T:log4net.LogManager"/>
  21506. to obtain <see cref="T:log4net.ILog"/> interfaces.
  21507. </para>
  21508. </remarks>
  21509. <author>Nicko Cadell</author>
  21510. <author>Gert Driesen</author>
  21511. </member>
  21512. <member name="P:log4net.Repository.ILoggerRepository.Name">
  21513. <summary>
  21514. The name of the repository
  21515. </summary>
  21516. <value>
  21517. The name of the repository
  21518. </value>
  21519. <remarks>
  21520. <para>
  21521. The name of the repository.
  21522. </para>
  21523. </remarks>
  21524. </member>
  21525. <member name="P:log4net.Repository.ILoggerRepository.RendererMap">
  21526. <summary>
  21527. RendererMap accesses the object renderer map for this repository.
  21528. </summary>
  21529. <value>
  21530. RendererMap accesses the object renderer map for this repository.
  21531. </value>
  21532. <remarks>
  21533. <para>
  21534. RendererMap accesses the object renderer map for this repository.
  21535. </para>
  21536. <para>
  21537. The RendererMap holds a mapping between types and
  21538. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  21539. </para>
  21540. </remarks>
  21541. </member>
  21542. <member name="P:log4net.Repository.ILoggerRepository.PluginMap">
  21543. <summary>
  21544. The plugin map for this repository.
  21545. </summary>
  21546. <value>
  21547. The plugin map for this repository.
  21548. </value>
  21549. <remarks>
  21550. <para>
  21551. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  21552. that have been attached to this repository.
  21553. </para>
  21554. </remarks>
  21555. </member>
  21556. <member name="P:log4net.Repository.ILoggerRepository.LevelMap">
  21557. <summary>
  21558. Get the level map for the Repository.
  21559. </summary>
  21560. <remarks>
  21561. <para>
  21562. Get the level map for the Repository.
  21563. </para>
  21564. <para>
  21565. The level map defines the mappings between
  21566. level names and <see cref="T:log4net.Core.Level"/> objects in
  21567. this repository.
  21568. </para>
  21569. </remarks>
  21570. </member>
  21571. <member name="P:log4net.Repository.ILoggerRepository.Threshold">
  21572. <summary>
  21573. The threshold for all events in this repository
  21574. </summary>
  21575. <value>
  21576. The threshold for all events in this repository
  21577. </value>
  21578. <remarks>
  21579. <para>
  21580. The threshold for all events in this repository.
  21581. </para>
  21582. </remarks>
  21583. </member>
  21584. <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
  21585. <summary>
  21586. Check if the named logger exists in the repository. If so return
  21587. its reference, otherwise returns <c>null</c>.
  21588. </summary>
  21589. <param name="name">The name of the logger to lookup</param>
  21590. <returns>The Logger object with the name specified</returns>
  21591. <remarks>
  21592. <para>
  21593. If the names logger exists it is returned, otherwise
  21594. <c>null</c> is returned.
  21595. </para>
  21596. </remarks>
  21597. </member>
  21598. <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
  21599. <summary>
  21600. Returns all the currently defined loggers as an Array.
  21601. </summary>
  21602. <returns>All the defined loggers</returns>
  21603. <remarks>
  21604. <para>
  21605. Returns all the currently defined loggers as an Array.
  21606. </para>
  21607. </remarks>
  21608. </member>
  21609. <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
  21610. <summary>
  21611. Returns a named logger instance
  21612. </summary>
  21613. <param name="name">The name of the logger to retrieve</param>
  21614. <returns>The logger object with the name specified</returns>
  21615. <remarks>
  21616. <para>
  21617. Returns a named logger instance.
  21618. </para>
  21619. <para>
  21620. If a logger of that name already exists, then it will be
  21621. returned. Otherwise, a new logger will be instantiated and
  21622. then linked with its existing ancestors as well as children.
  21623. </para>
  21624. </remarks>
  21625. </member>
  21626. <member name="M:log4net.Repository.ILoggerRepository.Shutdown">
  21627. <summary>Shutdown the repository</summary>
  21628. <remarks>
  21629. <para>
  21630. Shutting down a repository will <i>safely</i> close and remove
  21631. all appenders in all loggers including the root logger.
  21632. </para>
  21633. <para>
  21634. Some appenders need to be closed before the
  21635. application exists. Otherwise, pending logging events might be
  21636. lost.
  21637. </para>
  21638. <para>
  21639. The <see cref="M:Shutdown()"/> method is careful to close nested
  21640. appenders before closing regular appenders. This is allows
  21641. configurations where a regular appender is attached to a logger
  21642. and again to a nested appender.
  21643. </para>
  21644. </remarks>
  21645. </member>
  21646. <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
  21647. <summary>
  21648. Reset the repositories configuration to a default state
  21649. </summary>
  21650. <remarks>
  21651. <para>
  21652. Reset all values contained in this instance to their
  21653. default state.
  21654. </para>
  21655. <para>
  21656. Existing loggers are not removed. They are just reset.
  21657. </para>
  21658. <para>
  21659. This method should be used sparingly and with care as it will
  21660. block all logging until it is completed.
  21661. </para>
  21662. </remarks>
  21663. </member>
  21664. <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
  21665. <summary>
  21666. Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
  21667. </summary>
  21668. <param name="logEvent">the event to log</param>
  21669. <remarks>
  21670. <para>
  21671. This method should not normally be used to log.
  21672. The <see cref="T:log4net.ILog"/> interface should be used
  21673. for routine logging. This interface can be obtained
  21674. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  21675. </para>
  21676. <para>
  21677. The <c>logEvent</c> is delivered to the appropriate logger and
  21678. that logger is then responsible for logging the event.
  21679. </para>
  21680. </remarks>
  21681. </member>
  21682. <member name="P:log4net.Repository.ILoggerRepository.Configured">
  21683. <summary>
  21684. Flag indicates if this repository has been configured.
  21685. </summary>
  21686. <value>
  21687. Flag indicates if this repository has been configured.
  21688. </value>
  21689. <remarks>
  21690. <para>
  21691. Flag indicates if this repository has been configured.
  21692. </para>
  21693. </remarks>
  21694. </member>
  21695. <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
  21696. <summary>
  21697. Collection of internal messages captured during the most
  21698. recent configuration process.
  21699. </summary>
  21700. </member>
  21701. <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
  21702. <summary>
  21703. Event to notify that the repository has been shutdown.
  21704. </summary>
  21705. <value>
  21706. Event to notify that the repository has been shutdown.
  21707. </value>
  21708. <remarks>
  21709. <para>
  21710. Event raised when the repository has been shutdown.
  21711. </para>
  21712. </remarks>
  21713. </member>
  21714. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
  21715. <summary>
  21716. Event to notify that the repository has had its configuration reset.
  21717. </summary>
  21718. <value>
  21719. Event to notify that the repository has had its configuration reset.
  21720. </value>
  21721. <remarks>
  21722. <para>
  21723. Event raised when the repository's configuration has been
  21724. reset to default.
  21725. </para>
  21726. </remarks>
  21727. </member>
  21728. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
  21729. <summary>
  21730. Event to notify that the repository has had its configuration changed.
  21731. </summary>
  21732. <value>
  21733. Event to notify that the repository has had its configuration changed.
  21734. </value>
  21735. <remarks>
  21736. <para>
  21737. Event raised when the repository's configuration has been changed.
  21738. </para>
  21739. </remarks>
  21740. </member>
  21741. <member name="P:log4net.Repository.ILoggerRepository.Properties">
  21742. <summary>
  21743. Repository specific properties
  21744. </summary>
  21745. <value>
  21746. Repository specific properties
  21747. </value>
  21748. <remarks>
  21749. <para>
  21750. These properties can be specified on a repository specific basis.
  21751. </para>
  21752. </remarks>
  21753. </member>
  21754. <member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
  21755. <summary>
  21756. Returns all the Appenders that are configured as an Array.
  21757. </summary>
  21758. <returns>All the Appenders</returns>
  21759. <remarks>
  21760. <para>
  21761. Returns all the Appenders that are configured as an Array.
  21762. </para>
  21763. </remarks>
  21764. </member>
  21765. <member name="T:log4net.Repository.IXmlRepositoryConfigurator">
  21766. <summary>
  21767. Configure repository using XML
  21768. </summary>
  21769. <remarks>
  21770. <para>
  21771. Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21772. </para>
  21773. <para>
  21774. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  21775. configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
  21776. </para>
  21777. </remarks>
  21778. <author>Nicko Cadell</author>
  21779. <author>Gert Driesen</author>
  21780. </member>
  21781. <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
  21782. <summary>
  21783. Initialize the repository using the specified config
  21784. </summary>
  21785. <param name="element">the element containing the root of the config</param>
  21786. <remarks>
  21787. <para>
  21788. The schema for the XML configuration data is defined by
  21789. the implementation.
  21790. </para>
  21791. </remarks>
  21792. </member>
  21793. <member name="T:log4net.Repository.LoggerRepositorySkeleton">
  21794. <summary>
  21795. Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
  21796. </summary>
  21797. <remarks>
  21798. <para>
  21799. Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21800. </para>
  21801. <para>
  21802. Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21803. All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
  21804. </para>
  21805. </remarks>
  21806. <author>Nicko Cadell</author>
  21807. <author>Gert Driesen</author>
  21808. </member>
  21809. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
  21810. <summary>
  21811. Default Constructor
  21812. </summary>
  21813. <remarks>
  21814. <para>
  21815. Initializes the repository with default (empty) properties.
  21816. </para>
  21817. </remarks>
  21818. </member>
  21819. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
  21820. <summary>
  21821. Construct the repository using specific properties
  21822. </summary>
  21823. <param name="properties">the properties to set for this repository</param>
  21824. <remarks>
  21825. <para>
  21826. Initializes the repository with specified properties.
  21827. </para>
  21828. </remarks>
  21829. </member>
  21830. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
  21831. <summary>
  21832. The name of the repository
  21833. </summary>
  21834. <value>
  21835. The string name of the repository
  21836. </value>
  21837. <remarks>
  21838. <para>
  21839. The name of this repository. The name is
  21840. used to store and lookup the repositories
  21841. stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
  21842. </para>
  21843. </remarks>
  21844. </member>
  21845. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
  21846. <summary>
  21847. The threshold for all events in this repository
  21848. </summary>
  21849. <value>
  21850. The threshold for all events in this repository
  21851. </value>
  21852. <remarks>
  21853. <para>
  21854. The threshold for all events in this repository
  21855. </para>
  21856. </remarks>
  21857. </member>
  21858. <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
  21859. <summary>
  21860. RendererMap accesses the object renderer map for this repository.
  21861. </summary>
  21862. <value>
  21863. RendererMap accesses the object renderer map for this repository.
  21864. </value>
  21865. <remarks>
  21866. <para>
  21867. RendererMap accesses the object renderer map for this repository.
  21868. </para>
  21869. <para>
  21870. The RendererMap holds a mapping between types and
  21871. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  21872. </para>
  21873. </remarks>
  21874. </member>
  21875. <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
  21876. <summary>
  21877. The plugin map for this repository.
  21878. </summary>
  21879. <value>
  21880. The plugin map for this repository.
  21881. </value>
  21882. <remarks>
  21883. <para>
  21884. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  21885. that have been attached to this repository.
  21886. </para>
  21887. </remarks>
  21888. </member>
  21889. <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
  21890. <summary>
  21891. Get the level map for the Repository.
  21892. </summary>
  21893. <remarks>
  21894. <para>
  21895. Get the level map for the Repository.
  21896. </para>
  21897. <para>
  21898. The level map defines the mappings between
  21899. level names and <see cref="T:log4net.Core.Level"/> objects in
  21900. this repository.
  21901. </para>
  21902. </remarks>
  21903. </member>
  21904. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
  21905. <summary>
  21906. Test if logger exists
  21907. </summary>
  21908. <param name="name">The name of the logger to lookup</param>
  21909. <returns>The Logger object with the name specified</returns>
  21910. <remarks>
  21911. <para>
  21912. Check if the named logger exists in the repository. If so return
  21913. its reference, otherwise returns <c>null</c>.
  21914. </para>
  21915. </remarks>
  21916. </member>
  21917. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
  21918. <summary>
  21919. Returns all the currently defined loggers in the repository
  21920. </summary>
  21921. <returns>All the defined loggers</returns>
  21922. <remarks>
  21923. <para>
  21924. Returns all the currently defined loggers in the repository as an Array.
  21925. </para>
  21926. </remarks>
  21927. </member>
  21928. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
  21929. <summary>
  21930. Return a new logger instance
  21931. </summary>
  21932. <param name="name">The name of the logger to retrieve</param>
  21933. <returns>The logger object with the name specified</returns>
  21934. <remarks>
  21935. <para>
  21936. Return a new logger instance.
  21937. </para>
  21938. <para>
  21939. If a logger of that name already exists, then it will be
  21940. returned. Otherwise, a new logger will be instantiated and
  21941. then linked with its existing ancestors as well as children.
  21942. </para>
  21943. </remarks>
  21944. </member>
  21945. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
  21946. <summary>
  21947. Shutdown the repository
  21948. </summary>
  21949. <remarks>
  21950. <para>
  21951. Shutdown the repository. Can be overridden in a subclass.
  21952. This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
  21953. listeners and all attached plugins of the shutdown event.
  21954. </para>
  21955. </remarks>
  21956. </member>
  21957. <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
  21958. <summary>
  21959. Reset the repositories configuration to a default state
  21960. </summary>
  21961. <remarks>
  21962. <para>
  21963. Reset all values contained in this instance to their
  21964. default state.
  21965. </para>
  21966. <para>
  21967. Existing loggers are not removed. They are just reset.
  21968. </para>
  21969. <para>
  21970. This method should be used sparingly and with care as it will
  21971. block all logging until it is completed.
  21972. </para>
  21973. </remarks>
  21974. </member>
  21975. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
  21976. <summary>
  21977. Log the logEvent through this repository.
  21978. </summary>
  21979. <param name="logEvent">the event to log</param>
  21980. <remarks>
  21981. <para>
  21982. This method should not normally be used to log.
  21983. The <see cref="T:log4net.ILog"/> interface should be used
  21984. for routine logging. This interface can be obtained
  21985. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  21986. </para>
  21987. <para>
  21988. The <c>logEvent</c> is delivered to the appropriate logger and
  21989. that logger is then responsible for logging the event.
  21990. </para>
  21991. </remarks>
  21992. </member>
  21993. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
  21994. <summary>
  21995. Flag indicates if this repository has been configured.
  21996. </summary>
  21997. <value>
  21998. Flag indicates if this repository has been configured.
  21999. </value>
  22000. <remarks>
  22001. <para>
  22002. Flag indicates if this repository has been configured.
  22003. </para>
  22004. </remarks>
  22005. </member>
  22006. <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
  22007. <summary>
  22008. Contains a list of internal messages captures during the
  22009. last configuration.
  22010. </summary>
  22011. </member>
  22012. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
  22013. <summary>
  22014. Event to notify that the repository has been shutdown.
  22015. </summary>
  22016. <value>
  22017. Event to notify that the repository has been shutdown.
  22018. </value>
  22019. <remarks>
  22020. <para>
  22021. Event raised when the repository has been shutdown.
  22022. </para>
  22023. </remarks>
  22024. </member>
  22025. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
  22026. <summary>
  22027. Event to notify that the repository has had its configuration reset.
  22028. </summary>
  22029. <value>
  22030. Event to notify that the repository has had its configuration reset.
  22031. </value>
  22032. <remarks>
  22033. <para>
  22034. Event raised when the repository's configuration has been
  22035. reset to default.
  22036. </para>
  22037. </remarks>
  22038. </member>
  22039. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
  22040. <summary>
  22041. Event to notify that the repository has had its configuration changed.
  22042. </summary>
  22043. <value>
  22044. Event to notify that the repository has had its configuration changed.
  22045. </value>
  22046. <remarks>
  22047. <para>
  22048. Event raised when the repository's configuration has been changed.
  22049. </para>
  22050. </remarks>
  22051. </member>
  22052. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
  22053. <summary>
  22054. Repository specific properties
  22055. </summary>
  22056. <value>
  22057. Repository specific properties
  22058. </value>
  22059. <remarks>
  22060. These properties can be specified on a repository specific basis
  22061. </remarks>
  22062. </member>
  22063. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
  22064. <summary>
  22065. Returns all the Appenders that are configured as an Array.
  22066. </summary>
  22067. <returns>All the Appenders</returns>
  22068. <remarks>
  22069. <para>
  22070. Returns all the Appenders that are configured as an Array.
  22071. </para>
  22072. </remarks>
  22073. </member>
  22074. <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
  22075. <summary>
  22076. The fully qualified type of the LoggerRepositorySkeleton class.
  22077. </summary>
  22078. <remarks>
  22079. Used by the internal logger to record the Type of the
  22080. log message.
  22081. </remarks>
  22082. </member>
  22083. <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  22084. <summary>
  22085. Adds an object renderer for a specific class.
  22086. </summary>
  22087. <param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
  22088. <param name="rendererInstance">The object renderer used to render the object.</param>
  22089. <remarks>
  22090. <para>
  22091. Adds an object renderer for a specific class.
  22092. </para>
  22093. </remarks>
  22094. </member>
  22095. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
  22096. <summary>
  22097. Notify the registered listeners that the repository is shutting down
  22098. </summary>
  22099. <param name="e">Empty EventArgs</param>
  22100. <remarks>
  22101. <para>
  22102. Notify any listeners that this repository is shutting down.
  22103. </para>
  22104. </remarks>
  22105. </member>
  22106. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
  22107. <summary>
  22108. Notify the registered listeners that the repository has had its configuration reset
  22109. </summary>
  22110. <param name="e">Empty EventArgs</param>
  22111. <remarks>
  22112. <para>
  22113. Notify any listeners that this repository's configuration has been reset.
  22114. </para>
  22115. </remarks>
  22116. </member>
  22117. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
  22118. <summary>
  22119. Notify the registered listeners that the repository has had its configuration changed
  22120. </summary>
  22121. <param name="e">Empty EventArgs</param>
  22122. <remarks>
  22123. <para>
  22124. Notify any listeners that this repository's configuration has changed.
  22125. </para>
  22126. </remarks>
  22127. </member>
  22128. <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
  22129. <summary>
  22130. Raise a configuration changed event on this repository
  22131. </summary>
  22132. <param name="e">EventArgs.Empty</param>
  22133. <remarks>
  22134. <para>
  22135. Applications that programmatically change the configuration of the repository should
  22136. raise this event notification to notify listeners.
  22137. </para>
  22138. </remarks>
  22139. </member>
  22140. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Flush(System.Int32)">
  22141. <summary>
  22142. Flushes all configured Appenders that implement <see cref="T:log4net.Appender.IFlushable"/>.
  22143. </summary>
  22144. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed,
  22145. or <see cref="F:System.Threading.Timeout.Infinite"/> to wait indefinitely.</param>
  22146. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  22147. </member>
  22148. <member name="T:log4net.ThreadContext">
  22149. <summary>
  22150. The log4net Thread Context.
  22151. </summary>
  22152. <remarks>
  22153. <para>
  22154. The <c>ThreadContext</c> provides a location for thread specific debugging
  22155. information to be stored.
  22156. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  22157. properties with the same name.
  22158. </para>
  22159. <para>
  22160. The thread context has a properties map and a stack.
  22161. The properties and stack can
  22162. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  22163. supports selecting and outputting these properties.
  22164. </para>
  22165. <para>
  22166. The Thread Context provides a diagnostic context for the current thread.
  22167. This is an instrument for distinguishing interleaved log
  22168. output from different sources. Log output is typically interleaved
  22169. when a server handles multiple clients near-simultaneously.
  22170. </para>
  22171. <para>
  22172. The Thread Context is managed on a per thread basis.
  22173. </para>
  22174. </remarks>
  22175. <example>Example of using the thread context properties to store a username.
  22176. <code lang="C#">
  22177. ThreadContext.Properties["user"] = userName;
  22178. log.Info("This log message has a ThreadContext Property called 'user'");
  22179. </code>
  22180. </example>
  22181. <example>Example of how to push a message into the context stack
  22182. <code lang="C#">
  22183. using(ThreadContext.Stacks["NDC"].Push("my context message"))
  22184. {
  22185. log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
  22186. } // at the end of the using block the message is automatically popped
  22187. </code>
  22188. </example>
  22189. <threadsafety static="true" instance="true" />
  22190. <author>Nicko Cadell</author>
  22191. </member>
  22192. <member name="M:log4net.ThreadContext.#ctor">
  22193. <summary>
  22194. Private Constructor.
  22195. </summary>
  22196. <remarks>
  22197. <para>
  22198. Uses a private access modifier to prevent instantiation of this class.
  22199. </para>
  22200. </remarks>
  22201. </member>
  22202. <member name="P:log4net.ThreadContext.Properties">
  22203. <summary>
  22204. The thread properties map
  22205. </summary>
  22206. <value>
  22207. The thread properties map
  22208. </value>
  22209. <remarks>
  22210. <para>
  22211. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  22212. properties with the same name.
  22213. </para>
  22214. </remarks>
  22215. </member>
  22216. <member name="P:log4net.ThreadContext.Stacks">
  22217. <summary>
  22218. The thread stacks
  22219. </summary>
  22220. <value>
  22221. stack map
  22222. </value>
  22223. <remarks>
  22224. <para>
  22225. The thread local stacks.
  22226. </para>
  22227. </remarks>
  22228. </member>
  22229. <member name="F:log4net.ThreadContext.s_properties">
  22230. <summary>
  22231. The thread context properties instance
  22232. </summary>
  22233. </member>
  22234. <member name="F:log4net.ThreadContext.s_stacks">
  22235. <summary>
  22236. The thread context stacks instance
  22237. </summary>
  22238. </member>
  22239. <member name="T:log4net.Util.AppenderAttachedImpl">
  22240. <summary>
  22241. A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  22242. </summary>
  22243. <remarks>
  22244. <para>
  22245. This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
  22246. interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  22247. should aggregate an instance of this type.
  22248. </para>
  22249. </remarks>
  22250. <author>Nicko Cadell</author>
  22251. <author>Gert Driesen</author>
  22252. </member>
  22253. <member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
  22254. <summary>
  22255. Constructor
  22256. </summary>
  22257. <remarks>
  22258. <para>
  22259. Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
  22260. </para>
  22261. </remarks>
  22262. </member>
  22263. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
  22264. <summary>
  22265. Append on on all attached appenders.
  22266. </summary>
  22267. <param name="loggingEvent">The event being logged.</param>
  22268. <returns>The number of appenders called.</returns>
  22269. <remarks>
  22270. <para>
  22271. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)" /> method on all
  22272. attached appenders.
  22273. </para>
  22274. </remarks>
  22275. </member>
  22276. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
  22277. <summary>
  22278. Append on on all attached appenders.
  22279. </summary>
  22280. <param name="loggingEvents">The array of events being logged.</param>
  22281. <returns>The number of appenders called.</returns>
  22282. <remarks>
  22283. <para>
  22284. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)" /> method on all
  22285. attached appenders.
  22286. </para>
  22287. </remarks>
  22288. </member>
  22289. <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
  22290. <summary>
  22291. Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
  22292. the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
  22293. </summary>
  22294. <param name="appender">The appender</param>
  22295. <param name="loggingEvents">The events</param>
  22296. <remarks>
  22297. <para>
  22298. If the <paramref name="appender" /> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
  22299. interface then the <paramref name="loggingEvents" /> will be passed
  22300. through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
  22301. objects in the array will be passed one at a time.
  22302. </para>
  22303. </remarks>
  22304. </member>
  22305. <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
  22306. <summary>
  22307. Attaches an appender.
  22308. </summary>
  22309. <param name="newAppender">The appender to add.</param>
  22310. <remarks>
  22311. <para>
  22312. If the appender is already in the list it won't be added again.
  22313. </para>
  22314. </remarks>
  22315. </member>
  22316. <member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
  22317. <summary>
  22318. Gets all attached appenders.
  22319. </summary>
  22320. <returns>
  22321. A collection of attached appenders, or <c>null</c> if there
  22322. are no attached appenders.
  22323. </returns>
  22324. <remarks>
  22325. <para>
  22326. The read only collection of all currently attached appenders.
  22327. </para>
  22328. </remarks>
  22329. </member>
  22330. <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
  22331. <summary>
  22332. Gets an attached appender with the specified name.
  22333. </summary>
  22334. <param name="name">The name of the appender to get.</param>
  22335. <returns>
  22336. The appender with the name specified, or <c>null</c> if no appender with the
  22337. specified name is found.
  22338. </returns>
  22339. <remarks>
  22340. <para>
  22341. Lookup an attached appender by name.
  22342. </para>
  22343. </remarks>
  22344. </member>
  22345. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
  22346. <summary>
  22347. Removes all attached appenders.
  22348. </summary>
  22349. <remarks>
  22350. <para>
  22351. Removes and closes all attached appenders
  22352. </para>
  22353. </remarks>
  22354. </member>
  22355. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
  22356. <summary>
  22357. Removes the specified appender from the list of attached appenders.
  22358. </summary>
  22359. <param name="appender">The appender to remove.</param>
  22360. <returns>The appender removed from the list</returns>
  22361. <remarks>
  22362. <para>
  22363. The appender removed is not closed.
  22364. If you are discarding the appender you must call
  22365. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  22366. </para>
  22367. </remarks>
  22368. </member>
  22369. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
  22370. <summary>
  22371. Removes the appender with the specified name from the list of appenders.
  22372. </summary>
  22373. <param name="name">The name of the appender to remove.</param>
  22374. <returns>The appender removed from the list</returns>
  22375. <remarks>
  22376. <para>
  22377. The appender removed is not closed.
  22378. If you are discarding the appender you must call
  22379. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  22380. </para>
  22381. </remarks>
  22382. </member>
  22383. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
  22384. <summary>
  22385. List of appenders
  22386. </summary>
  22387. </member>
  22388. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
  22389. <summary>
  22390. Array of appenders, used to cache the m_appenderList
  22391. </summary>
  22392. </member>
  22393. <member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
  22394. <summary>
  22395. The fully qualified type of the AppenderAttachedImpl class.
  22396. </summary>
  22397. <remarks>
  22398. Used by the internal logger to record the Type of the
  22399. log message.
  22400. </remarks>
  22401. </member>
  22402. <member name="T:log4net.Util.CompositeProperties">
  22403. <summary>
  22404. This class aggregates several PropertiesDictionary collections together.
  22405. </summary>
  22406. <remarks>
  22407. <para>
  22408. Provides a dictionary style lookup over an ordered list of
  22409. <see cref="T:log4net.Util.PropertiesDictionary"/> collections.
  22410. </para>
  22411. </remarks>
  22412. <author>Nicko Cadell</author>
  22413. </member>
  22414. <member name="M:log4net.Util.CompositeProperties.#ctor">
  22415. <summary>
  22416. Constructor
  22417. </summary>
  22418. <remarks>
  22419. <para>
  22420. Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties" /> class.
  22421. </para>
  22422. </remarks>
  22423. </member>
  22424. <member name="P:log4net.Util.CompositeProperties.Item(System.String)">
  22425. <summary>
  22426. Gets the value of a property
  22427. </summary>
  22428. <value>
  22429. The value for the property with the specified key
  22430. </value>
  22431. <remarks>
  22432. <para>
  22433. Looks up the value for the <paramref name="key" /> specified.
  22434. The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
  22435. in the order in which they were added to this collection. The value
  22436. returned is the value held by the first collection that contains
  22437. the specified key.
  22438. </para>
  22439. <para>
  22440. If none of the collections contain the specified key then
  22441. <c>null</c> is returned.
  22442. </para>
  22443. </remarks>
  22444. </member>
  22445. <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
  22446. <summary>
  22447. Add a Properties Dictionary to this composite collection
  22448. </summary>
  22449. <param name="properties">the properties to add</param>
  22450. <remarks>
  22451. <para>
  22452. Properties dictionaries added first take precedence over dictionaries added
  22453. later.
  22454. </para>
  22455. </remarks>
  22456. </member>
  22457. <member name="M:log4net.Util.CompositeProperties.Flatten">
  22458. <summary>
  22459. Flatten this composite collection into a single properties dictionary
  22460. </summary>
  22461. <returns>the flattened dictionary</returns>
  22462. <remarks>
  22463. <para>
  22464. Reduces the collection of ordered dictionaries to a single dictionary
  22465. containing the resultant values for the keys.
  22466. </para>
  22467. </remarks>
  22468. </member>
  22469. <member name="T:log4net.Util.ContextPropertiesBase">
  22470. <summary>
  22471. Base class for Context Properties implementations
  22472. </summary>
  22473. <remarks>
  22474. <para>
  22475. This class defines a basic property get set accessor
  22476. </para>
  22477. </remarks>
  22478. <author>Nicko Cadell</author>
  22479. </member>
  22480. <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
  22481. <summary>
  22482. Gets or sets the value of a property
  22483. </summary>
  22484. <value>
  22485. The value for the property with the specified key
  22486. </value>
  22487. <remarks>
  22488. <para>
  22489. Gets or sets the value of a property
  22490. </para>
  22491. </remarks>
  22492. </member>
  22493. <member name="T:log4net.Util.ConverterInfo">
  22494. <summary>
  22495. Wrapper class used to map converter names to converter types
  22496. </summary>
  22497. <remarks>
  22498. <para>
  22499. Pattern converter info class used during configuration by custom
  22500. PatternString and PatternLayer converters.
  22501. </para>
  22502. </remarks>
  22503. </member>
  22504. <member name="M:log4net.Util.ConverterInfo.#ctor">
  22505. <summary>
  22506. default constructor
  22507. </summary>
  22508. </member>
  22509. <member name="P:log4net.Util.ConverterInfo.Name">
  22510. <summary>
  22511. Gets or sets the name of the conversion pattern
  22512. </summary>
  22513. <remarks>
  22514. <para>
  22515. The name of the pattern in the format string
  22516. </para>
  22517. </remarks>
  22518. </member>
  22519. <member name="P:log4net.Util.ConverterInfo.Type">
  22520. <summary>
  22521. Gets or sets the type of the converter
  22522. </summary>
  22523. <remarks>
  22524. <para>
  22525. The value specified must extend the
  22526. <see cref="T:log4net.Util.PatternConverter"/> type.
  22527. </para>
  22528. </remarks>
  22529. </member>
  22530. <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
  22531. <summary>
  22532. </summary>
  22533. <param name="entry"></param>
  22534. </member>
  22535. <member name="P:log4net.Util.ConverterInfo.Properties">
  22536. <summary>
  22537. </summary>
  22538. </member>
  22539. <member name="T:log4net.Util.CountingQuietTextWriter">
  22540. <summary>
  22541. Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
  22542. the number of bytes written.
  22543. </summary>
  22544. <remarks>
  22545. <para>
  22546. This writer counts the number of bytes written.
  22547. </para>
  22548. </remarks>
  22549. <author>Nicko Cadell</author>
  22550. <author>Gert Driesen</author>
  22551. </member>
  22552. <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  22553. <summary>
  22554. Constructor
  22555. </summary>
  22556. <param name="writer">The <see cref="T:System.IO.TextWriter" /> to actually write to.</param>
  22557. <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler" /> to report errors to.</param>
  22558. <remarks>
  22559. <para>
  22560. Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter" /> class
  22561. with the specified <see cref="T:System.IO.TextWriter" /> and <see cref="T:log4net.Core.IErrorHandler" />.
  22562. </para>
  22563. </remarks>
  22564. </member>
  22565. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
  22566. <summary>
  22567. Writes a character to the underlying writer and counts the number of bytes written.
  22568. </summary>
  22569. <param name="value">the char to write</param>
  22570. <remarks>
  22571. <para>
  22572. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  22573. the number of bytes written.
  22574. </para>
  22575. </remarks>
  22576. </member>
  22577. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  22578. <summary>
  22579. Writes a buffer to the underlying writer and counts the number of bytes written.
  22580. </summary>
  22581. <param name="buffer">the buffer to write</param>
  22582. <param name="index">the start index to write from</param>
  22583. <param name="count">the number of characters to write</param>
  22584. <remarks>
  22585. <para>
  22586. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  22587. the number of bytes written.
  22588. </para>
  22589. </remarks>
  22590. </member>
  22591. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
  22592. <summary>
  22593. Writes a string to the output and counts the number of bytes written.
  22594. </summary>
  22595. <param name="str">The string data to write to the output.</param>
  22596. <remarks>
  22597. <para>
  22598. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  22599. the number of bytes written.
  22600. </para>
  22601. </remarks>
  22602. </member>
  22603. <member name="P:log4net.Util.CountingQuietTextWriter.Count">
  22604. <summary>
  22605. Gets or sets the total number of bytes written.
  22606. </summary>
  22607. <value>
  22608. The total number of bytes written.
  22609. </value>
  22610. <remarks>
  22611. <para>
  22612. Gets or sets the total number of bytes written.
  22613. </para>
  22614. </remarks>
  22615. </member>
  22616. <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
  22617. <summary>
  22618. Total number of bytes written.
  22619. </summary>
  22620. </member>
  22621. <member name="T:log4net.Util.CyclicBuffer">
  22622. <summary>
  22623. A fixed size rolling buffer of logging events.
  22624. </summary>
  22625. <remarks>
  22626. <para>
  22627. An array backed fixed size leaky bucket.
  22628. </para>
  22629. </remarks>
  22630. <author>Nicko Cadell</author>
  22631. <author>Gert Driesen</author>
  22632. </member>
  22633. <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
  22634. <summary>
  22635. Constructor
  22636. </summary>
  22637. <param name="maxSize">The maximum number of logging events in the buffer.</param>
  22638. <remarks>
  22639. <para>
  22640. Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer" /> class with
  22641. the specified maximum number of buffered logging events.
  22642. </para>
  22643. </remarks>
  22644. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
  22645. </member>
  22646. <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
  22647. <summary>
  22648. Appends a <paramref name="loggingEvent"/> to the buffer.
  22649. </summary>
  22650. <param name="loggingEvent">The event to append to the buffer.</param>
  22651. <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
  22652. <remarks>
  22653. <para>
  22654. Append an event to the buffer. If the buffer still contains free space then
  22655. <c>null</c> is returned. If the buffer is full then an event will be dropped
  22656. to make space for the new event, the event dropped is returned.
  22657. </para>
  22658. </remarks>
  22659. </member>
  22660. <member name="M:log4net.Util.CyclicBuffer.PopOldest">
  22661. <summary>
  22662. Get and remove the oldest event in the buffer.
  22663. </summary>
  22664. <returns>The oldest logging event in the buffer</returns>
  22665. <remarks>
  22666. <para>
  22667. Gets the oldest (first) logging event in the buffer and removes it
  22668. from the buffer.
  22669. </para>
  22670. </remarks>
  22671. </member>
  22672. <member name="M:log4net.Util.CyclicBuffer.PopAll">
  22673. <summary>
  22674. Pops all the logging events from the buffer into an array.
  22675. </summary>
  22676. <returns>An array of all the logging events in the buffer.</returns>
  22677. <remarks>
  22678. <para>
  22679. Get all the events in the buffer and clear the buffer.
  22680. </para>
  22681. </remarks>
  22682. </member>
  22683. <member name="M:log4net.Util.CyclicBuffer.Clear">
  22684. <summary>
  22685. Clear the buffer
  22686. </summary>
  22687. <remarks>
  22688. <para>
  22689. Clear the buffer of all events. The events in the buffer are lost.
  22690. </para>
  22691. </remarks>
  22692. </member>
  22693. <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
  22694. <summary>
  22695. Gets the <paramref name="i"/>th oldest event currently in the buffer.
  22696. </summary>
  22697. <value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
  22698. <remarks>
  22699. <para>
  22700. If <paramref name="i"/> is outside the range 0 to the number of events
  22701. currently in the buffer, then <c>null</c> is returned.
  22702. </para>
  22703. </remarks>
  22704. </member>
  22705. <member name="P:log4net.Util.CyclicBuffer.MaxSize">
  22706. <summary>
  22707. Gets the maximum size of the buffer.
  22708. </summary>
  22709. <value>The maximum size of the buffer.</value>
  22710. <remarks>
  22711. <para>
  22712. Gets the maximum size of the buffer
  22713. </para>
  22714. </remarks>
  22715. </member>
  22716. <member name="P:log4net.Util.CyclicBuffer.Length">
  22717. <summary>
  22718. Gets the number of logging events in the buffer.
  22719. </summary>
  22720. <value>The number of logging events in the buffer.</value>
  22721. <remarks>
  22722. <para>
  22723. This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
  22724. (inclusive).
  22725. </para>
  22726. </remarks>
  22727. </member>
  22728. <member name="T:log4net.Util.EmptyCollection">
  22729. <summary>
  22730. An always empty <see cref="T:System.Collections.ICollection"/>.
  22731. </summary>
  22732. <remarks>
  22733. <para>
  22734. A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
  22735. interface that always represents an empty collection.
  22736. </para>
  22737. </remarks>
  22738. <author>Nicko Cadell</author>
  22739. <author>Gert Driesen</author>
  22740. </member>
  22741. <member name="M:log4net.Util.EmptyCollection.#ctor">
  22742. <summary>
  22743. Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection" /> class.
  22744. </summary>
  22745. <remarks>
  22746. <para>
  22747. Uses a private access modifier to enforce the singleton pattern.
  22748. </para>
  22749. </remarks>
  22750. </member>
  22751. <member name="P:log4net.Util.EmptyCollection.Instance">
  22752. <summary>
  22753. Gets the singleton instance of the empty collection.
  22754. </summary>
  22755. <returns>The singleton instance of the empty collection.</returns>
  22756. <remarks>
  22757. <para>
  22758. Gets the singleton instance of the empty collection.
  22759. </para>
  22760. </remarks>
  22761. </member>
  22762. <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
  22763. <summary>
  22764. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  22765. <see cref="T:System.Array"/>, starting at a particular Array index.
  22766. </summary>
  22767. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  22768. that is the destination of the elements copied from
  22769. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  22770. indexing.</param>
  22771. <param name="index">The zero-based index in array at which
  22772. copying begins.</param>
  22773. <remarks>
  22774. <para>
  22775. As the collection is empty no values are copied into the array.
  22776. </para>
  22777. </remarks>
  22778. </member>
  22779. <member name="P:log4net.Util.EmptyCollection.IsSynchronized">
  22780. <summary>
  22781. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  22782. </summary>
  22783. <value>
  22784. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  22785. </value>
  22786. <remarks>
  22787. <para>
  22788. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
  22789. </para>
  22790. </remarks>
  22791. </member>
  22792. <member name="P:log4net.Util.EmptyCollection.Count">
  22793. <summary>
  22794. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  22795. </summary>
  22796. <value>
  22797. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  22798. </value>
  22799. <remarks>
  22800. <para>
  22801. As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
  22802. </para>
  22803. </remarks>
  22804. </member>
  22805. <member name="P:log4net.Util.EmptyCollection.SyncRoot">
  22806. <summary>
  22807. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  22808. </summary>
  22809. <value>
  22810. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  22811. </value>
  22812. <remarks>
  22813. <para>
  22814. As the collection is empty and thread safe and synchronized this instance is also
  22815. the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
  22816. </para>
  22817. </remarks>
  22818. </member>
  22819. <member name="M:log4net.Util.EmptyCollection.GetEnumerator">
  22820. <summary>
  22821. Returns an enumerator that can iterate through a collection.
  22822. </summary>
  22823. <returns>
  22824. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  22825. iterate through the collection.
  22826. </returns>
  22827. <remarks>
  22828. <para>
  22829. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  22830. </para>
  22831. </remarks>
  22832. </member>
  22833. <member name="F:log4net.Util.EmptyCollection.s_instance">
  22834. <summary>
  22835. The singleton instance of the empty collection.
  22836. </summary>
  22837. </member>
  22838. <member name="T:log4net.Util.EmptyDictionary">
  22839. <summary>
  22840. An always empty <see cref="T:System.Collections.IDictionary"/>.
  22841. </summary>
  22842. <remarks>
  22843. <para>
  22844. A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
  22845. interface that always represents an empty collection.
  22846. </para>
  22847. </remarks>
  22848. <author>Nicko Cadell</author>
  22849. <author>Gert Driesen</author>
  22850. </member>
  22851. <member name="M:log4net.Util.EmptyDictionary.#ctor">
  22852. <summary>
  22853. Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary" /> class.
  22854. </summary>
  22855. <remarks>
  22856. <para>
  22857. Uses a private access modifier to enforce the singleton pattern.
  22858. </para>
  22859. </remarks>
  22860. </member>
  22861. <member name="P:log4net.Util.EmptyDictionary.Instance">
  22862. <summary>
  22863. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.
  22864. </summary>
  22865. <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.</returns>
  22866. <remarks>
  22867. <para>
  22868. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.
  22869. </para>
  22870. </remarks>
  22871. </member>
  22872. <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
  22873. <summary>
  22874. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  22875. <see cref="T:System.Array"/>, starting at a particular Array index.
  22876. </summary>
  22877. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  22878. that is the destination of the elements copied from
  22879. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  22880. indexing.</param>
  22881. <param name="index">The zero-based index in array at which
  22882. copying begins.</param>
  22883. <remarks>
  22884. <para>
  22885. As the collection is empty no values are copied into the array.
  22886. </para>
  22887. </remarks>
  22888. </member>
  22889. <member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
  22890. <summary>
  22891. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  22892. </summary>
  22893. <value>
  22894. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  22895. </value>
  22896. <remarks>
  22897. <para>
  22898. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
  22899. </para>
  22900. </remarks>
  22901. </member>
  22902. <member name="P:log4net.Util.EmptyDictionary.Count">
  22903. <summary>
  22904. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
  22905. </summary>
  22906. <value>
  22907. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  22908. </value>
  22909. <remarks>
  22910. <para>
  22911. As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
  22912. </para>
  22913. </remarks>
  22914. </member>
  22915. <member name="P:log4net.Util.EmptyDictionary.SyncRoot">
  22916. <summary>
  22917. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  22918. </summary>
  22919. <value>
  22920. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  22921. </value>
  22922. <remarks>
  22923. <para>
  22924. As the collection is empty and thread safe and synchronized this instance is also
  22925. the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
  22926. </para>
  22927. </remarks>
  22928. </member>
  22929. <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
  22930. <summary>
  22931. Returns an enumerator that can iterate through a collection.
  22932. </summary>
  22933. <returns>
  22934. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  22935. iterate through the collection.
  22936. </returns>
  22937. <remarks>
  22938. <para>
  22939. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  22940. </para>
  22941. </remarks>
  22942. </member>
  22943. <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
  22944. <summary>
  22945. Adds an element with the provided key and value to the
  22946. <see cref="T:log4net.Util.EmptyDictionary" />.
  22947. </summary>
  22948. <param name="key">The <see cref="T:System.Object" /> to use as the key of the element to add.</param>
  22949. <param name="value">The <see cref="T:System.Object" /> to use as the value of the element to add.</param>
  22950. <remarks>
  22951. <para>
  22952. As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
  22953. is thrown if this method is called.
  22954. </para>
  22955. </remarks>
  22956. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  22957. </member>
  22958. <member name="M:log4net.Util.EmptyDictionary.Clear">
  22959. <summary>
  22960. Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary" />.
  22961. </summary>
  22962. <remarks>
  22963. <para>
  22964. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  22965. is thrown if this method is called.
  22966. </para>
  22967. </remarks>
  22968. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  22969. </member>
  22970. <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
  22971. <summary>
  22972. Determines whether the <see cref="T:log4net.Util.EmptyDictionary" /> contains an element
  22973. with the specified key.
  22974. </summary>
  22975. <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary" />.</param>
  22976. <returns><c>false</c></returns>
  22977. <remarks>
  22978. <para>
  22979. As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
  22980. </para>
  22981. </remarks>
  22982. </member>
  22983. <member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
  22984. <summary>
  22985. Returns an enumerator that can iterate through a collection.
  22986. </summary>
  22987. <returns>
  22988. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  22989. iterate through the collection.
  22990. </returns>
  22991. <remarks>
  22992. <para>
  22993. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  22994. </para>
  22995. </remarks>
  22996. </member>
  22997. <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
  22998. <summary>
  22999. Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary" />.
  23000. </summary>
  23001. <param name="key">The key of the element to remove.</param>
  23002. <remarks>
  23003. <para>
  23004. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  23005. is thrown if this method is called.
  23006. </para>
  23007. </remarks>
  23008. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  23009. </member>
  23010. <member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
  23011. <summary>
  23012. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary" /> has a fixed size.
  23013. </summary>
  23014. <value><c>true</c></value>
  23015. <remarks>
  23016. <para>
  23017. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
  23018. </para>
  23019. </remarks>
  23020. </member>
  23021. <member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
  23022. <summary>
  23023. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary" /> is read-only.
  23024. </summary>
  23025. <value><c>true</c></value>
  23026. <remarks>
  23027. <para>
  23028. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
  23029. </para>
  23030. </remarks>
  23031. </member>
  23032. <member name="P:log4net.Util.EmptyDictionary.Keys">
  23033. <summary>
  23034. Gets an <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary" />.
  23035. </summary>
  23036. <value>An <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary" />.</value>
  23037. <remarks>
  23038. <para>
  23039. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  23040. </para>
  23041. </remarks>
  23042. </member>
  23043. <member name="P:log4net.Util.EmptyDictionary.Values">
  23044. <summary>
  23045. Gets an <see cref="T:System.Collections.ICollection" /> containing the values of the <see cref="T:log4net.Util.EmptyDictionary" />.
  23046. </summary>
  23047. <value>An <see cref="T:System.Collections.ICollection" /> containing the values of the <see cref="T:log4net.Util.EmptyDictionary" />.</value>
  23048. <remarks>
  23049. <para>
  23050. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  23051. </para>
  23052. </remarks>
  23053. </member>
  23054. <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
  23055. <summary>
  23056. Gets or sets the element with the specified key.
  23057. </summary>
  23058. <param name="key">The key of the element to get or set.</param>
  23059. <value><c>null</c></value>
  23060. <remarks>
  23061. <para>
  23062. As the collection is empty no values can be looked up or stored.
  23063. If the index getter is called then <c>null</c> is returned.
  23064. A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
  23065. </para>
  23066. </remarks>
  23067. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  23068. </member>
  23069. <member name="F:log4net.Util.EmptyDictionary.s_instance">
  23070. <summary>
  23071. The singleton instance of the empty dictionary.
  23072. </summary>
  23073. </member>
  23074. <member name="T:log4net.Util.FormattingInfo">
  23075. <summary>
  23076. Contain the information obtained when parsing formatting modifiers
  23077. in conversion modifiers.
  23078. </summary>
  23079. <remarks>
  23080. <para>
  23081. Holds the formatting information extracted from the format string by
  23082. the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
  23083. objects when rendering the output.
  23084. </para>
  23085. </remarks>
  23086. <author>Nicko Cadell</author>
  23087. <author>Gert Driesen</author>
  23088. </member>
  23089. <member name="M:log4net.Util.FormattingInfo.#ctor">
  23090. <summary>
  23091. Defaut Constructor
  23092. </summary>
  23093. <remarks>
  23094. <para>
  23095. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo" /> class.
  23096. </para>
  23097. </remarks>
  23098. </member>
  23099. <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
  23100. <summary>
  23101. Constructor
  23102. </summary>
  23103. <remarks>
  23104. <para>
  23105. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo" /> class
  23106. with the specified parameters.
  23107. </para>
  23108. </remarks>
  23109. </member>
  23110. <member name="P:log4net.Util.FormattingInfo.Min">
  23111. <summary>
  23112. Gets or sets the minimum value.
  23113. </summary>
  23114. <value>
  23115. The minimum value.
  23116. </value>
  23117. <remarks>
  23118. <para>
  23119. Gets or sets the minimum value.
  23120. </para>
  23121. </remarks>
  23122. </member>
  23123. <member name="P:log4net.Util.FormattingInfo.Max">
  23124. <summary>
  23125. Gets or sets the maximum value.
  23126. </summary>
  23127. <value>
  23128. The maximum value.
  23129. </value>
  23130. <remarks>
  23131. <para>
  23132. Gets or sets the maximum value.
  23133. </para>
  23134. </remarks>
  23135. </member>
  23136. <member name="P:log4net.Util.FormattingInfo.LeftAlign">
  23137. <summary>
  23138. Gets or sets a flag indicating whether left align is enabled
  23139. or not.
  23140. </summary>
  23141. <value>
  23142. A flag indicating whether left align is enabled or not.
  23143. </value>
  23144. <remarks>
  23145. <para>
  23146. Gets or sets a flag indicating whether left align is enabled or not.
  23147. </para>
  23148. </remarks>
  23149. </member>
  23150. <member name="T:log4net.Util.GlobalContextProperties">
  23151. <summary>
  23152. Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
  23153. </summary>
  23154. <remarks>
  23155. <para>
  23156. This class implements a properties collection that is thread safe and supports both
  23157. storing properties and capturing a read only copy of the current propertied.
  23158. </para>
  23159. <para>
  23160. This class is optimized to the scenario where the properties are read frequently
  23161. and are modified infrequently.
  23162. </para>
  23163. </remarks>
  23164. <author>Nicko Cadell</author>
  23165. </member>
  23166. <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
  23167. <summary>
  23168. The read only copy of the properties.
  23169. </summary>
  23170. <remarks>
  23171. <para>
  23172. This variable is declared <c>volatile</c> to prevent the compiler and JIT from
  23173. reordering reads and writes of this thread performed on different threads.
  23174. </para>
  23175. </remarks>
  23176. </member>
  23177. <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
  23178. <summary>
  23179. Lock object used to synchronize updates within this instance
  23180. </summary>
  23181. </member>
  23182. <member name="M:log4net.Util.GlobalContextProperties.#ctor">
  23183. <summary>
  23184. Constructor
  23185. </summary>
  23186. <remarks>
  23187. <para>
  23188. Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties" /> class.
  23189. </para>
  23190. </remarks>
  23191. </member>
  23192. <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
  23193. <summary>
  23194. Gets or sets the value of a property
  23195. </summary>
  23196. <value>
  23197. The value for the property with the specified key
  23198. </value>
  23199. <remarks>
  23200. <para>
  23201. Reading the value for a key is faster than setting the value.
  23202. When the value is written a new read only copy of
  23203. the properties is created.
  23204. </para>
  23205. </remarks>
  23206. </member>
  23207. <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
  23208. <summary>
  23209. Remove a property from the global context
  23210. </summary>
  23211. <param name="key">the key for the entry to remove</param>
  23212. <remarks>
  23213. <para>
  23214. Removing an entry from the global context properties is relatively expensive compared
  23215. with reading a value.
  23216. </para>
  23217. </remarks>
  23218. </member>
  23219. <member name="M:log4net.Util.GlobalContextProperties.Clear">
  23220. <summary>
  23221. Clear the global context properties
  23222. </summary>
  23223. </member>
  23224. <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
  23225. <summary>
  23226. Get a readonly immutable copy of the properties
  23227. </summary>
  23228. <returns>the current global context properties</returns>
  23229. <remarks>
  23230. <para>
  23231. This implementation is fast because the GlobalContextProperties class
  23232. stores a readonly copy of the properties.
  23233. </para>
  23234. </remarks>
  23235. </member>
  23236. <member name="T:log4net.Util.ILogExtensions">
  23237. <summary>
  23238. The static class ILogExtensions contains a set of widely used
  23239. methods that ease the interaction with the ILog interface implementations.
  23240. </summary>
  23241. <remarks>
  23242. <para>
  23243. This class contains methods for logging at different levels and checks the
  23244. properties for determining if those logging levels are enabled in the current
  23245. configuration.
  23246. </para>
  23247. </remarks>
  23248. <example>Simple example of logging messages
  23249. <code lang="C#">
  23250. using log4net.Util;
  23251. ILog log = LogManager.GetLogger("application-log");
  23252. log.InfoExt("Application Start");
  23253. log.DebugExt("This is a debug message");
  23254. </code>
  23255. </example>
  23256. </member>
  23257. <member name="F:log4net.Util.ILogExtensions.declaringType">
  23258. <summary>
  23259. The fully qualified type of the Logger class.
  23260. </summary>
  23261. </member>
  23262. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})">
  23263. <summary>
  23264. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23265. </summary>
  23266. <param name="logger">The logger on which the message is logged.</param>
  23267. <param name="callback">The lambda expression that gets the object to log.</param>
  23268. <remarks>
  23269. <para>
  23270. This method first checks if this logger is <c>INFO</c>
  23271. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  23272. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23273. implementation. If this logger is <c>INFO</c> enabled, then it converts
  23274. the message object (retrieved by invocation of the provided callback) to a
  23275. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  23276. It then proceeds to call all the registered appenders in this logger
  23277. and also higher in the hierarchy depending on the value of
  23278. the additivity flag.
  23279. </para>
  23280. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23281. to this method will print the name of the <see cref="T:System.Exception"/>
  23282. but no stack trace. To print a stack trace use the
  23283. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  23284. </para>
  23285. </remarks>
  23286. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23287. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23288. </member>
  23289. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  23290. <summary>
  23291. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  23292. the stack trace of the <see cref="T:System.Exception"/> passed
  23293. as a parameter.
  23294. </summary>
  23295. <param name="logger">The logger on which the message is logged.</param>
  23296. <param name="callback">The lambda expression that gets the object to log.</param>
  23297. <param name="exception">The exception to log, including its stack trace.</param>
  23298. <remarks>
  23299. <para>
  23300. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23301. </para>
  23302. </remarks>
  23303. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23304. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23305. </member>
  23306. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)">
  23307. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO
  23308. <summary>
  23309. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23310. </summary>
  23311. <param name="logger">The logger on which the message is logged.</param>
  23312. <param name="message">The message object to log.</param>
  23313. <remarks>
  23314. <para>
  23315. This method first checks if this logger is <c>INFO</c>
  23316. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  23317. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23318. implementation. If this logger is <c>INFO</c> enabled, then it converts
  23319. the message object (passed as parameter) to a string by invoking the appropriate
  23320. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  23321. proceeds to call all the registered appenders in this logger
  23322. and also higher in the hierarchy depending on the value of
  23323. the additivity flag.
  23324. </para>
  23325. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23326. to this method will print the name of the <see cref="T:System.Exception"/>
  23327. but no stack trace. To print a stack trace use the
  23328. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  23329. </para>
  23330. </remarks>
  23331. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23332. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23333. </member>
  23334. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)">
  23335. <summary>
  23336. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  23337. the stack trace of the <see cref="T:System.Exception"/> passed
  23338. as a parameter.
  23339. </summary>
  23340. <param name="logger">The logger on which the message is logged.</param>
  23341. <param name="message">The message object to log.</param>
  23342. <param name="exception">The exception to log, including its stack trace.</param>
  23343. <remarks>
  23344. <para>
  23345. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23346. </para>
  23347. </remarks>
  23348. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23349. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23350. </member>
  23351. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)">
  23352. <summary>
  23353. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23354. </summary>
  23355. <param name="logger">The logger on which the message is logged.</param>
  23356. <param name="format">A String containing zero or more format items</param>
  23357. <param name="arg0">An Object to format</param>
  23358. <remarks>
  23359. <para>
  23360. The message is formatted using the <c>String.Format</c> method. See
  23361. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23362. of the formatting.
  23363. </para>
  23364. <para>
  23365. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23366. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  23367. methods instead.
  23368. </para>
  23369. </remarks>
  23370. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23371. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23372. </member>
  23373. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])">
  23374. <summary>
  23375. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23376. </summary>
  23377. <param name="logger">The logger on which the message is logged.</param>
  23378. <param name="format">A String containing zero or more format items</param>
  23379. <param name="args">An Object array containing zero or more objects to format</param>
  23380. <remarks>
  23381. <para>
  23382. The message is formatted using the <c>String.Format</c> method. See
  23383. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23384. of the formatting.
  23385. </para>
  23386. <para>
  23387. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23388. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  23389. methods instead.
  23390. </para>
  23391. </remarks>
  23392. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23393. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23394. </member>
  23395. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  23396. <summary>
  23397. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23398. </summary>
  23399. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  23400. <param name="logger">The logger on which the message is logged.</param>
  23401. <param name="format">A String containing zero or more format items</param>
  23402. <param name="args">An Object array containing zero or more objects to format</param>
  23403. <remarks>
  23404. <para>
  23405. The message is formatted using the <c>String.Format</c> method. See
  23406. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23407. of the formatting.
  23408. </para>
  23409. <para>
  23410. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23411. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  23412. methods instead.
  23413. </para>
  23414. </remarks>
  23415. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23416. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23417. </member>
  23418. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  23419. <summary>
  23420. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23421. </summary>
  23422. <param name="logger">The logger on which the message is logged.</param>
  23423. <param name="format">A String containing zero or more format items</param>
  23424. <param name="arg0">An Object to format</param>
  23425. <param name="arg1">An Object to format</param>
  23426. <remarks>
  23427. <para>
  23428. The message is formatted using the <c>String.Format</c> method. See
  23429. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23430. of the formatting.
  23431. </para>
  23432. <para>
  23433. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23434. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  23435. methods instead.
  23436. </para>
  23437. </remarks>
  23438. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23439. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23440. </member>
  23441. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  23442. <summary>
  23443. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23444. </summary>
  23445. <param name="logger">The logger on which the message is logged.</param>
  23446. <param name="format">A String containing zero or more format items</param>
  23447. <param name="arg0">An Object to format</param>
  23448. <param name="arg1">An Object to format</param>
  23449. <param name="arg2">An Object to format</param>
  23450. <remarks>
  23451. <para>
  23452. The message is formatted using the <c>String.Format</c> method. See
  23453. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23454. of the formatting.
  23455. </para>
  23456. <para>
  23457. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23458. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/>
  23459. methods instead.
  23460. </para>
  23461. </remarks>
  23462. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23463. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23464. </member>
  23465. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})">
  23466. <summary>
  23467. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  23468. </summary>
  23469. <param name="logger">The logger on which the message is logged.</param>
  23470. <param name="callback">The lambda expression that gets the object to log.</param>
  23471. <remarks>
  23472. <para>
  23473. This method first checks if this logger is <c>INFO</c>
  23474. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  23475. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23476. implementation. If this logger is <c>INFO</c> enabled, then it converts
  23477. the message object (retrieved by invocation of the provided callback) to a
  23478. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  23479. It then proceeds to call all the registered appenders in this logger
  23480. and also higher in the hierarchy depending on the value of
  23481. the additivity flag.
  23482. </para>
  23483. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23484. to this method will print the name of the <see cref="T:System.Exception"/>
  23485. but no stack trace. To print a stack trace use the
  23486. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  23487. </para>
  23488. </remarks>
  23489. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23490. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23491. </member>
  23492. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  23493. <summary>
  23494. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  23495. the stack trace of the <see cref="T:System.Exception"/> passed
  23496. as a parameter.
  23497. </summary>
  23498. <param name="logger">The logger on which the message is logged.</param>
  23499. <param name="callback">The lambda expression that gets the object to log.</param>
  23500. <param name="exception">The exception to log, including its stack trace.</param>
  23501. <remarks>
  23502. <para>
  23503. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23504. </para>
  23505. </remarks>
  23506. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23507. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23508. </member>
  23509. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)">
  23510. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO
  23511. <summary>
  23512. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  23513. </summary>
  23514. <param name="logger">The logger on which the message is logged.</param>
  23515. <param name="message">The message object to log.</param>
  23516. <remarks>
  23517. <para>
  23518. This method first checks if this logger is <c>INFO</c>
  23519. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  23520. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23521. implementation. If this logger is <c>INFO</c> enabled, then it converts
  23522. the message object (passed as parameter) to a string by invoking the appropriate
  23523. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  23524. proceeds to call all the registered appenders in this logger
  23525. and also higher in the hierarchy depending on the value of
  23526. the additivity flag.
  23527. </para>
  23528. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23529. to this method will print the name of the <see cref="T:System.Exception"/>
  23530. but no stack trace. To print a stack trace use the
  23531. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  23532. </para>
  23533. </remarks>
  23534. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23535. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23536. </member>
  23537. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)">
  23538. <summary>
  23539. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  23540. the stack trace of the <see cref="T:System.Exception"/> passed
  23541. as a parameter.
  23542. </summary>
  23543. <param name="logger">The logger on which the message is logged.</param>
  23544. <param name="message">The message object to log.</param>
  23545. <param name="exception">The exception to log, including its stack trace.</param>
  23546. <remarks>
  23547. <para>
  23548. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23549. </para>
  23550. </remarks>
  23551. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23552. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23553. </member>
  23554. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)">
  23555. <summary>
  23556. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23557. </summary>
  23558. <param name="logger">The logger on which the message is logged.</param>
  23559. <param name="format">A String containing zero or more format items</param>
  23560. <param name="arg0">An Object to format</param>
  23561. <remarks>
  23562. <para>
  23563. The message is formatted using the <c>String.Format</c> method. See
  23564. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23565. of the formatting.
  23566. </para>
  23567. <para>
  23568. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23569. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  23570. methods instead.
  23571. </para>
  23572. </remarks>
  23573. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23574. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23575. </member>
  23576. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])">
  23577. <summary>
  23578. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23579. </summary>
  23580. <param name="logger">The logger on which the message is logged.</param>
  23581. <param name="format">A String containing zero or more format items</param>
  23582. <param name="args">An Object array containing zero or more objects to format</param>
  23583. <remarks>
  23584. <para>
  23585. The message is formatted using the <c>String.Format</c> method. See
  23586. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23587. of the formatting.
  23588. </para>
  23589. <para>
  23590. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23591. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  23592. methods instead.
  23593. </para>
  23594. </remarks>
  23595. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23596. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23597. </member>
  23598. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  23599. <summary>
  23600. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23601. </summary>
  23602. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  23603. <param name="logger">The logger on which the message is logged.</param>
  23604. <param name="format">A String containing zero or more format items</param>
  23605. <param name="args">An Object array containing zero or more objects to format</param>
  23606. <remarks>
  23607. <para>
  23608. The message is formatted using the <c>String.Format</c> method. See
  23609. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23610. of the formatting.
  23611. </para>
  23612. <para>
  23613. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23614. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  23615. methods instead.
  23616. </para>
  23617. </remarks>
  23618. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23619. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23620. </member>
  23621. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  23622. <summary>
  23623. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23624. </summary>
  23625. <param name="logger">The logger on which the message is logged.</param>
  23626. <param name="format">A String containing zero or more format items</param>
  23627. <param name="arg0">An Object to format</param>
  23628. <param name="arg1">An Object to format</param>
  23629. <remarks>
  23630. <para>
  23631. The message is formatted using the <c>String.Format</c> method. See
  23632. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23633. of the formatting.
  23634. </para>
  23635. <para>
  23636. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23637. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  23638. methods instead.
  23639. </para>
  23640. </remarks>
  23641. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23642. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23643. </member>
  23644. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  23645. <summary>
  23646. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23647. </summary>
  23648. <param name="logger">The logger on which the message is logged.</param>
  23649. <param name="format">A String containing zero or more format items</param>
  23650. <param name="arg0">An Object to format</param>
  23651. <param name="arg1">An Object to format</param>
  23652. <param name="arg2">An Object to format</param>
  23653. <remarks>
  23654. <para>
  23655. The message is formatted using the <c>String.Format</c> method. See
  23656. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23657. of the formatting.
  23658. </para>
  23659. <para>
  23660. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23661. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/>
  23662. methods instead.
  23663. </para>
  23664. </remarks>
  23665. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23666. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23667. </member>
  23668. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})">
  23669. <summary>
  23670. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23671. </summary>
  23672. <param name="logger">The logger on which the message is logged.</param>
  23673. <param name="callback">The lambda expression that gets the object to log.</param>
  23674. <remarks>
  23675. <para>
  23676. This method first checks if this logger is <c>WARN</c>
  23677. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  23678. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23679. implementation. If this logger is <c>WARN</c> enabled, then it converts
  23680. the message object (retrieved by invocation of the provided callback) to a
  23681. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  23682. It then proceeds to call all the registered appenders in this logger
  23683. and also higher in the hierarchy depending on the value of
  23684. the additivity flag.
  23685. </para>
  23686. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23687. to this method will print the name of the <see cref="T:System.Exception"/>
  23688. but no stack trace. To print a stack trace use the
  23689. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  23690. </para>
  23691. </remarks>
  23692. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23693. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23694. </member>
  23695. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  23696. <summary>
  23697. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  23698. the stack trace of the <see cref="T:System.Exception"/> passed
  23699. as a parameter.
  23700. </summary>
  23701. <param name="logger">The logger on which the message is logged.</param>
  23702. <param name="callback">The lambda expression that gets the object to log.</param>
  23703. <param name="exception">The exception to log, including its stack trace.</param>
  23704. <remarks>
  23705. <para>
  23706. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23707. </para>
  23708. </remarks>
  23709. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23710. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23711. </member>
  23712. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)">
  23713. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO
  23714. <summary>
  23715. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23716. </summary>
  23717. <param name="logger">The logger on which the message is logged.</param>
  23718. <param name="message">The message object to log.</param>
  23719. <remarks>
  23720. <para>
  23721. This method first checks if this logger is <c>WARN</c>
  23722. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  23723. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23724. implementation. If this logger is <c>WARN</c> enabled, then it converts
  23725. the message object (passed as parameter) to a string by invoking the appropriate
  23726. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  23727. proceeds to call all the registered appenders in this logger
  23728. and also higher in the hierarchy depending on the value of
  23729. the additivity flag.
  23730. </para>
  23731. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23732. to this method will print the name of the <see cref="T:System.Exception"/>
  23733. but no stack trace. To print a stack trace use the
  23734. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  23735. </para>
  23736. </remarks>
  23737. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23738. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23739. </member>
  23740. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)">
  23741. <summary>
  23742. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  23743. the stack trace of the <see cref="T:System.Exception"/> passed
  23744. as a parameter.
  23745. </summary>
  23746. <param name="logger">The logger on which the message is logged.</param>
  23747. <param name="message">The message object to log.</param>
  23748. <param name="exception">The exception to log, including its stack trace.</param>
  23749. <remarks>
  23750. <para>
  23751. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23752. </para>
  23753. </remarks>
  23754. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23755. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23756. </member>
  23757. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)">
  23758. <summary>
  23759. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23760. </summary>
  23761. <param name="logger">The logger on which the message is logged.</param>
  23762. <param name="format">A String containing zero or more format items</param>
  23763. <param name="arg0">An Object to format</param>
  23764. <remarks>
  23765. <para>
  23766. The message is formatted using the <c>String.Format</c> method. See
  23767. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23768. of the formatting.
  23769. </para>
  23770. <para>
  23771. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23772. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  23773. methods instead.
  23774. </para>
  23775. </remarks>
  23776. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23777. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23778. </member>
  23779. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])">
  23780. <summary>
  23781. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23782. </summary>
  23783. <param name="logger">The logger on which the message is logged.</param>
  23784. <param name="format">A String containing zero or more format items</param>
  23785. <param name="args">An Object array containing zero or more objects to format</param>
  23786. <remarks>
  23787. <para>
  23788. The message is formatted using the <c>String.Format</c> method. See
  23789. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23790. of the formatting.
  23791. </para>
  23792. <para>
  23793. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23794. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  23795. methods instead.
  23796. </para>
  23797. </remarks>
  23798. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23799. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23800. </member>
  23801. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  23802. <summary>
  23803. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23804. </summary>
  23805. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  23806. <param name="logger">The logger on which the message is logged.</param>
  23807. <param name="format">A String containing zero or more format items</param>
  23808. <param name="args">An Object array containing zero or more objects to format</param>
  23809. <remarks>
  23810. <para>
  23811. The message is formatted using the <c>String.Format</c> method. See
  23812. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23813. of the formatting.
  23814. </para>
  23815. <para>
  23816. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23817. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  23818. methods instead.
  23819. </para>
  23820. </remarks>
  23821. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23822. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23823. </member>
  23824. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  23825. <summary>
  23826. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23827. </summary>
  23828. <param name="logger">The logger on which the message is logged.</param>
  23829. <param name="format">A String containing zero or more format items</param>
  23830. <param name="arg0">An Object to format</param>
  23831. <param name="arg1">An Object to format</param>
  23832. <remarks>
  23833. <para>
  23834. The message is formatted using the <c>String.Format</c> method. See
  23835. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23836. of the formatting.
  23837. </para>
  23838. <para>
  23839. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23840. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  23841. methods instead.
  23842. </para>
  23843. </remarks>
  23844. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23845. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23846. </member>
  23847. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  23848. <summary>
  23849. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23850. </summary>
  23851. <param name="logger">The logger on which the message is logged.</param>
  23852. <param name="format">A String containing zero or more format items</param>
  23853. <param name="arg0">An Object to format</param>
  23854. <param name="arg1">An Object to format</param>
  23855. <param name="arg2">An Object to format</param>
  23856. <remarks>
  23857. <para>
  23858. The message is formatted using the <c>String.Format</c> method. See
  23859. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23860. of the formatting.
  23861. </para>
  23862. <para>
  23863. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23864. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/>
  23865. methods instead.
  23866. </para>
  23867. </remarks>
  23868. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23869. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23870. </member>
  23871. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})">
  23872. <summary>
  23873. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  23874. </summary>
  23875. <param name="logger">The logger on which the message is logged.</param>
  23876. <param name="callback">The lambda expression that gets the object to log.</param>
  23877. <remarks>
  23878. <para>
  23879. This method first checks if this logger is <c>ERROR</c>
  23880. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  23881. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23882. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  23883. the message object (retrieved by invocation of the provided callback) to a
  23884. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  23885. It then proceeds to call all the registered appenders in this logger
  23886. and also higher in the hierarchy depending on the value of
  23887. the additivity flag.
  23888. </para>
  23889. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23890. to this method will print the name of the <see cref="T:System.Exception"/>
  23891. but no stack trace. To print a stack trace use the
  23892. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  23893. </para>
  23894. </remarks>
  23895. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23896. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23897. </member>
  23898. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  23899. <summary>
  23900. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  23901. the stack trace of the <see cref="T:System.Exception"/> passed
  23902. as a parameter.
  23903. </summary>
  23904. <param name="logger">The logger on which the message is logged.</param>
  23905. <param name="callback">The lambda expression that gets the object to log.</param>
  23906. <param name="exception">The exception to log, including its stack trace.</param>
  23907. <remarks>
  23908. <para>
  23909. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23910. </para>
  23911. </remarks>
  23912. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23913. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23914. </member>
  23915. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)">
  23916. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO
  23917. <summary>
  23918. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  23919. </summary>
  23920. <param name="logger">The logger on which the message is logged.</param>
  23921. <param name="message">The message object to log.</param>
  23922. <remarks>
  23923. <para>
  23924. This method first checks if this logger is <c>ERROR</c>
  23925. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  23926. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23927. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  23928. the message object (passed as parameter) to a string by invoking the appropriate
  23929. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  23930. proceeds to call all the registered appenders in this logger
  23931. and also higher in the hierarchy depending on the value of
  23932. the additivity flag.
  23933. </para>
  23934. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23935. to this method will print the name of the <see cref="T:System.Exception"/>
  23936. but no stack trace. To print a stack trace use the
  23937. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  23938. </para>
  23939. </remarks>
  23940. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23941. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23942. </member>
  23943. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)">
  23944. <summary>
  23945. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  23946. the stack trace of the <see cref="T:System.Exception"/> passed
  23947. as a parameter.
  23948. </summary>
  23949. <param name="logger">The logger on which the message is logged.</param>
  23950. <param name="message">The message object to log.</param>
  23951. <param name="exception">The exception to log, including its stack trace.</param>
  23952. <remarks>
  23953. <para>
  23954. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23955. </para>
  23956. </remarks>
  23957. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23958. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23959. </member>
  23960. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)">
  23961. <summary>
  23962. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  23963. </summary>
  23964. <param name="logger">The logger on which the message is logged.</param>
  23965. <param name="format">A String containing zero or more format items</param>
  23966. <param name="arg0">An Object to format</param>
  23967. <remarks>
  23968. <para>
  23969. The message is formatted using the <c>String.Format</c> method. See
  23970. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23971. of the formatting.
  23972. </para>
  23973. <para>
  23974. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23975. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  23976. methods instead.
  23977. </para>
  23978. </remarks>
  23979. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23980. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23981. </member>
  23982. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])">
  23983. <summary>
  23984. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  23985. </summary>
  23986. <param name="logger">The logger on which the message is logged.</param>
  23987. <param name="format">A String containing zero or more format items</param>
  23988. <param name="args">An Object array containing zero or more objects to format</param>
  23989. <remarks>
  23990. <para>
  23991. The message is formatted using the <c>String.Format</c> method. See
  23992. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23993. of the formatting.
  23994. </para>
  23995. <para>
  23996. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23997. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  23998. methods instead.
  23999. </para>
  24000. </remarks>
  24001. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  24002. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  24003. </member>
  24004. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  24005. <summary>
  24006. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  24007. </summary>
  24008. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  24009. <param name="logger">The logger on which the message is logged.</param>
  24010. <param name="format">A String containing zero or more format items</param>
  24011. <param name="args">An Object array containing zero or more objects to format</param>
  24012. <remarks>
  24013. <para>
  24014. The message is formatted using the <c>String.Format</c> method. See
  24015. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24016. of the formatting.
  24017. </para>
  24018. <para>
  24019. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24020. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  24021. methods instead.
  24022. </para>
  24023. </remarks>
  24024. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  24025. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  24026. </member>
  24027. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  24028. <summary>
  24029. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  24030. </summary>
  24031. <param name="logger">The logger on which the message is logged.</param>
  24032. <param name="format">A String containing zero or more format items</param>
  24033. <param name="arg0">An Object to format</param>
  24034. <param name="arg1">An Object to format</param>
  24035. <remarks>
  24036. <para>
  24037. The message is formatted using the <c>String.Format</c> method. See
  24038. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24039. of the formatting.
  24040. </para>
  24041. <para>
  24042. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24043. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  24044. methods instead.
  24045. </para>
  24046. </remarks>
  24047. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  24048. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  24049. </member>
  24050. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  24051. <summary>
  24052. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  24053. </summary>
  24054. <param name="logger">The logger on which the message is logged.</param>
  24055. <param name="format">A String containing zero or more format items</param>
  24056. <param name="arg0">An Object to format</param>
  24057. <param name="arg1">An Object to format</param>
  24058. <param name="arg2">An Object to format</param>
  24059. <remarks>
  24060. <para>
  24061. The message is formatted using the <c>String.Format</c> method. See
  24062. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24063. of the formatting.
  24064. </para>
  24065. <para>
  24066. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24067. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/>
  24068. methods instead.
  24069. </para>
  24070. </remarks>
  24071. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  24072. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  24073. </member>
  24074. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})">
  24075. <summary>
  24076. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24077. </summary>
  24078. <param name="logger">The logger on which the message is logged.</param>
  24079. <param name="callback">The lambda expression that gets the object to log.</param>
  24080. <remarks>
  24081. <para>
  24082. This method first checks if this logger is <c>FATAL</c>
  24083. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  24084. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  24085. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  24086. the message object (retrieved by invocation of the provided callback) to a
  24087. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  24088. It then proceeds to call all the registered appenders in this logger
  24089. and also higher in the hierarchy depending on the value of
  24090. the additivity flag.
  24091. </para>
  24092. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  24093. to this method will print the name of the <see cref="T:System.Exception"/>
  24094. but no stack trace. To print a stack trace use the
  24095. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  24096. </para>
  24097. </remarks>
  24098. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24099. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24100. </member>
  24101. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  24102. <summary>
  24103. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  24104. the stack trace of the <see cref="T:System.Exception"/> passed
  24105. as a parameter.
  24106. </summary>
  24107. <param name="logger">The logger on which the message is logged.</param>
  24108. <param name="callback">The lambda expression that gets the object to log.</param>
  24109. <param name="exception">The exception to log, including its stack trace.</param>
  24110. <remarks>
  24111. <para>
  24112. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  24113. </para>
  24114. </remarks>
  24115. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24116. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24117. </member>
  24118. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)">
  24119. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO
  24120. <summary>
  24121. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24122. </summary>
  24123. <param name="logger">The logger on which the message is logged.</param>
  24124. <param name="message">The message object to log.</param>
  24125. <remarks>
  24126. <para>
  24127. This method first checks if this logger is <c>FATAL</c>
  24128. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  24129. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  24130. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  24131. the message object (passed as parameter) to a string by invoking the appropriate
  24132. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  24133. proceeds to call all the registered appenders in this logger
  24134. and also higher in the hierarchy depending on the value of
  24135. the additivity flag.
  24136. </para>
  24137. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  24138. to this method will print the name of the <see cref="T:System.Exception"/>
  24139. but no stack trace. To print a stack trace use the
  24140. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  24141. </para>
  24142. </remarks>
  24143. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24144. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24145. </member>
  24146. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)">
  24147. <summary>
  24148. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  24149. the stack trace of the <see cref="T:System.Exception"/> passed
  24150. as a parameter.
  24151. </summary>
  24152. <param name="logger">The logger on which the message is logged.</param>
  24153. <param name="message">The message object to log.</param>
  24154. <param name="exception">The exception to log, including its stack trace.</param>
  24155. <remarks>
  24156. <para>
  24157. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  24158. </para>
  24159. </remarks>
  24160. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24161. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24162. </member>
  24163. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)">
  24164. <summary>
  24165. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24166. </summary>
  24167. <param name="logger">The logger on which the message is logged.</param>
  24168. <param name="format">A String containing zero or more format items</param>
  24169. <param name="arg0">An Object to format</param>
  24170. <remarks>
  24171. <para>
  24172. The message is formatted using the <c>String.Format</c> method. See
  24173. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24174. of the formatting.
  24175. </para>
  24176. <para>
  24177. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24178. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  24179. methods instead.
  24180. </para>
  24181. </remarks>
  24182. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24183. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24184. </member>
  24185. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])">
  24186. <summary>
  24187. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24188. </summary>
  24189. <param name="logger">The logger on which the message is logged.</param>
  24190. <param name="format">A String containing zero or more format items</param>
  24191. <param name="args">An Object array containing zero or more objects to format</param>
  24192. <remarks>
  24193. <para>
  24194. The message is formatted using the <c>String.Format</c> method. See
  24195. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24196. of the formatting.
  24197. </para>
  24198. <para>
  24199. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24200. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  24201. methods instead.
  24202. </para>
  24203. </remarks>
  24204. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24205. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24206. </member>
  24207. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  24208. <summary>
  24209. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24210. </summary>
  24211. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  24212. <param name="logger">The logger on which the message is logged.</param>
  24213. <param name="format">A String containing zero or more format items</param>
  24214. <param name="args">An Object array containing zero or more objects to format</param>
  24215. <remarks>
  24216. <para>
  24217. The message is formatted using the <c>String.Format</c> method. See
  24218. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24219. of the formatting.
  24220. </para>
  24221. <para>
  24222. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24223. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  24224. methods instead.
  24225. </para>
  24226. </remarks>
  24227. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24228. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24229. </member>
  24230. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  24231. <summary>
  24232. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24233. </summary>
  24234. <param name="logger">The logger on which the message is logged.</param>
  24235. <param name="format">A String containing zero or more format items</param>
  24236. <param name="arg0">An Object to format</param>
  24237. <param name="arg1">An Object to format</param>
  24238. <remarks>
  24239. <para>
  24240. The message is formatted using the <c>String.Format</c> method. See
  24241. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24242. of the formatting.
  24243. </para>
  24244. <para>
  24245. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24246. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  24247. methods instead.
  24248. </para>
  24249. </remarks>
  24250. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24251. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24252. </member>
  24253. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  24254. <summary>
  24255. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24256. </summary>
  24257. <param name="logger">The logger on which the message is logged.</param>
  24258. <param name="format">A String containing zero or more format items</param>
  24259. <param name="arg0">An Object to format</param>
  24260. <param name="arg1">An Object to format</param>
  24261. <param name="arg2">An Object to format</param>
  24262. <remarks>
  24263. <para>
  24264. The message is formatted using the <c>String.Format</c> method. See
  24265. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24266. of the formatting.
  24267. </para>
  24268. <para>
  24269. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24270. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/>
  24271. methods instead.
  24272. </para>
  24273. </remarks>
  24274. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24275. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24276. </member>
  24277. <member name="T:log4net.Util.LevelMapping">
  24278. <summary>
  24279. Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
  24280. </summary>
  24281. <remarks>
  24282. <para>
  24283. Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
  24284. to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
  24285. </para>
  24286. </remarks>
  24287. <author>Nicko Cadell</author>
  24288. </member>
  24289. <member name="M:log4net.Util.LevelMapping.#ctor">
  24290. <summary>
  24291. Default constructor
  24292. </summary>
  24293. <remarks>
  24294. <para>
  24295. Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
  24296. </para>
  24297. </remarks>
  24298. </member>
  24299. <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
  24300. <summary>
  24301. Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
  24302. </summary>
  24303. <param name="entry">the entry to add</param>
  24304. <remarks>
  24305. <para>
  24306. If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
  24307. for the same <see cref="T:log4net.Core.Level"/> then that entry will be
  24308. overwritten.
  24309. </para>
  24310. </remarks>
  24311. </member>
  24312. <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
  24313. <summary>
  24314. Lookup the mapping for the specified level
  24315. </summary>
  24316. <param name="level">the level to lookup</param>
  24317. <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
  24318. <remarks>
  24319. <para>
  24320. Lookup the value for the specified level. Finds the nearest
  24321. mapping value for the level that is equal to or less than the
  24322. <paramref name="level"/> specified.
  24323. </para>
  24324. <para>
  24325. If no mapping could be found then <c>null</c> is returned.
  24326. </para>
  24327. </remarks>
  24328. </member>
  24329. <member name="M:log4net.Util.LevelMapping.ActivateOptions">
  24330. <summary>
  24331. Initialize options
  24332. </summary>
  24333. <remarks>
  24334. <para>
  24335. Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
  24336. </para>
  24337. </remarks>
  24338. </member>
  24339. <member name="T:log4net.Util.LevelMappingEntry">
  24340. <summary>
  24341. An entry in the <see cref="T:log4net.Util.LevelMapping"/>
  24342. </summary>
  24343. <remarks>
  24344. <para>
  24345. This is an abstract base class for types that are stored in the
  24346. <see cref="T:log4net.Util.LevelMapping"/> object.
  24347. </para>
  24348. </remarks>
  24349. <author>Nicko Cadell</author>
  24350. </member>
  24351. <member name="M:log4net.Util.LevelMappingEntry.#ctor">
  24352. <summary>
  24353. Default protected constructor
  24354. </summary>
  24355. <remarks>
  24356. <para>
  24357. Default protected constructor
  24358. </para>
  24359. </remarks>
  24360. </member>
  24361. <member name="P:log4net.Util.LevelMappingEntry.Level">
  24362. <summary>
  24363. The level that is the key for this mapping
  24364. </summary>
  24365. <value>
  24366. The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
  24367. </value>
  24368. <remarks>
  24369. <para>
  24370. Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
  24371. mapping subclass.
  24372. </para>
  24373. </remarks>
  24374. </member>
  24375. <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
  24376. <summary>
  24377. Initialize any options defined on this entry
  24378. </summary>
  24379. <remarks>
  24380. <para>
  24381. Should be overridden by any classes that need to initialise based on their options
  24382. </para>
  24383. </remarks>
  24384. </member>
  24385. <member name="T:log4net.Util.LogicalThreadContextProperties">
  24386. <summary>
  24387. Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
  24388. </summary>
  24389. <remarks>
  24390. <para>
  24391. Class implements a collection of properties that is specific to each thread.
  24392. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  24393. </para>
  24394. <para>
  24395. This class stores its properties in a slot on the <see cref="!:CallContext"/> named
  24396. <c>log4net.Util.LogicalThreadContextProperties</c>.
  24397. </para>
  24398. <para>
  24399. For .NET Standard 1.3 this class uses
  24400. System.Threading.AsyncLocal rather than <see
  24401. cref="!:System.Runtime.Remoting.Messaging.CallContext"/>.
  24402. </para>
  24403. <para>
  24404. The <see cref="!:CallContext"/> requires a link time
  24405. <see cref="!:System.Security.Permissions.SecurityPermission"/> for the
  24406. <see cref="!:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  24407. If the calling code does not have this permission then this context will be disabled.
  24408. It will not store any property values set on it.
  24409. </para>
  24410. </remarks>
  24411. <author>Nicko Cadell</author>
  24412. </member>
  24413. <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
  24414. <summary>
  24415. Flag used to disable this context if we don't have permission to access the CallContext.
  24416. </summary>
  24417. </member>
  24418. <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
  24419. <summary>
  24420. Constructor
  24421. </summary>
  24422. <remarks>
  24423. <para>
  24424. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties" /> class.
  24425. </para>
  24426. </remarks>
  24427. </member>
  24428. <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
  24429. <summary>
  24430. Gets or sets the value of a property
  24431. </summary>
  24432. <value>
  24433. The value for the property with the specified key
  24434. </value>
  24435. <remarks>
  24436. <para>
  24437. Get or set the property value for the <paramref name="key"/> specified.
  24438. </para>
  24439. </remarks>
  24440. </member>
  24441. <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
  24442. <summary>
  24443. Remove a property
  24444. </summary>
  24445. <param name="key">the key for the entry to remove</param>
  24446. <remarks>
  24447. <para>
  24448. Remove the value for the specified <paramref name="key"/> from the context.
  24449. </para>
  24450. </remarks>
  24451. </member>
  24452. <member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
  24453. <summary>
  24454. Clear all the context properties
  24455. </summary>
  24456. <remarks>
  24457. <para>
  24458. Clear all the context properties
  24459. </para>
  24460. </remarks>
  24461. </member>
  24462. <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
  24463. <summary>
  24464. Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
  24465. </summary>
  24466. <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
  24467. <returns>the properties for this thread</returns>
  24468. <remarks>
  24469. <para>
  24470. The collection returned is only to be used on the calling thread. If the
  24471. caller needs to share the collection between different threads then the
  24472. caller must clone the collection before doings so.
  24473. </para>
  24474. </remarks>
  24475. </member>
  24476. <member name="M:log4net.Util.LogicalThreadContextProperties.GetLogicalProperties">
  24477. <summary>
  24478. Gets the call context get data.
  24479. </summary>
  24480. <returns>The peroperties dictionary stored in the call context</returns>
  24481. <remarks>
  24482. The <see cref="!:CallContext"/> method <see cref="!:CallContext.GetData"/> has a
  24483. security link demand, therfore we must put the method call in a seperate method
  24484. that we can wrap in an exception handler.
  24485. </remarks>
  24486. </member>
  24487. <member name="M:log4net.Util.LogicalThreadContextProperties.SetLogicalProperties(log4net.Util.PropertiesDictionary)">
  24488. <summary>
  24489. Sets the call context data.
  24490. </summary>
  24491. <param name="properties">The properties.</param>
  24492. <remarks>
  24493. The <see cref="!:CallContext"/> method <see cref="!:CallContext.SetData"/> has a
  24494. security link demand, therfore we must put the method call in a seperate method
  24495. that we can wrap in an exception handler.
  24496. </remarks>
  24497. </member>
  24498. <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
  24499. <summary>
  24500. The fully qualified type of the LogicalThreadContextProperties class.
  24501. </summary>
  24502. <remarks>
  24503. Used by the internal logger to record the Type of the
  24504. log message.
  24505. </remarks>
  24506. </member>
  24507. <member name="T:log4net.Util.TwoArgAction`2">
  24508. <summary>
  24509. Delegate type used for LogicalThreadContextStack's callbacks.
  24510. </summary>
  24511. </member>
  24512. <member name="T:log4net.Util.LogicalThreadContextStack">
  24513. <summary>
  24514. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  24515. </summary>
  24516. <remarks>
  24517. <para>
  24518. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  24519. </para>
  24520. </remarks>
  24521. <author>Nicko Cadell</author>
  24522. </member>
  24523. <member name="F:log4net.Util.LogicalThreadContextStack.m_stack">
  24524. <summary>
  24525. The stack store.
  24526. </summary>
  24527. </member>
  24528. <member name="F:log4net.Util.LogicalThreadContextStack.m_propertyKey">
  24529. <summary>
  24530. The name of this <see cref="T:log4net.Util.LogicalThreadContextStack"/> within the
  24531. <see cref="T:log4net.Util.LogicalThreadContextProperties"/>.
  24532. </summary>
  24533. </member>
  24534. <member name="F:log4net.Util.LogicalThreadContextStack.m_registerNew">
  24535. <summary>
  24536. The callback used to let the <see cref="T:log4net.Util.LogicalThreadContextStacks"/> register a
  24537. new instance of a <see cref="T:log4net.Util.LogicalThreadContextStack"/>.
  24538. </summary>
  24539. </member>
  24540. <member name="M:log4net.Util.LogicalThreadContextStack.#ctor(System.String,log4net.Util.TwoArgAction{System.String,log4net.Util.LogicalThreadContextStack})">
  24541. <summary>
  24542. Internal constructor
  24543. </summary>
  24544. <remarks>
  24545. <para>
  24546. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack" /> class.
  24547. </para>
  24548. </remarks>
  24549. </member>
  24550. <member name="P:log4net.Util.LogicalThreadContextStack.Count">
  24551. <summary>
  24552. The number of messages in the stack
  24553. </summary>
  24554. <value>
  24555. The current number of messages in the stack
  24556. </value>
  24557. <remarks>
  24558. <para>
  24559. The current number of messages in the stack. That is
  24560. the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> has been called
  24561. minus the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Pop"/> has been called.
  24562. </para>
  24563. </remarks>
  24564. </member>
  24565. <member name="M:log4net.Util.LogicalThreadContextStack.Clear">
  24566. <summary>
  24567. Clears all the contextual information held in this stack.
  24568. </summary>
  24569. <remarks>
  24570. <para>
  24571. Clears all the contextual information held in this stack.
  24572. Only call this if you think that this thread is being reused after
  24573. a previous call execution which may not have completed correctly.
  24574. You do not need to use this method if you always guarantee to call
  24575. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  24576. returned from <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  24577. for example by using the <c>using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  24578. syntax.
  24579. </para>
  24580. </remarks>
  24581. </member>
  24582. <member name="M:log4net.Util.LogicalThreadContextStack.Pop">
  24583. <summary>
  24584. Removes the top context from this stack.
  24585. </summary>
  24586. <returns>The message in the context that was removed from the top of this stack.</returns>
  24587. <remarks>
  24588. <para>
  24589. Remove the top context from this stack, and return
  24590. it to the caller. If this stack is empty then an
  24591. empty string (not <see langword="null"/>) is returned.
  24592. </para>
  24593. </remarks>
  24594. </member>
  24595. <member name="M:log4net.Util.LogicalThreadContextStack.Push(System.String)">
  24596. <summary>
  24597. Pushes a new context message into this stack.
  24598. </summary>
  24599. <param name="message">The new context message.</param>
  24600. <returns>
  24601. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  24602. </returns>
  24603. <remarks>
  24604. <para>
  24605. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  24606. is returned that can be used to clean up this stack. This
  24607. can be easily combined with the <c>using</c> keyword to scope the
  24608. context.
  24609. </para>
  24610. </remarks>
  24611. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  24612. <code lang="C#">
  24613. using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
  24614. {
  24615. log.Warn("This should have an ThreadContext Stack message");
  24616. }
  24617. </code>
  24618. </example>
  24619. </member>
  24620. <member name="M:log4net.Util.LogicalThreadContextStack.GetFullMessage">
  24621. <summary>
  24622. Gets the current context information for this stack.
  24623. </summary>
  24624. <returns>The current context information.</returns>
  24625. </member>
  24626. <member name="P:log4net.Util.LogicalThreadContextStack.InternalStack">
  24627. <summary>
  24628. Gets and sets the internal stack used by this <see cref="T:log4net.Util.LogicalThreadContextStack"/>
  24629. </summary>
  24630. <value>The internal storage stack</value>
  24631. <remarks>
  24632. <para>
  24633. This property is provided only to support backward compatability
  24634. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  24635. be modified.
  24636. </para>
  24637. </remarks>
  24638. </member>
  24639. <member name="M:log4net.Util.LogicalThreadContextStack.ToString">
  24640. <summary>
  24641. Gets the current context information for this stack.
  24642. </summary>
  24643. <returns>Gets the current context information</returns>
  24644. <remarks>
  24645. <para>
  24646. Gets the current context information for this stack.
  24647. </para>
  24648. </remarks>
  24649. </member>
  24650. <member name="M:log4net.Util.LogicalThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  24651. <summary>
  24652. Get a portable version of this object
  24653. </summary>
  24654. <returns>the portable instance of this object</returns>
  24655. <remarks>
  24656. <para>
  24657. Get a cross thread portable version of this object
  24658. </para>
  24659. </remarks>
  24660. </member>
  24661. <member name="T:log4net.Util.LogicalThreadContextStack.StackFrame">
  24662. <summary>
  24663. Inner class used to represent a single context frame in the stack.
  24664. </summary>
  24665. <remarks>
  24666. <para>
  24667. Inner class used to represent a single context frame in the stack.
  24668. </para>
  24669. </remarks>
  24670. </member>
  24671. <member name="M:log4net.Util.LogicalThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.LogicalThreadContextStack.StackFrame)">
  24672. <summary>
  24673. Constructor
  24674. </summary>
  24675. <param name="message">The message for this context.</param>
  24676. <param name="parent">The parent context in the chain.</param>
  24677. <remarks>
  24678. <para>
  24679. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.StackFrame" /> class
  24680. with the specified message and parent context.
  24681. </para>
  24682. </remarks>
  24683. </member>
  24684. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.Message">
  24685. <summary>
  24686. Get the message.
  24687. </summary>
  24688. <value>The message.</value>
  24689. <remarks>
  24690. <para>
  24691. Get the message.
  24692. </para>
  24693. </remarks>
  24694. </member>
  24695. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.FullMessage">
  24696. <summary>
  24697. Gets the full text of the context down to the root level.
  24698. </summary>
  24699. <value>
  24700. The full text of the context down to the root level.
  24701. </value>
  24702. <remarks>
  24703. <para>
  24704. Gets the full text of the context down to the root level.
  24705. </para>
  24706. </remarks>
  24707. </member>
  24708. <member name="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame">
  24709. <summary>
  24710. Struct returned from the <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> method.
  24711. </summary>
  24712. <remarks>
  24713. <para>
  24714. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  24715. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  24716. </para>
  24717. </remarks>
  24718. </member>
  24719. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_frameDepth">
  24720. <summary>
  24721. The depth to trim the stack to when this instance is disposed
  24722. </summary>
  24723. </member>
  24724. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_logicalThreadContextStack">
  24725. <summary>
  24726. The outer LogicalThreadContextStack.
  24727. </summary>
  24728. </member>
  24729. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.#ctor(log4net.Util.LogicalThreadContextStack,System.Int32)">
  24730. <summary>
  24731. Constructor
  24732. </summary>
  24733. <param name="logicalThreadContextStack">The internal stack used by the ThreadContextStack.</param>
  24734. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  24735. <remarks>
  24736. <para>
  24737. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame" /> class with
  24738. the specified stack and return depth.
  24739. </para>
  24740. </remarks>
  24741. </member>
  24742. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.Dispose">
  24743. <summary>
  24744. Returns the stack to the correct depth.
  24745. </summary>
  24746. <remarks>
  24747. <para>
  24748. Returns the stack to the correct depth.
  24749. </para>
  24750. </remarks>
  24751. </member>
  24752. <member name="T:log4net.Util.LogicalThreadContextStacks">
  24753. <summary>
  24754. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  24755. </summary>
  24756. <remarks>
  24757. <para>
  24758. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  24759. </para>
  24760. </remarks>
  24761. <author>Nicko Cadell</author>
  24762. </member>
  24763. <member name="M:log4net.Util.LogicalThreadContextStacks.#ctor(log4net.Util.LogicalThreadContextProperties)">
  24764. <summary>
  24765. Internal constructor
  24766. </summary>
  24767. <remarks>
  24768. <para>
  24769. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks" /> class.
  24770. </para>
  24771. </remarks>
  24772. </member>
  24773. <member name="P:log4net.Util.LogicalThreadContextStacks.Item(System.String)">
  24774. <summary>
  24775. Gets the named thread context stack
  24776. </summary>
  24777. <value>
  24778. The named stack
  24779. </value>
  24780. <remarks>
  24781. <para>
  24782. Gets the named thread context stack
  24783. </para>
  24784. </remarks>
  24785. </member>
  24786. <member name="F:log4net.Util.LogicalThreadContextStacks.declaringType">
  24787. <summary>
  24788. The fully qualified type of the ThreadContextStacks class.
  24789. </summary>
  24790. <remarks>
  24791. Used by the internal logger to record the Type of the
  24792. log message.
  24793. </remarks>
  24794. </member>
  24795. <member name="T:log4net.Util.LogReceivedEventHandler">
  24796. <summary>
  24797. </summary>
  24798. <param name="source"></param>
  24799. <param name="e"></param>
  24800. </member>
  24801. <member name="T:log4net.Util.LogLog">
  24802. <summary>
  24803. Outputs log statements from within the log4net assembly.
  24804. </summary>
  24805. <remarks>
  24806. <para>
  24807. Log4net components cannot make log4net logging calls. However, it is
  24808. sometimes useful for the user to learn about what log4net is
  24809. doing.
  24810. </para>
  24811. <para>
  24812. All log4net internal debug calls go to the standard output stream
  24813. whereas internal error messages are sent to the standard error output
  24814. stream.
  24815. </para>
  24816. </remarks>
  24817. <author>Nicko Cadell</author>
  24818. <author>Gert Driesen</author>
  24819. </member>
  24820. <member name="E:log4net.Util.LogLog.LogReceived">
  24821. <summary>
  24822. The event raised when an internal message has been received.
  24823. </summary>
  24824. </member>
  24825. <member name="P:log4net.Util.LogLog.Source">
  24826. <summary>
  24827. The Type that generated the internal message.
  24828. </summary>
  24829. </member>
  24830. <member name="P:log4net.Util.LogLog.TimeStamp">
  24831. <summary>
  24832. The DateTime stamp of when the internal message was received.
  24833. </summary>
  24834. </member>
  24835. <member name="P:log4net.Util.LogLog.TimeStampUtc">
  24836. <summary>
  24837. The UTC DateTime stamp of when the internal message was received.
  24838. </summary>
  24839. </member>
  24840. <member name="P:log4net.Util.LogLog.Prefix">
  24841. <summary>
  24842. A string indicating the severity of the internal message.
  24843. </summary>
  24844. <remarks>
  24845. "log4net: ",
  24846. "log4net:ERROR ",
  24847. "log4net:WARN "
  24848. </remarks>
  24849. </member>
  24850. <member name="P:log4net.Util.LogLog.Message">
  24851. <summary>
  24852. The internal log message.
  24853. </summary>
  24854. </member>
  24855. <member name="P:log4net.Util.LogLog.Exception">
  24856. <summary>
  24857. The Exception related to the message.
  24858. </summary>
  24859. <remarks>
  24860. Optional. Will be null if no Exception was passed.
  24861. </remarks>
  24862. </member>
  24863. <member name="M:log4net.Util.LogLog.ToString">
  24864. <summary>
  24865. Formats Prefix, Source, and Message in the same format as the value
  24866. sent to Console.Out and Trace.Write.
  24867. </summary>
  24868. <returns></returns>
  24869. </member>
  24870. <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
  24871. <summary>
  24872. Initializes a new instance of the <see cref="T:log4net.Util.LogLog" /> class.
  24873. </summary>
  24874. <param name="source"></param>
  24875. <param name="prefix"></param>
  24876. <param name="message"></param>
  24877. <param name="exception"></param>
  24878. </member>
  24879. <member name="M:log4net.Util.LogLog.#cctor">
  24880. <summary>
  24881. Static constructor that initializes logging by reading
  24882. settings from the application configuration file.
  24883. </summary>
  24884. <remarks>
  24885. <para>
  24886. The <c>log4net.Internal.Debug</c> application setting
  24887. controls internal debugging. This setting should be set
  24888. to <c>true</c> to enable debugging.
  24889. </para>
  24890. <para>
  24891. The <c>log4net.Internal.Quiet</c> application setting
  24892. suppresses all internal logging including error messages.
  24893. This setting should be set to <c>true</c> to enable message
  24894. suppression.
  24895. </para>
  24896. </remarks>
  24897. </member>
  24898. <member name="P:log4net.Util.LogLog.InternalDebugging">
  24899. <summary>
  24900. Gets or sets a value indicating whether log4net internal logging
  24901. is enabled or disabled.
  24902. </summary>
  24903. <value>
  24904. <c>true</c> if log4net internal logging is enabled, otherwise
  24905. <c>false</c>.
  24906. </value>
  24907. <remarks>
  24908. <para>
  24909. When set to <c>true</c>, internal debug level logging will be
  24910. displayed.
  24911. </para>
  24912. <para>
  24913. This value can be set by setting the application setting
  24914. <c>log4net.Internal.Debug</c> in the application configuration
  24915. file.
  24916. </para>
  24917. <para>
  24918. The default value is <c>false</c>, i.e. debugging is
  24919. disabled.
  24920. </para>
  24921. </remarks>
  24922. <example>
  24923. <para>
  24924. The following example enables internal debugging using the
  24925. application configuration file :
  24926. </para>
  24927. <code lang="XML" escaped="true">
  24928. <configuration>
  24929. <appSettings>
  24930. <add key="log4net.Internal.Debug" value="true" />
  24931. </appSettings>
  24932. </configuration>
  24933. </code>
  24934. </example>
  24935. </member>
  24936. <member name="P:log4net.Util.LogLog.QuietMode">
  24937. <summary>
  24938. Gets or sets a value indicating whether log4net should generate no output
  24939. from internal logging, not even for errors.
  24940. </summary>
  24941. <value>
  24942. <c>true</c> if log4net should generate no output at all from internal
  24943. logging, otherwise <c>false</c>.
  24944. </value>
  24945. <remarks>
  24946. <para>
  24947. When set to <c>true</c> will cause internal logging at all levels to be
  24948. suppressed. This means that no warning or error reports will be logged.
  24949. This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
  24950. disables all debug also.
  24951. </para>
  24952. <para>This value can be set by setting the application setting
  24953. <c>log4net.Internal.Quiet</c> in the application configuration file.
  24954. </para>
  24955. <para>
  24956. The default value is <c>false</c>, i.e. internal logging is not
  24957. disabled.
  24958. </para>
  24959. </remarks>
  24960. <example>
  24961. The following example disables internal logging using the
  24962. application configuration file :
  24963. <code lang="XML" escaped="true">
  24964. <configuration>
  24965. <appSettings>
  24966. <add key="log4net.Internal.Quiet" value="true" />
  24967. </appSettings>
  24968. </configuration>
  24969. </code>
  24970. </example>
  24971. </member>
  24972. <member name="P:log4net.Util.LogLog.EmitInternalMessages">
  24973. <summary>
  24974. </summary>
  24975. </member>
  24976. <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
  24977. <summary>
  24978. Raises the LogReceived event when an internal messages is received.
  24979. </summary>
  24980. <param name="source"></param>
  24981. <param name="prefix"></param>
  24982. <param name="message"></param>
  24983. <param name="exception"></param>
  24984. </member>
  24985. <member name="P:log4net.Util.LogLog.IsDebugEnabled">
  24986. <summary>
  24987. Test if LogLog.Debug is enabled for output.
  24988. </summary>
  24989. <value>
  24990. <c>true</c> if Debug is enabled
  24991. </value>
  24992. <remarks>
  24993. <para>
  24994. Test if LogLog.Debug is enabled for output.
  24995. </para>
  24996. </remarks>
  24997. </member>
  24998. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
  24999. <summary>
  25000. Writes log4net internal debug messages to the
  25001. standard output stream.
  25002. </summary>
  25003. <param name="source"></param>
  25004. <param name="message">The message to log.</param>
  25005. <remarks>
  25006. <para>
  25007. All internal debug messages are prepended with
  25008. the string "log4net: ".
  25009. </para>
  25010. </remarks>
  25011. </member>
  25012. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
  25013. <summary>
  25014. Writes log4net internal debug messages to the
  25015. standard output stream.
  25016. </summary>
  25017. <param name="source">The Type that generated this message.</param>
  25018. <param name="message">The message to log.</param>
  25019. <param name="exception">An exception to log.</param>
  25020. <remarks>
  25021. <para>
  25022. All internal debug messages are prepended with
  25023. the string "log4net: ".
  25024. </para>
  25025. </remarks>
  25026. </member>
  25027. <member name="P:log4net.Util.LogLog.IsWarnEnabled">
  25028. <summary>
  25029. Test if LogLog.Warn is enabled for output.
  25030. </summary>
  25031. <value>
  25032. <c>true</c> if Warn is enabled
  25033. </value>
  25034. <remarks>
  25035. <para>
  25036. Test if LogLog.Warn is enabled for output.
  25037. </para>
  25038. </remarks>
  25039. </member>
  25040. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
  25041. <summary>
  25042. Writes log4net internal warning messages to the
  25043. standard error stream.
  25044. </summary>
  25045. <param name="source">The Type that generated this message.</param>
  25046. <param name="message">The message to log.</param>
  25047. <remarks>
  25048. <para>
  25049. All internal warning messages are prepended with
  25050. the string "log4net:WARN ".
  25051. </para>
  25052. </remarks>
  25053. </member>
  25054. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
  25055. <summary>
  25056. Writes log4net internal warning messages to the
  25057. standard error stream.
  25058. </summary>
  25059. <param name="source">The Type that generated this message.</param>
  25060. <param name="message">The message to log.</param>
  25061. <param name="exception">An exception to log.</param>
  25062. <remarks>
  25063. <para>
  25064. All internal warning messages are prepended with
  25065. the string "log4net:WARN ".
  25066. </para>
  25067. </remarks>
  25068. </member>
  25069. <member name="P:log4net.Util.LogLog.IsErrorEnabled">
  25070. <summary>
  25071. Test if LogLog.Error is enabled for output.
  25072. </summary>
  25073. <value>
  25074. <c>true</c> if Error is enabled
  25075. </value>
  25076. <remarks>
  25077. <para>
  25078. Test if LogLog.Error is enabled for output.
  25079. </para>
  25080. </remarks>
  25081. </member>
  25082. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
  25083. <summary>
  25084. Writes log4net internal error messages to the
  25085. standard error stream.
  25086. </summary>
  25087. <param name="source">The Type that generated this message.</param>
  25088. <param name="message">The message to log.</param>
  25089. <remarks>
  25090. <para>
  25091. All internal error messages are prepended with
  25092. the string "log4net:ERROR ".
  25093. </para>
  25094. </remarks>
  25095. </member>
  25096. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
  25097. <summary>
  25098. Writes log4net internal error messages to the
  25099. standard error stream.
  25100. </summary>
  25101. <param name="source">The Type that generated this message.</param>
  25102. <param name="message">The message to log.</param>
  25103. <param name="exception">An exception to log.</param>
  25104. <remarks>
  25105. <para>
  25106. All internal debug messages are prepended with
  25107. the string "log4net:ERROR ".
  25108. </para>
  25109. </remarks>
  25110. </member>
  25111. <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
  25112. <summary>
  25113. Writes output to the standard output stream.
  25114. </summary>
  25115. <param name="message">The message to log.</param>
  25116. <remarks>
  25117. <para>
  25118. Writes to both Console.Out and System.Diagnostics.Trace.
  25119. Note that the System.Diagnostics.Trace is not supported
  25120. on the Compact Framework.
  25121. </para>
  25122. <para>
  25123. If the AppDomain is not configured with a config file then
  25124. the call to System.Diagnostics.Trace may fail. This is only
  25125. an issue if you are programmatically creating your own AppDomains.
  25126. </para>
  25127. </remarks>
  25128. </member>
  25129. <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
  25130. <summary>
  25131. Writes output to the standard error stream.
  25132. </summary>
  25133. <param name="message">The message to log.</param>
  25134. <remarks>
  25135. <para>
  25136. Writes to both Console.Error and System.Diagnostics.Trace.
  25137. Note that the System.Diagnostics.Trace is not supported
  25138. on the Compact Framework.
  25139. </para>
  25140. <para>
  25141. If the AppDomain is not configured with a config file then
  25142. the call to System.Diagnostics.Trace may fail. This is only
  25143. an issue if you are programmatically creating your own AppDomains.
  25144. </para>
  25145. </remarks>
  25146. </member>
  25147. <member name="F:log4net.Util.LogLog.s_debugEnabled">
  25148. <summary>
  25149. Default debug level
  25150. </summary>
  25151. </member>
  25152. <member name="F:log4net.Util.LogLog.s_quietMode">
  25153. <summary>
  25154. In quietMode not even errors generate any output.
  25155. </summary>
  25156. </member>
  25157. <member name="T:log4net.Util.LogLog.LogReceivedAdapter">
  25158. <summary>
  25159. Subscribes to the LogLog.LogReceived event and stores messages
  25160. to the supplied IList instance.
  25161. </summary>
  25162. </member>
  25163. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
  25164. <summary>
  25165. </summary>
  25166. <param name="items"></param>
  25167. </member>
  25168. <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
  25169. <summary>
  25170. </summary>
  25171. </member>
  25172. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
  25173. <summary>
  25174. </summary>
  25175. </member>
  25176. <member name="T:log4net.Util.LogReceivedEventArgs">
  25177. <summary>
  25178. </summary>
  25179. </member>
  25180. <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
  25181. <summary>
  25182. </summary>
  25183. <param name="loglog"></param>
  25184. </member>
  25185. <member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
  25186. <summary>
  25187. </summary>
  25188. </member>
  25189. <member name="T:log4net.Util.NativeError">
  25190. <summary>
  25191. Represents a native error code and message.
  25192. </summary>
  25193. <remarks>
  25194. <para>
  25195. Represents a Win32 platform native error.
  25196. </para>
  25197. </remarks>
  25198. <author>Nicko Cadell</author>
  25199. <author>Gert Driesen</author>
  25200. </member>
  25201. <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
  25202. <summary>
  25203. Create an instance of the <see cref="T:log4net.Util.NativeError" /> class with the specified
  25204. error number and message.
  25205. </summary>
  25206. <param name="number">The number of the native error.</param>
  25207. <param name="message">The message of the native error.</param>
  25208. <remarks>
  25209. <para>
  25210. Create an instance of the <see cref="T:log4net.Util.NativeError" /> class with the specified
  25211. error number and message.
  25212. </para>
  25213. </remarks>
  25214. </member>
  25215. <member name="P:log4net.Util.NativeError.Number">
  25216. <summary>
  25217. Gets the number of the native error.
  25218. </summary>
  25219. <value>
  25220. The number of the native error.
  25221. </value>
  25222. <remarks>
  25223. <para>
  25224. Gets the number of the native error.
  25225. </para>
  25226. </remarks>
  25227. </member>
  25228. <member name="P:log4net.Util.NativeError.Message">
  25229. <summary>
  25230. Gets the message of the native error.
  25231. </summary>
  25232. <value>
  25233. The message of the native error.
  25234. </value>
  25235. <remarks>
  25236. <para>
  25237. </para>
  25238. Gets the message of the native error.
  25239. </remarks>
  25240. </member>
  25241. <member name="M:log4net.Util.NativeError.GetLastError">
  25242. <summary>
  25243. Create a new instance of the <see cref="T:log4net.Util.NativeError" /> class for the last Windows error.
  25244. </summary>
  25245. <returns>
  25246. An instance of the <see cref="T:log4net.Util.NativeError" /> class for the last windows error.
  25247. </returns>
  25248. <remarks>
  25249. <para>
  25250. The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
  25251. native Win32 <c>FormatMessage</c> function.
  25252. </para>
  25253. </remarks>
  25254. </member>
  25255. <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
  25256. <summary>
  25257. Create a new instance of the <see cref="T:log4net.Util.NativeError" /> class.
  25258. </summary>
  25259. <param name="number">the error number for the native error</param>
  25260. <returns>
  25261. An instance of the <see cref="T:log4net.Util.NativeError" /> class for the specified
  25262. error number.
  25263. </returns>
  25264. <remarks>
  25265. <para>
  25266. The message for the specified error number is lookup up using the
  25267. native Win32 <c>FormatMessage</c> function.
  25268. </para>
  25269. </remarks>
  25270. </member>
  25271. <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
  25272. <summary>
  25273. Retrieves the message corresponding with a Win32 message identifier.
  25274. </summary>
  25275. <param name="messageId">Message identifier for the requested message.</param>
  25276. <returns>
  25277. The message corresponding with the specified message identifier.
  25278. </returns>
  25279. <remarks>
  25280. <para>
  25281. The message will be searched for in system message-table resource(s)
  25282. using the native <c>FormatMessage</c> function.
  25283. </para>
  25284. </remarks>
  25285. </member>
  25286. <member name="M:log4net.Util.NativeError.ToString">
  25287. <summary>
  25288. Return error information string
  25289. </summary>
  25290. <returns>error information string</returns>
  25291. <remarks>
  25292. <para>
  25293. Return error information string
  25294. </para>
  25295. </remarks>
  25296. </member>
  25297. <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
  25298. <summary>
  25299. Formats a message string.
  25300. </summary>
  25301. <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
  25302. <param name="lpSource">Location of the message definition.</param>
  25303. <param name="dwMessageId">Message identifier for the requested message.</param>
  25304. <param name="dwLanguageId">Language identifier for the requested message.</param>
  25305. <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>
  25306. <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>
  25307. <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
  25308. <remarks>
  25309. <para>
  25310. The function requires a message definition as input. The message definition can come from a
  25311. buffer passed into the function. It can come from a message table resource in an
  25312. already-loaded module. Or the caller can ask the function to search the system's message
  25313. table resource(s) for the message definition. The function finds the message definition
  25314. in a message table resource based on a message identifier and a language identifier.
  25315. The function copies the formatted message text to an output buffer, processing any embedded
  25316. insert sequences if requested.
  25317. </para>
  25318. <para>
  25319. To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
  25320. </para>
  25321. </remarks>
  25322. <returns>
  25323. <para>
  25324. If the function succeeds, the return value is the number of TCHARs stored in the output
  25325. buffer, excluding the terminating null character.
  25326. </para>
  25327. <para>
  25328. If the function fails, the return value is zero. To get extended error information,
  25329. call <see cref="M:Marshal.GetLastWin32Error()" />.
  25330. </para>
  25331. </returns>
  25332. </member>
  25333. <member name="T:log4net.Util.NullDictionaryEnumerator">
  25334. <summary>
  25335. An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
  25336. </summary>
  25337. <remarks>
  25338. <para>
  25339. A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
  25340. that is empty and not modifiable.
  25341. </para>
  25342. </remarks>
  25343. <author>Nicko Cadell</author>
  25344. <author>Gert Driesen</author>
  25345. </member>
  25346. <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
  25347. <summary>
  25348. Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" /> class.
  25349. </summary>
  25350. <remarks>
  25351. <para>
  25352. Uses a private access modifier to enforce the singleton pattern.
  25353. </para>
  25354. </remarks>
  25355. </member>
  25356. <member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
  25357. <summary>
  25358. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  25359. </summary>
  25360. <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.</returns>
  25361. <remarks>
  25362. <para>
  25363. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  25364. </para>
  25365. </remarks>
  25366. </member>
  25367. <member name="P:log4net.Util.NullDictionaryEnumerator.Current">
  25368. <summary>
  25369. Gets the current object from the enumerator.
  25370. </summary>
  25371. <remarks>
  25372. Throws an <see cref="T:System.InvalidOperationException" /> because the
  25373. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  25374. </remarks>
  25375. <remarks>
  25376. <para>
  25377. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25378. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25379. will throw an <see cref="T:System.InvalidOperationException"/>.
  25380. </para>
  25381. </remarks>
  25382. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25383. cannot be positioned over a valid location.</exception>
  25384. </member>
  25385. <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
  25386. <summary>
  25387. Test if the enumerator can advance, if so advance.
  25388. </summary>
  25389. <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator" /> cannot advance.</returns>
  25390. <remarks>
  25391. <para>
  25392. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25393. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
  25394. will always return <c>false</c>.
  25395. </para>
  25396. </remarks>
  25397. </member>
  25398. <member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
  25399. <summary>
  25400. Resets the enumerator back to the start.
  25401. </summary>
  25402. <remarks>
  25403. <para>
  25404. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
  25405. </para>
  25406. </remarks>
  25407. </member>
  25408. <member name="P:log4net.Util.NullDictionaryEnumerator.Key">
  25409. <summary>
  25410. Gets the current key from the enumerator.
  25411. </summary>
  25412. <remarks>
  25413. Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator" />
  25414. never has a current value.
  25415. </remarks>
  25416. <remarks>
  25417. <para>
  25418. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25419. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
  25420. will throw an <see cref="T:System.InvalidOperationException"/>.
  25421. </para>
  25422. </remarks>
  25423. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25424. cannot be positioned over a valid location.</exception>
  25425. </member>
  25426. <member name="P:log4net.Util.NullDictionaryEnumerator.Value">
  25427. <summary>
  25428. Gets the current value from the enumerator.
  25429. </summary>
  25430. <value>The current value from the enumerator.</value>
  25431. <remarks>
  25432. Throws an <see cref="T:System.InvalidOperationException" /> because the
  25433. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  25434. </remarks>
  25435. <remarks>
  25436. <para>
  25437. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25438. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
  25439. will throw an <see cref="T:System.InvalidOperationException"/>.
  25440. </para>
  25441. </remarks>
  25442. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25443. cannot be positioned over a valid location.</exception>
  25444. </member>
  25445. <member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
  25446. <summary>
  25447. Gets the current entry from the enumerator.
  25448. </summary>
  25449. <remarks>
  25450. Throws an <see cref="T:System.InvalidOperationException" /> because the
  25451. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current entry.
  25452. </remarks>
  25453. <remarks>
  25454. <para>
  25455. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25456. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
  25457. will throw an <see cref="T:System.InvalidOperationException"/>.
  25458. </para>
  25459. </remarks>
  25460. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25461. cannot be positioned over a valid location.</exception>
  25462. </member>
  25463. <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
  25464. <summary>
  25465. The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  25466. </summary>
  25467. </member>
  25468. <member name="T:log4net.Util.NullEnumerator">
  25469. <summary>
  25470. An always empty <see cref="T:System.Collections.IEnumerator"/>.
  25471. </summary>
  25472. <remarks>
  25473. <para>
  25474. A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
  25475. that is empty and not modifiable.
  25476. </para>
  25477. </remarks>
  25478. <author>Nicko Cadell</author>
  25479. <author>Gert Driesen</author>
  25480. </member>
  25481. <member name="M:log4net.Util.NullEnumerator.#ctor">
  25482. <summary>
  25483. Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator" /> class.
  25484. </summary>
  25485. <remarks>
  25486. <para>
  25487. Uses a private access modifier to enforce the singleton pattern.
  25488. </para>
  25489. </remarks>
  25490. </member>
  25491. <member name="P:log4net.Util.NullEnumerator.Instance">
  25492. <summary>
  25493. Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  25494. </summary>
  25495. <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.</returns>
  25496. <remarks>
  25497. <para>
  25498. Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  25499. </para>
  25500. </remarks>
  25501. </member>
  25502. <member name="P:log4net.Util.NullEnumerator.Current">
  25503. <summary>
  25504. Gets the current object from the enumerator.
  25505. </summary>
  25506. <remarks>
  25507. Throws an <see cref="T:System.InvalidOperationException" /> because the
  25508. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  25509. </remarks>
  25510. <remarks>
  25511. <para>
  25512. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  25513. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
  25514. will throw an <see cref="T:System.InvalidOperationException"/>.
  25515. </para>
  25516. </remarks>
  25517. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
  25518. cannot be positioned over a valid location.</exception>
  25519. </member>
  25520. <member name="M:log4net.Util.NullEnumerator.MoveNext">
  25521. <summary>
  25522. Test if the enumerator can advance, if so advance
  25523. </summary>
  25524. <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator" /> cannot advance.</returns>
  25525. <remarks>
  25526. <para>
  25527. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  25528. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
  25529. will always return <c>false</c>.
  25530. </para>
  25531. </remarks>
  25532. </member>
  25533. <member name="M:log4net.Util.NullEnumerator.Reset">
  25534. <summary>
  25535. Resets the enumerator back to the start.
  25536. </summary>
  25537. <remarks>
  25538. <para>
  25539. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
  25540. </para>
  25541. </remarks>
  25542. </member>
  25543. <member name="F:log4net.Util.NullEnumerator.s_instance">
  25544. <summary>
  25545. The singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  25546. </summary>
  25547. </member>
  25548. <member name="T:log4net.Util.NullSecurityContext">
  25549. <summary>
  25550. A SecurityContext used when a SecurityContext is not required
  25551. </summary>
  25552. <remarks>
  25553. <para>
  25554. The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
  25555. <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
  25556. is required but one has not been provided.
  25557. </para>
  25558. </remarks>
  25559. <author>Nicko Cadell</author>
  25560. </member>
  25561. <member name="F:log4net.Util.NullSecurityContext.Instance">
  25562. <summary>
  25563. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  25564. </summary>
  25565. <remarks>
  25566. <para>
  25567. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  25568. </para>
  25569. </remarks>
  25570. </member>
  25571. <member name="M:log4net.Util.NullSecurityContext.#ctor">
  25572. <summary>
  25573. Private constructor
  25574. </summary>
  25575. <remarks>
  25576. <para>
  25577. Private constructor for singleton pattern.
  25578. </para>
  25579. </remarks>
  25580. </member>
  25581. <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
  25582. <summary>
  25583. Impersonate this SecurityContext
  25584. </summary>
  25585. <param name="state">State supplied by the caller</param>
  25586. <returns><c>null</c></returns>
  25587. <remarks>
  25588. <para>
  25589. No impersonation is done and <c>null</c> is always returned.
  25590. </para>
  25591. </remarks>
  25592. </member>
  25593. <member name="T:log4net.Util.OnlyOnceErrorHandler">
  25594. <summary>
  25595. Implements log4net's default error handling policy which consists
  25596. of emitting a message for the first error in an appender and
  25597. ignoring all subsequent errors.
  25598. </summary>
  25599. <remarks>
  25600. <para>
  25601. The error message is processed using the LogLog sub-system by default.
  25602. </para>
  25603. <para>
  25604. This policy aims at protecting an otherwise working application
  25605. from being flooded with error messages when logging fails.
  25606. </para>
  25607. </remarks>
  25608. <author>Nicko Cadell</author>
  25609. <author>Gert Driesen</author>
  25610. <author>Ron Grabowski</author>
  25611. </member>
  25612. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
  25613. <summary>
  25614. Default Constructor
  25615. </summary>
  25616. <remarks>
  25617. <para>
  25618. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler" /> class.
  25619. </para>
  25620. </remarks>
  25621. </member>
  25622. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
  25623. <summary>
  25624. Constructor
  25625. </summary>
  25626. <param name="prefix">The prefix to use for each message.</param>
  25627. <remarks>
  25628. <para>
  25629. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler" /> class
  25630. with the specified prefix.
  25631. </para>
  25632. </remarks>
  25633. </member>
  25634. <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
  25635. <summary>
  25636. Reset the error handler back to its initial disabled state.
  25637. </summary>
  25638. </member>
  25639. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  25640. <summary>
  25641. Log an Error
  25642. </summary>
  25643. <param name="message">The error message.</param>
  25644. <param name="e">The exception.</param>
  25645. <param name="errorCode">The internal error code.</param>
  25646. <remarks>
  25647. <para>
  25648. 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.
  25649. </para>
  25650. </remarks>
  25651. </member>
  25652. <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
  25653. <summary>
  25654. Log the very first error
  25655. </summary>
  25656. <param name="message">The error message.</param>
  25657. <param name="e">The exception.</param>
  25658. <param name="errorCode">The internal error code.</param>
  25659. <remarks>
  25660. <para>
  25661. Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
  25662. </para>
  25663. </remarks>
  25664. </member>
  25665. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
  25666. <summary>
  25667. Log an Error
  25668. </summary>
  25669. <param name="message">The error message.</param>
  25670. <param name="e">The exception.</param>
  25671. <remarks>
  25672. <para>
  25673. 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.
  25674. </para>
  25675. </remarks>
  25676. </member>
  25677. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
  25678. <summary>
  25679. Log an error
  25680. </summary>
  25681. <param name="message">The error message.</param>
  25682. <remarks>
  25683. <para>
  25684. 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.
  25685. </para>
  25686. </remarks>
  25687. </member>
  25688. <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
  25689. <summary>
  25690. Is error logging enabled
  25691. </summary>
  25692. <remarks>
  25693. <para>
  25694. Is error logging enabled. Logging is only enabled for the
  25695. first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
  25696. </para>
  25697. </remarks>
  25698. </member>
  25699. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
  25700. <summary>
  25701. The date the first error that trigged this error handler occurred, or <see cref="F:System.DateTime.MinValue"/> if it has not been triggered.
  25702. </summary>
  25703. </member>
  25704. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDateUtc">
  25705. <summary>
  25706. The UTC date the first error that trigged this error handler occured, or <see cref="F:System.DateTime.MinValue"/> if it has not been triggered.
  25707. </summary>
  25708. </member>
  25709. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
  25710. <summary>
  25711. The message from the first error that trigged this error handler.
  25712. </summary>
  25713. </member>
  25714. <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
  25715. <summary>
  25716. The exception from the first error that trigged this error handler.
  25717. </summary>
  25718. <remarks>
  25719. May be <see langword="null" />.
  25720. </remarks>
  25721. </member>
  25722. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
  25723. <summary>
  25724. The error code from the first error that trigged this error handler.
  25725. </summary>
  25726. <remarks>
  25727. Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
  25728. </remarks>
  25729. </member>
  25730. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDateUtc">
  25731. <summary>
  25732. The UTC date the error was recorded.
  25733. </summary>
  25734. </member>
  25735. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
  25736. <summary>
  25737. Flag to indicate if it is the first error
  25738. </summary>
  25739. </member>
  25740. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
  25741. <summary>
  25742. The message recorded during the first error.
  25743. </summary>
  25744. </member>
  25745. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
  25746. <summary>
  25747. The exception recorded during the first error.
  25748. </summary>
  25749. </member>
  25750. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
  25751. <summary>
  25752. The error code recorded during the first error.
  25753. </summary>
  25754. </member>
  25755. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
  25756. <summary>
  25757. String to prefix each message with
  25758. </summary>
  25759. </member>
  25760. <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
  25761. <summary>
  25762. The fully qualified type of the OnlyOnceErrorHandler class.
  25763. </summary>
  25764. <remarks>
  25765. Used by the internal logger to record the Type of the
  25766. log message.
  25767. </remarks>
  25768. </member>
  25769. <member name="T:log4net.Util.OptionConverter">
  25770. <summary>
  25771. A convenience class to convert property values to specific types.
  25772. </summary>
  25773. <remarks>
  25774. <para>
  25775. Utility functions for converting types and parsing values.
  25776. </para>
  25777. </remarks>
  25778. <author>Nicko Cadell</author>
  25779. <author>Gert Driesen</author>
  25780. </member>
  25781. <member name="M:log4net.Util.OptionConverter.#ctor">
  25782. <summary>
  25783. Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter" /> class.
  25784. </summary>
  25785. <remarks>
  25786. <para>
  25787. Uses a private access modifier to prevent instantiation of this class.
  25788. </para>
  25789. </remarks>
  25790. </member>
  25791. <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
  25792. <summary>
  25793. Converts a string to a <see cref="T:System.Boolean" /> value.
  25794. </summary>
  25795. <param name="argValue">String to convert.</param>
  25796. <param name="defaultValue">The default value.</param>
  25797. <returns>The <see cref="T:System.Boolean" /> value of <paramref name="argValue" />.</returns>
  25798. <remarks>
  25799. <para>
  25800. If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
  25801. If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
  25802. Otherwise, <paramref name="defaultValue"/> is returned.
  25803. </para>
  25804. </remarks>
  25805. </member>
  25806. <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
  25807. <summary>
  25808. Parses a file size into a number.
  25809. </summary>
  25810. <param name="argValue">String to parse.</param>
  25811. <param name="defaultValue">The default value.</param>
  25812. <returns>The <see cref="T:System.Int64" /> value of <paramref name="argValue" />.</returns>
  25813. <remarks>
  25814. <para>
  25815. Parses a file size of the form: number[KB|MB|GB] into a
  25816. long value. It is scaled with the appropriate multiplier.
  25817. </para>
  25818. <para>
  25819. <paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
  25820. cannot be converted to a <see cref="T:System.Int64" /> value.
  25821. </para>
  25822. </remarks>
  25823. </member>
  25824. <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
  25825. <summary>
  25826. Converts a string to an object.
  25827. </summary>
  25828. <param name="target">The target type to convert to.</param>
  25829. <param name="txt">The string to convert to an object.</param>
  25830. <returns>
  25831. The object converted from a string or <c>null</c> when the
  25832. conversion failed.
  25833. </returns>
  25834. <remarks>
  25835. <para>
  25836. Converts a string to an object. Uses the converter registry to try
  25837. to convert the string value into the specified target type.
  25838. </para>
  25839. </remarks>
  25840. </member>
  25841. <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
  25842. <summary>
  25843. Checks if there is an appropriate type conversion from the source type to the target type.
  25844. </summary>
  25845. <param name="sourceType">The type to convert from.</param>
  25846. <param name="targetType">The type to convert to.</param>
  25847. <returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
  25848. <remarks>
  25849. Checks if there is an appropriate type conversion from the source type to the target type.
  25850. <para>
  25851. </para>
  25852. </remarks>
  25853. </member>
  25854. <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
  25855. <summary>
  25856. Converts an object to the target type.
  25857. </summary>
  25858. <param name="sourceInstance">The object to convert to the target type.</param>
  25859. <param name="targetType">The type to convert to.</param>
  25860. <returns>The converted object.</returns>
  25861. <remarks>
  25862. <para>
  25863. Converts an object to the target type.
  25864. </para>
  25865. </remarks>
  25866. </member>
  25867. <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
  25868. <summary>
  25869. Instantiates an object given a class name.
  25870. </summary>
  25871. <param name="className">The fully qualified class name of the object to instantiate.</param>
  25872. <param name="superClass">The class to which the new object should belong.</param>
  25873. <param name="defaultValue">The object to return in case of non-fulfillment.</param>
  25874. <returns>
  25875. An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
  25876. if the object could not be instantiated.
  25877. </returns>
  25878. <remarks>
  25879. <para>
  25880. Checks that the <paramref name="className"/> is a subclass of
  25881. <paramref name="superClass"/>. If that test fails or the object could
  25882. not be instantiated, then <paramref name="defaultValue"/> is returned.
  25883. </para>
  25884. </remarks>
  25885. </member>
  25886. <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
  25887. <summary>
  25888. Performs variable substitution in string <paramref name="value"/> from the
  25889. values of keys found in <paramref name="props"/>.
  25890. </summary>
  25891. <param name="value">The string on which variable substitution is performed.</param>
  25892. <param name="props">The dictionary to use to lookup variables.</param>
  25893. <returns>The result of the substitutions.</returns>
  25894. <remarks>
  25895. <para>
  25896. The variable substitution delimiters are <b>${</b> and <b>}</b>.
  25897. </para>
  25898. <para>
  25899. For example, if props contains <c>key=value</c>, then the call
  25900. </para>
  25901. <para>
  25902. <code lang="C#">
  25903. string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
  25904. </code>
  25905. </para>
  25906. <para>
  25907. will set the variable <c>s</c> to "Value of key is value.".
  25908. </para>
  25909. <para>
  25910. If no value could be found for the specified key, then substitution
  25911. defaults to an empty string.
  25912. </para>
  25913. <para>
  25914. For example, if system properties contains no value for the key
  25915. "nonExistentKey", then the call
  25916. </para>
  25917. <para>
  25918. <code lang="C#">
  25919. string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
  25920. </code>
  25921. </para>
  25922. <para>
  25923. will set <s>s</s> to "Value of nonExistentKey is []".
  25924. </para>
  25925. <para>
  25926. An Exception is thrown if <paramref name="value"/> contains a start
  25927. delimiter "${" which is not balanced by a stop delimiter "}".
  25928. </para>
  25929. </remarks>
  25930. </member>
  25931. <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
  25932. <summary>
  25933. Converts the string representation of the name or numeric value of one or
  25934. more enumerated constants to an equivalent enumerated object.
  25935. </summary>
  25936. <param name="enumType">The type to convert to.</param>
  25937. <param name="value">The enum string value.</param>
  25938. <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
  25939. <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
  25940. </member>
  25941. <member name="F:log4net.Util.OptionConverter.declaringType">
  25942. <summary>
  25943. The fully qualified type of the OptionConverter class.
  25944. </summary>
  25945. <remarks>
  25946. Used by the internal logger to record the Type of the
  25947. log message.
  25948. </remarks>
  25949. </member>
  25950. <member name="T:log4net.Util.PatternConverter">
  25951. <summary>
  25952. Abstract class that provides the formatting functionality that
  25953. derived classes need.
  25954. </summary>
  25955. <remarks>
  25956. <para>
  25957. Conversion specifiers in a conversion patterns are parsed to
  25958. individual PatternConverters. Each of which is responsible for
  25959. converting a logging event in a converter specific manner.
  25960. </para>
  25961. </remarks>
  25962. <author>Nicko Cadell</author>
  25963. <author>Gert Driesen</author>
  25964. </member>
  25965. <member name="M:log4net.Util.PatternConverter.#ctor">
  25966. <summary>
  25967. Protected constructor
  25968. </summary>
  25969. <remarks>
  25970. <para>
  25971. Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter" /> class.
  25972. </para>
  25973. </remarks>
  25974. </member>
  25975. <member name="P:log4net.Util.PatternConverter.Next">
  25976. <summary>
  25977. Get the next pattern converter in the chain
  25978. </summary>
  25979. <value>
  25980. the next pattern converter in the chain
  25981. </value>
  25982. <remarks>
  25983. <para>
  25984. Get the next pattern converter in the chain
  25985. </para>
  25986. </remarks>
  25987. </member>
  25988. <member name="P:log4net.Util.PatternConverter.FormattingInfo">
  25989. <summary>
  25990. Gets or sets the formatting info for this converter
  25991. </summary>
  25992. <value>
  25993. The formatting info for this converter
  25994. </value>
  25995. <remarks>
  25996. <para>
  25997. Gets or sets the formatting info for this converter
  25998. </para>
  25999. </remarks>
  26000. </member>
  26001. <member name="P:log4net.Util.PatternConverter.Option">
  26002. <summary>
  26003. Gets or sets the option value for this converter
  26004. </summary>
  26005. <summary>
  26006. The option for this converter
  26007. </summary>
  26008. <remarks>
  26009. <para>
  26010. Gets or sets the option value for this converter
  26011. </para>
  26012. </remarks>
  26013. </member>
  26014. <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26015. <summary>
  26016. Evaluate this pattern converter and write the output to a writer.
  26017. </summary>
  26018. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  26019. <param name="state">The state object on which the pattern converter should be executed.</param>
  26020. <remarks>
  26021. <para>
  26022. Derived pattern converters must override this method in order to
  26023. convert conversion specifiers in the appropriate way.
  26024. </para>
  26025. </remarks>
  26026. </member>
  26027. <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
  26028. <summary>
  26029. Set the next pattern converter in the chains
  26030. </summary>
  26031. <param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
  26032. <returns>the next converter</returns>
  26033. <remarks>
  26034. <para>
  26035. The PatternConverter can merge with its neighbor during this method (or a sub class).
  26036. Therefore the return value may or may not be the value of the argument passed in.
  26037. </para>
  26038. </remarks>
  26039. </member>
  26040. <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
  26041. <summary>
  26042. Write the pattern converter to the writer with appropriate formatting
  26043. </summary>
  26044. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  26045. <param name="state">The state object on which the pattern converter should be executed.</param>
  26046. <remarks>
  26047. <para>
  26048. This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
  26049. appropriate conversion of the pattern converter. If formatting options have
  26050. been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
  26051. apply those formattings before writing the output.
  26052. </para>
  26053. </remarks>
  26054. </member>
  26055. <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
  26056. <summary>
  26057. Fast space padding method.
  26058. </summary>
  26059. <param name="writer"><see cref="T:System.IO.TextWriter" /> to which the spaces will be appended.</param>
  26060. <param name="length">The number of spaces to be padded.</param>
  26061. <remarks>
  26062. <para>
  26063. Fast space padding method.
  26064. </para>
  26065. </remarks>
  26066. </member>
  26067. <member name="F:log4net.Util.PatternConverter.m_option">
  26068. <summary>
  26069. The option string to the converter
  26070. </summary>
  26071. </member>
  26072. <member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
  26073. <summary>
  26074. Initial buffer size
  26075. </summary>
  26076. </member>
  26077. <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
  26078. <summary>
  26079. Maximum buffer size before it is recycled
  26080. </summary>
  26081. </member>
  26082. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
  26083. <summary>
  26084. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  26085. </summary>
  26086. <param name="writer">the writer to write to</param>
  26087. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  26088. <param name="value">the value to write to the writer</param>
  26089. <remarks>
  26090. <para>
  26091. Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
  26092. </para>
  26093. <code>
  26094. {key1=value1, key2=value2, key3=value3}
  26095. </code>
  26096. <para>
  26097. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  26098. is not null then it is used to render the key and value to text, otherwise
  26099. the object's ToString method is called.
  26100. </para>
  26101. </remarks>
  26102. </member>
  26103. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
  26104. <summary>
  26105. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  26106. </summary>
  26107. <param name="writer">the writer to write to</param>
  26108. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  26109. <param name="value">the value to write to the writer</param>
  26110. <remarks>
  26111. <para>
  26112. Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
  26113. </para>
  26114. <code>
  26115. {key1=value1, key2=value2, key3=value3}
  26116. </code>
  26117. <para>
  26118. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  26119. is not null then it is used to render the key and value to text, otherwise
  26120. the object's ToString method is called.
  26121. </para>
  26122. </remarks>
  26123. </member>
  26124. <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
  26125. <summary>
  26126. Write an object to a <see cref="T:System.IO.TextWriter"/>
  26127. </summary>
  26128. <param name="writer">the writer to write to</param>
  26129. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  26130. <param name="value">the value to write to the writer</param>
  26131. <remarks>
  26132. <para>
  26133. Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  26134. is not null then it is used to render the object to text, otherwise
  26135. the object's ToString method is called.
  26136. </para>
  26137. </remarks>
  26138. </member>
  26139. <member name="P:log4net.Util.PatternConverter.Properties">
  26140. <summary>
  26141. </summary>
  26142. </member>
  26143. <member name="T:log4net.Util.PatternParser">
  26144. <summary>
  26145. Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
  26146. is delegated to the PatternParser class.
  26147. </summary>
  26148. <remarks>
  26149. <para>
  26150. The <c>PatternParser</c> processes a pattern string and
  26151. returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
  26152. </para>
  26153. </remarks>
  26154. <author>Nicko Cadell</author>
  26155. <author>Gert Driesen</author>
  26156. </member>
  26157. <member name="M:log4net.Util.PatternParser.#ctor(System.String)">
  26158. <summary>
  26159. Constructor
  26160. </summary>
  26161. <param name="pattern">The pattern to parse.</param>
  26162. <remarks>
  26163. <para>
  26164. Initializes a new instance of the <see cref="T:log4net.Util.PatternParser" /> class
  26165. with the specified pattern string.
  26166. </para>
  26167. </remarks>
  26168. </member>
  26169. <member name="M:log4net.Util.PatternParser.Parse">
  26170. <summary>
  26171. Parses the pattern into a chain of pattern converters.
  26172. </summary>
  26173. <returns>The head of a chain of pattern converters.</returns>
  26174. <remarks>
  26175. <para>
  26176. Parses the pattern into a chain of pattern converters.
  26177. </para>
  26178. </remarks>
  26179. </member>
  26180. <member name="P:log4net.Util.PatternParser.PatternConverters">
  26181. <summary>
  26182. Get the converter registry used by this parser
  26183. </summary>
  26184. <value>
  26185. The converter registry used by this parser
  26186. </value>
  26187. <remarks>
  26188. <para>
  26189. Get the converter registry used by this parser
  26190. </para>
  26191. </remarks>
  26192. </member>
  26193. <member name="M:log4net.Util.PatternParser.BuildCache">
  26194. <summary>
  26195. Build the unified cache of converters from the static and instance maps
  26196. </summary>
  26197. <returns>the list of all the converter names</returns>
  26198. <remarks>
  26199. <para>
  26200. Build the unified cache of converters from the static and instance maps
  26201. </para>
  26202. </remarks>
  26203. </member>
  26204. <member name="T:log4net.Util.PatternParser.StringLengthComparer">
  26205. <summary>
  26206. Sort strings by length
  26207. </summary>
  26208. <remarks>
  26209. <para>
  26210. <see cref="T:System.Collections.IComparer" /> that orders strings by string length.
  26211. The longest strings are placed first
  26212. </para>
  26213. </remarks>
  26214. </member>
  26215. <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
  26216. <summary>
  26217. Internal method to parse the specified pattern to find specified matches
  26218. </summary>
  26219. <param name="pattern">the pattern to parse</param>
  26220. <param name="matches">the converter names to match in the pattern</param>
  26221. <remarks>
  26222. <para>
  26223. The matches param must be sorted such that longer strings come before shorter ones.
  26224. </para>
  26225. </remarks>
  26226. </member>
  26227. <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
  26228. <summary>
  26229. Process a parsed literal
  26230. </summary>
  26231. <param name="text">the literal text</param>
  26232. </member>
  26233. <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
  26234. <summary>
  26235. Process a parsed converter pattern
  26236. </summary>
  26237. <param name="converterName">the name of the converter</param>
  26238. <param name="option">the optional option for the converter</param>
  26239. <param name="formattingInfo">the formatting info for the converter</param>
  26240. </member>
  26241. <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
  26242. <summary>
  26243. Resets the internal state of the parser and adds the specified pattern converter
  26244. to the chain.
  26245. </summary>
  26246. <param name="pc">The pattern converter to add.</param>
  26247. </member>
  26248. <member name="F:log4net.Util.PatternParser.m_head">
  26249. <summary>
  26250. The first pattern converter in the chain
  26251. </summary>
  26252. </member>
  26253. <member name="F:log4net.Util.PatternParser.m_tail">
  26254. <summary>
  26255. the last pattern converter in the chain
  26256. </summary>
  26257. </member>
  26258. <member name="F:log4net.Util.PatternParser.m_pattern">
  26259. <summary>
  26260. The pattern
  26261. </summary>
  26262. </member>
  26263. <member name="F:log4net.Util.PatternParser.m_patternConverters">
  26264. <summary>
  26265. Internal map of converter identifiers to converter types
  26266. </summary>
  26267. <remarks>
  26268. <para>
  26269. This map overrides the static s_globalRulesRegistry map.
  26270. </para>
  26271. </remarks>
  26272. </member>
  26273. <member name="F:log4net.Util.PatternParser.declaringType">
  26274. <summary>
  26275. The fully qualified type of the PatternParser class.
  26276. </summary>
  26277. <remarks>
  26278. Used by the internal logger to record the Type of the
  26279. log message.
  26280. </remarks>
  26281. </member>
  26282. <member name="T:log4net.Util.PatternString">
  26283. <summary>
  26284. This class implements a patterned string.
  26285. </summary>
  26286. <remarks>
  26287. <para>
  26288. This string has embedded patterns that are resolved and expanded
  26289. when the string is formatted.
  26290. </para>
  26291. <para>
  26292. This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
  26293. in that it accepts a pattern and renders it to a string. Unlike the
  26294. <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
  26295. does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
  26296. of the process in general.
  26297. </para>
  26298. <para>
  26299. The recognized conversion pattern names are:
  26300. </para>
  26301. <list type="table">
  26302. <listheader>
  26303. <term>Conversion Pattern Name</term>
  26304. <description>Effect</description>
  26305. </listheader>
  26306. <item>
  26307. <term>appdomain</term>
  26308. <description>
  26309. <para>
  26310. Used to output the friendly name of the current AppDomain.
  26311. </para>
  26312. </description>
  26313. </item>
  26314. <item>
  26315. <term>appsetting</term>
  26316. <description>
  26317. <para>
  26318. Used to output the value of a specific appSetting key in the application
  26319. configuration file.
  26320. </para>
  26321. </description>
  26322. </item>
  26323. <item>
  26324. <term>date</term>
  26325. <description>
  26326. <para>
  26327. Used to output the current date and time in the local time zone.
  26328. To output the date in universal time use the <c>%utcdate</c> pattern.
  26329. The date conversion
  26330. specifier may be followed by a <i>date format specifier</i> enclosed
  26331. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  26332. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  26333. given then ISO8601 format is
  26334. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  26335. </para>
  26336. <para>
  26337. The date format specifier admits the same syntax as the
  26338. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  26339. </para>
  26340. <para>
  26341. For better results it is recommended to use the log4net date
  26342. formatters. These can be specified using one of the strings
  26343. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  26344. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  26345. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  26346. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  26347. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  26348. </para>
  26349. <para>
  26350. These dedicated date formatters perform significantly
  26351. better than <see cref="M:DateTime.ToString(string)"/>.
  26352. </para>
  26353. </description>
  26354. </item>
  26355. <item>
  26356. <term>env</term>
  26357. <description>
  26358. <para>
  26359. Used to output the a specific environment variable. The key to
  26360. lookup must be specified within braces and directly following the
  26361. pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
  26362. of the <c>COMPUTERNAME</c> environment variable.
  26363. </para>
  26364. <para>
  26365. The <c>env</c> pattern is not supported on the .NET Compact Framework.
  26366. </para>
  26367. </description>
  26368. </item>
  26369. <item>
  26370. <term>identity</term>
  26371. <description>
  26372. <para>
  26373. Used to output the user name for the currently active user
  26374. (Principal.Identity.Name).
  26375. </para>
  26376. </description>
  26377. </item>
  26378. <item>
  26379. <term>newline</term>
  26380. <description>
  26381. <para>
  26382. Outputs the platform dependent line separator character or
  26383. characters.
  26384. </para>
  26385. <para>
  26386. This conversion pattern name offers the same performance as using
  26387. non-portable line separator strings such as "\n", or "\r\n".
  26388. Thus, it is the preferred way of specifying a line separator.
  26389. </para>
  26390. </description>
  26391. </item>
  26392. <item>
  26393. <term>processid</term>
  26394. <description>
  26395. <para>
  26396. Used to output the system process ID for the current process.
  26397. </para>
  26398. </description>
  26399. </item>
  26400. <item>
  26401. <term>property</term>
  26402. <description>
  26403. <para>
  26404. Used to output a specific context property. The key to
  26405. lookup must be specified within braces and directly following the
  26406. pattern specifier, e.g. <b>%property{user}</b> would include the value
  26407. from the property that is keyed by the string 'user'. Each property value
  26408. that is to be included in the log must be specified separately.
  26409. Properties are stored in logging contexts. By default
  26410. the <c>log4net:HostName</c> property is set to the name of machine on
  26411. which the event was originally logged.
  26412. </para>
  26413. <para>
  26414. If no key is specified, e.g. <b>%property</b> then all the keys and their
  26415. values are printed in a comma separated list.
  26416. </para>
  26417. <para>
  26418. The properties of an event are combined from a number of different
  26419. contexts. These are listed below in the order in which they are searched.
  26420. </para>
  26421. <list type="definition">
  26422. <item>
  26423. <term>the thread properties</term>
  26424. <description>
  26425. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  26426. thread. These properties are shared by all events logged on this thread.
  26427. </description>
  26428. </item>
  26429. <item>
  26430. <term>the global properties</term>
  26431. <description>
  26432. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  26433. properties are shared by all the threads in the AppDomain.
  26434. </description>
  26435. </item>
  26436. </list>
  26437. </description>
  26438. </item>
  26439. <item>
  26440. <term>random</term>
  26441. <description>
  26442. <para>
  26443. Used to output a random string of characters. The string is made up of
  26444. uppercase letters and numbers. By default the string is 4 characters long.
  26445. The length of the string can be specified within braces directly following the
  26446. pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
  26447. </para>
  26448. </description>
  26449. </item>
  26450. <item>
  26451. <term>username</term>
  26452. <description>
  26453. <para>
  26454. Used to output the WindowsIdentity for the currently
  26455. active user.
  26456. </para>
  26457. </description>
  26458. </item>
  26459. <item>
  26460. <term>utcdate</term>
  26461. <description>
  26462. <para>
  26463. Used to output the date of the logging event in universal time.
  26464. The date conversion
  26465. specifier may be followed by a <i>date format specifier</i> enclosed
  26466. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  26467. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  26468. given then ISO8601 format is
  26469. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  26470. </para>
  26471. <para>
  26472. The date format specifier admits the same syntax as the
  26473. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  26474. </para>
  26475. <para>
  26476. For better results it is recommended to use the log4net date
  26477. formatters. These can be specified using one of the strings
  26478. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  26479. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  26480. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  26481. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  26482. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  26483. </para>
  26484. <para>
  26485. These dedicated date formatters perform significantly
  26486. better than <see cref="M:DateTime.ToString(string)"/>.
  26487. </para>
  26488. </description>
  26489. </item>
  26490. <item>
  26491. <term>%</term>
  26492. <description>
  26493. <para>
  26494. The sequence %% outputs a single percent sign.
  26495. </para>
  26496. </description>
  26497. </item>
  26498. </list>
  26499. <para>
  26500. Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
  26501. instance using <see cref="M:AddConverter(ConverterInfo)"/> or
  26502. <see cref="M:AddConverter(string, Type)" />.
  26503. </para>
  26504. <para>
  26505. See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
  26506. <i>format modifiers</i> supported by the patterns.
  26507. </para>
  26508. </remarks>
  26509. <author>Nicko Cadell</author>
  26510. </member>
  26511. <member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
  26512. <summary>
  26513. Internal map of converter identifiers to converter types.
  26514. </summary>
  26515. </member>
  26516. <member name="F:log4net.Util.PatternString.m_pattern">
  26517. <summary>
  26518. the pattern
  26519. </summary>
  26520. </member>
  26521. <member name="F:log4net.Util.PatternString.m_head">
  26522. <summary>
  26523. the head of the pattern converter chain
  26524. </summary>
  26525. </member>
  26526. <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
  26527. <summary>
  26528. patterns defined on this PatternString only
  26529. </summary>
  26530. </member>
  26531. <member name="M:log4net.Util.PatternString.#cctor">
  26532. <summary>
  26533. Initialize the global registry
  26534. </summary>
  26535. </member>
  26536. <member name="M:log4net.Util.PatternString.#ctor">
  26537. <summary>
  26538. Default constructor
  26539. </summary>
  26540. <remarks>
  26541. <para>
  26542. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
  26543. </para>
  26544. </remarks>
  26545. </member>
  26546. <member name="M:log4net.Util.PatternString.#ctor(System.String)">
  26547. <summary>
  26548. Constructs a PatternString
  26549. </summary>
  26550. <param name="pattern">The pattern to use with this PatternString</param>
  26551. <remarks>
  26552. <para>
  26553. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
  26554. </para>
  26555. </remarks>
  26556. </member>
  26557. <member name="P:log4net.Util.PatternString.ConversionPattern">
  26558. <summary>
  26559. Gets or sets the pattern formatting string
  26560. </summary>
  26561. <value>
  26562. The pattern formatting string
  26563. </value>
  26564. <remarks>
  26565. <para>
  26566. The <b>ConversionPattern</b> option. This is the string which
  26567. controls formatting and consists of a mix of literal content and
  26568. conversion specifiers.
  26569. </para>
  26570. </remarks>
  26571. </member>
  26572. <member name="M:log4net.Util.PatternString.ActivateOptions">
  26573. <summary>
  26574. Initialize object options
  26575. </summary>
  26576. <remarks>
  26577. <para>
  26578. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  26579. activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
  26580. be called on this object after the configuration properties have
  26581. been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
  26582. object is in an undefined state and must not be used.
  26583. </para>
  26584. <para>
  26585. If any of the configuration properties are modified then
  26586. <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
  26587. </para>
  26588. </remarks>
  26589. </member>
  26590. <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
  26591. <summary>
  26592. Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
  26593. </summary>
  26594. <param name="pattern">the pattern to parse</param>
  26595. <returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
  26596. <remarks>
  26597. <para>
  26598. Returns PatternParser used to parse the conversion string. Subclasses
  26599. may override this to return a subclass of PatternParser which recognize
  26600. custom conversion pattern name.
  26601. </para>
  26602. </remarks>
  26603. </member>
  26604. <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
  26605. <summary>
  26606. Produces a formatted string as specified by the conversion pattern.
  26607. </summary>
  26608. <param name="writer">The TextWriter to write the formatted event to</param>
  26609. <remarks>
  26610. <para>
  26611. Format the pattern to the <paramref name="writer"/>.
  26612. </para>
  26613. </remarks>
  26614. </member>
  26615. <member name="M:log4net.Util.PatternString.Format">
  26616. <summary>
  26617. Format the pattern as a string
  26618. </summary>
  26619. <returns>the pattern formatted as a string</returns>
  26620. <remarks>
  26621. <para>
  26622. Format the pattern to a string.
  26623. </para>
  26624. </remarks>
  26625. </member>
  26626. <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
  26627. <summary>
  26628. Add a converter to this PatternString
  26629. </summary>
  26630. <param name="converterInfo">the converter info</param>
  26631. <remarks>
  26632. <para>
  26633. This version of the method is used by the configurator.
  26634. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  26635. </para>
  26636. </remarks>
  26637. </member>
  26638. <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
  26639. <summary>
  26640. Add a converter to this PatternString
  26641. </summary>
  26642. <param name="name">the name of the conversion pattern for this converter</param>
  26643. <param name="type">the type of the converter</param>
  26644. <remarks>
  26645. <para>
  26646. Add a converter to this PatternString
  26647. </para>
  26648. </remarks>
  26649. </member>
  26650. <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
  26651. <summary>
  26652. Write the name of the current AppDomain to the output
  26653. </summary>
  26654. <remarks>
  26655. <para>
  26656. Write the name of the current AppDomain to the output writer
  26657. </para>
  26658. </remarks>
  26659. <author>Nicko Cadell</author>
  26660. </member>
  26661. <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26662. <summary>
  26663. Write the name of the current AppDomain to the output
  26664. </summary>
  26665. <param name="writer">the writer to write to</param>
  26666. <param name="state">null, state is not set</param>
  26667. <remarks>
  26668. <para>
  26669. Writes name of the current AppDomain to the output <paramref name="writer"/>.
  26670. </para>
  26671. </remarks>
  26672. </member>
  26673. <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
  26674. <summary>
  26675. Write the current date to the output
  26676. </summary>
  26677. <remarks>
  26678. <para>
  26679. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  26680. the current date and time to the writer as a string.
  26681. </para>
  26682. <para>
  26683. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  26684. the formatting of the date. The following values are allowed:
  26685. <list type="definition">
  26686. <listheader>
  26687. <term>Option value</term>
  26688. <description>Output</description>
  26689. </listheader>
  26690. <item>
  26691. <term>ISO8601</term>
  26692. <description>
  26693. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  26694. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  26695. </description>
  26696. </item>
  26697. <item>
  26698. <term>DATE</term>
  26699. <description>
  26700. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  26701. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  26702. </description>
  26703. </item>
  26704. <item>
  26705. <term>ABSOLUTE</term>
  26706. <description>
  26707. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  26708. Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  26709. </description>
  26710. </item>
  26711. <item>
  26712. <term>other</term>
  26713. <description>
  26714. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  26715. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  26716. <see cref="M:DateTime.ToString(string)"/> method.
  26717. For details on valid patterns see
  26718. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  26719. </description>
  26720. </item>
  26721. </list>
  26722. </para>
  26723. <para>
  26724. The date and time is in the local time zone and is rendered in that zone.
  26725. To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
  26726. </para>
  26727. </remarks>
  26728. <author>Nicko Cadell</author>
  26729. </member>
  26730. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
  26731. <summary>
  26732. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  26733. </summary>
  26734. <remarks>
  26735. <para>
  26736. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  26737. </para>
  26738. </remarks>
  26739. </member>
  26740. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
  26741. <summary>
  26742. Initialize the converter options
  26743. </summary>
  26744. <remarks>
  26745. <para>
  26746. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  26747. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
  26748. be called on this object after the configuration properties have
  26749. been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
  26750. object is in an undefined state and must not be used.
  26751. </para>
  26752. <para>
  26753. If any of the configuration properties are modified then
  26754. <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
  26755. </para>
  26756. </remarks>
  26757. </member>
  26758. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26759. <summary>
  26760. Write the current date to the output
  26761. </summary>
  26762. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  26763. <param name="state">null, state is not set</param>
  26764. <remarks>
  26765. <para>
  26766. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  26767. for it to render it to the writer.
  26768. </para>
  26769. <para>
  26770. The date and time passed is in the local time zone.
  26771. </para>
  26772. </remarks>
  26773. </member>
  26774. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
  26775. <summary>
  26776. The fully qualified type of the DatePatternConverter class.
  26777. </summary>
  26778. <remarks>
  26779. Used by the internal logger to record the Type of the
  26780. log message.
  26781. </remarks>
  26782. </member>
  26783. <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
  26784. <summary>
  26785. Write an environment variable to the output
  26786. </summary>
  26787. <remarks>
  26788. <para>
  26789. Write an environment variable to the output writer.
  26790. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  26791. the name of the variable to output.
  26792. </para>
  26793. </remarks>
  26794. <author>Nicko Cadell</author>
  26795. </member>
  26796. <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26797. <summary>
  26798. Write an environment variable to the output
  26799. </summary>
  26800. <param name="writer">the writer to write to</param>
  26801. <param name="state">null, state is not set</param>
  26802. <remarks>
  26803. <para>
  26804. Writes the environment variable to the output <paramref name="writer"/>.
  26805. The name of the environment variable to output must be set
  26806. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  26807. property.
  26808. </para>
  26809. </remarks>
  26810. </member>
  26811. <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
  26812. <summary>
  26813. The fully qualified type of the EnvironmentPatternConverter class.
  26814. </summary>
  26815. <remarks>
  26816. Used by the internal logger to record the Type of the
  26817. log message.
  26818. </remarks>
  26819. </member>
  26820. <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
  26821. <summary>
  26822. Write the current thread identity to the output
  26823. </summary>
  26824. <remarks>
  26825. <para>
  26826. Write the current thread identity to the output writer
  26827. </para>
  26828. </remarks>
  26829. <author>Nicko Cadell</author>
  26830. </member>
  26831. <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26832. <summary>
  26833. Write the current thread identity to the output
  26834. </summary>
  26835. <param name="writer">the writer to write to</param>
  26836. <param name="state">null, state is not set</param>
  26837. <remarks>
  26838. <para>
  26839. Writes the current thread identity to the output <paramref name="writer"/>.
  26840. </para>
  26841. </remarks>
  26842. </member>
  26843. <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
  26844. <summary>
  26845. The fully qualified type of the IdentityPatternConverter class.
  26846. </summary>
  26847. <remarks>
  26848. Used by the internal logger to record the Type of the
  26849. log message.
  26850. </remarks>
  26851. </member>
  26852. <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
  26853. <summary>
  26854. Pattern converter for literal string instances in the pattern
  26855. </summary>
  26856. <remarks>
  26857. <para>
  26858. Writes the literal string value specified in the
  26859. <see cref="P:log4net.Util.PatternConverter.Option"/> property to
  26860. the output.
  26861. </para>
  26862. </remarks>
  26863. <author>Nicko Cadell</author>
  26864. </member>
  26865. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
  26866. <summary>
  26867. Set the next converter in the chain
  26868. </summary>
  26869. <param name="pc">The next pattern converter in the chain</param>
  26870. <returns>The next pattern converter</returns>
  26871. <remarks>
  26872. <para>
  26873. Special case the building of the pattern converter chain
  26874. for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
  26875. literals in the pattern can be represented by a single combined
  26876. pattern converter. This implementation detects when a
  26877. <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
  26878. after this converter and combines its value with this converter's
  26879. literal value.
  26880. </para>
  26881. </remarks>
  26882. </member>
  26883. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
  26884. <summary>
  26885. Write the literal to the output
  26886. </summary>
  26887. <param name="writer">the writer to write to</param>
  26888. <param name="state">null, not set</param>
  26889. <remarks>
  26890. <para>
  26891. Override the formatting behavior to ignore the FormattingInfo
  26892. because we have a literal instead.
  26893. </para>
  26894. <para>
  26895. Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
  26896. to the output <paramref name="writer"/>.
  26897. </para>
  26898. </remarks>
  26899. </member>
  26900. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26901. <summary>
  26902. Convert this pattern into the rendered message
  26903. </summary>
  26904. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  26905. <param name="state">null, not set</param>
  26906. <remarks>
  26907. <para>
  26908. This method is not used.
  26909. </para>
  26910. </remarks>
  26911. </member>
  26912. <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
  26913. <summary>
  26914. Writes a newline to the output
  26915. </summary>
  26916. <remarks>
  26917. <para>
  26918. Writes the system dependent line terminator to the output.
  26919. This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
  26920. </para>
  26921. <list type="definition">
  26922. <listheader>
  26923. <term>Option Value</term>
  26924. <description>Output</description>
  26925. </listheader>
  26926. <item>
  26927. <term>DOS</term>
  26928. <description>DOS or Windows line terminator <c>"\r\n"</c></description>
  26929. </item>
  26930. <item>
  26931. <term>UNIX</term>
  26932. <description>UNIX line terminator <c>"\n"</c></description>
  26933. </item>
  26934. </list>
  26935. </remarks>
  26936. <author>Nicko Cadell</author>
  26937. </member>
  26938. <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
  26939. <summary>
  26940. Initialize the converter
  26941. </summary>
  26942. <remarks>
  26943. <para>
  26944. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  26945. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
  26946. be called on this object after the configuration properties have
  26947. been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
  26948. object is in an undefined state and must not be used.
  26949. </para>
  26950. <para>
  26951. If any of the configuration properties are modified then
  26952. <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
  26953. </para>
  26954. </remarks>
  26955. </member>
  26956. <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
  26957. <summary>
  26958. Write the current process ID to the output
  26959. </summary>
  26960. <remarks>
  26961. <para>
  26962. Write the current process ID to the output writer
  26963. </para>
  26964. </remarks>
  26965. <author>Nicko Cadell</author>
  26966. </member>
  26967. <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26968. <summary>
  26969. Write the current process ID to the output
  26970. </summary>
  26971. <param name="writer">the writer to write to</param>
  26972. <param name="state">null, state is not set</param>
  26973. <remarks>
  26974. <para>
  26975. Write the current process ID to the output <paramref name="writer"/>.
  26976. </para>
  26977. </remarks>
  26978. </member>
  26979. <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
  26980. <summary>
  26981. The fully qualified type of the ProcessIdPatternConverter class.
  26982. </summary>
  26983. <remarks>
  26984. Used by the internal logger to record the Type of the
  26985. log message.
  26986. </remarks>
  26987. </member>
  26988. <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
  26989. <summary>
  26990. Property pattern converter
  26991. </summary>
  26992. <remarks>
  26993. <para>
  26994. This pattern converter reads the thread and global properties.
  26995. The thread properties take priority over global properties.
  26996. See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
  26997. thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
  26998. details of the global properties.
  26999. </para>
  27000. <para>
  27001. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  27002. lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  27003. then all properties will be dumped as a list of key value pairs.
  27004. </para>
  27005. </remarks>
  27006. <author>Nicko Cadell</author>
  27007. </member>
  27008. <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  27009. <summary>
  27010. Write the property value to the output
  27011. </summary>
  27012. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  27013. <param name="state">null, state is not set</param>
  27014. <remarks>
  27015. <para>
  27016. Writes out the value of a named property. The property name
  27017. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  27018. property.
  27019. </para>
  27020. <para>
  27021. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  27022. then all the properties are written as key value pairs.
  27023. </para>
  27024. </remarks>
  27025. </member>
  27026. <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
  27027. <summary>
  27028. A Pattern converter that generates a string of random characters
  27029. </summary>
  27030. <remarks>
  27031. <para>
  27032. The converter generates a string of random characters. By default
  27033. the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
  27034. to the string value of the length required.
  27035. </para>
  27036. <para>
  27037. The random characters in the string are limited to uppercase letters
  27038. and numbers only.
  27039. </para>
  27040. <para>
  27041. The random number generator used by this class is not cryptographically secure.
  27042. </para>
  27043. </remarks>
  27044. <author>Nicko Cadell</author>
  27045. </member>
  27046. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
  27047. <summary>
  27048. Shared random number generator
  27049. </summary>
  27050. </member>
  27051. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
  27052. <summary>
  27053. Length of random string to generate. Default length 4.
  27054. </summary>
  27055. </member>
  27056. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
  27057. <summary>
  27058. Initialize the converter options
  27059. </summary>
  27060. <remarks>
  27061. <para>
  27062. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  27063. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
  27064. be called on this object after the configuration properties have
  27065. been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
  27066. object is in an undefined state and must not be used.
  27067. </para>
  27068. <para>
  27069. If any of the configuration properties are modified then
  27070. <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
  27071. </para>
  27072. </remarks>
  27073. </member>
  27074. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  27075. <summary>
  27076. Write a randoim string to the output
  27077. </summary>
  27078. <param name="writer">the writer to write to</param>
  27079. <param name="state">null, state is not set</param>
  27080. <remarks>
  27081. <para>
  27082. Write a randoim string to the output <paramref name="writer"/>.
  27083. </para>
  27084. </remarks>
  27085. </member>
  27086. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
  27087. <summary>
  27088. The fully qualified type of the RandomStringPatternConverter class.
  27089. </summary>
  27090. <remarks>
  27091. Used by the internal logger to record the Type of the
  27092. log message.
  27093. </remarks>
  27094. </member>
  27095. <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
  27096. <summary>
  27097. Write the current threads username to the output
  27098. </summary>
  27099. <remarks>
  27100. <para>
  27101. Write the current threads username to the output writer
  27102. </para>
  27103. </remarks>
  27104. <author>Nicko Cadell</author>
  27105. </member>
  27106. <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  27107. <summary>
  27108. Write the current threads username to the output
  27109. </summary>
  27110. <param name="writer">the writer to write to</param>
  27111. <param name="state">null, state is not set</param>
  27112. <remarks>
  27113. <para>
  27114. Write the current threads username to the output <paramref name="writer"/>.
  27115. </para>
  27116. </remarks>
  27117. </member>
  27118. <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
  27119. <summary>
  27120. The fully qualified type of the UserNamePatternConverter class.
  27121. </summary>
  27122. <remarks>
  27123. Used by the internal logger to record the Type of the
  27124. log message.
  27125. </remarks>
  27126. </member>
  27127. <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
  27128. <summary>
  27129. Write the UTC date time to the output
  27130. </summary>
  27131. <remarks>
  27132. <para>
  27133. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  27134. the current date and time in Universal time.
  27135. </para>
  27136. <para>
  27137. See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
  27138. </para>
  27139. </remarks>
  27140. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  27141. <author>Nicko Cadell</author>
  27142. </member>
  27143. <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  27144. <summary>
  27145. Write the current date and time to the output
  27146. </summary>
  27147. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  27148. <param name="state">null, state is not set</param>
  27149. <remarks>
  27150. <para>
  27151. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  27152. for it to render it to the writer.
  27153. </para>
  27154. <para>
  27155. The date is in Universal time when it is rendered.
  27156. </para>
  27157. </remarks>
  27158. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  27159. </member>
  27160. <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
  27161. <summary>
  27162. The fully qualified type of the UtcDatePatternConverter class.
  27163. </summary>
  27164. <remarks>
  27165. Used by the internal logger to record the Type of the
  27166. log message.
  27167. </remarks>
  27168. </member>
  27169. <member name="T:log4net.Util.PropertiesDictionary">
  27170. <summary>
  27171. String keyed object map.
  27172. </summary>
  27173. <remarks>
  27174. <para>
  27175. While this collection is serializable only member
  27176. objects that are serializable will
  27177. be serialized along with this collection.
  27178. </para>
  27179. </remarks>
  27180. <author>Nicko Cadell</author>
  27181. <author>Gert Driesen</author>
  27182. </member>
  27183. <member name="M:log4net.Util.PropertiesDictionary.#ctor">
  27184. <summary>
  27185. Constructor
  27186. </summary>
  27187. <remarks>
  27188. <para>
  27189. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class.
  27190. </para>
  27191. </remarks>
  27192. </member>
  27193. <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  27194. <summary>
  27195. Constructor
  27196. </summary>
  27197. <param name="propertiesDictionary">properties to copy</param>
  27198. <remarks>
  27199. <para>
  27200. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class.
  27201. </para>
  27202. </remarks>
  27203. </member>
  27204. <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27205. <summary>
  27206. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class
  27207. with serialized data.
  27208. </summary>
  27209. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  27210. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  27211. <remarks>
  27212. <para>
  27213. Because this class is sealed the serialization constructor is private.
  27214. </para>
  27215. </remarks>
  27216. </member>
  27217. <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
  27218. <summary>
  27219. Gets or sets the value of the property with the specified key.
  27220. </summary>
  27221. <value>
  27222. The value of the property with the specified key.
  27223. </value>
  27224. <param name="key">The key of the property to get or set.</param>
  27225. <remarks>
  27226. <para>
  27227. The property value will only be serialized if it is serializable.
  27228. If it cannot be serialized it will be silently ignored if
  27229. a serialization operation is performed.
  27230. </para>
  27231. </remarks>
  27232. </member>
  27233. <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
  27234. <summary>
  27235. Remove the entry with the specified key from this dictionary
  27236. </summary>
  27237. <param name="key">the key for the entry to remove</param>
  27238. <remarks>
  27239. <para>
  27240. Remove the entry with the specified key from this dictionary
  27241. </para>
  27242. </remarks>
  27243. </member>
  27244. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  27245. <summary>
  27246. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  27247. </summary>
  27248. <returns>an enumerator</returns>
  27249. <remarks>
  27250. <para>
  27251. Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
  27252. </para>
  27253. </remarks>
  27254. </member>
  27255. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  27256. <summary>
  27257. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  27258. </summary>
  27259. <param name="key">the key to remove</param>
  27260. <remarks>
  27261. <para>
  27262. Remove the entry with the specified key from this dictionary
  27263. </para>
  27264. </remarks>
  27265. </member>
  27266. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  27267. <summary>
  27268. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  27269. </summary>
  27270. <param name="key">the key to lookup in the collection</param>
  27271. <returns><c>true</c> if the collection contains the specified key</returns>
  27272. <remarks>
  27273. <para>
  27274. Test if this collection contains a specified key.
  27275. </para>
  27276. </remarks>
  27277. </member>
  27278. <member name="M:log4net.Util.PropertiesDictionary.Clear">
  27279. <summary>
  27280. Remove all properties from the properties collection
  27281. </summary>
  27282. <remarks>
  27283. <para>
  27284. Remove all properties from the properties collection
  27285. </para>
  27286. </remarks>
  27287. </member>
  27288. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  27289. <summary>
  27290. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  27291. </summary>
  27292. <param name="key">the key</param>
  27293. <param name="value">the value to store for the key</param>
  27294. <remarks>
  27295. <para>
  27296. Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  27297. </para>
  27298. </remarks>
  27299. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  27300. </member>
  27301. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  27302. <summary>
  27303. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  27304. </summary>
  27305. <value>
  27306. <c>false</c>
  27307. </value>
  27308. <remarks>
  27309. <para>
  27310. This collection is modifiable. This property always
  27311. returns <c>false</c>.
  27312. </para>
  27313. </remarks>
  27314. </member>
  27315. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  27316. <summary>
  27317. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  27318. </summary>
  27319. <value>
  27320. The value for the key specified.
  27321. </value>
  27322. <remarks>
  27323. <para>
  27324. Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  27325. </para>
  27326. </remarks>
  27327. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  27328. </member>
  27329. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
  27330. <summary>
  27331. See <see cref="P:System.Collections.IDictionary.Values"/>
  27332. </summary>
  27333. </member>
  27334. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
  27335. <summary>
  27336. See <see cref="P:System.Collections.IDictionary.Keys"/>
  27337. </summary>
  27338. </member>
  27339. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  27340. <summary>
  27341. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  27342. </summary>
  27343. </member>
  27344. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  27345. <summary>
  27346. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  27347. </summary>
  27348. <param name="array"></param>
  27349. <param name="index"></param>
  27350. </member>
  27351. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  27352. <summary>
  27353. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  27354. </summary>
  27355. </member>
  27356. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
  27357. <summary>
  27358. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  27359. </summary>
  27360. </member>
  27361. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  27362. <summary>
  27363. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  27364. </summary>
  27365. </member>
  27366. <member name="T:log4net.Util.PropertyEntry">
  27367. <summary>
  27368. A class to hold the key and data for a property set in the config file
  27369. </summary>
  27370. <remarks>
  27371. <para>
  27372. A class to hold the key and data for a property set in the config file
  27373. </para>
  27374. </remarks>
  27375. </member>
  27376. <member name="P:log4net.Util.PropertyEntry.Key">
  27377. <summary>
  27378. Property Key
  27379. </summary>
  27380. <value>
  27381. Property Key
  27382. </value>
  27383. <remarks>
  27384. <para>
  27385. Property Key.
  27386. </para>
  27387. </remarks>
  27388. </member>
  27389. <member name="P:log4net.Util.PropertyEntry.Value">
  27390. <summary>
  27391. Property Value
  27392. </summary>
  27393. <value>
  27394. Property Value
  27395. </value>
  27396. <remarks>
  27397. <para>
  27398. Property Value.
  27399. </para>
  27400. </remarks>
  27401. </member>
  27402. <member name="M:log4net.Util.PropertyEntry.ToString">
  27403. <summary>
  27404. Override <c>Object.ToString</c> to return sensible debug info
  27405. </summary>
  27406. <returns>string info about this object</returns>
  27407. </member>
  27408. <member name="T:log4net.Util.ProtectCloseTextWriter">
  27409. <summary>
  27410. A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
  27411. </summary>
  27412. <remarks>
  27413. <para>
  27414. This writer is used in special cases where it is necessary
  27415. to protect a writer from being closed by a client.
  27416. </para>
  27417. </remarks>
  27418. <author>Nicko Cadell</author>
  27419. </member>
  27420. <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
  27421. <summary>
  27422. Constructor
  27423. </summary>
  27424. <param name="writer">the writer to actually write to</param>
  27425. <remarks>
  27426. <para>
  27427. Create a new ProtectCloseTextWriter using a writer
  27428. </para>
  27429. </remarks>
  27430. </member>
  27431. <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
  27432. <summary>
  27433. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  27434. </summary>
  27435. <param name="writer">the writer to attach to</param>
  27436. <remarks>
  27437. <para>
  27438. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  27439. </para>
  27440. </remarks>
  27441. </member>
  27442. <member name="M:log4net.Util.ProtectCloseTextWriter.Close">
  27443. <summary>
  27444. Does not close the underlying output writer.
  27445. </summary>
  27446. <remarks>
  27447. <para>
  27448. Does not close the underlying output writer.
  27449. This method does nothing.
  27450. </para>
  27451. </remarks>
  27452. </member>
  27453. <member name="T:log4net.Util.QuietTextWriter">
  27454. <summary>
  27455. <see cref="T:System.IO.TextWriter"/> that does not leak exceptions
  27456. </summary>
  27457. <remarks>
  27458. <para>
  27459. <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
  27460. Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
  27461. </para>
  27462. </remarks>
  27463. <author>Nicko Cadell</author>
  27464. <author>Gert Driesen</author>
  27465. </member>
  27466. <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  27467. <summary>
  27468. Constructor
  27469. </summary>
  27470. <param name="writer">the writer to actually write to</param>
  27471. <param name="errorHandler">the error handler to report error to</param>
  27472. <remarks>
  27473. <para>
  27474. Create a new QuietTextWriter using a writer and error handler
  27475. </para>
  27476. </remarks>
  27477. </member>
  27478. <member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
  27479. <summary>
  27480. Gets or sets the error handler that all errors are passed to.
  27481. </summary>
  27482. <value>
  27483. The error handler that all errors are passed to.
  27484. </value>
  27485. <remarks>
  27486. <para>
  27487. Gets or sets the error handler that all errors are passed to.
  27488. </para>
  27489. </remarks>
  27490. </member>
  27491. <member name="P:log4net.Util.QuietTextWriter.Closed">
  27492. <summary>
  27493. Gets a value indicating whether this writer is closed.
  27494. </summary>
  27495. <value>
  27496. <c>true</c> if this writer is closed, otherwise <c>false</c>.
  27497. </value>
  27498. <remarks>
  27499. <para>
  27500. Gets a value indicating whether this writer is closed.
  27501. </para>
  27502. </remarks>
  27503. </member>
  27504. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
  27505. <summary>
  27506. Writes a character to the underlying writer
  27507. </summary>
  27508. <param name="value">the char to write</param>
  27509. <remarks>
  27510. <para>
  27511. Writes a character to the underlying writer
  27512. </para>
  27513. </remarks>
  27514. </member>
  27515. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  27516. <summary>
  27517. Writes a buffer to the underlying writer
  27518. </summary>
  27519. <param name="buffer">the buffer to write</param>
  27520. <param name="index">the start index to write from</param>
  27521. <param name="count">the number of characters to write</param>
  27522. <remarks>
  27523. <para>
  27524. Writes a buffer to the underlying writer
  27525. </para>
  27526. </remarks>
  27527. </member>
  27528. <member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
  27529. <summary>
  27530. Writes a string to the output.
  27531. </summary>
  27532. <param name="value">The string data to write to the output.</param>
  27533. <remarks>
  27534. <para>
  27535. Writes a string to the output.
  27536. </para>
  27537. </remarks>
  27538. </member>
  27539. <member name="M:log4net.Util.QuietTextWriter.Close">
  27540. <summary>
  27541. Closes the underlying output writer.
  27542. </summary>
  27543. <remarks>
  27544. <para>
  27545. Closes the underlying output writer.
  27546. </para>
  27547. </remarks>
  27548. </member>
  27549. <member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
  27550. <summary>
  27551. The error handler instance to pass all errors to
  27552. </summary>
  27553. </member>
  27554. <member name="F:log4net.Util.QuietTextWriter.m_closed">
  27555. <summary>
  27556. Flag to indicate if this writer is closed
  27557. </summary>
  27558. </member>
  27559. <member name="T:log4net.Util.ReaderWriterLock">
  27560. <summary>
  27561. Defines a lock that supports single writers and multiple readers
  27562. </summary>
  27563. <remarks>
  27564. <para>
  27565. <c>ReaderWriterLock</c> is used to synchronize access to a resource.
  27566. At any given time, it allows either concurrent read access for
  27567. multiple threads, or write access for a single thread. In a
  27568. situation where a resource is changed infrequently, a
  27569. <c>ReaderWriterLock</c> provides better throughput than a simple
  27570. one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
  27571. </para>
  27572. <para>
  27573. If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
  27574. implementation then all readers and writers are serialized. Therefore
  27575. the caller must not rely on multiple simultaneous readers.
  27576. </para>
  27577. </remarks>
  27578. <author>Nicko Cadell</author>
  27579. </member>
  27580. <member name="M:log4net.Util.ReaderWriterLock.#ctor">
  27581. <summary>
  27582. Constructor
  27583. </summary>
  27584. <remarks>
  27585. <para>
  27586. Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock" /> class.
  27587. </para>
  27588. </remarks>
  27589. </member>
  27590. <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
  27591. <summary>
  27592. Acquires a reader lock
  27593. </summary>
  27594. <remarks>
  27595. <para>
  27596. <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
  27597. lock, or if at least one thread is waiting for the writer lock.
  27598. </para>
  27599. </remarks>
  27600. </member>
  27601. <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
  27602. <summary>
  27603. Decrements the lock count
  27604. </summary>
  27605. <remarks>
  27606. <para>
  27607. <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
  27608. reaches zero, the lock is released.
  27609. </para>
  27610. </remarks>
  27611. </member>
  27612. <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
  27613. <summary>
  27614. Acquires the writer lock
  27615. </summary>
  27616. <remarks>
  27617. <para>
  27618. This method blocks if another thread has a reader lock or writer lock.
  27619. </para>
  27620. </remarks>
  27621. </member>
  27622. <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
  27623. <summary>
  27624. Decrements the lock count on the writer lock
  27625. </summary>
  27626. <remarks>
  27627. <para>
  27628. ReleaseWriterLock decrements the writer lock count.
  27629. When the count reaches zero, the writer lock is released.
  27630. </para>
  27631. </remarks>
  27632. </member>
  27633. <member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
  27634. <summary>
  27635. String keyed object map that is read only.
  27636. </summary>
  27637. <remarks>
  27638. <para>
  27639. This collection is readonly and cannot be modified.
  27640. </para>
  27641. <para>
  27642. While this collection is serializable only member
  27643. objects that are serializable will
  27644. be serialized along with this collection.
  27645. </para>
  27646. </remarks>
  27647. <author>Nicko Cadell</author>
  27648. <author>Gert Driesen</author>
  27649. </member>
  27650. <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
  27651. <summary>
  27652. The Hashtable used to store the properties data
  27653. </summary>
  27654. </member>
  27655. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
  27656. <summary>
  27657. Constructor
  27658. </summary>
  27659. <remarks>
  27660. <para>
  27661. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class.
  27662. </para>
  27663. </remarks>
  27664. </member>
  27665. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  27666. <summary>
  27667. Copy Constructor
  27668. </summary>
  27669. <param name="propertiesDictionary">properties to copy</param>
  27670. <remarks>
  27671. <para>
  27672. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class.
  27673. </para>
  27674. </remarks>
  27675. </member>
  27676. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27677. <summary>
  27678. Deserialization constructor
  27679. </summary>
  27680. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  27681. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  27682. <remarks>
  27683. <para>
  27684. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class
  27685. with serialized data.
  27686. </para>
  27687. </remarks>
  27688. </member>
  27689. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
  27690. <summary>
  27691. Gets the key names.
  27692. </summary>
  27693. <returns>An array of all the keys.</returns>
  27694. <remarks>
  27695. <para>
  27696. Gets the key names.
  27697. </para>
  27698. </remarks>
  27699. </member>
  27700. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
  27701. <summary>
  27702. Gets or sets the value of the property with the specified key.
  27703. </summary>
  27704. <value>
  27705. The value of the property with the specified key.
  27706. </value>
  27707. <param name="key">The key of the property to get or set.</param>
  27708. <remarks>
  27709. <para>
  27710. The property value will only be serialized if it is serializable.
  27711. If it cannot be serialized it will be silently ignored if
  27712. a serialization operation is performed.
  27713. </para>
  27714. </remarks>
  27715. </member>
  27716. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
  27717. <summary>
  27718. Test if the dictionary contains a specified key
  27719. </summary>
  27720. <param name="key">the key to look for</param>
  27721. <returns>true if the dictionary contains the specified key</returns>
  27722. <remarks>
  27723. <para>
  27724. Test if the dictionary contains a specified key
  27725. </para>
  27726. </remarks>
  27727. </member>
  27728. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
  27729. <summary>
  27730. The hashtable used to store the properties
  27731. </summary>
  27732. <value>
  27733. The internal collection used to store the properties
  27734. </value>
  27735. <remarks>
  27736. <para>
  27737. The hashtable used to store the properties
  27738. </para>
  27739. </remarks>
  27740. </member>
  27741. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27742. <summary>
  27743. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  27744. </summary>
  27745. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
  27746. <param name="context">The destination for this serialization.</param>
  27747. <remarks>
  27748. <para>
  27749. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  27750. </para>
  27751. </remarks>
  27752. </member>
  27753. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  27754. <summary>
  27755. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  27756. </summary>
  27757. </member>
  27758. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  27759. <summary>
  27760. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  27761. </summary>
  27762. <param name="key"></param>
  27763. </member>
  27764. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  27765. <summary>
  27766. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  27767. </summary>
  27768. <param name="key"></param>
  27769. <returns></returns>
  27770. </member>
  27771. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
  27772. <summary>
  27773. Remove all properties from the properties collection
  27774. </summary>
  27775. </member>
  27776. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  27777. <summary>
  27778. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  27779. </summary>
  27780. <param name="key"></param>
  27781. <param name="value"></param>
  27782. </member>
  27783. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  27784. <summary>
  27785. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  27786. </summary>
  27787. </member>
  27788. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  27789. <summary>
  27790. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  27791. </summary>
  27792. </member>
  27793. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
  27794. <summary>
  27795. See <see cref="P:System.Collections.IDictionary.Values"/>
  27796. </summary>
  27797. </member>
  27798. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
  27799. <summary>
  27800. See <see cref="P:System.Collections.IDictionary.Keys"/>
  27801. </summary>
  27802. </member>
  27803. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  27804. <summary>
  27805. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  27806. </summary>
  27807. </member>
  27808. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  27809. <summary>
  27810. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  27811. </summary>
  27812. <param name="array"></param>
  27813. <param name="index"></param>
  27814. </member>
  27815. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  27816. <summary>
  27817. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  27818. </summary>
  27819. </member>
  27820. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
  27821. <summary>
  27822. The number of properties in this collection
  27823. </summary>
  27824. </member>
  27825. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
  27826. <summary>
  27827. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  27828. </summary>
  27829. </member>
  27830. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  27831. <summary>
  27832. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  27833. </summary>
  27834. </member>
  27835. <member name="T:log4net.Util.ReusableStringWriter">
  27836. <summary>
  27837. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
  27838. </summary>
  27839. <remarks>
  27840. <para>
  27841. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
  27842. This uses a single buffer for string operations.
  27843. </para>
  27844. </remarks>
  27845. <author>Nicko Cadell</author>
  27846. </member>
  27847. <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
  27848. <summary>
  27849. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  27850. </summary>
  27851. <param name="formatProvider">the format provider to use</param>
  27852. <remarks>
  27853. <para>
  27854. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  27855. </para>
  27856. </remarks>
  27857. </member>
  27858. <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
  27859. <summary>
  27860. Override Dispose to prevent closing of writer
  27861. </summary>
  27862. <param name="disposing">flag</param>
  27863. <remarks>
  27864. <para>
  27865. Override Dispose to prevent closing of writer
  27866. </para>
  27867. </remarks>
  27868. </member>
  27869. <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
  27870. <summary>
  27871. Reset this string writer so that it can be reused.
  27872. </summary>
  27873. <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
  27874. <param name="defaultSize">the default size to make the buffer</param>
  27875. <remarks>
  27876. <para>
  27877. Reset this string writer so that it can be reused.
  27878. The internal buffers are cleared and reset.
  27879. </para>
  27880. </remarks>
  27881. </member>
  27882. <member name="T:log4net.Util.SystemInfo">
  27883. <summary>
  27884. Utility class for system specific information.
  27885. </summary>
  27886. <remarks>
  27887. <para>
  27888. Utility class of static methods for system specific information.
  27889. </para>
  27890. </remarks>
  27891. <author>Nicko Cadell</author>
  27892. <author>Gert Driesen</author>
  27893. <author>Alexey Solofnenko</author>
  27894. </member>
  27895. <member name="M:log4net.Util.SystemInfo.#ctor">
  27896. <summary>
  27897. Private constructor to prevent instances.
  27898. </summary>
  27899. <remarks>
  27900. <para>
  27901. Only static methods are exposed from this type.
  27902. </para>
  27903. </remarks>
  27904. </member>
  27905. <member name="M:log4net.Util.SystemInfo.#cctor">
  27906. <summary>
  27907. Initialize default values for private static fields.
  27908. </summary>
  27909. <remarks>
  27910. <para>
  27911. Only static methods are exposed from this type.
  27912. </para>
  27913. </remarks>
  27914. </member>
  27915. <member name="P:log4net.Util.SystemInfo.NewLine">
  27916. <summary>
  27917. Gets the system dependent line terminator.
  27918. </summary>
  27919. <value>
  27920. The system dependent line terminator.
  27921. </value>
  27922. <remarks>
  27923. <para>
  27924. Gets the system dependent line terminator.
  27925. </para>
  27926. </remarks>
  27927. </member>
  27928. <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
  27929. <summary>
  27930. Gets the base directory for this <see cref="!:AppDomain"/>.
  27931. </summary>
  27932. <value>The base directory path for the current <see cref="!:AppDomain"/>.</value>
  27933. <remarks>
  27934. <para>
  27935. Gets the base directory for this <see cref="!:AppDomain"/>.
  27936. </para>
  27937. <para>
  27938. The value returned may be either a local file path or a URI.
  27939. </para>
  27940. </remarks>
  27941. </member>
  27942. <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
  27943. <summary>
  27944. Gets the path to the configuration file for the current <see cref="!:AppDomain"/>.
  27945. </summary>
  27946. <value>The path to the configuration file for the current <see cref="!:AppDomain"/>.</value>
  27947. <remarks>
  27948. <para>
  27949. The .NET Compact Framework 1.0 does not have a concept of a configuration
  27950. file. For this runtime, we use the entry assembly location as the root for
  27951. the configuration file name.
  27952. </para>
  27953. <para>
  27954. The value returned may be either a local file path or a URI.
  27955. </para>
  27956. </remarks>
  27957. </member>
  27958. <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
  27959. <summary>
  27960. Gets the path to the file that first executed in the current <see cref="!:AppDomain"/>.
  27961. </summary>
  27962. <value>The path to the entry assembly.</value>
  27963. <remarks>
  27964. <para>
  27965. Gets the path to the file that first executed in the current <see cref="!:AppDomain"/>.
  27966. </para>
  27967. </remarks>
  27968. </member>
  27969. <member name="P:log4net.Util.SystemInfo.CurrentThreadId">
  27970. <summary>
  27971. Gets the ID of the current thread.
  27972. </summary>
  27973. <value>The ID of the current thread.</value>
  27974. <remarks>
  27975. <para>
  27976. On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
  27977. is used to obtain the thread ID for the current thread. This is the
  27978. operating system ID for the thread.
  27979. </para>
  27980. <para>
  27981. On the .NET Compact Framework 1.0 it is not possible to get the
  27982. operating system thread ID for the current thread. The native method
  27983. <c>GetCurrentThreadId</c> is implemented inline in a header file
  27984. and cannot be called.
  27985. </para>
  27986. <para>
  27987. On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
  27988. gives a stable id unrelated to the operating system thread ID which may
  27989. change if the runtime is using fibers.
  27990. </para>
  27991. </remarks>
  27992. </member>
  27993. <member name="P:log4net.Util.SystemInfo.HostName">
  27994. <summary>
  27995. Get the host name or machine name for the current machine
  27996. </summary>
  27997. <value>
  27998. The hostname or machine name
  27999. </value>
  28000. <remarks>
  28001. <para>
  28002. Get the host name or machine name for the current machine
  28003. </para>
  28004. <para>
  28005. The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
  28006. the machine name (<c>Environment.MachineName</c>) for
  28007. the current machine, or if neither of these are available
  28008. then <c>NOT AVAILABLE</c> is returned.
  28009. </para>
  28010. </remarks>
  28011. </member>
  28012. <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
  28013. <summary>
  28014. Get this application's friendly name
  28015. </summary>
  28016. <value>
  28017. The friendly name of this application as a string
  28018. </value>
  28019. <remarks>
  28020. <para>
  28021. If available the name of the application is retrieved from
  28022. the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
  28023. </para>
  28024. <para>
  28025. Otherwise the file name of the entry assembly is used.
  28026. </para>
  28027. </remarks>
  28028. </member>
  28029. <member name="P:log4net.Util.SystemInfo.ProcessStartTime">
  28030. <summary>
  28031. Get the start time for the current process.
  28032. </summary>
  28033. <remarks>
  28034. <para>
  28035. This is the time at which the log4net library was loaded into the
  28036. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  28037. this is not the start time for the current process.
  28038. </para>
  28039. <para>
  28040. The log4net library should be loaded by an application early during its
  28041. startup, therefore this start time should be a good approximation for
  28042. the actual start time.
  28043. </para>
  28044. <para>
  28045. Note that AppDomains may be loaded and unloaded within the
  28046. same process without the process terminating, however this start time
  28047. will be set per AppDomain.
  28048. </para>
  28049. </remarks>
  28050. </member>
  28051. <member name="P:log4net.Util.SystemInfo.ProcessStartTimeUtc">
  28052. <summary>
  28053. Get the UTC start time for the current process.
  28054. </summary>
  28055. <remarks>
  28056. <para>
  28057. This is the UTC time at which the log4net library was loaded into the
  28058. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  28059. this is not the start time for the current process.
  28060. </para>
  28061. <para>
  28062. The log4net library should be loaded by an application early during its
  28063. startup, therefore this start time should be a good approximation for
  28064. the actual start time.
  28065. </para>
  28066. <para>
  28067. Note that AppDomains may be loaded and unloaded within the
  28068. same process without the process terminating, however this start time
  28069. will be set per AppDomain.
  28070. </para>
  28071. </remarks>
  28072. </member>
  28073. <member name="P:log4net.Util.SystemInfo.NullText">
  28074. <summary>
  28075. Text to output when a <c>null</c> is encountered.
  28076. </summary>
  28077. <remarks>
  28078. <para>
  28079. Use this value to indicate a <c>null</c> has been encountered while
  28080. outputting a string representation of an item.
  28081. </para>
  28082. <para>
  28083. The default value is <c>(null)</c>. This value can be overridden by specifying
  28084. a value for the <c>log4net.NullText</c> appSetting in the application's
  28085. .config file.
  28086. </para>
  28087. </remarks>
  28088. </member>
  28089. <member name="P:log4net.Util.SystemInfo.NotAvailableText">
  28090. <summary>
  28091. Text to output when an unsupported feature is requested.
  28092. </summary>
  28093. <remarks>
  28094. <para>
  28095. Use this value when an unsupported feature is requested.
  28096. </para>
  28097. <para>
  28098. The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
  28099. a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
  28100. .config file.
  28101. </para>
  28102. </remarks>
  28103. </member>
  28104. <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
  28105. <summary>
  28106. Gets the assembly location path for the specified assembly.
  28107. </summary>
  28108. <param name="myAssembly">The assembly to get the location for.</param>
  28109. <returns>The location of the assembly.</returns>
  28110. <remarks>
  28111. <para>
  28112. This method does not guarantee to return the correct path
  28113. to the assembly. If only tries to give an indication as to
  28114. where the assembly was loaded from.
  28115. </para>
  28116. </remarks>
  28117. </member>
  28118. <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
  28119. <summary>
  28120. Gets the fully qualified name of the <see cref="T:System.Type" />, including
  28121. the name of the assembly from which the <see cref="T:System.Type" /> was
  28122. loaded.
  28123. </summary>
  28124. <param name="type">The <see cref="T:System.Type" /> to get the fully qualified name for.</param>
  28125. <returns>The fully qualified name for the <see cref="T:System.Type" />.</returns>
  28126. <remarks>
  28127. <para>
  28128. This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
  28129. but this method works on the .NET Compact Framework 1.0 as well as
  28130. the full .NET runtime.
  28131. </para>
  28132. </remarks>
  28133. </member>
  28134. <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
  28135. <summary>
  28136. Gets the short name of the <see cref="T:System.Reflection.Assembly" />.
  28137. </summary>
  28138. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly" /> to get the name for.</param>
  28139. <returns>The short name of the <see cref="T:System.Reflection.Assembly" />.</returns>
  28140. <remarks>
  28141. <para>
  28142. The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName" />
  28143. without the version, culture, or public key. i.e. it is just the
  28144. assembly's file name without the extension.
  28145. </para>
  28146. <para>
  28147. Use this rather than <c>Assembly.GetName().Name</c> because that
  28148. is not available on the Compact Framework.
  28149. </para>
  28150. <para>
  28151. Because of a FileIOPermission security demand we cannot do
  28152. the obvious Assembly.GetName().Name. We are allowed to get
  28153. the <see cref="P:System.Reflection.Assembly.FullName" /> of the assembly so we
  28154. start from there and strip out just the assembly name.
  28155. </para>
  28156. </remarks>
  28157. </member>
  28158. <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
  28159. <summary>
  28160. Gets the file name portion of the <see cref="T:System.Reflection.Assembly" />, including the extension.
  28161. </summary>
  28162. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly" /> to get the file name for.</param>
  28163. <returns>The file name of the assembly.</returns>
  28164. <remarks>
  28165. <para>
  28166. Gets the file name portion of the <see cref="T:System.Reflection.Assembly" />, including the extension.
  28167. </para>
  28168. </remarks>
  28169. </member>
  28170. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
  28171. <summary>
  28172. Loads the type specified in the type string.
  28173. </summary>
  28174. <param name="relativeType">A sibling type to use to load the type.</param>
  28175. <param name="typeName">The name of the type to load.</param>
  28176. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  28177. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  28178. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  28179. <remarks>
  28180. <para>
  28181. If the type name is fully qualified, i.e. if contains an assembly name in
  28182. the type name, the type will be loaded from the system using
  28183. <see cref="M:Type.GetType(string,bool)"/>.
  28184. </para>
  28185. <para>
  28186. If the type name is not fully qualified, it will be loaded from the assembly
  28187. containing the specified relative type. If the type is not found in the assembly
  28188. then all the loaded assemblies will be searched for the type.
  28189. </para>
  28190. </remarks>
  28191. </member>
  28192. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
  28193. <summary>
  28194. Loads the type specified in the type string.
  28195. </summary>
  28196. <param name="relativeAssembly">An assembly to load the type from.</param>
  28197. <param name="typeName">The name of the type to load.</param>
  28198. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  28199. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  28200. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  28201. <remarks>
  28202. <para>
  28203. If the type name is fully qualified, i.e. if contains an assembly name in
  28204. the type name, the type will be loaded from the system using
  28205. <see cref="M:Type.GetType(string,bool)"/>.
  28206. </para>
  28207. <para>
  28208. If the type name is not fully qualified it will be loaded from the specified
  28209. assembly. If the type is not found in the assembly then all the loaded assemblies
  28210. will be searched for the type.
  28211. </para>
  28212. </remarks>
  28213. </member>
  28214. <member name="M:log4net.Util.SystemInfo.NewGuid">
  28215. <summary>
  28216. Generate a new guid
  28217. </summary>
  28218. <returns>A new Guid</returns>
  28219. <remarks>
  28220. <para>
  28221. Generate a new guid
  28222. </para>
  28223. </remarks>
  28224. </member>
  28225. <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
  28226. <summary>
  28227. Create an <see cref="T:System.ArgumentOutOfRangeException"/>
  28228. </summary>
  28229. <param name="parameterName">The name of the parameter that caused the exception</param>
  28230. <param name="actualValue">The value of the argument that causes this exception</param>
  28231. <param name="message">The message that describes the error</param>
  28232. <returns>the ArgumentOutOfRangeException object</returns>
  28233. <remarks>
  28234. <para>
  28235. Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
  28236. with a specified error message, the parameter name, and the value
  28237. of the argument.
  28238. </para>
  28239. <para>
  28240. The Compact Framework does not support the 3 parameter constructor for the
  28241. <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
  28242. implementation that works for all platforms.
  28243. </para>
  28244. </remarks>
  28245. </member>
  28246. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
  28247. <summary>
  28248. Parse a string into an <see cref="T:System.Int32"/> value
  28249. </summary>
  28250. <param name="s">the string to parse</param>
  28251. <param name="val">out param where the parsed value is placed</param>
  28252. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28253. <remarks>
  28254. <para>
  28255. Attempts to parse the string into an integer. If the string cannot
  28256. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28257. </para>
  28258. </remarks>
  28259. </member>
  28260. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
  28261. <summary>
  28262. Parse a string into an <see cref="T:System.Int64"/> value
  28263. </summary>
  28264. <param name="s">the string to parse</param>
  28265. <param name="val">out param where the parsed value is placed</param>
  28266. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28267. <remarks>
  28268. <para>
  28269. Attempts to parse the string into an integer. If the string cannot
  28270. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28271. </para>
  28272. </remarks>
  28273. </member>
  28274. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
  28275. <summary>
  28276. Parse a string into an <see cref="T:System.Int16"/> value
  28277. </summary>
  28278. <param name="s">the string to parse</param>
  28279. <param name="val">out param where the parsed value is placed</param>
  28280. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28281. <remarks>
  28282. <para>
  28283. Attempts to parse the string into an integer. If the string cannot
  28284. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28285. </para>
  28286. </remarks>
  28287. </member>
  28288. <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
  28289. <summary>
  28290. Lookup an application setting
  28291. </summary>
  28292. <param name="key">the application settings key to lookup</param>
  28293. <returns>the value for the key, or <c>null</c></returns>
  28294. <remarks>
  28295. <para>
  28296. Configuration APIs are not supported under the Compact Framework
  28297. </para>
  28298. </remarks>
  28299. </member>
  28300. <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
  28301. <summary>
  28302. Convert a path into a fully qualified local file path.
  28303. </summary>
  28304. <param name="path">The path to convert.</param>
  28305. <returns>The fully qualified path.</returns>
  28306. <remarks>
  28307. <para>
  28308. Converts the path specified to a fully
  28309. qualified path. If the path is relative it is
  28310. taken as relative from the application base
  28311. directory.
  28312. </para>
  28313. <para>
  28314. The path specified must be a local file path, a URI is not supported.
  28315. </para>
  28316. </remarks>
  28317. </member>
  28318. <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
  28319. <summary>
  28320. Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
  28321. </summary>
  28322. <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
  28323. <remarks>
  28324. <para>
  28325. The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
  28326. </para>
  28327. </remarks>
  28328. </member>
  28329. <member name="M:log4net.Util.SystemInfo.EqualsIgnoringCase(System.String,System.String)">
  28330. <summary>
  28331. Tests two strings for equality, the ignoring case.
  28332. </summary>
  28333. <remarks>
  28334. If the platform permits, culture information is ignored completely (ordinal comparison).
  28335. The aim of this method is to provide a fast comparison that deals with <c>null</c> and ignores different casing.
  28336. It is not supposed to deal with various, culture-specific habits.
  28337. Use it to compare against pure ASCII constants, like keywords etc.
  28338. </remarks>
  28339. <param name="a">The one string.</param>
  28340. <param name="b">The other string.</param>
  28341. <returns><c>true</c> if the strings are equal, <c>false</c> otherwise.</returns>
  28342. </member>
  28343. <member name="F:log4net.Util.SystemInfo.EmptyTypes">
  28344. <summary>
  28345. Gets an empty array of types.
  28346. </summary>
  28347. <remarks>
  28348. <para>
  28349. The <c>Type.EmptyTypes</c> field is not available on
  28350. the .NET Compact Framework 1.0.
  28351. </para>
  28352. </remarks>
  28353. </member>
  28354. <member name="F:log4net.Util.SystemInfo.declaringType">
  28355. <summary>
  28356. The fully qualified type of the SystemInfo class.
  28357. </summary>
  28358. <remarks>
  28359. Used by the internal logger to record the Type of the
  28360. log message.
  28361. </remarks>
  28362. </member>
  28363. <member name="F:log4net.Util.SystemInfo.s_hostName">
  28364. <summary>
  28365. Cache the host name for the current machine
  28366. </summary>
  28367. </member>
  28368. <member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
  28369. <summary>
  28370. Cache the application friendly name
  28371. </summary>
  28372. </member>
  28373. <member name="F:log4net.Util.SystemInfo.s_nullText">
  28374. <summary>
  28375. Text to output when a <c>null</c> is encountered.
  28376. </summary>
  28377. </member>
  28378. <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
  28379. <summary>
  28380. Text to output when an unsupported feature is requested.
  28381. </summary>
  28382. </member>
  28383. <member name="F:log4net.Util.SystemInfo.s_processStartTimeUtc">
  28384. <summary>
  28385. Start time for the current process.
  28386. </summary>
  28387. </member>
  28388. <member name="T:log4net.Util.SystemStringFormat">
  28389. <summary>
  28390. Utility class that represents a format string.
  28391. </summary>
  28392. <remarks>
  28393. <para>
  28394. Utility class that represents a format string.
  28395. </para>
  28396. </remarks>
  28397. <author>Nicko Cadell</author>
  28398. </member>
  28399. <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
  28400. <summary>
  28401. Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
  28402. </summary>
  28403. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  28404. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  28405. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  28406. </member>
  28407. <member name="M:log4net.Util.SystemStringFormat.ToString">
  28408. <summary>
  28409. Format the string and arguments
  28410. </summary>
  28411. <returns>the formatted string</returns>
  28412. </member>
  28413. <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  28414. <summary>
  28415. Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
  28416. of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
  28417. A specified parameter supplies culture-specific formatting information.
  28418. </summary>
  28419. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  28420. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  28421. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  28422. <returns>
  28423. A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
  28424. equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
  28425. </returns>
  28426. <remarks>
  28427. <para>
  28428. This method does not throw exceptions. If an exception thrown while formatting the result the
  28429. exception and arguments are returned in the result string.
  28430. </para>
  28431. </remarks>
  28432. </member>
  28433. <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
  28434. <summary>
  28435. Process an error during StringFormat
  28436. </summary>
  28437. </member>
  28438. <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
  28439. <summary>
  28440. Dump the contents of an array into a string builder
  28441. </summary>
  28442. </member>
  28443. <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
  28444. <summary>
  28445. Dump an object to a string
  28446. </summary>
  28447. </member>
  28448. <member name="F:log4net.Util.SystemStringFormat.declaringType">
  28449. <summary>
  28450. The fully qualified type of the SystemStringFormat class.
  28451. </summary>
  28452. <remarks>
  28453. Used by the internal logger to record the Type of the
  28454. log message.
  28455. </remarks>
  28456. </member>
  28457. <member name="T:log4net.Util.TextWriterAdapter">
  28458. <summary>
  28459. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  28460. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  28461. </summary>
  28462. <remarks>
  28463. <para>
  28464. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  28465. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  28466. </para>
  28467. </remarks>
  28468. <author>Nicko Cadell</author>
  28469. </member>
  28470. <member name="F:log4net.Util.TextWriterAdapter.m_writer">
  28471. <summary>
  28472. The writer to forward messages to
  28473. </summary>
  28474. </member>
  28475. <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
  28476. <summary>
  28477. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  28478. messages to a <see cref="T:System.IO.TextWriter"/>.
  28479. </summary>
  28480. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
  28481. <remarks>
  28482. <para>
  28483. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  28484. messages to a <see cref="T:System.IO.TextWriter"/>.
  28485. </para>
  28486. </remarks>
  28487. </member>
  28488. <member name="P:log4net.Util.TextWriterAdapter.Writer">
  28489. <summary>
  28490. Gets or sets the underlying <see cref="T:System.IO.TextWriter" />.
  28491. </summary>
  28492. <value>
  28493. The underlying <see cref="T:System.IO.TextWriter" />.
  28494. </value>
  28495. <remarks>
  28496. <para>
  28497. Gets or sets the underlying <see cref="T:System.IO.TextWriter" />.
  28498. </para>
  28499. </remarks>
  28500. </member>
  28501. <member name="P:log4net.Util.TextWriterAdapter.Encoding">
  28502. <summary>
  28503. The Encoding in which the output is written
  28504. </summary>
  28505. <value>
  28506. The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
  28507. </value>
  28508. <remarks>
  28509. <para>
  28510. The Encoding in which the output is written
  28511. </para>
  28512. </remarks>
  28513. </member>
  28514. <member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
  28515. <summary>
  28516. Gets an object that controls formatting
  28517. </summary>
  28518. <value>
  28519. The format provider
  28520. </value>
  28521. <remarks>
  28522. <para>
  28523. Gets an object that controls formatting
  28524. </para>
  28525. </remarks>
  28526. </member>
  28527. <member name="P:log4net.Util.TextWriterAdapter.NewLine">
  28528. <summary>
  28529. Gets or sets the line terminator string used by the TextWriter
  28530. </summary>
  28531. <value>
  28532. The line terminator to use
  28533. </value>
  28534. <remarks>
  28535. <para>
  28536. Gets or sets the line terminator string used by the TextWriter
  28537. </para>
  28538. </remarks>
  28539. </member>
  28540. <member name="M:log4net.Util.TextWriterAdapter.Close">
  28541. <summary>
  28542. Closes the writer and releases any system resources associated with the writer
  28543. </summary>
  28544. <remarks>
  28545. <para>
  28546. </para>
  28547. </remarks>
  28548. </member>
  28549. <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
  28550. <summary>
  28551. Dispose this writer
  28552. </summary>
  28553. <param name="disposing">flag indicating if we are being disposed</param>
  28554. <remarks>
  28555. <para>
  28556. Dispose this writer
  28557. </para>
  28558. </remarks>
  28559. </member>
  28560. <member name="M:log4net.Util.TextWriterAdapter.Flush">
  28561. <summary>
  28562. Flushes any buffered output
  28563. </summary>
  28564. <remarks>
  28565. <para>
  28566. Clears all buffers for the writer and causes any buffered data to be written
  28567. to the underlying device
  28568. </para>
  28569. </remarks>
  28570. </member>
  28571. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
  28572. <summary>
  28573. Writes a character to the wrapped TextWriter
  28574. </summary>
  28575. <param name="value">the value to write to the TextWriter</param>
  28576. <remarks>
  28577. <para>
  28578. Writes a character to the wrapped TextWriter
  28579. </para>
  28580. </remarks>
  28581. </member>
  28582. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
  28583. <summary>
  28584. Writes a character buffer to the wrapped TextWriter
  28585. </summary>
  28586. <param name="buffer">the data buffer</param>
  28587. <param name="index">the start index</param>
  28588. <param name="count">the number of characters to write</param>
  28589. <remarks>
  28590. <para>
  28591. Writes a character buffer to the wrapped TextWriter
  28592. </para>
  28593. </remarks>
  28594. </member>
  28595. <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
  28596. <summary>
  28597. Writes a string to the wrapped TextWriter
  28598. </summary>
  28599. <param name="value">the value to write to the TextWriter</param>
  28600. <remarks>
  28601. <para>
  28602. Writes a string to the wrapped TextWriter
  28603. </para>
  28604. </remarks>
  28605. </member>
  28606. <member name="T:log4net.Util.ThreadContextProperties">
  28607. <summary>
  28608. Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
  28609. </summary>
  28610. <remarks>
  28611. <para>
  28612. Class implements a collection of properties that is specific to each thread.
  28613. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  28614. </para>
  28615. </remarks>
  28616. <author>Nicko Cadell</author>
  28617. </member>
  28618. <member name="F:log4net.Util.ThreadContextProperties._dictionary">
  28619. <summary>
  28620. Each thread will automatically have its instance.
  28621. </summary>
  28622. </member>
  28623. <member name="M:log4net.Util.ThreadContextProperties.#ctor">
  28624. <summary>
  28625. Internal constructor
  28626. </summary>
  28627. <remarks>
  28628. <para>
  28629. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties" /> class.
  28630. </para>
  28631. </remarks>
  28632. </member>
  28633. <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
  28634. <summary>
  28635. Gets or sets the value of a property
  28636. </summary>
  28637. <value>
  28638. The value for the property with the specified key
  28639. </value>
  28640. <remarks>
  28641. <para>
  28642. Gets or sets the value of a property
  28643. </para>
  28644. </remarks>
  28645. </member>
  28646. <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
  28647. <summary>
  28648. Remove a property
  28649. </summary>
  28650. <param name="key">the key for the entry to remove</param>
  28651. <remarks>
  28652. <para>
  28653. Remove a property
  28654. </para>
  28655. </remarks>
  28656. </member>
  28657. <member name="M:log4net.Util.ThreadContextProperties.GetKeys">
  28658. <summary>
  28659. Get the keys stored in the properties.
  28660. </summary>
  28661. <para>
  28662. Gets the keys stored in the properties.
  28663. </para>
  28664. <returns>a set of the defined keys</returns>
  28665. </member>
  28666. <member name="M:log4net.Util.ThreadContextProperties.Clear">
  28667. <summary>
  28668. Clear all properties
  28669. </summary>
  28670. <remarks>
  28671. <para>
  28672. Clear all properties
  28673. </para>
  28674. </remarks>
  28675. </member>
  28676. <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
  28677. <summary>
  28678. Get the <c>PropertiesDictionary</c> for this thread.
  28679. </summary>
  28680. <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
  28681. <returns>the properties for this thread</returns>
  28682. <remarks>
  28683. <para>
  28684. The collection returned is only to be used on the calling thread. If the
  28685. caller needs to share the collection between different threads then the
  28686. caller must clone the collection before doing so.
  28687. </para>
  28688. </remarks>
  28689. </member>
  28690. <member name="T:log4net.Util.ThreadContextStack">
  28691. <summary>
  28692. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  28693. </summary>
  28694. <remarks>
  28695. <para>
  28696. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  28697. </para>
  28698. </remarks>
  28699. <author>Nicko Cadell</author>
  28700. </member>
  28701. <member name="F:log4net.Util.ThreadContextStack.m_stack">
  28702. <summary>
  28703. The stack store.
  28704. </summary>
  28705. </member>
  28706. <member name="M:log4net.Util.ThreadContextStack.#ctor">
  28707. <summary>
  28708. Internal constructor
  28709. </summary>
  28710. <remarks>
  28711. <para>
  28712. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack" /> class.
  28713. </para>
  28714. </remarks>
  28715. </member>
  28716. <member name="P:log4net.Util.ThreadContextStack.Count">
  28717. <summary>
  28718. The number of messages in the stack
  28719. </summary>
  28720. <value>
  28721. The current number of messages in the stack
  28722. </value>
  28723. <remarks>
  28724. <para>
  28725. The current number of messages in the stack. That is
  28726. the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
  28727. minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
  28728. </para>
  28729. </remarks>
  28730. </member>
  28731. <member name="M:log4net.Util.ThreadContextStack.Clear">
  28732. <summary>
  28733. Clears all the contextual information held in this stack.
  28734. </summary>
  28735. <remarks>
  28736. <para>
  28737. Clears all the contextual information held in this stack.
  28738. Only call this if you think that this tread is being reused after
  28739. a previous call execution which may not have completed correctly.
  28740. You do not need to use this method if you always guarantee to call
  28741. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  28742. returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  28743. for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  28744. syntax.
  28745. </para>
  28746. </remarks>
  28747. </member>
  28748. <member name="M:log4net.Util.ThreadContextStack.Pop">
  28749. <summary>
  28750. Removes the top context from this stack.
  28751. </summary>
  28752. <returns>The message in the context that was removed from the top of this stack.</returns>
  28753. <remarks>
  28754. <para>
  28755. Remove the top context from this stack, and return
  28756. it to the caller. If this stack is empty then an
  28757. empty string (not <see langword="null"/>) is returned.
  28758. </para>
  28759. </remarks>
  28760. </member>
  28761. <member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
  28762. <summary>
  28763. Pushes a new context message into this stack.
  28764. </summary>
  28765. <param name="message">The new context message.</param>
  28766. <returns>
  28767. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  28768. </returns>
  28769. <remarks>
  28770. <para>
  28771. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  28772. is returned that can be used to clean up this stack. This
  28773. can be easily combined with the <c>using</c> keyword to scope the
  28774. context.
  28775. </para>
  28776. </remarks>
  28777. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  28778. <code lang="C#">
  28779. using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
  28780. {
  28781. log.Warn("This should have an ThreadContext Stack message");
  28782. }
  28783. </code>
  28784. </example>
  28785. </member>
  28786. <member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
  28787. <summary>
  28788. Gets the current context information for this stack.
  28789. </summary>
  28790. <returns>The current context information.</returns>
  28791. </member>
  28792. <member name="P:log4net.Util.ThreadContextStack.InternalStack">
  28793. <summary>
  28794. Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
  28795. </summary>
  28796. <value>The internal storage stack</value>
  28797. <remarks>
  28798. <para>
  28799. This property is provided only to support backward compatability
  28800. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  28801. be modified.
  28802. </para>
  28803. </remarks>
  28804. </member>
  28805. <member name="M:log4net.Util.ThreadContextStack.ToString">
  28806. <summary>
  28807. Gets the current context information for this stack.
  28808. </summary>
  28809. <returns>Gets the current context information</returns>
  28810. <remarks>
  28811. <para>
  28812. Gets the current context information for this stack.
  28813. </para>
  28814. </remarks>
  28815. </member>
  28816. <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  28817. <summary>
  28818. Get a portable version of this object
  28819. </summary>
  28820. <returns>the portable instance of this object</returns>
  28821. <remarks>
  28822. <para>
  28823. Get a cross thread portable version of this object
  28824. </para>
  28825. </remarks>
  28826. </member>
  28827. <member name="T:log4net.Util.ThreadContextStack.StackFrame">
  28828. <summary>
  28829. Inner class used to represent a single context frame in the stack.
  28830. </summary>
  28831. <remarks>
  28832. <para>
  28833. Inner class used to represent a single context frame in the stack.
  28834. </para>
  28835. </remarks>
  28836. </member>
  28837. <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
  28838. <summary>
  28839. Constructor
  28840. </summary>
  28841. <param name="message">The message for this context.</param>
  28842. <param name="parent">The parent context in the chain.</param>
  28843. <remarks>
  28844. <para>
  28845. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame" /> class
  28846. with the specified message and parent context.
  28847. </para>
  28848. </remarks>
  28849. </member>
  28850. <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
  28851. <summary>
  28852. Get the message.
  28853. </summary>
  28854. <value>The message.</value>
  28855. <remarks>
  28856. <para>
  28857. Get the message.
  28858. </para>
  28859. </remarks>
  28860. </member>
  28861. <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
  28862. <summary>
  28863. Gets the full text of the context down to the root level.
  28864. </summary>
  28865. <value>
  28866. The full text of the context down to the root level.
  28867. </value>
  28868. <remarks>
  28869. <para>
  28870. Gets the full text of the context down to the root level.
  28871. </para>
  28872. </remarks>
  28873. </member>
  28874. <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
  28875. <summary>
  28876. Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
  28877. </summary>
  28878. <remarks>
  28879. <para>
  28880. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  28881. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  28882. </para>
  28883. </remarks>
  28884. </member>
  28885. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
  28886. <summary>
  28887. The ThreadContextStack internal stack
  28888. </summary>
  28889. </member>
  28890. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
  28891. <summary>
  28892. The depth to trim the stack to when this instance is disposed
  28893. </summary>
  28894. </member>
  28895. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
  28896. <summary>
  28897. Constructor
  28898. </summary>
  28899. <param name="frameStack">The internal stack used by the ThreadContextStack.</param>
  28900. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  28901. <remarks>
  28902. <para>
  28903. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame" /> class with
  28904. the specified stack and return depth.
  28905. </para>
  28906. </remarks>
  28907. </member>
  28908. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
  28909. <summary>
  28910. Returns the stack to the correct depth.
  28911. </summary>
  28912. <remarks>
  28913. <para>
  28914. Returns the stack to the correct depth.
  28915. </para>
  28916. </remarks>
  28917. </member>
  28918. <member name="T:log4net.Util.ThreadContextStacks">
  28919. <summary>
  28920. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  28921. </summary>
  28922. <remarks>
  28923. <para>
  28924. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  28925. </para>
  28926. </remarks>
  28927. <author>Nicko Cadell</author>
  28928. </member>
  28929. <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
  28930. <summary>
  28931. Internal constructor
  28932. </summary>
  28933. <remarks>
  28934. <para>
  28935. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks" /> class.
  28936. </para>
  28937. </remarks>
  28938. </member>
  28939. <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
  28940. <summary>
  28941. Gets the named thread context stack
  28942. </summary>
  28943. <value>
  28944. The named stack
  28945. </value>
  28946. <remarks>
  28947. <para>
  28948. Gets the named thread context stack
  28949. </para>
  28950. </remarks>
  28951. </member>
  28952. <member name="F:log4net.Util.ThreadContextStacks.declaringType">
  28953. <summary>
  28954. The fully qualified type of the ThreadContextStacks class.
  28955. </summary>
  28956. <remarks>
  28957. Used by the internal logger to record the Type of the
  28958. log message.
  28959. </remarks>
  28960. </member>
  28961. <member name="T:log4net.Util.Transform">
  28962. <summary>
  28963. Utility class for transforming strings.
  28964. </summary>
  28965. <remarks>
  28966. <para>
  28967. Utility class for transforming strings.
  28968. </para>
  28969. </remarks>
  28970. <author>Nicko Cadell</author>
  28971. <author>Gert Driesen</author>
  28972. </member>
  28973. <member name="M:log4net.Util.Transform.#ctor">
  28974. <summary>
  28975. Initializes a new instance of the <see cref="T:log4net.Util.Transform" /> class.
  28976. </summary>
  28977. <remarks>
  28978. <para>
  28979. Uses a private access modifier to prevent instantiation of this class.
  28980. </para>
  28981. </remarks>
  28982. </member>
  28983. <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
  28984. <summary>
  28985. Write a string to an <see cref="T:System.Xml.XmlWriter"/>
  28986. </summary>
  28987. <param name="writer">the writer to write to</param>
  28988. <param name="textData">the string to write</param>
  28989. <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
  28990. <remarks>
  28991. <para>
  28992. The test is escaped either using XML escape entities
  28993. or using CDATA sections.
  28994. </para>
  28995. </remarks>
  28996. </member>
  28997. <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
  28998. <summary>
  28999. Replace invalid XML characters in text string
  29000. </summary>
  29001. <param name="textData">the XML text input string</param>
  29002. <param name="mask">the string to use in place of invalid characters</param>
  29003. <returns>A string that does not contain invalid XML characters.</returns>
  29004. <remarks>
  29005. <para>
  29006. Certain Unicode code points are not allowed in the XML InfoSet, for
  29007. details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
  29008. </para>
  29009. <para>
  29010. This method replaces any illegal characters in the input string
  29011. with the mask string specified.
  29012. </para>
  29013. </remarks>
  29014. </member>
  29015. <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
  29016. <summary>
  29017. Count the number of times that the substring occurs in the text
  29018. </summary>
  29019. <param name="text">the text to search</param>
  29020. <param name="substring">the substring to find</param>
  29021. <returns>the number of times the substring occurs in the text</returns>
  29022. <remarks>
  29023. <para>
  29024. The substring is assumed to be non repeating within itself.
  29025. </para>
  29026. </remarks>
  29027. </member>
  29028. <member name="F:log4net.Util.Transform.INVALIDCHARS">
  29029. <summary>
  29030. Characters illegal in XML 1.0
  29031. </summary>
  29032. </member>
  29033. <member name="T:log4net.Util.TypeConverters.BooleanConverter">
  29034. <summary>
  29035. Type converter for Boolean.
  29036. </summary>
  29037. <remarks>
  29038. <para>
  29039. Supports conversion from string to <c>bool</c> type.
  29040. </para>
  29041. </remarks>
  29042. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29043. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29044. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29045. <author>Nicko Cadell</author>
  29046. <author>Gert Driesen</author>
  29047. </member>
  29048. <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
  29049. <summary>
  29050. Can the source type be converted to the type supported by this object
  29051. </summary>
  29052. <param name="sourceType">the type to convert</param>
  29053. <returns>true if the conversion is possible</returns>
  29054. <remarks>
  29055. <para>
  29056. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29057. the <see cref="T:System.String"/> type.
  29058. </para>
  29059. </remarks>
  29060. </member>
  29061. <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
  29062. <summary>
  29063. Convert the source object to the type supported by this object
  29064. </summary>
  29065. <param name="source">the object to convert</param>
  29066. <returns>the converted object</returns>
  29067. <remarks>
  29068. <para>
  29069. Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
  29070. <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
  29071. </para>
  29072. </remarks>
  29073. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29074. The <paramref name="source"/> object cannot be converted to the
  29075. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
  29076. method.
  29077. </exception>
  29078. </member>
  29079. <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29080. <summary>
  29081. Exception base type for conversion errors.
  29082. </summary>
  29083. <remarks>
  29084. <para>
  29085. This type extends <see cref="!:ApplicationException"/>. It
  29086. does not add any new functionality but does differentiate the
  29087. type of exception being thrown.
  29088. </para>
  29089. </remarks>
  29090. <author>Nicko Cadell</author>
  29091. <author>Gert Driesen</author>
  29092. </member>
  29093. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
  29094. <summary>
  29095. Constructor
  29096. </summary>
  29097. <remarks>
  29098. <para>
  29099. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29100. </para>
  29101. </remarks>
  29102. </member>
  29103. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
  29104. <summary>
  29105. Constructor
  29106. </summary>
  29107. <param name="message">A message to include with the exception.</param>
  29108. <remarks>
  29109. <para>
  29110. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  29111. with the specified message.
  29112. </para>
  29113. </remarks>
  29114. </member>
  29115. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
  29116. <summary>
  29117. Constructor
  29118. </summary>
  29119. <param name="message">A message to include with the exception.</param>
  29120. <param name="innerException">A nested exception to include.</param>
  29121. <remarks>
  29122. <para>
  29123. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  29124. with the specified message and inner exception.
  29125. </para>
  29126. </remarks>
  29127. </member>
  29128. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
  29129. <summary>
  29130. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29131. </summary>
  29132. <param name="destinationType">The conversion destination type.</param>
  29133. <param name="sourceValue">The value to convert.</param>
  29134. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" />.</returns>
  29135. <remarks>
  29136. <para>
  29137. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29138. </para>
  29139. </remarks>
  29140. </member>
  29141. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
  29142. <summary>
  29143. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29144. </summary>
  29145. <param name="destinationType">The conversion destination type.</param>
  29146. <param name="sourceValue">The value to convert.</param>
  29147. <param name="innerException">A nested exception to include.</param>
  29148. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" />.</returns>
  29149. <remarks>
  29150. <para>
  29151. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29152. </para>
  29153. </remarks>
  29154. </member>
  29155. <member name="T:log4net.Util.TypeConverters.ConverterRegistry">
  29156. <summary>
  29157. Register of type converters for specific types.
  29158. </summary>
  29159. <remarks>
  29160. <para>
  29161. Maintains a registry of type converters used to convert between
  29162. types.
  29163. </para>
  29164. <para>
  29165. Use the <see cref="M:AddConverter(Type, object)"/> and
  29166. <see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
  29167. 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
  29168. lookup appropriate converters to use.
  29169. </para>
  29170. </remarks>
  29171. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29172. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29173. <author>Nicko Cadell</author>
  29174. <author>Gert Driesen</author>
  29175. </member>
  29176. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
  29177. <summary>
  29178. Private constructor
  29179. </summary>
  29180. <remarks>
  29181. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry" /> class.
  29182. </remarks>
  29183. </member>
  29184. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
  29185. <summary>
  29186. Static constructor.
  29187. </summary>
  29188. <remarks>
  29189. <para>
  29190. This constructor defines the intrinsic type converters.
  29191. </para>
  29192. </remarks>
  29193. </member>
  29194. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
  29195. <summary>
  29196. Adds a converter for a specific type.
  29197. </summary>
  29198. <param name="destinationType">The type being converted to.</param>
  29199. <param name="converter">The type converter to use to convert to the destination type.</param>
  29200. <remarks>
  29201. <para>
  29202. Adds a converter instance for a specific type.
  29203. </para>
  29204. </remarks>
  29205. </member>
  29206. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
  29207. <summary>
  29208. Adds a converter for a specific type.
  29209. </summary>
  29210. <param name="destinationType">The type being converted to.</param>
  29211. <param name="converterType">The type of the type converter to use to convert to the destination type.</param>
  29212. <remarks>
  29213. <para>
  29214. Adds a converter <see cref="T:System.Type"/> for a specific type.
  29215. </para>
  29216. </remarks>
  29217. </member>
  29218. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
  29219. <summary>
  29220. Gets the type converter to use to convert values to the destination type.
  29221. </summary>
  29222. <param name="sourceType">The type being converted from.</param>
  29223. <param name="destinationType">The type being converted to.</param>
  29224. <returns>
  29225. The type converter instance to use for type conversions or <c>null</c>
  29226. if no type converter is found.
  29227. </returns>
  29228. <remarks>
  29229. <para>
  29230. Gets the type converter to use to convert values to the destination type.
  29231. </para>
  29232. </remarks>
  29233. </member>
  29234. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
  29235. <summary>
  29236. Gets the type converter to use to convert values to the destination type.
  29237. </summary>
  29238. <param name="destinationType">The type being converted to.</param>
  29239. <returns>
  29240. The type converter instance to use for type conversions or <c>null</c>
  29241. if no type converter is found.
  29242. </returns>
  29243. <remarks>
  29244. <para>
  29245. Gets the type converter to use to convert values to the destination type.
  29246. </para>
  29247. </remarks>
  29248. </member>
  29249. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
  29250. <summary>
  29251. Lookups the type converter to use as specified by the attributes on the
  29252. destination type.
  29253. </summary>
  29254. <param name="destinationType">The type being converted to.</param>
  29255. <returns>
  29256. The type converter instance to use for type conversions or <c>null</c>
  29257. if no type converter is found.
  29258. </returns>
  29259. </member>
  29260. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
  29261. <summary>
  29262. Creates the instance of the type converter.
  29263. </summary>
  29264. <param name="converterType">The type of the type converter.</param>
  29265. <returns>
  29266. The type converter instance to use for type conversions or <c>null</c>
  29267. if no type converter is found.
  29268. </returns>
  29269. <remarks>
  29270. <para>
  29271. The type specified for the type converter must implement
  29272. the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
  29273. and must have a public default (no argument) constructor.
  29274. </para>
  29275. </remarks>
  29276. </member>
  29277. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
  29278. <summary>
  29279. The fully qualified type of the ConverterRegistry class.
  29280. </summary>
  29281. <remarks>
  29282. Used by the internal logger to record the Type of the
  29283. log message.
  29284. </remarks>
  29285. </member>
  29286. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
  29287. <summary>
  29288. Mapping from <see cref="T:System.Type" /> to type converter.
  29289. </summary>
  29290. </member>
  29291. <member name="T:log4net.Util.TypeConverters.EncodingConverter">
  29292. <summary>
  29293. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  29294. </summary>
  29295. <remarks>
  29296. <para>
  29297. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  29298. </para>
  29299. </remarks>
  29300. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29301. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29302. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29303. <author>Nicko Cadell</author>
  29304. <author>Gert Driesen</author>
  29305. </member>
  29306. <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
  29307. <summary>
  29308. Can the source type be converted to the type supported by this object
  29309. </summary>
  29310. <param name="sourceType">the type to convert</param>
  29311. <returns>true if the conversion is possible</returns>
  29312. <remarks>
  29313. <para>
  29314. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29315. the <see cref="T:System.String"/> type.
  29316. </para>
  29317. </remarks>
  29318. </member>
  29319. <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
  29320. <summary>
  29321. Overrides the ConvertFrom method of IConvertFrom.
  29322. </summary>
  29323. <param name="source">the object to convert to an encoding</param>
  29324. <returns>the encoding</returns>
  29325. <remarks>
  29326. <para>
  29327. Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
  29328. convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
  29329. </para>
  29330. </remarks>
  29331. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29332. The <paramref name="source"/> object cannot be converted to the
  29333. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
  29334. method.
  29335. </exception>
  29336. </member>
  29337. <member name="T:log4net.Util.TypeConverters.IConvertFrom">
  29338. <summary>
  29339. Interface supported by type converters
  29340. </summary>
  29341. <remarks>
  29342. <para>
  29343. This interface supports conversion from arbitrary types
  29344. to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  29345. </para>
  29346. </remarks>
  29347. <author>Nicko Cadell</author>
  29348. <author>Gert Driesen</author>
  29349. </member>
  29350. <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
  29351. <summary>
  29352. Can the source type be converted to the type supported by this object
  29353. </summary>
  29354. <param name="sourceType">the type to convert</param>
  29355. <returns>true if the conversion is possible</returns>
  29356. <remarks>
  29357. <para>
  29358. Test if the <paramref name="sourceType"/> can be converted to the
  29359. type supported by this converter.
  29360. </para>
  29361. </remarks>
  29362. </member>
  29363. <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
  29364. <summary>
  29365. Convert the source object to the type supported by this object
  29366. </summary>
  29367. <param name="source">the object to convert</param>
  29368. <returns>the converted object</returns>
  29369. <remarks>
  29370. <para>
  29371. Converts the <paramref name="source"/> to the type supported
  29372. by this converter.
  29373. </para>
  29374. </remarks>
  29375. </member>
  29376. <member name="T:log4net.Util.TypeConverters.IConvertTo">
  29377. <summary>
  29378. Interface supported by type converters
  29379. </summary>
  29380. <remarks>
  29381. <para>
  29382. This interface supports conversion from a single type to arbitrary types.
  29383. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  29384. </para>
  29385. </remarks>
  29386. <author>Nicko Cadell</author>
  29387. </member>
  29388. <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
  29389. <summary>
  29390. Returns whether this converter can convert the object to the specified type
  29391. </summary>
  29392. <param name="targetType">A Type that represents the type you want to convert to</param>
  29393. <returns>true if the conversion is possible</returns>
  29394. <remarks>
  29395. <para>
  29396. Test if the type supported by this converter can be converted to the
  29397. <paramref name="targetType"/>.
  29398. </para>
  29399. </remarks>
  29400. </member>
  29401. <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
  29402. <summary>
  29403. Converts the given value object to the specified type, using the arguments
  29404. </summary>
  29405. <param name="source">the object to convert</param>
  29406. <param name="targetType">The Type to convert the value parameter to</param>
  29407. <returns>the converted object</returns>
  29408. <remarks>
  29409. <para>
  29410. Converts the <paramref name="source"/> (which must be of the type supported
  29411. by this converter) to the <paramref name="targetType"/> specified..
  29412. </para>
  29413. </remarks>
  29414. </member>
  29415. <member name="T:log4net.Util.TypeConverters.IPAddressConverter">
  29416. <summary>
  29417. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  29418. </summary>
  29419. <remarks>
  29420. <para>
  29421. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  29422. </para>
  29423. </remarks>
  29424. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29425. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29426. <author>Nicko Cadell</author>
  29427. </member>
  29428. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
  29429. <summary>
  29430. Can the source type be converted to the type supported by this object
  29431. </summary>
  29432. <param name="sourceType">the type to convert</param>
  29433. <returns>true if the conversion is possible</returns>
  29434. <remarks>
  29435. <para>
  29436. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29437. the <see cref="T:System.String"/> type.
  29438. </para>
  29439. </remarks>
  29440. </member>
  29441. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
  29442. <summary>
  29443. Overrides the ConvertFrom method of IConvertFrom.
  29444. </summary>
  29445. <param name="source">the object to convert to an IPAddress</param>
  29446. <returns>the IPAddress</returns>
  29447. <remarks>
  29448. <para>
  29449. Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
  29450. <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
  29451. If that fails then the string is resolved as a DNS hostname.
  29452. </para>
  29453. </remarks>
  29454. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29455. The <paramref name="source"/> object cannot be converted to the
  29456. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
  29457. method.
  29458. </exception>
  29459. </member>
  29460. <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
  29461. <summary>
  29462. Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
  29463. </summary>
  29464. </member>
  29465. <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
  29466. <summary>
  29467. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  29468. </summary>
  29469. <remarks>
  29470. <para>
  29471. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  29472. </para>
  29473. <para>
  29474. The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
  29475. of the <see cref="T:log4net.Layout.PatternLayout"/>.
  29476. </para>
  29477. </remarks>
  29478. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29479. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29480. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29481. <author>Nicko Cadell</author>
  29482. </member>
  29483. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
  29484. <summary>
  29485. Can the source type be converted to the type supported by this object
  29486. </summary>
  29487. <param name="sourceType">the type to convert</param>
  29488. <returns>true if the conversion is possible</returns>
  29489. <remarks>
  29490. <para>
  29491. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29492. the <see cref="T:System.String"/> type.
  29493. </para>
  29494. </remarks>
  29495. </member>
  29496. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
  29497. <summary>
  29498. Overrides the ConvertFrom method of IConvertFrom.
  29499. </summary>
  29500. <param name="source">the object to convert to a PatternLayout</param>
  29501. <returns>the PatternLayout</returns>
  29502. <remarks>
  29503. <para>
  29504. Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
  29505. the <paramref name="source"/> <see cref="T:System.String"/> as the
  29506. <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
  29507. </para>
  29508. </remarks>
  29509. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29510. The <paramref name="source"/> object cannot be converted to the
  29511. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
  29512. method.
  29513. </exception>
  29514. </member>
  29515. <member name="T:log4net.Util.TypeConverters.PatternStringConverter">
  29516. <summary>
  29517. Convert between string and <see cref="T:log4net.Util.PatternString"/>
  29518. </summary>
  29519. <remarks>
  29520. <para>
  29521. Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
  29522. and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
  29523. </para>
  29524. <para>
  29525. The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
  29526. of the <see cref="T:log4net.Util.PatternString"/>.
  29527. </para>
  29528. </remarks>
  29529. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29530. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29531. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29532. <author>Nicko Cadell</author>
  29533. </member>
  29534. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
  29535. <summary>
  29536. Can the target type be converted to the type supported by this object
  29537. </summary>
  29538. <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
  29539. <returns>true if the conversion is possible</returns>
  29540. <remarks>
  29541. <para>
  29542. Returns <c>true</c> if the <paramref name="targetType"/> is
  29543. assignable from a <see cref="T:System.String"/> type.
  29544. </para>
  29545. </remarks>
  29546. </member>
  29547. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
  29548. <summary>
  29549. Converts the given value object to the specified type, using the arguments
  29550. </summary>
  29551. <param name="source">the object to convert</param>
  29552. <param name="targetType">The Type to convert the value parameter to</param>
  29553. <returns>the converted object</returns>
  29554. <remarks>
  29555. <para>
  29556. Uses the <see cref="M:PatternString.Format()"/> method to convert the
  29557. <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
  29558. </para>
  29559. </remarks>
  29560. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29561. The <paramref name="source"/> object cannot be converted to the
  29562. <paramref name="targetType"/>. To check for this condition use the
  29563. <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
  29564. </exception>
  29565. </member>
  29566. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
  29567. <summary>
  29568. Can the source type be converted to the type supported by this object
  29569. </summary>
  29570. <param name="sourceType">the type to convert</param>
  29571. <returns>true if the conversion is possible</returns>
  29572. <remarks>
  29573. <para>
  29574. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29575. the <see cref="T:System.String"/> type.
  29576. </para>
  29577. </remarks>
  29578. </member>
  29579. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
  29580. <summary>
  29581. Overrides the ConvertFrom method of IConvertFrom.
  29582. </summary>
  29583. <param name="source">the object to convert to a PatternString</param>
  29584. <returns>the PatternString</returns>
  29585. <remarks>
  29586. <para>
  29587. Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
  29588. the <paramref name="source"/> <see cref="T:System.String"/> as the
  29589. <see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
  29590. </para>
  29591. </remarks>
  29592. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29593. The <paramref name="source"/> object cannot be converted to the
  29594. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
  29595. method.
  29596. </exception>
  29597. </member>
  29598. <member name="T:log4net.Util.TypeConverters.TypeConverter">
  29599. <summary>
  29600. Supports conversion from string to <see cref="T:System.Type"/> type.
  29601. </summary>
  29602. <remarks>
  29603. <para>
  29604. Supports conversion from string to <see cref="T:System.Type"/> type.
  29605. </para>
  29606. </remarks>
  29607. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29608. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29609. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29610. <author>Nicko Cadell</author>
  29611. </member>
  29612. <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
  29613. <summary>
  29614. Can the source type be converted to the type supported by this object
  29615. </summary>
  29616. <param name="sourceType">the type to convert</param>
  29617. <returns>true if the conversion is possible</returns>
  29618. <remarks>
  29619. <para>
  29620. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29621. the <see cref="T:System.String"/> type.
  29622. </para>
  29623. </remarks>
  29624. </member>
  29625. <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
  29626. <summary>
  29627. Overrides the ConvertFrom method of IConvertFrom.
  29628. </summary>
  29629. <param name="source">the object to convert to a Type</param>
  29630. <returns>the Type</returns>
  29631. <remarks>
  29632. <para>
  29633. Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
  29634. <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
  29635. Additional effort is made to locate partially specified types
  29636. by searching the loaded assemblies.
  29637. </para>
  29638. </remarks>
  29639. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29640. The <paramref name="source"/> object cannot be converted to the
  29641. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
  29642. method.
  29643. </exception>
  29644. </member>
  29645. <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
  29646. <summary>
  29647. Attribute used to associate a type converter
  29648. </summary>
  29649. <remarks>
  29650. <para>
  29651. Class and Interface level attribute that specifies a type converter
  29652. to use with the associated type.
  29653. </para>
  29654. <para>
  29655. To associate a type converter with a target type apply a
  29656. <c>TypeConverterAttribute</c> to the target type. Specify the
  29657. type of the type converter on the attribute.
  29658. </para>
  29659. </remarks>
  29660. <author>Nicko Cadell</author>
  29661. <author>Gert Driesen</author>
  29662. </member>
  29663. <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
  29664. <summary>
  29665. The string type name of the type converter
  29666. </summary>
  29667. </member>
  29668. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
  29669. <summary>
  29670. Default constructor
  29671. </summary>
  29672. <remarks>
  29673. <para>
  29674. Default constructor
  29675. </para>
  29676. </remarks>
  29677. </member>
  29678. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
  29679. <summary>
  29680. Create a new type converter attribute for the specified type name
  29681. </summary>
  29682. <param name="typeName">The string type name of the type converter</param>
  29683. <remarks>
  29684. <para>
  29685. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29686. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  29687. </para>
  29688. </remarks>
  29689. </member>
  29690. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
  29691. <summary>
  29692. Create a new type converter attribute for the specified type
  29693. </summary>
  29694. <param name="converterType">The type of the type converter</param>
  29695. <remarks>
  29696. <para>
  29697. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29698. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  29699. </para>
  29700. </remarks>
  29701. </member>
  29702. <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
  29703. <summary>
  29704. The string type name of the type converter
  29705. </summary>
  29706. <value>
  29707. The string type name of the type converter
  29708. </value>
  29709. <remarks>
  29710. <para>
  29711. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29712. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  29713. </para>
  29714. </remarks>
  29715. </member>
  29716. </members>
  29717. </doc>