log4net.xml 1.3 MB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407264082640926410264112641226413264142641526416264172641826419264202642126422264232642426425264262642726428264292643026431264322643326434264352643626437264382643926440264412644226443264442644526446264472644826449264502645126452264532645426455264562645726458264592646026461264622646326464264652646626467264682646926470264712647226473264742647526476264772647826479264802648126482264832648426485264862648726488264892649026491264922649326494264952649626497264982649926500265012650226503265042650526506265072650826509265102651126512265132651426515265162651726518265192652026521265222652326524265252652626527265282652926530265312653226533265342653526536265372653826539265402654126542265432654426545265462654726548265492655026551265522655326554265552655626557265582655926560265612656226563265642656526566265672656826569265702657126572265732657426575265762657726578265792658026581265822658326584265852658626587265882658926590265912659226593265942659526596265972659826599266002660126602266032660426605266062660726608266092661026611266122661326614266152661626617266182661926620266212662226623266242662526626266272662826629266302663126632266332663426635266362663726638266392664026641266422664326644266452664626647266482664926650266512665226653266542665526656266572665826659266602666126662266632666426665266662666726668266692667026671266722667326674266752667626677266782667926680266812668226683266842668526686266872668826689266902669126692266932669426695266962669726698266992670026701267022670326704267052670626707267082670926710267112671226713267142671526716267172671826719267202672126722267232672426725267262672726728267292673026731267322673326734267352673626737267382673926740267412674226743267442674526746267472674826749267502675126752267532675426755267562675726758267592676026761267622676326764267652676626767267682676926770267712677226773267742677526776267772677826779267802678126782267832678426785267862678726788267892679026791267922679326794267952679626797267982679926800268012680226803268042680526806268072680826809268102681126812268132681426815268162681726818268192682026821268222682326824268252682626827268282682926830268312683226833268342683526836268372683826839268402684126842268432684426845268462684726848268492685026851268522685326854268552685626857268582685926860268612686226863268642686526866268672686826869268702687126872268732687426875268762687726878268792688026881268822688326884268852688626887268882688926890268912689226893268942689526896268972689826899269002690126902269032690426905269062690726908269092691026911269122691326914269152691626917269182691926920269212692226923269242692526926269272692826929269302693126932269332693426935269362693726938269392694026941269422694326944269452694626947269482694926950269512695226953269542695526956269572695826959269602696126962269632696426965269662696726968269692697026971269722697326974269752697626977269782697926980269812698226983269842698526986269872698826989269902699126992269932699426995269962699726998269992700027001270022700327004270052700627007270082700927010270112701227013270142701527016270172701827019270202702127022270232702427025270262702727028270292703027031270322703327034270352703627037270382703927040270412704227043270442704527046270472704827049270502705127052270532705427055270562705727058270592706027061270622706327064270652706627067270682706927070270712707227073270742707527076270772707827079270802708127082270832708427085270862708727088270892709027091270922709327094270952709627097270982709927100271012710227103271042710527106271072710827109271102711127112271132711427115271162711727118271192712027121271222712327124271252712627127271282712927130271312713227133271342713527136271372713827139271402714127142271432714427145271462714727148271492715027151271522715327154271552715627157271582715927160271612716227163271642716527166271672716827169271702717127172271732717427175271762717727178271792718027181271822718327184271852718627187271882718927190271912719227193271942719527196271972719827199272002720127202272032720427205272062720727208272092721027211272122721327214272152721627217272182721927220272212722227223272242722527226272272722827229272302723127232272332723427235272362723727238272392724027241272422724327244272452724627247272482724927250272512725227253272542725527256272572725827259272602726127262272632726427265272662726727268272692727027271272722727327274272752727627277272782727927280272812728227283272842728527286272872728827289272902729127292272932729427295272962729727298272992730027301273022730327304273052730627307273082730927310273112731227313273142731527316273172731827319273202732127322273232732427325273262732727328273292733027331273322733327334273352733627337273382733927340273412734227343273442734527346273472734827349273502735127352273532735427355273562735727358273592736027361273622736327364273652736627367273682736927370273712737227373273742737527376273772737827379273802738127382273832738427385273862738727388273892739027391273922739327394273952739627397273982739927400274012740227403274042740527406274072740827409274102741127412274132741427415274162741727418274192742027421274222742327424274252742627427274282742927430274312743227433274342743527436274372743827439274402744127442274432744427445274462744727448274492745027451274522745327454274552745627457274582745927460274612746227463274642746527466274672746827469274702747127472274732747427475274762747727478274792748027481274822748327484274852748627487274882748927490274912749227493274942749527496274972749827499275002750127502275032750427505275062750727508275092751027511275122751327514275152751627517275182751927520275212752227523275242752527526275272752827529275302753127532275332753427535275362753727538275392754027541275422754327544275452754627547275482754927550275512755227553275542755527556275572755827559275602756127562275632756427565275662756727568275692757027571275722757327574275752757627577275782757927580275812758227583275842758527586275872758827589275902759127592275932759427595275962759727598275992760027601276022760327604276052760627607276082760927610276112761227613276142761527616276172761827619276202762127622276232762427625276262762727628276292763027631276322763327634276352763627637276382763927640276412764227643276442764527646276472764827649276502765127652276532765427655276562765727658276592766027661276622766327664276652766627667276682766927670276712767227673276742767527676276772767827679276802768127682276832768427685276862768727688276892769027691276922769327694276952769627697276982769927700277012770227703277042770527706277072770827709277102771127712277132771427715277162771727718277192772027721277222772327724277252772627727277282772927730277312773227733277342773527736277372773827739277402774127742277432774427745277462774727748277492775027751277522775327754277552775627757277582775927760277612776227763277642776527766277672776827769277702777127772277732777427775277762777727778277792778027781277822778327784277852778627787277882778927790277912779227793277942779527796277972779827799278002780127802278032780427805278062780727808278092781027811278122781327814278152781627817278182781927820278212782227823278242782527826278272782827829278302783127832278332783427835278362783727838278392784027841278422784327844278452784627847278482784927850278512785227853278542785527856278572785827859278602786127862278632786427865278662786727868278692787027871278722787327874278752787627877278782787927880278812788227883278842788527886278872788827889278902789127892278932789427895278962789727898278992790027901279022790327904279052790627907279082790927910279112791227913279142791527916279172791827919279202792127922279232792427925279262792727928279292793027931279322793327934279352793627937279382793927940279412794227943279442794527946279472794827949279502795127952279532795427955279562795727958279592796027961279622796327964279652796627967279682796927970279712797227973279742797527976279772797827979279802798127982279832798427985279862798727988279892799027991279922799327994279952799627997279982799928000280012800228003280042800528006280072800828009280102801128012280132801428015280162801728018280192802028021280222802328024280252802628027280282802928030280312803228033280342803528036280372803828039280402804128042280432804428045280462804728048280492805028051280522805328054280552805628057280582805928060280612806228063280642806528066280672806828069280702807128072280732807428075280762807728078280792808028081280822808328084280852808628087280882808928090280912809228093280942809528096280972809828099281002810128102281032810428105281062810728108281092811028111281122811328114281152811628117281182811928120281212812228123281242812528126281272812828129281302813128132281332813428135281362813728138281392814028141281422814328144281452814628147281482814928150281512815228153281542815528156281572815828159281602816128162281632816428165281662816728168281692817028171281722817328174281752817628177281782817928180281812818228183281842818528186281872818828189281902819128192281932819428195281962819728198281992820028201282022820328204282052820628207282082820928210282112821228213282142821528216282172821828219282202822128222282232822428225282262822728228282292823028231282322823328234282352823628237282382823928240282412824228243282442824528246282472824828249282502825128252282532825428255282562825728258282592826028261282622826328264282652826628267282682826928270282712827228273282742827528276282772827828279282802828128282282832828428285282862828728288282892829028291282922829328294282952829628297282982829928300283012830228303283042830528306283072830828309283102831128312283132831428315283162831728318283192832028321283222832328324283252832628327283282832928330283312833228333283342833528336283372833828339283402834128342283432834428345283462834728348283492835028351283522835328354283552835628357283582835928360283612836228363283642836528366283672836828369283702837128372283732837428375283762837728378283792838028381283822838328384283852838628387283882838928390283912839228393283942839528396283972839828399284002840128402284032840428405284062840728408284092841028411284122841328414284152841628417284182841928420284212842228423284242842528426284272842828429284302843128432284332843428435284362843728438284392844028441284422844328444284452844628447284482844928450284512845228453284542845528456284572845828459284602846128462284632846428465284662846728468284692847028471284722847328474284752847628477284782847928480284812848228483284842848528486284872848828489284902849128492284932849428495284962849728498284992850028501285022850328504285052850628507285082850928510285112851228513285142851528516285172851828519285202852128522285232852428525285262852728528285292853028531285322853328534285352853628537285382853928540285412854228543285442854528546285472854828549285502855128552285532855428555285562855728558285592856028561285622856328564285652856628567285682856928570285712857228573285742857528576285772857828579285802858128582285832858428585285862858728588285892859028591285922859328594285952859628597285982859928600286012860228603286042860528606286072860828609286102861128612286132861428615286162861728618286192862028621286222862328624286252862628627286282862928630286312863228633286342863528636286372863828639286402864128642286432864428645286462864728648286492865028651286522865328654286552865628657286582865928660286612866228663286642866528666286672866828669286702867128672286732867428675286762867728678286792868028681286822868328684286852868628687286882868928690286912869228693286942869528696286972869828699287002870128702287032870428705287062870728708287092871028711287122871328714287152871628717287182871928720287212872228723287242872528726287272872828729287302873128732287332873428735287362873728738287392874028741287422874328744287452874628747287482874928750287512875228753287542875528756287572875828759287602876128762287632876428765287662876728768287692877028771287722877328774287752877628777287782877928780287812878228783287842878528786287872878828789287902879128792287932879428795287962879728798287992880028801288022880328804288052880628807288082880928810288112881228813288142881528816288172881828819288202882128822288232882428825288262882728828288292883028831288322883328834288352883628837288382883928840288412884228843288442884528846288472884828849288502885128852288532885428855288562885728858288592886028861288622886328864288652886628867288682886928870288712887228873288742887528876288772887828879288802888128882288832888428885288862888728888288892889028891288922889328894288952889628897288982889928900289012890228903289042890528906289072890828909289102891128912289132891428915289162891728918289192892028921289222892328924289252892628927289282892928930289312893228933289342893528936289372893828939289402894128942289432894428945289462894728948289492895028951289522895328954289552895628957289582895928960289612896228963289642896528966289672896828969289702897128972289732897428975289762897728978289792898028981289822898328984289852898628987289882898928990289912899228993289942899528996289972899828999290002900129002290032900429005290062900729008290092901029011290122901329014290152901629017290182901929020290212902229023290242902529026290272902829029290302903129032290332903429035290362903729038290392904029041290422904329044290452904629047290482904929050290512905229053290542905529056290572905829059290602906129062290632906429065290662906729068290692907029071290722907329074290752907629077290782907929080290812908229083290842908529086290872908829089290902909129092290932909429095290962909729098290992910029101291022910329104291052910629107291082910929110291112911229113291142911529116291172911829119291202912129122291232912429125291262912729128291292913029131291322913329134291352913629137291382913929140291412914229143291442914529146291472914829149291502915129152291532915429155291562915729158291592916029161291622916329164291652916629167291682916929170291712917229173291742917529176291772917829179291802918129182291832918429185291862918729188291892919029191291922919329194291952919629197291982919929200292012920229203292042920529206292072920829209292102921129212292132921429215292162921729218292192922029221292222922329224292252922629227292282922929230292312923229233292342923529236292372923829239292402924129242292432924429245292462924729248292492925029251292522925329254292552925629257292582925929260292612926229263292642926529266292672926829269292702927129272292732927429275292762927729278292792928029281292822928329284292852928629287292882928929290292912929229293292942929529296292972929829299293002930129302293032930429305293062930729308293092931029311293122931329314293152931629317293182931929320293212932229323293242932529326293272932829329293302933129332293332933429335293362933729338293392934029341293422934329344293452934629347293482934929350293512935229353293542935529356293572935829359293602936129362293632936429365293662936729368293692937029371293722937329374293752937629377293782937929380293812938229383293842938529386293872938829389293902939129392293932939429395293962939729398293992940029401294022940329404294052940629407294082940929410294112941229413294142941529416294172941829419294202942129422294232942429425294262942729428294292943029431294322943329434294352943629437294382943929440294412944229443294442944529446294472944829449294502945129452294532945429455294562945729458294592946029461294622946329464294652946629467294682946929470294712947229473294742947529476294772947829479294802948129482294832948429485294862948729488294892949029491294922949329494294952949629497294982949929500295012950229503295042950529506295072950829509295102951129512295132951429515295162951729518295192952029521295222952329524295252952629527295282952929530295312953229533295342953529536295372953829539295402954129542295432954429545295462954729548295492955029551295522955329554295552955629557295582955929560295612956229563295642956529566295672956829569295702957129572295732957429575295762957729578295792958029581295822958329584295852958629587295882958929590295912959229593295942959529596295972959829599296002960129602296032960429605296062960729608296092961029611296122961329614296152961629617296182961929620296212962229623296242962529626296272962829629296302963129632296332963429635296362963729638296392964029641296422964329644296452964629647296482964929650296512965229653296542965529656296572965829659296602966129662296632966429665296662966729668296692967029671296722967329674296752967629677296782967929680296812968229683296842968529686296872968829689296902969129692296932969429695296962969729698296992970029701297022970329704297052970629707297082970929710297112971229713297142971529716297172971829719297202972129722297232972429725297262972729728297292973029731297322973329734297352973629737297382973929740297412974229743297442974529746297472974829749297502975129752
  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.GetLogStatement(log4net.Core.LoggingEvent)">
  366. <summary>
  367. Formats the log message into database statement text.
  368. </summary>
  369. <param name="logEvent">The event being logged.</param>
  370. <remarks>
  371. This method can be overridden by subclasses to provide
  372. more control over the format of the database statement.
  373. </remarks>
  374. <returns>
  375. Text that can be passed to a <see cref="T:System.Data.IDbCommand"/>.
  376. </returns>
  377. </member>
  378. <member name="M:log4net.Appender.AdoNetAppender.CreateConnection(System.Type,System.String)">
  379. <summary>
  380. Creates an <see cref="T:System.Data.IDbConnection"/> instance used to connect to the database.
  381. </summary>
  382. <remarks>
  383. This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary).
  384. </remarks>
  385. <param name="connectionType">The <see cref="T:System.Type"/> of the <see cref="T:System.Data.IDbConnection"/> object.</param>
  386. <param name="connectionString">The connectionString output from the ResolveConnectionString method.</param>
  387. <returns>An <see cref="T:System.Data.IDbConnection"/> instance with a valid connection string.</returns>
  388. </member>
  389. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionString(System.String@)">
  390. <summary>
  391. Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey
  392. property.
  393. </summary>
  394. <remarks>
  395. ConnectiongStringName is only supported on .NET 2.0 and higher.
  396. </remarks>
  397. <param name="connectionStringContext">Additional information describing the connection string.</param>
  398. <returns>A connection string used to connect to the database.</returns>
  399. </member>
  400. <member name="M:log4net.Appender.AdoNetAppender.ResolveConnectionType">
  401. <summary>
  402. Retrieves the class type of the ADO.NET provider.
  403. </summary>
  404. <remarks>
  405. <para>
  406. Gets the Type of the ADO.NET provider to use to connect to the
  407. database. This method resolves the type specified in the
  408. <see cref="P:log4net.Appender.AdoNetAppender.ConnectionType"/> property.
  409. </para>
  410. <para>
  411. Subclasses can override this method to return a different type
  412. if necessary.
  413. </para>
  414. </remarks>
  415. <returns>The <see cref="T:System.Type"/> of the ADO.NET provider</returns>
  416. </member>
  417. <member name="M:log4net.Appender.AdoNetAppender.InitializeDatabaseConnection">
  418. <summary>
  419. Connects to the database.
  420. </summary>
  421. </member>
  422. <member name="M:log4net.Appender.AdoNetAppender.DiposeConnection">
  423. <summary>
  424. Cleanup the existing connection.
  425. </summary>
  426. <remarks>
  427. Calls the IDbConnection's <see cref="M:System.Data.IDbConnection.Close"/> method.
  428. </remarks>
  429. </member>
  430. <member name="F:log4net.Appender.AdoNetAppender.m_parameters">
  431. <summary>
  432. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  433. </summary>
  434. <remarks>
  435. <para>
  436. The list of <see cref="T:log4net.Appender.AdoNetAppenderParameter"/> objects.
  437. </para>
  438. </remarks>
  439. </member>
  440. <member name="F:log4net.Appender.AdoNetAppender.m_securityContext">
  441. <summary>
  442. The security context to use for privileged calls
  443. </summary>
  444. </member>
  445. <member name="F:log4net.Appender.AdoNetAppender.m_dbConnection">
  446. <summary>
  447. The <see cref="T:System.Data.IDbConnection" /> that will be used
  448. to insert logging events into a database.
  449. </summary>
  450. </member>
  451. <member name="F:log4net.Appender.AdoNetAppender.m_connectionString">
  452. <summary>
  453. Database connection string.
  454. </summary>
  455. </member>
  456. <member name="F:log4net.Appender.AdoNetAppender.m_appSettingsKey">
  457. <summary>
  458. The appSettings key from App.Config that contains the connection string.
  459. </summary>
  460. </member>
  461. <member name="F:log4net.Appender.AdoNetAppender.m_connectionStringName">
  462. <summary>
  463. The connectionStrings key from App.Config that contains the connection string.
  464. </summary>
  465. </member>
  466. <member name="F:log4net.Appender.AdoNetAppender.m_connectionType">
  467. <summary>
  468. String type name of the <see cref="T:System.Data.IDbConnection"/> type name.
  469. </summary>
  470. </member>
  471. <member name="F:log4net.Appender.AdoNetAppender.m_commandText">
  472. <summary>
  473. The text of the command.
  474. </summary>
  475. </member>
  476. <member name="F:log4net.Appender.AdoNetAppender.m_commandType">
  477. <summary>
  478. The command type.
  479. </summary>
  480. </member>
  481. <member name="F:log4net.Appender.AdoNetAppender.m_useTransactions">
  482. <summary>
  483. Indicates whether to use transactions when writing to the database.
  484. </summary>
  485. </member>
  486. <member name="F:log4net.Appender.AdoNetAppender.m_reconnectOnError">
  487. <summary>
  488. Indicates whether to reconnect when a connection is lost.
  489. </summary>
  490. </member>
  491. <member name="F:log4net.Appender.AdoNetAppender.declaringType">
  492. <summary>
  493. The fully qualified type of the AdoNetAppender class.
  494. </summary>
  495. <remarks>
  496. Used by the internal logger to record the Type of the
  497. log message.
  498. </remarks>
  499. </member>
  500. <member name="T:log4net.Appender.AdoNetAppenderParameter">
  501. <summary>
  502. Parameter type used by the <see cref="T:log4net.Appender.AdoNetAppender"/>.
  503. </summary>
  504. <remarks>
  505. <para>
  506. This class provides the basic database parameter properties
  507. as defined by the <see cref="T:System.Data.IDbDataParameter"/> interface.
  508. </para>
  509. <para>This type can be subclassed to provide database specific
  510. functionality. The two methods that are called externally are
  511. <see cref="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)"/> and <see cref="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)"/>.
  512. </para>
  513. </remarks>
  514. </member>
  515. <member name="M:log4net.Appender.AdoNetAppenderParameter.#ctor">
  516. <summary>
  517. Initializes a new instance of the <see cref="T:log4net.Appender.AdoNetAppenderParameter" /> class.
  518. </summary>
  519. <remarks>
  520. Default constructor for the AdoNetAppenderParameter class.
  521. </remarks>
  522. </member>
  523. <member name="P:log4net.Appender.AdoNetAppenderParameter.ParameterName">
  524. <summary>
  525. Gets or sets the name of this parameter.
  526. </summary>
  527. <value>
  528. The name of this parameter.
  529. </value>
  530. <remarks>
  531. <para>
  532. The name of this parameter. The parameter name
  533. must match up to a named parameter to the SQL stored procedure
  534. or prepared statement.
  535. </para>
  536. </remarks>
  537. </member>
  538. <member name="P:log4net.Appender.AdoNetAppenderParameter.DbType">
  539. <summary>
  540. Gets or sets the database type for this parameter.
  541. </summary>
  542. <value>
  543. The database type for this parameter.
  544. </value>
  545. <remarks>
  546. <para>
  547. The database type for this parameter. This property should
  548. be set to the database type from the <see cref="P:log4net.Appender.AdoNetAppenderParameter.DbType"/>
  549. enumeration. See <see cref="P:System.Data.IDataParameter.DbType"/>.
  550. </para>
  551. <para>
  552. This property is optional. If not specified the ADO.NET provider
  553. will attempt to infer the type from the value.
  554. </para>
  555. </remarks>
  556. <seealso cref="P:System.Data.IDataParameter.DbType" />
  557. </member>
  558. <member name="P:log4net.Appender.AdoNetAppenderParameter.Precision">
  559. <summary>
  560. Gets or sets the precision for this parameter.
  561. </summary>
  562. <value>
  563. The precision for this parameter.
  564. </value>
  565. <remarks>
  566. <para>
  567. The maximum number of digits used to represent the Value.
  568. </para>
  569. <para>
  570. This property is optional. If not specified the ADO.NET provider
  571. will attempt to infer the precision from the value.
  572. </para>
  573. </remarks>
  574. <seealso cref="P:System.Data.IDbDataParameter.Precision" />
  575. </member>
  576. <member name="P:log4net.Appender.AdoNetAppenderParameter.Scale">
  577. <summary>
  578. Gets or sets the scale for this parameter.
  579. </summary>
  580. <value>
  581. The scale for this parameter.
  582. </value>
  583. <remarks>
  584. <para>
  585. The number of decimal places to which Value is resolved.
  586. </para>
  587. <para>
  588. This property is optional. If not specified the ADO.NET provider
  589. will attempt to infer the scale from the value.
  590. </para>
  591. </remarks>
  592. <seealso cref="P:System.Data.IDbDataParameter.Scale" />
  593. </member>
  594. <member name="P:log4net.Appender.AdoNetAppenderParameter.Size">
  595. <summary>
  596. Gets or sets the size for this parameter.
  597. </summary>
  598. <value>
  599. The size for this parameter.
  600. </value>
  601. <remarks>
  602. <para>
  603. The maximum size, in bytes, of the data within the column.
  604. </para>
  605. <para>
  606. This property is optional. If not specified the ADO.NET provider
  607. will attempt to infer the size from the value.
  608. </para>
  609. <para>
  610. For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case.
  611. </para>
  612. </remarks>
  613. <seealso cref="P:System.Data.IDbDataParameter.Size" />
  614. </member>
  615. <member name="P:log4net.Appender.AdoNetAppenderParameter.Layout">
  616. <summary>
  617. Gets or sets the <see cref="T:log4net.Layout.IRawLayout"/> to use to
  618. render the logging event into an object for this
  619. parameter.
  620. </summary>
  621. <value>
  622. The <see cref="T:log4net.Layout.IRawLayout"/> used to render the
  623. logging event into an object for this parameter.
  624. </value>
  625. <remarks>
  626. <para>
  627. The <see cref="T:log4net.Layout.IRawLayout"/> that renders the value for this
  628. parameter.
  629. </para>
  630. <para>
  631. The <see cref="T:log4net.Layout.RawLayoutConverter"/> can be used to adapt
  632. any <see cref="T:log4net.Layout.ILayout"/> into a <see cref="T:log4net.Layout.IRawLayout"/>
  633. for use in the property.
  634. </para>
  635. </remarks>
  636. </member>
  637. <member name="M:log4net.Appender.AdoNetAppenderParameter.Prepare(System.Data.IDbCommand)">
  638. <summary>
  639. Prepare the specified database command object.
  640. </summary>
  641. <param name="command">The command to prepare.</param>
  642. <remarks>
  643. <para>
  644. Prepares the database command object by adding
  645. this parameter to its collection of parameters.
  646. </para>
  647. </remarks>
  648. </member>
  649. <member name="M:log4net.Appender.AdoNetAppenderParameter.FormatValue(System.Data.IDbCommand,log4net.Core.LoggingEvent)">
  650. <summary>
  651. Renders the logging event and set the parameter value in the command.
  652. </summary>
  653. <param name="command">The command containing the parameter.</param>
  654. <param name="loggingEvent">The event to be rendered.</param>
  655. <remarks>
  656. <para>
  657. Renders the logging event using this parameters layout
  658. object. Sets the value of the parameter on the command object.
  659. </para>
  660. </remarks>
  661. </member>
  662. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_parameterName">
  663. <summary>
  664. The name of this parameter.
  665. </summary>
  666. </member>
  667. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_dbType">
  668. <summary>
  669. The database type for this parameter.
  670. </summary>
  671. </member>
  672. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_inferType">
  673. <summary>
  674. Flag to infer type rather than use the DbType
  675. </summary>
  676. </member>
  677. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_precision">
  678. <summary>
  679. The precision for this parameter.
  680. </summary>
  681. </member>
  682. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_scale">
  683. <summary>
  684. The scale for this parameter.
  685. </summary>
  686. </member>
  687. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_size">
  688. <summary>
  689. The size for this parameter.
  690. </summary>
  691. </member>
  692. <member name="F:log4net.Appender.AdoNetAppenderParameter.m_layout">
  693. <summary>
  694. The <see cref="T:log4net.Layout.IRawLayout"/> to use to render the
  695. logging event into an object for this parameter.
  696. </summary>
  697. </member>
  698. <member name="T:log4net.Appender.AnsiColorTerminalAppender">
  699. <summary>
  700. Appends logging events to the terminal using ANSI color escape sequences.
  701. </summary>
  702. <remarks>
  703. <para>
  704. AnsiColorTerminalAppender appends log events to the standard output stream
  705. or the error output stream using a layout specified by the
  706. user. It also allows the color of a specific level of message to be set.
  707. </para>
  708. <note>
  709. This appender expects the terminal to understand the VT100 control set
  710. in order to interpret the color codes. If the terminal or console does not
  711. understand the control codes the behavior is not defined.
  712. </note>
  713. <para>
  714. By default, all output is written to the console's standard output stream.
  715. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> property can be set to direct the output to the
  716. error stream.
  717. </para>
  718. <para>
  719. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  720. <c>System.Console.Error</c> that is set at the time the event is appended.
  721. Therefore it is possible to programmatically redirect the output of this appender
  722. (for example NUnit does this to capture program output). While this is the desired
  723. behavior of this appender it may have security implications in your application.
  724. </para>
  725. <para>
  726. When configuring the ANSI colored terminal appender, a mapping should be
  727. specified to map a logging level to a color. For example:
  728. </para>
  729. <code lang="XML" escaped="true">
  730. <mapping>
  731. <level value="ERROR" />
  732. <foreColor value="White" />
  733. <backColor value="Red" />
  734. <attributes value="Bright,Underscore" />
  735. </mapping>
  736. <mapping>
  737. <level value="DEBUG" />
  738. <backColor value="Green" />
  739. </mapping>
  740. </code>
  741. <para>
  742. The Level is the standard log4net logging level and ForeColor and BackColor can be any
  743. of the following values:
  744. <list type="bullet">
  745. <item><term>Blue</term><description></description></item>
  746. <item><term>Green</term><description></description></item>
  747. <item><term>Red</term><description></description></item>
  748. <item><term>White</term><description></description></item>
  749. <item><term>Yellow</term><description></description></item>
  750. <item><term>Purple</term><description></description></item>
  751. <item><term>Cyan</term><description></description></item>
  752. </list>
  753. These color values cannot be combined together to make new colors.
  754. </para>
  755. <para>
  756. The attributes can be any combination of the following:
  757. <list type="bullet">
  758. <item><term>Bright</term><description>foreground is brighter</description></item>
  759. <item><term>Dim</term><description>foreground is dimmer</description></item>
  760. <item><term>Underscore</term><description>message is underlined</description></item>
  761. <item><term>Blink</term><description>foreground is blinking (does not work on all terminals)</description></item>
  762. <item><term>Reverse</term><description>foreground and background are reversed</description></item>
  763. <item><term>Hidden</term><description>output is hidden</description></item>
  764. <item><term>Strikethrough</term><description>message has a line through it</description></item>
  765. </list>
  766. While any of these attributes may be combined together not all combinations
  767. work well together, for example setting both <i>Bright</i> and <i>Dim</i> attributes makes
  768. no sense.
  769. </para>
  770. </remarks>
  771. <author>Patrick Wagstrom</author>
  772. <author>Nicko Cadell</author>
  773. </member>
  774. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes">
  775. <summary>
  776. The enum of possible display attributes
  777. </summary>
  778. <remarks>
  779. <para>
  780. The following flags can be combined together to
  781. form the ANSI color attributes.
  782. </para>
  783. </remarks>
  784. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender" />
  785. </member>
  786. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Bright">
  787. <summary>
  788. text is bright
  789. </summary>
  790. </member>
  791. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Dim">
  792. <summary>
  793. text is dim
  794. </summary>
  795. </member>
  796. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Underscore">
  797. <summary>
  798. text is underlined
  799. </summary>
  800. </member>
  801. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Blink">
  802. <summary>
  803. text is blinking
  804. </summary>
  805. <remarks>
  806. Not all terminals support this attribute
  807. </remarks>
  808. </member>
  809. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Reverse">
  810. <summary>
  811. text and background colors are reversed
  812. </summary>
  813. </member>
  814. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Hidden">
  815. <summary>
  816. text is hidden
  817. </summary>
  818. </member>
  819. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Strikethrough">
  820. <summary>
  821. text is displayed with a strikethrough
  822. </summary>
  823. </member>
  824. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiAttributes.Light">
  825. <summary>
  826. text color is light
  827. </summary>
  828. </member>
  829. <member name="T:log4net.Appender.AnsiColorTerminalAppender.AnsiColor">
  830. <summary>
  831. The enum of possible foreground or background color values for
  832. use with the color mapping method
  833. </summary>
  834. <remarks>
  835. <para>
  836. The output can be in one for the following ANSI colors.
  837. </para>
  838. </remarks>
  839. <seealso cref="T:log4net.Appender.AnsiColorTerminalAppender" />
  840. </member>
  841. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Black">
  842. <summary>
  843. color is black
  844. </summary>
  845. </member>
  846. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Red">
  847. <summary>
  848. color is red
  849. </summary>
  850. </member>
  851. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Green">
  852. <summary>
  853. color is green
  854. </summary>
  855. </member>
  856. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Yellow">
  857. <summary>
  858. color is yellow
  859. </summary>
  860. </member>
  861. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Blue">
  862. <summary>
  863. color is blue
  864. </summary>
  865. </member>
  866. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Magenta">
  867. <summary>
  868. color is magenta
  869. </summary>
  870. </member>
  871. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.Cyan">
  872. <summary>
  873. color is cyan
  874. </summary>
  875. </member>
  876. <member name="F:log4net.Appender.AnsiColorTerminalAppender.AnsiColor.White">
  877. <summary>
  878. color is white
  879. </summary>
  880. </member>
  881. <member name="M:log4net.Appender.AnsiColorTerminalAppender.#ctor">
  882. <summary>
  883. Initializes a new instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender" /> class.
  884. </summary>
  885. <remarks>
  886. The instance of the <see cref="T:log4net.Appender.AnsiColorTerminalAppender" /> class is set up to write
  887. to the standard output stream.
  888. </remarks>
  889. </member>
  890. <member name="P:log4net.Appender.AnsiColorTerminalAppender.Target">
  891. <summary>
  892. Target is the value of the console output stream.
  893. </summary>
  894. <value>
  895. Target is the value of the console output stream.
  896. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  897. </value>
  898. <remarks>
  899. <para>
  900. Target is the value of the console output stream.
  901. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  902. </para>
  903. </remarks>
  904. </member>
  905. <member name="M:log4net.Appender.AnsiColorTerminalAppender.AddMapping(log4net.Appender.AnsiColorTerminalAppender.LevelColors)">
  906. <summary>
  907. Add a mapping of level to color
  908. </summary>
  909. <param name="mapping">The mapping to add</param>
  910. <remarks>
  911. <para>
  912. Add a <see cref="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors"/> mapping to this appender.
  913. Each mapping defines the foreground and background colours
  914. for a level.
  915. </para>
  916. </remarks>
  917. </member>
  918. <member name="M:log4net.Appender.AnsiColorTerminalAppender.Append(log4net.Core.LoggingEvent)">
  919. <summary>
  920. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  921. </summary>
  922. <param name="loggingEvent">The event to log.</param>
  923. <remarks>
  924. <para>
  925. Writes the event to the console.
  926. </para>
  927. <para>
  928. The format of the output will depend on the appender's layout.
  929. </para>
  930. </remarks>
  931. </member>
  932. <member name="P:log4net.Appender.AnsiColorTerminalAppender.RequiresLayout">
  933. <summary>
  934. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  935. </summary>
  936. <value><c>true</c></value>
  937. <remarks>
  938. <para>
  939. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  940. </para>
  941. </remarks>
  942. </member>
  943. <member name="M:log4net.Appender.AnsiColorTerminalAppender.ActivateOptions">
  944. <summary>
  945. Initialize the options for this appender
  946. </summary>
  947. <remarks>
  948. <para>
  949. Initialize the level to color mappings set on this appender.
  950. </para>
  951. </remarks>
  952. </member>
  953. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleOut">
  954. <summary>
  955. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  956. standard output stream.
  957. </summary>
  958. <remarks>
  959. <para>
  960. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  961. standard output stream.
  962. </para>
  963. </remarks>
  964. </member>
  965. <member name="F:log4net.Appender.AnsiColorTerminalAppender.ConsoleError">
  966. <summary>
  967. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  968. standard error output stream.
  969. </summary>
  970. <remarks>
  971. <para>
  972. The <see cref="P:log4net.Appender.AnsiColorTerminalAppender.Target"/> to use when writing to the Console
  973. standard error output stream.
  974. </para>
  975. </remarks>
  976. </member>
  977. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_writeToErrorStream">
  978. <summary>
  979. Flag to write output to the error stream rather than the standard output stream
  980. </summary>
  981. </member>
  982. <member name="F:log4net.Appender.AnsiColorTerminalAppender.m_levelMapping">
  983. <summary>
  984. Mapping from level object to color value
  985. </summary>
  986. </member>
  987. <member name="F:log4net.Appender.AnsiColorTerminalAppender.PostEventCodes">
  988. <summary>
  989. Ansi code to reset terminal
  990. </summary>
  991. </member>
  992. <member name="T:log4net.Appender.AnsiColorTerminalAppender.LevelColors">
  993. <summary>
  994. A class to act as a mapping between the level that a logging call is made at and
  995. the color it should be displayed as.
  996. </summary>
  997. <remarks>
  998. <para>
  999. Defines the mapping between a level and the color it should be displayed in.
  1000. </para>
  1001. </remarks>
  1002. </member>
  1003. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor">
  1004. <summary>
  1005. The mapped foreground color for the specified level
  1006. </summary>
  1007. <remarks>
  1008. <para>
  1009. Required property.
  1010. The mapped foreground color for the specified level
  1011. </para>
  1012. </remarks>
  1013. </member>
  1014. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor">
  1015. <summary>
  1016. The mapped background color for the specified level
  1017. </summary>
  1018. <remarks>
  1019. <para>
  1020. Required property.
  1021. The mapped background color for the specified level
  1022. </para>
  1023. </remarks>
  1024. </member>
  1025. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes">
  1026. <summary>
  1027. The color attributes for the specified level
  1028. </summary>
  1029. <remarks>
  1030. <para>
  1031. Required property.
  1032. The color attributes for the specified level
  1033. </para>
  1034. </remarks>
  1035. </member>
  1036. <member name="M:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ActivateOptions">
  1037. <summary>
  1038. Initialize the options for the object
  1039. </summary>
  1040. <remarks>
  1041. <para>
  1042. Combine the <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/> and <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> together
  1043. and append the attributes.
  1044. </para>
  1045. </remarks>
  1046. </member>
  1047. <member name="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.CombinedColor">
  1048. <summary>
  1049. The combined <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.ForeColor"/>, <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.BackColor"/> and
  1050. <see cref="P:log4net.Appender.AnsiColorTerminalAppender.LevelColors.Attributes"/> suitable for setting the ansi terminal color.
  1051. </summary>
  1052. </member>
  1053. <member name="T:log4net.Appender.AppenderCollection">
  1054. <summary>
  1055. A strongly-typed collection of <see cref="T:log4net.Appender.IAppender"/> objects.
  1056. </summary>
  1057. <author>Nicko Cadell</author>
  1058. </member>
  1059. <member name="T:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator">
  1060. <summary>
  1061. Supports type-safe iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  1062. </summary>
  1063. <exclude/>
  1064. </member>
  1065. <member name="P:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Current">
  1066. <summary>
  1067. Gets the current element in the collection.
  1068. </summary>
  1069. </member>
  1070. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.MoveNext">
  1071. <summary>
  1072. Advances the enumerator to the next element in the collection.
  1073. </summary>
  1074. <returns>
  1075. <c>true</c> if the enumerator was successfully advanced to the next element;
  1076. <c>false</c> if the enumerator has passed the end of the collection.
  1077. </returns>
  1078. <exception cref="T:System.InvalidOperationException">
  1079. The collection was modified after the enumerator was created.
  1080. </exception>
  1081. </member>
  1082. <member name="M:log4net.Appender.AppenderCollection.IAppenderCollectionEnumerator.Reset">
  1083. <summary>
  1084. Sets the enumerator to its initial position, before the first element in the collection.
  1085. </summary>
  1086. </member>
  1087. <member name="M:log4net.Appender.AppenderCollection.ReadOnly(log4net.Appender.AppenderCollection)">
  1088. <summary>
  1089. Creates a read-only wrapper for a <c>AppenderCollection</c> instance.
  1090. </summary>
  1091. <param name="list">list to create a readonly wrapper arround</param>
  1092. <returns>
  1093. An <c>AppenderCollection</c> wrapper that is read-only.
  1094. </returns>
  1095. </member>
  1096. <member name="F:log4net.Appender.AppenderCollection.EmptyCollection">
  1097. <summary>
  1098. An empty readonly static AppenderCollection
  1099. </summary>
  1100. </member>
  1101. <member name="M:log4net.Appender.AppenderCollection.#ctor">
  1102. <summary>
  1103. Initializes a new instance of the <c>AppenderCollection</c> class
  1104. that is empty and has the default initial capacity.
  1105. </summary>
  1106. </member>
  1107. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Int32)">
  1108. <summary>
  1109. Initializes a new instance of the <c>AppenderCollection</c> class
  1110. that has the specified initial capacity.
  1111. </summary>
  1112. <param name="capacity">
  1113. The number of elements that the new <c>AppenderCollection</c> is initially capable of storing.
  1114. </param>
  1115. </member>
  1116. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection)">
  1117. <summary>
  1118. Initializes a new instance of the <c>AppenderCollection</c> class
  1119. that contains elements copied from the specified <c>AppenderCollection</c>.
  1120. </summary>
  1121. <param name="c">The <c>AppenderCollection</c> whose elements are copied to the new collection.</param>
  1122. </member>
  1123. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.IAppender[])">
  1124. <summary>
  1125. Initializes a new instance of the <c>AppenderCollection</c> class
  1126. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> array.
  1127. </summary>
  1128. <param name="a">The <see cref="T:log4net.Appender.IAppender"/> array whose elements are copied to the new list.</param>
  1129. </member>
  1130. <member name="M:log4net.Appender.AppenderCollection.#ctor(System.Collections.ICollection)">
  1131. <summary>
  1132. Initializes a new instance of the <c>AppenderCollection</c> class
  1133. that contains elements copied from the specified <see cref="T:log4net.Appender.IAppender"/> collection.
  1134. </summary>
  1135. <param name="col">The <see cref="T:log4net.Appender.IAppender"/> collection whose elements are copied to the new list.</param>
  1136. </member>
  1137. <member name="T:log4net.Appender.AppenderCollection.Tag">
  1138. <summary>
  1139. Type visible only to our subclasses
  1140. Used to access protected constructor
  1141. </summary>
  1142. <exclude/>
  1143. </member>
  1144. <member name="F:log4net.Appender.AppenderCollection.Tag.Default">
  1145. <summary>
  1146. A value
  1147. </summary>
  1148. </member>
  1149. <member name="M:log4net.Appender.AppenderCollection.#ctor(log4net.Appender.AppenderCollection.Tag)">
  1150. <summary>
  1151. Allow subclasses to avoid our default constructors
  1152. </summary>
  1153. <param name="tag"></param>
  1154. <exclude/>
  1155. </member>
  1156. <member name="P:log4net.Appender.AppenderCollection.Count">
  1157. <summary>
  1158. Gets the number of elements actually contained in the <c>AppenderCollection</c>.
  1159. </summary>
  1160. </member>
  1161. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[])">
  1162. <summary>
  1163. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  1164. <see cref="T:log4net.Appender.IAppender"/> array.
  1165. </summary>
  1166. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  1167. </member>
  1168. <member name="M:log4net.Appender.AppenderCollection.CopyTo(log4net.Appender.IAppender[],System.Int32)">
  1169. <summary>
  1170. Copies the entire <c>AppenderCollection</c> to a one-dimensional
  1171. <see cref="T:log4net.Appender.IAppender"/> array, starting at the specified index of the target array.
  1172. </summary>
  1173. <param name="array">The one-dimensional <see cref="T:log4net.Appender.IAppender"/> array to copy to.</param>
  1174. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  1175. </member>
  1176. <member name="P:log4net.Appender.AppenderCollection.IsSynchronized">
  1177. <summary>
  1178. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  1179. </summary>
  1180. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  1181. </member>
  1182. <member name="P:log4net.Appender.AppenderCollection.SyncRoot">
  1183. <summary>
  1184. Gets an object that can be used to synchronize access to the collection.
  1185. </summary>
  1186. </member>
  1187. <member name="P:log4net.Appender.AppenderCollection.Item(System.Int32)">
  1188. <summary>
  1189. Gets or sets the <see cref="T:log4net.Appender.IAppender"/> at the specified index.
  1190. </summary>
  1191. <param name="index">The zero-based index of the element to get or set.</param>
  1192. <exception cref="T:System.ArgumentOutOfRangeException">
  1193. <para><paramref name="index"/> is less than zero</para>
  1194. <para>-or-</para>
  1195. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1196. </exception>
  1197. </member>
  1198. <member name="M:log4net.Appender.AppenderCollection.Add(log4net.Appender.IAppender)">
  1199. <summary>
  1200. Adds a <see cref="T:log4net.Appender.IAppender"/> to the end of the <c>AppenderCollection</c>.
  1201. </summary>
  1202. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to be added to the end of the <c>AppenderCollection</c>.</param>
  1203. <returns>The index at which the value has been added.</returns>
  1204. </member>
  1205. <member name="M:log4net.Appender.AppenderCollection.Clear">
  1206. <summary>
  1207. Removes all elements from the <c>AppenderCollection</c>.
  1208. </summary>
  1209. </member>
  1210. <member name="M:log4net.Appender.AppenderCollection.Clone">
  1211. <summary>
  1212. Creates a shallow copy of the <see cref="T:log4net.Appender.AppenderCollection"/>.
  1213. </summary>
  1214. <returns>A new <see cref="T:log4net.Appender.AppenderCollection"/> with a shallow copy of the collection data.</returns>
  1215. </member>
  1216. <member name="M:log4net.Appender.AppenderCollection.Contains(log4net.Appender.IAppender)">
  1217. <summary>
  1218. Determines whether a given <see cref="T:log4net.Appender.IAppender"/> is in the <c>AppenderCollection</c>.
  1219. </summary>
  1220. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to check for.</param>
  1221. <returns><c>true</c> if <paramref name="item"/> is found in the <c>AppenderCollection</c>; otherwise, <c>false</c>.</returns>
  1222. </member>
  1223. <member name="M:log4net.Appender.AppenderCollection.IndexOf(log4net.Appender.IAppender)">
  1224. <summary>
  1225. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Appender.IAppender"/>
  1226. in the <c>AppenderCollection</c>.
  1227. </summary>
  1228. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to locate in the <c>AppenderCollection</c>.</param>
  1229. <returns>
  1230. The zero-based index of the first occurrence of <paramref name="item"/>
  1231. in the entire <c>AppenderCollection</c>, if found; otherwise, -1.
  1232. </returns>
  1233. </member>
  1234. <member name="M:log4net.Appender.AppenderCollection.Insert(System.Int32,log4net.Appender.IAppender)">
  1235. <summary>
  1236. Inserts an element into the <c>AppenderCollection</c> at the specified index.
  1237. </summary>
  1238. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  1239. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to insert.</param>
  1240. <exception cref="T:System.ArgumentOutOfRangeException">
  1241. <para><paramref name="index"/> is less than zero</para>
  1242. <para>-or-</para>
  1243. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1244. </exception>
  1245. </member>
  1246. <member name="M:log4net.Appender.AppenderCollection.Remove(log4net.Appender.IAppender)">
  1247. <summary>
  1248. Removes the first occurrence of a specific <see cref="T:log4net.Appender.IAppender"/> from the <c>AppenderCollection</c>.
  1249. </summary>
  1250. <param name="item">The <see cref="T:log4net.Appender.IAppender"/> to remove from the <c>AppenderCollection</c>.</param>
  1251. <exception cref="T:System.ArgumentException">
  1252. The specified <see cref="T:log4net.Appender.IAppender"/> was not found in the <c>AppenderCollection</c>.
  1253. </exception>
  1254. </member>
  1255. <member name="M:log4net.Appender.AppenderCollection.RemoveAt(System.Int32)">
  1256. <summary>
  1257. Removes the element at the specified index of the <c>AppenderCollection</c>.
  1258. </summary>
  1259. <param name="index">The zero-based index of the element to remove.</param>
  1260. <exception cref="T:System.ArgumentOutOfRangeException">
  1261. <para><paramref name="index"/> is less than zero</para>
  1262. <para>-or-</para>
  1263. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1264. </exception>
  1265. </member>
  1266. <member name="P:log4net.Appender.AppenderCollection.IsFixedSize">
  1267. <summary>
  1268. Gets a value indicating whether the collection has a fixed size.
  1269. </summary>
  1270. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  1271. </member>
  1272. <member name="P:log4net.Appender.AppenderCollection.IsReadOnly">
  1273. <summary>
  1274. Gets a value indicating whether the IList is read-only.
  1275. </summary>
  1276. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  1277. </member>
  1278. <member name="M:log4net.Appender.AppenderCollection.GetEnumerator">
  1279. <summary>
  1280. Returns an enumerator that can iterate through the <c>AppenderCollection</c>.
  1281. </summary>
  1282. <returns>An <see cref="T:log4net.Appender.AppenderCollection.Enumerator"/> for the entire <c>AppenderCollection</c>.</returns>
  1283. </member>
  1284. <member name="P:log4net.Appender.AppenderCollection.Capacity">
  1285. <summary>
  1286. Gets or sets the number of elements the <c>AppenderCollection</c> can contain.
  1287. </summary>
  1288. </member>
  1289. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.AppenderCollection)">
  1290. <summary>
  1291. Adds the elements of another <c>AppenderCollection</c> to the current <c>AppenderCollection</c>.
  1292. </summary>
  1293. <param name="x">The <c>AppenderCollection</c> whose elements should be added to the end of the current <c>AppenderCollection</c>.</param>
  1294. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1295. </member>
  1296. <member name="M:log4net.Appender.AppenderCollection.AddRange(log4net.Appender.IAppender[])">
  1297. <summary>
  1298. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> array to the current <c>AppenderCollection</c>.
  1299. </summary>
  1300. <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>
  1301. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1302. </member>
  1303. <member name="M:log4net.Appender.AppenderCollection.AddRange(System.Collections.ICollection)">
  1304. <summary>
  1305. Adds the elements of a <see cref="T:log4net.Appender.IAppender"/> collection to the current <c>AppenderCollection</c>.
  1306. </summary>
  1307. <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>
  1308. <returns>The new <see cref="P:log4net.Appender.AppenderCollection.Count"/> of the <c>AppenderCollection</c>.</returns>
  1309. </member>
  1310. <member name="M:log4net.Appender.AppenderCollection.TrimToSize">
  1311. <summary>
  1312. Sets the capacity to the actual number of elements.
  1313. </summary>
  1314. </member>
  1315. <member name="M:log4net.Appender.AppenderCollection.ToArray">
  1316. <summary>
  1317. Return the collection elements as an array
  1318. </summary>
  1319. <returns>the array</returns>
  1320. </member>
  1321. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32)">
  1322. <exception cref="T:System.ArgumentOutOfRangeException">
  1323. <para><paramref name="i"/> is less than zero</para>
  1324. <para>-or-</para>
  1325. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1326. </exception>
  1327. </member>
  1328. <member name="M:log4net.Appender.AppenderCollection.ValidateIndex(System.Int32,System.Boolean)">
  1329. <exception cref="T:System.ArgumentOutOfRangeException">
  1330. <para><paramref name="i"/> is less than zero</para>
  1331. <para>-or-</para>
  1332. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Appender.AppenderCollection.Count"/>.</para>
  1333. </exception>
  1334. </member>
  1335. <member name="T:log4net.Appender.AppenderCollection.Enumerator">
  1336. <summary>
  1337. Supports simple iteration over a <see cref="T:log4net.Appender.AppenderCollection"/>.
  1338. </summary>
  1339. <exclude/>
  1340. </member>
  1341. <member name="M:log4net.Appender.AppenderCollection.Enumerator.#ctor(log4net.Appender.AppenderCollection)">
  1342. <summary>
  1343. Initializes a new instance of the <c>Enumerator</c> class.
  1344. </summary>
  1345. <param name="tc"></param>
  1346. </member>
  1347. <member name="P:log4net.Appender.AppenderCollection.Enumerator.Current">
  1348. <summary>
  1349. Gets the current element in the collection.
  1350. </summary>
  1351. </member>
  1352. <member name="M:log4net.Appender.AppenderCollection.Enumerator.MoveNext">
  1353. <summary>
  1354. Advances the enumerator to the next element in the collection.
  1355. </summary>
  1356. <returns>
  1357. <c>true</c> if the enumerator was successfully advanced to the next element;
  1358. <c>false</c> if the enumerator has passed the end of the collection.
  1359. </returns>
  1360. <exception cref="T:System.InvalidOperationException">
  1361. The collection was modified after the enumerator was created.
  1362. </exception>
  1363. </member>
  1364. <member name="M:log4net.Appender.AppenderCollection.Enumerator.Reset">
  1365. <summary>
  1366. Sets the enumerator to its initial position, before the first element in the collection.
  1367. </summary>
  1368. </member>
  1369. <member name="T:log4net.Appender.AppenderCollection.ReadOnlyAppenderCollection">
  1370. <exclude/>
  1371. </member>
  1372. <member name="T:log4net.Appender.AppenderSkeleton">
  1373. <summary>
  1374. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/>.
  1375. </summary>
  1376. <remarks>
  1377. <para>
  1378. This class provides the code for common functionality, such
  1379. as support for threshold filtering and support for general filters.
  1380. </para>
  1381. <para>
  1382. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  1383. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  1384. be called after the appenders properties have been configured.
  1385. </para>
  1386. </remarks>
  1387. <author>Nicko Cadell</author>
  1388. <author>Gert Driesen</author>
  1389. </member>
  1390. <member name="M:log4net.Appender.AppenderSkeleton.#ctor">
  1391. <summary>
  1392. Default constructor
  1393. </summary>
  1394. <remarks>
  1395. <para>Empty default constructor</para>
  1396. </remarks>
  1397. </member>
  1398. <member name="M:log4net.Appender.AppenderSkeleton.Finalize">
  1399. <summary>
  1400. Finalizes this appender by calling the implementation's
  1401. <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> method.
  1402. </summary>
  1403. <remarks>
  1404. <para>
  1405. If this appender has not been closed then the <c>Finalize</c> method
  1406. will call <see cref="M:log4net.Appender.AppenderSkeleton.Close"/>.
  1407. </para>
  1408. </remarks>
  1409. </member>
  1410. <member name="P:log4net.Appender.AppenderSkeleton.Threshold">
  1411. <summary>
  1412. Gets or sets the threshold <see cref="T:log4net.Core.Level"/> of this appender.
  1413. </summary>
  1414. <value>
  1415. The threshold <see cref="T:log4net.Core.Level"/> of the appender.
  1416. </value>
  1417. <remarks>
  1418. <para>
  1419. All log events with lower level than the threshold level are ignored
  1420. by the appender.
  1421. </para>
  1422. <para>
  1423. In configuration files this option is specified by setting the
  1424. value of the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> option to a level
  1425. string, such as "DEBUG", "INFO" and so on.
  1426. </para>
  1427. </remarks>
  1428. </member>
  1429. <member name="P:log4net.Appender.AppenderSkeleton.ErrorHandler">
  1430. <summary>
  1431. Gets or sets the <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  1432. </summary>
  1433. <value>The <see cref="T:log4net.Core.IErrorHandler"/> of the appender</value>
  1434. <remarks>
  1435. <para>
  1436. The <see cref="T:log4net.Appender.AppenderSkeleton"/> provides a default
  1437. implementation for the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> property.
  1438. </para>
  1439. </remarks>
  1440. </member>
  1441. <member name="P:log4net.Appender.AppenderSkeleton.FilterHead">
  1442. <summary>
  1443. The filter chain.
  1444. </summary>
  1445. <value>The head of the filter chain filter chain.</value>
  1446. <remarks>
  1447. <para>
  1448. Returns the head Filter. The Filters are organized in a linked list
  1449. and so all Filters on this Appender are available through the result.
  1450. </para>
  1451. </remarks>
  1452. </member>
  1453. <member name="P:log4net.Appender.AppenderSkeleton.Layout">
  1454. <summary>
  1455. Gets or sets the <see cref="T:log4net.Layout.ILayout"/> for this appender.
  1456. </summary>
  1457. <value>The layout of the appender.</value>
  1458. <remarks>
  1459. <para>
  1460. See <see cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/> for more information.
  1461. </para>
  1462. </remarks>
  1463. <seealso cref="P:log4net.Appender.AppenderSkeleton.RequiresLayout"/>
  1464. </member>
  1465. <member name="M:log4net.Appender.AppenderSkeleton.ActivateOptions">
  1466. <summary>
  1467. Initialize the appender based on the options set
  1468. </summary>
  1469. <remarks>
  1470. <para>
  1471. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  1472. activation scheme. The <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> method must
  1473. be called on this object after the configuration properties have
  1474. been set. Until <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> is called this
  1475. object is in an undefined state and must not be used.
  1476. </para>
  1477. <para>
  1478. If any of the configuration properties are modified then
  1479. <see cref="M:log4net.Appender.AppenderSkeleton.ActivateOptions"/> must be called again.
  1480. </para>
  1481. </remarks>
  1482. </member>
  1483. <member name="P:log4net.Appender.AppenderSkeleton.Name">
  1484. <summary>
  1485. Gets or sets the name of this appender.
  1486. </summary>
  1487. <value>The name of the appender.</value>
  1488. <remarks>
  1489. <para>
  1490. The name uniquely identifies the appender.
  1491. </para>
  1492. </remarks>
  1493. </member>
  1494. <member name="M:log4net.Appender.AppenderSkeleton.Close">
  1495. <summary>
  1496. Closes the appender and release resources.
  1497. </summary>
  1498. <remarks>
  1499. <para>
  1500. Release any resources allocated within the appender such as file handles,
  1501. network connections, etc.
  1502. </para>
  1503. <para>
  1504. It is a programming error to append to a closed appender.
  1505. </para>
  1506. <para>
  1507. This method cannot be overridden by subclasses. This method
  1508. delegates the closing of the appender to the <see cref="M:log4net.Appender.AppenderSkeleton.OnClose"/>
  1509. method which must be overridden in the subclass.
  1510. </para>
  1511. </remarks>
  1512. </member>
  1513. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)">
  1514. <summary>
  1515. Performs threshold checks and invokes filters before
  1516. delegating actual logging to the subclasses specific
  1517. <see cref="M:Append(LoggingEvent)"/> method.
  1518. </summary>
  1519. <param name="loggingEvent">The event to log.</param>
  1520. <remarks>
  1521. <para>
  1522. This method cannot be overridden by derived classes. A
  1523. derived class should override the <see cref="M:Append(LoggingEvent)"/> method
  1524. which is called by this method.
  1525. </para>
  1526. <para>
  1527. The implementation of this method is as follows:
  1528. </para>
  1529. <para>
  1530. <list type="bullet">
  1531. <item>
  1532. <description>
  1533. Checks that the severity of the <paramref name="loggingEvent"/>
  1534. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1535. appender.</description>
  1536. </item>
  1537. <item>
  1538. <description>
  1539. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1540. <paramref name="loggingEvent"/>.
  1541. </description>
  1542. </item>
  1543. <item>
  1544. <description>
  1545. Calls <see cref="M:PreAppendCheck()"/> and checks that
  1546. it returns <c>true</c>.</description>
  1547. </item>
  1548. </list>
  1549. </para>
  1550. <para>
  1551. If all of the above steps succeed then the <paramref name="loggingEvent"/>
  1552. will be passed to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  1553. </para>
  1554. </remarks>
  1555. </member>
  1556. <member name="M:log4net.Appender.AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent[])">
  1557. <summary>
  1558. Performs threshold checks and invokes filters before
  1559. delegating actual logging to the subclasses specific
  1560. <see cref="M:Append(LoggingEvent[])"/> method.
  1561. </summary>
  1562. <param name="loggingEvents">The array of events to log.</param>
  1563. <remarks>
  1564. <para>
  1565. This method cannot be overridden by derived classes. A
  1566. derived class should override the <see cref="M:Append(LoggingEvent[])"/> method
  1567. which is called by this method.
  1568. </para>
  1569. <para>
  1570. The implementation of this method is as follows:
  1571. </para>
  1572. <para>
  1573. <list type="bullet">
  1574. <item>
  1575. <description>
  1576. Checks that the severity of the <paramref name="loggingEvents"/>
  1577. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1578. appender.</description>
  1579. </item>
  1580. <item>
  1581. <description>
  1582. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1583. <paramref name="loggingEvents"/>.
  1584. </description>
  1585. </item>
  1586. <item>
  1587. <description>
  1588. Calls <see cref="M:PreAppendCheck()"/> and checks that
  1589. it returns <c>true</c>.</description>
  1590. </item>
  1591. </list>
  1592. </para>
  1593. <para>
  1594. If all of the above steps succeed then the <paramref name="loggingEvents"/>
  1595. will be passed to the <see cref="M:Append(LoggingEvent[])"/> method.
  1596. </para>
  1597. </remarks>
  1598. </member>
  1599. <member name="M:log4net.Appender.AppenderSkeleton.FilterEvent(log4net.Core.LoggingEvent)">
  1600. <summary>
  1601. Test if the logging event should we output by this appender
  1602. </summary>
  1603. <param name="loggingEvent">the event to test</param>
  1604. <returns><c>true</c> if the event should be output, <c>false</c> if the event should be ignored</returns>
  1605. <remarks>
  1606. <para>
  1607. This method checks the logging event against the threshold level set
  1608. on this appender and also against the filters specified on this
  1609. appender.
  1610. </para>
  1611. <para>
  1612. The implementation of this method is as follows:
  1613. </para>
  1614. <para>
  1615. <list type="bullet">
  1616. <item>
  1617. <description>
  1618. Checks that the severity of the <paramref name="loggingEvent"/>
  1619. is greater than or equal to the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> of this
  1620. appender.</description>
  1621. </item>
  1622. <item>
  1623. <description>
  1624. Checks that the <see cref="T:log4net.Filter.IFilter"/> chain accepts the
  1625. <paramref name="loggingEvent"/>.
  1626. </description>
  1627. </item>
  1628. </list>
  1629. </para>
  1630. </remarks>
  1631. </member>
  1632. <member name="M:log4net.Appender.AppenderSkeleton.AddFilter(log4net.Filter.IFilter)">
  1633. <summary>
  1634. Adds a filter to the end of the filter chain.
  1635. </summary>
  1636. <param name="filter">the filter to add to this appender</param>
  1637. <remarks>
  1638. <para>
  1639. The Filters are organized in a linked list.
  1640. </para>
  1641. <para>
  1642. Setting this property causes the new filter to be pushed onto the
  1643. back of the filter chain.
  1644. </para>
  1645. </remarks>
  1646. </member>
  1647. <member name="M:log4net.Appender.AppenderSkeleton.ClearFilters">
  1648. <summary>
  1649. Clears the filter list for this appender.
  1650. </summary>
  1651. <remarks>
  1652. <para>
  1653. Clears the filter list for this appender.
  1654. </para>
  1655. </remarks>
  1656. </member>
  1657. <member name="M:log4net.Appender.AppenderSkeleton.IsAsSevereAsThreshold(log4net.Core.Level)">
  1658. <summary>
  1659. Checks if the message level is below this appender's threshold.
  1660. </summary>
  1661. <param name="level"><see cref="T:log4net.Core.Level"/> to test against.</param>
  1662. <remarks>
  1663. <para>
  1664. If there is no threshold set, then the return value is always <c>true</c>.
  1665. </para>
  1666. </remarks>
  1667. <returns>
  1668. <c>true</c> if the <paramref name="level"/> meets the <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/>
  1669. requirements of this appender.
  1670. </returns>
  1671. </member>
  1672. <member name="M:log4net.Appender.AppenderSkeleton.OnClose">
  1673. <summary>
  1674. Is called when the appender is closed. Derived classes should override
  1675. this method if resources need to be released.
  1676. </summary>
  1677. <remarks>
  1678. <para>
  1679. Releases any resources allocated within the appender such as file handles,
  1680. network connections, etc.
  1681. </para>
  1682. <para>
  1683. It is a programming error to append to a closed appender.
  1684. </para>
  1685. </remarks>
  1686. </member>
  1687. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  1688. <summary>
  1689. Subclasses of <see cref="T:log4net.Appender.AppenderSkeleton"/> should implement this method
  1690. to perform actual logging.
  1691. </summary>
  1692. <param name="loggingEvent">The event to append.</param>
  1693. <remarks>
  1694. <para>
  1695. A subclass must implement this method to perform
  1696. logging of the <paramref name="loggingEvent"/>.
  1697. </para>
  1698. <para>This method will be called by <see cref="M:DoAppend(LoggingEvent)"/>
  1699. if all the conditions listed for that method are met.
  1700. </para>
  1701. <para>
  1702. To restrict the logging of events in the appender
  1703. override the <see cref="M:PreAppendCheck()"/> method.
  1704. </para>
  1705. </remarks>
  1706. </member>
  1707. <member name="M:log4net.Appender.AppenderSkeleton.Append(log4net.Core.LoggingEvent[])">
  1708. <summary>
  1709. Append a bulk array of logging events.
  1710. </summary>
  1711. <param name="loggingEvents">the array of logging events</param>
  1712. <remarks>
  1713. <para>
  1714. This base class implementation calls the <see cref="M:Append(LoggingEvent)"/>
  1715. method for each element in the bulk array.
  1716. </para>
  1717. <para>
  1718. A sub class that can better process a bulk array of events should
  1719. override this method in addition to <see cref="M:Append(LoggingEvent)"/>.
  1720. </para>
  1721. </remarks>
  1722. </member>
  1723. <member name="M:log4net.Appender.AppenderSkeleton.PreAppendCheck">
  1724. <summary>
  1725. Called before <see cref="M:Append(LoggingEvent)"/> as a precondition.
  1726. </summary>
  1727. <remarks>
  1728. <para>
  1729. This method is called by <see cref="M:DoAppend(LoggingEvent)"/>
  1730. before the call to the abstract <see cref="M:Append(LoggingEvent)"/> method.
  1731. </para>
  1732. <para>
  1733. This method can be overridden in a subclass to extend the checks
  1734. made before the event is passed to the <see cref="M:Append(LoggingEvent)"/> method.
  1735. </para>
  1736. <para>
  1737. A subclass should ensure that they delegate this call to
  1738. this base class if it is overridden.
  1739. </para>
  1740. </remarks>
  1741. <returns><c>true</c> if the call to <see cref="M:Append(LoggingEvent)"/> should proceed.</returns>
  1742. </member>
  1743. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(log4net.Core.LoggingEvent)">
  1744. <summary>
  1745. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  1746. </summary>
  1747. <param name="loggingEvent">The event to render.</param>
  1748. <returns>The event rendered as a string.</returns>
  1749. <remarks>
  1750. <para>
  1751. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  1752. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  1753. set to render the <paramref name="loggingEvent"/> to
  1754. a string.
  1755. </para>
  1756. <para>If there is exception data in the logging event and
  1757. the layout does not process the exception, this method
  1758. will append the exception text to the rendered string.
  1759. </para>
  1760. <para>
  1761. Where possible use the alternative version of this method
  1762. <see cref="M:RenderLoggingEvent(TextWriter,LoggingEvent)"/>.
  1763. That method streams the rendering onto an existing Writer
  1764. which can give better performance if the caller already has
  1765. a <see cref="T:System.IO.TextWriter"/> open and ready for writing.
  1766. </para>
  1767. </remarks>
  1768. </member>
  1769. <member name="M:log4net.Appender.AppenderSkeleton.RenderLoggingEvent(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  1770. <summary>
  1771. Renders the <see cref="T:log4net.Core.LoggingEvent"/> to a string.
  1772. </summary>
  1773. <param name="loggingEvent">The event to render.</param>
  1774. <param name="writer">The TextWriter to write the formatted event to</param>
  1775. <remarks>
  1776. <para>
  1777. Helper method to render a <see cref="T:log4net.Core.LoggingEvent"/> to
  1778. a string. This appender must have a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/>
  1779. set to render the <paramref name="loggingEvent"/> to
  1780. a string.
  1781. </para>
  1782. <para>If there is exception data in the logging event and
  1783. the layout does not process the exception, this method
  1784. will append the exception text to the rendered string.
  1785. </para>
  1786. <para>
  1787. Use this method in preference to <see cref="M:RenderLoggingEvent(LoggingEvent)"/>
  1788. where possible. If, however, the caller needs to render the event
  1789. to a string then <see cref="M:RenderLoggingEvent(LoggingEvent)"/> does
  1790. provide an efficient mechanism for doing so.
  1791. </para>
  1792. </remarks>
  1793. </member>
  1794. <member name="P:log4net.Appender.AppenderSkeleton.RequiresLayout">
  1795. <summary>
  1796. Tests if this appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  1797. </summary>
  1798. <remarks>
  1799. <para>
  1800. In the rather exceptional case, where the appender
  1801. implementation admits a layout but can also work without it,
  1802. then the appender should return <c>true</c>.
  1803. </para>
  1804. <para>
  1805. This default implementation always returns <c>false</c>.
  1806. </para>
  1807. </remarks>
  1808. <returns>
  1809. <c>true</c> if the appender requires a layout object, otherwise <c>false</c>.
  1810. </returns>
  1811. </member>
  1812. <member name="M:log4net.Appender.AppenderSkeleton.Flush(System.Int32)">
  1813. <summary>
  1814. Flushes any buffered log data.
  1815. </summary>
  1816. <remarks>
  1817. This implementation doesn't flush anything and always returns true
  1818. </remarks>
  1819. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  1820. </member>
  1821. <member name="F:log4net.Appender.AppenderSkeleton.m_layout">
  1822. <summary>
  1823. The layout of this appender.
  1824. </summary>
  1825. <remarks>
  1826. See <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> for more information.
  1827. </remarks>
  1828. </member>
  1829. <member name="F:log4net.Appender.AppenderSkeleton.m_name">
  1830. <summary>
  1831. The name of this appender.
  1832. </summary>
  1833. <remarks>
  1834. See <see cref="P:log4net.Appender.AppenderSkeleton.Name"/> for more information.
  1835. </remarks>
  1836. </member>
  1837. <member name="F:log4net.Appender.AppenderSkeleton.m_threshold">
  1838. <summary>
  1839. The level threshold of this appender.
  1840. </summary>
  1841. <remarks>
  1842. <para>
  1843. There is no level threshold filtering by default.
  1844. </para>
  1845. <para>
  1846. See <see cref="P:log4net.Appender.AppenderSkeleton.Threshold"/> for more information.
  1847. </para>
  1848. </remarks>
  1849. </member>
  1850. <member name="F:log4net.Appender.AppenderSkeleton.m_errorHandler">
  1851. <summary>
  1852. It is assumed and enforced that errorHandler is never null.
  1853. </summary>
  1854. <remarks>
  1855. <para>
  1856. It is assumed and enforced that errorHandler is never null.
  1857. </para>
  1858. <para>
  1859. See <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/> for more information.
  1860. </para>
  1861. </remarks>
  1862. </member>
  1863. <member name="F:log4net.Appender.AppenderSkeleton.m_headFilter">
  1864. <summary>
  1865. The first filter in the filter chain.
  1866. </summary>
  1867. <remarks>
  1868. <para>
  1869. Set to <c>null</c> initially.
  1870. </para>
  1871. <para>
  1872. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  1873. </para>
  1874. </remarks>
  1875. </member>
  1876. <member name="F:log4net.Appender.AppenderSkeleton.m_tailFilter">
  1877. <summary>
  1878. The last filter in the filter chain.
  1879. </summary>
  1880. <remarks>
  1881. See <see cref="T:log4net.Filter.IFilter"/> for more information.
  1882. </remarks>
  1883. </member>
  1884. <member name="F:log4net.Appender.AppenderSkeleton.m_closed">
  1885. <summary>
  1886. Flag indicating if this appender is closed.
  1887. </summary>
  1888. <remarks>
  1889. See <see cref="M:log4net.Appender.AppenderSkeleton.Close"/> for more information.
  1890. </remarks>
  1891. </member>
  1892. <member name="F:log4net.Appender.AppenderSkeleton.m_recursiveGuard">
  1893. <summary>
  1894. The guard prevents an appender from repeatedly calling its own DoAppend method
  1895. </summary>
  1896. </member>
  1897. <member name="F:log4net.Appender.AppenderSkeleton.m_renderWriter">
  1898. <summary>
  1899. StringWriter used to render events
  1900. </summary>
  1901. </member>
  1902. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferSize">
  1903. <summary>
  1904. Initial buffer size
  1905. </summary>
  1906. </member>
  1907. <member name="F:log4net.Appender.AppenderSkeleton.c_renderBufferMaxCapacity">
  1908. <summary>
  1909. Maximum buffer size before it is recycled
  1910. </summary>
  1911. </member>
  1912. <member name="F:log4net.Appender.AppenderSkeleton.declaringType">
  1913. <summary>
  1914. The fully qualified type of the AppenderSkeleton class.
  1915. </summary>
  1916. <remarks>
  1917. Used by the internal logger to record the Type of the
  1918. log message.
  1919. </remarks>
  1920. </member>
  1921. <member name="T:log4net.Appender.BufferingAppenderSkeleton">
  1922. <summary>
  1923. Abstract base class implementation of <see cref="T:log4net.Appender.IAppender"/> that
  1924. buffers events in a fixed size buffer.
  1925. </summary>
  1926. <remarks>
  1927. <para>
  1928. This base class should be used by appenders that need to buffer a
  1929. number of events before logging them.
  1930. For example the <see cref="T:log4net.Appender.AdoNetAppender"/>
  1931. buffers events and then submits the entire contents of the buffer to
  1932. the underlying database in one go.
  1933. </para>
  1934. <para>
  1935. Subclasses should override the <see cref="M:SendBuffer(LoggingEvent[])"/>
  1936. method to deliver the buffered events.
  1937. </para>
  1938. <para>The BufferingAppenderSkeleton maintains a fixed size cyclic
  1939. buffer of events. The size of the buffer is set using
  1940. the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> property.
  1941. </para>
  1942. <para>A <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> is used to inspect
  1943. each event as it arrives in the appender. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  1944. triggers, then the current buffer is sent immediately
  1945. (see <see cref="M:SendBuffer(LoggingEvent[])"/>). Otherwise the event
  1946. is stored in the buffer. For example, an evaluator can be used to
  1947. deliver the events immediately when an ERROR event arrives.
  1948. </para>
  1949. <para>
  1950. The buffering appender can be configured in a <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode.
  1951. By default the appender is NOT lossy. When the buffer is full all
  1952. the buffered events are sent with <see cref="M:SendBuffer(LoggingEvent[])"/>.
  1953. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property is set to <c>true</c> then the
  1954. buffer will not be sent when it is full, and new events arriving
  1955. in the appender will overwrite the oldest event in the buffer.
  1956. In lossy mode the buffer will only be sent when the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/>
  1957. triggers. This can be useful behavior when you need to know about
  1958. ERROR events but not about events with a lower level, configure an
  1959. evaluator that will trigger when an ERROR event arrives, the whole
  1960. buffer will be sent which gives a history of events leading up to
  1961. the ERROR event.
  1962. </para>
  1963. </remarks>
  1964. <author>Nicko Cadell</author>
  1965. <author>Gert Driesen</author>
  1966. </member>
  1967. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor">
  1968. <summary>
  1969. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton" /> class.
  1970. </summary>
  1971. <remarks>
  1972. <para>
  1973. Protected default constructor to allow subclassing.
  1974. </para>
  1975. </remarks>
  1976. </member>
  1977. <member name="M:log4net.Appender.BufferingAppenderSkeleton.#ctor(System.Boolean)">
  1978. <summary>
  1979. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingAppenderSkeleton" /> class.
  1980. </summary>
  1981. <param name="eventMustBeFixed">the events passed through this appender must be
  1982. fixed by the time that they arrive in the derived class' <c>SendBuffer</c> method.</param>
  1983. <remarks>
  1984. <para>
  1985. Protected constructor to allow subclassing.
  1986. </para>
  1987. <para>
  1988. The <paramref name="eventMustBeFixed"/> should be set if the subclass
  1989. expects the events delivered to be fixed even if the
  1990. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to zero, i.e. when no buffering occurs.
  1991. </para>
  1992. </remarks>
  1993. </member>
  1994. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Lossy">
  1995. <summary>
  1996. Gets or sets a value that indicates whether the appender is lossy.
  1997. </summary>
  1998. <value>
  1999. <c>true</c> if the appender is lossy, otherwise <c>false</c>. The default is <c>false</c>.
  2000. </value>
  2001. <remarks>
  2002. <para>
  2003. This appender uses a buffer to store logging events before
  2004. delivering them. A triggering event causes the whole buffer
  2005. to be send to the remote sink. If the buffer overruns before
  2006. a triggering event then logging events could be lost. Set
  2007. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> to <c>false</c> to prevent logging events
  2008. from being lost.
  2009. </para>
  2010. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  2011. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  2012. </remarks>
  2013. </member>
  2014. <member name="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize">
  2015. <summary>
  2016. Gets or sets the size of the cyclic buffer used to hold the
  2017. logging events.
  2018. </summary>
  2019. <value>
  2020. The size of the cyclic buffer used to hold the logging events.
  2021. </value>
  2022. <remarks>
  2023. <para>
  2024. The <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option takes a positive integer
  2025. representing the maximum number of logging events to collect in
  2026. a cyclic buffer. When the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is reached,
  2027. oldest events are deleted as new events are added to the
  2028. buffer. By default the size of the cyclic buffer is 512 events.
  2029. </para>
  2030. <para>
  2031. If the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> is set to a value less than
  2032. or equal to 1 then no buffering will occur. The logging event
  2033. will be delivered synchronously (depending on the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>
  2034. and <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> properties). Otherwise the event will
  2035. be buffered.
  2036. </para>
  2037. </remarks>
  2038. </member>
  2039. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator">
  2040. <summary>
  2041. Gets or sets the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the
  2042. buffer to be sent immediately.
  2043. </summary>
  2044. <value>
  2045. The <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> that causes the buffer to be
  2046. sent immediately.
  2047. </value>
  2048. <remarks>
  2049. <para>
  2050. The evaluator will be called for each event that is appended to this
  2051. appender. If the evaluator triggers then the current buffer will
  2052. immediately be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  2053. </para>
  2054. <para>If <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> is set to <c>true</c> then an
  2055. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be specified.</para>
  2056. </remarks>
  2057. </member>
  2058. <member name="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator">
  2059. <summary>
  2060. Gets or sets the value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  2061. </summary>
  2062. <value>
  2063. The value of the <see cref="T:log4net.Core.ITriggeringEventEvaluator"/> to use.
  2064. </value>
  2065. <remarks>
  2066. <para>
  2067. The evaluator will be called for each event that is discarded from this
  2068. appender. If the evaluator triggers then the current buffer will immediately
  2069. be sent (see <see cref="M:SendBuffer(LoggingEvent[])"/>).
  2070. </para>
  2071. </remarks>
  2072. </member>
  2073. <member name="P:log4net.Appender.BufferingAppenderSkeleton.OnlyFixPartialEventData">
  2074. <summary>
  2075. Gets or sets a value indicating if only part of the logging event data
  2076. should be fixed.
  2077. </summary>
  2078. <value>
  2079. <c>true</c> if the appender should only fix part of the logging event
  2080. data, otherwise <c>false</c>. The default is <c>false</c>.
  2081. </value>
  2082. <remarks>
  2083. <para>
  2084. Setting this property to <c>true</c> will cause only part of the
  2085. event data to be fixed and serialized. This will improve performance.
  2086. </para>
  2087. <para>
  2088. See <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/> for more information.
  2089. </para>
  2090. </remarks>
  2091. </member>
  2092. <member name="P:log4net.Appender.BufferingAppenderSkeleton.Fix">
  2093. <summary>
  2094. Gets or sets a the fields that will be fixed in the event
  2095. </summary>
  2096. <value>
  2097. The event fields that will be fixed before the event is buffered
  2098. </value>
  2099. <remarks>
  2100. <para>
  2101. The logging event needs to have certain thread specific values
  2102. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  2103. for details.
  2104. </para>
  2105. </remarks>
  2106. <seealso cref="P:log4net.Core.LoggingEvent.Fix"/>
  2107. </member>
  2108. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Int32)">
  2109. <summary>
  2110. Flushes any buffered log data.
  2111. </summary>
  2112. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  2113. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  2114. </member>
  2115. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush">
  2116. <summary>
  2117. Flush the currently buffered events
  2118. </summary>
  2119. <remarks>
  2120. <para>
  2121. Flushes any events that have been buffered.
  2122. </para>
  2123. <para>
  2124. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  2125. of the buffer will NOT be flushed to the appender.
  2126. </para>
  2127. </remarks>
  2128. </member>
  2129. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Flush(System.Boolean)">
  2130. <summary>
  2131. Flush the currently buffered events
  2132. </summary>
  2133. <param name="flushLossyBuffer">set to <c>true</c> to flush the buffer of lossy events</param>
  2134. <remarks>
  2135. <para>
  2136. Flushes events that have been buffered. If <paramref name="flushLossyBuffer" /> is
  2137. <c>false</c> then events will only be flushed if this buffer is non-lossy mode.
  2138. </para>
  2139. <para>
  2140. If the appender is buffering in <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> mode then the contents
  2141. of the buffer will only be flushed if <paramref name="flushLossyBuffer" /> is <c>true</c>.
  2142. In this case the contents of the buffer will be tested against the
  2143. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.LossyEvaluator"/> and if triggering will be output. All other buffered
  2144. events will be discarded.
  2145. </para>
  2146. <para>
  2147. If <paramref name="flushLossyBuffer" /> is <c>true</c> then the buffer will always
  2148. be emptied by calling this method.
  2149. </para>
  2150. </remarks>
  2151. </member>
  2152. <member name="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions">
  2153. <summary>
  2154. Initialize the appender based on the options set
  2155. </summary>
  2156. <remarks>
  2157. <para>
  2158. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  2159. activation scheme. The <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> method must
  2160. be called on this object after the configuration properties have
  2161. been set. Until <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> is called this
  2162. object is in an undefined state and must not be used.
  2163. </para>
  2164. <para>
  2165. If any of the configuration properties are modified then
  2166. <see cref="M:log4net.Appender.BufferingAppenderSkeleton.ActivateOptions"/> must be called again.
  2167. </para>
  2168. </remarks>
  2169. </member>
  2170. <member name="M:log4net.Appender.BufferingAppenderSkeleton.OnClose">
  2171. <summary>
  2172. Close this appender instance.
  2173. </summary>
  2174. <remarks>
  2175. <para>
  2176. Close this appender instance. If this appender is marked
  2177. as not <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> then the remaining events in
  2178. the buffer must be sent when the appender is closed.
  2179. </para>
  2180. </remarks>
  2181. </member>
  2182. <member name="M:log4net.Appender.BufferingAppenderSkeleton.Append(log4net.Core.LoggingEvent)">
  2183. <summary>
  2184. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  2185. </summary>
  2186. <param name="loggingEvent">the event to log</param>
  2187. <remarks>
  2188. <para>
  2189. Stores the <paramref name="loggingEvent"/> in the cyclic buffer.
  2190. </para>
  2191. <para>
  2192. The buffer will be sent (i.e. passed to the <see cref="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])"/>
  2193. method) if one of the following conditions is met:
  2194. </para>
  2195. <list type="bullet">
  2196. <item>
  2197. <description>The cyclic buffer is full and this appender is
  2198. marked as not lossy (see <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/>)</description>
  2199. </item>
  2200. <item>
  2201. <description>An <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> is set and
  2202. it is triggered for the <paramref name="loggingEvent"/>
  2203. specified.</description>
  2204. </item>
  2205. </list>
  2206. <para>
  2207. Before the event is stored in the buffer it is fixed
  2208. (see <see cref="M:LoggingEvent.FixVolatileData(FixFlags)"/>) to ensure that
  2209. any data referenced by the event will be valid when the buffer
  2210. is processed.
  2211. </para>
  2212. </remarks>
  2213. </member>
  2214. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendFromBuffer(log4net.Core.LoggingEvent,log4net.Util.CyclicBuffer)">
  2215. <summary>
  2216. Sends the contents of the buffer.
  2217. </summary>
  2218. <param name="firstLoggingEvent">The first logging event.</param>
  2219. <param name="buffer">The buffer containing the events that need to be send.</param>
  2220. <remarks>
  2221. <para>
  2222. The subclass must override <see cref="M:SendBuffer(LoggingEvent[])"/>.
  2223. </para>
  2224. </remarks>
  2225. </member>
  2226. <member name="M:log4net.Appender.BufferingAppenderSkeleton.SendBuffer(log4net.Core.LoggingEvent[])">
  2227. <summary>
  2228. Sends the events.
  2229. </summary>
  2230. <param name="events">The events that need to be send.</param>
  2231. <remarks>
  2232. <para>
  2233. The subclass must override this method to process the buffered events.
  2234. </para>
  2235. </remarks>
  2236. </member>
  2237. <member name="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE">
  2238. <summary>
  2239. The default buffer size.
  2240. </summary>
  2241. <remarks>
  2242. The default size of the cyclic buffer used to store events.
  2243. This is set to 512 by default.
  2244. </remarks>
  2245. </member>
  2246. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_bufferSize">
  2247. <summary>
  2248. The size of the cyclic buffer used to hold the logging events.
  2249. </summary>
  2250. <remarks>
  2251. Set to <see cref="F:log4net.Appender.BufferingAppenderSkeleton.DEFAULT_BUFFER_SIZE"/> by default.
  2252. </remarks>
  2253. </member>
  2254. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_cb">
  2255. <summary>
  2256. The cyclic buffer used to store the logging events.
  2257. </summary>
  2258. </member>
  2259. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_evaluator">
  2260. <summary>
  2261. The triggering event evaluator that causes the buffer to be sent immediately.
  2262. </summary>
  2263. <remarks>
  2264. The object that is used to determine if an event causes the entire
  2265. buffer to be sent immediately. This field can be <c>null</c>, which
  2266. indicates that event triggering is not to be done. The evaluator
  2267. can be set using the <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> property. If this appender
  2268. has the <see cref="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy"/> (<see cref="P:log4net.Appender.BufferingAppenderSkeleton.Lossy"/> property) set to
  2269. <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must be set.
  2270. </remarks>
  2271. </member>
  2272. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossy">
  2273. <summary>
  2274. Indicates if the appender should overwrite events in the cyclic buffer
  2275. when it becomes full, or if the buffer should be flushed when the
  2276. buffer is full.
  2277. </summary>
  2278. <remarks>
  2279. If this field is set to <c>true</c> then an <see cref="P:log4net.Appender.BufferingAppenderSkeleton.Evaluator"/> must
  2280. be set.
  2281. </remarks>
  2282. </member>
  2283. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_lossyEvaluator">
  2284. <summary>
  2285. The triggering event evaluator filters discarded events.
  2286. </summary>
  2287. <remarks>
  2288. The object that is used to determine if an event that is discarded should
  2289. really be discarded or if it should be sent to the appenders.
  2290. This field can be <c>null</c>, which indicates that all discarded events will
  2291. be discarded.
  2292. </remarks>
  2293. </member>
  2294. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_fixFlags">
  2295. <summary>
  2296. Value indicating which fields in the event should be fixed
  2297. </summary>
  2298. <remarks>
  2299. By default all fields are fixed
  2300. </remarks>
  2301. </member>
  2302. <member name="F:log4net.Appender.BufferingAppenderSkeleton.m_eventMustBeFixed">
  2303. <summary>
  2304. The events delivered to the subclass must be fixed.
  2305. </summary>
  2306. </member>
  2307. <member name="T:log4net.Appender.BufferingForwardingAppender">
  2308. <summary>
  2309. Buffers events and then forwards them to attached appenders.
  2310. </summary>
  2311. <remarks>
  2312. <para>
  2313. The events are buffered in this appender until conditions are
  2314. met to allow the appender to deliver the events to the attached
  2315. appenders. See <see cref="T:log4net.Appender.BufferingAppenderSkeleton"/> for the
  2316. conditions that cause the buffer to be sent.
  2317. </para>
  2318. <para>The forwarding appender can be used to specify different
  2319. thresholds and filters for the same appender at different locations
  2320. within the hierarchy.
  2321. </para>
  2322. </remarks>
  2323. <author>Nicko Cadell</author>
  2324. <author>Gert Driesen</author>
  2325. </member>
  2326. <member name="M:log4net.Appender.BufferingForwardingAppender.#ctor">
  2327. <summary>
  2328. Initializes a new instance of the <see cref="T:log4net.Appender.BufferingForwardingAppender" /> class.
  2329. </summary>
  2330. <remarks>
  2331. <para>
  2332. Default constructor.
  2333. </para>
  2334. </remarks>
  2335. </member>
  2336. <member name="M:log4net.Appender.BufferingForwardingAppender.OnClose">
  2337. <summary>
  2338. Closes the appender and releases resources.
  2339. </summary>
  2340. <remarks>
  2341. <para>
  2342. Releases any resources allocated within the appender such as file handles,
  2343. network connections, etc.
  2344. </para>
  2345. <para>
  2346. It is a programming error to append to a closed appender.
  2347. </para>
  2348. </remarks>
  2349. </member>
  2350. <member name="M:log4net.Appender.BufferingForwardingAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  2351. <summary>
  2352. Send the events.
  2353. </summary>
  2354. <param name="events">The events that need to be send.</param>
  2355. <remarks>
  2356. <para>
  2357. Forwards the events to the attached appenders.
  2358. </para>
  2359. </remarks>
  2360. </member>
  2361. <member name="M:log4net.Appender.BufferingForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  2362. <summary>
  2363. Adds an <see cref="T:log4net.Appender.IAppender" /> to the list of appenders of this
  2364. instance.
  2365. </summary>
  2366. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender" /> to add to this appender.</param>
  2367. <remarks>
  2368. <para>
  2369. If the specified <see cref="T:log4net.Appender.IAppender" /> is already in the list of
  2370. appenders, then it won't be added again.
  2371. </para>
  2372. </remarks>
  2373. </member>
  2374. <member name="P:log4net.Appender.BufferingForwardingAppender.Appenders">
  2375. <summary>
  2376. Gets the appenders contained in this appender as an
  2377. <see cref="T:System.Collections.ICollection"/>.
  2378. </summary>
  2379. <remarks>
  2380. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  2381. is returned.
  2382. </remarks>
  2383. <returns>
  2384. A collection of the appenders in this appender.
  2385. </returns>
  2386. </member>
  2387. <member name="M:log4net.Appender.BufferingForwardingAppender.GetAppender(System.String)">
  2388. <summary>
  2389. Looks for the appender with the specified name.
  2390. </summary>
  2391. <param name="name">The name of the appender to lookup.</param>
  2392. <returns>
  2393. The appender with the specified name, or <c>null</c>.
  2394. </returns>
  2395. <remarks>
  2396. <para>
  2397. Get the named appender attached to this buffering appender.
  2398. </para>
  2399. </remarks>
  2400. </member>
  2401. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAllAppenders">
  2402. <summary>
  2403. Removes all previously added appenders from this appender.
  2404. </summary>
  2405. <remarks>
  2406. <para>
  2407. This is useful when re-reading configuration information.
  2408. </para>
  2409. </remarks>
  2410. </member>
  2411. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  2412. <summary>
  2413. Removes the specified appender from the list of appenders.
  2414. </summary>
  2415. <param name="appender">The appender to remove.</param>
  2416. <returns>The appender removed from the list</returns>
  2417. <remarks>
  2418. The appender removed is not closed.
  2419. If you are discarding the appender you must call
  2420. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2421. </remarks>
  2422. </member>
  2423. <member name="M:log4net.Appender.BufferingForwardingAppender.RemoveAppender(System.String)">
  2424. <summary>
  2425. Removes the appender with the specified name from the list of appenders.
  2426. </summary>
  2427. <param name="name">The name of the appender to remove.</param>
  2428. <returns>The appender removed from the list</returns>
  2429. <remarks>
  2430. The appender removed is not closed.
  2431. If you are discarding the appender you must call
  2432. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  2433. </remarks>
  2434. </member>
  2435. <member name="F:log4net.Appender.BufferingForwardingAppender.m_appenderAttachedImpl">
  2436. <summary>
  2437. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  2438. </summary>
  2439. </member>
  2440. <member name="T:log4net.Appender.ConsoleAppender">
  2441. <summary>
  2442. Appends logging events to the console.
  2443. </summary>
  2444. <remarks>
  2445. <para>
  2446. ConsoleAppender appends log events to the standard output stream
  2447. or the error output stream using a layout specified by the
  2448. user.
  2449. </para>
  2450. <para>
  2451. By default, all output is written to the console's standard output stream.
  2452. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> property can be set to direct the output to the
  2453. error stream.
  2454. </para>
  2455. <para>
  2456. NOTE: This appender writes each message to the <c>System.Console.Out</c> or
  2457. <c>System.Console.Error</c> that is set at the time the event is appended.
  2458. Therefore it is possible to programmatically redirect the output of this appender
  2459. (for example NUnit does this to capture program output). While this is the desired
  2460. behavior of this appender it may have security implications in your application.
  2461. </para>
  2462. </remarks>
  2463. <author>Nicko Cadell</author>
  2464. <author>Gert Driesen</author>
  2465. </member>
  2466. <member name="M:log4net.Appender.ConsoleAppender.#ctor">
  2467. <summary>
  2468. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class.
  2469. </summary>
  2470. <remarks>
  2471. The instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class is set up to write
  2472. to the standard output stream.
  2473. </remarks>
  2474. </member>
  2475. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout)">
  2476. <summary>
  2477. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class
  2478. with the specified layout.
  2479. </summary>
  2480. <param name="layout">the layout to use for this appender</param>
  2481. <remarks>
  2482. The instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class is set up to write
  2483. to the standard output stream.
  2484. </remarks>
  2485. </member>
  2486. <member name="M:log4net.Appender.ConsoleAppender.#ctor(log4net.Layout.ILayout,System.Boolean)">
  2487. <summary>
  2488. Initializes a new instance of the <see cref="T:log4net.Appender.ConsoleAppender" /> class
  2489. with the specified layout.
  2490. </summary>
  2491. <param name="layout">the layout to use for this appender</param>
  2492. <param name="writeToErrorStream">flag set to <c>true</c> to write to the console error stream</param>
  2493. <remarks>
  2494. When <paramref name="writeToErrorStream" /> is set to <c>true</c>, output is written to
  2495. the standard error output stream. Otherwise, output is written to the standard
  2496. output stream.
  2497. </remarks>
  2498. </member>
  2499. <member name="P:log4net.Appender.ConsoleAppender.Target">
  2500. <summary>
  2501. Target is the value of the console output stream.
  2502. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2503. </summary>
  2504. <value>
  2505. Target is the value of the console output stream.
  2506. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2507. </value>
  2508. <remarks>
  2509. <para>
  2510. Target is the value of the console output stream.
  2511. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  2512. </para>
  2513. </remarks>
  2514. </member>
  2515. <member name="M:log4net.Appender.ConsoleAppender.Append(log4net.Core.LoggingEvent)">
  2516. <summary>
  2517. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  2518. </summary>
  2519. <param name="loggingEvent">The event to log.</param>
  2520. <remarks>
  2521. <para>
  2522. Writes the event to the console.
  2523. </para>
  2524. <para>
  2525. The format of the output will depend on the appender's layout.
  2526. </para>
  2527. </remarks>
  2528. </member>
  2529. <member name="P:log4net.Appender.ConsoleAppender.RequiresLayout">
  2530. <summary>
  2531. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2532. </summary>
  2533. <value><c>true</c></value>
  2534. <remarks>
  2535. <para>
  2536. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2537. </para>
  2538. </remarks>
  2539. </member>
  2540. <member name="F:log4net.Appender.ConsoleAppender.ConsoleOut">
  2541. <summary>
  2542. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2543. standard output stream.
  2544. </summary>
  2545. <remarks>
  2546. <para>
  2547. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2548. standard output stream.
  2549. </para>
  2550. </remarks>
  2551. </member>
  2552. <member name="F:log4net.Appender.ConsoleAppender.ConsoleError">
  2553. <summary>
  2554. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2555. standard error output stream.
  2556. </summary>
  2557. <remarks>
  2558. <para>
  2559. The <see cref="P:log4net.Appender.ConsoleAppender.Target"/> to use when writing to the Console
  2560. standard error output stream.
  2561. </para>
  2562. </remarks>
  2563. </member>
  2564. <member name="T:log4net.Appender.DebugAppender">
  2565. <summary>
  2566. Appends log events to the <see cref="T:System.Diagnostics.Debug"/> system.
  2567. </summary>
  2568. <remarks>
  2569. <para>
  2570. The application configuration file can be used to control what listeners
  2571. are actually used. See the MSDN documentation for the
  2572. <see cref="T:System.Diagnostics.Debug"/> class for details on configuring the
  2573. debug system.
  2574. </para>
  2575. <para>
  2576. Events are written using the <see cref="M:System.Diagnostics.Debug.Write(string,string)"/>
  2577. method. The event's logger name is passed as the value for the category name to the Write method.
  2578. </para>
  2579. </remarks>
  2580. <author>Nicko Cadell</author>
  2581. </member>
  2582. <member name="M:log4net.Appender.DebugAppender.#ctor">
  2583. <summary>
  2584. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender" />.
  2585. </summary>
  2586. <remarks>
  2587. <para>
  2588. Default constructor.
  2589. </para>
  2590. </remarks>
  2591. </member>
  2592. <member name="M:log4net.Appender.DebugAppender.#ctor(log4net.Layout.ILayout)">
  2593. <summary>
  2594. Initializes a new instance of the <see cref="T:log4net.Appender.DebugAppender" />
  2595. with a specified layout.
  2596. </summary>
  2597. <param name="layout">The layout to use with this appender.</param>
  2598. <remarks>
  2599. <para>
  2600. Obsolete constructor.
  2601. </para>
  2602. </remarks>
  2603. </member>
  2604. <member name="P:log4net.Appender.DebugAppender.Category">
  2605. <summary>
  2606. Formats the category parameter sent to the Debug method.
  2607. </summary>
  2608. <remarks>
  2609. <para>
  2610. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern which will use the logger name of the current
  2611. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  2612. </para>
  2613. <para>
  2614. </para>
  2615. </remarks>
  2616. </member>
  2617. <member name="M:log4net.Appender.DebugAppender.Append(log4net.Core.LoggingEvent)">
  2618. <summary>
  2619. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  2620. </summary>
  2621. <param name="loggingEvent">The event to log.</param>
  2622. <remarks>
  2623. <para>
  2624. Writes the logging event to the <see cref="T:System.Diagnostics.Debug"/> system.
  2625. </para>
  2626. </remarks>
  2627. </member>
  2628. <member name="P:log4net.Appender.DebugAppender.RequiresLayout">
  2629. <summary>
  2630. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2631. </summary>
  2632. <value><c>true</c></value>
  2633. <remarks>
  2634. <para>
  2635. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  2636. </para>
  2637. </remarks>
  2638. </member>
  2639. <member name="F:log4net.Appender.DebugAppender.m_category">
  2640. <summary>
  2641. Defaults to a <see cref="T:log4net.Layout.PatternLayout"/> with %logger as the pattern.
  2642. </summary>
  2643. </member>
  2644. <member name="T:log4net.Appender.FileAppender">
  2645. <summary>
  2646. Appends logging events to a file.
  2647. </summary>
  2648. <remarks>
  2649. <para>
  2650. Logging events are sent to the file specified by
  2651. the <see cref="P:log4net.Appender.FileAppender.File"/> property.
  2652. </para>
  2653. <para>
  2654. The file can be opened in either append or overwrite mode
  2655. by specifying the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property.
  2656. If the file path is relative it is taken as relative from
  2657. the application base directory. The file encoding can be
  2658. specified by setting the <see cref="P:log4net.Appender.FileAppender.Encoding"/> property.
  2659. </para>
  2660. <para>
  2661. The layout's <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  2662. values will be written each time the file is opened and closed
  2663. respectively. If the <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is <see langword="true"/>
  2664. then the file may contain multiple copies of the header and footer.
  2665. </para>
  2666. <para>
  2667. This appender will first try to open the file for writing when <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/>
  2668. is called. This will typically be during configuration.
  2669. If the file cannot be opened for writing the appender will attempt
  2670. to open the file again each time a message is logged to the appender.
  2671. If the file cannot be opened for writing when a message is logged then
  2672. the message will be discarded by this appender.
  2673. </para>
  2674. <para>
  2675. The <see cref="T:log4net.Appender.FileAppender"/> supports pluggable file locking models via
  2676. the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> property.
  2677. The default behavior, implemented by <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>
  2678. is to obtain an exclusive write lock on the file until this appender is closed.
  2679. The alternative models only hold a
  2680. write lock while the appender is writing a logging event (<see cref="T:log4net.Appender.FileAppender.MinimalLock"/>)
  2681. or synchronize by using a named system wide Mutex (<see cref="T:log4net.Appender.FileAppender.InterProcessLock"/>).
  2682. </para>
  2683. <para>
  2684. All locking strategies have issues and you should seriously consider using a different strategy that
  2685. avoids having multiple processes logging to the same file.
  2686. </para>
  2687. </remarks>
  2688. <author>Nicko Cadell</author>
  2689. <author>Gert Driesen</author>
  2690. <author>Rodrigo B. de Oliveira</author>
  2691. <author>Douglas de la Torre</author>
  2692. <author>Niall Daley</author>
  2693. </member>
  2694. <member name="T:log4net.Appender.FileAppender.LockingStream">
  2695. <summary>
  2696. Write only <see cref="T:System.IO.Stream"/> that uses the <see cref="T:log4net.Appender.FileAppender.LockingModelBase"/>
  2697. to manage access to an underlying resource.
  2698. </summary>
  2699. </member>
  2700. <member name="T:log4net.Appender.FileAppender.LockingModelBase">
  2701. <summary>
  2702. Locking model base class
  2703. </summary>
  2704. <remarks>
  2705. <para>
  2706. Base class for the locking models available to the <see cref="T:log4net.Appender.FileAppender"/> derived loggers.
  2707. </para>
  2708. </remarks>
  2709. </member>
  2710. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  2711. <summary>
  2712. Open the output file
  2713. </summary>
  2714. <param name="filename">The filename to use</param>
  2715. <param name="append">Whether to append to the file, or overwrite</param>
  2716. <param name="encoding">The encoding to use</param>
  2717. <remarks>
  2718. <para>
  2719. Open the file specified and prepare for logging.
  2720. No writes will be made until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called.
  2721. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/>,
  2722. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile"/>.
  2723. </para>
  2724. </remarks>
  2725. </member>
  2726. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseFile">
  2727. <summary>
  2728. Close the file
  2729. </summary>
  2730. <remarks>
  2731. <para>
  2732. Close the file. No further writes will be made.
  2733. </para>
  2734. </remarks>
  2735. </member>
  2736. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ActivateOptions">
  2737. <summary>
  2738. Initializes all resources used by this locking model.
  2739. </summary>
  2740. </member>
  2741. <member name="M:log4net.Appender.FileAppender.LockingModelBase.OnClose">
  2742. <summary>
  2743. Disposes all resources that were initialized by this locking model.
  2744. </summary>
  2745. </member>
  2746. <member name="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock">
  2747. <summary>
  2748. Acquire the lock on the file
  2749. </summary>
  2750. <returns>A stream that is ready to be written to.</returns>
  2751. <remarks>
  2752. <para>
  2753. Acquire the lock on the file in preparation for writing to it.
  2754. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock"/>
  2755. must be called to release the lock on the output file.
  2756. </para>
  2757. </remarks>
  2758. </member>
  2759. <member name="M:log4net.Appender.FileAppender.LockingModelBase.ReleaseLock">
  2760. <summary>
  2761. Release the lock on the file
  2762. </summary>
  2763. <remarks>
  2764. <para>
  2765. Release the lock on the file. No further writes will be made to the
  2766. stream until <see cref="M:log4net.Appender.FileAppender.LockingModelBase.AcquireLock"/> is called again.
  2767. </para>
  2768. </remarks>
  2769. </member>
  2770. <member name="P:log4net.Appender.FileAppender.LockingModelBase.CurrentAppender">
  2771. <summary>
  2772. Gets or sets the <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  2773. </summary>
  2774. <value>
  2775. The <see cref="T:log4net.Appender.FileAppender"/> for this LockingModel
  2776. </value>
  2777. <remarks>
  2778. <para>
  2779. The file appender this locking model is attached to and working on
  2780. behalf of.
  2781. </para>
  2782. <para>
  2783. The file appender is used to locate the security context and the error handler to use.
  2784. </para>
  2785. <para>
  2786. 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
  2787. called.
  2788. </para>
  2789. </remarks>
  2790. </member>
  2791. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CreateStream(System.String,System.Boolean,System.IO.FileShare)">
  2792. <summary>
  2793. Helper method that creates a FileStream under CurrentAppender's SecurityContext.
  2794. </summary>
  2795. <remarks>
  2796. <para>
  2797. Typically called during OpenFile or AcquireLock.
  2798. </para>
  2799. <para>
  2800. If the directory portion of the <paramref name="filename"/> does not exist, it is created
  2801. via Directory.CreateDirecctory.
  2802. </para>
  2803. </remarks>
  2804. <param name="filename"></param>
  2805. <param name="append"></param>
  2806. <param name="fileShare"></param>
  2807. <returns></returns>
  2808. </member>
  2809. <member name="M:log4net.Appender.FileAppender.LockingModelBase.CloseStream(System.IO.Stream)">
  2810. <summary>
  2811. Helper method to close <paramref name="stream"/> under CurrentAppender's SecurityContext.
  2812. </summary>
  2813. <remarks>
  2814. Does not set <paramref name="stream"/> to null.
  2815. </remarks>
  2816. <param name="stream"></param>
  2817. </member>
  2818. <member name="T:log4net.Appender.FileAppender.ExclusiveLock">
  2819. <summary>
  2820. Hold an exclusive lock on the output file
  2821. </summary>
  2822. <remarks>
  2823. <para>
  2824. Open the file once for writing and hold it open until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/> is called.
  2825. Maintains an exclusive lock on the file during this time.
  2826. </para>
  2827. </remarks>
  2828. </member>
  2829. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  2830. <summary>
  2831. Open the file specified and prepare for logging.
  2832. </summary>
  2833. <param name="filename">The filename to use</param>
  2834. <param name="append">Whether to append to the file, or overwrite</param>
  2835. <param name="encoding">The encoding to use</param>
  2836. <remarks>
  2837. <para>
  2838. Open the file specified and prepare for logging.
  2839. No writes will be made until <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/> is called.
  2840. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock"/>,
  2841. <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile"/>.
  2842. </para>
  2843. </remarks>
  2844. </member>
  2845. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.CloseFile">
  2846. <summary>
  2847. Close the file
  2848. </summary>
  2849. <remarks>
  2850. <para>
  2851. Close the file. No further writes will be made.
  2852. </para>
  2853. </remarks>
  2854. </member>
  2855. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.AcquireLock">
  2856. <summary>
  2857. Acquire the lock on the file
  2858. </summary>
  2859. <returns>A stream that is ready to be written to.</returns>
  2860. <remarks>
  2861. <para>
  2862. Does nothing. The lock is already taken
  2863. </para>
  2864. </remarks>
  2865. </member>
  2866. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ReleaseLock">
  2867. <summary>
  2868. Release the lock on the file
  2869. </summary>
  2870. <remarks>
  2871. <para>
  2872. Does nothing. The lock will be released when the file is closed.
  2873. </para>
  2874. </remarks>
  2875. </member>
  2876. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.ActivateOptions">
  2877. <summary>
  2878. Initializes all resources used by this locking model.
  2879. </summary>
  2880. </member>
  2881. <member name="M:log4net.Appender.FileAppender.ExclusiveLock.OnClose">
  2882. <summary>
  2883. Disposes all resources that were initialized by this locking model.
  2884. </summary>
  2885. </member>
  2886. <member name="T:log4net.Appender.FileAppender.MinimalLock">
  2887. <summary>
  2888. Acquires the file lock for each write
  2889. </summary>
  2890. <remarks>
  2891. <para>
  2892. Opens the file once for each <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>/<see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> cycle,
  2893. thus holding the lock for the minimal amount of time. This method of locking
  2894. is considerably slower than <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/> but allows
  2895. other processes to move/delete the log file whilst logging continues.
  2896. </para>
  2897. </remarks>
  2898. </member>
  2899. <member name="M:log4net.Appender.FileAppender.MinimalLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  2900. <summary>
  2901. Prepares to open the file when the first message is logged.
  2902. </summary>
  2903. <param name="filename">The filename to use</param>
  2904. <param name="append">Whether to append to the file, or overwrite</param>
  2905. <param name="encoding">The encoding to use</param>
  2906. <remarks>
  2907. <para>
  2908. Open the file specified and prepare for logging.
  2909. No writes will be made until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called.
  2910. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/>,
  2911. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.MinimalLock.CloseFile"/>.
  2912. </para>
  2913. </remarks>
  2914. </member>
  2915. <member name="M:log4net.Appender.FileAppender.MinimalLock.CloseFile">
  2916. <summary>
  2917. Close the file
  2918. </summary>
  2919. <remarks>
  2920. <para>
  2921. Close the file. No further writes will be made.
  2922. </para>
  2923. </remarks>
  2924. </member>
  2925. <member name="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock">
  2926. <summary>
  2927. Acquire the lock on the file
  2928. </summary>
  2929. <returns>A stream that is ready to be written to.</returns>
  2930. <remarks>
  2931. <para>
  2932. Acquire the lock on the file in preparation for writing to it.
  2933. Return a stream pointing to the file. <see cref="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock"/>
  2934. must be called to release the lock on the output file.
  2935. </para>
  2936. </remarks>
  2937. </member>
  2938. <member name="M:log4net.Appender.FileAppender.MinimalLock.ReleaseLock">
  2939. <summary>
  2940. Release the lock on the file
  2941. </summary>
  2942. <remarks>
  2943. <para>
  2944. Release the lock on the file. No further writes will be made to the
  2945. stream until <see cref="M:log4net.Appender.FileAppender.MinimalLock.AcquireLock"/> is called again.
  2946. </para>
  2947. </remarks>
  2948. </member>
  2949. <member name="M:log4net.Appender.FileAppender.MinimalLock.ActivateOptions">
  2950. <summary>
  2951. Initializes all resources used by this locking model.
  2952. </summary>
  2953. </member>
  2954. <member name="M:log4net.Appender.FileAppender.MinimalLock.OnClose">
  2955. <summary>
  2956. Disposes all resources that were initialized by this locking model.
  2957. </summary>
  2958. </member>
  2959. <member name="T:log4net.Appender.FileAppender.InterProcessLock">
  2960. <summary>
  2961. Provides cross-process file locking.
  2962. </summary>
  2963. <author>Ron Grabowski</author>
  2964. <author>Steve Wranovsky</author>
  2965. </member>
  2966. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OpenFile(System.String,System.Boolean,System.Text.Encoding)">
  2967. <summary>
  2968. Open the file specified and prepare for logging.
  2969. </summary>
  2970. <param name="filename">The filename to use</param>
  2971. <param name="append">Whether to append to the file, or overwrite</param>
  2972. <param name="encoding">The encoding to use</param>
  2973. <remarks>
  2974. <para>
  2975. Open the file specified and prepare for logging.
  2976. No writes will be made until <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/> is called.
  2977. Must be called before any calls to <see cref="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock"/>,
  2978. -<see cref="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock"/> and <see cref="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile"/>.
  2979. </para>
  2980. </remarks>
  2981. </member>
  2982. <member name="M:log4net.Appender.FileAppender.InterProcessLock.CloseFile">
  2983. <summary>
  2984. Close the file
  2985. </summary>
  2986. <remarks>
  2987. <para>
  2988. Close the file. No further writes will be made.
  2989. </para>
  2990. </remarks>
  2991. </member>
  2992. <member name="M:log4net.Appender.FileAppender.InterProcessLock.AcquireLock">
  2993. <summary>
  2994. Acquire the lock on the file
  2995. </summary>
  2996. <returns>A stream that is ready to be written to.</returns>
  2997. <remarks>
  2998. <para>
  2999. Does nothing. The lock is already taken
  3000. </para>
  3001. </remarks>
  3002. </member>
  3003. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ReleaseLock">
  3004. <summary>
  3005. Releases the lock and allows others to acquire a lock.
  3006. </summary>
  3007. </member>
  3008. <member name="M:log4net.Appender.FileAppender.InterProcessLock.ActivateOptions">
  3009. <summary>
  3010. Initializes all resources used by this locking model.
  3011. </summary>
  3012. </member>
  3013. <member name="M:log4net.Appender.FileAppender.InterProcessLock.OnClose">
  3014. <summary>
  3015. Disposes all resources that were initialized by this locking model.
  3016. </summary>
  3017. </member>
  3018. <member name="M:log4net.Appender.FileAppender.#ctor">
  3019. <summary>
  3020. Default constructor
  3021. </summary>
  3022. <remarks>
  3023. <para>
  3024. Default constructor
  3025. </para>
  3026. </remarks>
  3027. </member>
  3028. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String,System.Boolean)">
  3029. <summary>
  3030. Construct a new appender using the layout, file and append mode.
  3031. </summary>
  3032. <param name="layout">the layout to use with this appender</param>
  3033. <param name="filename">the full path to the file to write to</param>
  3034. <param name="append">flag to indicate if the file should be appended to</param>
  3035. <remarks>
  3036. <para>
  3037. Obsolete constructor.
  3038. </para>
  3039. </remarks>
  3040. </member>
  3041. <member name="M:log4net.Appender.FileAppender.#ctor(log4net.Layout.ILayout,System.String)">
  3042. <summary>
  3043. Construct a new appender using the layout and file specified.
  3044. The file will be appended to.
  3045. </summary>
  3046. <param name="layout">the layout to use with this appender</param>
  3047. <param name="filename">the full path to the file to write to</param>
  3048. <remarks>
  3049. <para>
  3050. Obsolete constructor.
  3051. </para>
  3052. </remarks>
  3053. </member>
  3054. <member name="P:log4net.Appender.FileAppender.File">
  3055. <summary>
  3056. Gets or sets the path to the file that logging will be written to.
  3057. </summary>
  3058. <value>
  3059. The path to the file that logging will be written to.
  3060. </value>
  3061. <remarks>
  3062. <para>
  3063. If the path is relative it is taken as relative from
  3064. the application base directory.
  3065. </para>
  3066. </remarks>
  3067. </member>
  3068. <member name="P:log4net.Appender.FileAppender.AppendToFile">
  3069. <summary>
  3070. Gets or sets a flag that indicates whether the file should be
  3071. appended to or overwritten.
  3072. </summary>
  3073. <value>
  3074. Indicates whether the file should be appended to or overwritten.
  3075. </value>
  3076. <remarks>
  3077. <para>
  3078. If the value is set to false then the file will be overwritten, if
  3079. it is set to true then the file will be appended to.
  3080. </para>
  3081. The default value is true.
  3082. </remarks>
  3083. </member>
  3084. <member name="P:log4net.Appender.FileAppender.Encoding">
  3085. <summary>
  3086. Gets or sets <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  3087. </summary>
  3088. <value>
  3089. The <see cref="P:log4net.Appender.FileAppender.Encoding"/> used to write to the file.
  3090. </value>
  3091. <remarks>
  3092. <para>
  3093. The default encoding set is <see cref="!:System.Text.Encoding.Default"/>
  3094. which is the encoding for the system's current ANSI code page.
  3095. </para>
  3096. </remarks>
  3097. </member>
  3098. <member name="P:log4net.Appender.FileAppender.SecurityContext">
  3099. <summary>
  3100. Gets or sets the <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  3101. </summary>
  3102. <value>
  3103. The <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> used to write to the file.
  3104. </value>
  3105. <remarks>
  3106. <para>
  3107. Unless a <see cref="P:log4net.Appender.FileAppender.SecurityContext"/> specified here for this appender
  3108. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  3109. security context to use. The default behavior is to use the security context
  3110. of the current thread.
  3111. </para>
  3112. </remarks>
  3113. </member>
  3114. <member name="P:log4net.Appender.FileAppender.LockingModel">
  3115. <summary>
  3116. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  3117. </summary>
  3118. <value>
  3119. The <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to lock the file.
  3120. </value>
  3121. <remarks>
  3122. <para>
  3123. Gets or sets the <see cref="P:log4net.Appender.FileAppender.LockingModel"/> used to handle locking of the file.
  3124. </para>
  3125. <para>
  3126. 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"/> .
  3127. The first locks the file from the start of logging to the end, the
  3128. second locks only for the minimal amount of time when logging each message
  3129. and the last synchronizes processes using a named system wide Mutex.
  3130. </para>
  3131. <para>
  3132. The default locking model is the <see cref="T:log4net.Appender.FileAppender.ExclusiveLock"/>.
  3133. </para>
  3134. </remarks>
  3135. </member>
  3136. <member name="M:log4net.Appender.FileAppender.ActivateOptions">
  3137. <summary>
  3138. Activate the options on the file appender.
  3139. </summary>
  3140. <remarks>
  3141. <para>
  3142. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3143. activation scheme. The <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> method must
  3144. be called on this object after the configuration properties have
  3145. been set. Until <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> is called this
  3146. object is in an undefined state and must not be used.
  3147. </para>
  3148. <para>
  3149. If any of the configuration properties are modified then
  3150. <see cref="M:log4net.Appender.FileAppender.ActivateOptions"/> must be called again.
  3151. </para>
  3152. <para>
  3153. This will cause the file to be opened.
  3154. </para>
  3155. </remarks>
  3156. </member>
  3157. <member name="M:log4net.Appender.FileAppender.Reset">
  3158. <summary>
  3159. Closes any previously opened file and calls the parent's <see cref="M:log4net.Appender.TextWriterAppender.Reset"/>.
  3160. </summary>
  3161. <remarks>
  3162. <para>
  3163. Resets the filename and the file stream.
  3164. </para>
  3165. </remarks>
  3166. </member>
  3167. <member name="M:log4net.Appender.FileAppender.OnClose">
  3168. <summary>
  3169. Close this appender instance. The underlying stream or writer is also closed.
  3170. </summary>
  3171. </member>
  3172. <member name="M:log4net.Appender.FileAppender.PrepareWriter">
  3173. <summary>
  3174. Called to initialize the file writer
  3175. </summary>
  3176. <remarks>
  3177. <para>
  3178. Will be called for each logged message until the file is
  3179. successfully opened.
  3180. </para>
  3181. </remarks>
  3182. </member>
  3183. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent)">
  3184. <summary>
  3185. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  3186. method.
  3187. </summary>
  3188. <param name="loggingEvent">The event to log.</param>
  3189. <remarks>
  3190. <para>
  3191. Writes a log statement to the output stream if the output stream exists
  3192. and is writable.
  3193. </para>
  3194. <para>
  3195. The format of the output will depend on the appender's layout.
  3196. </para>
  3197. </remarks>
  3198. </member>
  3199. <member name="M:log4net.Appender.FileAppender.Append(log4net.Core.LoggingEvent[])">
  3200. <summary>
  3201. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  3202. method.
  3203. </summary>
  3204. <param name="loggingEvents">The array of events to log.</param>
  3205. <remarks>
  3206. <para>
  3207. Acquires the output file locks once before writing all the events to
  3208. the stream.
  3209. </para>
  3210. </remarks>
  3211. </member>
  3212. <member name="M:log4net.Appender.FileAppender.WriteFooter">
  3213. <summary>
  3214. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3215. </summary>
  3216. <remarks>
  3217. <para>
  3218. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  3219. </para>
  3220. </remarks>
  3221. </member>
  3222. <member name="M:log4net.Appender.FileAppender.WriteHeader">
  3223. <summary>
  3224. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3225. </summary>
  3226. <remarks>
  3227. <para>
  3228. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  3229. </para>
  3230. </remarks>
  3231. </member>
  3232. <member name="M:log4net.Appender.FileAppender.CloseWriter">
  3233. <summary>
  3234. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3235. </summary>
  3236. <remarks>
  3237. <para>
  3238. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  3239. </para>
  3240. </remarks>
  3241. </member>
  3242. <member name="M:log4net.Appender.FileAppender.CloseFile">
  3243. <summary>
  3244. Closes the previously opened file.
  3245. </summary>
  3246. <remarks>
  3247. <para>
  3248. Writes the <see cref="P:log4net.Layout.ILayout.Footer"/> to the file and then
  3249. closes the file.
  3250. </para>
  3251. </remarks>
  3252. </member>
  3253. <member name="M:log4net.Appender.FileAppender.SafeOpenFile(System.String,System.Boolean)">
  3254. <summary>
  3255. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3256. </summary>
  3257. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3258. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3259. <remarks>
  3260. <para>
  3261. Calls <see cref="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)"/> but guarantees not to throw an exception.
  3262. Errors are passed to the <see cref="P:log4net.Appender.TextWriterAppender.ErrorHandler"/>.
  3263. </para>
  3264. </remarks>
  3265. </member>
  3266. <member name="M:log4net.Appender.FileAppender.OpenFile(System.String,System.Boolean)">
  3267. <summary>
  3268. Sets and <i>opens</i> the file where the log output will go. The specified file must be writable.
  3269. </summary>
  3270. <param name="fileName">The path to the log file. Must be a fully qualified path.</param>
  3271. <param name="append">If true will append to fileName. Otherwise will truncate fileName</param>
  3272. <remarks>
  3273. <para>
  3274. If there was already an opened file, then the previous file
  3275. is closed first.
  3276. </para>
  3277. <para>
  3278. This method will ensure that the directory structure
  3279. for the <paramref name="fileName"/> specified exists.
  3280. </para>
  3281. </remarks>
  3282. </member>
  3283. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.Stream)">
  3284. <summary>
  3285. Sets the quiet writer used for file output
  3286. </summary>
  3287. <param name="fileStream">the file stream that has been opened for writing</param>
  3288. <remarks>
  3289. <para>
  3290. This implementation of <see cref="M:SetQWForFiles(Stream)"/> creates a <see cref="T:System.IO.StreamWriter"/>
  3291. over the <paramref name="fileStream"/> and passes it to the
  3292. <see cref="M:SetQWForFiles(TextWriter)"/> method.
  3293. </para>
  3294. <para>
  3295. This method can be overridden by sub classes that want to wrap the
  3296. <see cref="T:System.IO.Stream"/> in some way, for example to encrypt the output
  3297. data using a <c>System.Security.Cryptography.CryptoStream</c>.
  3298. </para>
  3299. </remarks>
  3300. </member>
  3301. <member name="M:log4net.Appender.FileAppender.SetQWForFiles(System.IO.TextWriter)">
  3302. <summary>
  3303. Sets the quiet writer being used.
  3304. </summary>
  3305. <param name="writer">the writer over the file stream that has been opened for writing</param>
  3306. <remarks>
  3307. <para>
  3308. This method can be overridden by sub classes that want to
  3309. wrap the <see cref="T:System.IO.TextWriter"/> in some way.
  3310. </para>
  3311. </remarks>
  3312. </member>
  3313. <member name="M:log4net.Appender.FileAppender.ConvertToFullPath(System.String)">
  3314. <summary>
  3315. Convert a path into a fully qualified path.
  3316. </summary>
  3317. <param name="path">The path to convert.</param>
  3318. <returns>The fully qualified path.</returns>
  3319. <remarks>
  3320. <para>
  3321. Converts the path specified to a fully
  3322. qualified path. If the path is relative it is
  3323. taken as relative from the application base
  3324. directory.
  3325. </para>
  3326. </remarks>
  3327. </member>
  3328. <member name="F:log4net.Appender.FileAppender.m_appendToFile">
  3329. <summary>
  3330. Flag to indicate if we should append to the file
  3331. or overwrite the file. The default is to append.
  3332. </summary>
  3333. </member>
  3334. <member name="F:log4net.Appender.FileAppender.m_fileName">
  3335. <summary>
  3336. The name of the log file.
  3337. </summary>
  3338. </member>
  3339. <member name="F:log4net.Appender.FileAppender.m_encoding">
  3340. <summary>
  3341. The encoding to use for the file stream.
  3342. </summary>
  3343. </member>
  3344. <member name="F:log4net.Appender.FileAppender.m_securityContext">
  3345. <summary>
  3346. The security context to use for privileged calls
  3347. </summary>
  3348. </member>
  3349. <member name="F:log4net.Appender.FileAppender.m_stream">
  3350. <summary>
  3351. The stream to log to. Has added locking semantics
  3352. </summary>
  3353. </member>
  3354. <member name="F:log4net.Appender.FileAppender.m_lockingModel">
  3355. <summary>
  3356. The locking model to use
  3357. </summary>
  3358. </member>
  3359. <member name="F:log4net.Appender.FileAppender.declaringType">
  3360. <summary>
  3361. The fully qualified type of the FileAppender class.
  3362. </summary>
  3363. <remarks>
  3364. Used by the internal logger to record the Type of the
  3365. log message.
  3366. </remarks>
  3367. </member>
  3368. <member name="T:log4net.Appender.ForwardingAppender">
  3369. <summary>
  3370. This appender forwards logging events to attached appenders.
  3371. </summary>
  3372. <remarks>
  3373. <para>
  3374. The forwarding appender can be used to specify different thresholds
  3375. and filters for the same appender at different locations within the hierarchy.
  3376. </para>
  3377. </remarks>
  3378. <author>Nicko Cadell</author>
  3379. <author>Gert Driesen</author>
  3380. </member>
  3381. <member name="M:log4net.Appender.ForwardingAppender.#ctor">
  3382. <summary>
  3383. Initializes a new instance of the <see cref="T:log4net.Appender.ForwardingAppender" /> class.
  3384. </summary>
  3385. <remarks>
  3386. <para>
  3387. Default constructor.
  3388. </para>
  3389. </remarks>
  3390. </member>
  3391. <member name="M:log4net.Appender.ForwardingAppender.OnClose">
  3392. <summary>
  3393. Closes the appender and releases resources.
  3394. </summary>
  3395. <remarks>
  3396. <para>
  3397. Releases any resources allocated within the appender such as file handles,
  3398. network connections, etc.
  3399. </para>
  3400. <para>
  3401. It is a programming error to append to a closed appender.
  3402. </para>
  3403. </remarks>
  3404. </member>
  3405. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent)">
  3406. <summary>
  3407. Forward the logging event to the attached appenders
  3408. </summary>
  3409. <param name="loggingEvent">The event to log.</param>
  3410. <remarks>
  3411. <para>
  3412. Delivers the logging event to all the attached appenders.
  3413. </para>
  3414. </remarks>
  3415. </member>
  3416. <member name="M:log4net.Appender.ForwardingAppender.Append(log4net.Core.LoggingEvent[])">
  3417. <summary>
  3418. Forward the logging events to the attached appenders
  3419. </summary>
  3420. <param name="loggingEvents">The array of events to log.</param>
  3421. <remarks>
  3422. <para>
  3423. Delivers the logging events to all the attached appenders.
  3424. </para>
  3425. </remarks>
  3426. </member>
  3427. <member name="M:log4net.Appender.ForwardingAppender.AddAppender(log4net.Appender.IAppender)">
  3428. <summary>
  3429. Adds an <see cref="T:log4net.Appender.IAppender" /> to the list of appenders of this
  3430. instance.
  3431. </summary>
  3432. <param name="newAppender">The <see cref="T:log4net.Appender.IAppender" /> to add to this appender.</param>
  3433. <remarks>
  3434. <para>
  3435. If the specified <see cref="T:log4net.Appender.IAppender" /> is already in the list of
  3436. appenders, then it won't be added again.
  3437. </para>
  3438. </remarks>
  3439. </member>
  3440. <member name="P:log4net.Appender.ForwardingAppender.Appenders">
  3441. <summary>
  3442. Gets the appenders contained in this appender as an
  3443. <see cref="T:System.Collections.ICollection"/>.
  3444. </summary>
  3445. <remarks>
  3446. If no appenders can be found, then an <see cref="T:log4net.Util.EmptyCollection"/>
  3447. is returned.
  3448. </remarks>
  3449. <returns>
  3450. A collection of the appenders in this appender.
  3451. </returns>
  3452. </member>
  3453. <member name="M:log4net.Appender.ForwardingAppender.GetAppender(System.String)">
  3454. <summary>
  3455. Looks for the appender with the specified name.
  3456. </summary>
  3457. <param name="name">The name of the appender to lookup.</param>
  3458. <returns>
  3459. The appender with the specified name, or <c>null</c>.
  3460. </returns>
  3461. <remarks>
  3462. <para>
  3463. Get the named appender attached to this appender.
  3464. </para>
  3465. </remarks>
  3466. </member>
  3467. <member name="M:log4net.Appender.ForwardingAppender.RemoveAllAppenders">
  3468. <summary>
  3469. Removes all previously added appenders from this appender.
  3470. </summary>
  3471. <remarks>
  3472. <para>
  3473. This is useful when re-reading configuration information.
  3474. </para>
  3475. </remarks>
  3476. </member>
  3477. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(log4net.Appender.IAppender)">
  3478. <summary>
  3479. Removes the specified appender from the list of appenders.
  3480. </summary>
  3481. <param name="appender">The appender to remove.</param>
  3482. <returns>The appender removed from the list</returns>
  3483. <remarks>
  3484. The appender removed is not closed.
  3485. If you are discarding the appender you must call
  3486. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  3487. </remarks>
  3488. </member>
  3489. <member name="M:log4net.Appender.ForwardingAppender.RemoveAppender(System.String)">
  3490. <summary>
  3491. Removes the appender with the specified name from the list of appenders.
  3492. </summary>
  3493. <param name="name">The name of the appender to remove.</param>
  3494. <returns>The appender removed from the list</returns>
  3495. <remarks>
  3496. The appender removed is not closed.
  3497. If you are discarding the appender you must call
  3498. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  3499. </remarks>
  3500. </member>
  3501. <member name="F:log4net.Appender.ForwardingAppender.m_appenderAttachedImpl">
  3502. <summary>
  3503. Implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  3504. </summary>
  3505. </member>
  3506. <member name="T:log4net.Appender.IAppender">
  3507. <summary>
  3508. Implement this interface for your own strategies for printing log statements.
  3509. </summary>
  3510. <remarks>
  3511. <para>
  3512. Implementors should consider extending the <see cref="T:log4net.Appender.AppenderSkeleton"/>
  3513. class which provides a default implementation of this interface.
  3514. </para>
  3515. <para>
  3516. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  3517. they would require that the <see cref="M:IOptionHandler.ActivateOptions()"/> method
  3518. be called after the appenders properties have been configured.
  3519. </para>
  3520. </remarks>
  3521. <author>Nicko Cadell</author>
  3522. <author>Gert Driesen</author>
  3523. </member>
  3524. <member name="M:log4net.Appender.IAppender.Close">
  3525. <summary>
  3526. Closes the appender and releases resources.
  3527. </summary>
  3528. <remarks>
  3529. <para>
  3530. Releases any resources allocated within the appender such as file handles,
  3531. network connections, etc.
  3532. </para>
  3533. <para>
  3534. It is a programming error to append to a closed appender.
  3535. </para>
  3536. </remarks>
  3537. </member>
  3538. <member name="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)">
  3539. <summary>
  3540. Log the logging event in Appender specific way.
  3541. </summary>
  3542. <param name="loggingEvent">The event to log</param>
  3543. <remarks>
  3544. <para>
  3545. This method is called to log a message into this appender.
  3546. </para>
  3547. </remarks>
  3548. </member>
  3549. <member name="P:log4net.Appender.IAppender.Name">
  3550. <summary>
  3551. Gets or sets the name of this appender.
  3552. </summary>
  3553. <value>The name of the appender.</value>
  3554. <remarks>
  3555. <para>The name uniquely identifies the appender.</para>
  3556. </remarks>
  3557. </member>
  3558. <member name="T:log4net.Appender.IBulkAppender">
  3559. <summary>
  3560. Interface for appenders that support bulk logging.
  3561. </summary>
  3562. <remarks>
  3563. <para>
  3564. This interface extends the <see cref="T:log4net.Appender.IAppender"/> interface to
  3565. support bulk logging of <see cref="T:log4net.Core.LoggingEvent"/> objects. Appenders
  3566. should only implement this interface if they can bulk log efficiently.
  3567. </para>
  3568. </remarks>
  3569. <author>Nicko Cadell</author>
  3570. </member>
  3571. <member name="M:log4net.Appender.IBulkAppender.DoAppend(log4net.Core.LoggingEvent[])">
  3572. <summary>
  3573. Log the array of logging events in Appender specific way.
  3574. </summary>
  3575. <param name="loggingEvents">The events to log</param>
  3576. <remarks>
  3577. <para>
  3578. This method is called to log an array of events into this appender.
  3579. </para>
  3580. </remarks>
  3581. </member>
  3582. <member name="T:log4net.Appender.IFlushable">
  3583. <summary>
  3584. Interface that can be implemented by Appenders that buffer logging data and expose a <see cref="M:log4net.Appender.IFlushable.Flush(System.Int32)"/> method.
  3585. </summary>
  3586. </member>
  3587. <member name="M:log4net.Appender.IFlushable.Flush(System.Int32)">
  3588. <summary>
  3589. Flushes any buffered log data.
  3590. </summary>
  3591. <remarks>
  3592. 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
  3593. the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  3594. <para>
  3595. Typically this is done by locking on the Appender instance, e.g.:
  3596. <code>
  3597. <![CDATA[
  3598. public bool Flush(int millisecondsTimeout)
  3599. {
  3600. lock(this)
  3601. {
  3602. // Flush buffered logging data
  3603. ...
  3604. }
  3605. }
  3606. ]]>
  3607. </code>
  3608. </para>
  3609. <para>
  3610. The <paramref name="millisecondsTimeout"/> parameter is only relevant for appenders that process logging events asynchronously,
  3611. such as <see cref="!:RemotingAppender"/>.
  3612. </para>
  3613. </remarks>
  3614. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  3615. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  3616. </member>
  3617. <member name="T:log4net.Appender.LocalSyslogAppender">
  3618. <summary>
  3619. Logs events to a local syslog service.
  3620. </summary>
  3621. <remarks>
  3622. <note>
  3623. This appender uses the POSIX libc library functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c>.
  3624. If these functions are not available on the local system then this appender will not work!
  3625. </note>
  3626. <para>
  3627. The functions <c>openlog</c>, <c>syslog</c>, and <c>closelog</c> are specified in SUSv2 and
  3628. POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service.
  3629. </para>
  3630. <para>
  3631. This appender talks to a local syslog service. If you need to log to a remote syslog
  3632. daemon and you cannot configure your local syslog service to do this you may be
  3633. able to use the <see cref="T:log4net.Appender.RemoteSyslogAppender"/> to log via UDP.
  3634. </para>
  3635. <para>
  3636. Syslog messages must have a facility and and a severity. The severity
  3637. is derived from the Level of the logging event.
  3638. The facility must be chosen from the set of defined syslog
  3639. <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  3640. and cannot be extended.
  3641. </para>
  3642. <para>
  3643. An identifier is specified with each log message. This can be specified
  3644. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  3645. as the tag) must not contain white space. The default value for the
  3646. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  3647. </para>
  3648. </remarks>
  3649. <author>Rob Lyon</author>
  3650. <author>Nicko Cadell</author>
  3651. </member>
  3652. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogSeverity">
  3653. <summary>
  3654. syslog severities
  3655. </summary>
  3656. <remarks>
  3657. <para>
  3658. The log4net Level maps to a syslog severity using the
  3659. <see cref="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)"/> method and the <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/>
  3660. class. The severity is set on <see cref="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity"/>.
  3661. </para>
  3662. </remarks>
  3663. </member>
  3664. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Emergency">
  3665. <summary>
  3666. system is unusable
  3667. </summary>
  3668. </member>
  3669. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Alert">
  3670. <summary>
  3671. action must be taken immediately
  3672. </summary>
  3673. </member>
  3674. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Critical">
  3675. <summary>
  3676. critical conditions
  3677. </summary>
  3678. </member>
  3679. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Error">
  3680. <summary>
  3681. error conditions
  3682. </summary>
  3683. </member>
  3684. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Warning">
  3685. <summary>
  3686. warning conditions
  3687. </summary>
  3688. </member>
  3689. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Notice">
  3690. <summary>
  3691. normal but significant condition
  3692. </summary>
  3693. </member>
  3694. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Informational">
  3695. <summary>
  3696. informational
  3697. </summary>
  3698. </member>
  3699. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogSeverity.Debug">
  3700. <summary>
  3701. debug-level messages
  3702. </summary>
  3703. </member>
  3704. <member name="T:log4net.Appender.LocalSyslogAppender.SyslogFacility">
  3705. <summary>
  3706. syslog facilities
  3707. </summary>
  3708. <remarks>
  3709. <para>
  3710. The syslog facility defines which subsystem the logging comes from.
  3711. This is set on the <see cref="P:log4net.Appender.LocalSyslogAppender.Facility"/> property.
  3712. </para>
  3713. </remarks>
  3714. </member>
  3715. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Kernel">
  3716. <summary>
  3717. kernel messages
  3718. </summary>
  3719. </member>
  3720. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User">
  3721. <summary>
  3722. random user-level messages
  3723. </summary>
  3724. </member>
  3725. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Mail">
  3726. <summary>
  3727. mail system
  3728. </summary>
  3729. </member>
  3730. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Daemons">
  3731. <summary>
  3732. system daemons
  3733. </summary>
  3734. </member>
  3735. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization">
  3736. <summary>
  3737. security/authorization messages
  3738. </summary>
  3739. </member>
  3740. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Syslog">
  3741. <summary>
  3742. messages generated internally by syslogd
  3743. </summary>
  3744. </member>
  3745. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Printer">
  3746. <summary>
  3747. line printer subsystem
  3748. </summary>
  3749. </member>
  3750. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.News">
  3751. <summary>
  3752. network news subsystem
  3753. </summary>
  3754. </member>
  3755. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Uucp">
  3756. <summary>
  3757. UUCP subsystem
  3758. </summary>
  3759. </member>
  3760. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock">
  3761. <summary>
  3762. clock (cron/at) daemon
  3763. </summary>
  3764. </member>
  3765. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Authorization2">
  3766. <summary>
  3767. security/authorization messages (private)
  3768. </summary>
  3769. </member>
  3770. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ftp">
  3771. <summary>
  3772. ftp daemon
  3773. </summary>
  3774. </member>
  3775. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Ntp">
  3776. <summary>
  3777. NTP subsystem
  3778. </summary>
  3779. </member>
  3780. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Audit">
  3781. <summary>
  3782. log audit
  3783. </summary>
  3784. </member>
  3785. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Alert">
  3786. <summary>
  3787. log alert
  3788. </summary>
  3789. </member>
  3790. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Clock2">
  3791. <summary>
  3792. clock daemon
  3793. </summary>
  3794. </member>
  3795. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local0">
  3796. <summary>
  3797. reserved for local use
  3798. </summary>
  3799. </member>
  3800. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local1">
  3801. <summary>
  3802. reserved for local use
  3803. </summary>
  3804. </member>
  3805. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local2">
  3806. <summary>
  3807. reserved for local use
  3808. </summary>
  3809. </member>
  3810. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local3">
  3811. <summary>
  3812. reserved for local use
  3813. </summary>
  3814. </member>
  3815. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local4">
  3816. <summary>
  3817. reserved for local use
  3818. </summary>
  3819. </member>
  3820. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local5">
  3821. <summary>
  3822. reserved for local use
  3823. </summary>
  3824. </member>
  3825. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local6">
  3826. <summary>
  3827. reserved for local use
  3828. </summary>
  3829. </member>
  3830. <member name="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.Local7">
  3831. <summary>
  3832. reserved for local use
  3833. </summary>
  3834. </member>
  3835. <member name="M:log4net.Appender.LocalSyslogAppender.#ctor">
  3836. <summary>
  3837. Initializes a new instance of the <see cref="T:log4net.Appender.LocalSyslogAppender" /> class.
  3838. </summary>
  3839. <remarks>
  3840. This instance of the <see cref="T:log4net.Appender.LocalSyslogAppender" /> class is set up to write
  3841. to a local syslog service.
  3842. </remarks>
  3843. </member>
  3844. <member name="P:log4net.Appender.LocalSyslogAppender.Identity">
  3845. <summary>
  3846. Message identity
  3847. </summary>
  3848. <remarks>
  3849. <para>
  3850. An identifier is specified with each log message. This can be specified
  3851. by setting the <see cref="P:log4net.Appender.LocalSyslogAppender.Identity"/> property. The identity (also know
  3852. as the tag) must not contain white space. The default value for the
  3853. identity is the application name (from <see cref="P:log4net.Util.SystemInfo.ApplicationFriendlyName"/>).
  3854. </para>
  3855. </remarks>
  3856. </member>
  3857. <member name="P:log4net.Appender.LocalSyslogAppender.Facility">
  3858. <summary>
  3859. Syslog facility
  3860. </summary>
  3861. <remarks>
  3862. Set to one of the <see cref="T:log4net.Appender.LocalSyslogAppender.SyslogFacility"/> values. The list of
  3863. facilities is predefined and cannot be extended. The default value
  3864. is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  3865. </remarks>
  3866. </member>
  3867. <member name="M:log4net.Appender.LocalSyslogAppender.AddMapping(log4net.Appender.LocalSyslogAppender.LevelSeverity)">
  3868. <summary>
  3869. Add a mapping of level to severity
  3870. </summary>
  3871. <param name="mapping">The mapping to add</param>
  3872. <remarks>
  3873. <para>
  3874. Adds a <see cref="T:log4net.Appender.LocalSyslogAppender.LevelSeverity"/> to this appender.
  3875. </para>
  3876. </remarks>
  3877. </member>
  3878. <member name="M:log4net.Appender.LocalSyslogAppender.ActivateOptions">
  3879. <summary>
  3880. Initialize the appender based on the options set.
  3881. </summary>
  3882. <remarks>
  3883. <para>
  3884. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  3885. activation scheme. The <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> method must
  3886. be called on this object after the configuration properties have
  3887. been set. Until <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> is called this
  3888. object is in an undefined state and must not be used.
  3889. </para>
  3890. <para>
  3891. If any of the configuration properties are modified then
  3892. <see cref="M:log4net.Appender.LocalSyslogAppender.ActivateOptions"/> must be called again.
  3893. </para>
  3894. </remarks>
  3895. </member>
  3896. <member name="M:log4net.Appender.LocalSyslogAppender.Append(log4net.Core.LoggingEvent)">
  3897. <summary>
  3898. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  3899. </summary>
  3900. <param name="loggingEvent">The event to log.</param>
  3901. <remarks>
  3902. <para>
  3903. Writes the event to a remote syslog daemon.
  3904. </para>
  3905. <para>
  3906. The format of the output will depend on the appender's layout.
  3907. </para>
  3908. </remarks>
  3909. </member>
  3910. <member name="M:log4net.Appender.LocalSyslogAppender.OnClose">
  3911. <summary>
  3912. Close the syslog when the appender is closed
  3913. </summary>
  3914. <remarks>
  3915. <para>
  3916. Close the syslog when the appender is closed
  3917. </para>
  3918. </remarks>
  3919. </member>
  3920. <member name="P:log4net.Appender.LocalSyslogAppender.RequiresLayout">
  3921. <summary>
  3922. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  3923. </summary>
  3924. <value><c>true</c></value>
  3925. <remarks>
  3926. <para>
  3927. This appender requires a <see cref="P:log4net.Appender.AppenderSkeleton.Layout"/> to be set.
  3928. </para>
  3929. </remarks>
  3930. </member>
  3931. <member name="M:log4net.Appender.LocalSyslogAppender.GetSeverity(log4net.Core.Level)">
  3932. <summary>
  3933. Translates a log4net level to a syslog severity.
  3934. </summary>
  3935. <param name="level">A log4net level.</param>
  3936. <returns>A syslog severity.</returns>
  3937. <remarks>
  3938. <para>
  3939. Translates a log4net level to a syslog severity.
  3940. </para>
  3941. </remarks>
  3942. </member>
  3943. <member name="M:log4net.Appender.LocalSyslogAppender.GeneratePriority(log4net.Appender.LocalSyslogAppender.SyslogFacility,log4net.Appender.LocalSyslogAppender.SyslogSeverity)">
  3944. <summary>
  3945. Generate a syslog priority.
  3946. </summary>
  3947. <param name="facility">The syslog facility.</param>
  3948. <param name="severity">The syslog severity.</param>
  3949. <returns>A syslog priority.</returns>
  3950. </member>
  3951. <member name="F:log4net.Appender.LocalSyslogAppender.m_facility">
  3952. <summary>
  3953. The facility. The default facility is <see cref="F:log4net.Appender.LocalSyslogAppender.SyslogFacility.User"/>.
  3954. </summary>
  3955. </member>
  3956. <member name="F:log4net.Appender.LocalSyslogAppender.m_identity">
  3957. <summary>
  3958. The message identity
  3959. </summary>
  3960. </member>
  3961. <member name="F:log4net.Appender.LocalSyslogAppender.m_handleToIdentity">
  3962. <summary>
  3963. Marshaled handle to the identity string. We have to hold on to the
  3964. string as the <c>openlog</c> and <c>syslog</c> APIs just hold the
  3965. pointer to the ident and dereference it for each log message.
  3966. </summary>
  3967. </member>
  3968. <member name="F:log4net.Appender.LocalSyslogAppender.m_levelMapping">
  3969. <summary>
  3970. Mapping from level object to syslog severity
  3971. </summary>
  3972. </member>
  3973. <member name="M:log4net.Appender.LocalSyslogAppender.openlog(System.IntPtr,System.Int32,log4net.Appender.LocalSyslogAppender.SyslogFacility)">
  3974. <summary>
  3975. Open connection to system logger.
  3976. </summary>
  3977. </member>
  3978. <member name="M:log4net.Appender.LocalSyslogAppender.syslog(System.Int32,System.String,System.String)">
  3979. <summary>
  3980. Generate a log message.
  3981. </summary>
  3982. <remarks>
  3983. <para>
  3984. The libc syslog method takes a format string and a variable argument list similar
  3985. to the classic printf function. As this type of vararg list is not supported
  3986. by C# we need to specify the arguments explicitly. Here we have specified the
  3987. format string with a single message argument. The caller must set the format
  3988. string to <c>"%s"</c>.
  3989. </para>
  3990. </remarks>
  3991. </member>
  3992. <member name="M:log4net.Appender.LocalSyslogAppender.closelog">
  3993. <summary>
  3994. Close descriptor used to write to system logger.
  3995. </summary>
  3996. </member>
  3997. <member name="T:log4net.Appender.LocalSyslogAppender.LevelSeverity">
  3998. <summary>
  3999. A class to act as a mapping between the level that a logging call is made at and
  4000. the syslog severity that is should be logged at.
  4001. </summary>
  4002. <remarks>
  4003. <para>
  4004. A class to act as a mapping between the level that a logging call is made at and
  4005. the syslog severity that is should be logged at.
  4006. </para>
  4007. </remarks>
  4008. </member>
  4009. <member name="P:log4net.Appender.LocalSyslogAppender.LevelSeverity.Severity">
  4010. <summary>
  4011. The mapped syslog severity for the specified level
  4012. </summary>
  4013. <remarks>
  4014. <para>
  4015. Required property.
  4016. The mapped syslog severity for the specified level
  4017. </para>
  4018. </remarks>
  4019. </member>
  4020. <member name="T:log4net.Appender.ManagedColoredConsoleAppender">
  4021. <summary>
  4022. Appends colorful logging events to the console, using the .NET 2
  4023. built-in capabilities.
  4024. </summary>
  4025. <remarks>
  4026. <para>
  4027. ManagedColoredConsoleAppender appends log events to the standard output stream
  4028. or the error output stream using a layout specified by the
  4029. user. It also allows the color of a specific type of message to be set.
  4030. </para>
  4031. <para>
  4032. By default, all output is written to the console's standard output stream.
  4033. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> property can be set to direct the output to the
  4034. error stream.
  4035. </para>
  4036. <para>
  4037. When configuring the colored console appender, mappings should be
  4038. specified to map logging levels to colors. For example:
  4039. </para>
  4040. <code lang="XML" escaped="true">
  4041. <mapping>
  4042. <level value="ERROR" />
  4043. <foreColor value="DarkRed" />
  4044. <backColor value="White" />
  4045. </mapping>
  4046. <mapping>
  4047. <level value="WARN" />
  4048. <foreColor value="Yellow" />
  4049. </mapping>
  4050. <mapping>
  4051. <level value="INFO" />
  4052. <foreColor value="White" />
  4053. </mapping>
  4054. <mapping>
  4055. <level value="DEBUG" />
  4056. <foreColor value="Blue" />
  4057. </mapping>
  4058. </code>
  4059. <para>
  4060. The Level is the standard log4net logging level while
  4061. ForeColor and BackColor are the values of <see cref="T:System.ConsoleColor"/>
  4062. enumeration.
  4063. </para>
  4064. <para>
  4065. Based on the ColoredConsoleAppender
  4066. </para>
  4067. </remarks>
  4068. <author>Rick Hobbs</author>
  4069. <author>Nicko Cadell</author>
  4070. <author>Pavlos Touboulidis</author>
  4071. </member>
  4072. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.#ctor">
  4073. <summary>
  4074. Initializes a new instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender" /> class.
  4075. </summary>
  4076. <remarks>
  4077. The instance of the <see cref="T:log4net.Appender.ManagedColoredConsoleAppender" /> class is set up to write
  4078. to the standard output stream.
  4079. </remarks>
  4080. </member>
  4081. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.Target">
  4082. <summary>
  4083. Target is the value of the console output stream.
  4084. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4085. </summary>
  4086. <value>
  4087. Target is the value of the console output stream.
  4088. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4089. </value>
  4090. <remarks>
  4091. <para>
  4092. Target is the value of the console output stream.
  4093. This is either <c>"Console.Out"</c> or <c>"Console.Error"</c>.
  4094. </para>
  4095. </remarks>
  4096. </member>
  4097. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.AddMapping(log4net.Appender.ManagedColoredConsoleAppender.LevelColors)">
  4098. <summary>
  4099. Add a mapping of level to color - done by the config file
  4100. </summary>
  4101. <param name="mapping">The mapping to add</param>
  4102. <remarks>
  4103. <para>
  4104. Add a <see cref="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors"/> mapping to this appender.
  4105. Each mapping defines the foreground and background colors
  4106. for a level.
  4107. </para>
  4108. </remarks>
  4109. </member>
  4110. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.Append(log4net.Core.LoggingEvent)">
  4111. <summary>
  4112. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(log4net.Core.LoggingEvent)"/> method.
  4113. </summary>
  4114. <param name="loggingEvent">The event to log.</param>
  4115. <remarks>
  4116. <para>
  4117. Writes the event to the console.
  4118. </para>
  4119. <para>
  4120. The format of the output will depend on the appender's layout.
  4121. </para>
  4122. </remarks>
  4123. </member>
  4124. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.RequiresLayout">
  4125. <summary>
  4126. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4127. </summary>
  4128. <value><c>true</c></value>
  4129. <remarks>
  4130. <para>
  4131. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4132. </para>
  4133. </remarks>
  4134. </member>
  4135. <member name="M:log4net.Appender.ManagedColoredConsoleAppender.ActivateOptions">
  4136. <summary>
  4137. Initialize the options for this appender
  4138. </summary>
  4139. <remarks>
  4140. <para>
  4141. Initialize the level to color mappings set on this appender.
  4142. </para>
  4143. </remarks>
  4144. </member>
  4145. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleOut">
  4146. <summary>
  4147. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4148. standard output stream.
  4149. </summary>
  4150. <remarks>
  4151. <para>
  4152. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4153. standard output stream.
  4154. </para>
  4155. </remarks>
  4156. </member>
  4157. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.ConsoleError">
  4158. <summary>
  4159. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4160. standard error output stream.
  4161. </summary>
  4162. <remarks>
  4163. <para>
  4164. The <see cref="P:log4net.Appender.ManagedColoredConsoleAppender.Target"/> to use when writing to the Console
  4165. standard error output stream.
  4166. </para>
  4167. </remarks>
  4168. </member>
  4169. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_writeToErrorStream">
  4170. <summary>
  4171. Flag to write output to the error stream rather than the standard output stream
  4172. </summary>
  4173. </member>
  4174. <member name="F:log4net.Appender.ManagedColoredConsoleAppender.m_levelMapping">
  4175. <summary>
  4176. Mapping from level object to color value
  4177. </summary>
  4178. </member>
  4179. <member name="T:log4net.Appender.ManagedColoredConsoleAppender.LevelColors">
  4180. <summary>
  4181. A class to act as a mapping between the level that a logging call is made at and
  4182. the color it should be displayed as.
  4183. </summary>
  4184. <remarks>
  4185. <para>
  4186. Defines the mapping between a level and the color it should be displayed in.
  4187. </para>
  4188. </remarks>
  4189. </member>
  4190. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.ForeColor">
  4191. <summary>
  4192. The mapped foreground color for the specified level
  4193. </summary>
  4194. <remarks>
  4195. <para>
  4196. Required property.
  4197. The mapped foreground color for the specified level.
  4198. </para>
  4199. </remarks>
  4200. </member>
  4201. <member name="P:log4net.Appender.ManagedColoredConsoleAppender.LevelColors.BackColor">
  4202. <summary>
  4203. The mapped background color for the specified level
  4204. </summary>
  4205. <remarks>
  4206. <para>
  4207. Required property.
  4208. The mapped background color for the specified level.
  4209. </para>
  4210. </remarks>
  4211. </member>
  4212. <member name="T:log4net.Appender.MemoryAppender">
  4213. <summary>
  4214. Stores logging events in an array.
  4215. </summary>
  4216. <remarks>
  4217. <para>
  4218. The memory appender stores all the logging events
  4219. that are appended in an in-memory array.
  4220. </para>
  4221. <para>
  4222. Use the <see cref="M:PopAllEvents()"/> method to get
  4223. and clear the current list of events that have been appended.
  4224. </para>
  4225. <para>
  4226. Use the <see cref="M:GetEvents()"/> method to get the current
  4227. list of events that have been appended. Note there is a
  4228. race-condition when calling <see cref="M:GetEvents()"/> and
  4229. <see cref="M:Clear()"/> in pairs, you better use <see
  4230. mref="M:PopAllEvents()"/> in that case.
  4231. </para>
  4232. <para>
  4233. Use the <see cref="M:Clear()"/> method to clear the
  4234. current list of events. Note there is a
  4235. race-condition when calling <see cref="M:GetEvents()"/> and
  4236. <see cref="M:Clear()"/> in pairs, you better use <see
  4237. mref="M:PopAllEvents()"/> in that case.
  4238. </para>
  4239. </remarks>
  4240. <author>Julian Biddle</author>
  4241. <author>Nicko Cadell</author>
  4242. <author>Gert Driesen</author>
  4243. </member>
  4244. <member name="M:log4net.Appender.MemoryAppender.#ctor">
  4245. <summary>
  4246. Initializes a new instance of the <see cref="T:log4net.Appender.MemoryAppender" /> class.
  4247. </summary>
  4248. <remarks>
  4249. <para>
  4250. Default constructor.
  4251. </para>
  4252. </remarks>
  4253. </member>
  4254. <member name="M:log4net.Appender.MemoryAppender.GetEvents">
  4255. <summary>
  4256. Gets the events that have been logged.
  4257. </summary>
  4258. <returns>The events that have been logged</returns>
  4259. <remarks>
  4260. <para>
  4261. Gets the events that have been logged.
  4262. </para>
  4263. </remarks>
  4264. </member>
  4265. <member name="P:log4net.Appender.MemoryAppender.OnlyFixPartialEventData">
  4266. <summary>
  4267. Gets or sets a value indicating whether only part of the logging event
  4268. data should be fixed.
  4269. </summary>
  4270. <value>
  4271. <c>true</c> if the appender should only fix part of the logging event
  4272. data, otherwise <c>false</c>. The default is <c>false</c>.
  4273. </value>
  4274. <remarks>
  4275. <para>
  4276. Setting this property to <c>true</c> will cause only part of the event
  4277. data to be fixed and stored in the appender, hereby improving performance.
  4278. </para>
  4279. <para>
  4280. See <see cref="M:LoggingEvent.FixVolatileData(bool)"/> for more information.
  4281. </para>
  4282. </remarks>
  4283. </member>
  4284. <member name="P:log4net.Appender.MemoryAppender.Fix">
  4285. <summary>
  4286. Gets or sets the fields that will be fixed in the event
  4287. </summary>
  4288. <remarks>
  4289. <para>
  4290. The logging event needs to have certain thread specific values
  4291. captured before it can be buffered. See <see cref="P:log4net.Core.LoggingEvent.Fix"/>
  4292. for details.
  4293. </para>
  4294. </remarks>
  4295. </member>
  4296. <member name="M:log4net.Appender.MemoryAppender.Append(log4net.Core.LoggingEvent)">
  4297. <summary>
  4298. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4299. </summary>
  4300. <param name="loggingEvent">the event to log</param>
  4301. <remarks>
  4302. <para>Stores the <paramref name="loggingEvent"/> in the events list.</para>
  4303. </remarks>
  4304. </member>
  4305. <member name="M:log4net.Appender.MemoryAppender.Clear">
  4306. <summary>
  4307. Clear the list of events
  4308. </summary>
  4309. <remarks>
  4310. Clear the list of events
  4311. </remarks>
  4312. </member>
  4313. <member name="M:log4net.Appender.MemoryAppender.PopAllEvents">
  4314. <summary>
  4315. Gets the events that have been logged and clears the list of events.
  4316. </summary>
  4317. <returns>The events that have been logged</returns>
  4318. <remarks>
  4319. <para>
  4320. Gets the events that have been logged and clears the list of events.
  4321. </para>
  4322. </remarks>
  4323. </member>
  4324. <member name="F:log4net.Appender.MemoryAppender.m_eventsList">
  4325. <summary>
  4326. The list of events that have been appended.
  4327. </summary>
  4328. </member>
  4329. <member name="F:log4net.Appender.MemoryAppender.m_fixFlags">
  4330. <summary>
  4331. Value indicating which fields in the event should be fixed
  4332. </summary>
  4333. <remarks>
  4334. By default all fields are fixed
  4335. </remarks>
  4336. </member>
  4337. <member name="T:log4net.Appender.NetSendAppender">
  4338. <summary>
  4339. Logs entries by sending network messages using the
  4340. <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)" /> native function.
  4341. </summary>
  4342. <remarks>
  4343. <para>
  4344. You can send messages only to names that are active
  4345. on the network. If you send the message to a user name,
  4346. that user must be logged on and running the Messenger
  4347. service to receive the message.
  4348. </para>
  4349. <para>
  4350. The receiver will get a top most window displaying the
  4351. messages one at a time, therefore this appender should
  4352. not be used to deliver a high volume of messages.
  4353. </para>
  4354. <para>
  4355. The following table lists some possible uses for this appender :
  4356. </para>
  4357. <para>
  4358. <list type="table">
  4359. <listheader>
  4360. <term>Action</term>
  4361. <description>Property Value(s)</description>
  4362. </listheader>
  4363. <item>
  4364. <term>Send a message to a user account on the local machine</term>
  4365. <description>
  4366. <para>
  4367. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine&gt;
  4368. </para>
  4369. <para>
  4370. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  4371. </para>
  4372. </description>
  4373. </item>
  4374. <item>
  4375. <term>Send a message to a user account on a remote machine</term>
  4376. <description>
  4377. <para>
  4378. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the remote machine&gt;
  4379. </para>
  4380. <para>
  4381. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  4382. </para>
  4383. </description>
  4384. </item>
  4385. <item>
  4386. <term>Send a message to a domain user account</term>
  4387. <description>
  4388. <para>
  4389. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of a domain controller | uninitialized&gt;
  4390. </para>
  4391. <para>
  4392. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;user name&gt;
  4393. </para>
  4394. </description>
  4395. </item>
  4396. <item>
  4397. <term>Send a message to all the names in a workgroup or domain</term>
  4398. <description>
  4399. <para>
  4400. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;workgroup name | domain name&gt;*
  4401. </para>
  4402. </description>
  4403. </item>
  4404. <item>
  4405. <term>Send a message from the local machine to a remote machine</term>
  4406. <description>
  4407. <para>
  4408. <see cref="P:log4net.Appender.NetSendAppender.Server"/> = &lt;name of the local machine | uninitialized&gt;
  4409. </para>
  4410. <para>
  4411. <see cref="P:log4net.Appender.NetSendAppender.Recipient"/> = &lt;name of the remote machine&gt;
  4412. </para>
  4413. </description>
  4414. </item>
  4415. </list>
  4416. </para>
  4417. <para>
  4418. <b>Note :</b> security restrictions apply for sending
  4419. network messages, see <see cref="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)" />
  4420. for more information.
  4421. </para>
  4422. </remarks>
  4423. <example>
  4424. <para>
  4425. An example configuration section to log information
  4426. using this appender from the local machine, named
  4427. LOCAL_PC, to machine OPERATOR_PC :
  4428. </para>
  4429. <code lang="XML" escaped="true">
  4430. <appender name="NetSendAppender_Operator" type="log4net.Appender.NetSendAppender">
  4431. <server value="LOCAL_PC" />
  4432. <recipient value="OPERATOR_PC" />
  4433. <layout type="log4net.Layout.PatternLayout" value="%-5p %c [%x] - %m%n" />
  4434. </appender>
  4435. </code>
  4436. </example>
  4437. <author>Nicko Cadell</author>
  4438. <author>Gert Driesen</author>
  4439. </member>
  4440. <member name="F:log4net.Appender.NetSendAppender.m_server">
  4441. <summary>
  4442. The DNS or NetBIOS name of the server on which the function is to execute.
  4443. </summary>
  4444. </member>
  4445. <member name="F:log4net.Appender.NetSendAppender.m_sender">
  4446. <summary>
  4447. The sender of the network message.
  4448. </summary>
  4449. </member>
  4450. <member name="F:log4net.Appender.NetSendAppender.m_recipient">
  4451. <summary>
  4452. The message alias to which the message should be sent.
  4453. </summary>
  4454. </member>
  4455. <member name="F:log4net.Appender.NetSendAppender.m_securityContext">
  4456. <summary>
  4457. The security context to use for privileged calls
  4458. </summary>
  4459. </member>
  4460. <member name="M:log4net.Appender.NetSendAppender.#ctor">
  4461. <summary>
  4462. Initializes the appender.
  4463. </summary>
  4464. <remarks>
  4465. The default constructor initializes all fields to their default values.
  4466. </remarks>
  4467. </member>
  4468. <member name="P:log4net.Appender.NetSendAppender.Sender">
  4469. <summary>
  4470. Gets or sets the sender of the message.
  4471. </summary>
  4472. <value>
  4473. The sender of the message.
  4474. </value>
  4475. <remarks>
  4476. If this property is not specified, the message is sent from the local computer.
  4477. </remarks>
  4478. </member>
  4479. <member name="P:log4net.Appender.NetSendAppender.Recipient">
  4480. <summary>
  4481. Gets or sets the message alias to which the message should be sent.
  4482. </summary>
  4483. <value>
  4484. The recipient of the message.
  4485. </value>
  4486. <remarks>
  4487. This property should always be specified in order to send a message.
  4488. </remarks>
  4489. </member>
  4490. <member name="P:log4net.Appender.NetSendAppender.Server">
  4491. <summary>
  4492. Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute.
  4493. </summary>
  4494. <value>
  4495. DNS or NetBIOS name of the remote server on which the function is to execute.
  4496. </value>
  4497. <remarks>
  4498. <para>
  4499. For Windows NT 4.0 and earlier, the string should begin with \\.
  4500. </para>
  4501. <para>
  4502. If this property is not specified, the local computer is used.
  4503. </para>
  4504. </remarks>
  4505. </member>
  4506. <member name="P:log4net.Appender.NetSendAppender.SecurityContext">
  4507. <summary>
  4508. Gets or sets the <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  4509. </summary>
  4510. <value>
  4511. The <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> used to call the NetSend method.
  4512. </value>
  4513. <remarks>
  4514. <para>
  4515. Unless a <see cref="P:log4net.Appender.NetSendAppender.SecurityContext"/> specified here for this appender
  4516. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  4517. security context to use. The default behavior is to use the security context
  4518. of the current thread.
  4519. </para>
  4520. </remarks>
  4521. </member>
  4522. <member name="M:log4net.Appender.NetSendAppender.ActivateOptions">
  4523. <summary>
  4524. Initialize the appender based on the options set.
  4525. </summary>
  4526. <remarks>
  4527. <para>
  4528. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  4529. activation scheme. The <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> method must
  4530. be called on this object after the configuration properties have
  4531. been set. Until <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> is called this
  4532. object is in an undefined state and must not be used.
  4533. </para>
  4534. <para>
  4535. If any of the configuration properties are modified then
  4536. <see cref="M:log4net.Appender.NetSendAppender.ActivateOptions"/> must be called again.
  4537. </para>
  4538. <para>
  4539. The appender will be ignored if no <see cref="P:log4net.Appender.NetSendAppender.Recipient" /> was specified.
  4540. </para>
  4541. </remarks>
  4542. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.NetSendAppender.Recipient" /> was not specified.</exception>
  4543. </member>
  4544. <member name="M:log4net.Appender.NetSendAppender.Append(log4net.Core.LoggingEvent)">
  4545. <summary>
  4546. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4547. </summary>
  4548. <param name="loggingEvent">The event to log.</param>
  4549. <remarks>
  4550. <para>
  4551. Sends the event using a network message.
  4552. </para>
  4553. </remarks>
  4554. </member>
  4555. <member name="P:log4net.Appender.NetSendAppender.RequiresLayout">
  4556. <summary>
  4557. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4558. </summary>
  4559. <value><c>true</c></value>
  4560. <remarks>
  4561. <para>
  4562. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4563. </para>
  4564. </remarks>
  4565. </member>
  4566. <member name="M:log4net.Appender.NetSendAppender.NetMessageBufferSend(System.String,System.String,System.String,System.String,System.Int32)">
  4567. <summary>
  4568. Sends a buffer of information to a registered message alias.
  4569. </summary>
  4570. <param name="serverName">The DNS or NetBIOS name of the server on which the function is to execute.</param>
  4571. <param name="msgName">The message alias to which the message buffer should be sent</param>
  4572. <param name="fromName">The originator of the message.</param>
  4573. <param name="buffer">The message text.</param>
  4574. <param name="bufferSize">The length, in bytes, of the message text.</param>
  4575. <remarks>
  4576. <para>
  4577. The following restrictions apply for sending network messages:
  4578. </para>
  4579. <para>
  4580. <list type="table">
  4581. <listheader>
  4582. <term>Platform</term>
  4583. <description>Requirements</description>
  4584. </listheader>
  4585. <item>
  4586. <term>Windows NT</term>
  4587. <description>
  4588. <para>
  4589. No special group membership is required to send a network message.
  4590. </para>
  4591. <para>
  4592. Admin, Accounts, Print, or Server Operator group membership is required to
  4593. successfully send a network message on a remote server.
  4594. </para>
  4595. </description>
  4596. </item>
  4597. <item>
  4598. <term>Windows 2000 or later</term>
  4599. <description>
  4600. <para>
  4601. If you send a message on a domain controller that is running Active Directory,
  4602. access is allowed or denied based on the access control list (ACL) for the securable
  4603. object. The default ACL permits only Domain Admins and Account Operators to send a network message.
  4604. </para>
  4605. <para>
  4606. On a member server or workstation, only Administrators and Server Operators can send a network message.
  4607. </para>
  4608. </description>
  4609. </item>
  4610. </list>
  4611. </para>
  4612. <para>
  4613. 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>.
  4614. </para>
  4615. </remarks>
  4616. <returns>
  4617. <para>
  4618. If the function succeeds, the return value is zero.
  4619. </para>
  4620. </returns>
  4621. </member>
  4622. <member name="T:log4net.Appender.OutputDebugStringAppender">
  4623. <summary>
  4624. Appends log events to the OutputDebugString system.
  4625. </summary>
  4626. <remarks>
  4627. <para>
  4628. OutputDebugStringAppender appends log events to the
  4629. OutputDebugString system.
  4630. </para>
  4631. <para>
  4632. The string is passed to the native <c>OutputDebugString</c>
  4633. function.
  4634. </para>
  4635. </remarks>
  4636. <author>Nicko Cadell</author>
  4637. <author>Gert Driesen</author>
  4638. </member>
  4639. <member name="M:log4net.Appender.OutputDebugStringAppender.#ctor">
  4640. <summary>
  4641. Initializes a new instance of the <see cref="T:log4net.Appender.OutputDebugStringAppender" /> class.
  4642. </summary>
  4643. <remarks>
  4644. <para>
  4645. Default constructor.
  4646. </para>
  4647. </remarks>
  4648. </member>
  4649. <member name="M:log4net.Appender.OutputDebugStringAppender.Append(log4net.Core.LoggingEvent)">
  4650. <summary>
  4651. Write the logging event to the output debug string API
  4652. </summary>
  4653. <param name="loggingEvent">the event to log</param>
  4654. <remarks>
  4655. <para>
  4656. Write the logging event to the output debug string API
  4657. </para>
  4658. </remarks>
  4659. </member>
  4660. <member name="P:log4net.Appender.OutputDebugStringAppender.RequiresLayout">
  4661. <summary>
  4662. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4663. </summary>
  4664. <value><c>true</c></value>
  4665. <remarks>
  4666. <para>
  4667. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  4668. </para>
  4669. </remarks>
  4670. </member>
  4671. <member name="M:log4net.Appender.OutputDebugStringAppender.OutputDebugString(System.String)">
  4672. <summary>
  4673. Stub for OutputDebugString native method
  4674. </summary>
  4675. <param name="message">the string to output</param>
  4676. <remarks>
  4677. <para>
  4678. Stub for OutputDebugString native method
  4679. </para>
  4680. </remarks>
  4681. </member>
  4682. <member name="T:log4net.Appender.RemoteSyslogAppender">
  4683. <summary>
  4684. Logs events to a remote syslog daemon.
  4685. </summary>
  4686. <remarks>
  4687. <para>
  4688. The BSD syslog protocol is used to remotely log to
  4689. a syslog daemon. The syslogd listens for for messages
  4690. on UDP port 514.
  4691. </para>
  4692. <para>
  4693. The syslog UDP protocol is not authenticated. Most syslog daemons
  4694. do not accept remote log messages because of the security implications.
  4695. You may be able to use the LocalSyslogAppender to talk to a local
  4696. syslog service.
  4697. </para>
  4698. <para>
  4699. There is an RFC 3164 that claims to document the BSD Syslog Protocol.
  4700. This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html.
  4701. This appender generates what the RFC calls an "Original Device Message",
  4702. i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation
  4703. this format of message will be accepted by all current syslog daemon
  4704. implementations. The daemon will attach the current time and the source
  4705. hostname or IP address to any messages received.
  4706. </para>
  4707. <para>
  4708. Syslog messages must have a facility and and a severity. The severity
  4709. is derived from the Level of the logging event.
  4710. The facility must be chosen from the set of defined syslog
  4711. <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The facilities list is predefined
  4712. and cannot be extended.
  4713. </para>
  4714. <para>
  4715. An identifier is specified with each log message. This can be specified
  4716. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  4717. as the tag) must not contain white space. The default value for the
  4718. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  4719. </para>
  4720. </remarks>
  4721. <author>Rob Lyon</author>
  4722. <author>Nicko Cadell</author>
  4723. </member>
  4724. <member name="F:log4net.Appender.RemoteSyslogAppender.DefaultSyslogPort">
  4725. <summary>
  4726. Syslog port 514
  4727. </summary>
  4728. </member>
  4729. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogSeverity">
  4730. <summary>
  4731. syslog severities
  4732. </summary>
  4733. <remarks>
  4734. <para>
  4735. The syslog severities.
  4736. </para>
  4737. </remarks>
  4738. </member>
  4739. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Emergency">
  4740. <summary>
  4741. system is unusable
  4742. </summary>
  4743. </member>
  4744. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Alert">
  4745. <summary>
  4746. action must be taken immediately
  4747. </summary>
  4748. </member>
  4749. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Critical">
  4750. <summary>
  4751. critical conditions
  4752. </summary>
  4753. </member>
  4754. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Error">
  4755. <summary>
  4756. error conditions
  4757. </summary>
  4758. </member>
  4759. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Warning">
  4760. <summary>
  4761. warning conditions
  4762. </summary>
  4763. </member>
  4764. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Notice">
  4765. <summary>
  4766. normal but significant condition
  4767. </summary>
  4768. </member>
  4769. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Informational">
  4770. <summary>
  4771. informational
  4772. </summary>
  4773. </member>
  4774. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogSeverity.Debug">
  4775. <summary>
  4776. debug-level messages
  4777. </summary>
  4778. </member>
  4779. <member name="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility">
  4780. <summary>
  4781. syslog facilities
  4782. </summary>
  4783. <remarks>
  4784. <para>
  4785. The syslog facilities
  4786. </para>
  4787. </remarks>
  4788. </member>
  4789. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Kernel">
  4790. <summary>
  4791. kernel messages
  4792. </summary>
  4793. </member>
  4794. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User">
  4795. <summary>
  4796. random user-level messages
  4797. </summary>
  4798. </member>
  4799. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Mail">
  4800. <summary>
  4801. mail system
  4802. </summary>
  4803. </member>
  4804. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Daemons">
  4805. <summary>
  4806. system daemons
  4807. </summary>
  4808. </member>
  4809. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization">
  4810. <summary>
  4811. security/authorization messages
  4812. </summary>
  4813. </member>
  4814. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Syslog">
  4815. <summary>
  4816. messages generated internally by syslogd
  4817. </summary>
  4818. </member>
  4819. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Printer">
  4820. <summary>
  4821. line printer subsystem
  4822. </summary>
  4823. </member>
  4824. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.News">
  4825. <summary>
  4826. network news subsystem
  4827. </summary>
  4828. </member>
  4829. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Uucp">
  4830. <summary>
  4831. UUCP subsystem
  4832. </summary>
  4833. </member>
  4834. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock">
  4835. <summary>
  4836. clock (cron/at) daemon
  4837. </summary>
  4838. </member>
  4839. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Authorization2">
  4840. <summary>
  4841. security/authorization messages (private)
  4842. </summary>
  4843. </member>
  4844. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ftp">
  4845. <summary>
  4846. ftp daemon
  4847. </summary>
  4848. </member>
  4849. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Ntp">
  4850. <summary>
  4851. NTP subsystem
  4852. </summary>
  4853. </member>
  4854. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Audit">
  4855. <summary>
  4856. log audit
  4857. </summary>
  4858. </member>
  4859. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Alert">
  4860. <summary>
  4861. log alert
  4862. </summary>
  4863. </member>
  4864. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Clock2">
  4865. <summary>
  4866. clock daemon
  4867. </summary>
  4868. </member>
  4869. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local0">
  4870. <summary>
  4871. reserved for local use
  4872. </summary>
  4873. </member>
  4874. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local1">
  4875. <summary>
  4876. reserved for local use
  4877. </summary>
  4878. </member>
  4879. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local2">
  4880. <summary>
  4881. reserved for local use
  4882. </summary>
  4883. </member>
  4884. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local3">
  4885. <summary>
  4886. reserved for local use
  4887. </summary>
  4888. </member>
  4889. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local4">
  4890. <summary>
  4891. reserved for local use
  4892. </summary>
  4893. </member>
  4894. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local5">
  4895. <summary>
  4896. reserved for local use
  4897. </summary>
  4898. </member>
  4899. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local6">
  4900. <summary>
  4901. reserved for local use
  4902. </summary>
  4903. </member>
  4904. <member name="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.Local7">
  4905. <summary>
  4906. reserved for local use
  4907. </summary>
  4908. </member>
  4909. <member name="M:log4net.Appender.RemoteSyslogAppender.#ctor">
  4910. <summary>
  4911. Initializes a new instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender" /> class.
  4912. </summary>
  4913. <remarks>
  4914. This instance of the <see cref="T:log4net.Appender.RemoteSyslogAppender" /> class is set up to write
  4915. to a remote syslog daemon.
  4916. </remarks>
  4917. </member>
  4918. <member name="P:log4net.Appender.RemoteSyslogAppender.Identity">
  4919. <summary>
  4920. Message identity
  4921. </summary>
  4922. <remarks>
  4923. <para>
  4924. An identifier is specified with each log message. This can be specified
  4925. by setting the <see cref="P:log4net.Appender.RemoteSyslogAppender.Identity"/> property. The identity (also know
  4926. as the tag) must not contain white space. The default value for the
  4927. identity is the application name (from <see cref="P:log4net.Core.LoggingEvent.Domain"/>).
  4928. </para>
  4929. </remarks>
  4930. </member>
  4931. <member name="P:log4net.Appender.RemoteSyslogAppender.Facility">
  4932. <summary>
  4933. Syslog facility
  4934. </summary>
  4935. <remarks>
  4936. Set to one of the <see cref="T:log4net.Appender.RemoteSyslogAppender.SyslogFacility"/> values. The list of
  4937. facilities is predefined and cannot be extended. The default value
  4938. is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  4939. </remarks>
  4940. </member>
  4941. <member name="M:log4net.Appender.RemoteSyslogAppender.AddMapping(log4net.Appender.RemoteSyslogAppender.LevelSeverity)">
  4942. <summary>
  4943. Add a mapping of level to severity
  4944. </summary>
  4945. <param name="mapping">The mapping to add</param>
  4946. <remarks>
  4947. <para>
  4948. Add a <see cref="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity"/> mapping to this appender.
  4949. </para>
  4950. </remarks>
  4951. </member>
  4952. <member name="M:log4net.Appender.RemoteSyslogAppender.Append(log4net.Core.LoggingEvent)">
  4953. <summary>
  4954. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  4955. </summary>
  4956. <param name="loggingEvent">The event to log.</param>
  4957. <remarks>
  4958. <para>
  4959. Writes the event to a remote syslog daemon.
  4960. </para>
  4961. <para>
  4962. The format of the output will depend on the appender's layout.
  4963. </para>
  4964. </remarks>
  4965. </member>
  4966. <member name="M:log4net.Appender.RemoteSyslogAppender.ActivateOptions">
  4967. <summary>
  4968. Initialize the options for this appender
  4969. </summary>
  4970. <remarks>
  4971. <para>
  4972. Initialize the level to syslog severity mappings set on this appender.
  4973. </para>
  4974. </remarks>
  4975. </member>
  4976. <member name="M:log4net.Appender.RemoteSyslogAppender.GetSeverity(log4net.Core.Level)">
  4977. <summary>
  4978. Translates a log4net level to a syslog severity.
  4979. </summary>
  4980. <param name="level">A log4net level.</param>
  4981. <returns>A syslog severity.</returns>
  4982. <remarks>
  4983. <para>
  4984. Translates a log4net level to a syslog severity.
  4985. </para>
  4986. </remarks>
  4987. </member>
  4988. <member name="M:log4net.Appender.RemoteSyslogAppender.GeneratePriority(log4net.Appender.RemoteSyslogAppender.SyslogFacility,log4net.Appender.RemoteSyslogAppender.SyslogSeverity)">
  4989. <summary>
  4990. Generate a syslog priority.
  4991. </summary>
  4992. <param name="facility">The syslog facility.</param>
  4993. <param name="severity">The syslog severity.</param>
  4994. <returns>A syslog priority.</returns>
  4995. <remarks>
  4996. <para>
  4997. Generate a syslog priority.
  4998. </para>
  4999. </remarks>
  5000. </member>
  5001. <member name="F:log4net.Appender.RemoteSyslogAppender.m_facility">
  5002. <summary>
  5003. The facility. The default facility is <see cref="F:log4net.Appender.RemoteSyslogAppender.SyslogFacility.User"/>.
  5004. </summary>
  5005. </member>
  5006. <member name="F:log4net.Appender.RemoteSyslogAppender.m_identity">
  5007. <summary>
  5008. The message identity
  5009. </summary>
  5010. </member>
  5011. <member name="F:log4net.Appender.RemoteSyslogAppender.m_levelMapping">
  5012. <summary>
  5013. Mapping from level object to syslog severity
  5014. </summary>
  5015. </member>
  5016. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferSize">
  5017. <summary>
  5018. Initial buffer size
  5019. </summary>
  5020. </member>
  5021. <member name="F:log4net.Appender.RemoteSyslogAppender.c_renderBufferMaxCapacity">
  5022. <summary>
  5023. Maximum buffer size before it is recycled
  5024. </summary>
  5025. </member>
  5026. <member name="T:log4net.Appender.RemoteSyslogAppender.LevelSeverity">
  5027. <summary>
  5028. A class to act as a mapping between the level that a logging call is made at and
  5029. the syslog severity that is should be logged at.
  5030. </summary>
  5031. <remarks>
  5032. <para>
  5033. A class to act as a mapping between the level that a logging call is made at and
  5034. the syslog severity that is should be logged at.
  5035. </para>
  5036. </remarks>
  5037. </member>
  5038. <member name="P:log4net.Appender.RemoteSyslogAppender.LevelSeverity.Severity">
  5039. <summary>
  5040. The mapped syslog severity for the specified level
  5041. </summary>
  5042. <remarks>
  5043. <para>
  5044. Required property.
  5045. The mapped syslog severity for the specified level
  5046. </para>
  5047. </remarks>
  5048. </member>
  5049. <member name="T:log4net.Appender.RollingFileAppender">
  5050. <summary>
  5051. Appender that rolls log files based on size or date or both.
  5052. </summary>
  5053. <remarks>
  5054. <para>
  5055. RollingFileAppender can roll log files based on size or date or both
  5056. depending on the setting of the <see cref="P:log4net.Appender.RollingFileAppender.RollingStyle"/> property.
  5057. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Size"/> the log file will be rolled
  5058. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  5059. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Date"/> the log file will be rolled
  5060. once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  5061. is crossed.
  5062. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite"/> the log file will be
  5063. rolled once the date boundary specified in the <see cref="P:log4net.Appender.RollingFileAppender.DatePattern"/> property
  5064. is crossed, but within a date boundary the file will also be rolled
  5065. once its size exceeds the <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/>.
  5066. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> the log file will be rolled when
  5067. the appender is configured. This effectively means that the log file can be
  5068. rolled once per program execution.
  5069. </para>
  5070. <para>
  5071. A of few additional optional features have been added:
  5072. <list type="bullet">
  5073. <item>Attach date pattern for current log file <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/></item>
  5074. <item>Backup number increments for newer files <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/></item>
  5075. <item>Infinite number of backups by file size <see cref="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups"/></item>
  5076. </list>
  5077. </para>
  5078. <note>
  5079. <para>
  5080. For large or infinite numbers of backup files a <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/>
  5081. greater than zero is highly recommended, otherwise all the backup files need
  5082. to be renamed each time a new backup is created.
  5083. </para>
  5084. <para>
  5085. When Date/Time based rolling is used setting <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  5086. to <see langword="true"/> will reduce the number of file renamings to few or none.
  5087. </para>
  5088. </note>
  5089. <note type="caution">
  5090. <para>
  5091. Changing <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> or <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> without clearing
  5092. the log file directory of backup files will cause unexpected and unwanted side effects.
  5093. </para>
  5094. </note>
  5095. <para>
  5096. If Date/Time based rolling is enabled this appender will attempt to roll existing files
  5097. in the directory without a Date/Time tag based on the last write date of the base log file.
  5098. The appender only rolls the log file when a message is logged. If Date/Time based rolling
  5099. is enabled then the appender will not roll the log file at the Date/Time boundary but
  5100. at the point when the next message is logged after the boundary has been crossed.
  5101. </para>
  5102. <para>
  5103. The <see cref="T:log4net.Appender.RollingFileAppender"/> extends the <see cref="T:log4net.Appender.FileAppender"/> and
  5104. has the same behavior when opening the log file.
  5105. The appender will first try to open the file for writing when <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>
  5106. is called. This will typically be during configuration.
  5107. If the file cannot be opened for writing the appender will attempt
  5108. to open the file again each time a message is logged to the appender.
  5109. If the file cannot be opened for writing when a message is logged then
  5110. the message will be discarded by this appender.
  5111. </para>
  5112. <para>
  5113. When rolling a backup file necessitates deleting an older backup file the
  5114. file to be deleted is moved to a temporary name before being deleted.
  5115. </para>
  5116. <note type="caution">
  5117. <para>
  5118. A maximum number of backup files when rolling on date/time boundaries is not supported.
  5119. </para>
  5120. </note>
  5121. </remarks>
  5122. <author>Nicko Cadell</author>
  5123. <author>Gert Driesen</author>
  5124. <author>Aspi Havewala</author>
  5125. <author>Douglas de la Torre</author>
  5126. <author>Edward Smit</author>
  5127. </member>
  5128. <member name="T:log4net.Appender.RollingFileAppender.RollingMode">
  5129. <summary>
  5130. Style of rolling to use
  5131. </summary>
  5132. <remarks>
  5133. <para>
  5134. Style of rolling to use
  5135. </para>
  5136. </remarks>
  5137. </member>
  5138. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Once">
  5139. <summary>
  5140. Roll files once per program execution
  5141. </summary>
  5142. <remarks>
  5143. <para>
  5144. Roll files once per program execution.
  5145. Well really once each time this appender is
  5146. configured.
  5147. </para>
  5148. <para>
  5149. Setting this option also sets <c>AppendToFile</c> to
  5150. <c>false</c> on the <c>RollingFileAppender</c>, otherwise
  5151. this appender would just be a normal file appender.
  5152. </para>
  5153. </remarks>
  5154. </member>
  5155. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Size">
  5156. <summary>
  5157. Roll files based only on the size of the file
  5158. </summary>
  5159. </member>
  5160. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Date">
  5161. <summary>
  5162. Roll files based only on the date
  5163. </summary>
  5164. </member>
  5165. <member name="F:log4net.Appender.RollingFileAppender.RollingMode.Composite">
  5166. <summary>
  5167. Roll files based on both the size and date of the file
  5168. </summary>
  5169. </member>
  5170. <member name="T:log4net.Appender.RollingFileAppender.RollPoint">
  5171. <summary>
  5172. The code assumes that the following 'time' constants are in a increasing sequence.
  5173. </summary>
  5174. <remarks>
  5175. <para>
  5176. The code assumes that the following 'time' constants are in a increasing sequence.
  5177. </para>
  5178. </remarks>
  5179. </member>
  5180. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.InvalidRollPoint">
  5181. <summary>
  5182. Roll the log not based on the date
  5183. </summary>
  5184. </member>
  5185. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMinute">
  5186. <summary>
  5187. Roll the log for each minute
  5188. </summary>
  5189. </member>
  5190. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfHour">
  5191. <summary>
  5192. Roll the log for each hour
  5193. </summary>
  5194. </member>
  5195. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.HalfDay">
  5196. <summary>
  5197. Roll the log twice a day (midday and midnight)
  5198. </summary>
  5199. </member>
  5200. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfDay">
  5201. <summary>
  5202. Roll the log each day (midnight)
  5203. </summary>
  5204. </member>
  5205. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfWeek">
  5206. <summary>
  5207. Roll the log each week
  5208. </summary>
  5209. </member>
  5210. <member name="F:log4net.Appender.RollingFileAppender.RollPoint.TopOfMonth">
  5211. <summary>
  5212. Roll the log each month
  5213. </summary>
  5214. </member>
  5215. <member name="M:log4net.Appender.RollingFileAppender.#ctor">
  5216. <summary>
  5217. Initializes a new instance of the <see cref="T:log4net.Appender.RollingFileAppender" /> class.
  5218. </summary>
  5219. <remarks>
  5220. <para>
  5221. Default constructor.
  5222. </para>
  5223. </remarks>
  5224. </member>
  5225. <member name="M:log4net.Appender.RollingFileAppender.Finalize">
  5226. <summary>
  5227. Cleans up all resources used by this appender.
  5228. </summary>
  5229. </member>
  5230. <member name="P:log4net.Appender.RollingFileAppender.DateTimeStrategy">
  5231. <summary>
  5232. Gets or sets the strategy for determining the current date and time. The default
  5233. implementation is to use LocalDateTime which internally calls through to DateTime.Now.
  5234. DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying
  5235. <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  5236. </summary>
  5237. <value>
  5238. An implementation of the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> interface which returns the current date and time.
  5239. </value>
  5240. <remarks>
  5241. <para>
  5242. Gets or sets the <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> used to return the current date and time.
  5243. </para>
  5244. <para>
  5245. There are two built strategies for determining the current date and time,
  5246. <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>
  5247. and <see cref="T:log4net.Appender.RollingFileAppender.UniversalDateTime"/>.
  5248. </para>
  5249. <para>
  5250. The default strategy is <see cref="T:log4net.Appender.RollingFileAppender.LocalDateTime"/>.
  5251. </para>
  5252. </remarks>
  5253. </member>
  5254. <member name="P:log4net.Appender.RollingFileAppender.DatePattern">
  5255. <summary>
  5256. Gets or sets the date pattern to be used for generating file names
  5257. when rolling over on date.
  5258. </summary>
  5259. <value>
  5260. The date pattern to be used for generating file names when rolling
  5261. over on date.
  5262. </value>
  5263. <remarks>
  5264. <para>
  5265. Takes a string in the same format as expected by
  5266. <see cref="T:log4net.DateFormatter.SimpleDateFormatter" />.
  5267. </para>
  5268. <para>
  5269. This property determines the rollover schedule when rolling over
  5270. on date.
  5271. </para>
  5272. </remarks>
  5273. </member>
  5274. <member name="P:log4net.Appender.RollingFileAppender.MaxSizeRollBackups">
  5275. <summary>
  5276. Gets or sets the maximum number of backup files that are kept before
  5277. the oldest is erased.
  5278. </summary>
  5279. <value>
  5280. The maximum number of backup files that are kept before the oldest is
  5281. erased.
  5282. </value>
  5283. <remarks>
  5284. <para>
  5285. If set to zero, then there will be no backup files and the log file
  5286. will be truncated when it reaches <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/>.
  5287. </para>
  5288. <para>
  5289. If a negative number is supplied then no deletions will be made. Note
  5290. that this could result in very slow performance as a large number of
  5291. files are rolled over unless <see cref="P:log4net.Appender.RollingFileAppender.CountDirection"/> is used.
  5292. </para>
  5293. <para>
  5294. The maximum applies to <b>each</b> time based group of files and
  5295. <b>not</b> the total.
  5296. </para>
  5297. </remarks>
  5298. </member>
  5299. <member name="P:log4net.Appender.RollingFileAppender.MaxFileSize">
  5300. <summary>
  5301. Gets or sets the maximum size that the output file is allowed to reach
  5302. before being rolled over to backup files.
  5303. </summary>
  5304. <value>
  5305. The maximum size in bytes that the output file is allowed to reach before being
  5306. rolled over to backup files.
  5307. </value>
  5308. <remarks>
  5309. <para>
  5310. This property is equivalent to <see cref="P:log4net.Appender.RollingFileAppender.MaximumFileSize"/> except
  5311. that it is required for differentiating the setter taking a
  5312. <see cref="T:System.Int64"/> argument from the setter taking a <see cref="T:System.String"/>
  5313. argument.
  5314. </para>
  5315. <para>
  5316. The default maximum file size is 10MB (10*1024*1024).
  5317. </para>
  5318. </remarks>
  5319. </member>
  5320. <member name="P:log4net.Appender.RollingFileAppender.MaximumFileSize">
  5321. <summary>
  5322. Gets or sets the maximum size that the output file is allowed to reach
  5323. before being rolled over to backup files.
  5324. </summary>
  5325. <value>
  5326. The maximum size that the output file is allowed to reach before being
  5327. rolled over to backup files.
  5328. </value>
  5329. <remarks>
  5330. <para>
  5331. This property allows you to specify the maximum size with the
  5332. suffixes "KB", "MB" or "GB" so that the size is interpreted being
  5333. expressed respectively in kilobytes, megabytes or gigabytes.
  5334. </para>
  5335. <para>
  5336. For example, the value "10KB" will be interpreted as 10240 bytes.
  5337. </para>
  5338. <para>
  5339. The default maximum file size is 10MB.
  5340. </para>
  5341. <para>
  5342. If you have the option to set the maximum file size programmatically
  5343. consider using the <see cref="P:log4net.Appender.RollingFileAppender.MaxFileSize"/> property instead as this
  5344. allows you to set the size in bytes as a <see cref="T:System.Int64"/>.
  5345. </para>
  5346. </remarks>
  5347. </member>
  5348. <member name="P:log4net.Appender.RollingFileAppender.CountDirection">
  5349. <summary>
  5350. Gets or sets the rolling file count direction.
  5351. </summary>
  5352. <value>
  5353. The rolling file count direction.
  5354. </value>
  5355. <remarks>
  5356. <para>
  5357. Indicates if the current file is the lowest numbered file or the
  5358. highest numbered file.
  5359. </para>
  5360. <para>
  5361. By default newer files have lower numbers (<see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &lt; 0),
  5362. i.e. log.1 is most recent, log.5 is the 5th backup, etc...
  5363. </para>
  5364. <para>
  5365. <see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &gt;= 0 does the opposite i.e.
  5366. log.1 is the first backup made, log.5 is the 5th backup made, etc.
  5367. For infinite backups use <see cref="P:log4net.Appender.RollingFileAppender.CountDirection" /> &gt;= 0 to reduce
  5368. rollover costs.
  5369. </para>
  5370. <para>The default file count direction is -1.</para>
  5371. </remarks>
  5372. </member>
  5373. <member name="P:log4net.Appender.RollingFileAppender.RollingStyle">
  5374. <summary>
  5375. Gets or sets the rolling style.
  5376. </summary>
  5377. <value>The rolling style.</value>
  5378. <remarks>
  5379. <para>
  5380. The default rolling style is <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Composite" />.
  5381. </para>
  5382. <para>
  5383. When set to <see cref="F:log4net.Appender.RollingFileAppender.RollingMode.Once"/> this appender's
  5384. <see cref="P:log4net.Appender.FileAppender.AppendToFile"/> property is set to <c>false</c>, otherwise
  5385. the appender would append to a single file rather than rolling
  5386. the file each time it is opened.
  5387. </para>
  5388. </remarks>
  5389. </member>
  5390. <member name="P:log4net.Appender.RollingFileAppender.PreserveLogFileNameExtension">
  5391. <summary>
  5392. Gets or sets a value indicating whether to preserve the file name extension when rolling.
  5393. </summary>
  5394. <value>
  5395. <c>true</c> if the file name extension should be preserved.
  5396. </value>
  5397. <remarks>
  5398. <para>
  5399. By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup.
  5400. However, under Windows the new file name will loose any program associations as the
  5401. extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or
  5402. file.curSizeRollBackup.log to maintain any program associations.
  5403. </para>
  5404. </remarks>
  5405. </member>
  5406. <member name="P:log4net.Appender.RollingFileAppender.StaticLogFileName">
  5407. <summary>
  5408. Gets or sets a value indicating whether to always log to
  5409. the same file.
  5410. </summary>
  5411. <value>
  5412. <c>true</c> if always should be logged to the same file, otherwise <c>false</c>.
  5413. </value>
  5414. <remarks>
  5415. <para>
  5416. By default file.log is always the current file. Optionally
  5417. file.log.yyyy-mm-dd for current formatted datePattern can by the currently
  5418. logging file (or file.log.curSizeRollBackup or even
  5419. file.log.yyyy-mm-dd.curSizeRollBackup).
  5420. </para>
  5421. <para>
  5422. This will make time based rollovers with a large number of backups
  5423. much faster as the appender it won't have to rename all the backups!
  5424. </para>
  5425. </remarks>
  5426. </member>
  5427. <member name="F:log4net.Appender.RollingFileAppender.declaringType">
  5428. <summary>
  5429. The fully qualified type of the RollingFileAppender class.
  5430. </summary>
  5431. <remarks>
  5432. Used by the internal logger to record the Type of the
  5433. log message.
  5434. </remarks>
  5435. </member>
  5436. <member name="M:log4net.Appender.RollingFileAppender.SetQWForFiles(System.IO.TextWriter)">
  5437. <summary>
  5438. Sets the quiet writer being used.
  5439. </summary>
  5440. <remarks>
  5441. This method can be overridden by sub classes.
  5442. </remarks>
  5443. <param name="writer">the writer to set</param>
  5444. </member>
  5445. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent)">
  5446. <summary>
  5447. Write out a logging event.
  5448. </summary>
  5449. <param name="loggingEvent">the event to write to file.</param>
  5450. <remarks>
  5451. <para>
  5452. Handles append time behavior for RollingFileAppender. This checks
  5453. if a roll over either by date (checked first) or time (checked second)
  5454. is need and then appends to the file last.
  5455. </para>
  5456. </remarks>
  5457. </member>
  5458. <member name="M:log4net.Appender.RollingFileAppender.Append(log4net.Core.LoggingEvent[])">
  5459. <summary>
  5460. Write out an array of logging events.
  5461. </summary>
  5462. <param name="loggingEvents">the events to write to file.</param>
  5463. <remarks>
  5464. <para>
  5465. Handles append time behavior for RollingFileAppender. This checks
  5466. if a roll over either by date (checked first) or time (checked second)
  5467. is need and then appends to the file last.
  5468. </para>
  5469. </remarks>
  5470. </member>
  5471. <member name="M:log4net.Appender.RollingFileAppender.AdjustFileBeforeAppend">
  5472. <summary>
  5473. Performs any required rolling before outputting the next event
  5474. </summary>
  5475. <remarks>
  5476. <para>
  5477. Handles append time behavior for RollingFileAppender. This checks
  5478. if a roll over either by date (checked first) or time (checked second)
  5479. is need and then appends to the file last.
  5480. </para>
  5481. </remarks>
  5482. </member>
  5483. <member name="M:log4net.Appender.RollingFileAppender.OpenFile(System.String,System.Boolean)">
  5484. <summary>
  5485. Creates and opens the file for logging. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/>
  5486. is false then the fully qualified name is determined and used.
  5487. </summary>
  5488. <param name="fileName">the name of the file to open</param>
  5489. <param name="append">true to append to existing file</param>
  5490. <remarks>
  5491. <para>This method will ensure that the directory structure
  5492. for the <paramref name="fileName"/> specified exists.</para>
  5493. </remarks>
  5494. </member>
  5495. <member name="M:log4net.Appender.RollingFileAppender.GetNextOutputFileName(System.String)">
  5496. <summary>
  5497. Get the current output file name
  5498. </summary>
  5499. <param name="fileName">the base file name</param>
  5500. <returns>the output file name</returns>
  5501. <remarks>
  5502. The output file name is based on the base fileName specified.
  5503. If <see cref="P:log4net.Appender.RollingFileAppender.StaticLogFileName"/> is set then the output
  5504. file name is the same as the base file passed in. Otherwise
  5505. the output file depends on the date pattern, on the count
  5506. direction or both.
  5507. </remarks>
  5508. </member>
  5509. <member name="M:log4net.Appender.RollingFileAppender.DetermineCurSizeRollBackups">
  5510. <summary>
  5511. Determines curSizeRollBackups (only within the current roll point)
  5512. </summary>
  5513. </member>
  5514. <member name="M:log4net.Appender.RollingFileAppender.GetWildcardPatternForFile(System.String)">
  5515. <summary>
  5516. Generates a wildcard pattern that can be used to find all files
  5517. that are similar to the base file name.
  5518. </summary>
  5519. <param name="baseFileName"></param>
  5520. <returns></returns>
  5521. </member>
  5522. <member name="M:log4net.Appender.RollingFileAppender.GetExistingFiles(System.String)">
  5523. <summary>
  5524. Builds a list of filenames for all files matching the base filename plus a file
  5525. pattern.
  5526. </summary>
  5527. <param name="baseFilePath"></param>
  5528. <returns></returns>
  5529. </member>
  5530. <member name="M:log4net.Appender.RollingFileAppender.RollOverIfDateBoundaryCrossing">
  5531. <summary>
  5532. Initiates a roll over if needed for crossing a date boundary since the last run.
  5533. </summary>
  5534. </member>
  5535. <member name="M:log4net.Appender.RollingFileAppender.ExistingInit">
  5536. <summary>
  5537. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  5538. </summary>
  5539. <remarks>
  5540. <para>
  5541. Initializes based on existing conditions at time of <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/>.
  5542. The following is done
  5543. <list type="bullet">
  5544. <item>determine curSizeRollBackups (only within the current roll point)</item>
  5545. <item>initiates a roll over if needed for crossing a date boundary since the last run.</item>
  5546. </list>
  5547. </para>
  5548. </remarks>
  5549. </member>
  5550. <member name="M:log4net.Appender.RollingFileAppender.InitializeFromOneFile(System.String,System.String)">
  5551. <summary>
  5552. Does the work of bumping the 'current' file counter higher
  5553. to the highest count when an incremental file name is seen.
  5554. The highest count is either the first file (when count direction
  5555. is greater than 0) or the last file (when count direction less than 0).
  5556. In either case, we want to know the highest count that is present.
  5557. </summary>
  5558. <param name="baseFile"></param>
  5559. <param name="curFileName"></param>
  5560. </member>
  5561. <member name="M:log4net.Appender.RollingFileAppender.GetBackUpIndex(System.String)">
  5562. <summary>
  5563. Attempts to extract a number from the end of the file name that indicates
  5564. the number of the times the file has been rolled over.
  5565. </summary>
  5566. <remarks>
  5567. Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes.
  5568. </remarks>
  5569. <param name="curFileName"></param>
  5570. <returns></returns>
  5571. </member>
  5572. <member name="M:log4net.Appender.RollingFileAppender.InitializeRollBackups(System.String,System.Collections.ArrayList)">
  5573. <summary>
  5574. Takes a list of files and a base file name, and looks for
  5575. 'incremented' versions of the base file. Bumps the max
  5576. count up to the highest count seen.
  5577. </summary>
  5578. <param name="baseFile"></param>
  5579. <param name="arrayFiles"></param>
  5580. </member>
  5581. <member name="M:log4net.Appender.RollingFileAppender.ComputeCheckPeriod(System.String)">
  5582. <summary>
  5583. Calculates the RollPoint for the datePattern supplied.
  5584. </summary>
  5585. <param name="datePattern">the date pattern to calculate the check period for</param>
  5586. <returns>The RollPoint that is most accurate for the date pattern supplied</returns>
  5587. <remarks>
  5588. Essentially the date pattern is examined to determine what the
  5589. most suitable roll point is. The roll point chosen is the roll point
  5590. with the smallest period that can be detected using the date pattern
  5591. supplied. i.e. if the date pattern only outputs the year, month, day
  5592. and hour then the smallest roll point that can be detected would be
  5593. and hourly roll point as minutes could not be detected.
  5594. </remarks>
  5595. </member>
  5596. <member name="M:log4net.Appender.RollingFileAppender.ActivateOptions">
  5597. <summary>
  5598. Initialize the appender based on the options set
  5599. </summary>
  5600. <remarks>
  5601. <para>
  5602. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  5603. activation scheme. The <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> method must
  5604. be called on this object after the configuration properties have
  5605. been set. Until <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> is called this
  5606. object is in an undefined state and must not be used.
  5607. </para>
  5608. <para>
  5609. If any of the configuration properties are modified then
  5610. <see cref="M:log4net.Appender.RollingFileAppender.ActivateOptions"/> must be called again.
  5611. </para>
  5612. <para>
  5613. Sets initial conditions including date/time roll over information, first check,
  5614. scheduledFilename, and calls <see cref="M:log4net.Appender.RollingFileAppender.ExistingInit"/> to initialize
  5615. the current number of backups.
  5616. </para>
  5617. </remarks>
  5618. </member>
  5619. <member name="M:log4net.Appender.RollingFileAppender.CombinePath(System.String,System.String)">
  5620. <summary>
  5621. </summary>
  5622. <param name="path1"></param>
  5623. <param name="path2">.1, .2, .3, etc.</param>
  5624. <returns></returns>
  5625. </member>
  5626. <member name="M:log4net.Appender.RollingFileAppender.RollOverTime(System.Boolean)">
  5627. <summary>
  5628. Rollover the file(s) to date/time tagged file(s).
  5629. </summary>
  5630. <param name="fileIsOpen">set to true if the file to be rolled is currently open</param>
  5631. <remarks>
  5632. <para>
  5633. Rollover the file(s) to date/time tagged file(s).
  5634. Resets curSizeRollBackups.
  5635. If fileIsOpen is set then the new file is opened (through SafeOpenFile).
  5636. </para>
  5637. </remarks>
  5638. </member>
  5639. <member name="M:log4net.Appender.RollingFileAppender.RollFile(System.String,System.String)">
  5640. <summary>
  5641. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>.
  5642. </summary>
  5643. <param name="fromFile">Name of existing file to roll.</param>
  5644. <param name="toFile">New name for file.</param>
  5645. <remarks>
  5646. <para>
  5647. Renames file <paramref name="fromFile"/> to file <paramref name="toFile"/>. It
  5648. also checks for existence of target file and deletes if it does.
  5649. </para>
  5650. </remarks>
  5651. </member>
  5652. <member name="M:log4net.Appender.RollingFileAppender.FileExists(System.String)">
  5653. <summary>
  5654. Test if a file exists at a specified path
  5655. </summary>
  5656. <param name="path">the path to the file</param>
  5657. <returns>true if the file exists</returns>
  5658. <remarks>
  5659. <para>
  5660. Test if a file exists at a specified path
  5661. </para>
  5662. </remarks>
  5663. </member>
  5664. <member name="M:log4net.Appender.RollingFileAppender.DeleteFile(System.String)">
  5665. <summary>
  5666. Deletes the specified file if it exists.
  5667. </summary>
  5668. <param name="fileName">The file to delete.</param>
  5669. <remarks>
  5670. <para>
  5671. Delete a file if is exists.
  5672. The file is first moved to a new filename then deleted.
  5673. This allows the file to be removed even when it cannot
  5674. be deleted, but it still can be moved.
  5675. </para>
  5676. </remarks>
  5677. </member>
  5678. <member name="M:log4net.Appender.RollingFileAppender.RollOverSize">
  5679. <summary>
  5680. Implements file roll base on file size.
  5681. </summary>
  5682. <remarks>
  5683. <para>
  5684. If the maximum number of size based backups is reached
  5685. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  5686. file is deleted -- its index determined by the sign of countDirection.
  5687. If <c>countDirection</c> &lt; 0, then files
  5688. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  5689. are renamed to {<c>File.2</c>, ...,
  5690. <c>File.curSizeRollBackups</c>}. Moreover, <c>File</c> is
  5691. renamed <c>File.1</c> and closed.
  5692. </para>
  5693. <para>
  5694. A new file is created to receive further log output.
  5695. </para>
  5696. <para>
  5697. If <c>maxSizeRollBackups</c> is equal to zero, then the
  5698. <c>File</c> is truncated with no backup files created.
  5699. </para>
  5700. <para>
  5701. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  5702. renamed if needed and no files are deleted.
  5703. </para>
  5704. </remarks>
  5705. </member>
  5706. <member name="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)">
  5707. <summary>
  5708. Implements file roll.
  5709. </summary>
  5710. <param name="baseFileName">the base name to rename</param>
  5711. <remarks>
  5712. <para>
  5713. If the maximum number of size based backups is reached
  5714. (<c>curSizeRollBackups == maxSizeRollBackups</c>) then the oldest
  5715. file is deleted -- its index determined by the sign of countDirection.
  5716. If <c>countDirection</c> &lt; 0, then files
  5717. {<c>File.1</c>, ..., <c>File.curSizeRollBackups -1</c>}
  5718. are renamed to {<c>File.2</c>, ...,
  5719. <c>File.curSizeRollBackups</c>}.
  5720. </para>
  5721. <para>
  5722. If <c>maxSizeRollBackups</c> is equal to zero, then the
  5723. <c>File</c> is truncated with no backup files created.
  5724. </para>
  5725. <para>
  5726. If <c>maxSizeRollBackups</c> &lt; 0, then <c>File</c> is
  5727. renamed if needed and no files are deleted.
  5728. </para>
  5729. <para>
  5730. This is called by <see cref="M:log4net.Appender.RollingFileAppender.RollOverSize"/> to rename the files.
  5731. </para>
  5732. </remarks>
  5733. </member>
  5734. <member name="M:log4net.Appender.RollingFileAppender.NextCheckDate(System.DateTime,log4net.Appender.RollingFileAppender.RollPoint)">
  5735. <summary>
  5736. Get the start time of the next window for the current rollpoint
  5737. </summary>
  5738. <param name="currentDateTime">the current date</param>
  5739. <param name="rollPoint">the type of roll point we are working with</param>
  5740. <returns>the start time for the next roll point an interval after the currentDateTime date</returns>
  5741. <remarks>
  5742. <para>
  5743. Returns the date of the next roll point after the currentDateTime date passed to the method.
  5744. </para>
  5745. <para>
  5746. The basic strategy is to subtract the time parts that are less significant
  5747. than the rollpoint from the current time. This should roll the time back to
  5748. the start of the time window for the current rollpoint. Then we add 1 window
  5749. worth of time and get the start time of the next window for the rollpoint.
  5750. </para>
  5751. </remarks>
  5752. </member>
  5753. <member name="F:log4net.Appender.RollingFileAppender.m_dateTime">
  5754. <summary>
  5755. This object supplies the current date/time. Allows test code to plug in
  5756. a method to control this class when testing date/time based rolling. The default
  5757. implementation uses the underlying value of DateTime.Now.
  5758. </summary>
  5759. </member>
  5760. <member name="F:log4net.Appender.RollingFileAppender.m_datePattern">
  5761. <summary>
  5762. The date pattern. By default, the pattern is set to <c>".yyyy-MM-dd"</c>
  5763. meaning daily rollover.
  5764. </summary>
  5765. </member>
  5766. <member name="F:log4net.Appender.RollingFileAppender.m_scheduledFilename">
  5767. <summary>
  5768. The actual formatted filename that is currently being written to
  5769. or will be the file transferred to on roll over
  5770. (based on staticLogFileName).
  5771. </summary>
  5772. </member>
  5773. <member name="F:log4net.Appender.RollingFileAppender.m_nextCheck">
  5774. <summary>
  5775. The timestamp when we shall next recompute the filename.
  5776. </summary>
  5777. </member>
  5778. <member name="F:log4net.Appender.RollingFileAppender.m_now">
  5779. <summary>
  5780. Holds date of last roll over
  5781. </summary>
  5782. </member>
  5783. <member name="F:log4net.Appender.RollingFileAppender.m_rollPoint">
  5784. <summary>
  5785. The type of rolling done
  5786. </summary>
  5787. </member>
  5788. <member name="F:log4net.Appender.RollingFileAppender.m_maxFileSize">
  5789. <summary>
  5790. The default maximum file size is 10MB
  5791. </summary>
  5792. </member>
  5793. <member name="F:log4net.Appender.RollingFileAppender.m_maxSizeRollBackups">
  5794. <summary>
  5795. There is zero backup files by default
  5796. </summary>
  5797. </member>
  5798. <member name="F:log4net.Appender.RollingFileAppender.m_curSizeRollBackups">
  5799. <summary>
  5800. How many sized based backups have been made so far
  5801. </summary>
  5802. </member>
  5803. <member name="F:log4net.Appender.RollingFileAppender.m_countDirection">
  5804. <summary>
  5805. The rolling file count direction.
  5806. </summary>
  5807. </member>
  5808. <member name="F:log4net.Appender.RollingFileAppender.m_rollingStyle">
  5809. <summary>
  5810. The rolling mode used in this appender.
  5811. </summary>
  5812. </member>
  5813. <member name="F:log4net.Appender.RollingFileAppender.m_rollDate">
  5814. <summary>
  5815. Cache flag set if we are rolling by date.
  5816. </summary>
  5817. </member>
  5818. <member name="F:log4net.Appender.RollingFileAppender.m_rollSize">
  5819. <summary>
  5820. Cache flag set if we are rolling by size.
  5821. </summary>
  5822. </member>
  5823. <member name="F:log4net.Appender.RollingFileAppender.m_staticLogFileName">
  5824. <summary>
  5825. Value indicating whether to always log to the same file.
  5826. </summary>
  5827. </member>
  5828. <member name="F:log4net.Appender.RollingFileAppender.m_preserveLogFileNameExtension">
  5829. <summary>
  5830. Value indicating whether to preserve the file name extension when rolling.
  5831. </summary>
  5832. </member>
  5833. <member name="F:log4net.Appender.RollingFileAppender.m_baseFileName">
  5834. <summary>
  5835. FileName provided in configuration. Used for rolling properly
  5836. </summary>
  5837. </member>
  5838. <member name="F:log4net.Appender.RollingFileAppender.m_mutexForRolling">
  5839. <summary>
  5840. A mutex that is used to lock rolling of files.
  5841. </summary>
  5842. </member>
  5843. <member name="F:log4net.Appender.RollingFileAppender.s_date1970">
  5844. <summary>
  5845. The 1st of January 1970 in UTC
  5846. </summary>
  5847. </member>
  5848. <member name="T:log4net.Appender.RollingFileAppender.IDateTime">
  5849. <summary>
  5850. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  5851. </summary>
  5852. <remarks>
  5853. This interface is used to supply Date/Time information to the <see cref="T:log4net.Appender.RollingFileAppender"/>.
  5854. Used primarily to allow test classes to plug themselves in so they can
  5855. supply test date/times.
  5856. </remarks>
  5857. </member>
  5858. <member name="P:log4net.Appender.RollingFileAppender.IDateTime.Now">
  5859. <summary>
  5860. Gets the <i>current</i> time.
  5861. </summary>
  5862. <value>The <i>current</i> time.</value>
  5863. <remarks>
  5864. <para>
  5865. Gets the <i>current</i> time.
  5866. </para>
  5867. </remarks>
  5868. </member>
  5869. <member name="T:log4net.Appender.RollingFileAppender.LocalDateTime">
  5870. <summary>
  5871. Default implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time.
  5872. </summary>
  5873. </member>
  5874. <member name="P:log4net.Appender.RollingFileAppender.LocalDateTime.Now">
  5875. <summary>
  5876. Gets the <b>current</b> time.
  5877. </summary>
  5878. <value>The <b>current</b> time.</value>
  5879. <remarks>
  5880. <para>
  5881. Gets the <b>current</b> time.
  5882. </para>
  5883. </remarks>
  5884. </member>
  5885. <member name="T:log4net.Appender.RollingFileAppender.UniversalDateTime">
  5886. <summary>
  5887. Implementation of <see cref="T:log4net.Appender.RollingFileAppender.IDateTime"/> that returns the current time as the coordinated universal time (UTC).
  5888. </summary>
  5889. </member>
  5890. <member name="P:log4net.Appender.RollingFileAppender.UniversalDateTime.Now">
  5891. <summary>
  5892. Gets the <b>current</b> time.
  5893. </summary>
  5894. <value>The <b>current</b> time.</value>
  5895. <remarks>
  5896. <para>
  5897. Gets the <b>current</b> time.
  5898. </para>
  5899. </remarks>
  5900. </member>
  5901. <member name="T:log4net.Appender.SmtpPickupDirAppender">
  5902. <summary>
  5903. Send an email when a specific logging event occurs, typically on errors
  5904. or fatal errors. Rather than sending via smtp it writes a file into the
  5905. directory specified by <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>. This allows services such
  5906. as the IIS SMTP agent to manage sending the messages.
  5907. </summary>
  5908. <remarks>
  5909. <para>
  5910. The configuration for this appender is identical to that of the <c>SMTPAppender</c>,
  5911. except that instead of specifying the <c>SMTPAppender.SMTPHost</c> you specify
  5912. <see cref="P:log4net.Appender.SmtpPickupDirAppender.PickupDir"/>.
  5913. </para>
  5914. <para>
  5915. The number of logging events delivered in this e-mail depend on
  5916. the value of <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> option. The
  5917. <see cref="T:log4net.Appender.SmtpPickupDirAppender"/> keeps only the last
  5918. <see cref="P:log4net.Appender.BufferingAppenderSkeleton.BufferSize"/> logging events in its
  5919. cyclic buffer. This keeps memory requirements at a reasonable level while
  5920. still delivering useful application context.
  5921. </para>
  5922. </remarks>
  5923. <author>Niall Daley</author>
  5924. <author>Nicko Cadell</author>
  5925. </member>
  5926. <member name="M:log4net.Appender.SmtpPickupDirAppender.#ctor">
  5927. <summary>
  5928. Default constructor
  5929. </summary>
  5930. <remarks>
  5931. <para>
  5932. Default constructor
  5933. </para>
  5934. </remarks>
  5935. </member>
  5936. <member name="P:log4net.Appender.SmtpPickupDirAppender.To">
  5937. <summary>
  5938. Gets or sets a semicolon-delimited list of recipient e-mail addresses.
  5939. </summary>
  5940. <value>
  5941. A semicolon-delimited list of e-mail addresses.
  5942. </value>
  5943. <remarks>
  5944. <para>
  5945. A semicolon-delimited list of e-mail addresses.
  5946. </para>
  5947. </remarks>
  5948. </member>
  5949. <member name="P:log4net.Appender.SmtpPickupDirAppender.From">
  5950. <summary>
  5951. Gets or sets the e-mail address of the sender.
  5952. </summary>
  5953. <value>
  5954. The e-mail address of the sender.
  5955. </value>
  5956. <remarks>
  5957. <para>
  5958. The e-mail address of the sender.
  5959. </para>
  5960. </remarks>
  5961. </member>
  5962. <member name="P:log4net.Appender.SmtpPickupDirAppender.Subject">
  5963. <summary>
  5964. Gets or sets the subject line of the e-mail message.
  5965. </summary>
  5966. <value>
  5967. The subject line of the e-mail message.
  5968. </value>
  5969. <remarks>
  5970. <para>
  5971. The subject line of the e-mail message.
  5972. </para>
  5973. </remarks>
  5974. </member>
  5975. <member name="P:log4net.Appender.SmtpPickupDirAppender.PickupDir">
  5976. <summary>
  5977. Gets or sets the path to write the messages to.
  5978. </summary>
  5979. <remarks>
  5980. <para>
  5981. Gets or sets the path to write the messages to. This should be the same
  5982. as that used by the agent sending the messages.
  5983. </para>
  5984. </remarks>
  5985. </member>
  5986. <member name="P:log4net.Appender.SmtpPickupDirAppender.FileExtension">
  5987. <summary>
  5988. Gets or sets the file extension for the generated files
  5989. </summary>
  5990. <value>
  5991. The file extension for the generated files
  5992. </value>
  5993. <remarks>
  5994. <para>
  5995. The file extension for the generated files
  5996. </para>
  5997. </remarks>
  5998. </member>
  5999. <member name="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext">
  6000. <summary>
  6001. Gets or sets the <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  6002. </summary>
  6003. <value>
  6004. The <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> used to write to the pickup directory.
  6005. </value>
  6006. <remarks>
  6007. <para>
  6008. Unless a <see cref="P:log4net.Appender.SmtpPickupDirAppender.SecurityContext"/> specified here for this appender
  6009. the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is queried for the
  6010. security context to use. The default behavior is to use the security context
  6011. of the current thread.
  6012. </para>
  6013. </remarks>
  6014. </member>
  6015. <member name="M:log4net.Appender.SmtpPickupDirAppender.SendBuffer(log4net.Core.LoggingEvent[])">
  6016. <summary>
  6017. Sends the contents of the cyclic buffer as an e-mail message.
  6018. </summary>
  6019. <param name="events">The logging events to send.</param>
  6020. <remarks>
  6021. <para>
  6022. Sends the contents of the cyclic buffer as an e-mail message.
  6023. </para>
  6024. </remarks>
  6025. </member>
  6026. <member name="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions">
  6027. <summary>
  6028. Activate the options on this appender.
  6029. </summary>
  6030. <remarks>
  6031. <para>
  6032. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6033. activation scheme. The <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> method must
  6034. be called on this object after the configuration properties have
  6035. been set. Until <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> is called this
  6036. object is in an undefined state and must not be used.
  6037. </para>
  6038. <para>
  6039. If any of the configuration properties are modified then
  6040. <see cref="M:log4net.Appender.SmtpPickupDirAppender.ActivateOptions"/> must be called again.
  6041. </para>
  6042. </remarks>
  6043. </member>
  6044. <member name="P:log4net.Appender.SmtpPickupDirAppender.RequiresLayout">
  6045. <summary>
  6046. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6047. </summary>
  6048. <value><c>true</c></value>
  6049. <remarks>
  6050. <para>
  6051. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6052. </para>
  6053. </remarks>
  6054. </member>
  6055. <member name="M:log4net.Appender.SmtpPickupDirAppender.ConvertToFullPath(System.String)">
  6056. <summary>
  6057. Convert a path into a fully qualified path.
  6058. </summary>
  6059. <param name="path">The path to convert.</param>
  6060. <returns>The fully qualified path.</returns>
  6061. <remarks>
  6062. <para>
  6063. Converts the path specified to a fully
  6064. qualified path. If the path is relative it is
  6065. taken as relative from the application base
  6066. directory.
  6067. </para>
  6068. </remarks>
  6069. </member>
  6070. <member name="F:log4net.Appender.SmtpPickupDirAppender.m_securityContext">
  6071. <summary>
  6072. The security context to use for privileged calls
  6073. </summary>
  6074. </member>
  6075. <member name="T:log4net.Appender.TelnetAppender">
  6076. <summary>
  6077. Appender that allows clients to connect via Telnet to receive log messages
  6078. </summary>
  6079. <remarks>
  6080. <para>
  6081. The TelnetAppender accepts socket connections and streams logging messages
  6082. back to the client.
  6083. The output is provided in a telnet-friendly way so that a log can be monitored
  6084. over a TCP/IP socket.
  6085. This allows simple remote monitoring of application logging.
  6086. </para>
  6087. <para>
  6088. The default <see cref="P:log4net.Appender.TelnetAppender.Port"/> is 23 (the telnet port).
  6089. </para>
  6090. </remarks>
  6091. <author>Keith Long</author>
  6092. <author>Nicko Cadell</author>
  6093. </member>
  6094. <member name="M:log4net.Appender.TelnetAppender.#ctor">
  6095. <summary>
  6096. Default constructor
  6097. </summary>
  6098. <remarks>
  6099. <para>
  6100. Default constructor
  6101. </para>
  6102. </remarks>
  6103. </member>
  6104. <member name="F:log4net.Appender.TelnetAppender.declaringType">
  6105. <summary>
  6106. The fully qualified type of the TelnetAppender class.
  6107. </summary>
  6108. <remarks>
  6109. Used by the internal logger to record the Type of the
  6110. log message.
  6111. </remarks>
  6112. </member>
  6113. <member name="P:log4net.Appender.TelnetAppender.Port">
  6114. <summary>
  6115. Gets or sets the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  6116. </summary>
  6117. <value>
  6118. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  6119. indicating the TCP port number on which this <see cref="T:log4net.Appender.TelnetAppender"/> will listen for connections.
  6120. </value>
  6121. <remarks>
  6122. <para>
  6123. The default value is 23 (the telnet port).
  6124. </para>
  6125. </remarks>
  6126. <exception cref="T:System.ArgumentOutOfRangeException">The value specified is less than <see cref="F:System.Net.IPEndPoint.MinPort" />
  6127. or greater than <see cref="F:System.Net.IPEndPoint.MaxPort" />.</exception>
  6128. </member>
  6129. <member name="M:log4net.Appender.TelnetAppender.OnClose">
  6130. <summary>
  6131. Overrides the parent method to close the socket handler
  6132. </summary>
  6133. <remarks>
  6134. <para>
  6135. Closes all the outstanding connections.
  6136. </para>
  6137. </remarks>
  6138. </member>
  6139. <member name="P:log4net.Appender.TelnetAppender.RequiresLayout">
  6140. <summary>
  6141. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6142. </summary>
  6143. <value><c>true</c></value>
  6144. <remarks>
  6145. <para>
  6146. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6147. </para>
  6148. </remarks>
  6149. </member>
  6150. <member name="M:log4net.Appender.TelnetAppender.ActivateOptions">
  6151. <summary>
  6152. Initialize the appender based on the options set.
  6153. </summary>
  6154. <remarks>
  6155. <para>
  6156. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6157. activation scheme. The <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> method must
  6158. be called on this object after the configuration properties have
  6159. been set. Until <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> is called this
  6160. object is in an undefined state and must not be used.
  6161. </para>
  6162. <para>
  6163. If any of the configuration properties are modified then
  6164. <see cref="M:log4net.Appender.TelnetAppender.ActivateOptions"/> must be called again.
  6165. </para>
  6166. <para>
  6167. Create the socket handler and wait for connections
  6168. </para>
  6169. </remarks>
  6170. </member>
  6171. <member name="M:log4net.Appender.TelnetAppender.Append(log4net.Core.LoggingEvent)">
  6172. <summary>
  6173. Writes the logging event to each connected client.
  6174. </summary>
  6175. <param name="loggingEvent">The event to log.</param>
  6176. <remarks>
  6177. <para>
  6178. Writes the logging event to each connected client.
  6179. </para>
  6180. </remarks>
  6181. </member>
  6182. <member name="T:log4net.Appender.TelnetAppender.SocketHandler">
  6183. <summary>
  6184. Helper class to manage connected clients
  6185. </summary>
  6186. <remarks>
  6187. <para>
  6188. The SocketHandler class is used to accept connections from
  6189. clients. It is threaded so that clients can connect/disconnect
  6190. asynchronously.
  6191. </para>
  6192. </remarks>
  6193. </member>
  6194. <member name="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient">
  6195. <summary>
  6196. Class that represents a client connected to this handler
  6197. </summary>
  6198. <remarks>
  6199. <para>
  6200. Class that represents a client connected to this handler
  6201. </para>
  6202. </remarks>
  6203. </member>
  6204. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.#ctor(System.Net.Sockets.Socket)">
  6205. <summary>
  6206. Create this <see cref="T:log4net.Appender.TelnetAppender.SocketHandler.SocketClient"/> for the specified <see cref="T:System.Net.Sockets.Socket"/>
  6207. </summary>
  6208. <param name="socket">the client's socket</param>
  6209. <remarks>
  6210. <para>
  6211. Opens a stream writer on the socket.
  6212. </para>
  6213. </remarks>
  6214. </member>
  6215. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Send(System.String)">
  6216. <summary>
  6217. Write a string to the client
  6218. </summary>
  6219. <param name="message">string to send</param>
  6220. <remarks>
  6221. <para>
  6222. Write a string to the client
  6223. </para>
  6224. </remarks>
  6225. </member>
  6226. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.SocketClient.Dispose">
  6227. <summary>
  6228. Cleanup the clients connection
  6229. </summary>
  6230. <remarks>
  6231. <para>
  6232. Close the socket connection.
  6233. </para>
  6234. </remarks>
  6235. </member>
  6236. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.#ctor(System.Int32)">
  6237. <summary>
  6238. Opens a new server port on <paramref ref="port"/>
  6239. </summary>
  6240. <param name="port">the local port to listen on for connections</param>
  6241. <remarks>
  6242. <para>
  6243. Creates a socket handler on the specified local server port.
  6244. </para>
  6245. </remarks>
  6246. </member>
  6247. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Send(System.String)">
  6248. <summary>
  6249. Sends a string message to each of the connected clients
  6250. </summary>
  6251. <param name="message">the text to send</param>
  6252. <remarks>
  6253. <para>
  6254. Sends a string message to each of the connected clients
  6255. </para>
  6256. </remarks>
  6257. </member>
  6258. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.AddClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  6259. <summary>
  6260. Add a client to the internal clients list
  6261. </summary>
  6262. <param name="client">client to add</param>
  6263. </member>
  6264. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.RemoveClient(log4net.Appender.TelnetAppender.SocketHandler.SocketClient)">
  6265. <summary>
  6266. Remove a client from the internal clients list
  6267. </summary>
  6268. <param name="client">client to remove</param>
  6269. </member>
  6270. <member name="P:log4net.Appender.TelnetAppender.SocketHandler.HasConnections">
  6271. <summary>
  6272. Test if this handler has active connections
  6273. </summary>
  6274. <value>
  6275. <c>true</c> if this handler has active connections
  6276. </value>
  6277. <remarks>
  6278. <para>
  6279. This property will be <c>true</c> while this handler has
  6280. active connections, that is at least one connection that
  6281. the handler will attempt to send a message to.
  6282. </para>
  6283. </remarks>
  6284. </member>
  6285. <member name="M:log4net.Appender.TelnetAppender.SocketHandler.Dispose">
  6286. <summary>
  6287. Close all network connections
  6288. </summary>
  6289. <remarks>
  6290. <para>
  6291. Make sure we close all network connections
  6292. </para>
  6293. </remarks>
  6294. </member>
  6295. <member name="T:log4net.Appender.TextWriterAppender">
  6296. <summary>
  6297. Sends logging events to a <see cref="T:System.IO.TextWriter"/>.
  6298. </summary>
  6299. <remarks>
  6300. <para>
  6301. An Appender that writes to a <see cref="T:System.IO.TextWriter"/>.
  6302. </para>
  6303. <para>
  6304. This appender may be used stand alone if initialized with an appropriate
  6305. writer, however it is typically used as a base class for an appender that
  6306. can open a <see cref="T:System.IO.TextWriter"/> to write to.
  6307. </para>
  6308. </remarks>
  6309. <author>Nicko Cadell</author>
  6310. <author>Gert Driesen</author>
  6311. <author>Douglas de la Torre</author>
  6312. </member>
  6313. <member name="M:log4net.Appender.TextWriterAppender.#ctor">
  6314. <summary>
  6315. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class.
  6316. </summary>
  6317. <remarks>
  6318. <para>
  6319. Default constructor.
  6320. </para>
  6321. </remarks>
  6322. </member>
  6323. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.Stream)">
  6324. <summary>
  6325. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class and
  6326. sets the output destination to a new <see cref="T:System.IO.StreamWriter"/> initialized
  6327. with the specified <see cref="T:System.IO.Stream"/>.
  6328. </summary>
  6329. <param name="layout">The layout to use with this appender.</param>
  6330. <param name="os">The <see cref="T:System.IO.Stream"/> to output to.</param>
  6331. <remarks>
  6332. <para>
  6333. Obsolete constructor.
  6334. </para>
  6335. </remarks>
  6336. </member>
  6337. <member name="M:log4net.Appender.TextWriterAppender.#ctor(log4net.Layout.ILayout,System.IO.TextWriter)">
  6338. <summary>
  6339. Initializes a new instance of the <see cref="T:log4net.Appender.TextWriterAppender" /> class and sets
  6340. the output destination to the specified <see cref="T:System.IO.StreamWriter" />.
  6341. </summary>
  6342. <param name="layout">The layout to use with this appender</param>
  6343. <param name="writer">The <see cref="T:System.IO.TextWriter" /> to output to</param>
  6344. <remarks>
  6345. The <see cref="T:System.IO.TextWriter" /> must have been previously opened.
  6346. </remarks>
  6347. <remarks>
  6348. <para>
  6349. Obsolete constructor.
  6350. </para>
  6351. </remarks>
  6352. </member>
  6353. <member name="P:log4net.Appender.TextWriterAppender.ImmediateFlush">
  6354. <summary>
  6355. Gets or set whether the appender will flush at the end
  6356. of each append operation.
  6357. </summary>
  6358. <value>
  6359. <para>
  6360. The default behavior is to flush at the end of each
  6361. append operation.
  6362. </para>
  6363. <para>
  6364. If this option is set to <c>false</c>, then the underlying
  6365. stream can defer persisting the logging event to a later
  6366. time.
  6367. </para>
  6368. </value>
  6369. <remarks>
  6370. Avoiding the flush operation at the end of each append results in
  6371. a performance gain of 10 to 20 percent. However, there is safety
  6372. trade-off involved in skipping flushing. Indeed, when flushing is
  6373. skipped, then it is likely that the last few log events will not
  6374. be recorded on disk when the application exits. This is a high
  6375. price to pay even for a 20% performance gain.
  6376. </remarks>
  6377. </member>
  6378. <member name="P:log4net.Appender.TextWriterAppender.Writer">
  6379. <summary>
  6380. Sets the <see cref="T:System.IO.TextWriter"/> where the log output will go.
  6381. </summary>
  6382. <remarks>
  6383. <para>
  6384. The specified <see cref="T:System.IO.TextWriter"/> must be open and writable.
  6385. </para>
  6386. <para>
  6387. The <see cref="T:System.IO.TextWriter"/> will be closed when the appender
  6388. instance is closed.
  6389. </para>
  6390. <para>
  6391. <b>Note:</b> Logging to an unopened <see cref="T:System.IO.TextWriter"/> will fail.
  6392. </para>
  6393. </remarks>
  6394. </member>
  6395. <member name="M:log4net.Appender.TextWriterAppender.PreAppendCheck">
  6396. <summary>
  6397. This method determines if there is a sense in attempting to append.
  6398. </summary>
  6399. <remarks>
  6400. <para>
  6401. This method checks if an output target has been set and if a
  6402. layout has been set.
  6403. </para>
  6404. </remarks>
  6405. <returns><c>false</c> if any of the preconditions fail.</returns>
  6406. </member>
  6407. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent)">
  6408. <summary>
  6409. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/>
  6410. method.
  6411. </summary>
  6412. <param name="loggingEvent">The event to log.</param>
  6413. <remarks>
  6414. <para>
  6415. Writes a log statement to the output stream if the output stream exists
  6416. and is writable.
  6417. </para>
  6418. <para>
  6419. The format of the output will depend on the appender's layout.
  6420. </para>
  6421. </remarks>
  6422. </member>
  6423. <member name="M:log4net.Appender.TextWriterAppender.Append(log4net.Core.LoggingEvent[])">
  6424. <summary>
  6425. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent[])"/>
  6426. method.
  6427. </summary>
  6428. <param name="loggingEvents">The array of events to log.</param>
  6429. <remarks>
  6430. <para>
  6431. This method writes all the bulk logged events to the output writer
  6432. before flushing the stream.
  6433. </para>
  6434. </remarks>
  6435. </member>
  6436. <member name="M:log4net.Appender.TextWriterAppender.OnClose">
  6437. <summary>
  6438. Close this appender instance. The underlying stream or writer is also closed.
  6439. </summary>
  6440. <remarks>
  6441. Closed appenders cannot be reused.
  6442. </remarks>
  6443. </member>
  6444. <member name="P:log4net.Appender.TextWriterAppender.ErrorHandler">
  6445. <summary>
  6446. Gets or set the <see cref="T:log4net.Core.IErrorHandler"/> and the underlying
  6447. <see cref="T:log4net.Util.QuietTextWriter"/>, if any, for this appender.
  6448. </summary>
  6449. <value>
  6450. The <see cref="T:log4net.Core.IErrorHandler"/> for this appender.
  6451. </value>
  6452. </member>
  6453. <member name="P:log4net.Appender.TextWriterAppender.RequiresLayout">
  6454. <summary>
  6455. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6456. </summary>
  6457. <value><c>true</c></value>
  6458. <remarks>
  6459. <para>
  6460. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6461. </para>
  6462. </remarks>
  6463. </member>
  6464. <member name="M:log4net.Appender.TextWriterAppender.WriteFooterAndCloseWriter">
  6465. <summary>
  6466. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  6467. </summary>
  6468. <remarks>
  6469. <para>
  6470. Writes the footer and closes the underlying <see cref="T:System.IO.TextWriter"/>.
  6471. </para>
  6472. </remarks>
  6473. </member>
  6474. <member name="M:log4net.Appender.TextWriterAppender.CloseWriter">
  6475. <summary>
  6476. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  6477. </summary>
  6478. <remarks>
  6479. <para>
  6480. Closes the underlying <see cref="T:System.IO.TextWriter"/>.
  6481. </para>
  6482. </remarks>
  6483. </member>
  6484. <member name="M:log4net.Appender.TextWriterAppender.Reset">
  6485. <summary>
  6486. Clears internal references to the underlying <see cref="T:System.IO.TextWriter" />
  6487. and other variables.
  6488. </summary>
  6489. <remarks>
  6490. <para>
  6491. Subclasses can override this method for an alternate closing behavior.
  6492. </para>
  6493. </remarks>
  6494. </member>
  6495. <member name="M:log4net.Appender.TextWriterAppender.WriteFooter">
  6496. <summary>
  6497. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  6498. </summary>
  6499. <remarks>
  6500. <para>
  6501. Writes a footer as produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Footer"/> property.
  6502. </para>
  6503. </remarks>
  6504. </member>
  6505. <member name="M:log4net.Appender.TextWriterAppender.WriteHeader">
  6506. <summary>
  6507. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  6508. </summary>
  6509. <remarks>
  6510. <para>
  6511. Writes a header produced by the embedded layout's <see cref="P:log4net.Layout.ILayout.Header"/> property.
  6512. </para>
  6513. </remarks>
  6514. </member>
  6515. <member name="M:log4net.Appender.TextWriterAppender.PrepareWriter">
  6516. <summary>
  6517. Called to allow a subclass to lazily initialize the writer
  6518. </summary>
  6519. <remarks>
  6520. <para>
  6521. This method is called when an event is logged and the <see cref="P:log4net.Appender.TextWriterAppender.Writer"/> or
  6522. <see cref="P:log4net.Appender.TextWriterAppender.QuietWriter"/> have not been set. This allows a subclass to
  6523. attempt to initialize the writer multiple times.
  6524. </para>
  6525. </remarks>
  6526. </member>
  6527. <member name="P:log4net.Appender.TextWriterAppender.QuietWriter">
  6528. <summary>
  6529. Gets or sets the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  6530. will be written to.
  6531. </summary>
  6532. <value>
  6533. The <see cref="T:log4net.Util.QuietTextWriter"/> where logging events are written.
  6534. </value>
  6535. <remarks>
  6536. <para>
  6537. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  6538. will be written to.
  6539. </para>
  6540. </remarks>
  6541. </member>
  6542. <member name="F:log4net.Appender.TextWriterAppender.m_qtw">
  6543. <summary>
  6544. This is the <see cref="T:log4net.Util.QuietTextWriter"/> where logging events
  6545. will be written to.
  6546. </summary>
  6547. </member>
  6548. <member name="F:log4net.Appender.TextWriterAppender.m_immediateFlush">
  6549. <summary>
  6550. Immediate flush means that the underlying <see cref="T:System.IO.TextWriter" />
  6551. or output stream will be flushed at the end of each append operation.
  6552. </summary>
  6553. <remarks>
  6554. <para>
  6555. Immediate flush is slower but ensures that each append request is
  6556. actually written. If <see cref="P:log4net.Appender.TextWriterAppender.ImmediateFlush"/> is set to
  6557. <c>false</c>, then there is a good chance that the last few
  6558. logging events are not actually persisted if and when the application
  6559. crashes.
  6560. </para>
  6561. <para>
  6562. The default value is <c>true</c>.
  6563. </para>
  6564. </remarks>
  6565. </member>
  6566. <member name="F:log4net.Appender.TextWriterAppender.declaringType">
  6567. <summary>
  6568. The fully qualified type of the TextWriterAppender class.
  6569. </summary>
  6570. <remarks>
  6571. Used by the internal logger to record the Type of the
  6572. log message.
  6573. </remarks>
  6574. </member>
  6575. <member name="M:log4net.Appender.TextWriterAppender.Flush(System.Int32)">
  6576. <summary>
  6577. Flushes any buffered log data.
  6578. </summary>
  6579. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  6580. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  6581. </member>
  6582. <member name="T:log4net.Appender.TraceAppender">
  6583. <summary>
  6584. Appends log events to the <see cref="T:System.Diagnostics.Trace"/> system.
  6585. </summary>
  6586. <remarks>
  6587. <para>
  6588. The application configuration file can be used to control what listeners
  6589. are actually used. See the MSDN documentation for the
  6590. <see cref="T:System.Diagnostics.Trace"/> class for details on configuring the
  6591. trace system.
  6592. </para>
  6593. <para>
  6594. Events are written using the <c>System.Diagnostics.Trace.Write(string,string)</c>
  6595. method. The event's logger name is the default value for the category parameter
  6596. of the Write method.
  6597. </para>
  6598. <para>
  6599. <b>Compact Framework</b><br />
  6600. The Compact Framework does not support the <see cref="T:System.Diagnostics.Trace"/>
  6601. class for any operation except <c>Assert</c>. When using the Compact Framework this
  6602. appender will write to the <see cref="T:System.Diagnostics.Debug"/> system rather than
  6603. the Trace system. This appender will therefore behave like the <see cref="T:log4net.Appender.DebugAppender"/>.
  6604. </para>
  6605. </remarks>
  6606. <author>Douglas de la Torre</author>
  6607. <author>Nicko Cadell</author>
  6608. <author>Gert Driesen</author>
  6609. <author>Ron Grabowski</author>
  6610. </member>
  6611. <member name="M:log4net.Appender.TraceAppender.#ctor">
  6612. <summary>
  6613. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender" />.
  6614. </summary>
  6615. <remarks>
  6616. <para>
  6617. Default constructor.
  6618. </para>
  6619. </remarks>
  6620. </member>
  6621. <member name="M:log4net.Appender.TraceAppender.#ctor(log4net.Layout.ILayout)">
  6622. <summary>
  6623. Initializes a new instance of the <see cref="T:log4net.Appender.TraceAppender" />
  6624. with a specified layout.
  6625. </summary>
  6626. <param name="layout">The layout to use with this appender.</param>
  6627. <remarks>
  6628. <para>
  6629. Obsolete constructor.
  6630. </para>
  6631. </remarks>
  6632. </member>
  6633. <member name="P:log4net.Appender.TraceAppender.ImmediateFlush">
  6634. <summary>
  6635. Gets or sets a value that indicates whether the appender will
  6636. flush at the end of each write.
  6637. </summary>
  6638. <remarks>
  6639. <para>The default behavior is to flush at the end of each
  6640. write. If the option is set to<c>false</c>, then the underlying
  6641. stream can defer writing to physical medium to a later time.
  6642. </para>
  6643. <para>
  6644. Avoiding the flush operation at the end of each append results
  6645. in a performance gain of 10 to 20 percent. However, there is safety
  6646. trade-off involved in skipping flushing. Indeed, when flushing is
  6647. skipped, then it is likely that the last few log events will not
  6648. be recorded on disk when the application exits. This is a high
  6649. price to pay even for a 20% performance gain.
  6650. </para>
  6651. </remarks>
  6652. </member>
  6653. <member name="P:log4net.Appender.TraceAppender.Category">
  6654. <summary>
  6655. The category parameter sent to the Trace method.
  6656. </summary>
  6657. <remarks>
  6658. <para>
  6659. Defaults to %logger which will use the logger name of the current
  6660. <see cref="T:log4net.Core.LoggingEvent"/> as the category parameter.
  6661. </para>
  6662. <para>
  6663. </para>
  6664. </remarks>
  6665. </member>
  6666. <member name="M:log4net.Appender.TraceAppender.Append(log4net.Core.LoggingEvent)">
  6667. <summary>
  6668. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  6669. </summary>
  6670. <param name="loggingEvent">The event to log.</param>
  6671. <remarks>
  6672. <para>
  6673. Writes the logging event to the <see cref="T:System.Diagnostics.Trace"/> system.
  6674. </para>
  6675. </remarks>
  6676. </member>
  6677. <member name="P:log4net.Appender.TraceAppender.RequiresLayout">
  6678. <summary>
  6679. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6680. </summary>
  6681. <value><c>true</c></value>
  6682. <remarks>
  6683. <para>
  6684. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6685. </para>
  6686. </remarks>
  6687. </member>
  6688. <member name="F:log4net.Appender.TraceAppender.m_immediateFlush">
  6689. <summary>
  6690. Immediate flush means that the underlying writer or output stream
  6691. will be flushed at the end of each append operation.
  6692. </summary>
  6693. <remarks>
  6694. <para>
  6695. Immediate flush is slower but ensures that each append request is
  6696. actually written. If <see cref="P:log4net.Appender.TraceAppender.ImmediateFlush"/> is set to
  6697. <c>false</c>, then there is a good chance that the last few
  6698. logs events are not actually written to persistent media if and
  6699. when the application crashes.
  6700. </para>
  6701. <para>
  6702. The default value is <c>true</c>.</para>
  6703. </remarks>
  6704. </member>
  6705. <member name="F:log4net.Appender.TraceAppender.m_category">
  6706. <summary>
  6707. Defaults to %logger
  6708. </summary>
  6709. </member>
  6710. <member name="M:log4net.Appender.TraceAppender.Flush(System.Int32)">
  6711. <summary>
  6712. Flushes any buffered log data.
  6713. </summary>
  6714. <param name="millisecondsTimeout">The maximum time to wait for logging events to be flushed.</param>
  6715. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  6716. </member>
  6717. <member name="T:log4net.Appender.UdpAppender">
  6718. <summary>
  6719. Sends logging events as connectionless UDP datagrams to a remote host or a
  6720. multicast group using an <see cref="T:System.Net.Sockets.UdpClient" />.
  6721. </summary>
  6722. <remarks>
  6723. <para>
  6724. UDP guarantees neither that messages arrive, nor that they arrive in the correct order.
  6725. </para>
  6726. <para>
  6727. To view the logging results, a custom application can be developed that listens for logging
  6728. events.
  6729. </para>
  6730. <para>
  6731. When decoding events send via this appender remember to use the same encoding
  6732. to decode the events as was used to send the events. See the <see cref="P:log4net.Appender.UdpAppender.Encoding"/>
  6733. property to specify the encoding to use.
  6734. </para>
  6735. </remarks>
  6736. <example>
  6737. This example shows how to log receive logging events that are sent
  6738. on IP address 244.0.0.1 and port 8080 to the console. The event is
  6739. encoded in the packet as a unicode string and it is decoded as such.
  6740. <code lang="C#">
  6741. IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0);
  6742. UdpClient udpClient;
  6743. byte[] buffer;
  6744. string loggingEvent;
  6745. try
  6746. {
  6747. udpClient = new UdpClient(8080);
  6748. while(true)
  6749. {
  6750. buffer = udpClient.Receive(ref remoteEndPoint);
  6751. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer);
  6752. Console.WriteLine(loggingEvent);
  6753. }
  6754. }
  6755. catch(Exception e)
  6756. {
  6757. Console.WriteLine(e.ToString());
  6758. }
  6759. </code>
  6760. <code lang="Visual Basic">
  6761. Dim remoteEndPoint as IPEndPoint
  6762. Dim udpClient as UdpClient
  6763. Dim buffer as Byte()
  6764. Dim loggingEvent as String
  6765. Try
  6766. remoteEndPoint = new IPEndPoint(IPAddress.Any, 0)
  6767. udpClient = new UdpClient(8080)
  6768. While True
  6769. buffer = udpClient.Receive(ByRef remoteEndPoint)
  6770. loggingEvent = System.Text.Encoding.Unicode.GetString(buffer)
  6771. Console.WriteLine(loggingEvent)
  6772. Wend
  6773. Catch e As Exception
  6774. Console.WriteLine(e.ToString())
  6775. End Try
  6776. </code>
  6777. <para>
  6778. An example configuration section to log information using this appender to the
  6779. IP 224.0.0.1 on port 8080:
  6780. </para>
  6781. <code lang="XML" escaped="true">
  6782. <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
  6783. <remoteAddress value="224.0.0.1" />
  6784. <remotePort value="8080" />
  6785. <layout type="log4net.Layout.PatternLayout" value="%-5level %logger [%ndc] - %message%newline" />
  6786. </appender>
  6787. </code>
  6788. </example>
  6789. <author>Gert Driesen</author>
  6790. <author>Nicko Cadell</author>
  6791. </member>
  6792. <member name="M:log4net.Appender.UdpAppender.#ctor">
  6793. <summary>
  6794. Initializes a new instance of the <see cref="T:log4net.Appender.UdpAppender" /> class.
  6795. </summary>
  6796. <remarks>
  6797. The default constructor initializes all fields to their default values.
  6798. </remarks>
  6799. </member>
  6800. <member name="P:log4net.Appender.UdpAppender.RemoteAddress">
  6801. <summary>
  6802. Gets or sets the IP address of the remote host or multicast group to which
  6803. the underlying <see cref="T:System.Net.Sockets.UdpClient" /> should sent the logging event.
  6804. </summary>
  6805. <value>
  6806. The IP address of the remote host or multicast group to which the logging event
  6807. will be sent.
  6808. </value>
  6809. <remarks>
  6810. <para>
  6811. Multicast addresses are identified by IP class <b>D</b> addresses (in the range 224.0.0.0 to
  6812. 239.255.255.255). Multicast packets can pass across different networks through routers, so
  6813. it is possible to use multicasts in an Internet scenario as long as your network provider
  6814. supports multicasting.
  6815. </para>
  6816. <para>
  6817. Hosts that want to receive particular multicast messages must register their interest by joining
  6818. the multicast group. Multicast messages are not sent to networks where no host has joined
  6819. the multicast group. Class <b>D</b> IP addresses are used for multicast groups, to differentiate
  6820. them from normal host addresses, allowing nodes to easily detect if a message is of interest.
  6821. </para>
  6822. <para>
  6823. Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below:
  6824. </para>
  6825. <para>
  6826. <list type="table">
  6827. <listheader>
  6828. <term>IP Address</term>
  6829. <description>Description</description>
  6830. </listheader>
  6831. <item>
  6832. <term>224.0.0.1</term>
  6833. <description>
  6834. <para>
  6835. Sends a message to all system on the subnet.
  6836. </para>
  6837. </description>
  6838. </item>
  6839. <item>
  6840. <term>224.0.0.2</term>
  6841. <description>
  6842. <para>
  6843. Sends a message to all routers on the subnet.
  6844. </para>
  6845. </description>
  6846. </item>
  6847. <item>
  6848. <term>224.0.0.12</term>
  6849. <description>
  6850. <para>
  6851. The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet.
  6852. </para>
  6853. </description>
  6854. </item>
  6855. </list>
  6856. </para>
  6857. <para>
  6858. A complete list of actually reserved multicast addresses and their owners in the ranges
  6859. defined by RFC 3171 can be found at the <A href="http://www.iana.org/assignments/multicast-addresses">IANA web site</A>.
  6860. </para>
  6861. <para>
  6862. The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative
  6863. addresses. These addresses can be reused with other local groups. Routers are typically
  6864. configured with filters to prevent multicast traffic in this range from flowing outside
  6865. of the local network.
  6866. </para>
  6867. </remarks>
  6868. </member>
  6869. <member name="P:log4net.Appender.UdpAppender.RemotePort">
  6870. <summary>
  6871. Gets or sets the TCP port number of the remote host or multicast group to which
  6872. the underlying <see cref="T:System.Net.Sockets.UdpClient" /> should sent the logging event.
  6873. </summary>
  6874. <value>
  6875. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  6876. indicating the TCP port number of the remote host or multicast group to which the logging event
  6877. will be sent.
  6878. </value>
  6879. <remarks>
  6880. The underlying <see cref="T:System.Net.Sockets.UdpClient" /> will send messages to this TCP port number
  6881. on the remote host or multicast group.
  6882. </remarks>
  6883. <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>
  6884. </member>
  6885. <member name="P:log4net.Appender.UdpAppender.LocalPort">
  6886. <summary>
  6887. Gets or sets the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  6888. </summary>
  6889. <value>
  6890. An integer value in the range <see cref="F:System.Net.IPEndPoint.MinPort" /> to <see cref="F:System.Net.IPEndPoint.MaxPort" />
  6891. indicating the TCP port number from which the underlying <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  6892. </value>
  6893. <remarks>
  6894. <para>
  6895. The underlying <see cref="T:System.Net.Sockets.UdpClient" /> will bind to this port for sending messages.
  6896. </para>
  6897. <para>
  6898. Setting the value to 0 (the default) will cause the udp client not to bind to
  6899. a local port.
  6900. </para>
  6901. </remarks>
  6902. <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>
  6903. </member>
  6904. <member name="P:log4net.Appender.UdpAppender.Encoding">
  6905. <summary>
  6906. Gets or sets <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6907. </summary>
  6908. <value>
  6909. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6910. </value>
  6911. <remarks>
  6912. <para>
  6913. The <see cref="P:log4net.Appender.UdpAppender.Encoding"/> used to write the packets.
  6914. </para>
  6915. </remarks>
  6916. </member>
  6917. <member name="P:log4net.Appender.UdpAppender.Client">
  6918. <summary>
  6919. Gets or sets the underlying <see cref="T:System.Net.Sockets.UdpClient" />.
  6920. </summary>
  6921. <value>
  6922. The underlying <see cref="T:System.Net.Sockets.UdpClient" />.
  6923. </value>
  6924. <remarks>
  6925. <see cref="T:log4net.Appender.UdpAppender" /> creates a <see cref="T:System.Net.Sockets.UdpClient" /> to send logging events
  6926. over a network. Classes deriving from <see cref="T:log4net.Appender.UdpAppender" /> can use this
  6927. property to get or set this <see cref="T:System.Net.Sockets.UdpClient" />. Use the underlying <see cref="T:System.Net.Sockets.UdpClient" />
  6928. returned from <see cref="P:log4net.Appender.UdpAppender.Client" /> if you require access beyond that which
  6929. <see cref="T:log4net.Appender.UdpAppender" /> provides.
  6930. </remarks>
  6931. </member>
  6932. <member name="P:log4net.Appender.UdpAppender.RemoteEndPoint">
  6933. <summary>
  6934. Gets or sets the cached remote endpoint to which the logging events should be sent.
  6935. </summary>
  6936. <value>
  6937. The cached remote endpoint to which the logging events will be sent.
  6938. </value>
  6939. <remarks>
  6940. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions" /> method will initialize the remote endpoint
  6941. with the values of the <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> and <see cref="P:log4net.Appender.UdpAppender.RemotePort"/>
  6942. properties.
  6943. </remarks>
  6944. </member>
  6945. <member name="M:log4net.Appender.UdpAppender.ActivateOptions">
  6946. <summary>
  6947. Initialize the appender based on the options set.
  6948. </summary>
  6949. <remarks>
  6950. <para>
  6951. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  6952. activation scheme. The <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> method must
  6953. be called on this object after the configuration properties have
  6954. been set. Until <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> is called this
  6955. object is in an undefined state and must not be used.
  6956. </para>
  6957. <para>
  6958. If any of the configuration properties are modified then
  6959. <see cref="M:log4net.Appender.UdpAppender.ActivateOptions"/> must be called again.
  6960. </para>
  6961. <para>
  6962. The appender will be ignored if no <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> was specified or
  6963. an invalid remote or local TCP port number was specified.
  6964. </para>
  6965. </remarks>
  6966. <exception cref="T:System.ArgumentNullException">The required property <see cref="P:log4net.Appender.UdpAppender.RemoteAddress" /> was not specified.</exception>
  6967. <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>
  6968. </member>
  6969. <member name="M:log4net.Appender.UdpAppender.Append(log4net.Core.LoggingEvent)">
  6970. <summary>
  6971. This method is called by the <see cref="M:AppenderSkeleton.DoAppend(LoggingEvent)"/> method.
  6972. </summary>
  6973. <param name="loggingEvent">The event to log.</param>
  6974. <remarks>
  6975. <para>
  6976. Sends the event using an UDP datagram.
  6977. </para>
  6978. <para>
  6979. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  6980. </para>
  6981. </remarks>
  6982. </member>
  6983. <member name="P:log4net.Appender.UdpAppender.RequiresLayout">
  6984. <summary>
  6985. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6986. </summary>
  6987. <value><c>true</c></value>
  6988. <remarks>
  6989. <para>
  6990. This appender requires a <see cref="N:log4net.Layout"/> to be set.
  6991. </para>
  6992. </remarks>
  6993. </member>
  6994. <member name="M:log4net.Appender.UdpAppender.OnClose">
  6995. <summary>
  6996. Closes the UDP connection and releases all resources associated with
  6997. this <see cref="T:log4net.Appender.UdpAppender" /> instance.
  6998. </summary>
  6999. <remarks>
  7000. <para>
  7001. Disables the underlying <see cref="T:System.Net.Sockets.UdpClient" /> and releases all managed
  7002. and unmanaged resources associated with the <see cref="T:log4net.Appender.UdpAppender" />.
  7003. </para>
  7004. </remarks>
  7005. </member>
  7006. <member name="M:log4net.Appender.UdpAppender.InitializeClientConnection">
  7007. <summary>
  7008. Initializes the underlying <see cref="T:System.Net.Sockets.UdpClient" /> connection.
  7009. </summary>
  7010. <remarks>
  7011. <para>
  7012. The underlying <see cref="T:System.Net.Sockets.UdpClient"/> is initialized and binds to the
  7013. port number from which you intend to communicate.
  7014. </para>
  7015. <para>
  7016. Exceptions are passed to the <see cref="P:log4net.Appender.AppenderSkeleton.ErrorHandler"/>.
  7017. </para>
  7018. </remarks>
  7019. </member>
  7020. <member name="F:log4net.Appender.UdpAppender.m_remoteAddress">
  7021. <summary>
  7022. The IP address of the remote host or multicast group to which
  7023. the logging event will be sent.
  7024. </summary>
  7025. </member>
  7026. <member name="F:log4net.Appender.UdpAppender.m_remotePort">
  7027. <summary>
  7028. The TCP port number of the remote host or multicast group to
  7029. which the logging event will be sent.
  7030. </summary>
  7031. </member>
  7032. <member name="F:log4net.Appender.UdpAppender.m_remoteEndPoint">
  7033. <summary>
  7034. The cached remote endpoint to which the logging events will be sent.
  7035. </summary>
  7036. </member>
  7037. <member name="F:log4net.Appender.UdpAppender.m_localPort">
  7038. <summary>
  7039. The TCP port number from which the <see cref="T:System.Net.Sockets.UdpClient" /> will communicate.
  7040. </summary>
  7041. </member>
  7042. <member name="F:log4net.Appender.UdpAppender.m_client">
  7043. <summary>
  7044. The <see cref="T:System.Net.Sockets.UdpClient" /> instance that will be used for sending the
  7045. logging events.
  7046. </summary>
  7047. </member>
  7048. <member name="F:log4net.Appender.UdpAppender.m_encoding">
  7049. <summary>
  7050. The encoding to use for the packet.
  7051. </summary>
  7052. </member>
  7053. <member name="T:log4net.Config.AliasDomainAttribute">
  7054. <summary>
  7055. Assembly level attribute that specifies a domain to alias to this assembly's repository.
  7056. </summary>
  7057. <remarks>
  7058. <para>
  7059. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  7060. </para>
  7061. <para>
  7062. An assembly's logger repository is defined by its <see cref="T:log4net.Config.DomainAttribute"/>,
  7063. however this can be overridden by an assembly loaded before the target assembly.
  7064. </para>
  7065. <para>
  7066. An assembly can alias another assembly's domain to its repository by
  7067. specifying this attribute with the name of the target domain.
  7068. </para>
  7069. <para>
  7070. This attribute can only be specified on the assembly and may be used
  7071. as many times as necessary to alias all the required domains.
  7072. </para>
  7073. </remarks>
  7074. <author>Nicko Cadell</author>
  7075. <author>Gert Driesen</author>
  7076. </member>
  7077. <member name="M:log4net.Config.AliasDomainAttribute.#ctor(System.String)">
  7078. <summary>
  7079. Initializes a new instance of the <see cref="T:log4net.Config.AliasDomainAttribute" /> class with
  7080. the specified domain to alias to this assembly's repository.
  7081. </summary>
  7082. <param name="name">The domain to alias to this assemby's repository.</param>
  7083. <remarks>
  7084. <para>
  7085. Obsolete. Use <see cref="T:log4net.Config.AliasRepositoryAttribute"/> instead of <see cref="T:log4net.Config.AliasDomainAttribute"/>.
  7086. </para>
  7087. </remarks>
  7088. </member>
  7089. <member name="T:log4net.Config.AliasRepositoryAttribute">
  7090. <summary>
  7091. Assembly level attribute that specifies a repository to alias to this assembly's repository.
  7092. </summary>
  7093. <remarks>
  7094. <para>
  7095. An assembly's logger repository is defined by its <see cref="T:log4net.Config.RepositoryAttribute"/>,
  7096. however this can be overridden by an assembly loaded before the target assembly.
  7097. </para>
  7098. <para>
  7099. An assembly can alias another assembly's repository to its repository by
  7100. specifying this attribute with the name of the target repository.
  7101. </para>
  7102. <para>
  7103. This attribute can only be specified on the assembly and may be used
  7104. as many times as necessary to alias all the required repositories.
  7105. </para>
  7106. </remarks>
  7107. <author>Nicko Cadell</author>
  7108. <author>Gert Driesen</author>
  7109. </member>
  7110. <member name="M:log4net.Config.AliasRepositoryAttribute.#ctor(System.String)">
  7111. <summary>
  7112. Initializes a new instance of the <see cref="T:log4net.Config.AliasRepositoryAttribute" /> class with
  7113. the specified repository to alias to this assembly's repository.
  7114. </summary>
  7115. <param name="name">The repository to alias to this assemby's repository.</param>
  7116. <remarks>
  7117. <para>
  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. </para>
  7121. </remarks>
  7122. </member>
  7123. <member name="P:log4net.Config.AliasRepositoryAttribute.Name">
  7124. <summary>
  7125. Gets or sets the repository to alias to this assemby's repository.
  7126. </summary>
  7127. <value>
  7128. The repository to alias to this assemby's repository.
  7129. </value>
  7130. <remarks>
  7131. <para>
  7132. The name of the repository to alias to this assemby's repository.
  7133. </para>
  7134. </remarks>
  7135. </member>
  7136. <member name="T:log4net.Config.BasicConfigurator">
  7137. <summary>
  7138. Use this class to quickly configure a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  7139. </summary>
  7140. <remarks>
  7141. <para>
  7142. Allows very simple programmatic configuration of log4net.
  7143. </para>
  7144. <para>
  7145. Only one appender can be configured using this configurator.
  7146. The appender is set at the root of the hierarchy and all logging
  7147. events will be delivered to that appender.
  7148. </para>
  7149. <para>
  7150. Appenders can also implement the <see cref="T:log4net.Core.IOptionHandler"/> interface. Therefore
  7151. they would require that the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions()"/> method
  7152. be called after the appenders properties have been configured.
  7153. </para>
  7154. </remarks>
  7155. <author>Nicko Cadell</author>
  7156. <author>Gert Driesen</author>
  7157. </member>
  7158. <member name="F:log4net.Config.BasicConfigurator.declaringType">
  7159. <summary>
  7160. The fully qualified type of the BasicConfigurator class.
  7161. </summary>
  7162. <remarks>
  7163. Used by the internal logger to record the Type of the
  7164. log message.
  7165. </remarks>
  7166. </member>
  7167. <member name="M:log4net.Config.BasicConfigurator.#ctor">
  7168. <summary>
  7169. Initializes a new instance of the <see cref="T:log4net.Config.BasicConfigurator" /> class.
  7170. </summary>
  7171. <remarks>
  7172. <para>
  7173. Uses a private access modifier to prevent instantiation of this class.
  7174. </para>
  7175. </remarks>
  7176. </member>
  7177. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  7178. <summary>
  7179. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> with a default configuration.
  7180. </summary>
  7181. <param name="repository">The repository to configure.</param>
  7182. <remarks>
  7183. <para>
  7184. Initializes the specified repository using a <see cref="T:log4net.Appender.ConsoleAppender"/>
  7185. that will write to <c>Console.Out</c>. The log messages are
  7186. formatted using the <see cref="T:log4net.Layout.PatternLayout"/> layout object
  7187. with the <see cref="F:log4net.Layout.PatternLayout.DetailConversionPattern"/>
  7188. layout style.
  7189. </para>
  7190. </remarks>
  7191. </member>
  7192. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender)">
  7193. <summary>
  7194. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  7195. </summary>
  7196. <param name="repository">The repository to configure.</param>
  7197. <param name="appender">The appender to use to log all logging events.</param>
  7198. <remarks>
  7199. <para>
  7200. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  7201. </para>
  7202. </remarks>
  7203. </member>
  7204. <member name="M:log4net.Config.BasicConfigurator.Configure(log4net.Repository.ILoggerRepository,log4net.Appender.IAppender[])">
  7205. <summary>
  7206. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appenders.
  7207. </summary>
  7208. <param name="repository">The repository to configure.</param>
  7209. <param name="appenders">The appenders to use to log all logging events.</param>
  7210. <remarks>
  7211. <para>
  7212. Initializes the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified appender.
  7213. </para>
  7214. </remarks>
  7215. </member>
  7216. <member name="T:log4net.Config.ConfiguratorAttribute">
  7217. <summary>
  7218. Base class for all log4net configuration attributes.
  7219. </summary>
  7220. <remarks>
  7221. This is an abstract class that must be extended by
  7222. specific configurators. This attribute allows the
  7223. configurator to be parameterized by an assembly level
  7224. attribute.
  7225. </remarks>
  7226. <author>Nicko Cadell</author>
  7227. <author>Gert Driesen</author>
  7228. </member>
  7229. <member name="M:log4net.Config.ConfiguratorAttribute.#ctor(System.Int32)">
  7230. <summary>
  7231. Constructor used by subclasses.
  7232. </summary>
  7233. <param name="priority">the ordering priority for this configurator</param>
  7234. <remarks>
  7235. <para>
  7236. The <paramref name="priority"/> is used to order the configurator
  7237. attributes before they are invoked. Higher priority configurators are executed
  7238. before lower priority ones.
  7239. </para>
  7240. </remarks>
  7241. </member>
  7242. <member name="M:log4net.Config.ConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  7243. <summary>
  7244. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  7245. </summary>
  7246. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  7247. <param name="targetRepository">The repository to configure.</param>
  7248. <remarks>
  7249. <para>
  7250. Abstract method implemented by a subclass. When this method is called
  7251. the subclass should configure the <paramref name="targetRepository"/>.
  7252. </para>
  7253. </remarks>
  7254. </member>
  7255. <member name="M:log4net.Config.ConfiguratorAttribute.CompareTo(System.Object)">
  7256. <summary>
  7257. Compare this instance to another ConfiguratorAttribute
  7258. </summary>
  7259. <param name="obj">the object to compare to</param>
  7260. <returns>see <see cref="M:System.IComparable.CompareTo(System.Object)"/></returns>
  7261. <remarks>
  7262. <para>
  7263. Compares the priorities of the two <see cref="T:log4net.Config.ConfiguratorAttribute"/> instances.
  7264. Sorts by priority in descending order. Objects with the same priority are
  7265. randomly ordered.
  7266. </para>
  7267. </remarks>
  7268. </member>
  7269. <member name="T:log4net.Config.DomainAttribute">
  7270. <summary>
  7271. Assembly level attribute that specifies the logging domain for the assembly.
  7272. </summary>
  7273. <remarks>
  7274. <para>
  7275. <b>DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute.</b>
  7276. </para>
  7277. <para>
  7278. Assemblies are mapped to logging domains. Each domain has its own
  7279. logging repository. This attribute specified on the assembly controls
  7280. the configuration of the domain. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  7281. of the domain that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  7282. specifies the type of the repository objects to create for the domain. If
  7283. this attribute is not specified and a <see cref="P:log4net.Config.RepositoryAttribute.Name"/> is not specified
  7284. then the assembly will be part of the default shared logging domain.
  7285. </para>
  7286. <para>
  7287. This attribute can only be specified on the assembly and may only be used
  7288. once per assembly.
  7289. </para>
  7290. </remarks>
  7291. <author>Nicko Cadell</author>
  7292. <author>Gert Driesen</author>
  7293. </member>
  7294. <member name="M:log4net.Config.DomainAttribute.#ctor">
  7295. <summary>
  7296. Initializes a new instance of the <see cref="T:log4net.Config.DomainAttribute" /> class.
  7297. </summary>
  7298. <remarks>
  7299. <para>
  7300. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  7301. </para>
  7302. </remarks>
  7303. </member>
  7304. <member name="M:log4net.Config.DomainAttribute.#ctor(System.String)">
  7305. <summary>
  7306. Initialize a new instance of the <see cref="T:log4net.Config.DomainAttribute" /> class
  7307. with the name of the domain.
  7308. </summary>
  7309. <param name="name">The name of the domain.</param>
  7310. <remarks>
  7311. <para>
  7312. Obsolete. Use RepositoryAttribute instead of DomainAttribute.
  7313. </para>
  7314. </remarks>
  7315. </member>
  7316. <member name="T:log4net.Config.DOMConfiguratorAttribute">
  7317. <summary>
  7318. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  7319. </summary>
  7320. <remarks>
  7321. <para>
  7322. <b>AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute.</b>
  7323. </para>
  7324. <para>
  7325. This attribute may only be used at the assembly scope and can only
  7326. be used once per assembly.
  7327. </para>
  7328. <para>
  7329. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  7330. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  7331. methods.
  7332. </para>
  7333. </remarks>
  7334. <author>Nicko Cadell</author>
  7335. <author>Gert Driesen</author>
  7336. </member>
  7337. <member name="T:log4net.Config.PluginAttribute">
  7338. <summary>
  7339. Assembly level attribute that specifies a plugin to attach to
  7340. the repository.
  7341. </summary>
  7342. <remarks>
  7343. <para>
  7344. Specifies the type of a plugin to create and attach to the
  7345. assembly's repository. The plugin type must implement the
  7346. <see cref="T:log4net.Plugin.IPlugin"/> interface.
  7347. </para>
  7348. </remarks>
  7349. <author>Nicko Cadell</author>
  7350. <author>Gert Driesen</author>
  7351. </member>
  7352. <member name="M:log4net.Config.PluginAttribute.#ctor(System.Type)">
  7353. <summary>
  7354. Initializes a new instance of the <see cref="T:log4net.Config.PluginAttribute" /> class
  7355. with the specified type.
  7356. </summary>
  7357. <param name="type">The type of plugin to create.</param>
  7358. <remarks>
  7359. <para>
  7360. Create the attribute with the plugin type specified.
  7361. </para>
  7362. </remarks>
  7363. </member>
  7364. <member name="P:log4net.Config.PluginAttribute.Type">
  7365. <summary>
  7366. Gets or sets the type for the plugin.
  7367. </summary>
  7368. <value>
  7369. The type for the plugin.
  7370. </value>
  7371. <remarks>
  7372. <para>
  7373. The type for the plugin.
  7374. </para>
  7375. </remarks>
  7376. </member>
  7377. <member name="P:log4net.Config.PluginAttribute.TypeName">
  7378. <summary>
  7379. Gets or sets the type name for the plugin.
  7380. </summary>
  7381. <value>
  7382. The type name for the plugin.
  7383. </value>
  7384. <remarks>
  7385. <para>
  7386. The type name for the plugin.
  7387. </para>
  7388. <para>
  7389. Where possible use the <see cref="P:log4net.Config.PluginAttribute.Type"/> property instead.
  7390. </para>
  7391. </remarks>
  7392. </member>
  7393. <member name="M:log4net.Config.PluginAttribute.CreatePlugin">
  7394. <summary>
  7395. Creates the plugin object defined by this attribute.
  7396. </summary>
  7397. <remarks>
  7398. <para>
  7399. Creates the instance of the <see cref="T:log4net.Plugin.IPlugin"/> object as
  7400. specified by this attribute.
  7401. </para>
  7402. </remarks>
  7403. <returns>The plugin object.</returns>
  7404. </member>
  7405. <member name="M:log4net.Config.PluginAttribute.ToString">
  7406. <summary>
  7407. Returns a representation of the properties of this object.
  7408. </summary>
  7409. <remarks>
  7410. <para>
  7411. Overrides base class <see cref="M:Object.ToString()" /> method to
  7412. return a representation of the properties of this object.
  7413. </para>
  7414. </remarks>
  7415. <returns>A representation of the properties of this object</returns>
  7416. </member>
  7417. <member name="T:log4net.Config.RepositoryAttribute">
  7418. <summary>
  7419. Assembly level attribute that specifies the logging repository for the assembly.
  7420. </summary>
  7421. <remarks>
  7422. <para>
  7423. Assemblies are mapped to logging repository. This attribute specified
  7424. on the assembly controls
  7425. the configuration of the repository. The <see cref="P:log4net.Config.RepositoryAttribute.Name"/> property specifies the name
  7426. of the repository that this assembly is a part of. The <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType"/>
  7427. specifies the type of the <see cref="T:log4net.Repository.ILoggerRepository"/> object
  7428. to create for the assembly. If this attribute is not specified or a <see cref="P:log4net.Config.RepositoryAttribute.Name"/>
  7429. is not specified then the assembly will be part of the default shared logging repository.
  7430. </para>
  7431. <para>
  7432. This attribute can only be specified on the assembly and may only be used
  7433. once per assembly.
  7434. </para>
  7435. </remarks>
  7436. <author>Nicko Cadell</author>
  7437. <author>Gert Driesen</author>
  7438. </member>
  7439. <member name="M:log4net.Config.RepositoryAttribute.#ctor">
  7440. <summary>
  7441. Initializes a new instance of the <see cref="T:log4net.Config.RepositoryAttribute" /> class.
  7442. </summary>
  7443. <remarks>
  7444. <para>
  7445. Default constructor.
  7446. </para>
  7447. </remarks>
  7448. </member>
  7449. <member name="M:log4net.Config.RepositoryAttribute.#ctor(System.String)">
  7450. <summary>
  7451. Initialize a new instance of the <see cref="T:log4net.Config.RepositoryAttribute" /> class
  7452. with the name of the repository.
  7453. </summary>
  7454. <param name="name">The name of the repository.</param>
  7455. <remarks>
  7456. <para>
  7457. Initialize the attribute with the name for the assembly's repository.
  7458. </para>
  7459. </remarks>
  7460. </member>
  7461. <member name="P:log4net.Config.RepositoryAttribute.Name">
  7462. <summary>
  7463. Gets or sets the name of the logging repository.
  7464. </summary>
  7465. <value>
  7466. The string name to use as the name of the repository associated with this
  7467. assembly.
  7468. </value>
  7469. <remarks>
  7470. <para>
  7471. This value does not have to be unique. Several assemblies can share the
  7472. same repository. They will share the logging configuration of the repository.
  7473. </para>
  7474. </remarks>
  7475. </member>
  7476. <member name="P:log4net.Config.RepositoryAttribute.RepositoryType">
  7477. <summary>
  7478. Gets or sets the type of repository to create for this assembly.
  7479. </summary>
  7480. <value>
  7481. The type of repository to create for this assembly.
  7482. </value>
  7483. <remarks>
  7484. <para>
  7485. The type of the repository to create for the assembly.
  7486. The type must implement the <see cref="T:log4net.Repository.ILoggerRepository"/>
  7487. interface.
  7488. </para>
  7489. <para>
  7490. This will be the type of repository created when
  7491. the repository is created. If multiple assemblies reference the
  7492. same repository then the repository is only created once using the
  7493. <see cref="P:log4net.Config.RepositoryAttribute.RepositoryType" /> of the first assembly to call into the
  7494. repository.
  7495. </para>
  7496. </remarks>
  7497. </member>
  7498. <member name="T:log4net.Config.SecurityContextProviderAttribute">
  7499. <summary>
  7500. Assembly level attribute to configure the <see cref="T:log4net.Core.SecurityContextProvider"/>.
  7501. </summary>
  7502. <remarks>
  7503. <para>
  7504. This attribute may only be used at the assembly scope and can only
  7505. be used once per assembly.
  7506. </para>
  7507. <para>
  7508. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  7509. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  7510. methods.
  7511. </para>
  7512. </remarks>
  7513. <author>Nicko Cadell</author>
  7514. </member>
  7515. <member name="M:log4net.Config.SecurityContextProviderAttribute.#ctor(System.Type)">
  7516. <summary>
  7517. Construct provider attribute with type specified
  7518. </summary>
  7519. <param name="providerType">the type of the provider to use</param>
  7520. <remarks>
  7521. <para>
  7522. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  7523. class.
  7524. </para>
  7525. </remarks>
  7526. </member>
  7527. <member name="P:log4net.Config.SecurityContextProviderAttribute.ProviderType">
  7528. <summary>
  7529. Gets or sets the type of the provider to use.
  7530. </summary>
  7531. <value>
  7532. the type of the provider to use.
  7533. </value>
  7534. <remarks>
  7535. <para>
  7536. The provider specified must subclass the <see cref="T:log4net.Core.SecurityContextProvider"/>
  7537. class.
  7538. </para>
  7539. </remarks>
  7540. </member>
  7541. <member name="M:log4net.Config.SecurityContextProviderAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  7542. <summary>
  7543. Configures the SecurityContextProvider
  7544. </summary>
  7545. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  7546. <param name="targetRepository">The repository to configure.</param>
  7547. <remarks>
  7548. <para>
  7549. Creates a provider instance from the <see cref="P:log4net.Config.SecurityContextProviderAttribute.ProviderType"/> specified.
  7550. Sets this as the default security context provider <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/>.
  7551. </para>
  7552. </remarks>
  7553. </member>
  7554. <member name="F:log4net.Config.SecurityContextProviderAttribute.declaringType">
  7555. <summary>
  7556. The fully qualified type of the SecurityContextProviderAttribute class.
  7557. </summary>
  7558. <remarks>
  7559. Used by the internal logger to record the Type of the
  7560. log message.
  7561. </remarks>
  7562. </member>
  7563. <member name="T:log4net.Config.XmlConfigurator">
  7564. <summary>
  7565. Use this class to initialize the log4net environment using an Xml tree.
  7566. </summary>
  7567. <remarks>
  7568. <para>
  7569. Configures a <see cref="T:log4net.Repository.ILoggerRepository"/> using an Xml tree.
  7570. </para>
  7571. </remarks>
  7572. <author>Nicko Cadell</author>
  7573. <author>Gert Driesen</author>
  7574. </member>
  7575. <member name="M:log4net.Config.XmlConfigurator.#ctor">
  7576. <summary>
  7577. Private constructor
  7578. </summary>
  7579. </member>
  7580. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository)">
  7581. <summary>
  7582. Automatically configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using settings
  7583. stored in the application's configuration file.
  7584. </summary>
  7585. <remarks>
  7586. <para>
  7587. Each application has a configuration file. This has the
  7588. same name as the application with '.config' appended.
  7589. This file is XML and calling this function prompts the
  7590. configurator to look in that file for a section called
  7591. <c>log4net</c> that contains the configuration data.
  7592. </para>
  7593. <para>
  7594. To use this method to configure log4net you must specify
  7595. the <see cref="!:Log4NetConfigurationSectionHandler"/> section
  7596. handler for the <c>log4net</c> configuration section. See the
  7597. <see cref="!:Log4NetConfigurationSectionHandler"/> for an example.
  7598. </para>
  7599. </remarks>
  7600. <param name="repository">The repository to configure.</param>
  7601. </member>
  7602. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  7603. <summary>
  7604. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified XML
  7605. element.
  7606. </summary>
  7607. <remarks>
  7608. Loads the log4net configuration from the XML element
  7609. supplied as <paramref name="element"/>.
  7610. </remarks>
  7611. <param name="repository">The repository to configure.</param>
  7612. <param name="element">The element to parse.</param>
  7613. </member>
  7614. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  7615. <summary>
  7616. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  7617. file.
  7618. </summary>
  7619. <param name="repository">The repository to configure.</param>
  7620. <param name="configFile">The XML file to load the configuration from.</param>
  7621. <remarks>
  7622. <para>
  7623. The configuration file must be valid XML. It must contain
  7624. at least one element called <c>log4net</c> that holds
  7625. the configuration data.
  7626. </para>
  7627. <para>
  7628. The log4net configuration file can possible be specified in the application's
  7629. configuration file (either <c>MyAppName.exe.config</c> for a
  7630. normal application on <c>Web.config</c> for an ASP.NET application).
  7631. </para>
  7632. <para>
  7633. The first element matching <c>&lt;configuration&gt;</c> will be read as the
  7634. configuration. If this file is also a .NET .config file then you must specify
  7635. a configuration section for the <c>log4net</c> element otherwise .NET will
  7636. complain. Set the type for the section handler to <see cref="!:System.Configuration.IgnoreSectionHandler"/>, for example:
  7637. <code lang="XML" escaped="true">
  7638. <configSections>
  7639. <section name="log4net" type="System.Configuration.IgnoreSectionHandler" />
  7640. </configSections>
  7641. </code>
  7642. </para>
  7643. <example>
  7644. The following example configures log4net using a configuration file, of which the
  7645. location is stored in the application's configuration file :
  7646. </example>
  7647. <code lang="C#">
  7648. using log4net.Config;
  7649. using System.IO;
  7650. using System.Configuration;
  7651. ...
  7652. XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"]));
  7653. </code>
  7654. <para>
  7655. In the <c>.config</c> file, the path to the log4net can be specified like this :
  7656. </para>
  7657. <code lang="XML" escaped="true">
  7658. <configuration>
  7659. <appSettings>
  7660. <add key="log4net-config-file" value="log.config"/>
  7661. </appSettings>
  7662. </configuration>
  7663. </code>
  7664. </remarks>
  7665. </member>
  7666. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.Uri)">
  7667. <summary>
  7668. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  7669. URI.
  7670. </summary>
  7671. <param name="repository">The repository to configure.</param>
  7672. <param name="configUri">A URI to load the XML configuration from.</param>
  7673. <remarks>
  7674. <para>
  7675. The configuration data must be valid XML. It must contain
  7676. at least one element called <c>log4net</c> that holds
  7677. the configuration data.
  7678. </para>
  7679. <para>
  7680. The <see cref="T:System.Net.WebRequest"/> must support the URI scheme specified.
  7681. </para>
  7682. </remarks>
  7683. </member>
  7684. <member name="M:log4net.Config.XmlConfigurator.Configure(log4net.Repository.ILoggerRepository,System.IO.Stream)">
  7685. <summary>
  7686. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the specified configuration
  7687. file.
  7688. </summary>
  7689. <param name="repository">The repository to configure.</param>
  7690. <param name="configStream">The stream to load the XML configuration from.</param>
  7691. <remarks>
  7692. <para>
  7693. The configuration data must be valid XML. It must contain
  7694. at least one element called <c>log4net</c> that holds
  7695. the configuration data.
  7696. </para>
  7697. <para>
  7698. Note that this method will NOT close the stream parameter.
  7699. </para>
  7700. </remarks>
  7701. </member>
  7702. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatch(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  7703. <summary>
  7704. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> using the file specified,
  7705. monitors the file for changes and reloads the configuration if a change
  7706. is detected.
  7707. </summary>
  7708. <param name="repository">The repository to configure.</param>
  7709. <param name="configFile">The XML file to load the configuration from.</param>
  7710. <remarks>
  7711. <para>
  7712. The configuration file must be valid XML. It must contain
  7713. at least one element called <c>log4net</c> that holds
  7714. the configuration data.
  7715. </para>
  7716. <para>
  7717. The configuration file will be monitored using a <see cref="T:System.IO.FileSystemWatcher"/>
  7718. and depends on the behavior of that class.
  7719. </para>
  7720. <para>
  7721. For more information on how to configure log4net using
  7722. a separate configuration file, see <see cref="M:Configure(FileInfo)"/>.
  7723. </para>
  7724. </remarks>
  7725. <seealso cref="M:Configure(FileInfo)"/>
  7726. </member>
  7727. <member name="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler">
  7728. <summary>
  7729. Class used to watch config files.
  7730. </summary>
  7731. <remarks>
  7732. <para>
  7733. Uses the <see cref="T:System.IO.FileSystemWatcher"/> to monitor
  7734. changes to a specified file. Because multiple change notifications
  7735. may be raised when the file is modified, a timer is used to
  7736. compress the notifications into a single event. The timer
  7737. waits for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> time before delivering
  7738. the event notification. If any further <see cref="T:System.IO.FileSystemWatcher"/>
  7739. change notifications arrive while the timer is waiting it
  7740. is reset and waits again for <see cref="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis"/> to
  7741. elapse.
  7742. </para>
  7743. </remarks>
  7744. </member>
  7745. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_configFile">
  7746. <summary>
  7747. Holds the FileInfo used to configure the XmlConfigurator
  7748. </summary>
  7749. </member>
  7750. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_repository">
  7751. <summary>
  7752. Holds the repository being configured.
  7753. </summary>
  7754. </member>
  7755. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_timer">
  7756. <summary>
  7757. The timer used to compress the notification events.
  7758. </summary>
  7759. </member>
  7760. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.TimeoutMillis">
  7761. <summary>
  7762. The default amount of time to wait after receiving notification
  7763. before reloading the config file.
  7764. </summary>
  7765. </member>
  7766. <member name="F:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.m_watcher">
  7767. <summary>
  7768. Watches file for changes. This object should be disposed when no longer
  7769. needed to free system handles on the watched resources.
  7770. </summary>
  7771. </member>
  7772. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.#ctor(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  7773. <summary>
  7774. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler" /> class to
  7775. watch a specified config file used to configure a repository.
  7776. </summary>
  7777. <param name="repository">The repository to configure.</param>
  7778. <param name="configFile">The configuration file to watch.</param>
  7779. <remarks>
  7780. <para>
  7781. Initializes a new instance of the <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler" /> class.
  7782. </para>
  7783. </remarks>
  7784. </member>
  7785. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnChanged(System.Object,System.IO.FileSystemEventArgs)">
  7786. <summary>
  7787. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  7788. </summary>
  7789. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  7790. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  7791. <remarks>
  7792. <para>
  7793. This handler reloads the configuration from the file when the event is fired.
  7794. </para>
  7795. </remarks>
  7796. </member>
  7797. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.ConfigureAndWatchHandler_OnRenamed(System.Object,System.IO.RenamedEventArgs)">
  7798. <summary>
  7799. Event handler used by <see cref="T:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler"/>.
  7800. </summary>
  7801. <param name="source">The <see cref="T:System.IO.FileSystemWatcher"/> firing the event.</param>
  7802. <param name="e">The argument indicates the file that caused the event to be fired.</param>
  7803. <remarks>
  7804. <para>
  7805. This handler reloads the configuration from the file when the event is fired.
  7806. </para>
  7807. </remarks>
  7808. </member>
  7809. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.OnWatchedFileChange(System.Object)">
  7810. <summary>
  7811. Called by the timer when the configuration has been updated.
  7812. </summary>
  7813. <param name="state">null</param>
  7814. </member>
  7815. <member name="M:log4net.Config.XmlConfigurator.ConfigureAndWatchHandler.Dispose">
  7816. <summary>
  7817. Release the handles held by the watcher and timer.
  7818. </summary>
  7819. </member>
  7820. <member name="M:log4net.Config.XmlConfigurator.InternalConfigureFromXml(log4net.Repository.ILoggerRepository,System.Xml.XmlElement)">
  7821. <summary>
  7822. Configures the specified repository using a <c>log4net</c> element.
  7823. </summary>
  7824. <param name="repository">The hierarchy to configure.</param>
  7825. <param name="element">The element to parse.</param>
  7826. <remarks>
  7827. <para>
  7828. Loads the log4net configuration from the XML element
  7829. supplied as <paramref name="element"/>.
  7830. </para>
  7831. <para>
  7832. This method is ultimately called by one of the Configure methods
  7833. to load the configuration from an <see cref="T:System.Xml.XmlElement"/>.
  7834. </para>
  7835. </remarks>
  7836. </member>
  7837. <member name="F:log4net.Config.XmlConfigurator.m_repositoryName2ConfigAndWatchHandler">
  7838. <summary>
  7839. Maps repository names to ConfigAndWatchHandler instances to allow a particular
  7840. ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is
  7841. reconfigured.
  7842. </summary>
  7843. </member>
  7844. <member name="F:log4net.Config.XmlConfigurator.declaringType">
  7845. <summary>
  7846. The fully qualified type of the XmlConfigurator class.
  7847. </summary>
  7848. <remarks>
  7849. Used by the internal logger to record the Type of the
  7850. log message.
  7851. </remarks>
  7852. </member>
  7853. <member name="T:log4net.Config.XmlConfiguratorAttribute">
  7854. <summary>
  7855. Assembly level attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>.
  7856. </summary>
  7857. <remarks>
  7858. <para>
  7859. This attribute may only be used at the assembly scope and can only
  7860. be used once per assembly.
  7861. </para>
  7862. <para>
  7863. Use this attribute to configure the <see cref="T:log4net.Config.XmlConfigurator"/>
  7864. without calling one of the <see cref="M:XmlConfigurator.Configure()"/>
  7865. methods.
  7866. </para>
  7867. <para>
  7868. If neither of the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>
  7869. properties are set the configuration is loaded from the application's .config file.
  7870. If set the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property takes priority over the
  7871. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> property
  7872. specifies a path to a file to load the config from. The path is relative to the
  7873. application's base directory; <see cref="!:AppDomain.BaseDirectory"/>.
  7874. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> property is used as a postfix to the assembly file name.
  7875. The config file must be located in the application's base directory; <see cref="!:AppDomain.BaseDirectory"/>.
  7876. For example in a console application setting the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> to
  7877. <c>config</c> has the same effect as not specifying the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> or
  7878. <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> properties.
  7879. </para>
  7880. <para>
  7881. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.Watch"/> property can be set to cause the <see cref="T:log4net.Config.XmlConfigurator"/>
  7882. to watch the configuration file for changes.
  7883. </para>
  7884. <note>
  7885. <para>
  7886. Log4net will only look for assembly level configuration attributes once.
  7887. When using the log4net assembly level attributes to control the configuration
  7888. of log4net you must ensure that the first call to any of the
  7889. <see cref="T:log4net.Core.LoggerManager"/> methods is made from the assembly with the configuration
  7890. attributes.
  7891. </para>
  7892. <para>
  7893. If you cannot guarantee the order in which log4net calls will be made from
  7894. different assemblies you must use programmatic configuration instead, i.e.
  7895. call the <see cref="M:XmlConfigurator.Configure()"/> method directly.
  7896. </para>
  7897. </note>
  7898. </remarks>
  7899. <author>Nicko Cadell</author>
  7900. <author>Gert Driesen</author>
  7901. </member>
  7902. <member name="M:log4net.Config.XmlConfiguratorAttribute.#ctor">
  7903. <summary>
  7904. Default constructor
  7905. </summary>
  7906. <remarks>
  7907. <para>
  7908. Default constructor
  7909. </para>
  7910. </remarks>
  7911. </member>
  7912. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile">
  7913. <summary>
  7914. Gets or sets the filename of the configuration file.
  7915. </summary>
  7916. <value>
  7917. The filename of the configuration file.
  7918. </value>
  7919. <remarks>
  7920. <para>
  7921. If specified, this is the name of the configuration file to use with
  7922. the <see cref="T:log4net.Config.XmlConfigurator"/>. This file path is relative to the
  7923. <b>application base</b> directory (<see cref="!:AppDomain.BaseDirectory"/>).
  7924. </para>
  7925. <para>
  7926. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  7927. </para>
  7928. </remarks>
  7929. </member>
  7930. <member name="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension">
  7931. <summary>
  7932. Gets or sets the extension of the configuration file.
  7933. </summary>
  7934. <value>
  7935. The extension of the configuration file.
  7936. </value>
  7937. <remarks>
  7938. <para>
  7939. If specified this is the extension for the configuration file.
  7940. The path to the config file is built by using the <b>application
  7941. base</b> directory (<see cref="!:AppDomain.BaseDirectory"/>),
  7942. the <b>assembly file name</b> and the config file extension.
  7943. </para>
  7944. <para>
  7945. If the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/> is set to <c>MyExt</c> then
  7946. possible config file names would be: <c>MyConsoleApp.exe.MyExt</c> or
  7947. <c>MyClassLibrary.dll.MyExt</c>.
  7948. </para>
  7949. <para>
  7950. The <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFile"/> takes priority over the <see cref="P:log4net.Config.XmlConfiguratorAttribute.ConfigFileExtension"/>.
  7951. </para>
  7952. </remarks>
  7953. </member>
  7954. <member name="P:log4net.Config.XmlConfiguratorAttribute.Watch">
  7955. <summary>
  7956. Gets or sets a value indicating whether to watch the configuration file.
  7957. </summary>
  7958. <value>
  7959. <c>true</c> if the configuration should be watched, <c>false</c> otherwise.
  7960. </value>
  7961. <remarks>
  7962. <para>
  7963. If this flag is specified and set to <c>true</c> then the framework
  7964. will watch the configuration file and will reload the config each time
  7965. the file is modified.
  7966. </para>
  7967. <para>
  7968. The config file can only be watched if it is loaded from local disk.
  7969. In a No-Touch (Smart Client) deployment where the application is downloaded
  7970. from a web server the config file may not reside on the local disk
  7971. and therefore it may not be able to watch it.
  7972. </para>
  7973. <note>
  7974. Watching configuration is not supported on the SSCLI.
  7975. </note>
  7976. </remarks>
  7977. </member>
  7978. <member name="M:log4net.Config.XmlConfiguratorAttribute.Configure(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  7979. <summary>
  7980. Configures the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  7981. </summary>
  7982. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  7983. <param name="targetRepository">The repository to configure.</param>
  7984. <remarks>
  7985. <para>
  7986. Configure the repository using the <see cref="T:log4net.Config.XmlConfigurator"/>.
  7987. The <paramref name="targetRepository"/> specified must extend the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  7988. class otherwise the <see cref="T:log4net.Config.XmlConfigurator"/> will not be able to
  7989. configure it.
  7990. </para>
  7991. </remarks>
  7992. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="targetRepository" /> does not extend <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.</exception>
  7993. </member>
  7994. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  7995. <summary>
  7996. Attempt to load configuration from the local file system
  7997. </summary>
  7998. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  7999. <param name="targetRepository">The repository to configure.</param>
  8000. </member>
  8001. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromFile(log4net.Repository.ILoggerRepository,System.IO.FileInfo)">
  8002. <summary>
  8003. Configure the specified repository using a <see cref="T:System.IO.FileInfo"/>
  8004. </summary>
  8005. <param name="targetRepository">The repository to configure.</param>
  8006. <param name="configFile">the FileInfo pointing to the config file</param>
  8007. </member>
  8008. <member name="M:log4net.Config.XmlConfiguratorAttribute.ConfigureFromUri(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8009. <summary>
  8010. Attempt to load configuration from a URI
  8011. </summary>
  8012. <param name="sourceAssembly">The assembly that this attribute was defined on.</param>
  8013. <param name="targetRepository">The repository to configure.</param>
  8014. </member>
  8015. <member name="F:log4net.Config.XmlConfiguratorAttribute.declaringType">
  8016. <summary>
  8017. The fully qualified type of the XmlConfiguratorAttribute class.
  8018. </summary>
  8019. <remarks>
  8020. Used by the internal logger to record the Type of the
  8021. log message.
  8022. </remarks>
  8023. </member>
  8024. <member name="T:log4net.Core.CompactRepositorySelector">
  8025. <summary>
  8026. The implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface suitable
  8027. for use with the compact framework
  8028. </summary>
  8029. <remarks>
  8030. <para>
  8031. This <see cref="T:log4net.Core.IRepositorySelector"/> implementation is a simple
  8032. mapping between repository name and <see cref="T:log4net.Repository.ILoggerRepository"/>
  8033. object.
  8034. </para>
  8035. <para>
  8036. The .NET Compact Framework 1.0 does not support retrieving assembly
  8037. level attributes therefore unlike the <c>DefaultRepositorySelector</c>
  8038. this selector does not examine the calling assembly for attributes.
  8039. </para>
  8040. </remarks>
  8041. <author>Nicko Cadell</author>
  8042. </member>
  8043. <member name="M:log4net.Core.CompactRepositorySelector.#ctor(System.Type)">
  8044. <summary>
  8045. Create a new repository selector
  8046. </summary>
  8047. <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  8048. <remarks>
  8049. <para>
  8050. Create an new compact repository selector.
  8051. The default type for repositories must be specified,
  8052. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8053. </para>
  8054. </remarks>
  8055. <exception cref="T:System.ArgumentNullException">throw if <paramref name="defaultRepositoryType"/> is null</exception>
  8056. <exception cref="T:System.ArgumentOutOfRangeException">throw if <paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/></exception>
  8057. </member>
  8058. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.Reflection.Assembly)">
  8059. <summary>
  8060. Get the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly
  8061. </summary>
  8062. <param name="assembly">not used</param>
  8063. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  8064. <remarks>
  8065. <para>
  8066. The <paramref name="assembly"/> argument is not used. This selector does not create a
  8067. separate repository for each assembly.
  8068. </para>
  8069. <para>
  8070. As a named repository is not specified the default repository is
  8071. returned. The default repository is named <c>log4net-default-repository</c>.
  8072. </para>
  8073. </remarks>
  8074. </member>
  8075. <member name="M:log4net.Core.CompactRepositorySelector.GetRepository(System.String)">
  8076. <summary>
  8077. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>
  8078. </summary>
  8079. <param name="repositoryName">the name of the repository to lookup</param>
  8080. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  8081. <remarks>
  8082. <para>
  8083. Get the named <see cref="T:log4net.Repository.ILoggerRepository"/>. The default
  8084. repository is <c>log4net-default-repository</c>. Other repositories
  8085. must be created using the <see cref="M:CreateRepository(string, Type)"/>.
  8086. If the named repository does not exist an exception is thrown.
  8087. </para>
  8088. </remarks>
  8089. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  8090. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> does not exist</exception>
  8091. </member>
  8092. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  8093. <summary>
  8094. Create a new repository for the assembly specified
  8095. </summary>
  8096. <param name="assembly">not used</param>
  8097. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  8098. <returns>the repository created</returns>
  8099. <remarks>
  8100. <para>
  8101. The <paramref name="assembly"/> argument is not used. This selector does not create a
  8102. separate repository for each assembly.
  8103. </para>
  8104. <para>
  8105. If the <paramref name="repositoryType"/> is <c>null</c> then the
  8106. default repository type specified to the constructor is used.
  8107. </para>
  8108. <para>
  8109. As a named repository is not specified the default repository is
  8110. returned. The default repository is named <c>log4net-default-repository</c>.
  8111. </para>
  8112. </remarks>
  8113. </member>
  8114. <member name="M:log4net.Core.CompactRepositorySelector.CreateRepository(System.String,System.Type)">
  8115. <summary>
  8116. Create a new repository for the repository specified
  8117. </summary>
  8118. <param name="repositoryName">the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  8119. <param name="repositoryType">the type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8120. If this param is null then the default repository type is used.</param>
  8121. <returns>the repository created</returns>
  8122. <remarks>
  8123. <para>
  8124. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  8125. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  8126. same repository specified will return the same repository instance.
  8127. </para>
  8128. <para>
  8129. If the named repository already exists an exception will be thrown.
  8130. </para>
  8131. <para>
  8132. If <paramref name="repositoryType"/> is <c>null</c> then the default
  8133. repository type specified to the constructor is used.
  8134. </para>
  8135. </remarks>
  8136. <exception cref="T:System.ArgumentNullException">throw if <paramref name="repositoryName"/> is null</exception>
  8137. <exception cref="T:log4net.Core.LogException">throw if the <paramref name="repositoryName"/> already exists</exception>
  8138. </member>
  8139. <member name="M:log4net.Core.CompactRepositorySelector.ExistsRepository(System.String)">
  8140. <summary>
  8141. Test if a named repository exists
  8142. </summary>
  8143. <param name="repositoryName">the named repository to check</param>
  8144. <returns><c>true</c> if the repository exists</returns>
  8145. <remarks>
  8146. <para>
  8147. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  8148. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  8149. a repository.
  8150. </para>
  8151. </remarks>
  8152. </member>
  8153. <member name="M:log4net.Core.CompactRepositorySelector.GetAllRepositories">
  8154. <summary>
  8155. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  8156. </summary>
  8157. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  8158. <remarks>
  8159. <para>
  8160. Gets an array of all of the repositories created by this selector.
  8161. </para>
  8162. </remarks>
  8163. </member>
  8164. <member name="F:log4net.Core.CompactRepositorySelector.declaringType">
  8165. <summary>
  8166. The fully qualified type of the CompactRepositorySelector class.
  8167. </summary>
  8168. <remarks>
  8169. Used by the internal logger to record the Type of the
  8170. log message.
  8171. </remarks>
  8172. </member>
  8173. <member name="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">
  8174. <summary>
  8175. Event to notify that a logger repository has been created.
  8176. </summary>
  8177. <value>
  8178. Event to notify that a logger repository has been created.
  8179. </value>
  8180. <remarks>
  8181. <para>
  8182. Event raised when a new repository is created.
  8183. The event source will be this selector. The event args will
  8184. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  8185. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8186. </para>
  8187. </remarks>
  8188. </member>
  8189. <member name="M:log4net.Core.CompactRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  8190. <summary>
  8191. Notify the registered listeners that the repository has been created
  8192. </summary>
  8193. <param name="repository">The repository that has been created</param>
  8194. <remarks>
  8195. <para>
  8196. Raises the <event cref="E:log4net.Core.CompactRepositorySelector.LoggerRepositoryCreatedEvent">LoggerRepositoryCreatedEvent</event>
  8197. event.
  8198. </para>
  8199. </remarks>
  8200. </member>
  8201. <member name="T:log4net.Core.DefaultRepositorySelector">
  8202. <summary>
  8203. The default implementation of the <see cref="T:log4net.Core.IRepositorySelector"/> interface.
  8204. </summary>
  8205. <remarks>
  8206. <para>
  8207. Uses attributes defined on the calling assembly to determine how to
  8208. configure the hierarchy for the repository.
  8209. </para>
  8210. </remarks>
  8211. <author>Nicko Cadell</author>
  8212. <author>Gert Driesen</author>
  8213. </member>
  8214. <member name="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent">
  8215. <summary>
  8216. Event to notify that a logger repository has been created.
  8217. </summary>
  8218. <value>
  8219. Event to notify that a logger repository has been created.
  8220. </value>
  8221. <remarks>
  8222. <para>
  8223. Event raised when a new repository is created.
  8224. The event source will be this selector. The event args will
  8225. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  8226. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8227. </para>
  8228. </remarks>
  8229. </member>
  8230. <member name="M:log4net.Core.DefaultRepositorySelector.#ctor(System.Type)">
  8231. <summary>
  8232. Creates a new repository selector.
  8233. </summary>
  8234. <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  8235. <remarks>
  8236. <para>
  8237. Create an new repository selector.
  8238. The default type for repositories must be specified,
  8239. an appropriate value would be <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>.
  8240. </para>
  8241. </remarks>
  8242. <exception cref="T:System.ArgumentNullException"><paramref name="defaultRepositoryType"/> is <see langword="null" />.</exception>
  8243. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="defaultRepositoryType"/> does not implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</exception>
  8244. </member>
  8245. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.Reflection.Assembly)">
  8246. <summary>
  8247. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  8248. </summary>
  8249. <param name="repositoryAssembly">The assembly use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8250. <remarks>
  8251. <para>
  8252. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and the repository
  8253. to create can be overridden by specifying the <see cref="T:log4net.Config.RepositoryAttribute"/>
  8254. attribute on the <paramref name="repositoryAssembly"/>.
  8255. </para>
  8256. <para>
  8257. The default values are to use the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/>
  8258. implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  8259. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  8260. </para>
  8261. <para>
  8262. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically configured using
  8263. any <see cref="T:log4net.Config.ConfiguratorAttribute"/> attributes defined on
  8264. the <paramref name="repositoryAssembly"/>.
  8265. </para>
  8266. </remarks>
  8267. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly</returns>
  8268. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  8269. </member>
  8270. <member name="M:log4net.Core.DefaultRepositorySelector.GetRepository(System.String)">
  8271. <summary>
  8272. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.
  8273. </summary>
  8274. <param name="repositoryName">The repository to use to lookup the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8275. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified repository.</returns>
  8276. <remarks>
  8277. <para>
  8278. Returns the named repository. If <paramref name="repositoryName"/> is <c>null</c>
  8279. a <see cref="T:System.ArgumentNullException"/> is thrown. If the repository
  8280. does not exist a <see cref="T:log4net.Core.LogException"/> is thrown.
  8281. </para>
  8282. <para>
  8283. Use <see cref="M:CreateRepository(string, Type)"/> to create a repository.
  8284. </para>
  8285. </remarks>
  8286. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null" />.</exception>
  8287. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> does not exist.</exception>
  8288. </member>
  8289. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  8290. <summary>
  8291. Create a new repository for the assembly specified
  8292. </summary>
  8293. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8294. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8295. <returns>The repository created.</returns>
  8296. <remarks>
  8297. <para>
  8298. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  8299. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  8300. same assembly specified will return the same repository instance.
  8301. </para>
  8302. <para>
  8303. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  8304. the repository to create can be overridden by specifying the
  8305. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  8306. <paramref name="repositoryAssembly"/>. The default values are to use the
  8307. <paramref name="repositoryType"/> implementation of the
  8308. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  8309. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  8310. </para>
  8311. <para>
  8312. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  8313. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  8314. attributes defined on the <paramref name="repositoryAssembly"/>.
  8315. </para>
  8316. <para>
  8317. If a repository for the <paramref name="repositoryAssembly"/> already exists
  8318. that repository will be returned. An error will not be raised and that
  8319. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  8320. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  8321. assembly may be used to override the repository type specified in
  8322. <paramref name="repositoryType"/>.
  8323. </para>
  8324. </remarks>
  8325. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  8326. </member>
  8327. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type,System.String,System.Boolean)">
  8328. <summary>
  8329. Creates a new repository for the assembly specified.
  8330. </summary>
  8331. <param name="repositoryAssembly">the assembly to use to create the repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8332. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8333. <param name="repositoryName">The name to assign to the created repository</param>
  8334. <param name="readAssemblyAttributes">Set to <c>true</c> to read and apply the assembly attributes</param>
  8335. <returns>The repository created.</returns>
  8336. <remarks>
  8337. <para>
  8338. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  8339. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  8340. same assembly specified will return the same repository instance.
  8341. </para>
  8342. <para>
  8343. The type of the <see cref="T:log4net.Repository.ILoggerRepository"/> created and
  8344. the repository to create can be overridden by specifying the
  8345. <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  8346. <paramref name="repositoryAssembly"/>. The default values are to use the
  8347. <paramref name="repositoryType"/> implementation of the
  8348. <see cref="T:log4net.Repository.ILoggerRepository"/> interface and to use the
  8349. <see cref="P:System.Reflection.AssemblyName.Name"/> as the name of the repository.
  8350. </para>
  8351. <para>
  8352. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be automatically
  8353. configured using any <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  8354. attributes defined on the <paramref name="repositoryAssembly"/>.
  8355. </para>
  8356. <para>
  8357. If a repository for the <paramref name="repositoryAssembly"/> already exists
  8358. that repository will be returned. An error will not be raised and that
  8359. repository may be of a different type to that specified in <paramref name="repositoryType"/>.
  8360. Also the <see cref="T:log4net.Config.RepositoryAttribute"/> attribute on the
  8361. assembly may be used to override the repository type specified in
  8362. <paramref name="repositoryType"/>.
  8363. </para>
  8364. </remarks>
  8365. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryAssembly"/> is <see langword="null" />.</exception>
  8366. </member>
  8367. <member name="M:log4net.Core.DefaultRepositorySelector.CreateRepository(System.String,System.Type)">
  8368. <summary>
  8369. Creates a new repository for the specified repository.
  8370. </summary>
  8371. <param name="repositoryName">The repository to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  8372. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8373. If this param is <see langword="null" /> then the default repository type is used.</param>
  8374. <returns>The new repository.</returns>
  8375. <remarks>
  8376. <para>
  8377. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  8378. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  8379. same repository specified will return the same repository instance.
  8380. </para>
  8381. </remarks>
  8382. <exception cref="T:System.ArgumentNullException"><paramref name="repositoryName"/> is <see langword="null" />.</exception>
  8383. <exception cref="T:log4net.Core.LogException"><paramref name="repositoryName"/> already exists.</exception>
  8384. </member>
  8385. <member name="M:log4net.Core.DefaultRepositorySelector.ExistsRepository(System.String)">
  8386. <summary>
  8387. Test if a named repository exists
  8388. </summary>
  8389. <param name="repositoryName">the named repository to check</param>
  8390. <returns><c>true</c> if the repository exists</returns>
  8391. <remarks>
  8392. <para>
  8393. Test if a named repository exists. Use <see cref="M:CreateRepository(string, Type)"/>
  8394. to create a new repository and <see cref="M:GetRepository(string)"/> to retrieve
  8395. a repository.
  8396. </para>
  8397. </remarks>
  8398. </member>
  8399. <member name="M:log4net.Core.DefaultRepositorySelector.GetAllRepositories">
  8400. <summary>
  8401. Gets a list of <see cref="T:log4net.Repository.ILoggerRepository"/> objects
  8402. </summary>
  8403. <returns>an array of all known <see cref="T:log4net.Repository.ILoggerRepository"/> objects</returns>
  8404. <remarks>
  8405. <para>
  8406. Gets an array of all of the repositories created by this selector.
  8407. </para>
  8408. </remarks>
  8409. </member>
  8410. <member name="M:log4net.Core.DefaultRepositorySelector.AliasRepository(System.String,log4net.Repository.ILoggerRepository)">
  8411. <summary>
  8412. Aliases a repository to an existing repository.
  8413. </summary>
  8414. <param name="repositoryAlias">The repository to alias.</param>
  8415. <param name="repositoryTarget">The repository that the repository is aliased to.</param>
  8416. <remarks>
  8417. <para>
  8418. The repository specified will be aliased to the repository when created.
  8419. The repository must not already exist.
  8420. </para>
  8421. <para>
  8422. When the repository is created it must utilize the same repository type as
  8423. the repository it is aliased to, otherwise the aliasing will fail.
  8424. </para>
  8425. </remarks>
  8426. <exception cref="T:System.ArgumentNullException">
  8427. <para><paramref name="repositoryAlias" /> is <see langword="null" />.</para>
  8428. <para>-or-</para>
  8429. <para><paramref name="repositoryTarget" /> is <see langword="null" />.</para>
  8430. </exception>
  8431. </member>
  8432. <member name="M:log4net.Core.DefaultRepositorySelector.OnLoggerRepositoryCreatedEvent(log4net.Repository.ILoggerRepository)">
  8433. <summary>
  8434. Notifies the registered listeners that the repository has been created.
  8435. </summary>
  8436. <param name="repository">The repository that has been created.</param>
  8437. <remarks>
  8438. <para>
  8439. Raises the <see cref="E:log4net.Core.DefaultRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  8440. </para>
  8441. </remarks>
  8442. </member>
  8443. <member name="M:log4net.Core.DefaultRepositorySelector.GetInfoForAssembly(System.Reflection.Assembly,System.String@,System.Type@)">
  8444. <summary>
  8445. Gets the repository name and repository type for the specified assembly.
  8446. </summary>
  8447. <param name="assembly">The assembly that has a <see cref="T:log4net.Config.RepositoryAttribute"/>.</param>
  8448. <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>
  8449. <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>
  8450. <exception cref="T:System.ArgumentNullException"><paramref name="assembly" /> is <see langword="null" />.</exception>
  8451. </member>
  8452. <member name="M:log4net.Core.DefaultRepositorySelector.ConfigureRepository(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8453. <summary>
  8454. Configures the repository using information from the assembly.
  8455. </summary>
  8456. <param name="assembly">The assembly containing <see cref="T:log4net.Config.ConfiguratorAttribute"/>
  8457. attributes which define the configuration for the repository.</param>
  8458. <param name="repository">The repository to configure.</param>
  8459. <exception cref="T:System.ArgumentNullException">
  8460. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  8461. <para>-or-</para>
  8462. <para><paramref name="repository" /> is <see langword="null" />.</para>
  8463. </exception>
  8464. </member>
  8465. <member name="M:log4net.Core.DefaultRepositorySelector.LoadPlugins(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8466. <summary>
  8467. Loads the attribute defined plugins on the assembly.
  8468. </summary>
  8469. <param name="assembly">The assembly that contains the attributes.</param>
  8470. <param name="repository">The repository to add the plugins to.</param>
  8471. <exception cref="T:System.ArgumentNullException">
  8472. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  8473. <para>-or-</para>
  8474. <para><paramref name="repository" /> is <see langword="null" />.</para>
  8475. </exception>
  8476. </member>
  8477. <member name="M:log4net.Core.DefaultRepositorySelector.LoadAliases(System.Reflection.Assembly,log4net.Repository.ILoggerRepository)">
  8478. <summary>
  8479. Loads the attribute defined aliases on the assembly.
  8480. </summary>
  8481. <param name="assembly">The assembly that contains the attributes.</param>
  8482. <param name="repository">The repository to alias to.</param>
  8483. <exception cref="T:System.ArgumentNullException">
  8484. <para><paramref name="assembly" /> is <see langword="null" />.</para>
  8485. <para>-or-</para>
  8486. <para><paramref name="repository" /> is <see langword="null" />.</para>
  8487. </exception>
  8488. </member>
  8489. <member name="F:log4net.Core.DefaultRepositorySelector.declaringType">
  8490. <summary>
  8491. The fully qualified type of the DefaultRepositorySelector class.
  8492. </summary>
  8493. <remarks>
  8494. Used by the internal logger to record the Type of the
  8495. log message.
  8496. </remarks>
  8497. </member>
  8498. <member name="T:log4net.Core.ErrorCode">
  8499. <summary>
  8500. Defined error codes that can be passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  8501. </summary>
  8502. <remarks>
  8503. <para>
  8504. Values passed to the <see cref="M:IErrorHandler.Error(string, Exception, ErrorCode)"/> method.
  8505. </para>
  8506. </remarks>
  8507. <author>Nicko Cadell</author>
  8508. </member>
  8509. <member name="F:log4net.Core.ErrorCode.GenericFailure">
  8510. <summary>
  8511. A general error
  8512. </summary>
  8513. </member>
  8514. <member name="F:log4net.Core.ErrorCode.WriteFailure">
  8515. <summary>
  8516. Error while writing output
  8517. </summary>
  8518. </member>
  8519. <member name="F:log4net.Core.ErrorCode.FlushFailure">
  8520. <summary>
  8521. Failed to flush file
  8522. </summary>
  8523. </member>
  8524. <member name="F:log4net.Core.ErrorCode.CloseFailure">
  8525. <summary>
  8526. Failed to close file
  8527. </summary>
  8528. </member>
  8529. <member name="F:log4net.Core.ErrorCode.FileOpenFailure">
  8530. <summary>
  8531. Unable to open output file
  8532. </summary>
  8533. </member>
  8534. <member name="F:log4net.Core.ErrorCode.MissingLayout">
  8535. <summary>
  8536. No layout specified
  8537. </summary>
  8538. </member>
  8539. <member name="F:log4net.Core.ErrorCode.AddressParseFailure">
  8540. <summary>
  8541. Failed to parse address
  8542. </summary>
  8543. </member>
  8544. <member name="T:log4net.Core.ExceptionEvaluator">
  8545. <summary>
  8546. An evaluator that triggers on an Exception type
  8547. </summary>
  8548. <remarks>
  8549. <para>
  8550. This evaluator will trigger if the type of the Exception
  8551. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  8552. is equal to a Type in <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>. ///
  8553. </para>
  8554. </remarks>
  8555. <author>Drew Schaeffer</author>
  8556. </member>
  8557. <member name="F:log4net.Core.ExceptionEvaluator.m_type">
  8558. <summary>
  8559. The type that causes the trigger to fire.
  8560. </summary>
  8561. </member>
  8562. <member name="F:log4net.Core.ExceptionEvaluator.m_triggerOnSubclass">
  8563. <summary>
  8564. Causes subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/> to cause the trigger to fire.
  8565. </summary>
  8566. </member>
  8567. <member name="M:log4net.Core.ExceptionEvaluator.#ctor">
  8568. <summary>
  8569. Default ctor to allow dynamic creation through a configurator.
  8570. </summary>
  8571. </member>
  8572. <member name="M:log4net.Core.ExceptionEvaluator.#ctor(System.Type,System.Boolean)">
  8573. <summary>
  8574. Constructs an evaluator and initializes to trigger on <paramref name="exType"/>
  8575. </summary>
  8576. <param name="exType">the type that triggers this evaluator.</param>
  8577. <param name="triggerOnSubClass">If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.</param>
  8578. </member>
  8579. <member name="P:log4net.Core.ExceptionEvaluator.ExceptionType">
  8580. <summary>
  8581. The type that triggers this evaluator.
  8582. </summary>
  8583. </member>
  8584. <member name="P:log4net.Core.ExceptionEvaluator.TriggerOnSubclass">
  8585. <summary>
  8586. If true, this evaluator will trigger on subclasses of <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  8587. </summary>
  8588. </member>
  8589. <member name="M:log4net.Core.ExceptionEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  8590. <summary>
  8591. Is this <paramref name="loggingEvent"/> the triggering event?
  8592. </summary>
  8593. <param name="loggingEvent">The event to check</param>
  8594. <returns>This method returns <c>true</c>, if the logging event Exception
  8595. Type is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  8596. Otherwise it returns <c>false</c></returns>
  8597. <remarks>
  8598. <para>
  8599. This evaluator will trigger if the Exception Type of the event
  8600. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  8601. is <see cref="P:log4net.Core.ExceptionEvaluator.ExceptionType"/>.
  8602. </para>
  8603. </remarks>
  8604. </member>
  8605. <member name="T:log4net.Core.IAppenderAttachable">
  8606. <summary>
  8607. Interface for attaching appenders to objects.
  8608. </summary>
  8609. <remarks>
  8610. <para>
  8611. Interface for attaching, removing and retrieving appenders.
  8612. </para>
  8613. </remarks>
  8614. <author>Nicko Cadell</author>
  8615. <author>Gert Driesen</author>
  8616. </member>
  8617. <member name="M:log4net.Core.IAppenderAttachable.AddAppender(log4net.Appender.IAppender)">
  8618. <summary>
  8619. Attaches an appender.
  8620. </summary>
  8621. <param name="appender">The appender to add.</param>
  8622. <remarks>
  8623. <para>
  8624. Add the specified appender. The implementation may
  8625. choose to allow or deny duplicate appenders.
  8626. </para>
  8627. </remarks>
  8628. </member>
  8629. <member name="P:log4net.Core.IAppenderAttachable.Appenders">
  8630. <summary>
  8631. Gets all attached appenders.
  8632. </summary>
  8633. <value>
  8634. A collection of attached appenders.
  8635. </value>
  8636. <remarks>
  8637. <para>
  8638. Gets a collection of attached appenders.
  8639. If there are no attached appenders the
  8640. implementation should return an empty
  8641. collection rather than <c>null</c>.
  8642. </para>
  8643. </remarks>
  8644. </member>
  8645. <member name="M:log4net.Core.IAppenderAttachable.GetAppender(System.String)">
  8646. <summary>
  8647. Gets an attached appender with the specified name.
  8648. </summary>
  8649. <param name="name">The name of the appender to get.</param>
  8650. <returns>
  8651. The appender with the name specified, or <c>null</c> if no appender with the
  8652. specified name is found.
  8653. </returns>
  8654. <remarks>
  8655. <para>
  8656. Returns an attached appender with the <paramref name="name"/> specified.
  8657. If no appender with the specified name is found <c>null</c> will be
  8658. returned.
  8659. </para>
  8660. </remarks>
  8661. </member>
  8662. <member name="M:log4net.Core.IAppenderAttachable.RemoveAllAppenders">
  8663. <summary>
  8664. Removes all attached appenders.
  8665. </summary>
  8666. <remarks>
  8667. <para>
  8668. Removes and closes all attached appenders
  8669. </para>
  8670. </remarks>
  8671. </member>
  8672. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(log4net.Appender.IAppender)">
  8673. <summary>
  8674. Removes the specified appender from the list of attached appenders.
  8675. </summary>
  8676. <param name="appender">The appender to remove.</param>
  8677. <returns>The appender removed from the list</returns>
  8678. <remarks>
  8679. <para>
  8680. The appender removed is not closed.
  8681. If you are discarding the appender you must call
  8682. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  8683. </para>
  8684. </remarks>
  8685. </member>
  8686. <member name="M:log4net.Core.IAppenderAttachable.RemoveAppender(System.String)">
  8687. <summary>
  8688. Removes the appender with the specified name from the list of appenders.
  8689. </summary>
  8690. <param name="name">The name of the appender to remove.</param>
  8691. <returns>The appender removed from the list</returns>
  8692. <remarks>
  8693. <para>
  8694. The appender removed is not closed.
  8695. If you are discarding the appender you must call
  8696. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  8697. </para>
  8698. </remarks>
  8699. </member>
  8700. <member name="T:log4net.Core.IErrorHandler">
  8701. <summary>
  8702. Appenders may delegate their error handling to an <see cref="T:log4net.Core.IErrorHandler" />.
  8703. </summary>
  8704. <remarks>
  8705. <para>
  8706. Error handling is a particularly tedious to get right because by
  8707. definition errors are hard to predict and to reproduce.
  8708. </para>
  8709. </remarks>
  8710. <author>Nicko Cadell</author>
  8711. <author>Gert Driesen</author>
  8712. </member>
  8713. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  8714. <summary>
  8715. Handles the error and information about the error condition is passed as
  8716. a parameter.
  8717. </summary>
  8718. <param name="message">The message associated with the error.</param>
  8719. <param name="e">The <see cref="T:System.Exception" /> that was thrown when the error occurred.</param>
  8720. <param name="errorCode">The error code associated with the error.</param>
  8721. <remarks>
  8722. <para>
  8723. Handles the error and information about the error condition is passed as
  8724. a parameter.
  8725. </para>
  8726. </remarks>
  8727. </member>
  8728. <member name="M:log4net.Core.IErrorHandler.Error(System.String,System.Exception)">
  8729. <summary>
  8730. Prints the error message passed as a parameter.
  8731. </summary>
  8732. <param name="message">The message associated with the error.</param>
  8733. <param name="e">The <see cref="T:System.Exception" /> that was thrown when the error occurred.</param>
  8734. <remarks>
  8735. <para>
  8736. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  8737. </para>
  8738. </remarks>
  8739. </member>
  8740. <member name="M:log4net.Core.IErrorHandler.Error(System.String)">
  8741. <summary>
  8742. Prints the error message passed as a parameter.
  8743. </summary>
  8744. <param name="message">The message associated with the error.</param>
  8745. <remarks>
  8746. <para>
  8747. See <see cref="M:Error(string,Exception,ErrorCode)"/>.
  8748. </para>
  8749. </remarks>
  8750. </member>
  8751. <member name="T:log4net.Core.IFixingRequired">
  8752. <summary>
  8753. Interface for objects that require fixing.
  8754. </summary>
  8755. <remarks>
  8756. <para>
  8757. Interface that indicates that the object requires fixing before it
  8758. can be taken outside the context of the appender's
  8759. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method.
  8760. </para>
  8761. <para>
  8762. When objects that implement this interface are stored
  8763. in the context properties maps <see cref="T:log4net.GlobalContext"/>
  8764. <see cref="P:log4net.GlobalContext.Properties"/> and <see cref="T:log4net.ThreadContext"/>
  8765. <see cref="P:log4net.ThreadContext.Properties"/> are fixed
  8766. (see <see cref="P:log4net.Core.LoggingEvent.Fix"/>) the <see cref="M:log4net.Core.IFixingRequired.GetFixedObject"/>
  8767. method will be called.
  8768. </para>
  8769. </remarks>
  8770. <author>Nicko Cadell</author>
  8771. </member>
  8772. <member name="M:log4net.Core.IFixingRequired.GetFixedObject">
  8773. <summary>
  8774. Get a portable version of this object
  8775. </summary>
  8776. <returns>the portable instance of this object</returns>
  8777. <remarks>
  8778. <para>
  8779. Get a portable instance object that represents the current
  8780. state of this object. The portable object can be stored
  8781. and logged from any thread with identical results.
  8782. </para>
  8783. </remarks>
  8784. </member>
  8785. <member name="T:log4net.Core.ILogger">
  8786. <summary>
  8787. Interface that all loggers implement
  8788. </summary>
  8789. <remarks>
  8790. <para>
  8791. This interface supports logging events and testing if a level
  8792. is enabled for logging.
  8793. </para>
  8794. <para>
  8795. These methods will not throw exceptions. Note to implementor, ensure
  8796. that the implementation of these methods cannot allow an exception
  8797. to be thrown to the caller.
  8798. </para>
  8799. </remarks>
  8800. <author>Nicko Cadell</author>
  8801. <author>Gert Driesen</author>
  8802. </member>
  8803. <member name="P:log4net.Core.ILogger.Name">
  8804. <summary>
  8805. Gets the name of the logger.
  8806. </summary>
  8807. <value>
  8808. The name of the logger.
  8809. </value>
  8810. <remarks>
  8811. <para>
  8812. The name of this logger
  8813. </para>
  8814. </remarks>
  8815. </member>
  8816. <member name="M:log4net.Core.ILogger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  8817. <summary>
  8818. This generic form is intended to be used by wrappers.
  8819. </summary>
  8820. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  8821. the stack boundary into the logging system for this call.</param>
  8822. <param name="level">The level of the message to be logged.</param>
  8823. <param name="message">The message object to log.</param>
  8824. <param name="exception">the exception to log, including its stack trace. Pass <c>null</c> to not log an exception.</param>
  8825. <remarks>
  8826. <para>
  8827. Generates a logging event for the specified <paramref name="level"/> using
  8828. the <paramref name="message"/> and <paramref name="exception"/>.
  8829. </para>
  8830. </remarks>
  8831. </member>
  8832. <member name="M:log4net.Core.ILogger.Log(log4net.Core.LoggingEvent)">
  8833. <summary>
  8834. This is the most generic printing method that is intended to be used
  8835. by wrappers.
  8836. </summary>
  8837. <param name="logEvent">The event being logged.</param>
  8838. <remarks>
  8839. <para>
  8840. Logs the specified logging event through this logger.
  8841. </para>
  8842. </remarks>
  8843. </member>
  8844. <member name="M:log4net.Core.ILogger.IsEnabledFor(log4net.Core.Level)">
  8845. <summary>
  8846. Checks if this logger is enabled for a given <see cref="T:log4net.Core.Level"/> passed as parameter.
  8847. </summary>
  8848. <param name="level">The level to check.</param>
  8849. <returns>
  8850. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  8851. </returns>
  8852. <remarks>
  8853. <para>
  8854. Test if this logger is going to log events of the specified <paramref name="level"/>.
  8855. </para>
  8856. </remarks>
  8857. </member>
  8858. <member name="P:log4net.Core.ILogger.Repository">
  8859. <summary>
  8860. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  8861. <c>Logger</c> instance is attached to.
  8862. </summary>
  8863. <value>
  8864. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this logger belongs to.
  8865. </value>
  8866. <remarks>
  8867. <para>
  8868. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  8869. <c>Logger</c> instance is attached to.
  8870. </para>
  8871. </remarks>
  8872. </member>
  8873. <member name="T:log4net.Core.ILoggerWrapper">
  8874. <summary>
  8875. Base interface for all wrappers
  8876. </summary>
  8877. <remarks>
  8878. <para>
  8879. Base interface for all wrappers.
  8880. </para>
  8881. <para>
  8882. All wrappers must implement this interface.
  8883. </para>
  8884. </remarks>
  8885. <author>Nicko Cadell</author>
  8886. </member>
  8887. <member name="P:log4net.Core.ILoggerWrapper.Logger">
  8888. <summary>
  8889. Get the implementation behind this wrapper object.
  8890. </summary>
  8891. <value>
  8892. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this object.
  8893. </value>
  8894. <remarks>
  8895. <para>
  8896. The <see cref="T:log4net.Core.ILogger"/> object that in implementing this
  8897. object. The <c>Logger</c> object may not
  8898. be the same object as this object because of logger decorators.
  8899. This gets the actual underlying objects that is used to process
  8900. the log events.
  8901. </para>
  8902. </remarks>
  8903. </member>
  8904. <member name="T:log4net.Core.IOptionHandler">
  8905. <summary>
  8906. Interface used to delay activate a configured object.
  8907. </summary>
  8908. <remarks>
  8909. <para>
  8910. This allows an object to defer activation of its options until all
  8911. options have been set. This is required for components which have
  8912. related options that remain ambiguous until all are set.
  8913. </para>
  8914. <para>
  8915. If a component implements this interface then the <see cref="M:log4net.Core.IOptionHandler.ActivateOptions"/> method
  8916. must be called by the container after its all the configured properties have been set
  8917. and before the component can be used.
  8918. </para>
  8919. </remarks>
  8920. <author>Nicko Cadell</author>
  8921. </member>
  8922. <member name="M:log4net.Core.IOptionHandler.ActivateOptions">
  8923. <summary>
  8924. Activate the options that were previously set with calls to properties.
  8925. </summary>
  8926. <remarks>
  8927. <para>
  8928. This allows an object to defer activation of its options until all
  8929. options have been set. This is required for components which have
  8930. related options that remain ambiguous until all are set.
  8931. </para>
  8932. <para>
  8933. If a component implements this interface then this method must be called
  8934. after its properties have been set before the component can be used.
  8935. </para>
  8936. </remarks>
  8937. </member>
  8938. <member name="T:log4net.Core.LoggerRepositoryCreationEventHandler">
  8939. <summary>
  8940. Delegate used to handle logger repository creation event notifications
  8941. </summary>
  8942. <param name="sender">The <see cref="T:log4net.Core.IRepositorySelector"/> which created the repository.</param>
  8943. <param name="e">The <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> event args
  8944. that holds the <see cref="T:log4net.Repository.ILoggerRepository"/> instance that has been created.</param>
  8945. <remarks>
  8946. <para>
  8947. Delegate used to handle logger repository creation event notifications.
  8948. </para>
  8949. </remarks>
  8950. </member>
  8951. <member name="T:log4net.Core.LoggerRepositoryCreationEventArgs">
  8952. <summary>
  8953. Provides data for the <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/> event.
  8954. </summary>
  8955. <remarks>
  8956. <para>
  8957. A <see cref="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent"/>
  8958. event is raised every time a <see cref="T:log4net.Repository.ILoggerRepository"/> is created.
  8959. </para>
  8960. </remarks>
  8961. </member>
  8962. <member name="F:log4net.Core.LoggerRepositoryCreationEventArgs.m_repository">
  8963. <summary>
  8964. The <see cref="T:log4net.Repository.ILoggerRepository"/> created
  8965. </summary>
  8966. </member>
  8967. <member name="M:log4net.Core.LoggerRepositoryCreationEventArgs.#ctor(log4net.Repository.ILoggerRepository)">
  8968. <summary>
  8969. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  8970. </summary>
  8971. <param name="repository">the <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created</param>
  8972. <remarks>
  8973. <para>
  8974. Construct instance using <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  8975. </para>
  8976. </remarks>
  8977. </member>
  8978. <member name="P:log4net.Core.LoggerRepositoryCreationEventArgs.LoggerRepository">
  8979. <summary>
  8980. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  8981. </summary>
  8982. <value>
  8983. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  8984. </value>
  8985. <remarks>
  8986. <para>
  8987. The <see cref="T:log4net.Repository.ILoggerRepository"/> that has been created
  8988. </para>
  8989. </remarks>
  8990. </member>
  8991. <member name="T:log4net.Core.IRepositorySelector">
  8992. <summary>
  8993. Interface used by the <see cref="T:log4net.LogManager"/> to select the <see cref="T:log4net.Repository.ILoggerRepository"/>.
  8994. </summary>
  8995. <remarks>
  8996. <para>
  8997. The <see cref="T:log4net.LogManager"/> uses a <see cref="T:log4net.Core.IRepositorySelector"/>
  8998. to specify the policy for selecting the correct <see cref="T:log4net.Repository.ILoggerRepository"/>
  8999. to return to the caller.
  9000. </para>
  9001. </remarks>
  9002. <author>Nicko Cadell</author>
  9003. <author>Gert Driesen</author>
  9004. </member>
  9005. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.Reflection.Assembly)">
  9006. <summary>
  9007. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9008. </summary>
  9009. <param name="assembly">The assembly to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/></param>
  9010. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> for the assembly.</returns>
  9011. <remarks>
  9012. <para>
  9013. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the specified assembly.
  9014. </para>
  9015. <para>
  9016. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9017. is made is not defined. The implementation may choose any method for
  9018. this association. The results of this method must be repeatable, i.e.
  9019. when called again with the same arguments the result must be the
  9020. save value.
  9021. </para>
  9022. </remarks>
  9023. </member>
  9024. <member name="M:log4net.Core.IRepositorySelector.GetRepository(System.String)">
  9025. <summary>
  9026. Gets the named <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9027. </summary>
  9028. <param name="repositoryName">The name to use to lookup to the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9029. <returns>The named <see cref="T:log4net.Repository.ILoggerRepository"/></returns>
  9030. <remarks>
  9031. Lookup a named <see cref="T:log4net.Repository.ILoggerRepository"/>. This is the repository created by
  9032. calling <see cref="M:CreateRepository(string,Type)"/>.
  9033. </remarks>
  9034. </member>
  9035. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.Reflection.Assembly,System.Type)">
  9036. <summary>
  9037. Creates a new repository for the assembly specified.
  9038. </summary>
  9039. <param name="assembly">The assembly to use to create the domain to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9040. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9041. <returns>The repository created.</returns>
  9042. <remarks>
  9043. <para>
  9044. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the domain
  9045. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  9046. same assembly specified will return the same repository instance.
  9047. </para>
  9048. <para>
  9049. How the association between <see cref="T:System.Reflection.Assembly"/> and <see cref="T:log4net.Repository.ILoggerRepository"/>
  9050. is made is not defined. The implementation may choose any method for
  9051. this association.
  9052. </para>
  9053. </remarks>
  9054. </member>
  9055. <member name="M:log4net.Core.IRepositorySelector.CreateRepository(System.String,System.Type)">
  9056. <summary>
  9057. Creates a new repository with the name specified.
  9058. </summary>
  9059. <param name="repositoryName">The name to associate with the <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9060. <param name="repositoryType">The type of repository to create, must implement <see cref="T:log4net.Repository.ILoggerRepository"/>.</param>
  9061. <returns>The repository created.</returns>
  9062. <remarks>
  9063. <para>
  9064. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the name
  9065. specified such that a call to <see cref="M:GetRepository(string)"/> with the
  9066. same name will return the same repository instance.
  9067. </para>
  9068. </remarks>
  9069. </member>
  9070. <member name="M:log4net.Core.IRepositorySelector.ExistsRepository(System.String)">
  9071. <summary>
  9072. Test if a named repository exists
  9073. </summary>
  9074. <param name="repositoryName">the named repository to check</param>
  9075. <returns><c>true</c> if the repository exists</returns>
  9076. <remarks>
  9077. <para>
  9078. Test if a named repository exists. Use <see cref="M:CreateRepository(Assembly, Type)"/>
  9079. to create a new repository and <see cref="M:GetRepository(Assembly)"/> to retrieve
  9080. a repository.
  9081. </para>
  9082. </remarks>
  9083. </member>
  9084. <member name="M:log4net.Core.IRepositorySelector.GetAllRepositories">
  9085. <summary>
  9086. Gets an array of all currently defined repositories.
  9087. </summary>
  9088. <returns>
  9089. An array of the <see cref="T:log4net.Repository.ILoggerRepository"/> instances created by
  9090. this <see cref="T:log4net.Core.IRepositorySelector"/>.</returns>
  9091. <remarks>
  9092. <para>
  9093. Gets an array of all of the repositories created by this selector.
  9094. </para>
  9095. </remarks>
  9096. </member>
  9097. <member name="E:log4net.Core.IRepositorySelector.LoggerRepositoryCreatedEvent">
  9098. <summary>
  9099. Event to notify that a logger repository has been created.
  9100. </summary>
  9101. <value>
  9102. Event to notify that a logger repository has been created.
  9103. </value>
  9104. <remarks>
  9105. <para>
  9106. Event raised when a new repository is created.
  9107. The event source will be this selector. The event args will
  9108. be a <see cref="T:log4net.Core.LoggerRepositoryCreationEventArgs"/> which
  9109. holds the newly created <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9110. </para>
  9111. </remarks>
  9112. </member>
  9113. <member name="T:log4net.Core.ITriggeringEventEvaluator">
  9114. <summary>
  9115. Test if an <see cref="T:log4net.Core.LoggingEvent"/> triggers an action
  9116. </summary>
  9117. <remarks>
  9118. <para>
  9119. Implementations of this interface allow certain appenders to decide
  9120. when to perform an appender specific action.
  9121. </para>
  9122. <para>
  9123. The action or behavior triggered is defined by the implementation.
  9124. </para>
  9125. </remarks>
  9126. <author>Nicko Cadell</author>
  9127. </member>
  9128. <member name="M:log4net.Core.ITriggeringEventEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  9129. <summary>
  9130. Test if this event triggers the action
  9131. </summary>
  9132. <param name="loggingEvent">The event to check</param>
  9133. <returns><c>true</c> if this event triggers the action, otherwise <c>false</c></returns>
  9134. <remarks>
  9135. <para>
  9136. Return <c>true</c> if this event triggers the action
  9137. </para>
  9138. </remarks>
  9139. </member>
  9140. <member name="T:log4net.Core.Level">
  9141. <summary>
  9142. Defines the default set of levels recognized by the system.
  9143. </summary>
  9144. <remarks>
  9145. <para>
  9146. Each <see cref="T:log4net.Core.LoggingEvent"/> has an associated <see cref="T:log4net.Core.Level"/>.
  9147. </para>
  9148. <para>
  9149. Levels have a numeric <see cref="P:log4net.Core.Level.Value"/> that defines the relative
  9150. ordering between levels. Two Levels with the same <see cref="P:log4net.Core.Level.Value"/>
  9151. are deemed to be equivalent.
  9152. </para>
  9153. <para>
  9154. The levels that are recognized by log4net are set for each <see cref="T:log4net.Repository.ILoggerRepository"/>
  9155. and each repository can have different levels defined. The levels are stored
  9156. in the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> on the repository. Levels are
  9157. looked up by name from the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>.
  9158. </para>
  9159. <para>
  9160. When logging at level INFO the actual level used is not <see cref="F:log4net.Core.Level.Info"/> but
  9161. the value of <c>LoggerRepository.LevelMap["INFO"]</c>. The default value for this is
  9162. <see cref="F:log4net.Core.Level.Info"/>, but this can be changed by reconfiguring the level map.
  9163. </para>
  9164. <para>
  9165. Each level has a <see cref="P:log4net.Core.Level.DisplayName"/> in addition to its <see cref="P:log4net.Core.Level.Name"/>. The
  9166. <see cref="P:log4net.Core.Level.DisplayName"/> is the string that is written into the output log. By default
  9167. the display name is the same as the level name, but this can be used to alias levels
  9168. or to localize the log output.
  9169. </para>
  9170. <para>
  9171. Some of the predefined levels recognized by the system are:
  9172. </para>
  9173. <list type="bullet">
  9174. <item>
  9175. <description><see cref="F:log4net.Core.Level.Off"/>.</description>
  9176. </item>
  9177. <item>
  9178. <description><see cref="F:log4net.Core.Level.Fatal"/>.</description>
  9179. </item>
  9180. <item>
  9181. <description><see cref="F:log4net.Core.Level.Error"/>.</description>
  9182. </item>
  9183. <item>
  9184. <description><see cref="F:log4net.Core.Level.Warn"/>.</description>
  9185. </item>
  9186. <item>
  9187. <description><see cref="F:log4net.Core.Level.Info"/>.</description>
  9188. </item>
  9189. <item>
  9190. <description><see cref="F:log4net.Core.Level.Debug"/>.</description>
  9191. </item>
  9192. <item>
  9193. <description><see cref="F:log4net.Core.Level.All"/>.</description>
  9194. </item>
  9195. </list>
  9196. </remarks>
  9197. <author>Nicko Cadell</author>
  9198. <author>Gert Driesen</author>
  9199. </member>
  9200. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String,System.String)">
  9201. <summary>
  9202. Constructor
  9203. </summary>
  9204. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  9205. <param name="levelName">The string name of this level.</param>
  9206. <param name="displayName">The display name for this level. This may be localized or otherwise different from the name</param>
  9207. <remarks>
  9208. <para>
  9209. Initializes a new instance of the <see cref="T:log4net.Core.Level" /> class with
  9210. the specified level name and value.
  9211. </para>
  9212. </remarks>
  9213. </member>
  9214. <member name="M:log4net.Core.Level.#ctor(System.Int32,System.String)">
  9215. <summary>
  9216. Constructor
  9217. </summary>
  9218. <param name="level">Integer value for this level, higher values represent more severe levels.</param>
  9219. <param name="levelName">The string name of this level.</param>
  9220. <remarks>
  9221. <para>
  9222. Initializes a new instance of the <see cref="T:log4net.Core.Level" /> class with
  9223. the specified level name and value.
  9224. </para>
  9225. </remarks>
  9226. </member>
  9227. <member name="P:log4net.Core.Level.Name">
  9228. <summary>
  9229. Gets the name of this level.
  9230. </summary>
  9231. <value>
  9232. The name of this level.
  9233. </value>
  9234. <remarks>
  9235. <para>
  9236. Gets the name of this level.
  9237. </para>
  9238. </remarks>
  9239. </member>
  9240. <member name="P:log4net.Core.Level.Value">
  9241. <summary>
  9242. Gets the value of this level.
  9243. </summary>
  9244. <value>
  9245. The value of this level.
  9246. </value>
  9247. <remarks>
  9248. <para>
  9249. Gets the value of this level.
  9250. </para>
  9251. </remarks>
  9252. </member>
  9253. <member name="P:log4net.Core.Level.DisplayName">
  9254. <summary>
  9255. Gets the display name of this level.
  9256. </summary>
  9257. <value>
  9258. The display name of this level.
  9259. </value>
  9260. <remarks>
  9261. <para>
  9262. Gets the display name of this level.
  9263. </para>
  9264. </remarks>
  9265. </member>
  9266. <member name="M:log4net.Core.Level.ToString">
  9267. <summary>
  9268. Returns the <see cref="T:System.String" /> representation of the current
  9269. <see cref="T:log4net.Core.Level" />.
  9270. </summary>
  9271. <returns>
  9272. A <see cref="T:System.String" /> representation of the current <see cref="T:log4net.Core.Level" />.
  9273. </returns>
  9274. <remarks>
  9275. <para>
  9276. Returns the level <see cref="P:log4net.Core.Level.Name"/>.
  9277. </para>
  9278. </remarks>
  9279. </member>
  9280. <member name="M:log4net.Core.Level.Equals(System.Object)">
  9281. <summary>
  9282. Compares levels.
  9283. </summary>
  9284. <param name="o">The object to compare against.</param>
  9285. <returns><c>true</c> if the objects are equal.</returns>
  9286. <remarks>
  9287. <para>
  9288. Compares the levels of <see cref="T:log4net.Core.Level" /> instances, and
  9289. defers to base class if the target object is not a <see cref="T:log4net.Core.Level" />
  9290. instance.
  9291. </para>
  9292. </remarks>
  9293. </member>
  9294. <member name="M:log4net.Core.Level.GetHashCode">
  9295. <summary>
  9296. Returns a hash code
  9297. </summary>
  9298. <returns>A hash code for the current <see cref="T:log4net.Core.Level" />.</returns>
  9299. <remarks>
  9300. <para>
  9301. Returns a hash code suitable for use in hashing algorithms and data
  9302. structures like a hash table.
  9303. </para>
  9304. <para>
  9305. Returns the hash code of the level <see cref="P:log4net.Core.Level.Value"/>.
  9306. </para>
  9307. </remarks>
  9308. </member>
  9309. <member name="M:log4net.Core.Level.CompareTo(System.Object)">
  9310. <summary>
  9311. Compares this instance to a specified object and returns an
  9312. indication of their relative values.
  9313. </summary>
  9314. <param name="r">A <see cref="T:log4net.Core.Level"/> instance or <see langword="null" /> to compare with this instance.</param>
  9315. <returns>
  9316. A 32-bit signed integer that indicates the relative order of the
  9317. values compared. The return value has these meanings:
  9318. <list type="table">
  9319. <listheader>
  9320. <term>Value</term>
  9321. <description>Meaning</description>
  9322. </listheader>
  9323. <item>
  9324. <term>Less than zero</term>
  9325. <description>This instance is less than <paramref name="r" />.</description>
  9326. </item>
  9327. <item>
  9328. <term>Zero</term>
  9329. <description>This instance is equal to <paramref name="r" />.</description>
  9330. </item>
  9331. <item>
  9332. <term>Greater than zero</term>
  9333. <description>
  9334. <para>This instance is greater than <paramref name="r" />.</para>
  9335. <para>-or-</para>
  9336. <para><paramref name="r" /> is <see langword="null" />.</para>
  9337. </description>
  9338. </item>
  9339. </list>
  9340. </returns>
  9341. <remarks>
  9342. <para>
  9343. <paramref name="r" /> must be an instance of <see cref="T:log4net.Core.Level" />
  9344. or <see langword="null" />; otherwise, an exception is thrown.
  9345. </para>
  9346. </remarks>
  9347. <exception cref="T:System.ArgumentException"><paramref name="r" /> is not a <see cref="T:log4net.Core.Level" />.</exception>
  9348. </member>
  9349. <member name="M:log4net.Core.Level.op_GreaterThan(log4net.Core.Level,log4net.Core.Level)">
  9350. <summary>
  9351. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  9352. is greater than another specified <see cref="T:log4net.Core.Level" />.
  9353. </summary>
  9354. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  9355. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  9356. <returns>
  9357. <c>true</c> if <paramref name="l" /> is greater than
  9358. <paramref name="r" />; otherwise, <c>false</c>.
  9359. </returns>
  9360. <remarks>
  9361. <para>
  9362. Compares two levels.
  9363. </para>
  9364. </remarks>
  9365. </member>
  9366. <member name="M:log4net.Core.Level.op_LessThan(log4net.Core.Level,log4net.Core.Level)">
  9367. <summary>
  9368. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  9369. is less than another specified <see cref="T:log4net.Core.Level" />.
  9370. </summary>
  9371. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  9372. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  9373. <returns>
  9374. <c>true</c> if <paramref name="l" /> is less than
  9375. <paramref name="r" />; otherwise, <c>false</c>.
  9376. </returns>
  9377. <remarks>
  9378. <para>
  9379. Compares two levels.
  9380. </para>
  9381. </remarks>
  9382. </member>
  9383. <member name="M:log4net.Core.Level.op_GreaterThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  9384. <summary>
  9385. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  9386. is greater than or equal to another specified <see cref="T:log4net.Core.Level" />.
  9387. </summary>
  9388. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  9389. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  9390. <returns>
  9391. <c>true</c> if <paramref name="l" /> is greater than or equal to
  9392. <paramref name="r" />; otherwise, <c>false</c>.
  9393. </returns>
  9394. <remarks>
  9395. <para>
  9396. Compares two levels.
  9397. </para>
  9398. </remarks>
  9399. </member>
  9400. <member name="M:log4net.Core.Level.op_LessThanOrEqual(log4net.Core.Level,log4net.Core.Level)">
  9401. <summary>
  9402. Returns a value indicating whether a specified <see cref="T:log4net.Core.Level" />
  9403. is less than or equal to another specified <see cref="T:log4net.Core.Level" />.
  9404. </summary>
  9405. <param name="l">A <see cref="T:log4net.Core.Level" /></param>
  9406. <param name="r">A <see cref="T:log4net.Core.Level" /></param>
  9407. <returns>
  9408. <c>true</c> if <paramref name="l" /> is less than or equal to
  9409. <paramref name="r" />; otherwise, <c>false</c>.
  9410. </returns>
  9411. <remarks>
  9412. <para>
  9413. Compares two levels.
  9414. </para>
  9415. </remarks>
  9416. </member>
  9417. <member name="M:log4net.Core.Level.op_Equality(log4net.Core.Level,log4net.Core.Level)">
  9418. <summary>
  9419. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level" />
  9420. objects have the same value.
  9421. </summary>
  9422. <param name="l">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  9423. <param name="r">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  9424. <returns>
  9425. <c>true</c> if the value of <paramref name="l" /> is the same as the
  9426. value of <paramref name="r" />; otherwise, <c>false</c>.
  9427. </returns>
  9428. <remarks>
  9429. <para>
  9430. Compares two levels.
  9431. </para>
  9432. </remarks>
  9433. </member>
  9434. <member name="M:log4net.Core.Level.op_Inequality(log4net.Core.Level,log4net.Core.Level)">
  9435. <summary>
  9436. Returns a value indicating whether two specified <see cref="T:log4net.Core.Level" />
  9437. objects have different values.
  9438. </summary>
  9439. <param name="l">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  9440. <param name="r">A <see cref="T:log4net.Core.Level" /> or <see langword="null" />.</param>
  9441. <returns>
  9442. <c>true</c> if the value of <paramref name="l" /> is different from
  9443. the value of <paramref name="r" />; otherwise, <c>false</c>.
  9444. </returns>
  9445. <remarks>
  9446. <para>
  9447. Compares two levels.
  9448. </para>
  9449. </remarks>
  9450. </member>
  9451. <member name="M:log4net.Core.Level.Compare(log4net.Core.Level,log4net.Core.Level)">
  9452. <summary>
  9453. Compares two specified <see cref="T:log4net.Core.Level"/> instances.
  9454. </summary>
  9455. <param name="l">The first <see cref="T:log4net.Core.Level"/> to compare.</param>
  9456. <param name="r">The second <see cref="T:log4net.Core.Level"/> to compare.</param>
  9457. <returns>
  9458. A 32-bit signed integer that indicates the relative order of the
  9459. two values compared. The return value has these meanings:
  9460. <list type="table">
  9461. <listheader>
  9462. <term>Value</term>
  9463. <description>Meaning</description>
  9464. </listheader>
  9465. <item>
  9466. <term>Less than zero</term>
  9467. <description><paramref name="l" /> is less than <paramref name="r" />.</description>
  9468. </item>
  9469. <item>
  9470. <term>Zero</term>
  9471. <description><paramref name="l" /> is equal to <paramref name="r" />.</description>
  9472. </item>
  9473. <item>
  9474. <term>Greater than zero</term>
  9475. <description><paramref name="l" /> is greater than <paramref name="r" />.</description>
  9476. </item>
  9477. </list>
  9478. </returns>
  9479. <remarks>
  9480. <para>
  9481. Compares two levels.
  9482. </para>
  9483. </remarks>
  9484. </member>
  9485. <member name="F:log4net.Core.Level.Off">
  9486. <summary>
  9487. The <see cref="F:log4net.Core.Level.Off" /> level designates a higher level than all the rest.
  9488. </summary>
  9489. </member>
  9490. <member name="F:log4net.Core.Level.Log4Net_Debug">
  9491. <summary>
  9492. The <see cref="F:log4net.Core.Level.Emergency" /> level designates very severe error events.
  9493. System unusable, emergencies.
  9494. </summary>
  9495. </member>
  9496. <member name="F:log4net.Core.Level.Emergency">
  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.Fatal">
  9503. <summary>
  9504. The <see cref="F:log4net.Core.Level.Fatal" /> level designates very severe error events
  9505. that will presumably lead the application to abort.
  9506. </summary>
  9507. </member>
  9508. <member name="F:log4net.Core.Level.Alert">
  9509. <summary>
  9510. The <see cref="F:log4net.Core.Level.Alert" /> level designates very severe error events.
  9511. Take immediate action, alerts.
  9512. </summary>
  9513. </member>
  9514. <member name="F:log4net.Core.Level.Critical">
  9515. <summary>
  9516. The <see cref="F:log4net.Core.Level.Critical" /> level designates very severe error events.
  9517. Critical condition, critical.
  9518. </summary>
  9519. </member>
  9520. <member name="F:log4net.Core.Level.Severe">
  9521. <summary>
  9522. The <see cref="F:log4net.Core.Level.Severe" /> level designates very severe error events.
  9523. </summary>
  9524. </member>
  9525. <member name="F:log4net.Core.Level.Error">
  9526. <summary>
  9527. The <see cref="F:log4net.Core.Level.Error" /> level designates error events that might
  9528. still allow the application to continue running.
  9529. </summary>
  9530. </member>
  9531. <member name="F:log4net.Core.Level.Warn">
  9532. <summary>
  9533. The <see cref="F:log4net.Core.Level.Warn" /> level designates potentially harmful
  9534. situations.
  9535. </summary>
  9536. </member>
  9537. <member name="F:log4net.Core.Level.Notice">
  9538. <summary>
  9539. The <see cref="F:log4net.Core.Level.Notice" /> level designates informational messages
  9540. that highlight the progress of the application at the highest level.
  9541. </summary>
  9542. </member>
  9543. <member name="F:log4net.Core.Level.Info">
  9544. <summary>
  9545. The <see cref="F:log4net.Core.Level.Info" /> level designates informational messages that
  9546. highlight the progress of the application at coarse-grained level.
  9547. </summary>
  9548. </member>
  9549. <member name="F:log4net.Core.Level.Debug">
  9550. <summary>
  9551. The <see cref="F:log4net.Core.Level.Debug" /> level designates fine-grained informational
  9552. events that are most useful to debug an application.
  9553. </summary>
  9554. </member>
  9555. <member name="F:log4net.Core.Level.Fine">
  9556. <summary>
  9557. The <see cref="F:log4net.Core.Level.Fine" /> 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.Trace">
  9562. <summary>
  9563. The <see cref="F:log4net.Core.Level.Trace" /> 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.Finer">
  9568. <summary>
  9569. The <see cref="F:log4net.Core.Level.Finer" /> 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.Verbose">
  9574. <summary>
  9575. The <see cref="F:log4net.Core.Level.Verbose" /> 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.Finest">
  9580. <summary>
  9581. The <see cref="F:log4net.Core.Level.Finest" /> 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.All">
  9586. <summary>
  9587. The <see cref="F:log4net.Core.Level.All" /> level designates the lowest level possible.
  9588. </summary>
  9589. </member>
  9590. <member name="T:log4net.Core.LevelCollection">
  9591. <summary>
  9592. A strongly-typed collection of <see cref="T:log4net.Core.Level"/> objects.
  9593. </summary>
  9594. <author>Nicko Cadell</author>
  9595. </member>
  9596. <member name="T:log4net.Core.LevelCollection.ILevelCollectionEnumerator">
  9597. <summary>
  9598. Supports type-safe iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  9599. </summary>
  9600. </member>
  9601. <member name="P:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Current">
  9602. <summary>
  9603. Gets the current element in the collection.
  9604. </summary>
  9605. </member>
  9606. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.MoveNext">
  9607. <summary>
  9608. Advances the enumerator to the next element in the collection.
  9609. </summary>
  9610. <returns>
  9611. <c>true</c> if the enumerator was successfully advanced to the next element;
  9612. <c>false</c> if the enumerator has passed the end of the collection.
  9613. </returns>
  9614. <exception cref="T:System.InvalidOperationException">
  9615. The collection was modified after the enumerator was created.
  9616. </exception>
  9617. </member>
  9618. <member name="M:log4net.Core.LevelCollection.ILevelCollectionEnumerator.Reset">
  9619. <summary>
  9620. Sets the enumerator to its initial position, before the first element in the collection.
  9621. </summary>
  9622. </member>
  9623. <member name="M:log4net.Core.LevelCollection.ReadOnly(log4net.Core.LevelCollection)">
  9624. <summary>
  9625. Creates a read-only wrapper for a <c>LevelCollection</c> instance.
  9626. </summary>
  9627. <param name="list">list to create a readonly wrapper arround</param>
  9628. <returns>
  9629. A <c>LevelCollection</c> wrapper that is read-only.
  9630. </returns>
  9631. </member>
  9632. <member name="M:log4net.Core.LevelCollection.#ctor">
  9633. <summary>
  9634. Initializes a new instance of the <c>LevelCollection</c> class
  9635. that is empty and has the default initial capacity.
  9636. </summary>
  9637. </member>
  9638. <member name="M:log4net.Core.LevelCollection.#ctor(System.Int32)">
  9639. <summary>
  9640. Initializes a new instance of the <c>LevelCollection</c> class
  9641. that has the specified initial capacity.
  9642. </summary>
  9643. <param name="capacity">
  9644. The number of elements that the new <c>LevelCollection</c> is initially capable of storing.
  9645. </param>
  9646. </member>
  9647. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection)">
  9648. <summary>
  9649. Initializes a new instance of the <c>LevelCollection</c> class
  9650. that contains elements copied from the specified <c>LevelCollection</c>.
  9651. </summary>
  9652. <param name="c">The <c>LevelCollection</c> whose elements are copied to the new collection.</param>
  9653. </member>
  9654. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.Level[])">
  9655. <summary>
  9656. Initializes a new instance of the <c>LevelCollection</c> class
  9657. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> array.
  9658. </summary>
  9659. <param name="a">The <see cref="T:log4net.Core.Level"/> array whose elements are copied to the new list.</param>
  9660. </member>
  9661. <member name="M:log4net.Core.LevelCollection.#ctor(System.Collections.ICollection)">
  9662. <summary>
  9663. Initializes a new instance of the <c>LevelCollection</c> class
  9664. that contains elements copied from the specified <see cref="T:log4net.Core.Level"/> collection.
  9665. </summary>
  9666. <param name="col">The <see cref="T:log4net.Core.Level"/> collection whose elements are copied to the new list.</param>
  9667. </member>
  9668. <member name="T:log4net.Core.LevelCollection.Tag">
  9669. <summary>
  9670. Type visible only to our subclasses
  9671. Used to access protected constructor
  9672. </summary>
  9673. </member>
  9674. <member name="F:log4net.Core.LevelCollection.Tag.Default">
  9675. <summary>
  9676. A value
  9677. </summary>
  9678. </member>
  9679. <member name="M:log4net.Core.LevelCollection.#ctor(log4net.Core.LevelCollection.Tag)">
  9680. <summary>
  9681. Allow subclasses to avoid our default constructors
  9682. </summary>
  9683. <param name="tag"></param>
  9684. </member>
  9685. <member name="P:log4net.Core.LevelCollection.Count">
  9686. <summary>
  9687. Gets the number of elements actually contained in the <c>LevelCollection</c>.
  9688. </summary>
  9689. </member>
  9690. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[])">
  9691. <summary>
  9692. Copies the entire <c>LevelCollection</c> to a one-dimensional
  9693. <see cref="T:log4net.Core.Level"/> array.
  9694. </summary>
  9695. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  9696. </member>
  9697. <member name="M:log4net.Core.LevelCollection.CopyTo(log4net.Core.Level[],System.Int32)">
  9698. <summary>
  9699. Copies the entire <c>LevelCollection</c> to a one-dimensional
  9700. <see cref="T:log4net.Core.Level"/> array, starting at the specified index of the target array.
  9701. </summary>
  9702. <param name="array">The one-dimensional <see cref="T:log4net.Core.Level"/> array to copy to.</param>
  9703. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  9704. </member>
  9705. <member name="P:log4net.Core.LevelCollection.IsSynchronized">
  9706. <summary>
  9707. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  9708. </summary>
  9709. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  9710. </member>
  9711. <member name="P:log4net.Core.LevelCollection.SyncRoot">
  9712. <summary>
  9713. Gets an object that can be used to synchronize access to the collection.
  9714. </summary>
  9715. </member>
  9716. <member name="P:log4net.Core.LevelCollection.Item(System.Int32)">
  9717. <summary>
  9718. Gets or sets the <see cref="T:log4net.Core.Level"/> at the specified index.
  9719. </summary>
  9720. <param name="index">The zero-based index of the element to get or set.</param>
  9721. <exception cref="T:System.ArgumentOutOfRangeException">
  9722. <para><paramref name="index"/> is less than zero</para>
  9723. <para>-or-</para>
  9724. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9725. </exception>
  9726. </member>
  9727. <member name="M:log4net.Core.LevelCollection.Add(log4net.Core.Level)">
  9728. <summary>
  9729. Adds a <see cref="T:log4net.Core.Level"/> to the end of the <c>LevelCollection</c>.
  9730. </summary>
  9731. <param name="item">The <see cref="T:log4net.Core.Level"/> to be added to the end of the <c>LevelCollection</c>.</param>
  9732. <returns>The index at which the value has been added.</returns>
  9733. </member>
  9734. <member name="M:log4net.Core.LevelCollection.Clear">
  9735. <summary>
  9736. Removes all elements from the <c>LevelCollection</c>.
  9737. </summary>
  9738. </member>
  9739. <member name="M:log4net.Core.LevelCollection.Clone">
  9740. <summary>
  9741. Creates a shallow copy of the <see cref="T:log4net.Core.LevelCollection"/>.
  9742. </summary>
  9743. <returns>A new <see cref="T:log4net.Core.LevelCollection"/> with a shallow copy of the collection data.</returns>
  9744. </member>
  9745. <member name="M:log4net.Core.LevelCollection.Contains(log4net.Core.Level)">
  9746. <summary>
  9747. Determines whether a given <see cref="T:log4net.Core.Level"/> is in the <c>LevelCollection</c>.
  9748. </summary>
  9749. <param name="item">The <see cref="T:log4net.Core.Level"/> to check for.</param>
  9750. <returns><c>true</c> if <paramref name="item"/> is found in the <c>LevelCollection</c>; otherwise, <c>false</c>.</returns>
  9751. </member>
  9752. <member name="M:log4net.Core.LevelCollection.IndexOf(log4net.Core.Level)">
  9753. <summary>
  9754. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Core.Level"/>
  9755. in the <c>LevelCollection</c>.
  9756. </summary>
  9757. <param name="item">The <see cref="T:log4net.Core.Level"/> to locate in the <c>LevelCollection</c>.</param>
  9758. <returns>
  9759. The zero-based index of the first occurrence of <paramref name="item"/>
  9760. in the entire <c>LevelCollection</c>, if found; otherwise, -1.
  9761. </returns>
  9762. </member>
  9763. <member name="M:log4net.Core.LevelCollection.Insert(System.Int32,log4net.Core.Level)">
  9764. <summary>
  9765. Inserts an element into the <c>LevelCollection</c> at the specified index.
  9766. </summary>
  9767. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  9768. <param name="item">The <see cref="T:log4net.Core.Level"/> to insert.</param>
  9769. <exception cref="T:System.ArgumentOutOfRangeException">
  9770. <para><paramref name="index"/> is less than zero</para>
  9771. <para>-or-</para>
  9772. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9773. </exception>
  9774. </member>
  9775. <member name="M:log4net.Core.LevelCollection.Remove(log4net.Core.Level)">
  9776. <summary>
  9777. Removes the first occurrence of a specific <see cref="T:log4net.Core.Level"/> from the <c>LevelCollection</c>.
  9778. </summary>
  9779. <param name="item">The <see cref="T:log4net.Core.Level"/> to remove from the <c>LevelCollection</c>.</param>
  9780. <exception cref="T:System.ArgumentException">
  9781. The specified <see cref="T:log4net.Core.Level"/> was not found in the <c>LevelCollection</c>.
  9782. </exception>
  9783. </member>
  9784. <member name="M:log4net.Core.LevelCollection.RemoveAt(System.Int32)">
  9785. <summary>
  9786. Removes the element at the specified index of the <c>LevelCollection</c>.
  9787. </summary>
  9788. <param name="index">The zero-based index of the element to remove.</param>
  9789. <exception cref="T:System.ArgumentOutOfRangeException">
  9790. <para><paramref name="index"/> is less than zero</para>
  9791. <para>-or-</para>
  9792. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9793. </exception>
  9794. </member>
  9795. <member name="P:log4net.Core.LevelCollection.IsFixedSize">
  9796. <summary>
  9797. Gets a value indicating whether the collection has a fixed size.
  9798. </summary>
  9799. <value>true if the collection has a fixed size; otherwise, false. The default is false</value>
  9800. </member>
  9801. <member name="P:log4net.Core.LevelCollection.IsReadOnly">
  9802. <summary>
  9803. Gets a value indicating whether the IList is read-only.
  9804. </summary>
  9805. <value>true if the collection is read-only; otherwise, false. The default is false</value>
  9806. </member>
  9807. <member name="M:log4net.Core.LevelCollection.GetEnumerator">
  9808. <summary>
  9809. Returns an enumerator that can iterate through the <c>LevelCollection</c>.
  9810. </summary>
  9811. <returns>An <see cref="T:log4net.Core.LevelCollection.Enumerator"/> for the entire <c>LevelCollection</c>.</returns>
  9812. </member>
  9813. <member name="P:log4net.Core.LevelCollection.Capacity">
  9814. <summary>
  9815. Gets or sets the number of elements the <c>LevelCollection</c> can contain.
  9816. </summary>
  9817. </member>
  9818. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.LevelCollection)">
  9819. <summary>
  9820. Adds the elements of another <c>LevelCollection</c> to the current <c>LevelCollection</c>.
  9821. </summary>
  9822. <param name="x">The <c>LevelCollection</c> whose elements should be added to the end of the current <c>LevelCollection</c>.</param>
  9823. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  9824. </member>
  9825. <member name="M:log4net.Core.LevelCollection.AddRange(log4net.Core.Level[])">
  9826. <summary>
  9827. Adds the elements of a <see cref="T:log4net.Core.Level"/> array to the current <c>LevelCollection</c>.
  9828. </summary>
  9829. <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>
  9830. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  9831. </member>
  9832. <member name="M:log4net.Core.LevelCollection.AddRange(System.Collections.ICollection)">
  9833. <summary>
  9834. Adds the elements of a <see cref="T:log4net.Core.Level"/> collection to the current <c>LevelCollection</c>.
  9835. </summary>
  9836. <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>
  9837. <returns>The new <see cref="P:log4net.Core.LevelCollection.Count"/> of the <c>LevelCollection</c>.</returns>
  9838. </member>
  9839. <member name="M:log4net.Core.LevelCollection.TrimToSize">
  9840. <summary>
  9841. Sets the capacity to the actual number of elements.
  9842. </summary>
  9843. </member>
  9844. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32)">
  9845. <exception cref="T:System.ArgumentOutOfRangeException">
  9846. <para><paramref name="i"/> is less than zero</para>
  9847. <para>-or-</para>
  9848. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9849. </exception>
  9850. </member>
  9851. <member name="M:log4net.Core.LevelCollection.ValidateIndex(System.Int32,System.Boolean)">
  9852. <exception cref="T:System.ArgumentOutOfRangeException">
  9853. <para><paramref name="i"/> is less than zero</para>
  9854. <para>-or-</para>
  9855. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Core.LevelCollection.Count"/>.</para>
  9856. </exception>
  9857. </member>
  9858. <member name="T:log4net.Core.LevelCollection.Enumerator">
  9859. <summary>
  9860. Supports simple iteration over a <see cref="T:log4net.Core.LevelCollection"/>.
  9861. </summary>
  9862. </member>
  9863. <member name="M:log4net.Core.LevelCollection.Enumerator.#ctor(log4net.Core.LevelCollection)">
  9864. <summary>
  9865. Initializes a new instance of the <c>Enumerator</c> class.
  9866. </summary>
  9867. <param name="tc"></param>
  9868. </member>
  9869. <member name="P:log4net.Core.LevelCollection.Enumerator.Current">
  9870. <summary>
  9871. Gets the current element in the collection.
  9872. </summary>
  9873. </member>
  9874. <member name="M:log4net.Core.LevelCollection.Enumerator.MoveNext">
  9875. <summary>
  9876. Advances the enumerator to the next element in the collection.
  9877. </summary>
  9878. <returns>
  9879. <c>true</c> if the enumerator was successfully advanced to the next element;
  9880. <c>false</c> if the enumerator has passed the end of the collection.
  9881. </returns>
  9882. <exception cref="T:System.InvalidOperationException">
  9883. The collection was modified after the enumerator was created.
  9884. </exception>
  9885. </member>
  9886. <member name="M:log4net.Core.LevelCollection.Enumerator.Reset">
  9887. <summary>
  9888. Sets the enumerator to its initial position, before the first element in the collection.
  9889. </summary>
  9890. </member>
  9891. <member name="T:log4net.Core.LevelEvaluator">
  9892. <summary>
  9893. An evaluator that triggers at a threshold level
  9894. </summary>
  9895. <remarks>
  9896. <para>
  9897. This evaluator will trigger if the level of the event
  9898. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9899. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9900. level.
  9901. </para>
  9902. </remarks>
  9903. <author>Nicko Cadell</author>
  9904. </member>
  9905. <member name="F:log4net.Core.LevelEvaluator.m_threshold">
  9906. <summary>
  9907. The threshold for triggering
  9908. </summary>
  9909. </member>
  9910. <member name="M:log4net.Core.LevelEvaluator.#ctor">
  9911. <summary>
  9912. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  9913. </summary>
  9914. <remarks>
  9915. <para>
  9916. Create a new evaluator using the <see cref="F:log4net.Core.Level.Off"/> threshold.
  9917. </para>
  9918. <para>
  9919. This evaluator will trigger if the level of the event
  9920. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9921. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9922. level.
  9923. </para>
  9924. </remarks>
  9925. </member>
  9926. <member name="M:log4net.Core.LevelEvaluator.#ctor(log4net.Core.Level)">
  9927. <summary>
  9928. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  9929. </summary>
  9930. <param name="threshold">the threshold to trigger at</param>
  9931. <remarks>
  9932. <para>
  9933. Create a new evaluator using the specified <see cref="T:log4net.Core.Level"/> threshold.
  9934. </para>
  9935. <para>
  9936. This evaluator will trigger if the level of the event
  9937. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9938. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9939. level.
  9940. </para>
  9941. </remarks>
  9942. </member>
  9943. <member name="P:log4net.Core.LevelEvaluator.Threshold">
  9944. <summary>
  9945. the threshold to trigger at
  9946. </summary>
  9947. <value>
  9948. The <see cref="T:log4net.Core.Level"/> that will cause this evaluator to trigger
  9949. </value>
  9950. <remarks>
  9951. <para>
  9952. This evaluator will trigger if the level of the event
  9953. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9954. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9955. level.
  9956. </para>
  9957. </remarks>
  9958. </member>
  9959. <member name="M:log4net.Core.LevelEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  9960. <summary>
  9961. Is this <paramref name="loggingEvent"/> the triggering event?
  9962. </summary>
  9963. <param name="loggingEvent">The event to check</param>
  9964. <returns>This method returns <c>true</c>, if the event level
  9965. is equal or higher than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>.
  9966. Otherwise it returns <c>false</c></returns>
  9967. <remarks>
  9968. <para>
  9969. This evaluator will trigger if the level of the event
  9970. passed to <see cref="M:IsTriggeringEvent(LoggingEvent)"/>
  9971. is equal to or greater than the <see cref="P:log4net.Core.LevelEvaluator.Threshold"/>
  9972. level.
  9973. </para>
  9974. </remarks>
  9975. </member>
  9976. <member name="T:log4net.Core.LevelMap">
  9977. <summary>
  9978. Mapping between string name and Level object
  9979. </summary>
  9980. <remarks>
  9981. <para>
  9982. Mapping between string name and <see cref="T:log4net.Core.Level"/> object.
  9983. This mapping is held separately for each <see cref="T:log4net.Repository.ILoggerRepository"/>.
  9984. The level name is case insensitive.
  9985. </para>
  9986. </remarks>
  9987. <author>Nicko Cadell</author>
  9988. </member>
  9989. <member name="F:log4net.Core.LevelMap.m_mapName2Level">
  9990. <summary>
  9991. Mapping from level name to Level object. The
  9992. level name is case insensitive
  9993. </summary>
  9994. </member>
  9995. <member name="M:log4net.Core.LevelMap.#ctor">
  9996. <summary>
  9997. Construct the level map
  9998. </summary>
  9999. <remarks>
  10000. <para>
  10001. Construct the level map.
  10002. </para>
  10003. </remarks>
  10004. </member>
  10005. <member name="M:log4net.Core.LevelMap.Clear">
  10006. <summary>
  10007. Clear the internal maps of all levels
  10008. </summary>
  10009. <remarks>
  10010. <para>
  10011. Clear the internal maps of all levels
  10012. </para>
  10013. </remarks>
  10014. </member>
  10015. <member name="P:log4net.Core.LevelMap.Item(System.String)">
  10016. <summary>
  10017. Lookup a <see cref="T:log4net.Core.Level"/> by name
  10018. </summary>
  10019. <param name="name">The name of the Level to lookup</param>
  10020. <returns>a Level from the map with the name specified</returns>
  10021. <remarks>
  10022. <para>
  10023. Returns the <see cref="T:log4net.Core.Level"/> from the
  10024. map with the name specified. If the no level is
  10025. found then <c>null</c> is returned.
  10026. </para>
  10027. </remarks>
  10028. </member>
  10029. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32)">
  10030. <summary>
  10031. Create a new Level and add it to the map
  10032. </summary>
  10033. <param name="name">the string to display for the Level</param>
  10034. <param name="value">the level value to give to the Level</param>
  10035. <remarks>
  10036. <para>
  10037. Create a new Level and add it to the map
  10038. </para>
  10039. </remarks>
  10040. <seealso cref="M:Add(string,int,string)"/>
  10041. </member>
  10042. <member name="M:log4net.Core.LevelMap.Add(System.String,System.Int32,System.String)">
  10043. <summary>
  10044. Create a new Level and add it to the map
  10045. </summary>
  10046. <param name="name">the string to display for the Level</param>
  10047. <param name="value">the level value to give to the Level</param>
  10048. <param name="displayName">the display name to give to the Level</param>
  10049. <remarks>
  10050. <para>
  10051. Create a new Level and add it to the map
  10052. </para>
  10053. </remarks>
  10054. </member>
  10055. <member name="M:log4net.Core.LevelMap.Add(log4net.Core.Level)">
  10056. <summary>
  10057. Add a Level to the map
  10058. </summary>
  10059. <param name="level">the Level to add</param>
  10060. <remarks>
  10061. <para>
  10062. Add a Level to the map
  10063. </para>
  10064. </remarks>
  10065. </member>
  10066. <member name="P:log4net.Core.LevelMap.AllLevels">
  10067. <summary>
  10068. Return all possible levels as a list of Level objects.
  10069. </summary>
  10070. <returns>all possible levels as a list of Level objects</returns>
  10071. <remarks>
  10072. <para>
  10073. Return all possible levels as a list of Level objects.
  10074. </para>
  10075. </remarks>
  10076. </member>
  10077. <member name="M:log4net.Core.LevelMap.LookupWithDefault(log4net.Core.Level)">
  10078. <summary>
  10079. Lookup a named level from the map
  10080. </summary>
  10081. <param name="defaultLevel">the name of the level to lookup is taken from this level.
  10082. If the level is not set on the map then this level is added</param>
  10083. <returns>the level in the map with the name specified</returns>
  10084. <remarks>
  10085. <para>
  10086. Lookup a named level from the map. The name of the level to lookup is taken
  10087. from the <see cref="P:log4net.Core.Level.Name"/> property of the <paramref name="defaultLevel"/>
  10088. argument.
  10089. </para>
  10090. <para>
  10091. If no level with the specified name is found then the
  10092. <paramref name="defaultLevel"/> argument is added to the level map
  10093. and returned.
  10094. </para>
  10095. </remarks>
  10096. </member>
  10097. <member name="T:log4net.Core.LocationInfo">
  10098. <summary>
  10099. The internal representation of caller location information.
  10100. </summary>
  10101. <remarks>
  10102. <para>
  10103. This class uses the <c>System.Diagnostics.StackTrace</c> class to generate
  10104. a call stack. The caller's information is then extracted from this stack.
  10105. </para>
  10106. <para>
  10107. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  10108. .NET Compact Framework 1.0 therefore caller location information is not
  10109. available on that framework.
  10110. </para>
  10111. <para>
  10112. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  10113. </para>
  10114. <para>
  10115. "StackTrace information will be most informative with Debug build configurations.
  10116. By default, Debug builds include debug symbols, while Release builds do not. The
  10117. debug symbols contain most of the file, method name, line number, and column
  10118. information used in constructing StackFrame and StackTrace objects. StackTrace
  10119. might not report as many method calls as expected, due to code transformations
  10120. that occur during optimization."
  10121. </para>
  10122. <para>
  10123. This means that in a Release build the caller information may be incomplete or may
  10124. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  10125. </para>
  10126. </remarks>
  10127. <author>Nicko Cadell</author>
  10128. <author>Gert Driesen</author>
  10129. </member>
  10130. <member name="M:log4net.Core.LocationInfo.#ctor(System.Type)">
  10131. <summary>
  10132. Constructor
  10133. </summary>
  10134. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  10135. the stack boundary into the logging system for this call.</param>
  10136. <remarks>
  10137. <para>
  10138. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo" />
  10139. class based on the current thread.
  10140. </para>
  10141. </remarks>
  10142. </member>
  10143. <member name="M:log4net.Core.LocationInfo.#ctor(System.String,System.String,System.String,System.String)">
  10144. <summary>
  10145. Constructor
  10146. </summary>
  10147. <param name="className">The fully qualified class name.</param>
  10148. <param name="methodName">The method name.</param>
  10149. <param name="fileName">The file name.</param>
  10150. <param name="lineNumber">The line number of the method within the file.</param>
  10151. <remarks>
  10152. <para>
  10153. Initializes a new instance of the <see cref="T:log4net.Core.LocationInfo" />
  10154. class with the specified data.
  10155. </para>
  10156. </remarks>
  10157. </member>
  10158. <member name="P:log4net.Core.LocationInfo.ClassName">
  10159. <summary>
  10160. Gets the fully qualified class name of the caller making the logging
  10161. request.
  10162. </summary>
  10163. <value>
  10164. The fully qualified class name of the caller making the logging
  10165. request.
  10166. </value>
  10167. <remarks>
  10168. <para>
  10169. Gets the fully qualified class name of the caller making the logging
  10170. request.
  10171. </para>
  10172. </remarks>
  10173. </member>
  10174. <member name="P:log4net.Core.LocationInfo.FileName">
  10175. <summary>
  10176. Gets the file name of the caller.
  10177. </summary>
  10178. <value>
  10179. The file name of the caller.
  10180. </value>
  10181. <remarks>
  10182. <para>
  10183. Gets the file name of the caller.
  10184. </para>
  10185. </remarks>
  10186. </member>
  10187. <member name="P:log4net.Core.LocationInfo.LineNumber">
  10188. <summary>
  10189. Gets the line number of the caller.
  10190. </summary>
  10191. <value>
  10192. The line number of the caller.
  10193. </value>
  10194. <remarks>
  10195. <para>
  10196. Gets the line number of the caller.
  10197. </para>
  10198. </remarks>
  10199. </member>
  10200. <member name="P:log4net.Core.LocationInfo.MethodName">
  10201. <summary>
  10202. Gets the method name of the caller.
  10203. </summary>
  10204. <value>
  10205. The method name of the caller.
  10206. </value>
  10207. <remarks>
  10208. <para>
  10209. Gets the method name of the caller.
  10210. </para>
  10211. </remarks>
  10212. </member>
  10213. <member name="P:log4net.Core.LocationInfo.FullInfo">
  10214. <summary>
  10215. Gets all available caller information
  10216. </summary>
  10217. <value>
  10218. All available caller information, in the format
  10219. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  10220. </value>
  10221. <remarks>
  10222. <para>
  10223. Gets all available caller information, in the format
  10224. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  10225. </para>
  10226. </remarks>
  10227. </member>
  10228. <member name="F:log4net.Core.LocationInfo.declaringType">
  10229. <summary>
  10230. The fully qualified type of the LocationInfo class.
  10231. </summary>
  10232. <remarks>
  10233. Used by the internal logger to record the Type of the
  10234. log message.
  10235. </remarks>
  10236. </member>
  10237. <member name="F:log4net.Core.LocationInfo.NA">
  10238. <summary>
  10239. When location information is not available the constant
  10240. <c>NA</c> is returned. Current value of this string
  10241. constant is <b>?</b>.
  10242. </summary>
  10243. </member>
  10244. <member name="T:log4net.Core.LogException">
  10245. <summary>
  10246. Exception base type for log4net.
  10247. </summary>
  10248. <remarks>
  10249. <para>
  10250. This type extends <see cref="!:ApplicationException"/>. It
  10251. does not add any new functionality but does differentiate the
  10252. type of exception being thrown.
  10253. </para>
  10254. </remarks>
  10255. <author>Nicko Cadell</author>
  10256. <author>Gert Driesen</author>
  10257. </member>
  10258. <member name="M:log4net.Core.LogException.#ctor">
  10259. <summary>
  10260. Constructor
  10261. </summary>
  10262. <remarks>
  10263. <para>
  10264. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class.
  10265. </para>
  10266. </remarks>
  10267. </member>
  10268. <member name="M:log4net.Core.LogException.#ctor(System.String)">
  10269. <summary>
  10270. Constructor
  10271. </summary>
  10272. <param name="message">A message to include with the exception.</param>
  10273. <remarks>
  10274. <para>
  10275. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class with
  10276. the specified message.
  10277. </para>
  10278. </remarks>
  10279. </member>
  10280. <member name="M:log4net.Core.LogException.#ctor(System.String,System.Exception)">
  10281. <summary>
  10282. Constructor
  10283. </summary>
  10284. <param name="message">A message to include with the exception.</param>
  10285. <param name="innerException">A nested exception to include.</param>
  10286. <remarks>
  10287. <para>
  10288. Initializes a new instance of the <see cref="T:log4net.Core.LogException" /> class
  10289. with the specified message and inner exception.
  10290. </para>
  10291. </remarks>
  10292. </member>
  10293. <member name="T:log4net.Core.LoggerManager">
  10294. <summary>
  10295. Static manager that controls the creation of repositories
  10296. </summary>
  10297. <remarks>
  10298. <para>
  10299. Static manager that controls the creation of repositories
  10300. </para>
  10301. <para>
  10302. This class is used by the wrapper managers (e.g. <see cref="T:log4net.LogManager"/>)
  10303. to provide access to the <see cref="T:log4net.Core.ILogger"/> objects.
  10304. </para>
  10305. <para>
  10306. This manager also holds the <see cref="T:log4net.Core.IRepositorySelector"/> that is used to
  10307. lookup and create repositories. The selector can be set either programmatically using
  10308. the <see cref="P:log4net.Core.LoggerManager.RepositorySelector"/> property, or by setting the <c>log4net.RepositorySelector</c>
  10309. AppSetting in the applications config file to the fully qualified type name of the
  10310. selector to use.
  10311. </para>
  10312. </remarks>
  10313. <author>Nicko Cadell</author>
  10314. <author>Gert Driesen</author>
  10315. </member>
  10316. <member name="M:log4net.Core.LoggerManager.#ctor">
  10317. <summary>
  10318. Private constructor to prevent instances. Only static methods should be used.
  10319. </summary>
  10320. <remarks>
  10321. <para>
  10322. Private constructor to prevent instances. Only static methods should be used.
  10323. </para>
  10324. </remarks>
  10325. </member>
  10326. <member name="M:log4net.Core.LoggerManager.#cctor">
  10327. <summary>
  10328. Hook the shutdown event
  10329. </summary>
  10330. <remarks>
  10331. <para>
  10332. On the full .NET runtime, the static constructor hooks up the
  10333. <c>AppDomain.ProcessExit</c> and <c>AppDomain.DomainUnload</c>> events.
  10334. These are used to shutdown the log4net system as the application exits.
  10335. </para>
  10336. </remarks>
  10337. </member>
  10338. <member name="M:log4net.Core.LoggerManager.RegisterAppDomainEvents">
  10339. <summary>
  10340. Register for ProcessExit and DomainUnload events on the AppDomain
  10341. </summary>
  10342. <remarks>
  10343. <para>
  10344. This needs to be in a separate method because the events make
  10345. a LinkDemand for the ControlAppDomain SecurityPermission. Because
  10346. this is a LinkDemand it is demanded at JIT time. Therefore we cannot
  10347. catch the exception in the method itself, we have to catch it in the
  10348. caller.
  10349. </para>
  10350. </remarks>
  10351. </member>
  10352. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.String)">
  10353. <summary>
  10354. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10355. </summary>
  10356. <param name="repository">the repository to lookup in</param>
  10357. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  10358. <remarks>
  10359. <para>
  10360. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  10361. by the <paramref name="repository"/> argument.
  10362. </para>
  10363. </remarks>
  10364. </member>
  10365. <member name="M:log4net.Core.LoggerManager.GetLoggerRepository(System.Reflection.Assembly)">
  10366. <summary>
  10367. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10368. </summary>
  10369. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10370. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  10371. </member>
  10372. <member name="M:log4net.Core.LoggerManager.GetRepository(System.String)">
  10373. <summary>
  10374. Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10375. </summary>
  10376. <param name="repository">the repository to lookup in</param>
  10377. <returns>Return the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance</returns>
  10378. <remarks>
  10379. <para>
  10380. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  10381. by the <paramref name="repository"/> argument.
  10382. </para>
  10383. </remarks>
  10384. </member>
  10385. <member name="M:log4net.Core.LoggerManager.GetRepository(System.Reflection.Assembly)">
  10386. <summary>
  10387. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10388. </summary>
  10389. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10390. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  10391. <remarks>
  10392. <para>
  10393. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  10394. </para>
  10395. </remarks>
  10396. </member>
  10397. <member name="M:log4net.Core.LoggerManager.Exists(System.String,System.String)">
  10398. <summary>
  10399. Returns the named logger if it exists.
  10400. </summary>
  10401. <param name="repository">The repository to lookup in.</param>
  10402. <param name="name">The fully qualified logger name to look for.</param>
  10403. <returns>
  10404. The logger found, or <c>null</c> if the named logger does not exist in the
  10405. specified repository.
  10406. </returns>
  10407. <remarks>
  10408. <para>
  10409. If the named logger exists (in the specified repository) then it
  10410. returns a reference to the logger, otherwise it returns
  10411. <c>null</c>.
  10412. </para>
  10413. </remarks>
  10414. </member>
  10415. <member name="M:log4net.Core.LoggerManager.Exists(System.Reflection.Assembly,System.String)">
  10416. <summary>
  10417. Returns the named logger if it exists.
  10418. </summary>
  10419. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10420. <param name="name">The fully qualified logger name to look for.</param>
  10421. <returns>
  10422. The logger found, or <c>null</c> if the named logger does not exist in the
  10423. specified assembly's repository.
  10424. </returns>
  10425. <remarks>
  10426. <para>
  10427. If the named logger exists (in the specified assembly's repository) then it
  10428. returns a reference to the logger, otherwise it returns
  10429. <c>null</c>.
  10430. </para>
  10431. </remarks>
  10432. </member>
  10433. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.String)">
  10434. <summary>
  10435. Returns all the currently defined loggers in the specified repository.
  10436. </summary>
  10437. <param name="repository">The repository to lookup in.</param>
  10438. <returns>All the defined loggers.</returns>
  10439. <remarks>
  10440. <para>
  10441. The root logger is <b>not</b> included in the returned array.
  10442. </para>
  10443. </remarks>
  10444. </member>
  10445. <member name="M:log4net.Core.LoggerManager.GetCurrentLoggers(System.Reflection.Assembly)">
  10446. <summary>
  10447. Returns all the currently defined loggers in the specified assembly's repository.
  10448. </summary>
  10449. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10450. <returns>All the defined loggers.</returns>
  10451. <remarks>
  10452. <para>
  10453. The root logger is <b>not</b> included in the returned array.
  10454. </para>
  10455. </remarks>
  10456. </member>
  10457. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.String)">
  10458. <summary>
  10459. Retrieves or creates a named logger.
  10460. </summary>
  10461. <param name="repository">The repository to lookup in.</param>
  10462. <param name="name">The name of the logger to retrieve.</param>
  10463. <returns>The logger with the name specified.</returns>
  10464. <remarks>
  10465. <para>
  10466. Retrieves a logger named as the <paramref name="name"/>
  10467. parameter. If the named logger already exists, then the
  10468. existing instance will be returned. Otherwise, a new instance is
  10469. created.
  10470. </para>
  10471. <para>
  10472. By default, loggers do not have a set level but inherit
  10473. it from the hierarchy. This is one of the central features of
  10474. log4net.
  10475. </para>
  10476. </remarks>
  10477. </member>
  10478. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.String)">
  10479. <summary>
  10480. Retrieves or creates a named logger.
  10481. </summary>
  10482. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10483. <param name="name">The name of the logger to retrieve.</param>
  10484. <returns>The logger with the name specified.</returns>
  10485. <remarks>
  10486. <para>
  10487. Retrieves a logger named as the <paramref name="name"/>
  10488. parameter. If the named logger already exists, then the
  10489. existing instance will be returned. Otherwise, a new instance is
  10490. created.
  10491. </para>
  10492. <para>
  10493. By default, loggers do not have a set level but inherit
  10494. it from the hierarchy. This is one of the central features of
  10495. log4net.
  10496. </para>
  10497. </remarks>
  10498. </member>
  10499. <member name="M:log4net.Core.LoggerManager.GetLogger(System.String,System.Type)">
  10500. <summary>
  10501. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  10502. </summary>
  10503. <param name="repository">The repository to lookup in.</param>
  10504. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  10505. <returns>The logger with the name specified.</returns>
  10506. <remarks>
  10507. <para>
  10508. Gets the logger for the fully qualified name of the type specified.
  10509. </para>
  10510. </remarks>
  10511. </member>
  10512. <member name="M:log4net.Core.LoggerManager.GetLogger(System.Reflection.Assembly,System.Type)">
  10513. <summary>
  10514. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  10515. </summary>
  10516. <param name="repositoryAssembly">the assembly to use to lookup the repository</param>
  10517. <param name="type">The <paramref name="type"/> of which the fullname will be used as the name of the logger to retrieve.</param>
  10518. <returns>The logger with the name specified.</returns>
  10519. <remarks>
  10520. <para>
  10521. Gets the logger for the fully qualified name of the type specified.
  10522. </para>
  10523. </remarks>
  10524. </member>
  10525. <member name="M:log4net.Core.LoggerManager.Shutdown">
  10526. <summary>
  10527. Shuts down the log4net system.
  10528. </summary>
  10529. <remarks>
  10530. <para>
  10531. Calling this method will <b>safely</b> close and remove all
  10532. appenders in all the loggers including root contained in all the
  10533. default repositories.
  10534. </para>
  10535. <para>
  10536. Some appenders need to be closed before the application exists.
  10537. Otherwise, pending logging events might be lost.
  10538. </para>
  10539. <para>
  10540. The <c>shutdown</c> method is careful to close nested
  10541. appenders before closing regular appenders. This is allows
  10542. configurations where a regular appender is attached to a logger
  10543. and again to a nested appender.
  10544. </para>
  10545. </remarks>
  10546. </member>
  10547. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.String)">
  10548. <summary>
  10549. Shuts down the repository for the repository specified.
  10550. </summary>
  10551. <param name="repository">The repository to shutdown.</param>
  10552. <remarks>
  10553. <para>
  10554. Calling this method will <b>safely</b> close and remove all
  10555. appenders in all the loggers including root contained in the
  10556. repository for the <paramref name="repository"/> specified.
  10557. </para>
  10558. <para>
  10559. Some appenders need to be closed before the application exists.
  10560. Otherwise, pending logging events might be lost.
  10561. </para>
  10562. <para>
  10563. The <c>shutdown</c> method is careful to close nested
  10564. appenders before closing regular appenders. This is allows
  10565. configurations where a regular appender is attached to a logger
  10566. and again to a nested appender.
  10567. </para>
  10568. </remarks>
  10569. </member>
  10570. <member name="M:log4net.Core.LoggerManager.ShutdownRepository(System.Reflection.Assembly)">
  10571. <summary>
  10572. Shuts down the repository for the repository specified.
  10573. </summary>
  10574. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  10575. <remarks>
  10576. <para>
  10577. Calling this method will <b>safely</b> close and remove all
  10578. appenders in all the loggers including root contained in the
  10579. repository for the repository. The repository is looked up using
  10580. the <paramref name="repositoryAssembly"/> specified.
  10581. </para>
  10582. <para>
  10583. Some appenders need to be closed before the application exists.
  10584. Otherwise, pending logging events might be lost.
  10585. </para>
  10586. <para>
  10587. The <c>shutdown</c> method is careful to close nested
  10588. appenders before closing regular appenders. This is allows
  10589. configurations where a regular appender is attached to a logger
  10590. and again to a nested appender.
  10591. </para>
  10592. </remarks>
  10593. </member>
  10594. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.String)">
  10595. <summary>
  10596. Resets all values contained in this repository instance to their defaults.
  10597. </summary>
  10598. <param name="repository">The repository to reset.</param>
  10599. <remarks>
  10600. <para>
  10601. Resets all values contained in the repository instance to their
  10602. defaults. This removes all appenders from all loggers, sets
  10603. the level of all non-root loggers to <c>null</c>,
  10604. sets their additivity flag to <c>true</c> and sets the level
  10605. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  10606. message disabling is set its default "off" value.
  10607. </para>
  10608. </remarks>
  10609. </member>
  10610. <member name="M:log4net.Core.LoggerManager.ResetConfiguration(System.Reflection.Assembly)">
  10611. <summary>
  10612. Resets all values contained in this repository instance to their defaults.
  10613. </summary>
  10614. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  10615. <remarks>
  10616. <para>
  10617. Resets all values contained in the repository instance to their
  10618. defaults. This removes all appenders from all loggers, sets
  10619. the level of all non-root loggers to <c>null</c>,
  10620. sets their additivity flag to <c>true</c> and sets the level
  10621. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  10622. message disabling is set its default "off" value.
  10623. </para>
  10624. </remarks>
  10625. </member>
  10626. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String)">
  10627. <summary>
  10628. Creates a repository with the specified name.
  10629. </summary>
  10630. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  10631. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10632. <remarks>
  10633. <para>
  10634. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  10635. </para>
  10636. <para>
  10637. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  10638. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  10639. </para>
  10640. <para>
  10641. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  10642. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  10643. </para>
  10644. </remarks>
  10645. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  10646. </member>
  10647. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String)">
  10648. <summary>
  10649. Creates a repository with the specified name.
  10650. </summary>
  10651. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  10652. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10653. <remarks>
  10654. <para>
  10655. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  10656. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  10657. </para>
  10658. <para>
  10659. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  10660. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  10661. </para>
  10662. </remarks>
  10663. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  10664. </member>
  10665. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.String,System.Type)">
  10666. <summary>
  10667. Creates a repository with the specified name and repository type.
  10668. </summary>
  10669. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  10670. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  10671. and has a no arg constructor. An instance of this type will be created to act
  10672. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  10673. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10674. <remarks>
  10675. <para>
  10676. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  10677. </para>
  10678. <para>
  10679. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  10680. An Exception will be thrown if the repository already exists.
  10681. </para>
  10682. </remarks>
  10683. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  10684. </member>
  10685. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.String,System.Type)">
  10686. <summary>
  10687. Creates a repository with the specified name and repository type.
  10688. </summary>
  10689. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  10690. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  10691. and has a no arg constructor. An instance of this type will be created to act
  10692. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  10693. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10694. <remarks>
  10695. <para>
  10696. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  10697. An Exception will be thrown if the repository already exists.
  10698. </para>
  10699. </remarks>
  10700. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  10701. </member>
  10702. <member name="M:log4net.Core.LoggerManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  10703. <summary>
  10704. Creates a repository for the specified assembly and repository type.
  10705. </summary>
  10706. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  10707. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  10708. and has a no arg constructor. An instance of this type will be created to act
  10709. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  10710. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10711. <remarks>
  10712. <para>
  10713. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  10714. </para>
  10715. <para>
  10716. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10717. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10718. same assembly specified will return the same repository instance.
  10719. </para>
  10720. </remarks>
  10721. </member>
  10722. <member name="M:log4net.Core.LoggerManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  10723. <summary>
  10724. Creates a repository for the specified assembly and repository type.
  10725. </summary>
  10726. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  10727. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  10728. and has a no arg constructor. An instance of this type will be created to act
  10729. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  10730. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  10731. <remarks>
  10732. <para>
  10733. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  10734. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  10735. same assembly specified will return the same repository instance.
  10736. </para>
  10737. </remarks>
  10738. </member>
  10739. <member name="M:log4net.Core.LoggerManager.GetAllRepositories">
  10740. <summary>
  10741. Gets an array of all currently defined repositories.
  10742. </summary>
  10743. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  10744. <remarks>
  10745. <para>
  10746. Gets an array of all currently defined repositories.
  10747. </para>
  10748. </remarks>
  10749. </member>
  10750. <member name="P:log4net.Core.LoggerManager.RepositorySelector">
  10751. <summary>
  10752. Gets or sets the repository selector used by the <see cref="T:log4net.LogManager" />.
  10753. </summary>
  10754. <value>
  10755. The repository selector used by the <see cref="T:log4net.LogManager" />.
  10756. </value>
  10757. <remarks>
  10758. <para>
  10759. The repository selector (<see cref="T:log4net.Core.IRepositorySelector"/>) is used by
  10760. the <see cref="T:log4net.LogManager"/> to create and select repositories
  10761. (<see cref="T:log4net.Repository.ILoggerRepository"/>).
  10762. </para>
  10763. <para>
  10764. The caller to <see cref="T:log4net.LogManager"/> supplies either a string name
  10765. or an assembly (if not supplied the assembly is inferred using
  10766. <see cref="M:Assembly.GetCallingAssembly()"/>).
  10767. </para>
  10768. <para>
  10769. This context is used by the selector to lookup a specific repository.
  10770. </para>
  10771. <para>
  10772. For the full .NET Framework, the default repository is <c>DefaultRepositorySelector</c>;
  10773. for the .NET Compact Framework <c>CompactRepositorySelector</c> is the default
  10774. repository.
  10775. </para>
  10776. </remarks>
  10777. </member>
  10778. <member name="M:log4net.Core.LoggerManager.GetVersionInfo">
  10779. <summary>
  10780. Internal method to get pertinent version info.
  10781. </summary>
  10782. <returns>A string of version info.</returns>
  10783. </member>
  10784. <member name="M:log4net.Core.LoggerManager.OnDomainUnload(System.Object,System.EventArgs)">
  10785. <summary>
  10786. Called when the <see cref="!:AppDomain.DomainUnload"/> event fires
  10787. </summary>
  10788. <param name="sender">the <see cref="!:AppDomain"/> that is exiting</param>
  10789. <param name="e">null</param>
  10790. <remarks>
  10791. <para>
  10792. Called when the <see cref="!:AppDomain.DomainUnload"/> event fires.
  10793. </para>
  10794. <para>
  10795. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  10796. </para>
  10797. </remarks>
  10798. </member>
  10799. <member name="M:log4net.Core.LoggerManager.OnProcessExit(System.Object,System.EventArgs)">
  10800. <summary>
  10801. Called when the <see cref="!:AppDomain.ProcessExit"/> event fires
  10802. </summary>
  10803. <param name="sender">the <see cref="!:AppDomain"/> that is exiting</param>
  10804. <param name="e">null</param>
  10805. <remarks>
  10806. <para>
  10807. Called when the <see cref="!:AppDomain.ProcessExit"/> event fires.
  10808. </para>
  10809. <para>
  10810. When the event is triggered the log4net system is <see cref="M:Shutdown()"/>.
  10811. </para>
  10812. </remarks>
  10813. </member>
  10814. <member name="F:log4net.Core.LoggerManager.declaringType">
  10815. <summary>
  10816. The fully qualified type of the LoggerManager class.
  10817. </summary>
  10818. <remarks>
  10819. Used by the internal logger to record the Type of the
  10820. log message.
  10821. </remarks>
  10822. </member>
  10823. <member name="F:log4net.Core.LoggerManager.s_repositorySelector">
  10824. <summary>
  10825. Initialize the default repository selector
  10826. </summary>
  10827. </member>
  10828. <member name="T:log4net.Core.LoggerWrapperImpl">
  10829. <summary>
  10830. Implementation of the <see cref="T:log4net.Core.ILoggerWrapper"/> interface.
  10831. </summary>
  10832. <remarks>
  10833. <para>
  10834. This class should be used as the base for all wrapper implementations.
  10835. </para>
  10836. </remarks>
  10837. <author>Nicko Cadell</author>
  10838. <author>Gert Driesen</author>
  10839. </member>
  10840. <member name="M:log4net.Core.LoggerWrapperImpl.#ctor(log4net.Core.ILogger)">
  10841. <summary>
  10842. Constructs a new wrapper for the specified logger.
  10843. </summary>
  10844. <param name="logger">The logger to wrap.</param>
  10845. <remarks>
  10846. <para>
  10847. Constructs a new wrapper for the specified logger.
  10848. </para>
  10849. </remarks>
  10850. </member>
  10851. <member name="P:log4net.Core.LoggerWrapperImpl.Logger">
  10852. <summary>
  10853. Gets the implementation behind this wrapper object.
  10854. </summary>
  10855. <value>
  10856. The <see cref="T:log4net.Core.ILogger"/> object that this object is implementing.
  10857. </value>
  10858. <remarks>
  10859. <para>
  10860. The <c>Logger</c> object may not be the same object as this object
  10861. because of logger decorators.
  10862. </para>
  10863. <para>
  10864. This gets the actual underlying objects that is used to process
  10865. the log events.
  10866. </para>
  10867. </remarks>
  10868. </member>
  10869. <member name="F:log4net.Core.LoggerWrapperImpl.m_logger">
  10870. <summary>
  10871. The logger that this object is wrapping
  10872. </summary>
  10873. </member>
  10874. <member name="T:log4net.Core.LoggingEventData">
  10875. <summary>
  10876. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  10877. </summary>
  10878. <remarks>
  10879. <para>
  10880. Portable data structure used by <see cref="T:log4net.Core.LoggingEvent"/>
  10881. </para>
  10882. </remarks>
  10883. <author>Nicko Cadell</author>
  10884. </member>
  10885. <member name="F:log4net.Core.LoggingEventData.LoggerName">
  10886. <summary>
  10887. The logger name.
  10888. </summary>
  10889. <remarks>
  10890. <para>
  10891. The logger name.
  10892. </para>
  10893. </remarks>
  10894. </member>
  10895. <member name="F:log4net.Core.LoggingEventData.Level">
  10896. <summary>
  10897. Level of logging event.
  10898. </summary>
  10899. <remarks>
  10900. <para>
  10901. Level of logging event. Level cannot be Serializable
  10902. because it is a flyweight. Due to its special serialization it
  10903. cannot be declared final either.
  10904. </para>
  10905. </remarks>
  10906. </member>
  10907. <member name="F:log4net.Core.LoggingEventData.Message">
  10908. <summary>
  10909. The application supplied message.
  10910. </summary>
  10911. <remarks>
  10912. <para>
  10913. The application supplied message of logging event.
  10914. </para>
  10915. </remarks>
  10916. </member>
  10917. <member name="F:log4net.Core.LoggingEventData.ThreadName">
  10918. <summary>
  10919. The name of thread
  10920. </summary>
  10921. <remarks>
  10922. <para>
  10923. The name of thread in which this logging event was generated
  10924. </para>
  10925. </remarks>
  10926. </member>
  10927. <member name="F:log4net.Core.LoggingEventData.TimeStamp">
  10928. <summary>
  10929. Gets or sets the local time the event was logged
  10930. </summary>
  10931. <remarks>
  10932. <para>
  10933. Prefer using the <see cref="P:log4net.Core.LoggingEventData.TimeStampUtc"/> setter, since local time can be ambiguous.
  10934. </para>
  10935. </remarks>
  10936. </member>
  10937. <member name="P:log4net.Core.LoggingEventData.TimeStampUtc">
  10938. <summary>
  10939. Gets or sets the UTC time the event was logged
  10940. </summary>
  10941. <remarks>
  10942. <para>
  10943. The TimeStamp is stored in the UTC time zone.
  10944. </para>
  10945. </remarks>
  10946. </member>
  10947. <member name="F:log4net.Core.LoggingEventData.LocationInfo">
  10948. <summary>
  10949. Location information for the caller.
  10950. </summary>
  10951. <remarks>
  10952. <para>
  10953. Location information for the caller.
  10954. </para>
  10955. </remarks>
  10956. </member>
  10957. <member name="F:log4net.Core.LoggingEventData.UserName">
  10958. <summary>
  10959. String representation of the user
  10960. </summary>
  10961. <remarks>
  10962. <para>
  10963. String representation of the user's windows name,
  10964. like DOMAIN\username
  10965. </para>
  10966. </remarks>
  10967. </member>
  10968. <member name="F:log4net.Core.LoggingEventData.Identity">
  10969. <summary>
  10970. String representation of the identity.
  10971. </summary>
  10972. <remarks>
  10973. <para>
  10974. String representation of the current thread's principal identity.
  10975. </para>
  10976. </remarks>
  10977. </member>
  10978. <member name="F:log4net.Core.LoggingEventData.ExceptionString">
  10979. <summary>
  10980. The string representation of the exception
  10981. </summary>
  10982. <remarks>
  10983. <para>
  10984. The string representation of the exception
  10985. </para>
  10986. </remarks>
  10987. </member>
  10988. <member name="F:log4net.Core.LoggingEventData.Domain">
  10989. <summary>
  10990. String representation of the AppDomain.
  10991. </summary>
  10992. <remarks>
  10993. <para>
  10994. String representation of the AppDomain.
  10995. </para>
  10996. </remarks>
  10997. </member>
  10998. <member name="F:log4net.Core.LoggingEventData.Properties">
  10999. <summary>
  11000. Additional event specific properties
  11001. </summary>
  11002. <remarks>
  11003. <para>
  11004. A logger or an appender may attach additional
  11005. properties to specific events. These properties
  11006. have a string key and an object value.
  11007. </para>
  11008. </remarks>
  11009. </member>
  11010. <member name="T:log4net.Core.FixFlags">
  11011. <summary>
  11012. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  11013. </summary>
  11014. <remarks>
  11015. <para>
  11016. Flags passed to the <see cref="P:log4net.Core.LoggingEvent.Fix"/> property
  11017. </para>
  11018. </remarks>
  11019. <author>Nicko Cadell</author>
  11020. </member>
  11021. <member name="F:log4net.Core.FixFlags.Mdc">
  11022. <summary>
  11023. Fix the MDC
  11024. </summary>
  11025. </member>
  11026. <member name="F:log4net.Core.FixFlags.Ndc">
  11027. <summary>
  11028. Fix the NDC
  11029. </summary>
  11030. </member>
  11031. <member name="F:log4net.Core.FixFlags.Message">
  11032. <summary>
  11033. Fix the rendered message
  11034. </summary>
  11035. </member>
  11036. <member name="F:log4net.Core.FixFlags.ThreadName">
  11037. <summary>
  11038. Fix the thread name
  11039. </summary>
  11040. </member>
  11041. <member name="F:log4net.Core.FixFlags.LocationInfo">
  11042. <summary>
  11043. Fix the callers location information
  11044. </summary>
  11045. <remarks>
  11046. CAUTION: Very slow to generate
  11047. </remarks>
  11048. </member>
  11049. <member name="F:log4net.Core.FixFlags.UserName">
  11050. <summary>
  11051. Fix the callers windows user name
  11052. </summary>
  11053. <remarks>
  11054. CAUTION: Slow to generate
  11055. </remarks>
  11056. </member>
  11057. <member name="F:log4net.Core.FixFlags.Domain">
  11058. <summary>
  11059. Fix the domain friendly name
  11060. </summary>
  11061. </member>
  11062. <member name="F:log4net.Core.FixFlags.Identity">
  11063. <summary>
  11064. Fix the callers principal name
  11065. </summary>
  11066. <remarks>
  11067. CAUTION: May be slow to generate
  11068. </remarks>
  11069. </member>
  11070. <member name="F:log4net.Core.FixFlags.Exception">
  11071. <summary>
  11072. Fix the exception text
  11073. </summary>
  11074. </member>
  11075. <member name="F:log4net.Core.FixFlags.Properties">
  11076. <summary>
  11077. Fix the event properties. Active properties must implement <see cref="T:log4net.Core.IFixingRequired"/> in order to be eligible for fixing.
  11078. </summary>
  11079. </member>
  11080. <member name="F:log4net.Core.FixFlags.None">
  11081. <summary>
  11082. No fields fixed
  11083. </summary>
  11084. </member>
  11085. <member name="F:log4net.Core.FixFlags.All">
  11086. <summary>
  11087. All fields fixed
  11088. </summary>
  11089. </member>
  11090. <member name="F:log4net.Core.FixFlags.Partial">
  11091. <summary>
  11092. Partial fields fixed
  11093. </summary>
  11094. <remarks>
  11095. <para>
  11096. This set of partial fields gives good performance. The following fields are fixed:
  11097. </para>
  11098. <list type="bullet">
  11099. <item><description><see cref="F:log4net.Core.FixFlags.Message"/></description></item>
  11100. <item><description><see cref="F:log4net.Core.FixFlags.ThreadName"/></description></item>
  11101. <item><description><see cref="F:log4net.Core.FixFlags.Exception"/></description></item>
  11102. <item><description><see cref="F:log4net.Core.FixFlags.Domain"/></description></item>
  11103. <item><description><see cref="F:log4net.Core.FixFlags.Properties"/></description></item>
  11104. </list>
  11105. </remarks>
  11106. </member>
  11107. <member name="T:log4net.Core.LoggingEvent">
  11108. <summary>
  11109. The internal representation of logging events.
  11110. </summary>
  11111. <remarks>
  11112. <para>
  11113. When an affirmative decision is made to log then a
  11114. <see cref="T:log4net.Core.LoggingEvent"/> instance is created. This instance
  11115. is passed around to the different log4net components.
  11116. </para>
  11117. <para>
  11118. This class is of concern to those wishing to extend log4net.
  11119. </para>
  11120. <para>
  11121. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  11122. are considered volatile, that is the values are correct at the
  11123. time the event is delivered to appenders, but will not be consistent
  11124. at any time afterwards. If an event is to be stored and then processed
  11125. at a later time these volatile values must be fixed by calling
  11126. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  11127. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  11128. is essential to maintaining data consistency.
  11129. </para>
  11130. </remarks>
  11131. <author>Nicko Cadell</author>
  11132. <author>Gert Driesen</author>
  11133. <author>Douglas de la Torre</author>
  11134. <author>Daniel Cazzulino</author>
  11135. </member>
  11136. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,System.String,log4net.Core.Level,System.Object,System.Exception)">
  11137. <summary>
  11138. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11139. from the supplied parameters.
  11140. </summary>
  11141. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11142. the stack boundary into the logging system for this call.</param>
  11143. <param name="repository">The repository this event is logged in.</param>
  11144. <param name="loggerName">The name of the logger of this event.</param>
  11145. <param name="level">The level of this event.</param>
  11146. <param name="message">The message of this event.</param>
  11147. <param name="exception">The exception for this event.</param>
  11148. <remarks>
  11149. <para>
  11150. Except <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>, <see cref="P:log4net.Core.LoggingEvent.Level"/> and <see cref="P:log4net.Core.LoggingEvent.LoggerName"/>,
  11151. all fields of <c>LoggingEvent</c> are filled when actually needed. Call
  11152. <see cref="M:FixVolatileData()"/> to cache all data locally
  11153. to prevent inconsistencies.
  11154. </para>
  11155. <para>This method is called by the log4net framework
  11156. to create a logging event.
  11157. </para>
  11158. </remarks>
  11159. </member>
  11160. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData,log4net.Core.FixFlags)">
  11161. <summary>
  11162. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11163. using specific data.
  11164. </summary>
  11165. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11166. the stack boundary into the logging system for this call.</param>
  11167. <param name="repository">The repository this event is logged in.</param>
  11168. <param name="data">Data used to initialize the logging event.</param>
  11169. <param name="fixedData">The fields in the <paranref name="data"/> struct that have already been fixed.</param>
  11170. <remarks>
  11171. <para>
  11172. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  11173. to be created independently of the log4net framework. This can
  11174. be useful if you require a custom serialization scheme.
  11175. </para>
  11176. <para>
  11177. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  11178. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  11179. </para>
  11180. <para>
  11181. The <paramref name="fixedData"/> parameter should be used to specify which fields in the
  11182. <paramref name="data"/> struct have been preset. Fields not specified in the <paramref name="fixedData"/>
  11183. will be captured from the environment if requested or fixed.
  11184. </para>
  11185. </remarks>
  11186. </member>
  11187. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Type,log4net.Repository.ILoggerRepository,log4net.Core.LoggingEventData)">
  11188. <summary>
  11189. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11190. using specific data.
  11191. </summary>
  11192. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  11193. the stack boundary into the logging system for this call.</param>
  11194. <param name="repository">The repository this event is logged in.</param>
  11195. <param name="data">Data used to initialize the logging event.</param>
  11196. <remarks>
  11197. <para>
  11198. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  11199. to be created independently of the log4net framework. This can
  11200. be useful if you require a custom serialization scheme.
  11201. </para>
  11202. <para>
  11203. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  11204. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  11205. </para>
  11206. <para>
  11207. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  11208. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  11209. parameter and no other data should be captured from the environment.
  11210. </para>
  11211. </remarks>
  11212. </member>
  11213. <member name="M:log4net.Core.LoggingEvent.#ctor(log4net.Core.LoggingEventData)">
  11214. <summary>
  11215. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11216. using specific data.
  11217. </summary>
  11218. <param name="data">Data used to initialize the logging event.</param>
  11219. <remarks>
  11220. <para>
  11221. This constructor is provided to allow a <see cref="T:log4net.Core.LoggingEvent" />
  11222. to be created independently of the log4net framework. This can
  11223. be useful if you require a custom serialization scheme.
  11224. </para>
  11225. <para>
  11226. Use the <see cref="M:GetLoggingEventData(FixFlags)"/> method to obtain an
  11227. instance of the <see cref="T:log4net.Core.LoggingEventData"/> class.
  11228. </para>
  11229. <para>
  11230. This constructor sets this objects <see cref="P:log4net.Core.LoggingEvent.Fix"/> flags to <see cref="F:log4net.Core.FixFlags.All"/>,
  11231. this assumes that all the data relating to this event is passed in via the <paramref name="data"/>
  11232. parameter and no other data should be captured from the environment.
  11233. </para>
  11234. </remarks>
  11235. </member>
  11236. <member name="M:log4net.Core.LoggingEvent.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  11237. <summary>
  11238. Serialization constructor
  11239. </summary>
  11240. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  11241. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  11242. <remarks>
  11243. <para>
  11244. Initializes a new instance of the <see cref="T:log4net.Core.LoggingEvent" /> class
  11245. with serialized data.
  11246. </para>
  11247. </remarks>
  11248. </member>
  11249. <member name="P:log4net.Core.LoggingEvent.StartTime">
  11250. <summary>
  11251. Gets the time when the current process started.
  11252. </summary>
  11253. <value>
  11254. This is the time when this process started.
  11255. </value>
  11256. <remarks>
  11257. <para>
  11258. The TimeStamp is stored internally in UTC and converted to the local time zone for this computer.
  11259. </para>
  11260. <para>
  11261. Tries to get the start time for the current process.
  11262. Failing that it returns the time of the first call to
  11263. this property.
  11264. </para>
  11265. <para>
  11266. Note that AppDomains may be loaded and unloaded within the
  11267. same process without the process terminating and therefore
  11268. without the process start time being reset.
  11269. </para>
  11270. </remarks>
  11271. </member>
  11272. <member name="P:log4net.Core.LoggingEvent.StartTimeUtc">
  11273. <summary>
  11274. Gets the UTC time when the current process started.
  11275. </summary>
  11276. <value>
  11277. This is the UTC time when this process started.
  11278. </value>
  11279. <remarks>
  11280. <para>
  11281. Tries to get the start time for the current process.
  11282. Failing that it returns the time of the first call to
  11283. this property.
  11284. </para>
  11285. <para>
  11286. Note that AppDomains may be loaded and unloaded within the
  11287. same process without the process terminating and therefore
  11288. without the process start time being reset.
  11289. </para>
  11290. </remarks>
  11291. </member>
  11292. <member name="P:log4net.Core.LoggingEvent.Level">
  11293. <summary>
  11294. Gets the <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  11295. </summary>
  11296. <value>
  11297. The <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  11298. </value>
  11299. <remarks>
  11300. <para>
  11301. Gets the <see cref="P:log4net.Core.LoggingEvent.Level" /> of the logging event.
  11302. </para>
  11303. </remarks>
  11304. </member>
  11305. <member name="P:log4net.Core.LoggingEvent.TimeStamp">
  11306. <summary>
  11307. Gets the time of the logging event.
  11308. </summary>
  11309. <value>
  11310. The time of the logging event.
  11311. </value>
  11312. <remarks>
  11313. <para>
  11314. The TimeStamp is stored in UTC and converted to the local time zone for this computer.
  11315. </para>
  11316. </remarks>
  11317. </member>
  11318. <member name="P:log4net.Core.LoggingEvent.TimeStampUtc">
  11319. <summary>
  11320. Gets UTC the time of the logging event.
  11321. </summary>
  11322. <value>
  11323. The UTC time of the logging event.
  11324. </value>
  11325. </member>
  11326. <member name="P:log4net.Core.LoggingEvent.LoggerName">
  11327. <summary>
  11328. Gets the name of the logger that logged the event.
  11329. </summary>
  11330. <value>
  11331. The name of the logger that logged the event.
  11332. </value>
  11333. <remarks>
  11334. <para>
  11335. Gets the name of the logger that logged the event.
  11336. </para>
  11337. </remarks>
  11338. </member>
  11339. <member name="P:log4net.Core.LoggingEvent.LocationInformation">
  11340. <summary>
  11341. Gets the location information for this logging event.
  11342. </summary>
  11343. <value>
  11344. The location information for this logging event.
  11345. </value>
  11346. <remarks>
  11347. <para>
  11348. The collected information is cached for future use.
  11349. </para>
  11350. <para>
  11351. See the <see cref="T:log4net.Core.LocationInfo"/> class for more information on
  11352. supported frameworks and the different behavior in Debug and
  11353. Release builds.
  11354. </para>
  11355. </remarks>
  11356. </member>
  11357. <member name="P:log4net.Core.LoggingEvent.MessageObject">
  11358. <summary>
  11359. Gets the message object used to initialize this event.
  11360. </summary>
  11361. <value>
  11362. The message object used to initialize this event.
  11363. </value>
  11364. <remarks>
  11365. <para>
  11366. Gets the message object used to initialize this event.
  11367. Note that this event may not have a valid message object.
  11368. If the event is serialized the message object will not
  11369. be transferred. To get the text of the message the
  11370. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property must be used
  11371. not this property.
  11372. </para>
  11373. <para>
  11374. If there is no defined message object for this event then
  11375. null will be returned.
  11376. </para>
  11377. </remarks>
  11378. </member>
  11379. <member name="P:log4net.Core.LoggingEvent.ExceptionObject">
  11380. <summary>
  11381. Gets the exception object used to initialize this event.
  11382. </summary>
  11383. <value>
  11384. The exception object used to initialize this event.
  11385. </value>
  11386. <remarks>
  11387. <para>
  11388. Gets the exception object used to initialize this event.
  11389. Note that this event may not have a valid exception object.
  11390. If the event is serialized the exception object will not
  11391. be transferred. To get the text of the exception the
  11392. <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> method must be used
  11393. not this property.
  11394. </para>
  11395. <para>
  11396. If there is no defined exception object for this event then
  11397. null will be returned.
  11398. </para>
  11399. </remarks>
  11400. </member>
  11401. <member name="P:log4net.Core.LoggingEvent.Repository">
  11402. <summary>
  11403. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  11404. </summary>
  11405. <remarks>
  11406. <para>
  11407. The <see cref="T:log4net.Repository.ILoggerRepository"/> that this event was created in.
  11408. </para>
  11409. </remarks>
  11410. </member>
  11411. <member name="M:log4net.Core.LoggingEvent.EnsureRepository(log4net.Repository.ILoggerRepository)">
  11412. <summary>
  11413. Ensure that the repository is set.
  11414. </summary>
  11415. <param name="repository">the value for the repository</param>
  11416. </member>
  11417. <member name="P:log4net.Core.LoggingEvent.RenderedMessage">
  11418. <summary>
  11419. Gets the message, rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11420. </summary>
  11421. <value>
  11422. The message rendered through the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11423. </value>
  11424. <remarks>
  11425. <para>
  11426. The collected information is cached for future use.
  11427. </para>
  11428. </remarks>
  11429. </member>
  11430. <member name="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)">
  11431. <summary>
  11432. Write the rendered message to a TextWriter
  11433. </summary>
  11434. <param name="writer">the writer to write the message to</param>
  11435. <remarks>
  11436. <para>
  11437. Unlike the <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property this method
  11438. does store the message data in the internal cache. Therefore
  11439. if called only once this method should be faster than the
  11440. <see cref="P:log4net.Core.LoggingEvent.RenderedMessage"/> property, however if the message is
  11441. to be accessed multiple times then the property will be more efficient.
  11442. </para>
  11443. </remarks>
  11444. </member>
  11445. <member name="P:log4net.Core.LoggingEvent.ThreadName">
  11446. <summary>
  11447. Gets the name of the current thread.
  11448. </summary>
  11449. <value>
  11450. The name of the current thread, or the thread ID when
  11451. the name is not available.
  11452. </value>
  11453. <remarks>
  11454. <para>
  11455. The collected information is cached for future use.
  11456. </para>
  11457. </remarks>
  11458. </member>
  11459. <member name="P:log4net.Core.LoggingEvent.UserName">
  11460. <summary>
  11461. Gets the name of the current user.
  11462. </summary>
  11463. <value>
  11464. The name of the current user, or <c>NOT AVAILABLE</c> when the
  11465. underlying runtime has no support for retrieving the name of the
  11466. current user.
  11467. </value>
  11468. <remarks>
  11469. <para>
  11470. Calls <c>WindowsIdentity.GetCurrent().Name</c> to get the name of
  11471. the current windows user.
  11472. </para>
  11473. <para>
  11474. To improve performance, we could cache the string representation of
  11475. the name, and reuse that as long as the identity stayed constant.
  11476. Once the identity changed, we would need to re-assign and re-render
  11477. the string.
  11478. </para>
  11479. <para>
  11480. However, the <c>WindowsIdentity.GetCurrent()</c> call seems to
  11481. return different objects every time, so the current implementation
  11482. doesn't do this type of caching.
  11483. </para>
  11484. <para>
  11485. Timing for these operations:
  11486. </para>
  11487. <list type="table">
  11488. <listheader>
  11489. <term>Method</term>
  11490. <description>Results</description>
  11491. </listheader>
  11492. <item>
  11493. <term><c>WindowsIdentity.GetCurrent()</c></term>
  11494. <description>10000 loops, 00:00:00.2031250 seconds</description>
  11495. </item>
  11496. <item>
  11497. <term><c>WindowsIdentity.GetCurrent().Name</c></term>
  11498. <description>10000 loops, 00:00:08.0468750 seconds</description>
  11499. </item>
  11500. </list>
  11501. <para>
  11502. This means we could speed things up almost 40 times by caching the
  11503. value of the <c>WindowsIdentity.GetCurrent().Name</c> property, since
  11504. this takes (8.04-0.20) = 7.84375 seconds.
  11505. </para>
  11506. </remarks>
  11507. </member>
  11508. <member name="P:log4net.Core.LoggingEvent.Identity">
  11509. <summary>
  11510. Gets the identity of the current thread principal.
  11511. </summary>
  11512. <value>
  11513. The string name of the identity of the current thread principal.
  11514. </value>
  11515. <remarks>
  11516. <para>
  11517. Calls <c>System.Threading.Thread.CurrentPrincipal.Identity.Name</c> to get
  11518. the name of the current thread principal.
  11519. </para>
  11520. </remarks>
  11521. </member>
  11522. <member name="P:log4net.Core.LoggingEvent.Domain">
  11523. <summary>
  11524. Gets the AppDomain friendly name.
  11525. </summary>
  11526. <value>
  11527. The AppDomain friendly name.
  11528. </value>
  11529. <remarks>
  11530. <para>
  11531. Gets the AppDomain friendly name.
  11532. </para>
  11533. </remarks>
  11534. </member>
  11535. <member name="P:log4net.Core.LoggingEvent.Properties">
  11536. <summary>
  11537. Additional event specific properties.
  11538. </summary>
  11539. <value>
  11540. Additional event specific properties.
  11541. </value>
  11542. <remarks>
  11543. <para>
  11544. A logger or an appender may attach additional
  11545. properties to specific events. These properties
  11546. have a string key and an object value.
  11547. </para>
  11548. <para>
  11549. This property is for events that have been added directly to
  11550. this event. The aggregate properties (which include these
  11551. event properties) can be retrieved using <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/>
  11552. and <see cref="M:log4net.Core.LoggingEvent.GetProperties"/>.
  11553. </para>
  11554. <para>
  11555. Once the properties have been fixed <see cref="P:log4net.Core.LoggingEvent.Fix"/> this property
  11556. returns the combined cached properties. This ensures that updates to
  11557. this property are always reflected in the underlying storage. When
  11558. returning the combined properties there may be more keys in the
  11559. Dictionary than expected.
  11560. </para>
  11561. </remarks>
  11562. </member>
  11563. <member name="P:log4net.Core.LoggingEvent.Fix">
  11564. <summary>
  11565. The fixed fields in this event
  11566. </summary>
  11567. <value>
  11568. The set of fields that are fixed in this event
  11569. </value>
  11570. <remarks>
  11571. <para>
  11572. Fields will not be fixed if they have previously been fixed.
  11573. It is not possible to 'unfix' a field.
  11574. </para>
  11575. </remarks>
  11576. </member>
  11577. <member name="M:log4net.Core.LoggingEvent.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  11578. <summary>
  11579. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  11580. </summary>
  11581. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
  11582. <param name="context">The destination for this serialization.</param>
  11583. <remarks>
  11584. <para>
  11585. The data in this event must be fixed before it can be serialized.
  11586. </para>
  11587. <para>
  11588. The <see cref="M:FixVolatileData()"/> method must be called during the
  11589. <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)"/> method call if this event
  11590. is to be used outside that method.
  11591. </para>
  11592. </remarks>
  11593. </member>
  11594. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData">
  11595. <summary>
  11596. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent" />.
  11597. </summary>
  11598. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  11599. <remarks>
  11600. <para>
  11601. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  11602. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  11603. </para>
  11604. <para>
  11605. Does a <see cref="F:log4net.Core.FixFlags.Partial"/> fix of the data
  11606. in the logging event before returning the event data.
  11607. </para>
  11608. </remarks>
  11609. </member>
  11610. <member name="M:log4net.Core.LoggingEvent.GetLoggingEventData(log4net.Core.FixFlags)">
  11611. <summary>
  11612. Gets the portable data for this <see cref="T:log4net.Core.LoggingEvent" />.
  11613. </summary>
  11614. <param name="fixFlags">The set of data to ensure is fixed in the LoggingEventData</param>
  11615. <returns>The <see cref="T:log4net.Core.LoggingEventData"/> for this event.</returns>
  11616. <remarks>
  11617. <para>
  11618. A new <see cref="T:log4net.Core.LoggingEvent"/> can be constructed using a
  11619. <see cref="T:log4net.Core.LoggingEventData"/> instance.
  11620. </para>
  11621. </remarks>
  11622. </member>
  11623. <member name="M:log4net.Core.LoggingEvent.GetExceptionStrRep">
  11624. <summary>
  11625. Returns this event's exception's rendered using the
  11626. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11627. </summary>
  11628. <returns>
  11629. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11630. </returns>
  11631. <remarks>
  11632. <para>
  11633. <b>Obsolete. Use <see cref="M:log4net.Core.LoggingEvent.GetExceptionString"/> instead.</b>
  11634. </para>
  11635. </remarks>
  11636. </member>
  11637. <member name="M:log4net.Core.LoggingEvent.GetExceptionString">
  11638. <summary>
  11639. Returns this event's exception's rendered using the
  11640. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11641. </summary>
  11642. <returns>
  11643. This event's exception's rendered using the <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11644. </returns>
  11645. <remarks>
  11646. <para>
  11647. Returns this event's exception's rendered using the
  11648. <see cref="P:log4net.Repository.ILoggerRepository.RendererMap" />.
  11649. </para>
  11650. </remarks>
  11651. </member>
  11652. <member name="M:log4net.Core.LoggingEvent.FixVolatileData">
  11653. <summary>
  11654. Fix instance fields that hold volatile data.
  11655. </summary>
  11656. <remarks>
  11657. <para>
  11658. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  11659. are considered volatile, that is the values are correct at the
  11660. time the event is delivered to appenders, but will not be consistent
  11661. at any time afterwards. If an event is to be stored and then processed
  11662. at a later time these volatile values must be fixed by calling
  11663. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  11664. incurred by calling <see cref="M:FixVolatileData()"/> but it
  11665. is essential to maintaining data consistency.
  11666. </para>
  11667. <para>
  11668. Calling <see cref="M:FixVolatileData()"/> is equivalent to
  11669. calling <see cref="M:FixVolatileData(bool)"/> passing the parameter
  11670. <c>false</c>.
  11671. </para>
  11672. <para>
  11673. See <see cref="M:FixVolatileData(bool)"/> for more
  11674. information.
  11675. </para>
  11676. </remarks>
  11677. </member>
  11678. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(System.Boolean)">
  11679. <summary>
  11680. Fixes instance fields that hold volatile data.
  11681. </summary>
  11682. <param name="fastButLoose">Set to <c>true</c> to not fix data that takes a long time to fix.</param>
  11683. <remarks>
  11684. <para>
  11685. Some of the values in instances of <see cref="T:log4net.Core.LoggingEvent"/>
  11686. are considered volatile, that is the values are correct at the
  11687. time the event is delivered to appenders, but will not be consistent
  11688. at any time afterwards. If an event is to be stored and then processed
  11689. at a later time these volatile values must be fixed by calling
  11690. <see cref="M:FixVolatileData()"/>. There is a performance penalty
  11691. for incurred by calling <see cref="M:FixVolatileData()"/> but it
  11692. is essential to maintaining data consistency.
  11693. </para>
  11694. <para>
  11695. The <paramref name="fastButLoose"/> param controls the data that
  11696. is fixed. Some of the data that can be fixed takes a long time to
  11697. generate, therefore if you do not require those settings to be fixed
  11698. they can be ignored by setting the <paramref name="fastButLoose"/> param
  11699. to <c>true</c>. This setting will ignore the <see cref="P:log4net.Core.LoggingEvent.LocationInformation"/>
  11700. and <see cref="P:log4net.Core.LoggingEvent.UserName"/> settings.
  11701. </para>
  11702. <para>
  11703. Set <paramref name="fastButLoose"/> to <c>false</c> to ensure that all
  11704. settings are fixed.
  11705. </para>
  11706. </remarks>
  11707. </member>
  11708. <member name="M:log4net.Core.LoggingEvent.FixVolatileData(log4net.Core.FixFlags)">
  11709. <summary>
  11710. Fix the fields specified by the <see cref="T:log4net.Core.FixFlags"/> parameter
  11711. </summary>
  11712. <param name="flags">the fields to fix</param>
  11713. <remarks>
  11714. <para>
  11715. Only fields specified in the <paramref name="flags"/> will be fixed.
  11716. Fields will not be fixed if they have previously been fixed.
  11717. It is not possible to 'unfix' a field.
  11718. </para>
  11719. </remarks>
  11720. </member>
  11721. <member name="M:log4net.Core.LoggingEvent.LookupProperty(System.String)">
  11722. <summary>
  11723. Lookup a composite property in this event
  11724. </summary>
  11725. <param name="key">the key for the property to lookup</param>
  11726. <returns>the value for the property</returns>
  11727. <remarks>
  11728. <para>
  11729. This event has composite properties that combine together properties from
  11730. several different contexts in the following order:
  11731. <list type="definition">
  11732. <item>
  11733. <term>this events properties</term>
  11734. <description>
  11735. This event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  11736. properties are specific to this event only.
  11737. </description>
  11738. </item>
  11739. <item>
  11740. <term>the thread properties</term>
  11741. <description>
  11742. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  11743. thread. These properties are shared by all events logged on this thread.
  11744. </description>
  11745. </item>
  11746. <item>
  11747. <term>the global properties</term>
  11748. <description>
  11749. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  11750. properties are shared by all the threads in the AppDomain.
  11751. </description>
  11752. </item>
  11753. </list>
  11754. </para>
  11755. </remarks>
  11756. </member>
  11757. <member name="M:log4net.Core.LoggingEvent.GetProperties">
  11758. <summary>
  11759. Get all the composite properties in this event
  11760. </summary>
  11761. <returns>the <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the properties</returns>
  11762. <remarks>
  11763. <para>
  11764. See <see cref="M:log4net.Core.LoggingEvent.LookupProperty(System.String)"/> for details of the composite properties
  11765. stored by the event.
  11766. </para>
  11767. <para>
  11768. This method returns a single <see cref="T:log4net.Util.PropertiesDictionary"/> containing all the
  11769. properties defined for this event.
  11770. </para>
  11771. </remarks>
  11772. </member>
  11773. <member name="F:log4net.Core.LoggingEvent.m_data">
  11774. <summary>
  11775. The internal logging event data.
  11776. </summary>
  11777. </member>
  11778. <member name="F:log4net.Core.LoggingEvent.m_compositeProperties">
  11779. <summary>
  11780. The internal logging event data.
  11781. </summary>
  11782. </member>
  11783. <member name="F:log4net.Core.LoggingEvent.m_eventProperties">
  11784. <summary>
  11785. The internal logging event data.
  11786. </summary>
  11787. </member>
  11788. <member name="F:log4net.Core.LoggingEvent.m_callerStackBoundaryDeclaringType">
  11789. <summary>
  11790. The fully qualified Type of the calling
  11791. logger class in the stack frame (i.e. the declaring type of the method).
  11792. </summary>
  11793. </member>
  11794. <member name="F:log4net.Core.LoggingEvent.m_message">
  11795. <summary>
  11796. The application supplied message of logging event.
  11797. </summary>
  11798. </member>
  11799. <member name="F:log4net.Core.LoggingEvent.m_thrownException">
  11800. <summary>
  11801. The exception that was thrown.
  11802. </summary>
  11803. <remarks>
  11804. This is not serialized. The string representation
  11805. is serialized instead.
  11806. </remarks>
  11807. </member>
  11808. <member name="F:log4net.Core.LoggingEvent.m_repository">
  11809. <summary>
  11810. The repository that generated the logging event
  11811. </summary>
  11812. <remarks>
  11813. This is not serialized.
  11814. </remarks>
  11815. </member>
  11816. <member name="F:log4net.Core.LoggingEvent.m_fixFlags">
  11817. <summary>
  11818. The fix state for this event
  11819. </summary>
  11820. <remarks>
  11821. These flags indicate which fields have been fixed.
  11822. Not serialized.
  11823. </remarks>
  11824. </member>
  11825. <member name="F:log4net.Core.LoggingEvent.m_cacheUpdatable">
  11826. <summary>
  11827. Indicated that the internal cache is updateable (ie not fixed)
  11828. </summary>
  11829. <remarks>
  11830. This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler
  11831. changes in the caching strategy.
  11832. </remarks>
  11833. </member>
  11834. <member name="F:log4net.Core.LoggingEvent.HostNameProperty">
  11835. <summary>
  11836. The key into the Properties map for the host name value.
  11837. </summary>
  11838. </member>
  11839. <member name="F:log4net.Core.LoggingEvent.IdentityProperty">
  11840. <summary>
  11841. The key into the Properties map for the thread identity value.
  11842. </summary>
  11843. </member>
  11844. <member name="F:log4net.Core.LoggingEvent.UserNameProperty">
  11845. <summary>
  11846. The key into the Properties map for the user name value.
  11847. </summary>
  11848. </member>
  11849. <member name="T:log4net.Core.LogImpl">
  11850. <summary>
  11851. Implementation of <see cref="T:log4net.ILog"/> wrapper interface.
  11852. </summary>
  11853. <remarks>
  11854. <para>
  11855. This implementation of the <see cref="T:log4net.ILog"/> interface
  11856. forwards to the <see cref="T:log4net.Core.ILogger"/> held by the base class.
  11857. </para>
  11858. <para>
  11859. This logger has methods to allow the caller to log at the following
  11860. levels:
  11861. </para>
  11862. <list type="definition">
  11863. <item>
  11864. <term>DEBUG</term>
  11865. <description>
  11866. The <see cref="M:Debug(object)"/> and <see cref="M:DebugFormat(string, object[])"/> methods log messages
  11867. at the <c>DEBUG</c> level. That is the level with that name defined in the
  11868. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11869. for this level is <see cref="F:log4net.Core.Level.Debug"/>. The <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  11870. property tests if this level is enabled for logging.
  11871. </description>
  11872. </item>
  11873. <item>
  11874. <term>INFO</term>
  11875. <description>
  11876. The <see cref="M:Info(object)"/> and <see cref="M:InfoFormat(string, object[])"/> methods log messages
  11877. at the <c>INFO</c> level. That is the level with that name defined in the
  11878. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11879. for this level is <see cref="F:log4net.Core.Level.Info"/>. The <see cref="P:log4net.Core.LogImpl.IsInfoEnabled"/>
  11880. property tests if this level is enabled for logging.
  11881. </description>
  11882. </item>
  11883. <item>
  11884. <term>WARN</term>
  11885. <description>
  11886. The <see cref="M:Warn(object)"/> and <see cref="M:WarnFormat(string, object[])"/> methods log messages
  11887. at the <c>WARN</c> level. That is the level with that name defined in the
  11888. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11889. for this level is <see cref="F:log4net.Core.Level.Warn"/>. The <see cref="P:log4net.Core.LogImpl.IsWarnEnabled"/>
  11890. property tests if this level is enabled for logging.
  11891. </description>
  11892. </item>
  11893. <item>
  11894. <term>ERROR</term>
  11895. <description>
  11896. The <see cref="M:Error(object)"/> and <see cref="M:ErrorFormat(string, object[])"/> methods log messages
  11897. at the <c>ERROR</c> level. That is the level with that name defined in the
  11898. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11899. for this level is <see cref="F:log4net.Core.Level.Error"/>. The <see cref="P:log4net.Core.LogImpl.IsErrorEnabled"/>
  11900. property tests if this level is enabled for logging.
  11901. </description>
  11902. </item>
  11903. <item>
  11904. <term>FATAL</term>
  11905. <description>
  11906. The <see cref="M:Fatal(object)"/> and <see cref="M:FatalFormat(string, object[])"/> methods log messages
  11907. at the <c>FATAL</c> level. That is the level with that name defined in the
  11908. repositories <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/>. The default value
  11909. for this level is <see cref="F:log4net.Core.Level.Fatal"/>. The <see cref="P:log4net.Core.LogImpl.IsFatalEnabled"/>
  11910. property tests if this level is enabled for logging.
  11911. </description>
  11912. </item>
  11913. </list>
  11914. <para>
  11915. The values for these levels and their semantic meanings can be changed by
  11916. configuring the <see cref="P:log4net.Repository.ILoggerRepository.LevelMap"/> for the repository.
  11917. </para>
  11918. </remarks>
  11919. <author>Nicko Cadell</author>
  11920. <author>Gert Driesen</author>
  11921. </member>
  11922. <member name="M:log4net.Core.LogImpl.#ctor(log4net.Core.ILogger)">
  11923. <summary>
  11924. Construct a new wrapper for the specified logger.
  11925. </summary>
  11926. <param name="logger">The logger to wrap.</param>
  11927. <remarks>
  11928. <para>
  11929. Construct a new wrapper for the specified logger.
  11930. </para>
  11931. </remarks>
  11932. </member>
  11933. <member name="M:log4net.Core.LogImpl.ReloadLevels(log4net.Repository.ILoggerRepository)">
  11934. <summary>
  11935. Virtual method called when the configuration of the repository changes
  11936. </summary>
  11937. <param name="repository">the repository holding the levels</param>
  11938. <remarks>
  11939. <para>
  11940. Virtual method called when the configuration of the repository changes
  11941. </para>
  11942. </remarks>
  11943. </member>
  11944. <member name="M:log4net.Core.LogImpl.Debug(System.Object)">
  11945. <summary>
  11946. Logs a message object with the <c>DEBUG</c> level.
  11947. </summary>
  11948. <param name="message">The message object to log.</param>
  11949. <remarks>
  11950. <para>
  11951. This method first checks if this logger is <c>DEBUG</c>
  11952. enabled by comparing the level of this logger with the
  11953. <c>DEBUG</c> level. If this logger is
  11954. <c>DEBUG</c> enabled, then it converts the message object
  11955. (passed as parameter) to a string by invoking the appropriate
  11956. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  11957. proceeds to call all the registered appenders in this logger
  11958. and also higher in the hierarchy depending on the value of the
  11959. additivity flag.
  11960. </para>
  11961. <para>
  11962. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  11963. to this method will print the name of the <see cref="T:System.Exception"/>
  11964. but no stack trace. To print a stack trace use the
  11965. <see cref="M:Debug(object,Exception)"/> form instead.
  11966. </para>
  11967. </remarks>
  11968. </member>
  11969. <member name="M:log4net.Core.LogImpl.Debug(System.Object,System.Exception)">
  11970. <summary>
  11971. Logs a message object with the <c>DEBUG</c> level
  11972. </summary>
  11973. <param name="message">The message object to log.</param>
  11974. <param name="exception">The exception to log, including its stack trace.</param>
  11975. <remarks>
  11976. <para>
  11977. Logs a message object with the <c>DEBUG</c> level including
  11978. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/> passed
  11979. as a parameter.
  11980. </para>
  11981. <para>
  11982. See the <see cref="M:Debug(object)"/> form for more detailed information.
  11983. </para>
  11984. </remarks>
  11985. <seealso cref="M:Debug(object)"/>
  11986. </member>
  11987. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object[])">
  11988. <summary>
  11989. Logs a formatted message string with the <c>DEBUG</c> level.
  11990. </summary>
  11991. <param name="format">A String containing zero or more format items</param>
  11992. <param name="args">An Object array containing zero or more objects to format</param>
  11993. <remarks>
  11994. <para>
  11995. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  11996. <c>String.Format</c> for details of the syntax of the format string and the behavior
  11997. of the formatting.
  11998. </para>
  11999. <para>
  12000. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12001. format provider. To specify a localized provider use the
  12002. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  12003. </para>
  12004. <para>
  12005. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12006. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12007. methods instead.
  12008. </para>
  12009. </remarks>
  12010. </member>
  12011. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object)">
  12012. <summary>
  12013. Logs a formatted message string with the <c>DEBUG</c> level.
  12014. </summary>
  12015. <param name="format">A String containing zero or more format items</param>
  12016. <param name="arg0">An Object to format</param>
  12017. <remarks>
  12018. <para>
  12019. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12020. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12021. of the formatting.
  12022. </para>
  12023. <para>
  12024. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12025. format provider. To specify a localized provider use the
  12026. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  12027. </para>
  12028. <para>
  12029. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12030. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12031. methods instead.
  12032. </para>
  12033. </remarks>
  12034. </member>
  12035. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object)">
  12036. <summary>
  12037. Logs a formatted message string with the <c>DEBUG</c> level.
  12038. </summary>
  12039. <param name="format">A String containing zero or more format items</param>
  12040. <param name="arg0">An Object to format</param>
  12041. <param name="arg1">An Object to format</param>
  12042. <remarks>
  12043. <para>
  12044. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12045. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12046. of the formatting.
  12047. </para>
  12048. <para>
  12049. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12050. format provider. To specify a localized provider use the
  12051. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  12052. </para>
  12053. <para>
  12054. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12055. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12056. methods instead.
  12057. </para>
  12058. </remarks>
  12059. </member>
  12060. <member name="M:log4net.Core.LogImpl.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  12061. <summary>
  12062. Logs a formatted message string with the <c>DEBUG</c> level.
  12063. </summary>
  12064. <param name="format">A String containing zero or more format items</param>
  12065. <param name="arg0">An Object to format</param>
  12066. <param name="arg1">An Object to format</param>
  12067. <param name="arg2">An Object to format</param>
  12068. <remarks>
  12069. <para>
  12070. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12071. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12072. of the formatting.
  12073. </para>
  12074. <para>
  12075. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12076. format provider. To specify a localized provider use the
  12077. <see cref="M:DebugFormat(IFormatProvider,string,object[])"/> method.
  12078. </para>
  12079. <para>
  12080. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12081. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12082. methods instead.
  12083. </para>
  12084. </remarks>
  12085. </member>
  12086. <member name="M:log4net.Core.LogImpl.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  12087. <summary>
  12088. Logs a formatted message string with the <c>DEBUG</c> level.
  12089. </summary>
  12090. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12091. <param name="format">A String containing zero or more format items</param>
  12092. <param name="args">An Object array containing zero or more objects to format</param>
  12093. <remarks>
  12094. <para>
  12095. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12096. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12097. of the formatting.
  12098. </para>
  12099. <para>
  12100. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12101. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object)"/>
  12102. methods instead.
  12103. </para>
  12104. </remarks>
  12105. </member>
  12106. <member name="M:log4net.Core.LogImpl.Info(System.Object)">
  12107. <summary>
  12108. Logs a message object with the <c>INFO</c> level.
  12109. </summary>
  12110. <param name="message">The message object to log.</param>
  12111. <remarks>
  12112. <para>
  12113. This method first checks if this logger is <c>INFO</c>
  12114. enabled by comparing the level of this logger with the
  12115. <c>INFO</c> level. If this logger is
  12116. <c>INFO</c> enabled, then it converts the message object
  12117. (passed as parameter) to a string by invoking the appropriate
  12118. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  12119. proceeds to call all the registered appenders in this logger
  12120. and also higher in the hierarchy depending on the value of
  12121. the additivity flag.
  12122. </para>
  12123. <para>
  12124. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  12125. to this method will print the name of the <see cref="T:System.Exception"/>
  12126. but no stack trace. To print a stack trace use the
  12127. <see cref="M:Info(object,Exception)"/> form instead.
  12128. </para>
  12129. </remarks>
  12130. </member>
  12131. <member name="M:log4net.Core.LogImpl.Info(System.Object,System.Exception)">
  12132. <summary>
  12133. Logs a message object with the <c>INFO</c> level.
  12134. </summary>
  12135. <param name="message">The message object to log.</param>
  12136. <param name="exception">The exception to log, including its stack trace.</param>
  12137. <remarks>
  12138. <para>
  12139. Logs a message object with the <c>INFO</c> level including
  12140. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  12141. passed as a parameter.
  12142. </para>
  12143. <para>
  12144. See the <see cref="M:Info(object)"/> form for more detailed information.
  12145. </para>
  12146. </remarks>
  12147. <seealso cref="M:Info(object)"/>
  12148. </member>
  12149. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object[])">
  12150. <summary>
  12151. Logs a formatted message string with the <c>INFO</c> level.
  12152. </summary>
  12153. <param name="format">A String containing zero or more format items</param>
  12154. <param name="args">An Object array containing zero or more objects to format</param>
  12155. <remarks>
  12156. <para>
  12157. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12158. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12159. of the formatting.
  12160. </para>
  12161. <para>
  12162. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12163. format provider. To specify a localized provider use the
  12164. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  12165. </para>
  12166. <para>
  12167. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12168. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12169. methods instead.
  12170. </para>
  12171. </remarks>
  12172. </member>
  12173. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object)">
  12174. <summary>
  12175. Logs a formatted message string with the <c>INFO</c> level.
  12176. </summary>
  12177. <param name="format">A String containing zero or more format items</param>
  12178. <param name="arg0">An Object to format</param>
  12179. <remarks>
  12180. <para>
  12181. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12182. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12183. of the formatting.
  12184. </para>
  12185. <para>
  12186. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12187. format provider. To specify a localized provider use the
  12188. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  12189. </para>
  12190. <para>
  12191. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12192. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12193. methods instead.
  12194. </para>
  12195. </remarks>
  12196. </member>
  12197. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object)">
  12198. <summary>
  12199. Logs a formatted message string with the <c>INFO</c> level.
  12200. </summary>
  12201. <param name="format">A String containing zero or more format items</param>
  12202. <param name="arg0">An Object to format</param>
  12203. <param name="arg1">An Object to format</param>
  12204. <remarks>
  12205. <para>
  12206. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12207. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12208. of the formatting.
  12209. </para>
  12210. <para>
  12211. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12212. format provider. To specify a localized provider use the
  12213. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  12214. </para>
  12215. <para>
  12216. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12217. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12218. methods instead.
  12219. </para>
  12220. </remarks>
  12221. </member>
  12222. <member name="M:log4net.Core.LogImpl.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  12223. <summary>
  12224. Logs a formatted message string with the <c>INFO</c> level.
  12225. </summary>
  12226. <param name="format">A String containing zero or more format items</param>
  12227. <param name="arg0">An Object to format</param>
  12228. <param name="arg1">An Object to format</param>
  12229. <param name="arg2">An Object to format</param>
  12230. <remarks>
  12231. <para>
  12232. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12233. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12234. of the formatting.
  12235. </para>
  12236. <para>
  12237. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12238. format provider. To specify a localized provider use the
  12239. <see cref="M:InfoFormat(IFormatProvider,string,object[])"/> method.
  12240. </para>
  12241. <para>
  12242. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12243. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12244. methods instead.
  12245. </para>
  12246. </remarks>
  12247. </member>
  12248. <member name="M:log4net.Core.LogImpl.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  12249. <summary>
  12250. Logs a formatted message string with the <c>INFO</c> level.
  12251. </summary>
  12252. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12253. <param name="format">A String containing zero or more format items</param>
  12254. <param name="args">An Object array containing zero or more objects to format</param>
  12255. <remarks>
  12256. <para>
  12257. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12258. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12259. of the formatting.
  12260. </para>
  12261. <para>
  12262. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12263. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  12264. methods instead.
  12265. </para>
  12266. </remarks>
  12267. </member>
  12268. <member name="M:log4net.Core.LogImpl.Warn(System.Object)">
  12269. <summary>
  12270. Logs a message object with the <c>WARN</c> level.
  12271. </summary>
  12272. <param name="message">the message object to log</param>
  12273. <remarks>
  12274. <para>
  12275. This method first checks if this logger is <c>WARN</c>
  12276. enabled by comparing the level of this logger with the
  12277. <c>WARN</c> level. If this logger is
  12278. <c>WARN</c> enabled, then it converts the message object
  12279. (passed as parameter) to a string by invoking the appropriate
  12280. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  12281. proceeds to call all the registered appenders in this logger and
  12282. also higher in the hierarchy depending on the value of the
  12283. additivity flag.
  12284. </para>
  12285. <para>
  12286. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  12287. method will print the name of the <see cref="T:System.Exception"/> but no
  12288. stack trace. To print a stack trace use the
  12289. <see cref="M:Warn(object,Exception)"/> form instead.
  12290. </para>
  12291. </remarks>
  12292. </member>
  12293. <member name="M:log4net.Core.LogImpl.Warn(System.Object,System.Exception)">
  12294. <summary>
  12295. Logs a message object with the <c>WARN</c> level
  12296. </summary>
  12297. <param name="message">The message object to log.</param>
  12298. <param name="exception">The exception to log, including its stack trace.</param>
  12299. <remarks>
  12300. <para>
  12301. Logs a message object with the <c>WARN</c> level including
  12302. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  12303. passed as a parameter.
  12304. </para>
  12305. <para>
  12306. See the <see cref="M:Warn(object)"/> form for more detailed information.
  12307. </para>
  12308. </remarks>
  12309. <seealso cref="M:Warn(object)"/>
  12310. </member>
  12311. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object[])">
  12312. <summary>
  12313. Logs a formatted message string with the <c>WARN</c> level.
  12314. </summary>
  12315. <param name="format">A String containing zero or more format items</param>
  12316. <param name="args">An Object array containing zero or more objects to format</param>
  12317. <remarks>
  12318. <para>
  12319. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12320. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12321. of the formatting.
  12322. </para>
  12323. <para>
  12324. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12325. format provider. To specify a localized provider use the
  12326. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  12327. </para>
  12328. <para>
  12329. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12330. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12331. methods instead.
  12332. </para>
  12333. </remarks>
  12334. </member>
  12335. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object)">
  12336. <summary>
  12337. Logs a formatted message string with the <c>WARN</c> level.
  12338. </summary>
  12339. <param name="format">A String containing zero or more format items</param>
  12340. <param name="arg0">An Object to format</param>
  12341. <remarks>
  12342. <para>
  12343. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12344. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12345. of the formatting.
  12346. </para>
  12347. <para>
  12348. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12349. format provider. To specify a localized provider use the
  12350. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  12351. </para>
  12352. <para>
  12353. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12354. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12355. methods instead.
  12356. </para>
  12357. </remarks>
  12358. </member>
  12359. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object)">
  12360. <summary>
  12361. Logs a formatted message string with the <c>WARN</c> level.
  12362. </summary>
  12363. <param name="format">A String containing zero or more format items</param>
  12364. <param name="arg0">An Object to format</param>
  12365. <param name="arg1">An Object to format</param>
  12366. <remarks>
  12367. <para>
  12368. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12369. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12370. of the formatting.
  12371. </para>
  12372. <para>
  12373. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12374. format provider. To specify a localized provider use the
  12375. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  12376. </para>
  12377. <para>
  12378. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12379. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12380. methods instead.
  12381. </para>
  12382. </remarks>
  12383. </member>
  12384. <member name="M:log4net.Core.LogImpl.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  12385. <summary>
  12386. Logs a formatted message string with the <c>WARN</c> level.
  12387. </summary>
  12388. <param name="format">A String containing zero or more format items</param>
  12389. <param name="arg0">An Object to format</param>
  12390. <param name="arg1">An Object to format</param>
  12391. <param name="arg2">An Object to format</param>
  12392. <remarks>
  12393. <para>
  12394. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12395. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12396. of the formatting.
  12397. </para>
  12398. <para>
  12399. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12400. format provider. To specify a localized provider use the
  12401. <see cref="M:WarnFormat(IFormatProvider,string,object[])"/> method.
  12402. </para>
  12403. <para>
  12404. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12405. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12406. methods instead.
  12407. </para>
  12408. </remarks>
  12409. </member>
  12410. <member name="M:log4net.Core.LogImpl.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  12411. <summary>
  12412. Logs a formatted message string with the <c>WARN</c> level.
  12413. </summary>
  12414. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12415. <param name="format">A String containing zero or more format items</param>
  12416. <param name="args">An Object array containing zero or more objects to format</param>
  12417. <remarks>
  12418. <para>
  12419. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12420. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12421. of the formatting.
  12422. </para>
  12423. <para>
  12424. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12425. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  12426. methods instead.
  12427. </para>
  12428. </remarks>
  12429. </member>
  12430. <member name="M:log4net.Core.LogImpl.Error(System.Object)">
  12431. <summary>
  12432. Logs a message object with the <c>ERROR</c> level.
  12433. </summary>
  12434. <param name="message">The message object to log.</param>
  12435. <remarks>
  12436. <para>
  12437. This method first checks if this logger is <c>ERROR</c>
  12438. enabled by comparing the level of this logger with the
  12439. <c>ERROR</c> level. If this logger is
  12440. <c>ERROR</c> enabled, then it converts the message object
  12441. (passed as parameter) to a string by invoking the appropriate
  12442. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  12443. proceeds to call all the registered appenders in this logger and
  12444. also higher in the hierarchy depending on the value of the
  12445. additivity flag.
  12446. </para>
  12447. <para>
  12448. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  12449. method will print the name of the <see cref="T:System.Exception"/> but no
  12450. stack trace. To print a stack trace use the
  12451. <see cref="M:Error(object,Exception)"/> form instead.
  12452. </para>
  12453. </remarks>
  12454. </member>
  12455. <member name="M:log4net.Core.LogImpl.Error(System.Object,System.Exception)">
  12456. <summary>
  12457. Logs a message object with the <c>ERROR</c> level
  12458. </summary>
  12459. <param name="message">The message object to log.</param>
  12460. <param name="exception">The exception to log, including its stack trace.</param>
  12461. <remarks>
  12462. <para>
  12463. Logs a message object with the <c>ERROR</c> level including
  12464. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  12465. passed as a parameter.
  12466. </para>
  12467. <para>
  12468. See the <see cref="M:Error(object)"/> form for more detailed information.
  12469. </para>
  12470. </remarks>
  12471. <seealso cref="M:Error(object)"/>
  12472. </member>
  12473. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object[])">
  12474. <summary>
  12475. Logs a formatted message string with the <c>ERROR</c> level.
  12476. </summary>
  12477. <param name="format">A String containing zero or more format items</param>
  12478. <param name="args">An Object array containing zero or more objects to format</param>
  12479. <remarks>
  12480. <para>
  12481. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12482. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12483. of the formatting.
  12484. </para>
  12485. <para>
  12486. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12487. format provider. To specify a localized provider use the
  12488. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  12489. </para>
  12490. <para>
  12491. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12492. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12493. methods instead.
  12494. </para>
  12495. </remarks>
  12496. </member>
  12497. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object)">
  12498. <summary>
  12499. Logs a formatted message string with the <c>ERROR</c> level.
  12500. </summary>
  12501. <param name="format">A String containing zero or more format items</param>
  12502. <param name="arg0">An Object to format</param>
  12503. <remarks>
  12504. <para>
  12505. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12506. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12507. of the formatting.
  12508. </para>
  12509. <para>
  12510. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12511. format provider. To specify a localized provider use the
  12512. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  12513. </para>
  12514. <para>
  12515. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12516. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12517. methods instead.
  12518. </para>
  12519. </remarks>
  12520. </member>
  12521. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object)">
  12522. <summary>
  12523. Logs a formatted message string with the <c>ERROR</c> level.
  12524. </summary>
  12525. <param name="format">A String containing zero or more format items</param>
  12526. <param name="arg0">An Object to format</param>
  12527. <param name="arg1">An Object to format</param>
  12528. <remarks>
  12529. <para>
  12530. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12531. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12532. of the formatting.
  12533. </para>
  12534. <para>
  12535. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12536. format provider. To specify a localized provider use the
  12537. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  12538. </para>
  12539. <para>
  12540. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12541. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12542. methods instead.
  12543. </para>
  12544. </remarks>
  12545. </member>
  12546. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  12547. <summary>
  12548. Logs a formatted message string with the <c>ERROR</c> level.
  12549. </summary>
  12550. <param name="format">A String containing zero or more format items</param>
  12551. <param name="arg0">An Object to format</param>
  12552. <param name="arg1">An Object to format</param>
  12553. <param name="arg2">An Object to format</param>
  12554. <remarks>
  12555. <para>
  12556. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12557. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12558. of the formatting.
  12559. </para>
  12560. <para>
  12561. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12562. format provider. To specify a localized provider use the
  12563. <see cref="M:ErrorFormat(IFormatProvider,string,object[])"/> method.
  12564. </para>
  12565. <para>
  12566. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12567. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12568. methods instead.
  12569. </para>
  12570. </remarks>
  12571. </member>
  12572. <member name="M:log4net.Core.LogImpl.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  12573. <summary>
  12574. Logs a formatted message string with the <c>ERROR</c> level.
  12575. </summary>
  12576. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12577. <param name="format">A String containing zero or more format items</param>
  12578. <param name="args">An Object array containing zero or more objects to format</param>
  12579. <remarks>
  12580. <para>
  12581. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12582. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12583. of the formatting.
  12584. </para>
  12585. <para>
  12586. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12587. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  12588. methods instead.
  12589. </para>
  12590. </remarks>
  12591. </member>
  12592. <member name="M:log4net.Core.LogImpl.Fatal(System.Object)">
  12593. <summary>
  12594. Logs a message object with the <c>FATAL</c> level.
  12595. </summary>
  12596. <param name="message">The message object to log.</param>
  12597. <remarks>
  12598. <para>
  12599. This method first checks if this logger is <c>FATAL</c>
  12600. enabled by comparing the level of this logger with the
  12601. <c>FATAL</c> level. If this logger is
  12602. <c>FATAL</c> enabled, then it converts the message object
  12603. (passed as parameter) to a string by invoking the appropriate
  12604. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  12605. proceeds to call all the registered appenders in this logger and
  12606. also higher in the hierarchy depending on the value of the
  12607. additivity flag.
  12608. </para>
  12609. <para>
  12610. <b>WARNING</b> Note that passing an <see cref="T:System.Exception"/> to this
  12611. method will print the name of the <see cref="T:System.Exception"/> but no
  12612. stack trace. To print a stack trace use the
  12613. <see cref="M:Fatal(object,Exception)"/> form instead.
  12614. </para>
  12615. </remarks>
  12616. </member>
  12617. <member name="M:log4net.Core.LogImpl.Fatal(System.Object,System.Exception)">
  12618. <summary>
  12619. Logs a message object with the <c>FATAL</c> level
  12620. </summary>
  12621. <param name="message">The message object to log.</param>
  12622. <param name="exception">The exception to log, including its stack trace.</param>
  12623. <remarks>
  12624. <para>
  12625. Logs a message object with the <c>FATAL</c> level including
  12626. the stack trace of the <see cref="T:System.Exception"/> <paramref name="exception"/>
  12627. passed as a parameter.
  12628. </para>
  12629. <para>
  12630. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  12631. </para>
  12632. </remarks>
  12633. <seealso cref="M:Fatal(object)"/>
  12634. </member>
  12635. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object[])">
  12636. <summary>
  12637. Logs a formatted message string with the <c>FATAL</c> level.
  12638. </summary>
  12639. <param name="format">A String containing zero or more format items</param>
  12640. <param name="args">An Object array containing zero or more objects to format</param>
  12641. <remarks>
  12642. <para>
  12643. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12644. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12645. of the formatting.
  12646. </para>
  12647. <para>
  12648. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12649. format provider. To specify a localized provider use the
  12650. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  12651. </para>
  12652. <para>
  12653. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12654. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12655. methods instead.
  12656. </para>
  12657. </remarks>
  12658. </member>
  12659. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object)">
  12660. <summary>
  12661. Logs a formatted message string with the <c>FATAL</c> level.
  12662. </summary>
  12663. <param name="format">A String containing zero or more format items</param>
  12664. <param name="arg0">An Object to format</param>
  12665. <remarks>
  12666. <para>
  12667. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12668. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12669. of the formatting.
  12670. </para>
  12671. <para>
  12672. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12673. format provider. To specify a localized provider use the
  12674. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  12675. </para>
  12676. <para>
  12677. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12678. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12679. methods instead.
  12680. </para>
  12681. </remarks>
  12682. </member>
  12683. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object)">
  12684. <summary>
  12685. Logs a formatted message string with the <c>FATAL</c> level.
  12686. </summary>
  12687. <param name="format">A String containing zero or more format items</param>
  12688. <param name="arg0">An Object to format</param>
  12689. <param name="arg1">An Object to format</param>
  12690. <remarks>
  12691. <para>
  12692. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12693. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12694. of the formatting.
  12695. </para>
  12696. <para>
  12697. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12698. format provider. To specify a localized provider use the
  12699. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  12700. </para>
  12701. <para>
  12702. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12703. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12704. methods instead.
  12705. </para>
  12706. </remarks>
  12707. </member>
  12708. <member name="M:log4net.Core.LogImpl.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  12709. <summary>
  12710. Logs a formatted message string with the <c>FATAL</c> level.
  12711. </summary>
  12712. <param name="format">A String containing zero or more format items</param>
  12713. <param name="arg0">An Object to format</param>
  12714. <param name="arg1">An Object to format</param>
  12715. <param name="arg2">An Object to format</param>
  12716. <remarks>
  12717. <para>
  12718. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12719. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12720. of the formatting.
  12721. </para>
  12722. <para>
  12723. The string is formatted using the <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
  12724. format provider. To specify a localized provider use the
  12725. <see cref="M:FatalFormat(IFormatProvider,string,object[])"/> method.
  12726. </para>
  12727. <para>
  12728. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12729. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12730. methods instead.
  12731. </para>
  12732. </remarks>
  12733. </member>
  12734. <member name="M:log4net.Core.LogImpl.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  12735. <summary>
  12736. Logs a formatted message string with the <c>FATAL</c> level.
  12737. </summary>
  12738. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  12739. <param name="format">A String containing zero or more format items</param>
  12740. <param name="args">An Object array containing zero or more objects to format</param>
  12741. <remarks>
  12742. <para>
  12743. The message is formatted using the <see cref="M:String.Format(IFormatProvider, string, object[])"/> method. See
  12744. <c>String.Format</c> for details of the syntax of the format string and the behavior
  12745. of the formatting.
  12746. </para>
  12747. <para>
  12748. This method does not take an <see cref="T:System.Exception"/> object to include in the
  12749. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  12750. methods instead.
  12751. </para>
  12752. </remarks>
  12753. </member>
  12754. <member name="P:log4net.Core.LogImpl.IsDebugEnabled">
  12755. <summary>
  12756. Checks if this logger is enabled for the <c>DEBUG</c>
  12757. level.
  12758. </summary>
  12759. <value>
  12760. <c>true</c> if this logger is enabled for <c>DEBUG</c> events,
  12761. <c>false</c> otherwise.
  12762. </value>
  12763. <remarks>
  12764. <para>
  12765. This function is intended to lessen the computational cost of
  12766. disabled log debug statements.
  12767. </para>
  12768. <para>
  12769. For some <c>log</c> Logger object, when you write:
  12770. </para>
  12771. <code lang="C#">
  12772. log.Debug("This is entry number: " + i );
  12773. </code>
  12774. <para>
  12775. You incur the cost constructing the message, concatenation in
  12776. this case, regardless of whether the message is logged or not.
  12777. </para>
  12778. <para>
  12779. If you are worried about speed, then you should write:
  12780. </para>
  12781. <code lang="C#">
  12782. if (log.IsDebugEnabled())
  12783. {
  12784. log.Debug("This is entry number: " + i );
  12785. }
  12786. </code>
  12787. <para>
  12788. This way you will not incur the cost of parameter
  12789. construction if debugging is disabled for <c>log</c>. On
  12790. the other hand, if the <c>log</c> is debug enabled, you
  12791. will incur the cost of evaluating whether the logger is debug
  12792. enabled twice. Once in <c>IsDebugEnabled</c> and once in
  12793. the <c>Debug</c>. This is an insignificant overhead
  12794. since evaluating a logger takes about 1% of the time it
  12795. takes to actually log.
  12796. </para>
  12797. </remarks>
  12798. </member>
  12799. <member name="P:log4net.Core.LogImpl.IsInfoEnabled">
  12800. <summary>
  12801. Checks if this logger is enabled for the <c>INFO</c> level.
  12802. </summary>
  12803. <value>
  12804. <c>true</c> if this logger is enabled for <c>INFO</c> events,
  12805. <c>false</c> otherwise.
  12806. </value>
  12807. <remarks>
  12808. <para>
  12809. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  12810. of using this method.
  12811. </para>
  12812. </remarks>
  12813. <seealso cref="P:log4net.Core.LogImpl.IsDebugEnabled"/>
  12814. </member>
  12815. <member name="P:log4net.Core.LogImpl.IsWarnEnabled">
  12816. <summary>
  12817. Checks if this logger is enabled for the <c>WARN</c> level.
  12818. </summary>
  12819. <value>
  12820. <c>true</c> if this logger is enabled for <c>WARN</c> events,
  12821. <c>false</c> otherwise.
  12822. </value>
  12823. <remarks>
  12824. <para>
  12825. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples
  12826. of using this method.
  12827. </para>
  12828. </remarks>
  12829. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  12830. </member>
  12831. <member name="P:log4net.Core.LogImpl.IsErrorEnabled">
  12832. <summary>
  12833. Checks if this logger is enabled for the <c>ERROR</c> level.
  12834. </summary>
  12835. <value>
  12836. <c>true</c> if this logger is enabled for <c>ERROR</c> events,
  12837. <c>false</c> otherwise.
  12838. </value>
  12839. <remarks>
  12840. <para>
  12841. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  12842. </para>
  12843. </remarks>
  12844. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  12845. </member>
  12846. <member name="P:log4net.Core.LogImpl.IsFatalEnabled">
  12847. <summary>
  12848. Checks if this logger is enabled for the <c>FATAL</c> level.
  12849. </summary>
  12850. <value>
  12851. <c>true</c> if this logger is enabled for <c>FATAL</c> events,
  12852. <c>false</c> otherwise.
  12853. </value>
  12854. <remarks>
  12855. <para>
  12856. See <see cref="P:log4net.Core.LogImpl.IsDebugEnabled"/> for more information and examples of using this method.
  12857. </para>
  12858. </remarks>
  12859. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  12860. </member>
  12861. <member name="M:log4net.Core.LogImpl.LoggerRepositoryConfigurationChanged(System.Object,System.EventArgs)">
  12862. <summary>
  12863. Event handler for the <see cref="E:log4net.Repository.ILoggerRepository.ConfigurationChanged"/> event
  12864. </summary>
  12865. <param name="sender">the repository</param>
  12866. <param name="e">Empty</param>
  12867. </member>
  12868. <member name="F:log4net.Core.LogImpl.ThisDeclaringType">
  12869. <summary>
  12870. The fully qualified name of this declaring type not the type of any subclass.
  12871. </summary>
  12872. </member>
  12873. <member name="T:log4net.Core.MethodItem">
  12874. <summary>
  12875. provides method information without actually referencing a System.Reflection.MethodBase
  12876. as that would require that the containing assembly is loaded.
  12877. </summary>
  12878. </member>
  12879. <member name="M:log4net.Core.MethodItem.#ctor">
  12880. <summary>
  12881. constructs a method item for an unknown method.
  12882. </summary>
  12883. </member>
  12884. <member name="M:log4net.Core.MethodItem.#ctor(System.String)">
  12885. <summary>
  12886. constructs a method item from the name of the method.
  12887. </summary>
  12888. <param name="name"></param>
  12889. </member>
  12890. <member name="M:log4net.Core.MethodItem.#ctor(System.String,System.String[])">
  12891. <summary>
  12892. constructs a method item from the name of the method and its parameters.
  12893. </summary>
  12894. <param name="name"></param>
  12895. <param name="parameters"></param>
  12896. </member>
  12897. <member name="M:log4net.Core.MethodItem.#ctor(System.Reflection.MethodBase)">
  12898. <summary>
  12899. constructs a method item from a method base by determining the method name and its parameters.
  12900. </summary>
  12901. <param name="methodBase"></param>
  12902. </member>
  12903. <member name="P:log4net.Core.MethodItem.Name">
  12904. <summary>
  12905. Gets the method name of the caller making the logging
  12906. request.
  12907. </summary>
  12908. <value>
  12909. The method name of the caller making the logging
  12910. request.
  12911. </value>
  12912. <remarks>
  12913. <para>
  12914. Gets the method name of the caller making the logging
  12915. request.
  12916. </para>
  12917. </remarks>
  12918. </member>
  12919. <member name="P:log4net.Core.MethodItem.Parameters">
  12920. <summary>
  12921. Gets the method parameters of the caller making
  12922. the logging request.
  12923. </summary>
  12924. <value>
  12925. The method parameters of the caller making
  12926. the logging request
  12927. </value>
  12928. <remarks>
  12929. <para>
  12930. Gets the method parameters of the caller making
  12931. the logging request.
  12932. </para>
  12933. </remarks>
  12934. </member>
  12935. <member name="F:log4net.Core.MethodItem.declaringType">
  12936. <summary>
  12937. The fully qualified type of the StackFrameItem class.
  12938. </summary>
  12939. <remarks>
  12940. Used by the internal logger to record the Type of the
  12941. log message.
  12942. </remarks>
  12943. </member>
  12944. <member name="F:log4net.Core.MethodItem.NA">
  12945. <summary>
  12946. When location information is not available the constant
  12947. <c>NA</c> is returned. Current value of this string
  12948. constant is <b>?</b>.
  12949. </summary>
  12950. </member>
  12951. <member name="T:log4net.Core.SecurityContext">
  12952. <summary>
  12953. A SecurityContext used by log4net when interacting with protected resources
  12954. </summary>
  12955. <remarks>
  12956. <para>
  12957. A SecurityContext used by log4net when interacting with protected resources
  12958. for example with operating system services. This can be used to impersonate
  12959. a principal that has been granted privileges on the system resources.
  12960. </para>
  12961. </remarks>
  12962. <author>Nicko Cadell</author>
  12963. </member>
  12964. <member name="M:log4net.Core.SecurityContext.Impersonate(System.Object)">
  12965. <summary>
  12966. Impersonate this SecurityContext
  12967. </summary>
  12968. <param name="state">State supplied by the caller</param>
  12969. <returns>An <see cref="T:System.IDisposable"/> instance that will
  12970. revoke the impersonation of this SecurityContext, or <c>null</c></returns>
  12971. <remarks>
  12972. <para>
  12973. Impersonate this security context. Further calls on the current
  12974. thread should now be made in the security context provided
  12975. by this object. When the <see cref="T:System.IDisposable"/> result
  12976. <see cref="M:System.IDisposable.Dispose"/> method is called the security
  12977. context of the thread should be reverted to the state it was in
  12978. before <see cref="M:log4net.Core.SecurityContext.Impersonate(System.Object)"/> was called.
  12979. </para>
  12980. </remarks>
  12981. </member>
  12982. <member name="T:log4net.Core.SecurityContextProvider">
  12983. <summary>
  12984. The <see cref="T:log4net.Core.SecurityContextProvider"/> providers default <see cref="T:log4net.Core.SecurityContext"/> instances.
  12985. </summary>
  12986. <remarks>
  12987. <para>
  12988. A configured component that interacts with potentially protected system
  12989. resources uses a <see cref="T:log4net.Core.SecurityContext"/> to provide the elevated
  12990. privileges required. If the <see cref="T:log4net.Core.SecurityContext"/> object has
  12991. been not been explicitly provided to the component then the component
  12992. will request one from this <see cref="T:log4net.Core.SecurityContextProvider"/>.
  12993. </para>
  12994. <para>
  12995. By default the <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> is
  12996. an instance of <see cref="T:log4net.Core.SecurityContextProvider"/> which returns only
  12997. <see cref="T:log4net.Util.NullSecurityContext"/> objects. This is a reasonable default
  12998. where the privileges required are not know by the system.
  12999. </para>
  13000. <para>
  13001. This default behavior can be overridden by subclassing the <see cref="T:log4net.Core.SecurityContextProvider"/>
  13002. and overriding the <see cref="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)"/> method to return
  13003. the desired <see cref="T:log4net.Core.SecurityContext"/> objects. The default provider
  13004. can be replaced by programmatically setting the value of the
  13005. <see cref="P:log4net.Core.SecurityContextProvider.DefaultProvider"/> property.
  13006. </para>
  13007. <para>
  13008. An alternative is to use the <c>log4net.Config.SecurityContextProviderAttribute</c>
  13009. This attribute can be applied to an assembly in the same way as the
  13010. <c>log4net.Config.XmlConfiguratorAttribute"</c>. The attribute takes
  13011. the type to use as the <see cref="T:log4net.Core.SecurityContextProvider"/> as an argument.
  13012. </para>
  13013. </remarks>
  13014. <author>Nicko Cadell</author>
  13015. </member>
  13016. <member name="F:log4net.Core.SecurityContextProvider.s_defaultProvider">
  13017. <summary>
  13018. The default provider
  13019. </summary>
  13020. </member>
  13021. <member name="P:log4net.Core.SecurityContextProvider.DefaultProvider">
  13022. <summary>
  13023. Gets or sets the default SecurityContextProvider
  13024. </summary>
  13025. <value>
  13026. The default SecurityContextProvider
  13027. </value>
  13028. <remarks>
  13029. <para>
  13030. The default provider is used by configured components that
  13031. require a <see cref="T:log4net.Core.SecurityContext"/> and have not had one
  13032. given to them.
  13033. </para>
  13034. <para>
  13035. By default this is an instance of <see cref="T:log4net.Core.SecurityContextProvider"/>
  13036. that returns <see cref="T:log4net.Util.NullSecurityContext"/> objects.
  13037. </para>
  13038. <para>
  13039. The default provider can be set programmatically by setting
  13040. the value of this property to a sub class of <see cref="T:log4net.Core.SecurityContextProvider"/>
  13041. that has the desired behavior.
  13042. </para>
  13043. </remarks>
  13044. </member>
  13045. <member name="M:log4net.Core.SecurityContextProvider.#ctor">
  13046. <summary>
  13047. Protected default constructor to allow subclassing
  13048. </summary>
  13049. <remarks>
  13050. <para>
  13051. Protected default constructor to allow subclassing
  13052. </para>
  13053. </remarks>
  13054. </member>
  13055. <member name="M:log4net.Core.SecurityContextProvider.CreateSecurityContext(System.Object)">
  13056. <summary>
  13057. Create a SecurityContext for a consumer
  13058. </summary>
  13059. <param name="consumer">The consumer requesting the SecurityContext</param>
  13060. <returns>An impersonation context</returns>
  13061. <remarks>
  13062. <para>
  13063. The default implementation is to return a <see cref="T:log4net.Util.NullSecurityContext"/>.
  13064. </para>
  13065. <para>
  13066. Subclasses should override this method to provide their own
  13067. behavior.
  13068. </para>
  13069. </remarks>
  13070. </member>
  13071. <member name="T:log4net.Core.StackFrameItem">
  13072. <summary>
  13073. provides stack frame information without actually referencing a System.Diagnostics.StackFrame
  13074. as that would require that the containing assembly is loaded.
  13075. </summary>
  13076. </member>
  13077. <member name="M:log4net.Core.StackFrameItem.#ctor(System.Diagnostics.StackFrame)">
  13078. <summary>
  13079. returns a stack frame item from a stack frame. This
  13080. </summary>
  13081. <param name="frame"></param>
  13082. <returns></returns>
  13083. </member>
  13084. <member name="P:log4net.Core.StackFrameItem.ClassName">
  13085. <summary>
  13086. Gets the fully qualified class name of the caller making the logging
  13087. request.
  13088. </summary>
  13089. <value>
  13090. The fully qualified class name of the caller making the logging
  13091. request.
  13092. </value>
  13093. <remarks>
  13094. <para>
  13095. Gets the fully qualified class name of the caller making the logging
  13096. request.
  13097. </para>
  13098. </remarks>
  13099. </member>
  13100. <member name="P:log4net.Core.StackFrameItem.FileName">
  13101. <summary>
  13102. Gets the file name of the caller.
  13103. </summary>
  13104. <value>
  13105. The file name of the caller.
  13106. </value>
  13107. <remarks>
  13108. <para>
  13109. Gets the file name of the caller.
  13110. </para>
  13111. </remarks>
  13112. </member>
  13113. <member name="P:log4net.Core.StackFrameItem.LineNumber">
  13114. <summary>
  13115. Gets the line number of the caller.
  13116. </summary>
  13117. <value>
  13118. The line number of the caller.
  13119. </value>
  13120. <remarks>
  13121. <para>
  13122. Gets the line number of the caller.
  13123. </para>
  13124. </remarks>
  13125. </member>
  13126. <member name="P:log4net.Core.StackFrameItem.Method">
  13127. <summary>
  13128. Gets the method name of the caller.
  13129. </summary>
  13130. <value>
  13131. The method name of the caller.
  13132. </value>
  13133. <remarks>
  13134. <para>
  13135. Gets the method name of the caller.
  13136. </para>
  13137. </remarks>
  13138. </member>
  13139. <member name="P:log4net.Core.StackFrameItem.FullInfo">
  13140. <summary>
  13141. Gets all available caller information
  13142. </summary>
  13143. <value>
  13144. All available caller information, in the format
  13145. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  13146. </value>
  13147. <remarks>
  13148. <para>
  13149. Gets all available caller information, in the format
  13150. <c>fully.qualified.classname.of.caller.methodName(Filename:line)</c>
  13151. </para>
  13152. </remarks>
  13153. </member>
  13154. <member name="F:log4net.Core.StackFrameItem.declaringType">
  13155. <summary>
  13156. The fully qualified type of the StackFrameItem class.
  13157. </summary>
  13158. <remarks>
  13159. Used by the internal logger to record the Type of the
  13160. log message.
  13161. </remarks>
  13162. </member>
  13163. <member name="F:log4net.Core.StackFrameItem.NA">
  13164. <summary>
  13165. When location information is not available the constant
  13166. <c>NA</c> is returned. Current value of this string
  13167. constant is <b>?</b>.
  13168. </summary>
  13169. </member>
  13170. <member name="T:log4net.Core.TimeEvaluator">
  13171. <summary>
  13172. An evaluator that triggers after specified number of seconds.
  13173. </summary>
  13174. <remarks>
  13175. <para>
  13176. This evaluator will trigger if the specified time period
  13177. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13178. </para>
  13179. </remarks>
  13180. <author>Robert Sevcik</author>
  13181. </member>
  13182. <member name="F:log4net.Core.TimeEvaluator.m_interval">
  13183. <summary>
  13184. The time threshold for triggering in seconds. Zero means it won't trigger at all.
  13185. </summary>
  13186. </member>
  13187. <member name="F:log4net.Core.TimeEvaluator.m_lastTimeUtc">
  13188. <summary>
  13189. The UTC time of last check. This gets updated when the object is created and when the evaluator triggers.
  13190. </summary>
  13191. </member>
  13192. <member name="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL">
  13193. <summary>
  13194. The default time threshold for triggering in seconds. Zero means it won't trigger at all.
  13195. </summary>
  13196. </member>
  13197. <member name="M:log4net.Core.TimeEvaluator.#ctor">
  13198. <summary>
  13199. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  13200. </summary>
  13201. <remarks>
  13202. <para>
  13203. Create a new evaluator using the <see cref="F:log4net.Core.TimeEvaluator.DEFAULT_INTERVAL"/> time threshold in seconds.
  13204. </para>
  13205. <para>
  13206. This evaluator will trigger if the specified time period
  13207. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13208. </para>
  13209. </remarks>
  13210. </member>
  13211. <member name="M:log4net.Core.TimeEvaluator.#ctor(System.Int32)">
  13212. <summary>
  13213. Create a new evaluator using the specified time threshold in seconds.
  13214. </summary>
  13215. <param name="interval">
  13216. The time threshold in seconds to trigger after.
  13217. Zero means it won't trigger at all.
  13218. </param>
  13219. <remarks>
  13220. <para>
  13221. Create a new evaluator using the specified time threshold in seconds.
  13222. </para>
  13223. <para>
  13224. This evaluator will trigger if the specified time period
  13225. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13226. </para>
  13227. </remarks>
  13228. </member>
  13229. <member name="P:log4net.Core.TimeEvaluator.Interval">
  13230. <summary>
  13231. The time threshold in seconds to trigger after
  13232. </summary>
  13233. <value>
  13234. The time threshold in seconds to trigger after.
  13235. Zero means it won't trigger at all.
  13236. </value>
  13237. <remarks>
  13238. <para>
  13239. This evaluator will trigger if the specified time period
  13240. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13241. </para>
  13242. </remarks>
  13243. </member>
  13244. <member name="M:log4net.Core.TimeEvaluator.IsTriggeringEvent(log4net.Core.LoggingEvent)">
  13245. <summary>
  13246. Is this <paramref name="loggingEvent"/> the triggering event?
  13247. </summary>
  13248. <param name="loggingEvent">The event to check</param>
  13249. <returns>This method returns <c>true</c>, if the specified time period
  13250. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check..
  13251. Otherwise it returns <c>false</c></returns>
  13252. <remarks>
  13253. <para>
  13254. This evaluator will trigger if the specified time period
  13255. <see cref="P:log4net.Core.TimeEvaluator.Interval"/> has passed since last check.
  13256. </para>
  13257. </remarks>
  13258. </member>
  13259. <member name="T:log4net.Core.WrapperCreationHandler">
  13260. <summary>
  13261. Delegate used to handle creation of new wrappers.
  13262. </summary>
  13263. <param name="logger">The logger to wrap in a wrapper.</param>
  13264. <remarks>
  13265. <para>
  13266. Delegate used to handle creation of new wrappers. This delegate
  13267. is called from the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  13268. method to construct the wrapper for the specified logger.
  13269. </para>
  13270. <para>
  13271. The delegate to use is supplied to the <see cref="T:log4net.Core.WrapperMap"/>
  13272. constructor.
  13273. </para>
  13274. </remarks>
  13275. </member>
  13276. <member name="T:log4net.Core.WrapperMap">
  13277. <summary>
  13278. Maps between logger objects and wrapper objects.
  13279. </summary>
  13280. <remarks>
  13281. <para>
  13282. This class maintains a mapping between <see cref="T:log4net.Core.ILogger"/> objects and
  13283. <see cref="T:log4net.Core.ILoggerWrapper"/> objects. Use the <see cref="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)"/> method to
  13284. lookup the <see cref="T:log4net.Core.ILoggerWrapper"/> for the specified <see cref="T:log4net.Core.ILogger"/>.
  13285. </para>
  13286. <para>
  13287. New wrapper instances are created by the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/>
  13288. method. The default behavior is for this method to delegate construction
  13289. of the wrapper to the <see cref="T:log4net.Core.WrapperCreationHandler"/> delegate supplied
  13290. to the constructor. This allows specialization of the behavior without
  13291. requiring subclassing of this type.
  13292. </para>
  13293. </remarks>
  13294. <author>Nicko Cadell</author>
  13295. <author>Gert Driesen</author>
  13296. </member>
  13297. <member name="M:log4net.Core.WrapperMap.#ctor(log4net.Core.WrapperCreationHandler)">
  13298. <summary>
  13299. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap" />
  13300. </summary>
  13301. <param name="createWrapperHandler">The handler to use to create the wrapper objects.</param>
  13302. <remarks>
  13303. <para>
  13304. Initializes a new instance of the <see cref="T:log4net.Core.WrapperMap" /> class with
  13305. the specified handler to create the wrapper objects.
  13306. </para>
  13307. </remarks>
  13308. </member>
  13309. <member name="M:log4net.Core.WrapperMap.GetWrapper(log4net.Core.ILogger)">
  13310. <summary>
  13311. Gets the wrapper object for the specified logger.
  13312. </summary>
  13313. <returns>The wrapper object for the specified logger</returns>
  13314. <remarks>
  13315. <para>
  13316. If the logger is null then the corresponding wrapper is null.
  13317. </para>
  13318. <para>
  13319. Looks up the wrapper it it has previously been requested and
  13320. returns it. If the wrapper has never been requested before then
  13321. the <see cref="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)"/> virtual method is
  13322. called.
  13323. </para>
  13324. </remarks>
  13325. </member>
  13326. <member name="P:log4net.Core.WrapperMap.Repositories">
  13327. <summary>
  13328. Gets the map of logger repositories.
  13329. </summary>
  13330. <value>
  13331. Map of logger repositories.
  13332. </value>
  13333. <remarks>
  13334. <para>
  13335. Gets the hashtable that is keyed on <see cref="T:log4net.Repository.ILoggerRepository"/>. The
  13336. values are hashtables keyed on <see cref="T:log4net.Core.ILogger"/> with the
  13337. value being the corresponding <see cref="T:log4net.Core.ILoggerWrapper"/>.
  13338. </para>
  13339. </remarks>
  13340. </member>
  13341. <member name="M:log4net.Core.WrapperMap.CreateNewWrapperObject(log4net.Core.ILogger)">
  13342. <summary>
  13343. Creates the wrapper object for the specified logger.
  13344. </summary>
  13345. <param name="logger">The logger to wrap in a wrapper.</param>
  13346. <returns>The wrapper object for the logger.</returns>
  13347. <remarks>
  13348. <para>
  13349. This implementation uses the <see cref="T:log4net.Core.WrapperCreationHandler"/>
  13350. passed to the constructor to create the wrapper. This method
  13351. can be overridden in a subclass.
  13352. </para>
  13353. </remarks>
  13354. </member>
  13355. <member name="M:log4net.Core.WrapperMap.RepositoryShutdown(log4net.Repository.ILoggerRepository)">
  13356. <summary>
  13357. Called when a monitored repository shutdown event is received.
  13358. </summary>
  13359. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down</param>
  13360. <remarks>
  13361. <para>
  13362. This method is called when a <see cref="T:log4net.Repository.ILoggerRepository"/> that this
  13363. <see cref="T:log4net.Core.WrapperMap"/> is holding loggers for has signaled its shutdown
  13364. event <see cref="E:log4net.Repository.ILoggerRepository.ShutdownEvent"/>. The default
  13365. behavior of this method is to release the references to the loggers
  13366. and their wrappers generated for this repository.
  13367. </para>
  13368. </remarks>
  13369. </member>
  13370. <member name="M:log4net.Core.WrapperMap.ILoggerRepository_Shutdown(System.Object,System.EventArgs)">
  13371. <summary>
  13372. Event handler for repository shutdown event.
  13373. </summary>
  13374. <param name="sender">The sender of the event.</param>
  13375. <param name="e">The event args.</param>
  13376. </member>
  13377. <member name="F:log4net.Core.WrapperMap.m_repositories">
  13378. <summary>
  13379. Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings
  13380. </summary>
  13381. </member>
  13382. <member name="F:log4net.Core.WrapperMap.m_createWrapperHandler">
  13383. <summary>
  13384. The handler to use to create the extension wrapper objects.
  13385. </summary>
  13386. </member>
  13387. <member name="F:log4net.Core.WrapperMap.m_shutdownHandler">
  13388. <summary>
  13389. Internal reference to the delegate used to register for repository shutdown events.
  13390. </summary>
  13391. </member>
  13392. <member name="T:log4net.DateFormatter.AbsoluteTimeDateFormatter">
  13393. <summary>
  13394. Formats a <see cref="T:System.DateTime"/> as <c>"HH:mm:ss,fff"</c>.
  13395. </summary>
  13396. <remarks>
  13397. <para>
  13398. Formats a <see cref="T:System.DateTime"/> in the format <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  13399. </para>
  13400. </remarks>
  13401. <author>Nicko Cadell</author>
  13402. <author>Gert Driesen</author>
  13403. </member>
  13404. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  13405. <summary>
  13406. Renders the date into a string. Format is <c>"HH:mm:ss"</c>.
  13407. </summary>
  13408. <param name="dateToFormat">The date to render into a string.</param>
  13409. <param name="buffer">The string builder to write to.</param>
  13410. <remarks>
  13411. <para>
  13412. Subclasses should override this method to render the date
  13413. into a string using a precision up to the second. This method
  13414. will be called at most once per second and the result will be
  13415. reused if it is needed again during the same second.
  13416. </para>
  13417. </remarks>
  13418. </member>
  13419. <member name="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  13420. <summary>
  13421. Renders the date into a string. Format is "HH:mm:ss,fff".
  13422. </summary>
  13423. <param name="dateToFormat">The date to render into a string.</param>
  13424. <param name="writer">The writer to write to.</param>
  13425. <remarks>
  13426. <para>
  13427. Uses the <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> method to generate the
  13428. time string up to the seconds and then appends the current
  13429. milliseconds. The results from <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> are
  13430. cached and <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/> is called at most once
  13431. per second.
  13432. </para>
  13433. <para>
  13434. Sub classes should override <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)"/>
  13435. rather than <see cref="M:log4net.DateFormatter.AbsoluteTimeDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/>.
  13436. </para>
  13437. </remarks>
  13438. </member>
  13439. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.AbsoluteTimeDateFormat">
  13440. <summary>
  13441. String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is <b>ABSOLUTE</b>.
  13442. </summary>
  13443. </member>
  13444. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.DateAndTimeDateFormat">
  13445. <summary>
  13446. String constant used to specify DateTimeDateFormat in layouts. Current value is <b>DATE</b>.
  13447. </summary>
  13448. </member>
  13449. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.Iso8601TimeDateFormat">
  13450. <summary>
  13451. String constant used to specify ISO8601DateFormat in layouts. Current value is <b>ISO8601</b>.
  13452. </summary>
  13453. </member>
  13454. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeToTheSecond">
  13455. <summary>
  13456. Last stored time with precision up to the second.
  13457. </summary>
  13458. </member>
  13459. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeBuf">
  13460. <summary>
  13461. Last stored time with precision up to the second, formatted
  13462. as a string.
  13463. </summary>
  13464. </member>
  13465. <member name="F:log4net.DateFormatter.AbsoluteTimeDateFormatter.s_lastTimeStrings">
  13466. <summary>
  13467. Last stored time with precision up to the second, formatted
  13468. as a string.
  13469. </summary>
  13470. </member>
  13471. <member name="T:log4net.DateFormatter.DateTimeDateFormatter">
  13472. <summary>
  13473. Formats a <see cref="T:System.DateTime"/> as <c>"dd MMM yyyy HH:mm:ss,fff"</c>
  13474. </summary>
  13475. <remarks>
  13476. <para>
  13477. Formats a <see cref="T:System.DateTime"/> in the format
  13478. <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example,
  13479. <c>"06 Nov 1994 15:49:37,459"</c>.
  13480. </para>
  13481. </remarks>
  13482. <author>Nicko Cadell</author>
  13483. <author>Gert Driesen</author>
  13484. <author>Angelika Schnagl</author>
  13485. </member>
  13486. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.#ctor">
  13487. <summary>
  13488. Default constructor.
  13489. </summary>
  13490. <remarks>
  13491. <para>
  13492. Initializes a new instance of the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter" /> class.
  13493. </para>
  13494. </remarks>
  13495. </member>
  13496. <member name="M:log4net.DateFormatter.DateTimeDateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  13497. <summary>
  13498. Formats the date without the milliseconds part
  13499. </summary>
  13500. <param name="dateToFormat">The date to format.</param>
  13501. <param name="buffer">The string builder to write to.</param>
  13502. <remarks>
  13503. <para>
  13504. Formats a DateTime in the format <c>"dd MMM yyyy HH:mm:ss"</c>
  13505. for example, <c>"06 Nov 1994 15:49:37"</c>.
  13506. </para>
  13507. <para>
  13508. The base class will append the <c>",fff"</c> milliseconds section.
  13509. This method will only be called at most once per second.
  13510. </para>
  13511. </remarks>
  13512. </member>
  13513. <member name="F:log4net.DateFormatter.DateTimeDateFormatter.m_dateTimeFormatInfo">
  13514. <summary>
  13515. The format info for the invariant culture.
  13516. </summary>
  13517. </member>
  13518. <member name="T:log4net.DateFormatter.IDateFormatter">
  13519. <summary>
  13520. Render a <see cref="T:System.DateTime"/> as a string.
  13521. </summary>
  13522. <remarks>
  13523. <para>
  13524. Interface to abstract the rendering of a <see cref="T:System.DateTime"/>
  13525. instance into a string.
  13526. </para>
  13527. <para>
  13528. The <see cref="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)"/> method is used to render the
  13529. date to a text writer.
  13530. </para>
  13531. </remarks>
  13532. <author>Nicko Cadell</author>
  13533. <author>Gert Driesen</author>
  13534. </member>
  13535. <member name="M:log4net.DateFormatter.IDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  13536. <summary>
  13537. Formats the specified date as a string.
  13538. </summary>
  13539. <param name="dateToFormat">The date to format.</param>
  13540. <param name="writer">The writer to write to.</param>
  13541. <remarks>
  13542. <para>
  13543. Format the <see cref="T:System.DateTime"/> as a string and write it
  13544. to the <see cref="T:System.IO.TextWriter"/> provided.
  13545. </para>
  13546. </remarks>
  13547. </member>
  13548. <member name="T:log4net.DateFormatter.Iso8601DateFormatter">
  13549. <summary>
  13550. Formats the <see cref="T:System.DateTime"/> as <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  13551. </summary>
  13552. <remarks>
  13553. <para>
  13554. Formats the <see cref="T:System.DateTime"/> specified as a string: <c>"yyyy-MM-dd HH:mm:ss,fff"</c>.
  13555. </para>
  13556. </remarks>
  13557. <author>Nicko Cadell</author>
  13558. <author>Gert Driesen</author>
  13559. </member>
  13560. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.#ctor">
  13561. <summary>
  13562. Default constructor
  13563. </summary>
  13564. <remarks>
  13565. <para>
  13566. Initializes a new instance of the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter" /> class.
  13567. </para>
  13568. </remarks>
  13569. </member>
  13570. <member name="M:log4net.DateFormatter.Iso8601DateFormatter.FormatDateWithoutMillis(System.DateTime,System.Text.StringBuilder)">
  13571. <summary>
  13572. Formats the date without the milliseconds part
  13573. </summary>
  13574. <param name="dateToFormat">The date to format.</param>
  13575. <param name="buffer">The string builder to write to.</param>
  13576. <remarks>
  13577. <para>
  13578. Formats the date specified as a string: <c>"yyyy-MM-dd HH:mm:ss"</c>.
  13579. </para>
  13580. <para>
  13581. The base class will append the <c>",fff"</c> milliseconds section.
  13582. This method will only be called at most once per second.
  13583. </para>
  13584. </remarks>
  13585. </member>
  13586. <member name="T:log4net.DateFormatter.SimpleDateFormatter">
  13587. <summary>
  13588. Formats the <see cref="T:System.DateTime"/> using the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  13589. </summary>
  13590. <remarks>
  13591. <para>
  13592. Formats the <see cref="T:System.DateTime"/> using the <see cref="T:System.DateTime"/> <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method.
  13593. </para>
  13594. </remarks>
  13595. <author>Nicko Cadell</author>
  13596. <author>Gert Driesen</author>
  13597. </member>
  13598. <member name="M:log4net.DateFormatter.SimpleDateFormatter.#ctor(System.String)">
  13599. <summary>
  13600. Constructor
  13601. </summary>
  13602. <param name="format">The format string.</param>
  13603. <remarks>
  13604. <para>
  13605. Initializes a new instance of the <see cref="T:log4net.DateFormatter.SimpleDateFormatter" /> class
  13606. with the specified format string.
  13607. </para>
  13608. <para>
  13609. The format string must be compatible with the options
  13610. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  13611. </para>
  13612. </remarks>
  13613. </member>
  13614. <member name="M:log4net.DateFormatter.SimpleDateFormatter.FormatDate(System.DateTime,System.IO.TextWriter)">
  13615. <summary>
  13616. Formats the date using <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  13617. </summary>
  13618. <param name="dateToFormat">The date to convert to a string.</param>
  13619. <param name="writer">The writer to write to.</param>
  13620. <remarks>
  13621. <para>
  13622. Uses the date format string supplied to the constructor to call
  13623. the <see cref="M:DateTime.ToString(string, IFormatProvider)"/> method to format the date.
  13624. </para>
  13625. </remarks>
  13626. </member>
  13627. <member name="F:log4net.DateFormatter.SimpleDateFormatter.m_formatString">
  13628. <summary>
  13629. The format string used to format the <see cref="T:System.DateTime" />.
  13630. </summary>
  13631. <remarks>
  13632. <para>
  13633. The format string must be compatible with the options
  13634. that can be supplied to <see cref="M:DateTime.ToString(string, IFormatProvider)"/>.
  13635. </para>
  13636. </remarks>
  13637. </member>
  13638. <member name="T:log4net.Filter.DenyAllFilter">
  13639. <summary>
  13640. This filter drops all <see cref="T:log4net.Core.LoggingEvent"/>.
  13641. </summary>
  13642. <remarks>
  13643. <para>
  13644. You can add this filter to the end of a filter chain to
  13645. switch from the default "accept all unless instructed otherwise"
  13646. filtering behavior to a "deny all unless instructed otherwise"
  13647. behavior.
  13648. </para>
  13649. </remarks>
  13650. <author>Nicko Cadell</author>
  13651. <author>Gert Driesen</author>
  13652. </member>
  13653. <member name="M:log4net.Filter.DenyAllFilter.#ctor">
  13654. <summary>
  13655. Default constructor
  13656. </summary>
  13657. </member>
  13658. <member name="M:log4net.Filter.DenyAllFilter.Decide(log4net.Core.LoggingEvent)">
  13659. <summary>
  13660. Always returns the integer constant <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  13661. </summary>
  13662. <param name="loggingEvent">the LoggingEvent to filter</param>
  13663. <returns>Always returns <see cref="F:log4net.Filter.FilterDecision.Deny"/></returns>
  13664. <remarks>
  13665. <para>
  13666. Ignores the event being logged and just returns
  13667. <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This can be used to change the default filter
  13668. chain behavior from <see cref="F:log4net.Filter.FilterDecision.Accept"/> to <see cref="F:log4net.Filter.FilterDecision.Deny"/>. This filter
  13669. should only be used as the last filter in the chain
  13670. as any further filters will be ignored!
  13671. </para>
  13672. </remarks>
  13673. </member>
  13674. <member name="T:log4net.Filter.FilterDecision">
  13675. <summary>
  13676. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  13677. </summary>
  13678. <remarks>
  13679. <para>
  13680. The return result from <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  13681. </para>
  13682. </remarks>
  13683. </member>
  13684. <member name="F:log4net.Filter.FilterDecision.Deny">
  13685. <summary>
  13686. The log event must be dropped immediately without
  13687. consulting with the remaining filters, if any, in the chain.
  13688. </summary>
  13689. </member>
  13690. <member name="F:log4net.Filter.FilterDecision.Neutral">
  13691. <summary>
  13692. This filter is neutral with respect to the log event.
  13693. The remaining filters, if any, should be consulted for a final decision.
  13694. </summary>
  13695. </member>
  13696. <member name="F:log4net.Filter.FilterDecision.Accept">
  13697. <summary>
  13698. The log event must be logged immediately without
  13699. consulting with the remaining filters, if any, in the chain.
  13700. </summary>
  13701. </member>
  13702. <member name="T:log4net.Filter.FilterSkeleton">
  13703. <summary>
  13704. Subclass this type to implement customized logging event filtering
  13705. </summary>
  13706. <remarks>
  13707. <para>
  13708. Users should extend this class to implement customized logging
  13709. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  13710. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  13711. appenders, have built-in filtering rules. It is suggested that you
  13712. first use and understand the built-in rules before rushing to write
  13713. your own custom filters.
  13714. </para>
  13715. <para>
  13716. This abstract class assumes and also imposes that filters be
  13717. organized in a linear chain. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/>
  13718. method of each filter is called sequentially, in the order of their
  13719. addition to the chain.
  13720. </para>
  13721. <para>
  13722. The <see cref="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)"/> method must return one
  13723. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  13724. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  13725. </para>
  13726. <para>
  13727. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  13728. immediately without consulting with the remaining filters.
  13729. </para>
  13730. <para>
  13731. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  13732. in the chain is consulted. If there are no more filters in the
  13733. chain, then the log event is logged. Thus, in the presence of no
  13734. filters, the default behavior is to log all logging events.
  13735. </para>
  13736. <para>
  13737. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  13738. event is logged without consulting the remaining filters.
  13739. </para>
  13740. <para>
  13741. The philosophy of log4net filters is largely inspired from the
  13742. Linux ipchains.
  13743. </para>
  13744. </remarks>
  13745. <author>Nicko Cadell</author>
  13746. <author>Gert Driesen</author>
  13747. </member>
  13748. <member name="F:log4net.Filter.FilterSkeleton.m_next">
  13749. <summary>
  13750. Points to the next filter in the filter chain.
  13751. </summary>
  13752. <remarks>
  13753. <para>
  13754. See <see cref="P:log4net.Filter.FilterSkeleton.Next"/> for more information.
  13755. </para>
  13756. </remarks>
  13757. </member>
  13758. <member name="M:log4net.Filter.FilterSkeleton.ActivateOptions">
  13759. <summary>
  13760. Initialize the filter with the options set
  13761. </summary>
  13762. <remarks>
  13763. <para>
  13764. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  13765. activation scheme. The <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> method must
  13766. be called on this object after the configuration properties have
  13767. been set. Until <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> is called this
  13768. object is in an undefined state and must not be used.
  13769. </para>
  13770. <para>
  13771. If any of the configuration properties are modified then
  13772. <see cref="M:log4net.Filter.FilterSkeleton.ActivateOptions"/> must be called again.
  13773. </para>
  13774. <para>
  13775. Typically filter's options become active immediately on set,
  13776. however this method must still be called.
  13777. </para>
  13778. </remarks>
  13779. </member>
  13780. <member name="M:log4net.Filter.FilterSkeleton.Decide(log4net.Core.LoggingEvent)">
  13781. <summary>
  13782. Decide if the <see cref="T:log4net.Core.LoggingEvent"/> should be logged through an appender.
  13783. </summary>
  13784. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent"/> to decide upon</param>
  13785. <returns>The decision of the filter</returns>
  13786. <remarks>
  13787. <para>
  13788. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  13789. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  13790. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  13791. the event will be logged without consulting with other filters in
  13792. the chain.
  13793. </para>
  13794. <para>
  13795. This method is marked <c>abstract</c> and must be implemented
  13796. in a subclass.
  13797. </para>
  13798. </remarks>
  13799. </member>
  13800. <member name="P:log4net.Filter.FilterSkeleton.Next">
  13801. <summary>
  13802. Property to get and set the next filter
  13803. </summary>
  13804. <value>
  13805. The next filter in the chain
  13806. </value>
  13807. <remarks>
  13808. <para>
  13809. Filters are typically composed into chains. This property allows the next filter in
  13810. the chain to be accessed.
  13811. </para>
  13812. </remarks>
  13813. </member>
  13814. <member name="T:log4net.Filter.IFilter">
  13815. <summary>
  13816. Implement this interface to provide customized logging event filtering
  13817. </summary>
  13818. <remarks>
  13819. <para>
  13820. Users should implement this interface to implement customized logging
  13821. event filtering. Note that <see cref="T:log4net.Repository.Hierarchy.Logger"/> and
  13822. <see cref="T:log4net.Appender.AppenderSkeleton"/>, the parent class of all standard
  13823. appenders, have built-in filtering rules. It is suggested that you
  13824. first use and understand the built-in rules before rushing to write
  13825. your own custom filters.
  13826. </para>
  13827. <para>
  13828. This abstract class assumes and also imposes that filters be
  13829. organized in a linear chain. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/>
  13830. method of each filter is called sequentially, in the order of their
  13831. addition to the chain.
  13832. </para>
  13833. <para>
  13834. The <see cref="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)"/> method must return one
  13835. of the integer constants <see cref="F:log4net.Filter.FilterDecision.Deny"/>,
  13836. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> or <see cref="F:log4net.Filter.FilterDecision.Accept"/>.
  13837. </para>
  13838. <para>
  13839. If the value <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned, then the log event is dropped
  13840. immediately without consulting with the remaining filters.
  13841. </para>
  13842. <para>
  13843. If the value <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned, then the next filter
  13844. in the chain is consulted. If there are no more filters in the
  13845. chain, then the log event is logged. Thus, in the presence of no
  13846. filters, the default behavior is to log all logging events.
  13847. </para>
  13848. <para>
  13849. If the value <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, then the log
  13850. event is logged without consulting the remaining filters.
  13851. </para>
  13852. <para>
  13853. The philosophy of log4net filters is largely inspired from the
  13854. Linux ipchains.
  13855. </para>
  13856. </remarks>
  13857. <author>Nicko Cadell</author>
  13858. <author>Gert Driesen</author>
  13859. </member>
  13860. <member name="M:log4net.Filter.IFilter.Decide(log4net.Core.LoggingEvent)">
  13861. <summary>
  13862. Decide if the logging event should be logged through an appender.
  13863. </summary>
  13864. <param name="loggingEvent">The LoggingEvent to decide upon</param>
  13865. <returns>The decision of the filter</returns>
  13866. <remarks>
  13867. <para>
  13868. If the decision is <see cref="F:log4net.Filter.FilterDecision.Deny"/>, then the event will be
  13869. dropped. If the decision is <see cref="F:log4net.Filter.FilterDecision.Neutral"/>, then the next
  13870. filter, if any, will be invoked. If the decision is <see cref="F:log4net.Filter.FilterDecision.Accept"/> then
  13871. the event will be logged without consulting with other filters in
  13872. the chain.
  13873. </para>
  13874. </remarks>
  13875. </member>
  13876. <member name="P:log4net.Filter.IFilter.Next">
  13877. <summary>
  13878. Property to get and set the next filter
  13879. </summary>
  13880. <value>
  13881. The next filter in the chain
  13882. </value>
  13883. <remarks>
  13884. <para>
  13885. Filters are typically composed into chains. This property allows the next filter in
  13886. the chain to be accessed.
  13887. </para>
  13888. </remarks>
  13889. </member>
  13890. <member name="T:log4net.Filter.LevelMatchFilter">
  13891. <summary>
  13892. This is a very simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  13893. </summary>
  13894. <remarks>
  13895. <para>
  13896. The filter admits two options <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> and
  13897. <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If there is an exact match between the value
  13898. of the <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/> option and the <see cref="T:log4net.Core.Level"/> of the
  13899. <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
  13900. case the <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> option value is set
  13901. to <c>true</c>, if it is <c>false</c> then
  13902. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If the <see cref="T:log4net.Core.Level"/> does not match then
  13903. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  13904. </para>
  13905. </remarks>
  13906. <author>Nicko Cadell</author>
  13907. <author>Gert Driesen</author>
  13908. </member>
  13909. <member name="F:log4net.Filter.LevelMatchFilter.m_acceptOnMatch">
  13910. <summary>
  13911. flag to indicate if the filter should <see cref="F:log4net.Filter.FilterDecision.Accept"/> on a match
  13912. </summary>
  13913. </member>
  13914. <member name="F:log4net.Filter.LevelMatchFilter.m_levelToMatch">
  13915. <summary>
  13916. the <see cref="T:log4net.Core.Level"/> to match against
  13917. </summary>
  13918. </member>
  13919. <member name="M:log4net.Filter.LevelMatchFilter.#ctor">
  13920. <summary>
  13921. Default constructor
  13922. </summary>
  13923. </member>
  13924. <member name="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch">
  13925. <summary>
  13926. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelMatchFilter.LevelToMatch"/>
  13927. </summary>
  13928. <remarks>
  13929. <para>
  13930. The <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/> property is a flag that determines
  13931. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  13932. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  13933. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  13934. </para>
  13935. <para>
  13936. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  13937. </para>
  13938. </remarks>
  13939. </member>
  13940. <member name="P:log4net.Filter.LevelMatchFilter.LevelToMatch">
  13941. <summary>
  13942. The <see cref="T:log4net.Core.Level"/> that the filter will match
  13943. </summary>
  13944. <remarks>
  13945. <para>
  13946. The level that this filter will attempt to match against the
  13947. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  13948. the result depends on the value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>.
  13949. </para>
  13950. </remarks>
  13951. </member>
  13952. <member name="M:log4net.Filter.LevelMatchFilter.Decide(log4net.Core.LoggingEvent)">
  13953. <summary>
  13954. Tests if the <see cref="T:log4net.Core.Level"/> of the logging event matches that of the filter
  13955. </summary>
  13956. <param name="loggingEvent">the event to filter</param>
  13957. <returns>see remarks</returns>
  13958. <remarks>
  13959. <para>
  13960. If the <see cref="T:log4net.Core.Level"/> of the event matches the level of the
  13961. filter then the result of the function depends on the
  13962. value of <see cref="P:log4net.Filter.LevelMatchFilter.AcceptOnMatch"/>. If it is true then
  13963. the function will return <see cref="F:log4net.Filter.FilterDecision.Accept"/>, it it is false then it
  13964. will return <see cref="F:log4net.Filter.FilterDecision.Deny"/>. If the <see cref="T:log4net.Core.Level"/> does not match then
  13965. the result will be <see cref="F:log4net.Filter.FilterDecision.Neutral"/>.
  13966. </para>
  13967. </remarks>
  13968. </member>
  13969. <member name="T:log4net.Filter.LevelRangeFilter">
  13970. <summary>
  13971. This is a simple filter based on <see cref="T:log4net.Core.Level"/> matching.
  13972. </summary>
  13973. <remarks>
  13974. <para>
  13975. The filter admits three options <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  13976. that determine the range of priorities that are matched, and
  13977. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>. If there is a match between the range
  13978. of priorities and the <see cref="T:log4net.Core.Level"/> of the <see cref="T:log4net.Core.LoggingEvent"/>, then the
  13979. <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"/>
  13980. option value is set to <c>true</c>, if it is <c>false</c>
  13981. then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned. If there is no match, <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  13982. </para>
  13983. </remarks>
  13984. <author>Nicko Cadell</author>
  13985. <author>Gert Driesen</author>
  13986. </member>
  13987. <member name="F:log4net.Filter.LevelRangeFilter.m_acceptOnMatch">
  13988. <summary>
  13989. Flag to indicate the behavior when matching a <see cref="T:log4net.Core.Level"/>
  13990. </summary>
  13991. </member>
  13992. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMin">
  13993. <summary>
  13994. the minimum <see cref="T:log4net.Core.Level"/> value to match
  13995. </summary>
  13996. </member>
  13997. <member name="F:log4net.Filter.LevelRangeFilter.m_levelMax">
  13998. <summary>
  13999. the maximum <see cref="T:log4net.Core.Level"/> value to match
  14000. </summary>
  14001. </member>
  14002. <member name="M:log4net.Filter.LevelRangeFilter.#ctor">
  14003. <summary>
  14004. Default constructor
  14005. </summary>
  14006. </member>
  14007. <member name="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch">
  14008. <summary>
  14009. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LevelRangeFilter.LevelMin"/> and <see cref="P:log4net.Filter.LevelRangeFilter.LevelMax"/>
  14010. </summary>
  14011. <remarks>
  14012. <para>
  14013. The <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> property is a flag that determines
  14014. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  14015. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  14016. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  14017. </para>
  14018. <para>
  14019. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  14020. </para>
  14021. </remarks>
  14022. </member>
  14023. <member name="P:log4net.Filter.LevelRangeFilter.LevelMin">
  14024. <summary>
  14025. Set the minimum matched <see cref="T:log4net.Core.Level"/>
  14026. </summary>
  14027. <remarks>
  14028. <para>
  14029. The minimum level that this filter will attempt to match against the
  14030. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  14031. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  14032. </para>
  14033. </remarks>
  14034. </member>
  14035. <member name="P:log4net.Filter.LevelRangeFilter.LevelMax">
  14036. <summary>
  14037. Sets the maximum matched <see cref="T:log4net.Core.Level"/>
  14038. </summary>
  14039. <remarks>
  14040. <para>
  14041. The maximum level that this filter will attempt to match against the
  14042. <see cref="T:log4net.Core.LoggingEvent"/> level. If a match is found then
  14043. the result depends on the value of <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/>.
  14044. </para>
  14045. </remarks>
  14046. </member>
  14047. <member name="M:log4net.Filter.LevelRangeFilter.Decide(log4net.Core.LoggingEvent)">
  14048. <summary>
  14049. Check if the event should be logged.
  14050. </summary>
  14051. <param name="loggingEvent">the logging event to check</param>
  14052. <returns>see remarks</returns>
  14053. <remarks>
  14054. <para>
  14055. If the <see cref="T:log4net.Core.Level"/> of the logging event is outside the range
  14056. matched by this filter then <see cref="F:log4net.Filter.FilterDecision.Deny"/>
  14057. is returned. If the <see cref="T:log4net.Core.Level"/> is matched then the value of
  14058. <see cref="P:log4net.Filter.LevelRangeFilter.AcceptOnMatch"/> is checked. If it is true then
  14059. <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned, otherwise
  14060. <see cref="F:log4net.Filter.FilterDecision.Neutral"/> is returned.
  14061. </para>
  14062. </remarks>
  14063. </member>
  14064. <member name="T:log4net.Filter.LoggerMatchFilter">
  14065. <summary>
  14066. Simple filter to match a string in the event's logger name.
  14067. </summary>
  14068. <remarks>
  14069. <para>
  14070. The works very similar to the <see cref="T:log4net.Filter.LevelMatchFilter"/>. It admits two
  14071. options <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> and <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>. If the
  14072. <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <see cref="T:log4net.Core.LoggingEvent"/> starts
  14073. with the value of the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> option, then the
  14074. <see cref="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)"/> method returns <see cref="F:log4net.Filter.FilterDecision.Accept"/> in
  14075. case the <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> option value is set to <c>true</c>,
  14076. if it is <c>false</c> then <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  14077. </para>
  14078. </remarks>
  14079. <author>Daniel Cazzulino</author>
  14080. </member>
  14081. <member name="F:log4net.Filter.LoggerMatchFilter.m_acceptOnMatch">
  14082. <summary>
  14083. Flag to indicate the behavior when we have a match
  14084. </summary>
  14085. </member>
  14086. <member name="F:log4net.Filter.LoggerMatchFilter.m_loggerToMatch">
  14087. <summary>
  14088. The logger name string to substring match against the event
  14089. </summary>
  14090. </member>
  14091. <member name="M:log4net.Filter.LoggerMatchFilter.#ctor">
  14092. <summary>
  14093. Default constructor
  14094. </summary>
  14095. </member>
  14096. <member name="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch">
  14097. <summary>
  14098. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>
  14099. </summary>
  14100. <remarks>
  14101. <para>
  14102. The <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> property is a flag that determines
  14103. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  14104. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  14105. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Deny"/> the event.
  14106. </para>
  14107. <para>
  14108. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  14109. </para>
  14110. </remarks>
  14111. </member>
  14112. <member name="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch">
  14113. <summary>
  14114. The <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> that the filter will match
  14115. </summary>
  14116. <remarks>
  14117. <para>
  14118. This filter will attempt to match this value against logger name in
  14119. the following way. The match will be done against the beginning of the
  14120. logger name (using <see cref="M:String.StartsWith(string)"/>). The match is
  14121. case sensitive. If a match is found then
  14122. the result depends on the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/>.
  14123. </para>
  14124. </remarks>
  14125. </member>
  14126. <member name="M:log4net.Filter.LoggerMatchFilter.Decide(log4net.Core.LoggingEvent)">
  14127. <summary>
  14128. Check if this filter should allow the event to be logged
  14129. </summary>
  14130. <param name="loggingEvent">the event being logged</param>
  14131. <returns>see remarks</returns>
  14132. <remarks>
  14133. <para>
  14134. The rendered message is matched against the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/>.
  14135. If the <see cref="P:log4net.Filter.LoggerMatchFilter.LoggerToMatch"/> equals the beginning of
  14136. the incoming <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> (<see cref="M:String.StartsWith(string)"/>)
  14137. then a match will have occurred. If no match occurs
  14138. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  14139. allowing other filters to check the event. If a match occurs then
  14140. the value of <see cref="P:log4net.Filter.LoggerMatchFilter.AcceptOnMatch"/> is checked. If it is
  14141. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  14142. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  14143. </para>
  14144. </remarks>
  14145. </member>
  14146. <member name="T:log4net.Filter.MdcFilter">
  14147. <summary>
  14148. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  14149. </summary>
  14150. <remarks>
  14151. <para>
  14152. Simple filter to match a keyed string in the <see cref="T:log4net.MDC"/>
  14153. </para>
  14154. <para>
  14155. As the MDC has been replaced with layered properties the
  14156. <see cref="T:log4net.Filter.PropertyFilter"/> should be used instead.
  14157. </para>
  14158. </remarks>
  14159. <author>Nicko Cadell</author>
  14160. <author>Gert Driesen</author>
  14161. </member>
  14162. <member name="T:log4net.Filter.NdcFilter">
  14163. <summary>
  14164. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  14165. </summary>
  14166. <remarks>
  14167. <para>
  14168. Simple filter to match a string in the <see cref="T:log4net.NDC"/>
  14169. </para>
  14170. <para>
  14171. As the MDC has been replaced with named stacks stored in the
  14172. properties collections the <see cref="T:log4net.Filter.PropertyFilter"/> should
  14173. be used instead.
  14174. </para>
  14175. </remarks>
  14176. <author>Nicko Cadell</author>
  14177. <author>Gert Driesen</author>
  14178. </member>
  14179. <member name="M:log4net.Filter.NdcFilter.#ctor">
  14180. <summary>
  14181. Default constructor
  14182. </summary>
  14183. <remarks>
  14184. <para>
  14185. Sets the <see cref="P:log4net.Filter.PropertyFilter.Key"/> to <c>"NDC"</c>.
  14186. </para>
  14187. </remarks>
  14188. </member>
  14189. <member name="T:log4net.Filter.PropertyFilter">
  14190. <summary>
  14191. Simple filter to match a string an event property
  14192. </summary>
  14193. <remarks>
  14194. <para>
  14195. Simple filter to match a string in the value for a
  14196. specific event property
  14197. </para>
  14198. </remarks>
  14199. <author>Nicko Cadell</author>
  14200. </member>
  14201. <member name="F:log4net.Filter.PropertyFilter.m_key">
  14202. <summary>
  14203. The key to use to lookup the string from the event properties
  14204. </summary>
  14205. </member>
  14206. <member name="M:log4net.Filter.PropertyFilter.#ctor">
  14207. <summary>
  14208. Default constructor
  14209. </summary>
  14210. </member>
  14211. <member name="P:log4net.Filter.PropertyFilter.Key">
  14212. <summary>
  14213. The key to lookup in the event properties and then match against.
  14214. </summary>
  14215. <remarks>
  14216. <para>
  14217. The key name to use to lookup in the properties map of the
  14218. <see cref="T:log4net.Core.LoggingEvent"/>. The match will be performed against
  14219. the value of this property if it exists.
  14220. </para>
  14221. </remarks>
  14222. </member>
  14223. <member name="M:log4net.Filter.PropertyFilter.Decide(log4net.Core.LoggingEvent)">
  14224. <summary>
  14225. Check if this filter should allow the event to be logged
  14226. </summary>
  14227. <param name="loggingEvent">the event being logged</param>
  14228. <returns>see remarks</returns>
  14229. <remarks>
  14230. <para>
  14231. The event property for the <see cref="P:log4net.Filter.PropertyFilter.Key"/> is matched against
  14232. the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  14233. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  14234. the property value then a match will have occurred. If no match occurs
  14235. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  14236. allowing other filters to check the event. If a match occurs then
  14237. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  14238. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  14239. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  14240. </para>
  14241. </remarks>
  14242. </member>
  14243. <member name="T:log4net.Filter.StringMatchFilter">
  14244. <summary>
  14245. Simple filter to match a string in the rendered message
  14246. </summary>
  14247. <remarks>
  14248. <para>
  14249. Simple filter to match a string in the rendered message
  14250. </para>
  14251. </remarks>
  14252. <author>Nicko Cadell</author>
  14253. <author>Gert Driesen</author>
  14254. </member>
  14255. <member name="F:log4net.Filter.StringMatchFilter.m_acceptOnMatch">
  14256. <summary>
  14257. Flag to indicate the behavior when we have a match
  14258. </summary>
  14259. </member>
  14260. <member name="F:log4net.Filter.StringMatchFilter.m_stringToMatch">
  14261. <summary>
  14262. The string to substring match against the message
  14263. </summary>
  14264. </member>
  14265. <member name="F:log4net.Filter.StringMatchFilter.m_stringRegexToMatch">
  14266. <summary>
  14267. A string regex to match
  14268. </summary>
  14269. </member>
  14270. <member name="F:log4net.Filter.StringMatchFilter.m_regexToMatch">
  14271. <summary>
  14272. A regex object to match (generated from m_stringRegexToMatch)
  14273. </summary>
  14274. </member>
  14275. <member name="M:log4net.Filter.StringMatchFilter.#ctor">
  14276. <summary>
  14277. Default constructor
  14278. </summary>
  14279. </member>
  14280. <member name="M:log4net.Filter.StringMatchFilter.ActivateOptions">
  14281. <summary>
  14282. Initialize and precompile the Regex if required
  14283. </summary>
  14284. <remarks>
  14285. <para>
  14286. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  14287. activation scheme. The <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> method must
  14288. be called on this object after the configuration properties have
  14289. been set. Until <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> is called this
  14290. object is in an undefined state and must not be used.
  14291. </para>
  14292. <para>
  14293. If any of the configuration properties are modified then
  14294. <see cref="M:log4net.Filter.StringMatchFilter.ActivateOptions"/> must be called again.
  14295. </para>
  14296. </remarks>
  14297. </member>
  14298. <member name="P:log4net.Filter.StringMatchFilter.AcceptOnMatch">
  14299. <summary>
  14300. <see cref="F:log4net.Filter.FilterDecision.Accept"/> when matching <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  14301. </summary>
  14302. <remarks>
  14303. <para>
  14304. The <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> property is a flag that determines
  14305. the behavior when a matching <see cref="T:log4net.Core.Level"/> is found. If the
  14306. flag is set to true then the filter will <see cref="F:log4net.Filter.FilterDecision.Accept"/> the
  14307. logging event, otherwise it will <see cref="F:log4net.Filter.FilterDecision.Neutral"/> the event.
  14308. </para>
  14309. <para>
  14310. The default is <c>true</c> i.e. to <see cref="F:log4net.Filter.FilterDecision.Accept"/> the event.
  14311. </para>
  14312. </remarks>
  14313. </member>
  14314. <member name="P:log4net.Filter.StringMatchFilter.StringToMatch">
  14315. <summary>
  14316. Sets the static string to match
  14317. </summary>
  14318. <remarks>
  14319. <para>
  14320. The string that will be substring matched against
  14321. the rendered message. If the message contains this
  14322. string then the filter will match. If a match is found then
  14323. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  14324. </para>
  14325. <para>
  14326. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  14327. must be specified.
  14328. </para>
  14329. </remarks>
  14330. </member>
  14331. <member name="P:log4net.Filter.StringMatchFilter.RegexToMatch">
  14332. <summary>
  14333. Sets the regular expression to match
  14334. </summary>
  14335. <remarks>
  14336. <para>
  14337. The regular expression pattern that will be matched against
  14338. the rendered message. If the message matches this
  14339. pattern then the filter will match. If a match is found then
  14340. the result depends on the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/>.
  14341. </para>
  14342. <para>
  14343. One of <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> or <see cref="P:log4net.Filter.StringMatchFilter.RegexToMatch"/>
  14344. must be specified.
  14345. </para>
  14346. </remarks>
  14347. </member>
  14348. <member name="M:log4net.Filter.StringMatchFilter.Decide(log4net.Core.LoggingEvent)">
  14349. <summary>
  14350. Check if this filter should allow the event to be logged
  14351. </summary>
  14352. <param name="loggingEvent">the event being logged</param>
  14353. <returns>see remarks</returns>
  14354. <remarks>
  14355. <para>
  14356. The rendered message is matched against the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/>.
  14357. If the <see cref="P:log4net.Filter.StringMatchFilter.StringToMatch"/> occurs as a substring within
  14358. the message then a match will have occurred. If no match occurs
  14359. this function will return <see cref="F:log4net.Filter.FilterDecision.Neutral"/>
  14360. allowing other filters to check the event. If a match occurs then
  14361. the value of <see cref="P:log4net.Filter.StringMatchFilter.AcceptOnMatch"/> is checked. If it is
  14362. true then <see cref="F:log4net.Filter.FilterDecision.Accept"/> is returned otherwise
  14363. <see cref="F:log4net.Filter.FilterDecision.Deny"/> is returned.
  14364. </para>
  14365. </remarks>
  14366. </member>
  14367. <member name="T:log4net.GlobalContext">
  14368. <summary>
  14369. The log4net Global Context.
  14370. </summary>
  14371. <remarks>
  14372. <para>
  14373. The <c>GlobalContext</c> provides a location for global debugging
  14374. information to be stored.
  14375. </para>
  14376. <para>
  14377. The global context has a properties map and these properties can
  14378. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  14379. supports selecting and outputing these properties.
  14380. </para>
  14381. <para>
  14382. By default the <c>log4net:HostName</c> property is set to the name of
  14383. the current machine.
  14384. </para>
  14385. </remarks>
  14386. <example>
  14387. <code lang="C#">
  14388. GlobalContext.Properties["hostname"] = Environment.MachineName;
  14389. </code>
  14390. </example>
  14391. <threadsafety static="true" instance="true" />
  14392. <author>Nicko Cadell</author>
  14393. </member>
  14394. <member name="M:log4net.GlobalContext.#ctor">
  14395. <summary>
  14396. Private Constructor.
  14397. </summary>
  14398. <remarks>
  14399. Uses a private access modifier to prevent instantiation of this class.
  14400. </remarks>
  14401. </member>
  14402. <member name="P:log4net.GlobalContext.Properties">
  14403. <summary>
  14404. The global properties map.
  14405. </summary>
  14406. <value>
  14407. The global properties map.
  14408. </value>
  14409. <remarks>
  14410. <para>
  14411. The global properties map.
  14412. </para>
  14413. </remarks>
  14414. </member>
  14415. <member name="F:log4net.GlobalContext.s_properties">
  14416. <summary>
  14417. The global context properties instance
  14418. </summary>
  14419. </member>
  14420. <member name="T:log4net.ILog">
  14421. <summary>
  14422. The ILog interface is use by application to log messages into
  14423. the log4net framework.
  14424. </summary>
  14425. <remarks>
  14426. <para>
  14427. Use the <see cref="T:log4net.LogManager"/> to obtain logger instances
  14428. that implement this interface. The <see cref="M:LogManager.GetLogger(Assembly,Type)"/>
  14429. static method is used to get logger instances.
  14430. </para>
  14431. <para>
  14432. This class contains methods for logging at different levels and also
  14433. has properties for determining if those logging levels are
  14434. enabled in the current configuration.
  14435. </para>
  14436. <para>
  14437. This interface can be implemented in different ways. This documentation
  14438. specifies reasonable behavior that a caller can expect from the actual
  14439. implementation, however different implementations reserve the right to
  14440. do things differently.
  14441. </para>
  14442. </remarks>
  14443. <example>Simple example of logging messages
  14444. <code lang="C#">
  14445. ILog log = LogManager.GetLogger("application-log");
  14446. log.Info("Application Start");
  14447. log.Debug("This is a debug message");
  14448. if (log.IsDebugEnabled)
  14449. {
  14450. log.Debug("This is another debug message");
  14451. }
  14452. </code>
  14453. </example>
  14454. <seealso cref="T:log4net.LogManager"/>
  14455. <seealso cref="M:LogManager.GetLogger(Assembly, Type)"/>
  14456. <author>Nicko Cadell</author>
  14457. <author>Gert Driesen</author>
  14458. </member>
  14459. <member name="M:log4net.ILog.Debug(System.Object)">
  14460. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  14461. <summary>
  14462. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14463. </summary>
  14464. <param name="message">The message object to log.</param>
  14465. <remarks>
  14466. <para>
  14467. This method first checks if this logger is <c>DEBUG</c>
  14468. enabled by comparing the level of this logger with the
  14469. <see cref="F:log4net.Core.Level.Debug"/> level. If this logger is
  14470. <c>DEBUG</c> enabled, then it converts the message object
  14471. (passed as parameter) to a string by invoking the appropriate
  14472. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14473. proceeds to call all the registered appenders in this logger
  14474. and also higher in the hierarchy depending on the value of
  14475. the additivity flag.
  14476. </para>
  14477. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14478. to this method will print the name of the <see cref="T:System.Exception"/>
  14479. but no stack trace. To print a stack trace use the
  14480. <see cref="M:Debug(object,Exception)"/> form instead.
  14481. </para>
  14482. </remarks>
  14483. <seealso cref="M:Debug(object,Exception)"/>
  14484. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14485. </member>
  14486. <member name="M:log4net.ILog.Debug(System.Object,System.Exception)">
  14487. <summary>
  14488. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  14489. the stack trace of the <see cref="T:System.Exception"/> passed
  14490. as a parameter.
  14491. </summary>
  14492. <param name="message">The message object to log.</param>
  14493. <param name="exception">The exception to log, including its stack trace.</param>
  14494. <remarks>
  14495. <para>
  14496. See the <see cref="M:Debug(object)"/> form for more detailed information.
  14497. </para>
  14498. </remarks>
  14499. <seealso cref="M:Debug(object)"/>
  14500. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14501. </member>
  14502. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object[])">
  14503. <overloads>Log a formatted string with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads>
  14504. <summary>
  14505. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14506. </summary>
  14507. <param name="format">A String containing zero or more format items</param>
  14508. <param name="args">An Object array containing zero or more objects to format</param>
  14509. <remarks>
  14510. <para>
  14511. The message is formatted using the <c>String.Format</c> method. See
  14512. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14513. of the formatting.
  14514. </para>
  14515. <para>
  14516. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14517. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14518. methods instead.
  14519. </para>
  14520. </remarks>
  14521. <seealso cref="M:Debug(object)"/>
  14522. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14523. </member>
  14524. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object)">
  14525. <summary>
  14526. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14527. </summary>
  14528. <param name="format">A String containing zero or more format items</param>
  14529. <param name="arg0">An Object to format</param>
  14530. <remarks>
  14531. <para>
  14532. The message is formatted using the <c>String.Format</c> method. See
  14533. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14534. of the formatting.
  14535. </para>
  14536. <para>
  14537. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14538. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14539. methods instead.
  14540. </para>
  14541. </remarks>
  14542. <seealso cref="M:Debug(object)"/>
  14543. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14544. </member>
  14545. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object)">
  14546. <summary>
  14547. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14548. </summary>
  14549. <param name="format">A String containing zero or more format items</param>
  14550. <param name="arg0">An Object to format</param>
  14551. <param name="arg1">An Object to format</param>
  14552. <remarks>
  14553. <para>
  14554. The message is formatted using the <c>String.Format</c> method. See
  14555. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14556. of the formatting.
  14557. </para>
  14558. <para>
  14559. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14560. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14561. methods instead.
  14562. </para>
  14563. </remarks>
  14564. <seealso cref="M:Debug(object)"/>
  14565. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14566. </member>
  14567. <member name="M:log4net.ILog.DebugFormat(System.String,System.Object,System.Object,System.Object)">
  14568. <summary>
  14569. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14570. </summary>
  14571. <param name="format">A String containing zero or more format items</param>
  14572. <param name="arg0">An Object to format</param>
  14573. <param name="arg1">An Object to format</param>
  14574. <param name="arg2">An Object to format</param>
  14575. <remarks>
  14576. <para>
  14577. The message is formatted using the <c>String.Format</c> method. See
  14578. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14579. of the formatting.
  14580. </para>
  14581. <para>
  14582. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14583. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14584. methods instead.
  14585. </para>
  14586. </remarks>
  14587. <seealso cref="M:Debug(object)"/>
  14588. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14589. </member>
  14590. <member name="M:log4net.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
  14591. <summary>
  14592. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  14593. </summary>
  14594. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14595. <param name="format">A String containing zero or more format items</param>
  14596. <param name="args">An Object array containing zero or more objects to format</param>
  14597. <remarks>
  14598. <para>
  14599. The message is formatted using the <c>String.Format</c> method. See
  14600. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14601. of the formatting.
  14602. </para>
  14603. <para>
  14604. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14605. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Debug(object,Exception)"/>
  14606. methods instead.
  14607. </para>
  14608. </remarks>
  14609. <seealso cref="M:Debug(object)"/>
  14610. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  14611. </member>
  14612. <member name="M:log4net.ILog.Info(System.Object)">
  14613. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  14614. <summary>
  14615. Logs a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  14616. </summary>
  14617. <remarks>
  14618. <para>
  14619. This method first checks if this logger is <c>INFO</c>
  14620. enabled by comparing the level of this logger with the
  14621. <see cref="F:log4net.Core.Level.Info"/> level. If this logger is
  14622. <c>INFO</c> enabled, then it converts the message object
  14623. (passed as parameter) to a string by invoking the appropriate
  14624. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14625. proceeds to call all the registered appenders in this logger
  14626. and also higher in the hierarchy depending on the value of the
  14627. additivity flag.
  14628. </para>
  14629. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14630. to this method will print the name of the <see cref="T:System.Exception"/>
  14631. but no stack trace. To print a stack trace use the
  14632. <see cref="M:Info(object,Exception)"/> form instead.
  14633. </para>
  14634. </remarks>
  14635. <param name="message">The message object to log.</param>
  14636. <seealso cref="M:Info(object,Exception)"/>
  14637. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14638. </member>
  14639. <member name="M:log4net.ILog.Info(System.Object,System.Exception)">
  14640. <summary>
  14641. Logs a message object with the <c>INFO</c> level including
  14642. the stack trace of the <see cref="T:System.Exception"/> passed
  14643. as a parameter.
  14644. </summary>
  14645. <param name="message">The message object to log.</param>
  14646. <param name="exception">The exception to log, including its stack trace.</param>
  14647. <remarks>
  14648. <para>
  14649. See the <see cref="M:Info(object)"/> form for more detailed information.
  14650. </para>
  14651. </remarks>
  14652. <seealso cref="M:Info(object)"/>
  14653. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14654. </member>
  14655. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object[])">
  14656. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads>
  14657. <summary>
  14658. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14659. </summary>
  14660. <param name="format">A String containing zero or more format items</param>
  14661. <param name="args">An Object array containing zero or more objects to format</param>
  14662. <remarks>
  14663. <para>
  14664. The message is formatted using the <c>String.Format</c> method. See
  14665. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14666. of the formatting.
  14667. </para>
  14668. <para>
  14669. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14670. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14671. methods instead.
  14672. </para>
  14673. </remarks>
  14674. <seealso cref="M:Info(object,Exception)"/>
  14675. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14676. </member>
  14677. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object)">
  14678. <summary>
  14679. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14680. </summary>
  14681. <param name="format">A String containing zero or more format items</param>
  14682. <param name="arg0">An Object to format</param>
  14683. <remarks>
  14684. <para>
  14685. The message is formatted using the <c>String.Format</c> method. See
  14686. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14687. of the formatting.
  14688. </para>
  14689. <para>
  14690. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14691. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14692. methods instead.
  14693. </para>
  14694. </remarks>
  14695. <seealso cref="M:Info(object)"/>
  14696. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14697. </member>
  14698. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object)">
  14699. <summary>
  14700. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14701. </summary>
  14702. <param name="format">A String containing zero or more format items</param>
  14703. <param name="arg0">An Object to format</param>
  14704. <param name="arg1">An Object to format</param>
  14705. <remarks>
  14706. <para>
  14707. The message is formatted using the <c>String.Format</c> method. See
  14708. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14709. of the formatting.
  14710. </para>
  14711. <para>
  14712. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14713. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14714. methods instead.
  14715. </para>
  14716. </remarks>
  14717. <seealso cref="M:Info(object)"/>
  14718. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14719. </member>
  14720. <member name="M:log4net.ILog.InfoFormat(System.String,System.Object,System.Object,System.Object)">
  14721. <summary>
  14722. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14723. </summary>
  14724. <param name="format">A String containing zero or more format items</param>
  14725. <param name="arg0">An Object to format</param>
  14726. <param name="arg1">An Object to format</param>
  14727. <param name="arg2">An Object to format</param>
  14728. <remarks>
  14729. <para>
  14730. The message is formatted using the <c>String.Format</c> method. See
  14731. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14732. of the formatting.
  14733. </para>
  14734. <para>
  14735. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14736. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object,Exception)"/>
  14737. methods instead.
  14738. </para>
  14739. </remarks>
  14740. <seealso cref="M:Info(object)"/>
  14741. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14742. </member>
  14743. <member name="M:log4net.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
  14744. <summary>
  14745. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  14746. </summary>
  14747. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14748. <param name="format">A String containing zero or more format items</param>
  14749. <param name="args">An Object array containing zero or more objects to format</param>
  14750. <remarks>
  14751. <para>
  14752. The message is formatted using the <c>String.Format</c> method. See
  14753. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14754. of the formatting.
  14755. </para>
  14756. <para>
  14757. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14758. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Info(object)"/>
  14759. methods instead.
  14760. </para>
  14761. </remarks>
  14762. <seealso cref="M:Info(object,Exception)"/>
  14763. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  14764. </member>
  14765. <member name="M:log4net.ILog.Warn(System.Object)">
  14766. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  14767. <summary>
  14768. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14769. </summary>
  14770. <remarks>
  14771. <para>
  14772. This method first checks if this logger is <c>WARN</c>
  14773. enabled by comparing the level of this logger with the
  14774. <see cref="F:log4net.Core.Level.Warn"/> level. If this logger is
  14775. <c>WARN</c> enabled, then it converts the message object
  14776. (passed as parameter) to a string by invoking the appropriate
  14777. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14778. proceeds to call all the registered appenders in this logger
  14779. and also higher in the hierarchy depending on the value of the
  14780. additivity flag.
  14781. </para>
  14782. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14783. to this method will print the name of the <see cref="T:System.Exception"/>
  14784. but no stack trace. To print a stack trace use the
  14785. <see cref="M:Warn(object,Exception)"/> form instead.
  14786. </para>
  14787. </remarks>
  14788. <param name="message">The message object to log.</param>
  14789. <seealso cref="M:Warn(object,Exception)"/>
  14790. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14791. </member>
  14792. <member name="M:log4net.ILog.Warn(System.Object,System.Exception)">
  14793. <summary>
  14794. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  14795. the stack trace of the <see cref="T:System.Exception"/> passed
  14796. as a parameter.
  14797. </summary>
  14798. <param name="message">The message object to log.</param>
  14799. <param name="exception">The exception to log, including its stack trace.</param>
  14800. <remarks>
  14801. <para>
  14802. See the <see cref="M:Warn(object)"/> form for more detailed information.
  14803. </para>
  14804. </remarks>
  14805. <seealso cref="M:Warn(object)"/>
  14806. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14807. </member>
  14808. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object[])">
  14809. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads>
  14810. <summary>
  14811. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14812. </summary>
  14813. <param name="format">A String containing zero or more format items</param>
  14814. <param name="args">An Object array containing zero or more objects to format</param>
  14815. <remarks>
  14816. <para>
  14817. The message is formatted using the <c>String.Format</c> method. See
  14818. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14819. of the formatting.
  14820. </para>
  14821. <para>
  14822. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14823. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14824. methods instead.
  14825. </para>
  14826. </remarks>
  14827. <seealso cref="M:Warn(object,Exception)"/>
  14828. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14829. </member>
  14830. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object)">
  14831. <summary>
  14832. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14833. </summary>
  14834. <param name="format">A String containing zero or more format items</param>
  14835. <param name="arg0">An Object to format</param>
  14836. <remarks>
  14837. <para>
  14838. The message is formatted using the <c>String.Format</c> method. See
  14839. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14840. of the formatting.
  14841. </para>
  14842. <para>
  14843. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14844. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14845. methods instead.
  14846. </para>
  14847. </remarks>
  14848. <seealso cref="M:Warn(object)"/>
  14849. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14850. </member>
  14851. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object)">
  14852. <summary>
  14853. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14854. </summary>
  14855. <param name="format">A String containing zero or more format items</param>
  14856. <param name="arg0">An Object to format</param>
  14857. <param name="arg1">An Object to format</param>
  14858. <remarks>
  14859. <para>
  14860. The message is formatted using the <c>String.Format</c> method. See
  14861. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14862. of the formatting.
  14863. </para>
  14864. <para>
  14865. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14866. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14867. methods instead.
  14868. </para>
  14869. </remarks>
  14870. <seealso cref="M:Warn(object)"/>
  14871. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14872. </member>
  14873. <member name="M:log4net.ILog.WarnFormat(System.String,System.Object,System.Object,System.Object)">
  14874. <summary>
  14875. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14876. </summary>
  14877. <param name="format">A String containing zero or more format items</param>
  14878. <param name="arg0">An Object to format</param>
  14879. <param name="arg1">An Object to format</param>
  14880. <param name="arg2">An Object to format</param>
  14881. <remarks>
  14882. <para>
  14883. The message is formatted using the <c>String.Format</c> method. See
  14884. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14885. of the formatting.
  14886. </para>
  14887. <para>
  14888. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14889. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object,Exception)"/>
  14890. methods instead.
  14891. </para>
  14892. </remarks>
  14893. <seealso cref="M:Warn(object)"/>
  14894. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14895. </member>
  14896. <member name="M:log4net.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
  14897. <summary>
  14898. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  14899. </summary>
  14900. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  14901. <param name="format">A String containing zero or more format items</param>
  14902. <param name="args">An Object array containing zero or more objects to format</param>
  14903. <remarks>
  14904. <para>
  14905. The message is formatted using the <c>String.Format</c> method. See
  14906. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14907. of the formatting.
  14908. </para>
  14909. <para>
  14910. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14911. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Warn(object)"/>
  14912. methods instead.
  14913. </para>
  14914. </remarks>
  14915. <seealso cref="M:Warn(object,Exception)"/>
  14916. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  14917. </member>
  14918. <member name="M:log4net.ILog.Error(System.Object)">
  14919. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  14920. <summary>
  14921. Logs a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  14922. </summary>
  14923. <param name="message">The message object to log.</param>
  14924. <remarks>
  14925. <para>
  14926. This method first checks if this logger is <c>ERROR</c>
  14927. enabled by comparing the level of this logger with the
  14928. <see cref="F:log4net.Core.Level.Error"/> level. If this logger is
  14929. <c>ERROR</c> enabled, then it converts the message object
  14930. (passed as parameter) to a string by invoking the appropriate
  14931. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  14932. proceeds to call all the registered appenders in this logger
  14933. and also higher in the hierarchy depending on the value of the
  14934. additivity flag.
  14935. </para>
  14936. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  14937. to this method will print the name of the <see cref="T:System.Exception"/>
  14938. but no stack trace. To print a stack trace use the
  14939. <see cref="M:Error(object,Exception)"/> form instead.
  14940. </para>
  14941. </remarks>
  14942. <seealso cref="M:Error(object,Exception)"/>
  14943. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14944. </member>
  14945. <member name="M:log4net.ILog.Error(System.Object,System.Exception)">
  14946. <summary>
  14947. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  14948. the stack trace of the <see cref="T:System.Exception"/> passed
  14949. as a parameter.
  14950. </summary>
  14951. <param name="message">The message object to log.</param>
  14952. <param name="exception">The exception to log, including its stack trace.</param>
  14953. <remarks>
  14954. <para>
  14955. See the <see cref="M:Error(object)"/> form for more detailed information.
  14956. </para>
  14957. </remarks>
  14958. <seealso cref="M:Error(object)"/>
  14959. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14960. </member>
  14961. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object[])">
  14962. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads>
  14963. <summary>
  14964. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14965. </summary>
  14966. <param name="format">A String containing zero or more format items</param>
  14967. <param name="args">An Object array containing zero or more objects to format</param>
  14968. <remarks>
  14969. <para>
  14970. The message is formatted using the <c>String.Format</c> method. See
  14971. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14972. of the formatting.
  14973. </para>
  14974. <para>
  14975. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14976. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  14977. methods instead.
  14978. </para>
  14979. </remarks>
  14980. <seealso cref="M:Error(object,Exception)"/>
  14981. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  14982. </member>
  14983. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object)">
  14984. <summary>
  14985. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  14986. </summary>
  14987. <param name="format">A String containing zero or more format items</param>
  14988. <param name="arg0">An Object to format</param>
  14989. <remarks>
  14990. <para>
  14991. The message is formatted using the <c>String.Format</c> method. See
  14992. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  14993. of the formatting.
  14994. </para>
  14995. <para>
  14996. This method does not take an <see cref="T:System.Exception"/> object to include in the
  14997. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  14998. methods instead.
  14999. </para>
  15000. </remarks>
  15001. <seealso cref="M:Error(object)"/>
  15002. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  15003. </member>
  15004. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object)">
  15005. <summary>
  15006. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  15007. </summary>
  15008. <param name="format">A String containing zero or more format items</param>
  15009. <param name="arg0">An Object to format</param>
  15010. <param name="arg1">An Object to format</param>
  15011. <remarks>
  15012. <para>
  15013. The message is formatted using the <c>String.Format</c> method. See
  15014. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15015. of the formatting.
  15016. </para>
  15017. <para>
  15018. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15019. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  15020. methods instead.
  15021. </para>
  15022. </remarks>
  15023. <seealso cref="M:Error(object)"/>
  15024. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  15025. </member>
  15026. <member name="M:log4net.ILog.ErrorFormat(System.String,System.Object,System.Object,System.Object)">
  15027. <summary>
  15028. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  15029. </summary>
  15030. <param name="format">A String containing zero or more format items</param>
  15031. <param name="arg0">An Object to format</param>
  15032. <param name="arg1">An Object to format</param>
  15033. <param name="arg2">An Object to format</param>
  15034. <remarks>
  15035. <para>
  15036. The message is formatted using the <c>String.Format</c> method. See
  15037. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15038. of the formatting.
  15039. </para>
  15040. <para>
  15041. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15042. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object,Exception)"/>
  15043. methods instead.
  15044. </para>
  15045. </remarks>
  15046. <seealso cref="M:Error(object)"/>
  15047. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  15048. </member>
  15049. <member name="M:log4net.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
  15050. <summary>
  15051. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  15052. </summary>
  15053. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15054. <param name="format">A String containing zero or more format items</param>
  15055. <param name="args">An Object array containing zero or more objects to format</param>
  15056. <remarks>
  15057. <para>
  15058. The message is formatted using the <c>String.Format</c> method. See
  15059. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15060. of the formatting.
  15061. </para>
  15062. <para>
  15063. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15064. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Error(object)"/>
  15065. methods instead.
  15066. </para>
  15067. </remarks>
  15068. <seealso cref="M:Error(object,Exception)"/>
  15069. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  15070. </member>
  15071. <member name="M:log4net.ILog.Fatal(System.Object)">
  15072. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  15073. <summary>
  15074. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15075. </summary>
  15076. <remarks>
  15077. <para>
  15078. This method first checks if this logger is <c>FATAL</c>
  15079. enabled by comparing the level of this logger with the
  15080. <see cref="F:log4net.Core.Level.Fatal"/> level. If this logger is
  15081. <c>FATAL</c> enabled, then it converts the message object
  15082. (passed as parameter) to a string by invoking the appropriate
  15083. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  15084. proceeds to call all the registered appenders in this logger
  15085. and also higher in the hierarchy depending on the value of the
  15086. additivity flag.
  15087. </para>
  15088. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  15089. to this method will print the name of the <see cref="T:System.Exception"/>
  15090. but no stack trace. To print a stack trace use the
  15091. <see cref="M:Fatal(object,Exception)"/> form instead.
  15092. </para>
  15093. </remarks>
  15094. <param name="message">The message object to log.</param>
  15095. <seealso cref="M:Fatal(object,Exception)"/>
  15096. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15097. </member>
  15098. <member name="M:log4net.ILog.Fatal(System.Object,System.Exception)">
  15099. <summary>
  15100. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  15101. the stack trace of the <see cref="T:System.Exception"/> passed
  15102. as a parameter.
  15103. </summary>
  15104. <param name="message">The message object to log.</param>
  15105. <param name="exception">The exception to log, including its stack trace.</param>
  15106. <remarks>
  15107. <para>
  15108. See the <see cref="M:Fatal(object)"/> form for more detailed information.
  15109. </para>
  15110. </remarks>
  15111. <seealso cref="M:Fatal(object)"/>
  15112. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15113. </member>
  15114. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object[])">
  15115. <overloads>Log a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads>
  15116. <summary>
  15117. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15118. </summary>
  15119. <param name="format">A String containing zero or more format items</param>
  15120. <param name="args">An Object array containing zero or more objects to format</param>
  15121. <remarks>
  15122. <para>
  15123. The message is formatted using the <c>String.Format</c> method. See
  15124. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15125. of the formatting.
  15126. </para>
  15127. <para>
  15128. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15129. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15130. methods instead.
  15131. </para>
  15132. </remarks>
  15133. <seealso cref="M:Fatal(object,Exception)"/>
  15134. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15135. </member>
  15136. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object)">
  15137. <summary>
  15138. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15139. </summary>
  15140. <param name="format">A String containing zero or more format items</param>
  15141. <param name="arg0">An Object to format</param>
  15142. <remarks>
  15143. <para>
  15144. The message is formatted using the <c>String.Format</c> method. See
  15145. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15146. of the formatting.
  15147. </para>
  15148. <para>
  15149. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15150. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  15151. methods instead.
  15152. </para>
  15153. </remarks>
  15154. <seealso cref="M:Fatal(object)"/>
  15155. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15156. </member>
  15157. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object)">
  15158. <summary>
  15159. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15160. </summary>
  15161. <param name="format">A String containing zero or more format items</param>
  15162. <param name="arg0">An Object to format</param>
  15163. <param name="arg1">An Object to format</param>
  15164. <remarks>
  15165. <para>
  15166. The message is formatted using the <c>String.Format</c> method. See
  15167. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15168. of the formatting.
  15169. </para>
  15170. <para>
  15171. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15172. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  15173. methods instead.
  15174. </para>
  15175. </remarks>
  15176. <seealso cref="M:Fatal(object)"/>
  15177. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15178. </member>
  15179. <member name="M:log4net.ILog.FatalFormat(System.String,System.Object,System.Object,System.Object)">
  15180. <summary>
  15181. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15182. </summary>
  15183. <param name="format">A String containing zero or more format items</param>
  15184. <param name="arg0">An Object to format</param>
  15185. <param name="arg1">An Object to format</param>
  15186. <param name="arg2">An Object to format</param>
  15187. <remarks>
  15188. <para>
  15189. The message is formatted using the <c>String.Format</c> method. See
  15190. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15191. of the formatting.
  15192. </para>
  15193. <para>
  15194. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15195. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object,Exception)"/>
  15196. methods instead.
  15197. </para>
  15198. </remarks>
  15199. <seealso cref="M:Fatal(object)"/>
  15200. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15201. </member>
  15202. <member name="M:log4net.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
  15203. <summary>
  15204. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15205. </summary>
  15206. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  15207. <param name="format">A String containing zero or more format items</param>
  15208. <param name="args">An Object array containing zero or more objects to format</param>
  15209. <remarks>
  15210. <para>
  15211. The message is formatted using the <c>String.Format</c> method. See
  15212. <see cref="M:String.Format(string, object[])"/> for details of the syntax of the format string and the behavior
  15213. of the formatting.
  15214. </para>
  15215. <para>
  15216. This method does not take an <see cref="T:System.Exception"/> object to include in the
  15217. log event. To pass an <see cref="T:System.Exception"/> use one of the <see cref="M:Fatal(object)"/>
  15218. methods instead.
  15219. </para>
  15220. </remarks>
  15221. <seealso cref="M:Fatal(object,Exception)"/>
  15222. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  15223. </member>
  15224. <member name="P:log4net.ILog.IsDebugEnabled">
  15225. <summary>
  15226. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Debug"/> level.
  15227. </summary>
  15228. <value>
  15229. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Debug"/> events, <c>false</c> otherwise.
  15230. </value>
  15231. <remarks>
  15232. <para>
  15233. This function is intended to lessen the computational cost of
  15234. disabled log debug statements.
  15235. </para>
  15236. <para> For some ILog interface <c>log</c>, when you write:</para>
  15237. <code lang="C#">
  15238. log.Debug("This is entry number: " + i );
  15239. </code>
  15240. <para>
  15241. You incur the cost constructing the message, string construction and concatenation in
  15242. this case, regardless of whether the message is logged or not.
  15243. </para>
  15244. <para>
  15245. If you are worried about speed (who isn't), then you should write:
  15246. </para>
  15247. <code lang="C#">
  15248. if (log.IsDebugEnabled)
  15249. {
  15250. log.Debug("This is entry number: " + i );
  15251. }
  15252. </code>
  15253. <para>
  15254. This way you will not incur the cost of parameter
  15255. construction if debugging is disabled for <c>log</c>. On
  15256. the other hand, if the <c>log</c> is debug enabled, you
  15257. will incur the cost of evaluating whether the logger is debug
  15258. enabled twice. Once in <see cref="P:log4net.ILog.IsDebugEnabled"/> and once in
  15259. the <see cref="M:Debug(object)"/>. This is an insignificant overhead
  15260. since evaluating a logger takes about 1% of the time it
  15261. takes to actually log. This is the preferred style of logging.
  15262. </para>
  15263. <para>Alternatively if your logger is available statically then the is debug
  15264. enabled state can be stored in a static variable like this:
  15265. </para>
  15266. <code lang="C#">
  15267. private static readonly bool isDebugEnabled = log.IsDebugEnabled;
  15268. </code>
  15269. <para>
  15270. Then when you come to log you can write:
  15271. </para>
  15272. <code lang="C#">
  15273. if (isDebugEnabled)
  15274. {
  15275. log.Debug("This is entry number: " + i );
  15276. }
  15277. </code>
  15278. <para>
  15279. This way the debug enabled state is only queried once
  15280. when the class is loaded. Using a <c>private static readonly</c>
  15281. variable is the most efficient because it is a run time constant
  15282. and can be heavily optimized by the JIT compiler.
  15283. </para>
  15284. <para>
  15285. Of course if you use a static readonly variable to
  15286. hold the enabled state of the logger then you cannot
  15287. change the enabled state at runtime to vary the logging
  15288. that is produced. You have to decide if you need absolute
  15289. speed or runtime flexibility.
  15290. </para>
  15291. </remarks>
  15292. <seealso cref="M:Debug(object)"/>
  15293. <seealso cref="M:DebugFormat(IFormatProvider, string, object[])"/>
  15294. </member>
  15295. <member name="P:log4net.ILog.IsInfoEnabled">
  15296. <summary>
  15297. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Info"/> level.
  15298. </summary>
  15299. <value>
  15300. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Info"/> events, <c>false</c> otherwise.
  15301. </value>
  15302. <remarks>
  15303. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  15304. </remarks>
  15305. <seealso cref="M:Info(object)"/>
  15306. <seealso cref="M:InfoFormat(IFormatProvider, string, object[])"/>
  15307. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15308. </member>
  15309. <member name="P:log4net.ILog.IsWarnEnabled">
  15310. <summary>
  15311. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Warn"/> level.
  15312. </summary>
  15313. <value>
  15314. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Warn"/> events, <c>false</c> otherwise.
  15315. </value>
  15316. <remarks>
  15317. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  15318. </remarks>
  15319. <seealso cref="M:Warn(object)"/>
  15320. <seealso cref="M:WarnFormat(IFormatProvider, string, object[])"/>
  15321. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15322. </member>
  15323. <member name="P:log4net.ILog.IsErrorEnabled">
  15324. <summary>
  15325. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Error"/> level.
  15326. </summary>
  15327. <value>
  15328. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Error"/> events, <c>false</c> otherwise.
  15329. </value>
  15330. <remarks>
  15331. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  15332. </remarks>
  15333. <seealso cref="M:Error(object)"/>
  15334. <seealso cref="M:ErrorFormat(IFormatProvider, string, object[])"/>
  15335. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15336. </member>
  15337. <member name="P:log4net.ILog.IsFatalEnabled">
  15338. <summary>
  15339. Checks if this logger is enabled for the <see cref="F:log4net.Core.Level.Fatal"/> level.
  15340. </summary>
  15341. <value>
  15342. <c>true</c> if this logger is enabled for <see cref="F:log4net.Core.Level.Fatal"/> events, <c>false</c> otherwise.
  15343. </value>
  15344. <remarks>
  15345. For more information see <see cref="P:log4net.ILog.IsDebugEnabled"/>.
  15346. </remarks>
  15347. <seealso cref="M:Fatal(object)"/>
  15348. <seealso cref="M:FatalFormat(IFormatProvider, string, object[])"/>
  15349. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  15350. </member>
  15351. <member name="T:log4net.Layout.DynamicPatternLayout">
  15352. <summary>
  15353. A flexible layout configurable with pattern string that re-evaluates on each call.
  15354. </summary>
  15355. <remarks>
  15356. <para>This class is built on <see cref="T:log4net.Layout.PatternLayout"></see> and provides all the
  15357. features and capabilities of PatternLayout. PatternLayout is a 'static' class
  15358. in that its layout is done once at configuration time. This class will recreate
  15359. the layout on each reference.</para>
  15360. <para>One important difference between PatternLayout and DynamicPatternLayout is the
  15361. treatment of the Header and Footer parameters in the configuration. The Header and Footer
  15362. parameters for DynamicPatternLayout must be syntactically in the form of a PatternString,
  15363. but should not be marked as type log4net.Util.PatternString. Doing so causes the
  15364. pattern to be statically converted at configuration time and causes DynamicPatternLayout
  15365. to perform the same as PatternLayout.</para>
  15366. <para>Please see <see cref="T:log4net.Layout.PatternLayout"/> for complete documentation.</para>
  15367. <example>
  15368. &lt;layout type="log4net.Layout.DynamicPatternLayout"&gt;
  15369. &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;
  15370. &lt;param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /&gt;
  15371. &lt;/layout&gt;
  15372. </example>
  15373. </remarks>
  15374. </member>
  15375. <member name="F:log4net.Layout.DynamicPatternLayout.m_headerPatternString">
  15376. <summary>
  15377. The header PatternString
  15378. </summary>
  15379. </member>
  15380. <member name="F:log4net.Layout.DynamicPatternLayout.m_footerPatternString">
  15381. <summary>
  15382. The footer PatternString
  15383. </summary>
  15384. </member>
  15385. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor">
  15386. <summary>
  15387. Constructs a DynamicPatternLayout using the DefaultConversionPattern
  15388. </summary>
  15389. <remarks>
  15390. <para>
  15391. The default pattern just produces the application supplied message.
  15392. </para>
  15393. </remarks>
  15394. </member>
  15395. <member name="M:log4net.Layout.DynamicPatternLayout.#ctor(System.String)">
  15396. <summary>
  15397. Constructs a DynamicPatternLayout using the supplied conversion pattern
  15398. </summary>
  15399. <param name="pattern">the pattern to use</param>
  15400. <remarks>
  15401. </remarks>
  15402. </member>
  15403. <member name="P:log4net.Layout.DynamicPatternLayout.Header">
  15404. <summary>
  15405. The header for the layout format.
  15406. </summary>
  15407. <value>the layout header</value>
  15408. <remarks>
  15409. <para>
  15410. The Header text will be appended before any logging events
  15411. are formatted and appended.
  15412. </para>
  15413. The pattern will be formatted on each get operation.
  15414. </remarks>
  15415. </member>
  15416. <member name="P:log4net.Layout.DynamicPatternLayout.Footer">
  15417. <summary>
  15418. The footer for the layout format.
  15419. </summary>
  15420. <value>the layout footer</value>
  15421. <remarks>
  15422. <para>
  15423. The Footer text will be appended after all the logging events
  15424. have been formatted and appended.
  15425. </para>
  15426. The pattern will be formatted on each get operation.
  15427. </remarks>
  15428. </member>
  15429. <member name="T:log4net.Layout.ExceptionLayout">
  15430. <summary>
  15431. A Layout that renders only the Exception text from the logging event
  15432. </summary>
  15433. <remarks>
  15434. <para>
  15435. A Layout that renders only the Exception text from the logging event.
  15436. </para>
  15437. <para>
  15438. This Layout should only be used with appenders that utilize multiple
  15439. layouts (e.g. <see cref="T:log4net.Appender.AdoNetAppender"/>).
  15440. </para>
  15441. </remarks>
  15442. <author>Nicko Cadell</author>
  15443. <author>Gert Driesen</author>
  15444. </member>
  15445. <member name="M:log4net.Layout.ExceptionLayout.#ctor">
  15446. <summary>
  15447. Default constructor
  15448. </summary>
  15449. <remarks>
  15450. <para>
  15451. Constructs a ExceptionLayout
  15452. </para>
  15453. </remarks>
  15454. </member>
  15455. <member name="M:log4net.Layout.ExceptionLayout.ActivateOptions">
  15456. <summary>
  15457. Activate component options
  15458. </summary>
  15459. <remarks>
  15460. <para>
  15461. Part of the <see cref="T:log4net.Core.IOptionHandler"/> component activation
  15462. framework.
  15463. </para>
  15464. <para>
  15465. This method does nothing as options become effective immediately.
  15466. </para>
  15467. </remarks>
  15468. </member>
  15469. <member name="M:log4net.Layout.ExceptionLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  15470. <summary>
  15471. Gets the exception text from the logging event
  15472. </summary>
  15473. <param name="writer">The TextWriter to write the formatted event to</param>
  15474. <param name="loggingEvent">the event being logged</param>
  15475. <remarks>
  15476. <para>
  15477. Write the exception string to the <see cref="T:System.IO.TextWriter"/>.
  15478. The exception string is retrieved from <see cref="M:LoggingEvent.GetExceptionString()"/>.
  15479. </para>
  15480. </remarks>
  15481. </member>
  15482. <member name="T:log4net.Layout.ILayout">
  15483. <summary>
  15484. Interface implemented by layout objects
  15485. </summary>
  15486. <remarks>
  15487. <para>
  15488. An <see cref="T:log4net.Layout.ILayout"/> object is used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  15489. as text. The <see cref="M:Format(TextWriter,LoggingEvent)"/> method is called by an
  15490. appender to transform the <see cref="T:log4net.Core.LoggingEvent"/> into a string.
  15491. </para>
  15492. <para>
  15493. The layout can also supply <see cref="P:log4net.Layout.ILayout.Header"/> and <see cref="P:log4net.Layout.ILayout.Footer"/>
  15494. text that is appender before any events and after all the events respectively.
  15495. </para>
  15496. </remarks>
  15497. <author>Nicko Cadell</author>
  15498. <author>Gert Driesen</author>
  15499. </member>
  15500. <member name="M:log4net.Layout.ILayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  15501. <summary>
  15502. Implement this method to create your own layout format.
  15503. </summary>
  15504. <param name="writer">The TextWriter to write the formatted event to</param>
  15505. <param name="loggingEvent">The event to format</param>
  15506. <remarks>
  15507. <para>
  15508. This method is called by an appender to format
  15509. the <paramref name="loggingEvent"/> as text and output to a writer.
  15510. </para>
  15511. <para>
  15512. If the caller does not have a <see cref="T:System.IO.TextWriter"/> and prefers the
  15513. event to be formatted as a <see cref="T:System.String"/> then the following
  15514. code can be used to format the event into a <see cref="T:System.IO.StringWriter"/>.
  15515. </para>
  15516. <code lang="C#">
  15517. StringWriter writer = new StringWriter();
  15518. Layout.Format(writer, loggingEvent);
  15519. string formattedEvent = writer.ToString();
  15520. </code>
  15521. </remarks>
  15522. </member>
  15523. <member name="P:log4net.Layout.ILayout.ContentType">
  15524. <summary>
  15525. The content type output by this layout.
  15526. </summary>
  15527. <value>The content type</value>
  15528. <remarks>
  15529. <para>
  15530. The content type output by this layout.
  15531. </para>
  15532. <para>
  15533. This is a MIME type e.g. <c>"text/plain"</c>.
  15534. </para>
  15535. </remarks>
  15536. </member>
  15537. <member name="P:log4net.Layout.ILayout.Header">
  15538. <summary>
  15539. The header for the layout format.
  15540. </summary>
  15541. <value>the layout header</value>
  15542. <remarks>
  15543. <para>
  15544. The Header text will be appended before any logging events
  15545. are formatted and appended.
  15546. </para>
  15547. </remarks>
  15548. </member>
  15549. <member name="P:log4net.Layout.ILayout.Footer">
  15550. <summary>
  15551. The footer for the layout format.
  15552. </summary>
  15553. <value>the layout footer</value>
  15554. <remarks>
  15555. <para>
  15556. The Footer text will be appended after all the logging events
  15557. have been formatted and appended.
  15558. </para>
  15559. </remarks>
  15560. </member>
  15561. <member name="P:log4net.Layout.ILayout.IgnoresException">
  15562. <summary>
  15563. Flag indicating if this layout handle exceptions
  15564. </summary>
  15565. <value><c>false</c> if this layout handles exceptions</value>
  15566. <remarks>
  15567. <para>
  15568. If this layout handles the exception object contained within
  15569. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  15570. <c>false</c>. Otherwise, if the layout ignores the exception
  15571. object, then the layout should return <c>true</c>.
  15572. </para>
  15573. </remarks>
  15574. </member>
  15575. <member name="T:log4net.Layout.IRawLayout">
  15576. <summary>
  15577. Interface for raw layout objects
  15578. </summary>
  15579. <remarks>
  15580. <para>
  15581. Interface used to format a <see cref="T:log4net.Core.LoggingEvent"/>
  15582. to an object.
  15583. </para>
  15584. <para>
  15585. This interface should not be confused with the
  15586. <see cref="T:log4net.Layout.ILayout"/> interface. This interface is used in
  15587. only certain specialized situations where a raw object is
  15588. required rather than a formatted string. The <see cref="T:log4net.Layout.ILayout"/>
  15589. is not generally useful than this interface.
  15590. </para>
  15591. </remarks>
  15592. <author>Nicko Cadell</author>
  15593. <author>Gert Driesen</author>
  15594. </member>
  15595. <member name="M:log4net.Layout.IRawLayout.Format(log4net.Core.LoggingEvent)">
  15596. <summary>
  15597. Implement this method to create your own layout format.
  15598. </summary>
  15599. <param name="loggingEvent">The event to format</param>
  15600. <returns>returns the formatted event</returns>
  15601. <remarks>
  15602. <para>
  15603. Implement this method to create your own layout format.
  15604. </para>
  15605. </remarks>
  15606. </member>
  15607. <member name="T:log4net.Layout.Layout2RawLayoutAdapter">
  15608. <summary>
  15609. Adapts any <see cref="T:log4net.Layout.ILayout"/> to a <see cref="T:log4net.Layout.IRawLayout"/>
  15610. </summary>
  15611. <remarks>
  15612. <para>
  15613. Where an <see cref="T:log4net.Layout.IRawLayout"/> is required this adapter
  15614. allows a <see cref="T:log4net.Layout.ILayout"/> to be specified.
  15615. </para>
  15616. </remarks>
  15617. <author>Nicko Cadell</author>
  15618. <author>Gert Driesen</author>
  15619. </member>
  15620. <member name="F:log4net.Layout.Layout2RawLayoutAdapter.m_layout">
  15621. <summary>
  15622. The layout to adapt
  15623. </summary>
  15624. </member>
  15625. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.#ctor(log4net.Layout.ILayout)">
  15626. <summary>
  15627. Construct a new adapter
  15628. </summary>
  15629. <param name="layout">the layout to adapt</param>
  15630. <remarks>
  15631. <para>
  15632. Create the adapter for the specified <paramref name="layout"/>.
  15633. </para>
  15634. </remarks>
  15635. </member>
  15636. <member name="M:log4net.Layout.Layout2RawLayoutAdapter.Format(log4net.Core.LoggingEvent)">
  15637. <summary>
  15638. Format the logging event as an object.
  15639. </summary>
  15640. <param name="loggingEvent">The event to format</param>
  15641. <returns>returns the formatted event</returns>
  15642. <remarks>
  15643. <para>
  15644. Format the logging event as an object.
  15645. </para>
  15646. <para>
  15647. Uses the <see cref="T:log4net.Layout.ILayout"/> object supplied to
  15648. the constructor to perform the formatting.
  15649. </para>
  15650. </remarks>
  15651. </member>
  15652. <member name="T:log4net.Layout.LayoutSkeleton">
  15653. <summary>
  15654. Extend this abstract class to create your own log layout format.
  15655. </summary>
  15656. <remarks>
  15657. <para>
  15658. This is the base implementation of the <see cref="T:log4net.Layout.ILayout"/>
  15659. interface. Most layout objects should extend this class.
  15660. </para>
  15661. </remarks>
  15662. <remarks>
  15663. <note type="inheritinfo">
  15664. <para>
  15665. Subclasses must implement the <see cref="M:Format(TextWriter,LoggingEvent)"/>
  15666. method.
  15667. </para>
  15668. <para>
  15669. Subclasses should set the <see cref="P:log4net.Layout.LayoutSkeleton.IgnoresException"/> in their default
  15670. constructor.
  15671. </para>
  15672. </note>
  15673. </remarks>
  15674. <author>Nicko Cadell</author>
  15675. <author>Gert Driesen</author>
  15676. </member>
  15677. <member name="F:log4net.Layout.LayoutSkeleton.m_header">
  15678. <summary>
  15679. The header text
  15680. </summary>
  15681. <remarks>
  15682. <para>
  15683. See <see cref="P:log4net.Layout.LayoutSkeleton.Header"/> for more information.
  15684. </para>
  15685. </remarks>
  15686. </member>
  15687. <member name="F:log4net.Layout.LayoutSkeleton.m_footer">
  15688. <summary>
  15689. The footer text
  15690. </summary>
  15691. <remarks>
  15692. <para>
  15693. See <see cref="P:log4net.Layout.LayoutSkeleton.Footer"/> for more information.
  15694. </para>
  15695. </remarks>
  15696. </member>
  15697. <member name="F:log4net.Layout.LayoutSkeleton.m_ignoresException">
  15698. <summary>
  15699. Flag indicating if this layout handles exceptions
  15700. </summary>
  15701. <remarks>
  15702. <para>
  15703. <c>false</c> if this layout handles exceptions
  15704. </para>
  15705. </remarks>
  15706. </member>
  15707. <member name="M:log4net.Layout.LayoutSkeleton.#ctor">
  15708. <summary>
  15709. Empty default constructor
  15710. </summary>
  15711. <remarks>
  15712. <para>
  15713. Empty default constructor
  15714. </para>
  15715. </remarks>
  15716. </member>
  15717. <member name="M:log4net.Layout.LayoutSkeleton.ActivateOptions">
  15718. <summary>
  15719. Activate component options
  15720. </summary>
  15721. <remarks>
  15722. <para>
  15723. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  15724. activation scheme. The <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> method must
  15725. be called on this object after the configuration properties have
  15726. been set. Until <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> is called this
  15727. object is in an undefined state and must not be used.
  15728. </para>
  15729. <para>
  15730. If any of the configuration properties are modified then
  15731. <see cref="M:log4net.Layout.LayoutSkeleton.ActivateOptions"/> must be called again.
  15732. </para>
  15733. <para>
  15734. This method must be implemented by the subclass.
  15735. </para>
  15736. </remarks>
  15737. </member>
  15738. <member name="M:log4net.Layout.LayoutSkeleton.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  15739. <summary>
  15740. Implement this method to create your own layout format.
  15741. </summary>
  15742. <param name="writer">The TextWriter to write the formatted event to</param>
  15743. <param name="loggingEvent">The event to format</param>
  15744. <remarks>
  15745. <para>
  15746. This method is called by an appender to format
  15747. the <paramref name="loggingEvent"/> as text.
  15748. </para>
  15749. </remarks>
  15750. </member>
  15751. <member name="M:log4net.Layout.LayoutSkeleton.Format(log4net.Core.LoggingEvent)">
  15752. <summary>
  15753. Convenience method for easily formatting the logging event into a string variable.
  15754. </summary>
  15755. <param name="loggingEvent"></param>
  15756. <remarks>
  15757. Creates a new StringWriter instance to store the formatted logging event.
  15758. </remarks>
  15759. </member>
  15760. <member name="P:log4net.Layout.LayoutSkeleton.ContentType">
  15761. <summary>
  15762. The content type output by this layout.
  15763. </summary>
  15764. <value>The content type is <c>"text/plain"</c></value>
  15765. <remarks>
  15766. <para>
  15767. The content type output by this layout.
  15768. </para>
  15769. <para>
  15770. This base class uses the value <c>"text/plain"</c>.
  15771. To change this value a subclass must override this
  15772. property.
  15773. </para>
  15774. </remarks>
  15775. </member>
  15776. <member name="P:log4net.Layout.LayoutSkeleton.Header">
  15777. <summary>
  15778. The header for the layout format.
  15779. </summary>
  15780. <value>the layout header</value>
  15781. <remarks>
  15782. <para>
  15783. The Header text will be appended before any logging events
  15784. are formatted and appended.
  15785. </para>
  15786. </remarks>
  15787. </member>
  15788. <member name="P:log4net.Layout.LayoutSkeleton.Footer">
  15789. <summary>
  15790. The footer for the layout format.
  15791. </summary>
  15792. <value>the layout footer</value>
  15793. <remarks>
  15794. <para>
  15795. The Footer text will be appended after all the logging events
  15796. have been formatted and appended.
  15797. </para>
  15798. </remarks>
  15799. </member>
  15800. <member name="P:log4net.Layout.LayoutSkeleton.IgnoresException">
  15801. <summary>
  15802. Flag indicating if this layout handles exceptions
  15803. </summary>
  15804. <value><c>false</c> if this layout handles exceptions</value>
  15805. <remarks>
  15806. <para>
  15807. If this layout handles the exception object contained within
  15808. <see cref="T:log4net.Core.LoggingEvent"/>, then the layout should return
  15809. <c>false</c>. Otherwise, if the layout ignores the exception
  15810. object, then the layout should return <c>true</c>.
  15811. </para>
  15812. <para>
  15813. Set this value to override a this default setting. The default
  15814. value is <c>true</c>, this layout does not handle the exception.
  15815. </para>
  15816. </remarks>
  15817. </member>
  15818. <member name="T:log4net.Layout.PatternLayout">
  15819. <summary>
  15820. A flexible layout configurable with pattern string.
  15821. </summary>
  15822. <remarks>
  15823. <para>
  15824. The goal of this class is to <see cref="M:PatternLayout.Format(TextWriter,LoggingEvent)"/> a
  15825. <see cref="T:log4net.Core.LoggingEvent"/> as a string. The results
  15826. depend on the <i>conversion pattern</i>.
  15827. </para>
  15828. <para>
  15829. The conversion pattern is closely related to the conversion
  15830. pattern of the printf function in C. A conversion pattern is
  15831. composed of literal text and format control expressions called
  15832. <i>conversion specifiers</i>.
  15833. </para>
  15834. <para>
  15835. <i>You are free to insert any literal text within the conversion
  15836. pattern.</i>
  15837. </para>
  15838. <para>
  15839. Each conversion specifier starts with a percent sign (%) and is
  15840. followed by optional <i>format modifiers</i> and a <i>conversion
  15841. pattern name</i>. The conversion pattern name specifies the type of
  15842. data, e.g. logger, level, date, thread name. The format
  15843. modifiers control such things as field width, padding, left and
  15844. right justification. The following is a simple example.
  15845. </para>
  15846. <para>
  15847. Let the conversion pattern be <b>"%-5level [%thread]: %message%newline"</b> and assume
  15848. that the log4net environment was set to use a PatternLayout. Then the
  15849. statements
  15850. </para>
  15851. <code lang="C#">
  15852. ILog log = LogManager.GetLogger(typeof(TestApp));
  15853. log.Debug("Message 1");
  15854. log.Warn("Message 2");
  15855. </code>
  15856. <para>would yield the output</para>
  15857. <code>
  15858. DEBUG [main]: Message 1
  15859. WARN [main]: Message 2
  15860. </code>
  15861. <para>
  15862. Note that there is no explicit separator between text and
  15863. conversion specifiers. The pattern parser knows when it has reached
  15864. the end of a conversion specifier when it reads a conversion
  15865. character. In the example above the conversion specifier
  15866. <b>%-5level</b> means the level of the logging event should be left
  15867. justified to a width of five characters.
  15868. </para>
  15869. <para>
  15870. The recognized conversion pattern names are:
  15871. </para>
  15872. <list type="table">
  15873. <listheader>
  15874. <term>Conversion Pattern Name</term>
  15875. <description>Effect</description>
  15876. </listheader>
  15877. <item>
  15878. <term>a</term>
  15879. <description>Equivalent to <b>appdomain</b></description>
  15880. </item>
  15881. <item>
  15882. <term>appdomain</term>
  15883. <description>
  15884. Used to output the friendly name of the AppDomain where the
  15885. logging event was generated.
  15886. </description>
  15887. </item>
  15888. <item>
  15889. <term>aspnet-cache</term>
  15890. <description>
  15891. <para>
  15892. 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>
  15893. </para>
  15894. <para>
  15895. This pattern is not available for Compact Framework or Client Profile assemblies.
  15896. </para>
  15897. </description>
  15898. </item>
  15899. <item>
  15900. <term>aspnet-context</term>
  15901. <description>
  15902. <para>
  15903. 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>
  15904. </para>
  15905. <para>
  15906. This pattern is not available for Compact Framework or Client Profile assemblies.
  15907. </para>
  15908. </description>
  15909. </item>
  15910. <item>
  15911. <term>aspnet-request</term>
  15912. <description>
  15913. <para>
  15914. 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>
  15915. </para>
  15916. <para>
  15917. This pattern is not available for Compact Framework or Client Profile assemblies.
  15918. </para>
  15919. </description>
  15920. </item>
  15921. <item>
  15922. <term>aspnet-session</term>
  15923. <description>
  15924. <para>
  15925. 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>
  15926. </para>
  15927. <para>
  15928. This pattern is not available for Compact Framework or Client Profile assemblies.
  15929. </para>
  15930. </description>
  15931. </item>
  15932. <item>
  15933. <term>c</term>
  15934. <description>Equivalent to <b>logger</b></description>
  15935. </item>
  15936. <item>
  15937. <term>C</term>
  15938. <description>Equivalent to <b>type</b></description>
  15939. </item>
  15940. <item>
  15941. <term>class</term>
  15942. <description>Equivalent to <b>type</b></description>
  15943. </item>
  15944. <item>
  15945. <term>d</term>
  15946. <description>Equivalent to <b>date</b></description>
  15947. </item>
  15948. <item>
  15949. <term>date</term>
  15950. <description>
  15951. <para>
  15952. Used to output the date of the logging event in the local time zone.
  15953. To output the date in universal time use the <c>%utcdate</c> pattern.
  15954. The date conversion
  15955. specifier may be followed by a <i>date format specifier</i> enclosed
  15956. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  15957. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  15958. given then ISO8601 format is
  15959. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  15960. </para>
  15961. <para>
  15962. The date format specifier admits the same syntax as the
  15963. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  15964. </para>
  15965. <para>
  15966. For better results it is recommended to use the log4net date
  15967. formatters. These can be specified using one of the strings
  15968. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  15969. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  15970. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  15971. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  15972. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  15973. </para>
  15974. <para>
  15975. These dedicated date formatters perform significantly
  15976. better than <see cref="M:DateTime.ToString(string)"/>.
  15977. </para>
  15978. </description>
  15979. </item>
  15980. <item>
  15981. <term>exception</term>
  15982. <description>
  15983. <para>
  15984. Used to output the exception passed in with the log message.
  15985. </para>
  15986. <para>
  15987. If an exception object is stored in the logging event
  15988. it will be rendered into the pattern output with a
  15989. trailing newline.
  15990. If there is no exception then nothing will be output
  15991. and no trailing newline will be appended.
  15992. It is typical to put a newline before the exception
  15993. and to have the exception as the last data in the pattern.
  15994. </para>
  15995. </description>
  15996. </item>
  15997. <item>
  15998. <term>F</term>
  15999. <description>Equivalent to <b>file</b></description>
  16000. </item>
  16001. <item>
  16002. <term>file</term>
  16003. <description>
  16004. <para>
  16005. Used to output the file name where the logging request was
  16006. issued.
  16007. </para>
  16008. <para>
  16009. <b>WARNING</b> Generating caller location information is
  16010. extremely slow. Its use should be avoided unless execution speed
  16011. is not an issue.
  16012. </para>
  16013. <para>
  16014. See the note below on the availability of caller location information.
  16015. </para>
  16016. </description>
  16017. </item>
  16018. <item>
  16019. <term>identity</term>
  16020. <description>
  16021. <para>
  16022. Used to output the user name for the currently active user
  16023. (Principal.Identity.Name).
  16024. </para>
  16025. <para>
  16026. <b>WARNING</b> Generating caller information is
  16027. extremely slow. Its use should be avoided unless execution speed
  16028. is not an issue.
  16029. </para>
  16030. </description>
  16031. </item>
  16032. <item>
  16033. <term>l</term>
  16034. <description>Equivalent to <b>location</b></description>
  16035. </item>
  16036. <item>
  16037. <term>L</term>
  16038. <description>Equivalent to <b>line</b></description>
  16039. </item>
  16040. <item>
  16041. <term>location</term>
  16042. <description>
  16043. <para>
  16044. Used to output location information of the caller which generated
  16045. the logging event.
  16046. </para>
  16047. <para>
  16048. The location information depends on the CLI implementation but
  16049. usually consists of the fully qualified name of the calling
  16050. method followed by the callers source the file name and line
  16051. number between parentheses.
  16052. </para>
  16053. <para>
  16054. The location information can be very useful. However, its
  16055. generation is <b>extremely</b> slow. Its use should be avoided
  16056. unless execution speed is not an issue.
  16057. </para>
  16058. <para>
  16059. See the note below on the availability of caller location information.
  16060. </para>
  16061. </description>
  16062. </item>
  16063. <item>
  16064. <term>level</term>
  16065. <description>
  16066. <para>
  16067. Used to output the level of the logging event.
  16068. </para>
  16069. </description>
  16070. </item>
  16071. <item>
  16072. <term>line</term>
  16073. <description>
  16074. <para>
  16075. Used to output the line number from where the logging request
  16076. was issued.
  16077. </para>
  16078. <para>
  16079. <b>WARNING</b> Generating caller location information is
  16080. extremely slow. Its use should be avoided unless execution speed
  16081. is not an issue.
  16082. </para>
  16083. <para>
  16084. See the note below on the availability of caller location information.
  16085. </para>
  16086. </description>
  16087. </item>
  16088. <item>
  16089. <term>logger</term>
  16090. <description>
  16091. <para>
  16092. Used to output the logger of the logging event. The
  16093. logger conversion specifier can be optionally followed by
  16094. <i>precision specifier</i>, that is a decimal constant in
  16095. brackets.
  16096. </para>
  16097. <para>
  16098. If a precision specifier is given, then only the corresponding
  16099. number of right most components of the logger name will be
  16100. printed. By default the logger name is printed in full.
  16101. </para>
  16102. <para>
  16103. For example, for the logger name "a.b.c" the pattern
  16104. <b>%logger{2}</b> will output "b.c".
  16105. </para>
  16106. </description>
  16107. </item>
  16108. <item>
  16109. <term>m</term>
  16110. <description>Equivalent to <b>message</b></description>
  16111. </item>
  16112. <item>
  16113. <term>M</term>
  16114. <description>Equivalent to <b>method</b></description>
  16115. </item>
  16116. <item>
  16117. <term>message</term>
  16118. <description>
  16119. <para>
  16120. Used to output the application supplied message associated with
  16121. the logging event.
  16122. </para>
  16123. </description>
  16124. </item>
  16125. <item>
  16126. <term>mdc</term>
  16127. <description>
  16128. <para>
  16129. The MDC (old name for the ThreadContext.Properties) is now part of the
  16130. combined event properties. This pattern is supported for compatibility
  16131. but is equivalent to <b>property</b>.
  16132. </para>
  16133. </description>
  16134. </item>
  16135. <item>
  16136. <term>method</term>
  16137. <description>
  16138. <para>
  16139. Used to output the method name where the logging request was
  16140. issued.
  16141. </para>
  16142. <para>
  16143. <b>WARNING</b> Generating caller location information is
  16144. extremely slow. Its use should be avoided unless execution speed
  16145. is not an issue.
  16146. </para>
  16147. <para>
  16148. See the note below on the availability of caller location information.
  16149. </para>
  16150. </description>
  16151. </item>
  16152. <item>
  16153. <term>n</term>
  16154. <description>Equivalent to <b>newline</b></description>
  16155. </item>
  16156. <item>
  16157. <term>newline</term>
  16158. <description>
  16159. <para>
  16160. Outputs the platform dependent line separator character or
  16161. characters.
  16162. </para>
  16163. <para>
  16164. This conversion pattern offers the same performance as using
  16165. non-portable line separator strings such as "\n", or "\r\n".
  16166. Thus, it is the preferred way of specifying a line separator.
  16167. </para>
  16168. </description>
  16169. </item>
  16170. <item>
  16171. <term>ndc</term>
  16172. <description>
  16173. <para>
  16174. Used to output the NDC (nested diagnostic context) associated
  16175. with the thread that generated the logging event.
  16176. </para>
  16177. </description>
  16178. </item>
  16179. <item>
  16180. <term>p</term>
  16181. <description>Equivalent to <b>level</b></description>
  16182. </item>
  16183. <item>
  16184. <term>P</term>
  16185. <description>Equivalent to <b>property</b></description>
  16186. </item>
  16187. <item>
  16188. <term>properties</term>
  16189. <description>Equivalent to <b>property</b></description>
  16190. </item>
  16191. <item>
  16192. <term>property</term>
  16193. <description>
  16194. <para>
  16195. Used to output the an event specific property. The key to
  16196. lookup must be specified within braces and directly following the
  16197. pattern specifier, e.g. <b>%property{user}</b> would include the value
  16198. from the property that is keyed by the string 'user'. Each property value
  16199. that is to be included in the log must be specified separately.
  16200. Properties are added to events by loggers or appenders. By default
  16201. the <c>log4net:HostName</c> property is set to the name of machine on
  16202. which the event was originally logged.
  16203. </para>
  16204. <para>
  16205. If no key is specified, e.g. <b>%property</b> then all the keys and their
  16206. values are printed in a comma separated list.
  16207. </para>
  16208. <para>
  16209. The properties of an event are combined from a number of different
  16210. contexts. These are listed below in the order in which they are searched.
  16211. </para>
  16212. <list type="definition">
  16213. <item>
  16214. <term>the event properties</term>
  16215. <description>
  16216. The event has <see cref="P:log4net.Core.LoggingEvent.Properties"/> that can be set. These
  16217. properties are specific to this event only.
  16218. </description>
  16219. </item>
  16220. <item>
  16221. <term>the thread properties</term>
  16222. <description>
  16223. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  16224. thread. These properties are shared by all events logged on this thread.
  16225. </description>
  16226. </item>
  16227. <item>
  16228. <term>the global properties</term>
  16229. <description>
  16230. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  16231. properties are shared by all the threads in the AppDomain.
  16232. </description>
  16233. </item>
  16234. </list>
  16235. </description>
  16236. </item>
  16237. <item>
  16238. <term>r</term>
  16239. <description>Equivalent to <b>timestamp</b></description>
  16240. </item>
  16241. <item>
  16242. <term>stacktrace</term>
  16243. <description>
  16244. <para>
  16245. Used to output the stack trace of the logging event
  16246. The stack trace level specifier may be enclosed
  16247. between braces. For example, <b>%stacktrace{level}</b>.
  16248. If no stack trace level specifier is given then 1 is assumed
  16249. </para>
  16250. <para>
  16251. Output uses the format:
  16252. type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1
  16253. </para>
  16254. <para>
  16255. This pattern is not available for Compact Framework assemblies.
  16256. </para>
  16257. </description>
  16258. </item>
  16259. <item>
  16260. <term>stacktracedetail</term>
  16261. <description>
  16262. <para>
  16263. Used to output the stack trace of the logging event
  16264. The stack trace level specifier may be enclosed
  16265. between braces. For example, <b>%stacktracedetail{level}</b>.
  16266. If no stack trace level specifier is given then 1 is assumed
  16267. </para>
  16268. <para>
  16269. Output uses the format:
  16270. type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...)
  16271. </para>
  16272. <para>
  16273. This pattern is not available for Compact Framework assemblies.
  16274. </para>
  16275. </description>
  16276. </item>
  16277. <item>
  16278. <term>t</term>
  16279. <description>Equivalent to <b>thread</b></description>
  16280. </item>
  16281. <item>
  16282. <term>timestamp</term>
  16283. <description>
  16284. <para>
  16285. Used to output the number of milliseconds elapsed since the start
  16286. of the application until the creation of the logging event.
  16287. </para>
  16288. </description>
  16289. </item>
  16290. <item>
  16291. <term>thread</term>
  16292. <description>
  16293. <para>
  16294. Used to output the name of the thread that generated the
  16295. logging event. Uses the thread number if no name is available.
  16296. </para>
  16297. </description>
  16298. </item>
  16299. <item>
  16300. <term>type</term>
  16301. <description>
  16302. <para>
  16303. Used to output the fully qualified type name of the caller
  16304. issuing the logging request. This conversion specifier
  16305. can be optionally followed by <i>precision specifier</i>, that
  16306. is a decimal constant in brackets.
  16307. </para>
  16308. <para>
  16309. If a precision specifier is given, then only the corresponding
  16310. number of right most components of the class name will be
  16311. printed. By default the class name is output in fully qualified form.
  16312. </para>
  16313. <para>
  16314. For example, for the class name "log4net.Layout.PatternLayout", the
  16315. pattern <b>%type{1}</b> will output "PatternLayout".
  16316. </para>
  16317. <para>
  16318. <b>WARNING</b> Generating the caller class information is
  16319. slow. Thus, its use should be avoided unless execution speed is
  16320. not an issue.
  16321. </para>
  16322. <para>
  16323. See the note below on the availability of caller location information.
  16324. </para>
  16325. </description>
  16326. </item>
  16327. <item>
  16328. <term>u</term>
  16329. <description>Equivalent to <b>identity</b></description>
  16330. </item>
  16331. <item>
  16332. <term>username</term>
  16333. <description>
  16334. <para>
  16335. Used to output the WindowsIdentity for the currently
  16336. active user.
  16337. </para>
  16338. <para>
  16339. <b>WARNING</b> Generating caller WindowsIdentity information is
  16340. extremely slow. Its use should be avoided unless execution speed
  16341. is not an issue.
  16342. </para>
  16343. </description>
  16344. </item>
  16345. <item>
  16346. <term>utcdate</term>
  16347. <description>
  16348. <para>
  16349. Used to output the date of the logging event in universal time.
  16350. The date conversion
  16351. specifier may be followed by a <i>date format specifier</i> enclosed
  16352. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  16353. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  16354. given then ISO8601 format is
  16355. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  16356. </para>
  16357. <para>
  16358. The date format specifier admits the same syntax as the
  16359. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  16360. </para>
  16361. <para>
  16362. For better results it is recommended to use the log4net date
  16363. formatters. These can be specified using one of the strings
  16364. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  16365. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  16366. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  16367. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  16368. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  16369. </para>
  16370. <para>
  16371. These dedicated date formatters perform significantly
  16372. better than <see cref="M:DateTime.ToString(string)"/>.
  16373. </para>
  16374. </description>
  16375. </item>
  16376. <item>
  16377. <term>w</term>
  16378. <description>Equivalent to <b>username</b></description>
  16379. </item>
  16380. <item>
  16381. <term>x</term>
  16382. <description>Equivalent to <b>ndc</b></description>
  16383. </item>
  16384. <item>
  16385. <term>X</term>
  16386. <description>Equivalent to <b>mdc</b></description>
  16387. </item>
  16388. <item>
  16389. <term>%</term>
  16390. <description>
  16391. <para>
  16392. The sequence %% outputs a single percent sign.
  16393. </para>
  16394. </description>
  16395. </item>
  16396. </list>
  16397. <para>
  16398. The single letter patterns are deprecated in favor of the
  16399. longer more descriptive pattern names.
  16400. </para>
  16401. <para>
  16402. By default the relevant information is output as is. However,
  16403. with the aid of format modifiers it is possible to change the
  16404. minimum field width, the maximum field width and justification.
  16405. </para>
  16406. <para>
  16407. The optional format modifier is placed between the percent sign
  16408. and the conversion pattern name.
  16409. </para>
  16410. <para>
  16411. The first optional format modifier is the <i>left justification
  16412. flag</i> which is just the minus (-) character. Then comes the
  16413. optional <i>minimum field width</i> modifier. This is a decimal
  16414. constant that represents the minimum number of characters to
  16415. output. If the data item requires fewer characters, it is padded on
  16416. either the left or the right until the minimum width is
  16417. reached. The default is to pad on the left (right justify) but you
  16418. can specify right padding with the left justification flag. The
  16419. padding character is space. If the data item is larger than the
  16420. minimum field width, the field is expanded to accommodate the
  16421. data. The value is never truncated.
  16422. </para>
  16423. <para>
  16424. This behavior can be changed using the <i>maximum field
  16425. width</i> modifier which is designated by a period followed by a
  16426. decimal constant. If the data item is longer than the maximum
  16427. field, then the extra characters are removed from the
  16428. <i>beginning</i> of the data item and not from the end. For
  16429. example, it the maximum field width is eight and the data item is
  16430. ten characters long, then the first two characters of the data item
  16431. are dropped. This behavior deviates from the printf function in C
  16432. where truncation is done from the end.
  16433. </para>
  16434. <para>
  16435. Below are various format modifier examples for the logger
  16436. conversion specifier.
  16437. </para>
  16438. <div class="tablediv">
  16439. <table class="dtTABLE" cellspacing="0">
  16440. <tr>
  16441. <th>Format modifier</th>
  16442. <th>left justify</th>
  16443. <th>minimum width</th>
  16444. <th>maximum width</th>
  16445. <th>comment</th>
  16446. </tr>
  16447. <tr>
  16448. <td align="center">%20logger</td>
  16449. <td align="center">false</td>
  16450. <td align="center">20</td>
  16451. <td align="center">none</td>
  16452. <td>
  16453. <para>
  16454. Left pad with spaces if the logger name is less than 20
  16455. characters long.
  16456. </para>
  16457. </td>
  16458. </tr>
  16459. <tr>
  16460. <td align="center">%-20logger</td>
  16461. <td align="center">true</td>
  16462. <td align="center">20</td>
  16463. <td align="center">none</td>
  16464. <td>
  16465. <para>
  16466. Right pad with spaces if the logger
  16467. name is less than 20 characters long.
  16468. </para>
  16469. </td>
  16470. </tr>
  16471. <tr>
  16472. <td align="center">%.30logger</td>
  16473. <td align="center">NA</td>
  16474. <td align="center">none</td>
  16475. <td align="center">30</td>
  16476. <td>
  16477. <para>
  16478. Truncate from the beginning if the logger
  16479. name is longer than 30 characters.
  16480. </para>
  16481. </td>
  16482. </tr>
  16483. <tr>
  16484. <td align="center"><nobr>%20.30logger</nobr></td>
  16485. <td align="center">false</td>
  16486. <td align="center">20</td>
  16487. <td align="center">30</td>
  16488. <td>
  16489. <para>
  16490. Left pad with spaces if the logger name is shorter than 20
  16491. characters. However, if logger name is longer than 30 characters,
  16492. then truncate from the beginning.
  16493. </para>
  16494. </td>
  16495. </tr>
  16496. <tr>
  16497. <td align="center">%-20.30logger</td>
  16498. <td align="center">true</td>
  16499. <td align="center">20</td>
  16500. <td align="center">30</td>
  16501. <td>
  16502. <para>
  16503. Right pad with spaces if the logger name is shorter than 20
  16504. characters. However, if logger name is longer than 30 characters,
  16505. then truncate from the beginning.
  16506. </para>
  16507. </td>
  16508. </tr>
  16509. </table>
  16510. </div>
  16511. <para>
  16512. <b>Note about caller location information.</b><br />
  16513. The following patterns <c>%type %file %line %method %location %class %C %F %L %l %M</c>
  16514. all generate caller location information.
  16515. Location information uses the <c>System.Diagnostics.StackTrace</c> class to generate
  16516. a call stack. The caller's information is then extracted from this stack.
  16517. </para>
  16518. <note type="caution">
  16519. <para>
  16520. The <c>System.Diagnostics.StackTrace</c> class is not supported on the
  16521. .NET Compact Framework 1.0 therefore caller location information is not
  16522. available on that framework.
  16523. </para>
  16524. </note>
  16525. <note type="caution">
  16526. <para>
  16527. The <c>System.Diagnostics.StackTrace</c> class has this to say about Release builds:
  16528. </para>
  16529. <para>
  16530. "StackTrace information will be most informative with Debug build configurations.
  16531. By default, Debug builds include debug symbols, while Release builds do not. The
  16532. debug symbols contain most of the file, method name, line number, and column
  16533. information used in constructing StackFrame and StackTrace objects. StackTrace
  16534. might not report as many method calls as expected, due to code transformations
  16535. that occur during optimization."
  16536. </para>
  16537. <para>
  16538. This means that in a Release build the caller information may be incomplete or may
  16539. not exist at all! Therefore caller location information cannot be relied upon in a Release build.
  16540. </para>
  16541. </note>
  16542. <para>
  16543. Additional pattern converters may be registered with a specific <see cref="T:log4net.Layout.PatternLayout"/>
  16544. instance using the <see cref="M:AddConverter(string, Type)"/> method.
  16545. </para>
  16546. </remarks>
  16547. <example>
  16548. This is a more detailed pattern.
  16549. <code><b>%timestamp [%thread] %level %logger %ndc - %message%newline</b></code>
  16550. </example>
  16551. <example>
  16552. A similar pattern except that the relative time is
  16553. right padded if less than 6 digits, thread name is right padded if
  16554. less than 15 characters and truncated if longer and the logger
  16555. name is left padded if shorter than 30 characters and truncated if
  16556. longer.
  16557. <code><b>%-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline</b></code>
  16558. </example>
  16559. <author>Nicko Cadell</author>
  16560. <author>Gert Driesen</author>
  16561. <author>Douglas de la Torre</author>
  16562. <author>Daniel Cazzulino</author>
  16563. </member>
  16564. <member name="F:log4net.Layout.PatternLayout.DefaultConversionPattern">
  16565. <summary>
  16566. Default pattern string for log output.
  16567. </summary>
  16568. <remarks>
  16569. <para>
  16570. Default pattern string for log output.
  16571. Currently set to the string <b>"%message%newline"</b>
  16572. which just prints the application supplied message.
  16573. </para>
  16574. </remarks>
  16575. </member>
  16576. <member name="F:log4net.Layout.PatternLayout.DetailConversionPattern">
  16577. <summary>
  16578. A detailed conversion pattern
  16579. </summary>
  16580. <remarks>
  16581. <para>
  16582. A conversion pattern which includes Time, Thread, Logger, and Nested Context.
  16583. Current value is <b>%timestamp [%thread] %level %logger %ndc - %message%newline</b>.
  16584. </para>
  16585. </remarks>
  16586. </member>
  16587. <member name="F:log4net.Layout.PatternLayout.s_globalRulesRegistry">
  16588. <summary>
  16589. Internal map of converter identifiers to converter types.
  16590. </summary>
  16591. <remarks>
  16592. <para>
  16593. This static map is overridden by the m_converterRegistry instance map
  16594. </para>
  16595. </remarks>
  16596. </member>
  16597. <member name="F:log4net.Layout.PatternLayout.m_pattern">
  16598. <summary>
  16599. the pattern
  16600. </summary>
  16601. </member>
  16602. <member name="F:log4net.Layout.PatternLayout.m_head">
  16603. <summary>
  16604. the head of the pattern converter chain
  16605. </summary>
  16606. </member>
  16607. <member name="F:log4net.Layout.PatternLayout.m_instanceRulesRegistry">
  16608. <summary>
  16609. patterns defined on this PatternLayout only
  16610. </summary>
  16611. </member>
  16612. <member name="M:log4net.Layout.PatternLayout.#cctor">
  16613. <summary>
  16614. Initialize the global registry
  16615. </summary>
  16616. <remarks>
  16617. <para>
  16618. Defines the builtin global rules.
  16619. </para>
  16620. </remarks>
  16621. </member>
  16622. <member name="M:log4net.Layout.PatternLayout.#ctor">
  16623. <summary>
  16624. Constructs a PatternLayout using the DefaultConversionPattern
  16625. </summary>
  16626. <remarks>
  16627. <para>
  16628. The default pattern just produces the application supplied message.
  16629. </para>
  16630. <para>
  16631. Note to Inheritors: This constructor calls the virtual method
  16632. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  16633. aware that it will be called before your is called constructor.
  16634. </para>
  16635. <para>
  16636. As per the <see cref="T:log4net.Core.IOptionHandler"/> contract the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>
  16637. method must be called after the properties on this object have been
  16638. configured.
  16639. </para>
  16640. </remarks>
  16641. </member>
  16642. <member name="M:log4net.Layout.PatternLayout.#ctor(System.String)">
  16643. <summary>
  16644. Constructs a PatternLayout using the supplied conversion pattern
  16645. </summary>
  16646. <param name="pattern">the pattern to use</param>
  16647. <remarks>
  16648. <para>
  16649. Note to Inheritors: This constructor calls the virtual method
  16650. <see cref="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)"/>. If you override this method be
  16651. aware that it will be called before your is called constructor.
  16652. </para>
  16653. <para>
  16654. When using this constructor the <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method
  16655. need not be called. This may not be the case when using a subclass.
  16656. </para>
  16657. </remarks>
  16658. </member>
  16659. <member name="P:log4net.Layout.PatternLayout.ConversionPattern">
  16660. <summary>
  16661. The pattern formatting string
  16662. </summary>
  16663. <remarks>
  16664. <para>
  16665. The <b>ConversionPattern</b> option. This is the string which
  16666. controls formatting and consists of a mix of literal content and
  16667. conversion specifiers.
  16668. </para>
  16669. </remarks>
  16670. </member>
  16671. <member name="M:log4net.Layout.PatternLayout.CreatePatternParser(System.String)">
  16672. <summary>
  16673. Create the pattern parser instance
  16674. </summary>
  16675. <param name="pattern">the pattern to parse</param>
  16676. <returns>The <see cref="T:log4net.Util.PatternParser"/> that will format the event</returns>
  16677. <remarks>
  16678. <para>
  16679. Creates the <see cref="T:log4net.Util.PatternParser"/> used to parse the conversion string. Sets the
  16680. global and instance rules on the <see cref="T:log4net.Util.PatternParser"/>.
  16681. </para>
  16682. </remarks>
  16683. </member>
  16684. <member name="M:log4net.Layout.PatternLayout.ActivateOptions">
  16685. <summary>
  16686. Initialize layout options
  16687. </summary>
  16688. <remarks>
  16689. <para>
  16690. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16691. activation scheme. The <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> method must
  16692. be called on this object after the configuration properties have
  16693. been set. Until <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> is called this
  16694. object is in an undefined state and must not be used.
  16695. </para>
  16696. <para>
  16697. If any of the configuration properties are modified then
  16698. <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/> must be called again.
  16699. </para>
  16700. </remarks>
  16701. </member>
  16702. <member name="M:log4net.Layout.PatternLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16703. <summary>
  16704. Produces a formatted string as specified by the conversion pattern.
  16705. </summary>
  16706. <param name="loggingEvent">the event being logged</param>
  16707. <param name="writer">The TextWriter to write the formatted event to</param>
  16708. <remarks>
  16709. <para>
  16710. Parse the <see cref="T:log4net.Core.LoggingEvent"/> using the patter format
  16711. specified in the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/> property.
  16712. </para>
  16713. </remarks>
  16714. </member>
  16715. <member name="M:log4net.Layout.PatternLayout.AddConverter(log4net.Util.ConverterInfo)">
  16716. <summary>
  16717. Add a converter to this PatternLayout
  16718. </summary>
  16719. <param name="converterInfo">the converter info</param>
  16720. <remarks>
  16721. <para>
  16722. This version of the method is used by the configurator.
  16723. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  16724. </para>
  16725. </remarks>
  16726. </member>
  16727. <member name="M:log4net.Layout.PatternLayout.AddConverter(System.String,System.Type)">
  16728. <summary>
  16729. Add a converter to this PatternLayout
  16730. </summary>
  16731. <param name="name">the name of the conversion pattern for this converter</param>
  16732. <param name="type">the type of the converter</param>
  16733. <remarks>
  16734. <para>
  16735. Add a named pattern converter to this instance. This
  16736. converter will be used in the formatting of the event.
  16737. This method must be called before <see cref="M:log4net.Layout.PatternLayout.ActivateOptions"/>.
  16738. </para>
  16739. <para>
  16740. The <paramref name="type"/> specified must extend the
  16741. <see cref="T:log4net.Util.PatternConverter"/> type.
  16742. </para>
  16743. </remarks>
  16744. </member>
  16745. <member name="T:log4net.Layout.Pattern.AppDomainPatternConverter">
  16746. <summary>
  16747. Write the event appdomain name to the output
  16748. </summary>
  16749. <remarks>
  16750. <para>
  16751. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output writer.
  16752. </para>
  16753. </remarks>
  16754. <author>Daniel Cazzulino</author>
  16755. <author>Nicko Cadell</author>
  16756. </member>
  16757. <member name="M:log4net.Layout.Pattern.AppDomainPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16758. <summary>
  16759. Write the event appdomain name to the output
  16760. </summary>
  16761. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16762. <param name="loggingEvent">the event being logged</param>
  16763. <remarks>
  16764. <para>
  16765. Writes the <see cref="P:log4net.Core.LoggingEvent.Domain"/> to the output <paramref name="writer"/>.
  16766. </para>
  16767. </remarks>
  16768. </member>
  16769. <member name="T:log4net.Layout.Pattern.DatePatternConverter">
  16770. <summary>
  16771. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  16772. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  16773. </summary>
  16774. <remarks>
  16775. <para>
  16776. Render the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the writer as a string.
  16777. </para>
  16778. <para>
  16779. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  16780. the formatting of the date. The following values are allowed:
  16781. <list type="definition">
  16782. <listheader>
  16783. <term>Option value</term>
  16784. <description>Output</description>
  16785. </listheader>
  16786. <item>
  16787. <term>ISO8601</term>
  16788. <description>
  16789. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  16790. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  16791. </description>
  16792. </item>
  16793. <item>
  16794. <term>DATE</term>
  16795. <description>
  16796. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  16797. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  16798. </description>
  16799. </item>
  16800. <item>
  16801. <term>ABSOLUTE</term>
  16802. <description>
  16803. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  16804. Formats using the <c>"HH:mm:ss,yyyy"</c> for example, <c>"15:49:37,459"</c>.
  16805. </description>
  16806. </item>
  16807. <item>
  16808. <term>other</term>
  16809. <description>
  16810. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  16811. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  16812. <see cref="M:DateTime.ToString(string)"/> method.
  16813. For details on valid patterns see
  16814. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  16815. </description>
  16816. </item>
  16817. </list>
  16818. </para>
  16819. <para>
  16820. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> is in the local time zone and is rendered in that zone.
  16821. To output the time in Universal time see <see cref="T:log4net.Layout.Pattern.UtcDatePatternConverter"/>.
  16822. </para>
  16823. </remarks>
  16824. <author>Nicko Cadell</author>
  16825. </member>
  16826. <member name="F:log4net.Layout.Pattern.DatePatternConverter.m_dateFormatter">
  16827. <summary>
  16828. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  16829. </summary>
  16830. <remarks>
  16831. <para>
  16832. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  16833. </para>
  16834. </remarks>
  16835. </member>
  16836. <member name="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions">
  16837. <summary>
  16838. Initialize the converter pattern based on the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  16839. </summary>
  16840. <remarks>
  16841. <para>
  16842. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  16843. activation scheme. The <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> method must
  16844. be called on this object after the configuration properties have
  16845. been set. Until <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> is called this
  16846. object is in an undefined state and must not be used.
  16847. </para>
  16848. <para>
  16849. If any of the configuration properties are modified then
  16850. <see cref="M:log4net.Layout.Pattern.DatePatternConverter.ActivateOptions"/> must be called again.
  16851. </para>
  16852. </remarks>
  16853. </member>
  16854. <member name="M:log4net.Layout.Pattern.DatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16855. <summary>
  16856. Convert the pattern into the rendered message
  16857. </summary>
  16858. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16859. <param name="loggingEvent">the event being logged</param>
  16860. <remarks>
  16861. <para>
  16862. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  16863. for it to render it to the writer.
  16864. </para>
  16865. <para>
  16866. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone.
  16867. </para>
  16868. </remarks>
  16869. </member>
  16870. <member name="F:log4net.Layout.Pattern.DatePatternConverter.declaringType">
  16871. <summary>
  16872. The fully qualified type of the DatePatternConverter class.
  16873. </summary>
  16874. <remarks>
  16875. Used by the internal logger to record the Type of the
  16876. log message.
  16877. </remarks>
  16878. </member>
  16879. <member name="T:log4net.Layout.Pattern.ExceptionPatternConverter">
  16880. <summary>
  16881. Write the exception text to the output
  16882. </summary>
  16883. <remarks>
  16884. <para>
  16885. If an exception object is stored in the logging event
  16886. it will be rendered into the pattern output with a
  16887. trailing newline.
  16888. </para>
  16889. <para>
  16890. If there is no exception then nothing will be output
  16891. and no trailing newline will be appended.
  16892. It is typical to put a newline before the exception
  16893. and to have the exception as the last data in the pattern.
  16894. </para>
  16895. </remarks>
  16896. <author>Nicko Cadell</author>
  16897. </member>
  16898. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.#ctor">
  16899. <summary>
  16900. Default constructor
  16901. </summary>
  16902. </member>
  16903. <member name="M:log4net.Layout.Pattern.ExceptionPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16904. <summary>
  16905. Write the exception text to the output
  16906. </summary>
  16907. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16908. <param name="loggingEvent">the event being logged</param>
  16909. <remarks>
  16910. <para>
  16911. If an exception object is stored in the logging event
  16912. it will be rendered into the pattern output with a
  16913. trailing newline.
  16914. </para>
  16915. <para>
  16916. If there is no exception or the exception property specified
  16917. by the Option value does not exist then nothing will be output
  16918. and no trailing newline will be appended.
  16919. It is typical to put a newline before the exception
  16920. and to have the exception as the last data in the pattern.
  16921. </para>
  16922. <para>
  16923. Recognized values for the Option parameter are:
  16924. </para>
  16925. <list type="bullet">
  16926. <item>
  16927. <description>Message</description>
  16928. </item>
  16929. <item>
  16930. <description>Source</description>
  16931. </item>
  16932. <item>
  16933. <description>StackTrace</description>
  16934. </item>
  16935. <item>
  16936. <description>TargetSite</description>
  16937. </item>
  16938. <item>
  16939. <description>HelpLink</description>
  16940. </item>
  16941. </list>
  16942. </remarks>
  16943. </member>
  16944. <member name="T:log4net.Layout.Pattern.FileLocationPatternConverter">
  16945. <summary>
  16946. Writes the caller location file name to the output
  16947. </summary>
  16948. <remarks>
  16949. <para>
  16950. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  16951. the event to the output writer.
  16952. </para>
  16953. </remarks>
  16954. <author>Nicko Cadell</author>
  16955. </member>
  16956. <member name="M:log4net.Layout.Pattern.FileLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16957. <summary>
  16958. Write the caller location file name to the output
  16959. </summary>
  16960. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16961. <param name="loggingEvent">the event being logged</param>
  16962. <remarks>
  16963. <para>
  16964. Writes the value of the <see cref="P:log4net.Core.LocationInfo.FileName"/> for
  16965. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  16966. </para>
  16967. </remarks>
  16968. </member>
  16969. <member name="T:log4net.Layout.Pattern.FullLocationPatternConverter">
  16970. <summary>
  16971. Write the caller location info to the output
  16972. </summary>
  16973. <remarks>
  16974. <para>
  16975. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  16976. </para>
  16977. </remarks>
  16978. <author>Nicko Cadell</author>
  16979. </member>
  16980. <member name="M:log4net.Layout.Pattern.FullLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  16981. <summary>
  16982. Write the caller location info to the output
  16983. </summary>
  16984. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  16985. <param name="loggingEvent">the event being logged</param>
  16986. <remarks>
  16987. <para>
  16988. Writes the <see cref="P:log4net.Core.LocationInfo.FullInfo"/> to the output writer.
  16989. </para>
  16990. </remarks>
  16991. </member>
  16992. <member name="T:log4net.Layout.Pattern.IdentityPatternConverter">
  16993. <summary>
  16994. Writes the event identity to the output
  16995. </summary>
  16996. <remarks>
  16997. <para>
  16998. Writes the value of the <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  16999. the output writer.
  17000. </para>
  17001. </remarks>
  17002. <author>Daniel Cazzulino</author>
  17003. <author>Nicko Cadell</author>
  17004. </member>
  17005. <member name="M:log4net.Layout.Pattern.IdentityPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17006. <summary>
  17007. Writes the event identity to the output
  17008. </summary>
  17009. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17010. <param name="loggingEvent">the event being logged</param>
  17011. <remarks>
  17012. <para>
  17013. Writes the value of the <paramref name="loggingEvent"/>
  17014. <see cref="P:log4net.Core.LoggingEvent.Identity"/> to
  17015. the output <paramref name="writer"/>.
  17016. </para>
  17017. </remarks>
  17018. </member>
  17019. <member name="T:log4net.Layout.Pattern.LevelPatternConverter">
  17020. <summary>
  17021. Write the event level to the output
  17022. </summary>
  17023. <remarks>
  17024. <para>
  17025. Writes the display name of the event <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17026. to the writer.
  17027. </para>
  17028. </remarks>
  17029. <author>Nicko Cadell</author>
  17030. </member>
  17031. <member name="M:log4net.Layout.Pattern.LevelPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17032. <summary>
  17033. Write the event level to the output
  17034. </summary>
  17035. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17036. <param name="loggingEvent">the event being logged</param>
  17037. <remarks>
  17038. <para>
  17039. Writes the <see cref="P:log4net.Core.Level.DisplayName"/> of the <paramref name="loggingEvent"/> <see cref="P:log4net.Core.LoggingEvent.Level"/>
  17040. to the <paramref name="writer"/>.
  17041. </para>
  17042. </remarks>
  17043. </member>
  17044. <member name="T:log4net.Layout.Pattern.LineLocationPatternConverter">
  17045. <summary>
  17046. Write the caller location line number to the output
  17047. </summary>
  17048. <remarks>
  17049. <para>
  17050. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17051. the event to the output writer.
  17052. </para>
  17053. </remarks>
  17054. <author>Nicko Cadell</author>
  17055. </member>
  17056. <member name="M:log4net.Layout.Pattern.LineLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17057. <summary>
  17058. Write the caller location line number to the output
  17059. </summary>
  17060. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17061. <param name="loggingEvent">the event being logged</param>
  17062. <remarks>
  17063. <para>
  17064. Writes the value of the <see cref="P:log4net.Core.LocationInfo.LineNumber"/> for
  17065. the <paramref name="loggingEvent"/> to the output <paramref name="writer"/>.
  17066. </para>
  17067. </remarks>
  17068. </member>
  17069. <member name="T:log4net.Layout.Pattern.LoggerPatternConverter">
  17070. <summary>
  17071. Converter for logger name
  17072. </summary>
  17073. <remarks>
  17074. <para>
  17075. Outputs the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the event.
  17076. </para>
  17077. </remarks>
  17078. <author>Nicko Cadell</author>
  17079. </member>
  17080. <member name="M:log4net.Layout.Pattern.LoggerPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17081. <summary>
  17082. Gets the fully qualified name of the logger
  17083. </summary>
  17084. <param name="loggingEvent">the event being logged</param>
  17085. <returns>The fully qualified logger name</returns>
  17086. <remarks>
  17087. <para>
  17088. Returns the <see cref="P:log4net.Core.LoggingEvent.LoggerName"/> of the <paramref name="loggingEvent"/>.
  17089. </para>
  17090. </remarks>
  17091. </member>
  17092. <member name="T:log4net.Layout.Pattern.MessagePatternConverter">
  17093. <summary>
  17094. Writes the event message to the output
  17095. </summary>
  17096. <remarks>
  17097. <para>
  17098. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  17099. to write out the event message.
  17100. </para>
  17101. </remarks>
  17102. <author>Nicko Cadell</author>
  17103. </member>
  17104. <member name="M:log4net.Layout.Pattern.MessagePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17105. <summary>
  17106. Writes the event message to the output
  17107. </summary>
  17108. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17109. <param name="loggingEvent">the event being logged</param>
  17110. <remarks>
  17111. <para>
  17112. Uses the <see cref="M:log4net.Core.LoggingEvent.WriteRenderedMessage(System.IO.TextWriter)"/> method
  17113. to write out the event message.
  17114. </para>
  17115. </remarks>
  17116. </member>
  17117. <member name="T:log4net.Layout.Pattern.MethodLocationPatternConverter">
  17118. <summary>
  17119. Write the method name to the output
  17120. </summary>
  17121. <remarks>
  17122. <para>
  17123. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  17124. the output.
  17125. </para>
  17126. </remarks>
  17127. <author>Nicko Cadell</author>
  17128. </member>
  17129. <member name="M:log4net.Layout.Pattern.MethodLocationPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17130. <summary>
  17131. Write the method name to the output
  17132. </summary>
  17133. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17134. <param name="loggingEvent">the event being logged</param>
  17135. <remarks>
  17136. <para>
  17137. Writes the caller location <see cref="P:log4net.Core.LocationInfo.MethodName"/> to
  17138. the output.
  17139. </para>
  17140. </remarks>
  17141. </member>
  17142. <member name="T:log4net.Layout.Pattern.NamedPatternConverter">
  17143. <summary>
  17144. Converter to output and truncate <c>'.'</c> separated strings
  17145. </summary>
  17146. <remarks>
  17147. <para>
  17148. This abstract class supports truncating a <c>'.'</c> separated string
  17149. to show a specified number of elements from the right hand side.
  17150. This is used to truncate class names that are fully qualified.
  17151. </para>
  17152. <para>
  17153. Subclasses should override the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> method to
  17154. return the fully qualified string.
  17155. </para>
  17156. </remarks>
  17157. <author>Nicko Cadell</author>
  17158. </member>
  17159. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions">
  17160. <summary>
  17161. Initialize the converter
  17162. </summary>
  17163. <remarks>
  17164. <para>
  17165. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17166. activation scheme. The <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> method must
  17167. be called on this object after the configuration properties have
  17168. been set. Until <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> is called this
  17169. object is in an undefined state and must not be used.
  17170. </para>
  17171. <para>
  17172. If any of the configuration properties are modified then
  17173. <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.ActivateOptions"/> must be called again.
  17174. </para>
  17175. </remarks>
  17176. </member>
  17177. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17178. <summary>
  17179. Get the fully qualified string data
  17180. </summary>
  17181. <param name="loggingEvent">the event being logged</param>
  17182. <returns>the fully qualified name</returns>
  17183. <remarks>
  17184. <para>
  17185. Overridden by subclasses to get the fully qualified name before the
  17186. precision is applied to it.
  17187. </para>
  17188. <para>
  17189. Return the fully qualified <c>'.'</c> (dot/period) separated string.
  17190. </para>
  17191. </remarks>
  17192. </member>
  17193. <member name="M:log4net.Layout.Pattern.NamedPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17194. <summary>
  17195. Convert the pattern to the rendered message
  17196. </summary>
  17197. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17198. <param name="loggingEvent">the event being logged</param>
  17199. <remarks>
  17200. Render the <see cref="M:log4net.Layout.Pattern.NamedPatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)"/> to the precision
  17201. specified by the <see cref="P:log4net.Util.PatternConverter.Option"/> property.
  17202. </remarks>
  17203. </member>
  17204. <member name="F:log4net.Layout.Pattern.NamedPatternConverter.declaringType">
  17205. <summary>
  17206. The fully qualified type of the NamedPatternConverter class.
  17207. </summary>
  17208. <remarks>
  17209. Used by the internal logger to record the Type of the
  17210. log message.
  17211. </remarks>
  17212. </member>
  17213. <member name="T:log4net.Layout.Pattern.NdcPatternConverter">
  17214. <summary>
  17215. Converter to include event NDC
  17216. </summary>
  17217. <remarks>
  17218. <para>
  17219. Outputs the value of the event property named <c>NDC</c>.
  17220. </para>
  17221. <para>
  17222. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  17223. </para>
  17224. </remarks>
  17225. <author>Nicko Cadell</author>
  17226. </member>
  17227. <member name="M:log4net.Layout.Pattern.NdcPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17228. <summary>
  17229. Write the event NDC to the output
  17230. </summary>
  17231. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17232. <param name="loggingEvent">the event being logged</param>
  17233. <remarks>
  17234. <para>
  17235. As the thread context stacks are now stored in named event properties
  17236. this converter simply looks up the value of the <c>NDC</c> property.
  17237. </para>
  17238. <para>
  17239. The <see cref="T:log4net.Layout.Pattern.PropertyPatternConverter"/> should be used instead.
  17240. </para>
  17241. </remarks>
  17242. </member>
  17243. <member name="T:log4net.Layout.Pattern.PatternLayoutConverter">
  17244. <summary>
  17245. Abstract class that provides the formatting functionality that
  17246. derived classes need.
  17247. </summary>
  17248. <remarks>
  17249. Conversion specifiers in a conversion patterns are parsed to
  17250. individual PatternConverters. Each of which is responsible for
  17251. converting a logging event in a converter specific manner.
  17252. </remarks>
  17253. <author>Nicko Cadell</author>
  17254. </member>
  17255. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.#ctor">
  17256. <summary>
  17257. Initializes a new instance of the <see cref="T:log4net.Layout.Pattern.PatternLayoutConverter" /> class.
  17258. </summary>
  17259. </member>
  17260. <member name="P:log4net.Layout.Pattern.PatternLayoutConverter.IgnoresException">
  17261. <summary>
  17262. Flag indicating if this converter handles the logging event exception
  17263. </summary>
  17264. <value><c>false</c> if this converter handles the logging event exception</value>
  17265. <remarks>
  17266. <para>
  17267. If this converter handles the exception object contained within
  17268. <see cref="T:log4net.Core.LoggingEvent"/>, then this property should be set to
  17269. <c>false</c>. Otherwise, if the layout ignores the exception
  17270. object, then the property should be set to <c>true</c>.
  17271. </para>
  17272. <para>
  17273. Set this value to override a this default setting. The default
  17274. value is <c>true</c>, this converter does not handle the exception.
  17275. </para>
  17276. </remarks>
  17277. </member>
  17278. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17279. <summary>
  17280. Derived pattern converters must override this method in order to
  17281. convert conversion specifiers in the correct way.
  17282. </summary>
  17283. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17284. <param name="loggingEvent">The <see cref="T:log4net.Core.LoggingEvent" /> on which the pattern converter should be executed.</param>
  17285. </member>
  17286. <member name="M:log4net.Layout.Pattern.PatternLayoutConverter.Convert(System.IO.TextWriter,System.Object)">
  17287. <summary>
  17288. Derived pattern converters must override this method in order to
  17289. convert conversion specifiers in the correct way.
  17290. </summary>
  17291. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17292. <param name="state">The state object on which the pattern converter should be executed.</param>
  17293. </member>
  17294. <member name="F:log4net.Layout.Pattern.PatternLayoutConverter.m_ignoresException">
  17295. <summary>
  17296. Flag indicating if this converter handles exceptions
  17297. </summary>
  17298. <remarks>
  17299. <c>false</c> if this converter handles exceptions
  17300. </remarks>
  17301. </member>
  17302. <member name="T:log4net.Layout.Pattern.PropertyPatternConverter">
  17303. <summary>
  17304. Property pattern converter
  17305. </summary>
  17306. <remarks>
  17307. <para>
  17308. Writes out the value of a named property. The property name
  17309. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17310. property.
  17311. </para>
  17312. <para>
  17313. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  17314. then all the properties are written as key value pairs.
  17315. </para>
  17316. </remarks>
  17317. <author>Nicko Cadell</author>
  17318. </member>
  17319. <member name="M:log4net.Layout.Pattern.PropertyPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17320. <summary>
  17321. Write the property value to the output
  17322. </summary>
  17323. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17324. <param name="loggingEvent">the event being logged</param>
  17325. <remarks>
  17326. <para>
  17327. Writes out the value of a named property. The property name
  17328. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  17329. property.
  17330. </para>
  17331. <para>
  17332. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  17333. then all the properties are written as key value pairs.
  17334. </para>
  17335. </remarks>
  17336. </member>
  17337. <member name="T:log4net.Layout.Pattern.RelativeTimePatternConverter">
  17338. <summary>
  17339. Converter to output the relative time of the event
  17340. </summary>
  17341. <remarks>
  17342. <para>
  17343. Converter to output the time of the event relative to the start of the program.
  17344. </para>
  17345. </remarks>
  17346. <author>Nicko Cadell</author>
  17347. </member>
  17348. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17349. <summary>
  17350. Write the relative time to the output
  17351. </summary>
  17352. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17353. <param name="loggingEvent">the event being logged</param>
  17354. <remarks>
  17355. <para>
  17356. Writes out the relative time of the event in milliseconds.
  17357. That is the number of milliseconds between the event <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  17358. and the <see cref="P:log4net.Core.LoggingEvent.StartTime"/>.
  17359. </para>
  17360. </remarks>
  17361. </member>
  17362. <member name="M:log4net.Layout.Pattern.RelativeTimePatternConverter.TimeDifferenceInMillis(System.DateTime,System.DateTime)">
  17363. <summary>
  17364. Helper method to get the time difference between two DateTime objects
  17365. </summary>
  17366. <param name="start">start time (in the current local time zone)</param>
  17367. <param name="end">end time (in the current local time zone)</param>
  17368. <returns>the time difference in milliseconds</returns>
  17369. </member>
  17370. <member name="T:log4net.Layout.Pattern.ThreadPatternConverter">
  17371. <summary>
  17372. Converter to include event thread name
  17373. </summary>
  17374. <remarks>
  17375. <para>
  17376. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the output.
  17377. </para>
  17378. </remarks>
  17379. <author>Nicko Cadell</author>
  17380. </member>
  17381. <member name="M:log4net.Layout.Pattern.ThreadPatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17382. <summary>
  17383. Write the ThreadName to the output
  17384. </summary>
  17385. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17386. <param name="loggingEvent">the event being logged</param>
  17387. <remarks>
  17388. <para>
  17389. Writes the <see cref="P:log4net.Core.LoggingEvent.ThreadName"/> to the <paramref name="writer" />.
  17390. </para>
  17391. </remarks>
  17392. </member>
  17393. <member name="T:log4net.Layout.Pattern.TypeNamePatternConverter">
  17394. <summary>
  17395. Pattern converter for the class name
  17396. </summary>
  17397. <remarks>
  17398. <para>
  17399. Outputs the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the event.
  17400. </para>
  17401. </remarks>
  17402. <author>Nicko Cadell</author>
  17403. </member>
  17404. <member name="M:log4net.Layout.Pattern.TypeNamePatternConverter.GetFullyQualifiedName(log4net.Core.LoggingEvent)">
  17405. <summary>
  17406. Gets the fully qualified name of the class
  17407. </summary>
  17408. <param name="loggingEvent">the event being logged</param>
  17409. <returns>The fully qualified type name for the caller location</returns>
  17410. <remarks>
  17411. <para>
  17412. Returns the <see cref="P:log4net.Core.LocationInfo.ClassName"/> of the <paramref name="loggingEvent"/>.
  17413. </para>
  17414. </remarks>
  17415. </member>
  17416. <member name="T:log4net.Layout.Pattern.UserNamePatternConverter">
  17417. <summary>
  17418. Converter to include event user name
  17419. </summary>
  17420. <author>Douglas de la Torre</author>
  17421. <author>Nicko Cadell</author>
  17422. </member>
  17423. <member name="M:log4net.Layout.Pattern.UserNamePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17424. <summary>
  17425. Convert the pattern to the rendered message
  17426. </summary>
  17427. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17428. <param name="loggingEvent">the event being logged</param>
  17429. </member>
  17430. <member name="T:log4net.Layout.Pattern.UtcDatePatternConverter">
  17431. <summary>
  17432. Write the TimeStamp to the output
  17433. </summary>
  17434. <remarks>
  17435. <para>
  17436. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  17437. the date of a <see cref="T:log4net.Core.LoggingEvent"/>.
  17438. </para>
  17439. <para>
  17440. Uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/>
  17441. in Universal time.
  17442. </para>
  17443. <para>
  17444. See the <see cref="T:log4net.Layout.Pattern.DatePatternConverter"/> for details on the date pattern syntax.
  17445. </para>
  17446. </remarks>
  17447. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  17448. <author>Nicko Cadell</author>
  17449. </member>
  17450. <member name="M:log4net.Layout.Pattern.UtcDatePatternConverter.Convert(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17451. <summary>
  17452. Write the TimeStamp to the output
  17453. </summary>
  17454. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  17455. <param name="loggingEvent">the event being logged</param>
  17456. <remarks>
  17457. <para>
  17458. Pass the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  17459. for it to render it to the writer.
  17460. </para>
  17461. <para>
  17462. The <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> passed is in the local time zone, this is converted
  17463. to Universal time before it is rendered.
  17464. </para>
  17465. </remarks>
  17466. <seealso cref="T:log4net.Layout.Pattern.DatePatternConverter"/>
  17467. </member>
  17468. <member name="F:log4net.Layout.Pattern.UtcDatePatternConverter.declaringType">
  17469. <summary>
  17470. The fully qualified type of the UtcDatePatternConverter class.
  17471. </summary>
  17472. <remarks>
  17473. Used by the internal logger to record the Type of the
  17474. log message.
  17475. </remarks>
  17476. </member>
  17477. <member name="T:log4net.Layout.RawLayoutConverter">
  17478. <summary>
  17479. Type converter for the <see cref="T:log4net.Layout.IRawLayout"/> interface
  17480. </summary>
  17481. <remarks>
  17482. <para>
  17483. Used to convert objects to the <see cref="T:log4net.Layout.IRawLayout"/> interface.
  17484. Supports converting from the <see cref="T:log4net.Layout.ILayout"/> interface to
  17485. the <see cref="T:log4net.Layout.IRawLayout"/> interface using the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>.
  17486. </para>
  17487. </remarks>
  17488. <author>Nicko Cadell</author>
  17489. <author>Gert Driesen</author>
  17490. </member>
  17491. <member name="M:log4net.Layout.RawLayoutConverter.CanConvertFrom(System.Type)">
  17492. <summary>
  17493. Can the sourceType be converted to an <see cref="T:log4net.Layout.IRawLayout"/>
  17494. </summary>
  17495. <param name="sourceType">the source to be to be converted</param>
  17496. <returns><c>true</c> if the source type can be converted to <see cref="T:log4net.Layout.IRawLayout"/></returns>
  17497. <remarks>
  17498. <para>
  17499. Test if the <paramref name="sourceType"/> can be converted to a
  17500. <see cref="T:log4net.Layout.IRawLayout"/>. Only <see cref="T:log4net.Layout.ILayout"/> is supported
  17501. as the <paramref name="sourceType"/>.
  17502. </para>
  17503. </remarks>
  17504. </member>
  17505. <member name="M:log4net.Layout.RawLayoutConverter.ConvertFrom(System.Object)">
  17506. <summary>
  17507. Convert the value to a <see cref="T:log4net.Layout.IRawLayout"/> object
  17508. </summary>
  17509. <param name="source">the value to convert</param>
  17510. <returns>the <see cref="T:log4net.Layout.IRawLayout"/> object</returns>
  17511. <remarks>
  17512. <para>
  17513. Convert the <paramref name="source"/> object to a
  17514. <see cref="T:log4net.Layout.IRawLayout"/> object. If the <paramref name="source"/> object
  17515. is a <see cref="T:log4net.Layout.ILayout"/> then the <see cref="T:log4net.Layout.Layout2RawLayoutAdapter"/>
  17516. is used to adapt between the two interfaces, otherwise an
  17517. exception is thrown.
  17518. </para>
  17519. </remarks>
  17520. </member>
  17521. <member name="T:log4net.Layout.RawPropertyLayout">
  17522. <summary>
  17523. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  17524. </summary>
  17525. <remarks>
  17526. <para>
  17527. Extract the value of a property from the <see cref="T:log4net.Core.LoggingEvent"/>
  17528. </para>
  17529. </remarks>
  17530. <author>Nicko Cadell</author>
  17531. </member>
  17532. <member name="M:log4net.Layout.RawPropertyLayout.#ctor">
  17533. <summary>
  17534. Constructs a RawPropertyLayout
  17535. </summary>
  17536. </member>
  17537. <member name="P:log4net.Layout.RawPropertyLayout.Key">
  17538. <summary>
  17539. The name of the value to lookup in the LoggingEvent Properties collection.
  17540. </summary>
  17541. <value>
  17542. Value to lookup in the LoggingEvent Properties collection
  17543. </value>
  17544. <remarks>
  17545. <para>
  17546. String name of the property to lookup in the <see cref="T:log4net.Core.LoggingEvent"/>.
  17547. </para>
  17548. </remarks>
  17549. </member>
  17550. <member name="M:log4net.Layout.RawPropertyLayout.Format(log4net.Core.LoggingEvent)">
  17551. <summary>
  17552. Lookup the property for <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>
  17553. </summary>
  17554. <param name="loggingEvent">The event to format</param>
  17555. <returns>returns property value</returns>
  17556. <remarks>
  17557. <para>
  17558. Looks up and returns the object value of the property
  17559. named <see cref="P:log4net.Layout.RawPropertyLayout.Key"/>. If there is no property defined
  17560. with than name then <c>null</c> will be returned.
  17561. </para>
  17562. </remarks>
  17563. </member>
  17564. <member name="T:log4net.Layout.RawTimeStampLayout">
  17565. <summary>
  17566. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  17567. </summary>
  17568. <remarks>
  17569. <para>
  17570. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  17571. </para>
  17572. </remarks>
  17573. <author>Nicko Cadell</author>
  17574. <author>Gert Driesen</author>
  17575. </member>
  17576. <member name="M:log4net.Layout.RawTimeStampLayout.#ctor">
  17577. <summary>
  17578. Constructs a RawTimeStampLayout
  17579. </summary>
  17580. </member>
  17581. <member name="M:log4net.Layout.RawTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  17582. <summary>
  17583. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  17584. </summary>
  17585. <param name="loggingEvent">The event to format</param>
  17586. <returns>returns the time stamp</returns>
  17587. <remarks>
  17588. <para>
  17589. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  17590. </para>
  17591. <para>
  17592. The time stamp is in local time. To format the time stamp
  17593. in universal time use <see cref="T:log4net.Layout.RawUtcTimeStampLayout"/>.
  17594. </para>
  17595. </remarks>
  17596. </member>
  17597. <member name="T:log4net.Layout.RawUtcTimeStampLayout">
  17598. <summary>
  17599. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  17600. </summary>
  17601. <remarks>
  17602. <para>
  17603. Extract the date from the <see cref="T:log4net.Core.LoggingEvent"/>
  17604. </para>
  17605. </remarks>
  17606. <author>Nicko Cadell</author>
  17607. <author>Gert Driesen</author>
  17608. </member>
  17609. <member name="M:log4net.Layout.RawUtcTimeStampLayout.#ctor">
  17610. <summary>
  17611. Constructs a RawUtcTimeStampLayout
  17612. </summary>
  17613. </member>
  17614. <member name="M:log4net.Layout.RawUtcTimeStampLayout.Format(log4net.Core.LoggingEvent)">
  17615. <summary>
  17616. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  17617. </summary>
  17618. <param name="loggingEvent">The event to format</param>
  17619. <returns>returns the time stamp</returns>
  17620. <remarks>
  17621. <para>
  17622. Gets the <see cref="P:log4net.Core.LoggingEvent.TimeStamp"/> as a <see cref="T:System.DateTime"/>.
  17623. </para>
  17624. <para>
  17625. The time stamp is in universal time. To format the time stamp
  17626. in local time use <see cref="T:log4net.Layout.RawTimeStampLayout"/>.
  17627. </para>
  17628. </remarks>
  17629. </member>
  17630. <member name="T:log4net.Layout.SimpleLayout">
  17631. <summary>
  17632. A very simple layout
  17633. </summary>
  17634. <remarks>
  17635. <para>
  17636. SimpleLayout consists of the level of the log statement,
  17637. followed by " - " and then the log message itself. For example,
  17638. <code>
  17639. DEBUG - Hello world
  17640. </code>
  17641. </para>
  17642. </remarks>
  17643. <author>Nicko Cadell</author>
  17644. <author>Gert Driesen</author>
  17645. </member>
  17646. <member name="M:log4net.Layout.SimpleLayout.#ctor">
  17647. <summary>
  17648. Constructs a SimpleLayout
  17649. </summary>
  17650. </member>
  17651. <member name="M:log4net.Layout.SimpleLayout.ActivateOptions">
  17652. <summary>
  17653. Initialize layout options
  17654. </summary>
  17655. <remarks>
  17656. <para>
  17657. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17658. activation scheme. The <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> method must
  17659. be called on this object after the configuration properties have
  17660. been set. Until <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> is called this
  17661. object is in an undefined state and must not be used.
  17662. </para>
  17663. <para>
  17664. If any of the configuration properties are modified then
  17665. <see cref="M:log4net.Layout.SimpleLayout.ActivateOptions"/> must be called again.
  17666. </para>
  17667. </remarks>
  17668. </member>
  17669. <member name="M:log4net.Layout.SimpleLayout.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17670. <summary>
  17671. Produces a simple formatted output.
  17672. </summary>
  17673. <param name="loggingEvent">the event being logged</param>
  17674. <param name="writer">The TextWriter to write the formatted event to</param>
  17675. <remarks>
  17676. <para>
  17677. Formats the event as the level of the even,
  17678. followed by " - " and then the log message itself. The
  17679. output is terminated by a newline.
  17680. </para>
  17681. </remarks>
  17682. </member>
  17683. <member name="T:log4net.Layout.XmlLayout">
  17684. <summary>
  17685. Layout that formats the log events as XML elements.
  17686. </summary>
  17687. <remarks>
  17688. <para>
  17689. The output of the <see cref="T:log4net.Layout.XmlLayout" /> consists of a series of
  17690. log4net:event elements. It does not output a complete well-formed XML
  17691. file. The output is designed to be included as an <em>external entity</em>
  17692. in a separate file to form a correct XML file.
  17693. </para>
  17694. <para>
  17695. For example, if <c>abc</c> is the name of the file where
  17696. the <see cref="T:log4net.Layout.XmlLayout" /> output goes, then a well-formed XML file would
  17697. be:
  17698. </para>
  17699. <code lang="XML">
  17700. &lt;?xml version="1.0" ?&gt;
  17701. &lt;!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [&lt;!ENTITY data SYSTEM "abc"&gt;]&gt;
  17702. &lt;log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2&gt;
  17703. &amp;data;
  17704. &lt;/log4net:events&gt;
  17705. </code>
  17706. <para>
  17707. This approach enforces the independence of the <see cref="T:log4net.Layout.XmlLayout" />
  17708. and the appender where it is embedded.
  17709. </para>
  17710. <para>
  17711. The <c>version</c> attribute helps components to correctly
  17712. interpret output generated by <see cref="T:log4net.Layout.XmlLayout" />. The value of
  17713. this attribute should be "1.2" for release 1.2 and later.
  17714. </para>
  17715. <para>
  17716. Alternatively the <c>Header</c> and <c>Footer</c> properties can be
  17717. configured to output the correct XML header, open tag and close tag.
  17718. When setting the <c>Header</c> and <c>Footer</c> properties it is essential
  17719. that the underlying data store not be appendable otherwise the data
  17720. will become invalid XML.
  17721. </para>
  17722. </remarks>
  17723. <author>Nicko Cadell</author>
  17724. <author>Gert Driesen</author>
  17725. </member>
  17726. <member name="M:log4net.Layout.XmlLayout.#ctor">
  17727. <summary>
  17728. Constructs an XmlLayout
  17729. </summary>
  17730. </member>
  17731. <member name="M:log4net.Layout.XmlLayout.#ctor(System.Boolean)">
  17732. <summary>
  17733. Constructs an XmlLayout.
  17734. </summary>
  17735. <remarks>
  17736. <para>
  17737. The <b>LocationInfo</b> option takes a boolean value. By
  17738. default, it is set to false which means there will be no location
  17739. information output by this layout. If the the option is set to
  17740. true, then the file name and line number of the statement
  17741. at the origin of the log statement will be output.
  17742. </para>
  17743. <para>
  17744. If you are embedding this layout within an SmtpAppender
  17745. then make sure to set the <b>LocationInfo</b> option of that
  17746. appender as well.
  17747. </para>
  17748. </remarks>
  17749. </member>
  17750. <member name="P:log4net.Layout.XmlLayout.Prefix">
  17751. <summary>
  17752. The prefix to use for all element names
  17753. </summary>
  17754. <remarks>
  17755. <para>
  17756. The default prefix is <b>log4net</b>. Set this property
  17757. to change the prefix. If the prefix is set to an empty string
  17758. then no prefix will be written.
  17759. </para>
  17760. </remarks>
  17761. </member>
  17762. <member name="P:log4net.Layout.XmlLayout.Base64EncodeMessage">
  17763. <summary>
  17764. Set whether or not to base64 encode the message.
  17765. </summary>
  17766. <remarks>
  17767. <para>
  17768. By default the log message will be written as text to the xml
  17769. output. This can cause problems when the message contains binary
  17770. data. By setting this to true the contents of the message will be
  17771. base64 encoded. If this is set then invalid character replacement
  17772. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  17773. on the log message.
  17774. </para>
  17775. </remarks>
  17776. </member>
  17777. <member name="P:log4net.Layout.XmlLayout.Base64EncodeProperties">
  17778. <summary>
  17779. Set whether or not to base64 encode the property values.
  17780. </summary>
  17781. <remarks>
  17782. <para>
  17783. By default the properties will be written as text to the xml
  17784. output. This can cause problems when one or more properties contain
  17785. binary data. By setting this to true the values of the properties
  17786. will be base64 encoded. If this is set then invalid character replacement
  17787. (see <see cref="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement"/>) will not be performed
  17788. on the property values.
  17789. </para>
  17790. </remarks>
  17791. </member>
  17792. <member name="M:log4net.Layout.XmlLayout.ActivateOptions">
  17793. <summary>
  17794. Initialize layout options
  17795. </summary>
  17796. <remarks>
  17797. <para>
  17798. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17799. activation scheme. The <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> method must
  17800. be called on this object after the configuration properties have
  17801. been set. Until <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> is called this
  17802. object is in an undefined state and must not be used.
  17803. </para>
  17804. <para>
  17805. If any of the configuration properties are modified then
  17806. <see cref="M:log4net.Layout.XmlLayout.ActivateOptions"/> must be called again.
  17807. </para>
  17808. <para>
  17809. Builds a cache of the element names
  17810. </para>
  17811. </remarks>
  17812. </member>
  17813. <member name="M:log4net.Layout.XmlLayout.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  17814. <summary>
  17815. Does the actual writing of the XML.
  17816. </summary>
  17817. <param name="writer">The writer to use to output the event to.</param>
  17818. <param name="loggingEvent">The event to write.</param>
  17819. <remarks>
  17820. <para>
  17821. Override the base class <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method
  17822. to write the <see cref="T:log4net.Core.LoggingEvent"/> to the <see cref="T:System.Xml.XmlWriter"/>.
  17823. </para>
  17824. </remarks>
  17825. </member>
  17826. <member name="F:log4net.Layout.XmlLayout.m_prefix">
  17827. <summary>
  17828. The prefix to use for all generated element names
  17829. </summary>
  17830. </member>
  17831. <member name="T:log4net.Layout.XmlLayoutBase">
  17832. <summary>
  17833. Layout that formats the log events as XML elements.
  17834. </summary>
  17835. <remarks>
  17836. <para>
  17837. This is an abstract class that must be subclassed by an implementation
  17838. to conform to a specific schema.
  17839. </para>
  17840. <para>
  17841. Deriving classes must implement the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method.
  17842. </para>
  17843. </remarks>
  17844. <author>Nicko Cadell</author>
  17845. <author>Gert Driesen</author>
  17846. </member>
  17847. <member name="M:log4net.Layout.XmlLayoutBase.#ctor">
  17848. <summary>
  17849. Protected constructor to support subclasses
  17850. </summary>
  17851. <remarks>
  17852. <para>
  17853. Initializes a new instance of the <see cref="T:log4net.Layout.XmlLayoutBase" /> class
  17854. with no location info.
  17855. </para>
  17856. </remarks>
  17857. </member>
  17858. <member name="M:log4net.Layout.XmlLayoutBase.#ctor(System.Boolean)">
  17859. <summary>
  17860. Protected constructor to support subclasses
  17861. </summary>
  17862. <remarks>
  17863. <para>
  17864. The <paramref name="locationInfo" /> parameter determines whether
  17865. location information will be output by the layout. If
  17866. <paramref name="locationInfo" /> is set to <c>true</c>, then the
  17867. file name and line number of the statement at the origin of the log
  17868. statement will be output.
  17869. </para>
  17870. <para>
  17871. If you are embedding this layout within an SMTPAppender
  17872. then make sure to set the <b>LocationInfo</b> option of that
  17873. appender as well.
  17874. </para>
  17875. </remarks>
  17876. </member>
  17877. <member name="P:log4net.Layout.XmlLayoutBase.LocationInfo">
  17878. <summary>
  17879. Gets a value indicating whether to include location information in
  17880. the XML events.
  17881. </summary>
  17882. <value>
  17883. <c>true</c> if location information should be included in the XML
  17884. events; otherwise, <c>false</c>.
  17885. </value>
  17886. <remarks>
  17887. <para>
  17888. If <see cref="P:log4net.Layout.XmlLayoutBase.LocationInfo" /> is set to <c>true</c>, then the file
  17889. name and line number of the statement at the origin of the log
  17890. statement will be output.
  17891. </para>
  17892. <para>
  17893. If you are embedding this layout within an <c>SMTPAppender</c>
  17894. then make sure to set the <b>LocationInfo</b> option of that
  17895. appender as well.
  17896. </para>
  17897. </remarks>
  17898. </member>
  17899. <member name="P:log4net.Layout.XmlLayoutBase.InvalidCharReplacement">
  17900. <summary>
  17901. The string to replace characters that can not be expressed in XML with.
  17902. <remarks>
  17903. <para>
  17904. Not all characters may be expressed in XML. This property contains the
  17905. string to replace those that can not with. This defaults to a ?. Set it
  17906. to the empty string to simply remove offending characters. For more
  17907. details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets
  17908. Character replacement will occur in the log message, the property names
  17909. and the property values.
  17910. </para>
  17911. </remarks>
  17912. </summary>
  17913. </member>
  17914. <member name="M:log4net.Layout.XmlLayoutBase.ActivateOptions">
  17915. <summary>
  17916. Initialize layout options
  17917. </summary>
  17918. <remarks>
  17919. <para>
  17920. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  17921. activation scheme. The <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> method must
  17922. be called on this object after the configuration properties have
  17923. been set. Until <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> is called this
  17924. object is in an undefined state and must not be used.
  17925. </para>
  17926. <para>
  17927. If any of the configuration properties are modified then
  17928. <see cref="M:log4net.Layout.XmlLayoutBase.ActivateOptions"/> must be called again.
  17929. </para>
  17930. </remarks>
  17931. </member>
  17932. <member name="P:log4net.Layout.XmlLayoutBase.ContentType">
  17933. <summary>
  17934. Gets the content type output by this layout.
  17935. </summary>
  17936. <value>
  17937. As this is the XML layout, the value is always <c>"text/xml"</c>.
  17938. </value>
  17939. <remarks>
  17940. <para>
  17941. As this is the XML layout, the value is always <c>"text/xml"</c>.
  17942. </para>
  17943. </remarks>
  17944. </member>
  17945. <member name="M:log4net.Layout.XmlLayoutBase.Format(System.IO.TextWriter,log4net.Core.LoggingEvent)">
  17946. <summary>
  17947. Produces a formatted string.
  17948. </summary>
  17949. <param name="loggingEvent">The event being logged.</param>
  17950. <param name="writer">The TextWriter to write the formatted event to</param>
  17951. <remarks>
  17952. <para>
  17953. Format the <see cref="T:log4net.Core.LoggingEvent"/> and write it to the <see cref="T:System.IO.TextWriter"/>.
  17954. </para>
  17955. <para>
  17956. This method creates an <see cref="!:XmlTextWriter"/> that writes to the
  17957. <paramref name="writer"/>. The <see cref="!:XmlTextWriter"/> is passed
  17958. to the <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method. Subclasses should override the
  17959. <see cref="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)"/> method rather than this method.
  17960. </para>
  17961. </remarks>
  17962. </member>
  17963. <member name="M:log4net.Layout.XmlLayoutBase.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  17964. <summary>
  17965. Does the actual writing of the XML.
  17966. </summary>
  17967. <param name="writer">The writer to use to output the event to.</param>
  17968. <param name="loggingEvent">The event to write.</param>
  17969. <remarks>
  17970. <para>
  17971. Subclasses should override this method to format
  17972. the <see cref="T:log4net.Core.LoggingEvent"/> as XML.
  17973. </para>
  17974. </remarks>
  17975. </member>
  17976. <member name="F:log4net.Layout.XmlLayoutBase.m_locationInfo">
  17977. <summary>
  17978. Flag to indicate if location information should be included in
  17979. the XML events.
  17980. </summary>
  17981. </member>
  17982. <member name="F:log4net.Layout.XmlLayoutBase.m_invalidCharReplacement">
  17983. <summary>
  17984. The string to replace invalid chars with
  17985. </summary>
  17986. </member>
  17987. <member name="T:log4net.Layout.XmlLayoutSchemaLog4j">
  17988. <summary>
  17989. Layout that formats the log events as XML elements compatible with the log4j schema
  17990. </summary>
  17991. <remarks>
  17992. <para>
  17993. Formats the log events according to the http://logging.apache.org/log4j schema.
  17994. </para>
  17995. </remarks>
  17996. <author>Nicko Cadell</author>
  17997. </member>
  17998. <member name="F:log4net.Layout.XmlLayoutSchemaLog4j.s_date1970">
  17999. <summary>
  18000. The 1st of January 1970 in UTC
  18001. </summary>
  18002. </member>
  18003. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor">
  18004. <summary>
  18005. Constructs an XMLLayoutSchemaLog4j
  18006. </summary>
  18007. </member>
  18008. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.#ctor(System.Boolean)">
  18009. <summary>
  18010. Constructs an XMLLayoutSchemaLog4j.
  18011. </summary>
  18012. <remarks>
  18013. <para>
  18014. The <b>LocationInfo</b> option takes a boolean value. By
  18015. default, it is set to false which means there will be no location
  18016. information output by this layout. If the the option is set to
  18017. true, then the file name and line number of the statement
  18018. at the origin of the log statement will be output.
  18019. </para>
  18020. <para>
  18021. If you are embedding this layout within an SMTPAppender
  18022. then make sure to set the <b>LocationInfo</b> option of that
  18023. appender as well.
  18024. </para>
  18025. </remarks>
  18026. </member>
  18027. <member name="P:log4net.Layout.XmlLayoutSchemaLog4j.Version">
  18028. <summary>
  18029. The version of the log4j schema to use.
  18030. </summary>
  18031. <remarks>
  18032. <para>
  18033. Only version 1.2 of the log4j schema is supported.
  18034. </para>
  18035. </remarks>
  18036. </member>
  18037. <member name="M:log4net.Layout.XmlLayoutSchemaLog4j.FormatXml(System.Xml.XmlWriter,log4net.Core.LoggingEvent)">
  18038. <summary>
  18039. Actually do the writing of the xml
  18040. </summary>
  18041. <param name="writer">the writer to use</param>
  18042. <param name="loggingEvent">the event to write</param>
  18043. <remarks>
  18044. <para>
  18045. Generate XML that is compatible with the log4j schema.
  18046. </para>
  18047. </remarks>
  18048. </member>
  18049. <member name="T:log4net.LogicalThreadContext">
  18050. <summary>
  18051. The log4net Logical Thread Context.
  18052. </summary>
  18053. <remarks>
  18054. <para>
  18055. The <c>LogicalThreadContext</c> provides a location for <see cref="!:System.Runtime.Remoting.Messaging.CallContext"/> specific debugging
  18056. information to be stored.
  18057. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/> or <see cref="T:log4net.GlobalContext"/>
  18058. properties with the same name.
  18059. </para>
  18060. <para>
  18061. For .NET Standard 1.3 this class uses
  18062. System.Threading.AsyncLocal rather than <see
  18063. cref="!:System.Runtime.Remoting.Messaging.CallContext"/>.
  18064. </para>
  18065. <para>
  18066. The Logical Thread Context has a properties map and a stack.
  18067. The properties and stack can
  18068. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  18069. supports selecting and outputting these properties.
  18070. </para>
  18071. <para>
  18072. The Logical Thread Context provides a diagnostic context for the current call context.
  18073. This is an instrument for distinguishing interleaved log
  18074. output from different sources. Log output is typically interleaved
  18075. when a server handles multiple clients near-simultaneously.
  18076. </para>
  18077. <para>
  18078. The Logical Thread Context is managed on a per <see cref="!:System.Runtime.Remoting.Messaging.CallContext"/> basis.
  18079. </para>
  18080. <para>
  18081. The <see cref="!:System.Runtime.Remoting.Messaging.CallContext"/> requires a link time
  18082. <see cref="!:System.Security.Permissions.SecurityPermission"/> for the
  18083. <see cref="!:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  18084. If the calling code does not have this permission then this context will be disabled.
  18085. It will not store any property values set on it.
  18086. </para>
  18087. </remarks>
  18088. <example>Example of using the thread context properties to store a username.
  18089. <code lang="C#">
  18090. LogicalThreadContext.Properties["user"] = userName;
  18091. log.Info("This log message has a LogicalThreadContext Property called 'user'");
  18092. </code>
  18093. </example>
  18094. <example>Example of how to push a message into the context stack
  18095. <code lang="C#">
  18096. using(LogicalThreadContext.Stacks["LDC"].Push("my context message"))
  18097. {
  18098. log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'");
  18099. } // at the end of the using block the message is automatically popped
  18100. </code>
  18101. </example>
  18102. <threadsafety static="true" instance="true" />
  18103. <author>Nicko Cadell</author>
  18104. </member>
  18105. <member name="M:log4net.LogicalThreadContext.#ctor">
  18106. <summary>
  18107. Private Constructor.
  18108. </summary>
  18109. <remarks>
  18110. <para>
  18111. Uses a private access modifier to prevent instantiation of this class.
  18112. </para>
  18113. </remarks>
  18114. </member>
  18115. <member name="P:log4net.LogicalThreadContext.Properties">
  18116. <summary>
  18117. The thread properties map
  18118. </summary>
  18119. <value>
  18120. The thread properties map
  18121. </value>
  18122. <remarks>
  18123. <para>
  18124. The <c>LogicalThreadContext</c> properties override any <see cref="T:log4net.ThreadContext"/>
  18125. or <see cref="T:log4net.GlobalContext"/> properties with the same name.
  18126. </para>
  18127. </remarks>
  18128. </member>
  18129. <member name="P:log4net.LogicalThreadContext.Stacks">
  18130. <summary>
  18131. The thread stacks
  18132. </summary>
  18133. <value>
  18134. stack map
  18135. </value>
  18136. <remarks>
  18137. <para>
  18138. The logical thread stacks.
  18139. </para>
  18140. </remarks>
  18141. </member>
  18142. <member name="F:log4net.LogicalThreadContext.s_properties">
  18143. <summary>
  18144. The thread context properties instance
  18145. </summary>
  18146. </member>
  18147. <member name="F:log4net.LogicalThreadContext.s_stacks">
  18148. <summary>
  18149. The thread context stacks instance
  18150. </summary>
  18151. </member>
  18152. <member name="T:log4net.LogManager">
  18153. <summary>
  18154. This class is used by client applications to request logger instances.
  18155. </summary>
  18156. <remarks>
  18157. <para>
  18158. This class has static methods that are used by a client to request
  18159. a logger instance. The <see cref="M:GetLogger(string)"/> method is
  18160. used to retrieve a logger.
  18161. </para>
  18162. <para>
  18163. See the <see cref="T:log4net.ILog"/> interface for more details.
  18164. </para>
  18165. </remarks>
  18166. <example>Simple example of logging messages
  18167. <code lang="C#">
  18168. ILog log = LogManager.GetLogger("application-log");
  18169. log.Info("Application Start");
  18170. log.Debug("This is a debug message");
  18171. if (log.IsDebugEnabled)
  18172. {
  18173. log.Debug("This is another debug message");
  18174. }
  18175. </code>
  18176. </example>
  18177. <threadsafety static="true" instance="true" />
  18178. <seealso cref="T:log4net.ILog"/>
  18179. <author>Nicko Cadell</author>
  18180. <author>Gert Driesen</author>
  18181. </member>
  18182. <member name="M:log4net.LogManager.#ctor">
  18183. <summary>
  18184. Initializes a new instance of the <see cref="T:log4net.LogManager" /> class.
  18185. </summary>
  18186. <remarks>
  18187. Uses a private access modifier to prevent instantiation of this class.
  18188. </remarks>
  18189. </member>
  18190. <member name="M:log4net.LogManager.Exists(System.String,System.String)">
  18191. <summary>
  18192. Returns the named logger if it exists.
  18193. </summary>
  18194. <remarks>
  18195. <para>
  18196. If the named logger exists (in the specified repository) then it
  18197. returns a reference to the logger, otherwise it returns
  18198. <c>null</c>.
  18199. </para>
  18200. </remarks>
  18201. <param name="repository">The repository to lookup in.</param>
  18202. <param name="name">The fully qualified logger name to look for.</param>
  18203. <returns>
  18204. The logger found, or <c>null</c> if the logger doesn't exist in the specified
  18205. repository.
  18206. </returns>
  18207. </member>
  18208. <member name="M:log4net.LogManager.Exists(System.Reflection.Assembly,System.String)">
  18209. <summary>
  18210. Returns the named logger if it exists.
  18211. </summary>
  18212. <remarks>
  18213. <para>
  18214. If the named logger exists (in the repository for the specified assembly) then it
  18215. returns a reference to the logger, otherwise it returns
  18216. <c>null</c>.
  18217. </para>
  18218. </remarks>
  18219. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18220. <param name="name">The fully qualified logger name to look for.</param>
  18221. <returns>
  18222. The logger, or <c>null</c> if the logger doesn't exist in the specified
  18223. assembly's repository.
  18224. </returns>
  18225. </member>
  18226. <member name="M:log4net.LogManager.GetCurrentLoggers(System.String)">
  18227. <summary>
  18228. Returns all the currently defined loggers in the specified repository.
  18229. </summary>
  18230. <param name="repository">The repository to lookup in.</param>
  18231. <remarks>
  18232. The root logger is <b>not</b> included in the returned array.
  18233. </remarks>
  18234. <returns>All the defined loggers.</returns>
  18235. </member>
  18236. <member name="M:log4net.LogManager.GetCurrentLoggers(System.Reflection.Assembly)">
  18237. <summary>
  18238. Returns all the currently defined loggers in the specified assembly's repository.
  18239. </summary>
  18240. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18241. <remarks>
  18242. The root logger is <b>not</b> included in the returned array.
  18243. </remarks>
  18244. <returns>All the defined loggers.</returns>
  18245. </member>
  18246. <member name="M:log4net.LogManager.GetLogger(System.String,System.String)">
  18247. <summary>
  18248. Retrieves or creates a named logger.
  18249. </summary>
  18250. <remarks>
  18251. <para>
  18252. Retrieve a logger named as the <paramref name="name"/>
  18253. parameter. If the named logger already exists, then the
  18254. existing instance will be returned. Otherwise, a new instance is
  18255. created.
  18256. </para>
  18257. <para>
  18258. By default, loggers do not have a set level but inherit
  18259. it from the hierarchy. This is one of the central features of
  18260. log4net.
  18261. </para>
  18262. </remarks>
  18263. <param name="repository">The repository to lookup in.</param>
  18264. <param name="name">The name of the logger to retrieve.</param>
  18265. <returns>The logger with the name specified.</returns>
  18266. </member>
  18267. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.String)">
  18268. <summary>
  18269. Retrieves or creates a named logger.
  18270. </summary>
  18271. <remarks>
  18272. <para>
  18273. Retrieve a logger named as the <paramref name="name"/>
  18274. parameter. If the named logger already exists, then the
  18275. existing instance will be returned. Otherwise, a new instance is
  18276. created.
  18277. </para>
  18278. <para>
  18279. By default, loggers do not have a set level but inherit
  18280. it from the hierarchy. This is one of the central features of
  18281. log4net.
  18282. </para>
  18283. </remarks>
  18284. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18285. <param name="name">The name of the logger to retrieve.</param>
  18286. <returns>The logger with the name specified.</returns>
  18287. </member>
  18288. <member name="M:log4net.LogManager.GetLogger(System.Type)">
  18289. <summary>
  18290. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  18291. </summary>
  18292. <remarks>
  18293. Get the logger for the fully qualified name of the type specified.
  18294. </remarks>
  18295. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  18296. <returns>The logger with the name specified.</returns>
  18297. </member>
  18298. <member name="M:log4net.LogManager.GetLogger(System.String,System.Type)">
  18299. <summary>
  18300. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  18301. </summary>
  18302. <remarks>
  18303. Gets the logger for the fully qualified name of the type specified.
  18304. </remarks>
  18305. <param name="repository">The repository to lookup in.</param>
  18306. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  18307. <returns>The logger with the name specified.</returns>
  18308. </member>
  18309. <member name="M:log4net.LogManager.GetLogger(System.Reflection.Assembly,System.Type)">
  18310. <summary>
  18311. Shorthand for <see cref="M:LogManager.GetLogger(string)"/>.
  18312. </summary>
  18313. <remarks>
  18314. Gets the logger for the fully qualified name of the type specified.
  18315. </remarks>
  18316. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18317. <param name="type">The full name of <paramref name="type"/> will be used as the name of the logger to retrieve.</param>
  18318. <returns>The logger with the name specified.</returns>
  18319. </member>
  18320. <member name="M:log4net.LogManager.Shutdown">
  18321. <summary>
  18322. Shuts down the log4net system.
  18323. </summary>
  18324. <remarks>
  18325. <para>
  18326. Calling this method will <b>safely</b> close and remove all
  18327. appenders in all the loggers including root contained in all the
  18328. default repositories.
  18329. </para>
  18330. <para>
  18331. Some appenders need to be closed before the application exists.
  18332. Otherwise, pending logging events might be lost.
  18333. </para>
  18334. <para>The <c>shutdown</c> method is careful to close nested
  18335. appenders before closing regular appenders. This is allows
  18336. configurations where a regular appender is attached to a logger
  18337. and again to a nested appender.
  18338. </para>
  18339. </remarks>
  18340. </member>
  18341. <member name="M:log4net.LogManager.ShutdownRepository(System.String)">
  18342. <summary>
  18343. Shuts down the repository for the repository specified.
  18344. </summary>
  18345. <remarks>
  18346. <para>
  18347. Calling this method will <b>safely</b> close and remove all
  18348. appenders in all the loggers including root contained in the
  18349. <paramref name="repository"/> specified.
  18350. </para>
  18351. <para>
  18352. Some appenders need to be closed before the application exists.
  18353. Otherwise, pending logging events might be lost.
  18354. </para>
  18355. <para>The <c>shutdown</c> method is careful to close nested
  18356. appenders before closing regular appenders. This is allows
  18357. configurations where a regular appender is attached to a logger
  18358. and again to a nested appender.
  18359. </para>
  18360. </remarks>
  18361. <param name="repository">The repository to shutdown.</param>
  18362. </member>
  18363. <member name="M:log4net.LogManager.ShutdownRepository(System.Reflection.Assembly)">
  18364. <summary>
  18365. Shuts down the repository specified.
  18366. </summary>
  18367. <remarks>
  18368. <para>
  18369. Calling this method will <b>safely</b> close and remove all
  18370. appenders in all the loggers including root contained in the
  18371. repository. The repository is looked up using
  18372. the <paramref name="repositoryAssembly"/> specified.
  18373. </para>
  18374. <para>
  18375. Some appenders need to be closed before the application exists.
  18376. Otherwise, pending logging events might be lost.
  18377. </para>
  18378. <para>
  18379. The <c>shutdown</c> method is careful to close nested
  18380. appenders before closing regular appenders. This is allows
  18381. configurations where a regular appender is attached to a logger
  18382. and again to a nested appender.
  18383. </para>
  18384. </remarks>
  18385. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18386. </member>
  18387. <member name="M:log4net.LogManager.ResetConfiguration(System.String)">
  18388. <summary>
  18389. Resets all values contained in this repository instance to their defaults.
  18390. </summary>
  18391. <remarks>
  18392. <para>
  18393. Reset all values contained in the repository instance to their
  18394. defaults. This removes all appenders from all loggers, sets
  18395. the level of all non-root loggers to <c>null</c>,
  18396. sets their additivity flag to <c>true</c> and sets the level
  18397. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  18398. message disabling is set to its default "off" value.
  18399. </para>
  18400. </remarks>
  18401. <param name="repository">The repository to reset.</param>
  18402. </member>
  18403. <member name="M:log4net.LogManager.ResetConfiguration(System.Reflection.Assembly)">
  18404. <summary>
  18405. Resets all values contained in this repository instance to their defaults.
  18406. </summary>
  18407. <remarks>
  18408. <para>
  18409. Reset all values contained in the repository instance to their
  18410. defaults. This removes all appenders from all loggers, sets
  18411. the level of all non-root loggers to <c>null</c>,
  18412. sets their additivity flag to <c>true</c> and sets the level
  18413. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  18414. message disabling is set to its default "off" value.
  18415. </para>
  18416. </remarks>
  18417. <param name="repositoryAssembly">The assembly to use to lookup the repository to reset.</param>
  18418. </member>
  18419. <member name="M:log4net.LogManager.GetLoggerRepository(System.String)">
  18420. <summary>
  18421. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  18422. </summary>
  18423. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  18424. <remarks>
  18425. <para>
  18426. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  18427. by the <paramref name="repository"/> argument.
  18428. </para>
  18429. </remarks>
  18430. <param name="repository">The repository to lookup in.</param>
  18431. </member>
  18432. <member name="M:log4net.LogManager.GetLoggerRepository(System.Reflection.Assembly)">
  18433. <summary>
  18434. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  18435. </summary>
  18436. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  18437. <remarks>
  18438. <para>
  18439. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  18440. by the <paramref name="repositoryAssembly"/> argument.
  18441. </para>
  18442. </remarks>
  18443. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18444. </member>
  18445. <member name="M:log4net.LogManager.GetRepository(System.String)">
  18446. <summary>
  18447. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  18448. </summary>
  18449. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  18450. <remarks>
  18451. <para>
  18452. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  18453. by the <paramref name="repository"/> argument.
  18454. </para>
  18455. </remarks>
  18456. <param name="repository">The repository to lookup in.</param>
  18457. </member>
  18458. <member name="M:log4net.LogManager.GetRepository(System.Reflection.Assembly)">
  18459. <summary>
  18460. Returns the default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.
  18461. </summary>
  18462. <returns>The default <see cref="T:log4net.Repository.ILoggerRepository"/> instance.</returns>
  18463. <remarks>
  18464. <para>
  18465. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified
  18466. by the <paramref name="repositoryAssembly"/> argument.
  18467. </para>
  18468. </remarks>
  18469. <param name="repositoryAssembly">The assembly to use to lookup the repository.</param>
  18470. </member>
  18471. <member name="M:log4net.LogManager.CreateDomain(System.String)">
  18472. <summary>
  18473. Creates a repository with the specified name.
  18474. </summary>
  18475. <remarks>
  18476. <para>
  18477. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  18478. </para>
  18479. <para>
  18480. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  18481. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  18482. </para>
  18483. <para>
  18484. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  18485. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  18486. </para>
  18487. </remarks>
  18488. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  18489. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18490. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  18491. </member>
  18492. <member name="M:log4net.LogManager.CreateRepository(System.String)">
  18493. <summary>
  18494. Creates a repository with the specified name.
  18495. </summary>
  18496. <remarks>
  18497. <para>
  18498. Creates the default type of <see cref="T:log4net.Repository.ILoggerRepository"/> which is a
  18499. <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> object.
  18500. </para>
  18501. <para>
  18502. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  18503. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  18504. </para>
  18505. </remarks>
  18506. <param name="repository">The name of the repository, this must be unique amongst repositories.</param>
  18507. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18508. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  18509. </member>
  18510. <member name="M:log4net.LogManager.CreateDomain(System.String,System.Type)">
  18511. <summary>
  18512. Creates a repository with the specified name and repository type.
  18513. </summary>
  18514. <remarks>
  18515. <para>
  18516. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  18517. </para>
  18518. <para>
  18519. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  18520. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  18521. </para>
  18522. </remarks>
  18523. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  18524. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  18525. and has a no arg constructor. An instance of this type will be created to act
  18526. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  18527. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18528. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  18529. </member>
  18530. <member name="M:log4net.LogManager.CreateRepository(System.String,System.Type)">
  18531. <summary>
  18532. Creates a repository with the specified name and repository type.
  18533. </summary>
  18534. <remarks>
  18535. <para>
  18536. The <paramref name="repository"/> name must be unique. Repositories cannot be redefined.
  18537. An <see cref="T:System.Exception"/> will be thrown if the repository already exists.
  18538. </para>
  18539. </remarks>
  18540. <param name="repository">The name of the repository, this must be unique to the repository.</param>
  18541. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  18542. and has a no arg constructor. An instance of this type will be created to act
  18543. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  18544. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18545. <exception cref="T:log4net.Core.LogException">The specified repository already exists.</exception>
  18546. </member>
  18547. <member name="M:log4net.LogManager.CreateDomain(System.Reflection.Assembly,System.Type)">
  18548. <summary>
  18549. Creates a repository for the specified assembly and repository type.
  18550. </summary>
  18551. <remarks>
  18552. <para>
  18553. <b>CreateDomain is obsolete. Use CreateRepository instead of CreateDomain.</b>
  18554. </para>
  18555. <para>
  18556. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  18557. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  18558. same assembly specified will return the same repository instance.
  18559. </para>
  18560. </remarks>
  18561. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  18562. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  18563. and has a no arg constructor. An instance of this type will be created to act
  18564. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  18565. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18566. </member>
  18567. <member name="M:log4net.LogManager.CreateRepository(System.Reflection.Assembly,System.Type)">
  18568. <summary>
  18569. Creates a repository for the specified assembly and repository type.
  18570. </summary>
  18571. <remarks>
  18572. <para>
  18573. The <see cref="T:log4net.Repository.ILoggerRepository"/> created will be associated with the repository
  18574. specified such that a call to <see cref="M:GetRepository(Assembly)"/> with the
  18575. same assembly specified will return the same repository instance.
  18576. </para>
  18577. </remarks>
  18578. <param name="repositoryAssembly">The assembly to use to get the name of the repository.</param>
  18579. <param name="repositoryType">A <see cref="T:System.Type"/> that implements <see cref="T:log4net.Repository.ILoggerRepository"/>
  18580. and has a no arg constructor. An instance of this type will be created to act
  18581. as the <see cref="T:log4net.Repository.ILoggerRepository"/> for the repository specified.</param>
  18582. <returns>The <see cref="T:log4net.Repository.ILoggerRepository"/> created for the repository.</returns>
  18583. </member>
  18584. <member name="M:log4net.LogManager.GetAllRepositories">
  18585. <summary>
  18586. Gets the list of currently defined repositories.
  18587. </summary>
  18588. <remarks>
  18589. <para>
  18590. Get an array of all the <see cref="T:log4net.Repository.ILoggerRepository"/> objects that have been created.
  18591. </para>
  18592. </remarks>
  18593. <returns>An array of all the known <see cref="T:log4net.Repository.ILoggerRepository"/> objects.</returns>
  18594. </member>
  18595. <member name="M:log4net.LogManager.Flush(System.Int32)">
  18596. <summary>
  18597. Flushes logging events buffered in all configured appenders in the default repository.
  18598. </summary>
  18599. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed.</param>
  18600. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  18601. </member>
  18602. <member name="M:log4net.LogManager.WrapLogger(log4net.Core.ILogger)">
  18603. <summary>
  18604. Looks up the wrapper object for the logger specified.
  18605. </summary>
  18606. <param name="logger">The logger to get the wrapper for.</param>
  18607. <returns>The wrapper for the logger specified.</returns>
  18608. </member>
  18609. <member name="M:log4net.LogManager.WrapLoggers(log4net.Core.ILogger[])">
  18610. <summary>
  18611. Looks up the wrapper objects for the loggers specified.
  18612. </summary>
  18613. <param name="loggers">The loggers to get the wrappers for.</param>
  18614. <returns>The wrapper objects for the loggers specified.</returns>
  18615. </member>
  18616. <member name="M:log4net.LogManager.WrapperCreationHandler(log4net.Core.ILogger)">
  18617. <summary>
  18618. Create the <see cref="T:log4net.Core.ILoggerWrapper"/> objects used by
  18619. this manager.
  18620. </summary>
  18621. <param name="logger">The logger to wrap.</param>
  18622. <returns>The wrapper for the logger specified.</returns>
  18623. </member>
  18624. <member name="F:log4net.LogManager.s_wrapperMap">
  18625. <summary>
  18626. The wrapper map to use to hold the <see cref="T:log4net.Core.LogImpl"/> objects.
  18627. </summary>
  18628. </member>
  18629. <member name="T:log4net.MDC">
  18630. <summary>
  18631. Implementation of Mapped Diagnostic Contexts.
  18632. </summary>
  18633. <remarks>
  18634. <note>
  18635. <para>
  18636. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18637. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18638. </para>
  18639. </note>
  18640. <para>
  18641. The MDC class is similar to the <see cref="T:log4net.NDC"/> class except that it is
  18642. based on a map instead of a stack. It provides <i>mapped
  18643. diagnostic contexts</i>. A <i>Mapped Diagnostic Context</i>, or
  18644. MDC in short, is an instrument for distinguishing interleaved log
  18645. output from different sources. Log output is typically interleaved
  18646. when a server handles multiple clients near-simultaneously.
  18647. </para>
  18648. <para>
  18649. The MDC is managed on a per thread basis.
  18650. </para>
  18651. </remarks>
  18652. <threadsafety static="true" instance="true" />
  18653. <author>Nicko Cadell</author>
  18654. <author>Gert Driesen</author>
  18655. </member>
  18656. <member name="M:log4net.MDC.#ctor">
  18657. <summary>
  18658. Initializes a new instance of the <see cref="T:log4net.MDC" /> class.
  18659. </summary>
  18660. <remarks>
  18661. Uses a private access modifier to prevent instantiation of this class.
  18662. </remarks>
  18663. </member>
  18664. <member name="M:log4net.MDC.Get(System.String)">
  18665. <summary>
  18666. Gets the context value identified by the <paramref name="key" /> parameter.
  18667. </summary>
  18668. <param name="key">The key to lookup in the MDC.</param>
  18669. <returns>The string value held for the key, or a <c>null</c> reference if no corresponding value is found.</returns>
  18670. <remarks>
  18671. <note>
  18672. <para>
  18673. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18674. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18675. </para>
  18676. </note>
  18677. <para>
  18678. If the <paramref name="key" /> parameter does not look up to a
  18679. previously defined context then <c>null</c> will be returned.
  18680. </para>
  18681. </remarks>
  18682. </member>
  18683. <member name="M:log4net.MDC.Set(System.String,System.String)">
  18684. <summary>
  18685. Add an entry to the MDC
  18686. </summary>
  18687. <param name="key">The key to store the value under.</param>
  18688. <param name="value">The value to store.</param>
  18689. <remarks>
  18690. <note>
  18691. <para>
  18692. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18693. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18694. </para>
  18695. </note>
  18696. <para>
  18697. Puts a context value (the <paramref name="value" /> parameter) as identified
  18698. with the <paramref name="key" /> parameter into the current thread's
  18699. context map.
  18700. </para>
  18701. <para>
  18702. If a value is already defined for the <paramref name="key" />
  18703. specified then the value will be replaced. If the <paramref name="value" />
  18704. is specified as <c>null</c> then the key value mapping will be removed.
  18705. </para>
  18706. </remarks>
  18707. </member>
  18708. <member name="M:log4net.MDC.Remove(System.String)">
  18709. <summary>
  18710. Removes the key value mapping for the key specified.
  18711. </summary>
  18712. <param name="key">The key to remove.</param>
  18713. <remarks>
  18714. <note>
  18715. <para>
  18716. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18717. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18718. </para>
  18719. </note>
  18720. <para>
  18721. Remove the specified entry from this thread's MDC
  18722. </para>
  18723. </remarks>
  18724. </member>
  18725. <member name="M:log4net.MDC.Clear">
  18726. <summary>
  18727. Clear all entries in the MDC
  18728. </summary>
  18729. <remarks>
  18730. <note>
  18731. <para>
  18732. The MDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Properties"/>.
  18733. The current MDC implementation forwards to the <c>ThreadContext.Properties</c>.
  18734. </para>
  18735. </note>
  18736. <para>
  18737. Remove all the entries from this thread's MDC
  18738. </para>
  18739. </remarks>
  18740. </member>
  18741. <member name="T:log4net.NDC">
  18742. <summary>
  18743. Implementation of Nested Diagnostic Contexts.
  18744. </summary>
  18745. <remarks>
  18746. <note>
  18747. <para>
  18748. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18749. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18750. </para>
  18751. </note>
  18752. <para>
  18753. A Nested Diagnostic Context, or NDC in short, is an instrument
  18754. to distinguish interleaved log output from different sources. Log
  18755. output is typically interleaved when a server handles multiple
  18756. clients near-simultaneously.
  18757. </para>
  18758. <para>
  18759. Interleaved log output can still be meaningful if each log entry
  18760. from different contexts had a distinctive stamp. This is where NDCs
  18761. come into play.
  18762. </para>
  18763. <para>
  18764. Note that NDCs are managed on a per thread basis. The NDC class
  18765. is made up of static methods that operate on the context of the
  18766. calling thread.
  18767. </para>
  18768. </remarks>
  18769. <example>How to push a message into the context
  18770. <code lang="C#">
  18771. using(NDC.Push("my context message"))
  18772. {
  18773. ... all log calls will have 'my context message' included ...
  18774. } // at the end of the using block the message is automatically removed
  18775. </code>
  18776. </example>
  18777. <threadsafety static="true" instance="true" />
  18778. <author>Nicko Cadell</author>
  18779. <author>Gert Driesen</author>
  18780. </member>
  18781. <member name="M:log4net.NDC.#ctor">
  18782. <summary>
  18783. Initializes a new instance of the <see cref="T:log4net.NDC" /> class.
  18784. </summary>
  18785. <remarks>
  18786. Uses a private access modifier to prevent instantiation of this class.
  18787. </remarks>
  18788. </member>
  18789. <member name="P:log4net.NDC.Depth">
  18790. <summary>
  18791. Gets the current context depth.
  18792. </summary>
  18793. <value>The current context depth.</value>
  18794. <remarks>
  18795. <note>
  18796. <para>
  18797. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18798. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18799. </para>
  18800. </note>
  18801. <para>
  18802. The number of context values pushed onto the context stack.
  18803. </para>
  18804. <para>
  18805. Used to record the current depth of the context. This can then
  18806. be restored using the <see cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/> method.
  18807. </para>
  18808. </remarks>
  18809. <seealso cref="M:log4net.NDC.SetMaxDepth(System.Int32)"/>
  18810. </member>
  18811. <member name="M:log4net.NDC.Clear">
  18812. <summary>
  18813. Clears all the contextual information held on the current thread.
  18814. </summary>
  18815. <remarks>
  18816. <note>
  18817. <para>
  18818. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18819. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18820. </para>
  18821. </note>
  18822. <para>
  18823. Clears the stack of NDC data held on the current thread.
  18824. </para>
  18825. </remarks>
  18826. </member>
  18827. <member name="M:log4net.NDC.CloneStack">
  18828. <summary>
  18829. Creates a clone of the stack of context information.
  18830. </summary>
  18831. <returns>A clone of the context info for this thread.</returns>
  18832. <remarks>
  18833. <note>
  18834. <para>
  18835. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18836. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18837. </para>
  18838. </note>
  18839. <para>
  18840. The results of this method can be passed to the <see cref="M:log4net.NDC.Inherit(System.Collections.Stack)"/>
  18841. method to allow child threads to inherit the context of their
  18842. parent thread.
  18843. </para>
  18844. </remarks>
  18845. </member>
  18846. <member name="M:log4net.NDC.Inherit(System.Collections.Stack)">
  18847. <summary>
  18848. Inherits the contextual information from another thread.
  18849. </summary>
  18850. <param name="stack">The context stack to inherit.</param>
  18851. <remarks>
  18852. <note>
  18853. <para>
  18854. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18855. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18856. </para>
  18857. </note>
  18858. <para>
  18859. This thread will use the context information from the stack
  18860. supplied. This can be used to initialize child threads with
  18861. the same contextual information as their parent threads. These
  18862. contexts will <b>NOT</b> be shared. Any further contexts that
  18863. are pushed onto the stack will not be visible to the other.
  18864. Call <see cref="M:log4net.NDC.CloneStack"/> to obtain a stack to pass to
  18865. this method.
  18866. </para>
  18867. </remarks>
  18868. </member>
  18869. <member name="M:log4net.NDC.Pop">
  18870. <summary>
  18871. Removes the top context from the stack.
  18872. </summary>
  18873. <returns>
  18874. The message in the context that was removed from the top
  18875. of the stack.
  18876. </returns>
  18877. <remarks>
  18878. <note>
  18879. <para>
  18880. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18881. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18882. </para>
  18883. </note>
  18884. <para>
  18885. Remove the top context from the stack, and return
  18886. it to the caller. If the stack is empty then an
  18887. empty string (not <c>null</c>) is returned.
  18888. </para>
  18889. </remarks>
  18890. </member>
  18891. <member name="M:log4net.NDC.Push(System.String)">
  18892. <summary>
  18893. Pushes a new context message.
  18894. </summary>
  18895. <param name="message">The new context message.</param>
  18896. <returns>
  18897. An <see cref="T:System.IDisposable"/> that can be used to clean up
  18898. the context stack.
  18899. </returns>
  18900. <remarks>
  18901. <note>
  18902. <para>
  18903. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18904. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18905. </para>
  18906. </note>
  18907. <para>
  18908. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  18909. is returned that can be used to clean up the context stack. This
  18910. can be easily combined with the <c>using</c> keyword to scope the
  18911. context.
  18912. </para>
  18913. </remarks>
  18914. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  18915. <code lang="C#">
  18916. using(log4net.NDC.Push("NDC_Message"))
  18917. {
  18918. log.Warn("This should have an NDC message");
  18919. }
  18920. </code>
  18921. </example>
  18922. </member>
  18923. <member name="M:log4net.NDC.PushFormat(System.String,System.Object[])">
  18924. <summary>
  18925. Pushes a new context message.
  18926. </summary>
  18927. <param name="messageFormat">The new context message string format.</param>
  18928. <param name="args">Arguments to be passed into messageFormat.</param>
  18929. <returns>
  18930. An <see cref="T:System.IDisposable"/> that can be used to clean up
  18931. the context stack.
  18932. </returns>
  18933. <remarks>
  18934. <note>
  18935. <para>
  18936. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18937. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18938. </para>
  18939. </note>
  18940. <para>
  18941. Pushes a new context onto the context stack. An <see cref="T:System.IDisposable"/>
  18942. is returned that can be used to clean up the context stack. This
  18943. can be easily combined with the <c>using</c> keyword to scope the
  18944. context.
  18945. </para>
  18946. </remarks>
  18947. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  18948. <code lang="C#">
  18949. var someValue = "ExampleContext"
  18950. using(log4net.NDC.PushFormat("NDC_Message {0}", someValue))
  18951. {
  18952. log.Warn("This should have an NDC message");
  18953. }
  18954. </code>
  18955. </example>
  18956. </member>
  18957. <member name="M:log4net.NDC.Remove">
  18958. <summary>
  18959. Removes the context information for this thread. It is
  18960. not required to call this method.
  18961. </summary>
  18962. <remarks>
  18963. <note>
  18964. <para>
  18965. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18966. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18967. </para>
  18968. </note>
  18969. <para>
  18970. This method is not implemented.
  18971. </para>
  18972. </remarks>
  18973. </member>
  18974. <member name="M:log4net.NDC.SetMaxDepth(System.Int32)">
  18975. <summary>
  18976. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  18977. </summary>
  18978. <param name="maxDepth">The maximum depth of the stack</param>
  18979. <remarks>
  18980. <note>
  18981. <para>
  18982. The NDC is deprecated and has been replaced by the <see cref="P:log4net.ThreadContext.Stacks"/>.
  18983. The current NDC implementation forwards to the <c>ThreadContext.Stacks["NDC"]</c>.
  18984. </para>
  18985. </note>
  18986. <para>
  18987. Forces the stack depth to be at most <paramref name="maxDepth"/>.
  18988. This may truncate the head of the stack. This only affects the
  18989. stack in the current thread. Also it does not prevent it from
  18990. growing, it only sets the maximum depth at the time of the
  18991. call. This can be used to return to a known context depth.
  18992. </para>
  18993. </remarks>
  18994. </member>
  18995. <member name="T:log4net.ObjectRenderer.DefaultRenderer">
  18996. <summary>
  18997. The default object Renderer.
  18998. </summary>
  18999. <remarks>
  19000. <para>
  19001. The default renderer supports rendering objects and collections to strings.
  19002. </para>
  19003. <para>
  19004. See the <see cref="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)"/> method for details of the output.
  19005. </para>
  19006. </remarks>
  19007. <author>Nicko Cadell</author>
  19008. <author>Gert Driesen</author>
  19009. </member>
  19010. <member name="M:log4net.ObjectRenderer.DefaultRenderer.#ctor">
  19011. <summary>
  19012. Default constructor
  19013. </summary>
  19014. <remarks>
  19015. <para>
  19016. Default constructor
  19017. </para>
  19018. </remarks>
  19019. </member>
  19020. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  19021. <summary>
  19022. Render the object <paramref name="obj"/> to a string
  19023. </summary>
  19024. <param name="rendererMap">The map used to lookup renderers</param>
  19025. <param name="obj">The object to render</param>
  19026. <param name="writer">The writer to render to</param>
  19027. <remarks>
  19028. <para>
  19029. Render the object <paramref name="obj"/> to a string.
  19030. </para>
  19031. <para>
  19032. The <paramref name="rendererMap"/> parameter is
  19033. provided to lookup and render other objects. This is
  19034. very useful where <paramref name="obj"/> contains
  19035. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object)"/>
  19036. method can be used to render these objects.
  19037. </para>
  19038. <para>
  19039. The default renderer supports rendering objects to strings as follows:
  19040. </para>
  19041. <list type="table">
  19042. <listheader>
  19043. <term>Value</term>
  19044. <description>Rendered String</description>
  19045. </listheader>
  19046. <item>
  19047. <term><c>null</c></term>
  19048. <description>
  19049. <para>"(null)"</para>
  19050. </description>
  19051. </item>
  19052. <item>
  19053. <term><see cref="T:System.Array"/></term>
  19054. <description>
  19055. <para>
  19056. For a one dimensional array this is the
  19057. array type name, an open brace, followed by a comma
  19058. separated list of the elements (using the appropriate
  19059. renderer), followed by a close brace.
  19060. </para>
  19061. <para>
  19062. For example: <c>int[] {1, 2, 3}</c>.
  19063. </para>
  19064. <para>
  19065. If the array is not one dimensional the
  19066. <c>Array.ToString()</c> is returned.
  19067. </para>
  19068. </description>
  19069. </item>
  19070. <item>
  19071. <term><see cref="T:System.Collections.IEnumerable"/>, <see cref="T:System.Collections.ICollection"/> &amp; <see cref="T:System.Collections.IEnumerator"/></term>
  19072. <description>
  19073. <para>
  19074. Rendered as an open brace, followed by a comma
  19075. separated list of the elements (using the appropriate
  19076. renderer), followed by a close brace.
  19077. </para>
  19078. <para>
  19079. For example: <c>{a, b, c}</c>.
  19080. </para>
  19081. <para>
  19082. All collection classes that implement <see cref="T:System.Collections.ICollection"/> its subclasses,
  19083. or generic equivalents all implement the <see cref="T:System.Collections.IEnumerable"/> interface.
  19084. </para>
  19085. </description>
  19086. </item>
  19087. <item>
  19088. <term><see cref="T:System.Collections.DictionaryEntry"/></term>
  19089. <description>
  19090. <para>
  19091. Rendered as the key, an equals sign ('='), and the value (using the appropriate
  19092. renderer).
  19093. </para>
  19094. <para>
  19095. For example: <c>key=value</c>.
  19096. </para>
  19097. </description>
  19098. </item>
  19099. <item>
  19100. <term>other</term>
  19101. <description>
  19102. <para><c>Object.ToString()</c></para>
  19103. </description>
  19104. </item>
  19105. </list>
  19106. </remarks>
  19107. </member>
  19108. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderArray(log4net.ObjectRenderer.RendererMap,System.Array,System.IO.TextWriter)">
  19109. <summary>
  19110. Render the array argument into a string
  19111. </summary>
  19112. <param name="rendererMap">The map used to lookup renderers</param>
  19113. <param name="array">the array to render</param>
  19114. <param name="writer">The writer to render to</param>
  19115. <remarks>
  19116. <para>
  19117. For a one dimensional array this is the
  19118. array type name, an open brace, followed by a comma
  19119. separated list of the elements (using the appropriate
  19120. renderer), followed by a close brace. For example:
  19121. <c>int[] {1, 2, 3}</c>.
  19122. </para>
  19123. <para>
  19124. If the array is not one dimensional the
  19125. <c>Array.ToString()</c> is returned.
  19126. </para>
  19127. </remarks>
  19128. </member>
  19129. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderEnumerator(log4net.ObjectRenderer.RendererMap,System.Collections.IEnumerator,System.IO.TextWriter)">
  19130. <summary>
  19131. Render the enumerator argument into a string
  19132. </summary>
  19133. <param name="rendererMap">The map used to lookup renderers</param>
  19134. <param name="enumerator">the enumerator to render</param>
  19135. <param name="writer">The writer to render to</param>
  19136. <remarks>
  19137. <para>
  19138. Rendered as an open brace, followed by a comma
  19139. separated list of the elements (using the appropriate
  19140. renderer), followed by a close brace. For example:
  19141. <c>{a, b, c}</c>.
  19142. </para>
  19143. </remarks>
  19144. </member>
  19145. <member name="M:log4net.ObjectRenderer.DefaultRenderer.RenderDictionaryEntry(log4net.ObjectRenderer.RendererMap,System.Collections.DictionaryEntry,System.IO.TextWriter)">
  19146. <summary>
  19147. Render the DictionaryEntry argument into a string
  19148. </summary>
  19149. <param name="rendererMap">The map used to lookup renderers</param>
  19150. <param name="entry">the DictionaryEntry to render</param>
  19151. <param name="writer">The writer to render to</param>
  19152. <remarks>
  19153. <para>
  19154. Render the key, an equals sign ('='), and the value (using the appropriate
  19155. renderer). For example: <c>key=value</c>.
  19156. </para>
  19157. </remarks>
  19158. </member>
  19159. <member name="T:log4net.ObjectRenderer.IObjectRenderer">
  19160. <summary>
  19161. Implement this interface in order to render objects as strings
  19162. </summary>
  19163. <remarks>
  19164. <para>
  19165. Certain types require special case conversion to
  19166. string form. This conversion is done by an object renderer.
  19167. Object renderers implement the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>
  19168. interface.
  19169. </para>
  19170. </remarks>
  19171. <author>Nicko Cadell</author>
  19172. <author>Gert Driesen</author>
  19173. </member>
  19174. <member name="M:log4net.ObjectRenderer.IObjectRenderer.RenderObject(log4net.ObjectRenderer.RendererMap,System.Object,System.IO.TextWriter)">
  19175. <summary>
  19176. Render the object <paramref name="obj"/> to a string
  19177. </summary>
  19178. <param name="rendererMap">The map used to lookup renderers</param>
  19179. <param name="obj">The object to render</param>
  19180. <param name="writer">The writer to render to</param>
  19181. <remarks>
  19182. <para>
  19183. Render the object <paramref name="obj"/> to a
  19184. string.
  19185. </para>
  19186. <para>
  19187. The <paramref name="rendererMap"/> parameter is
  19188. provided to lookup and render other objects. This is
  19189. very useful where <paramref name="obj"/> contains
  19190. nested objects of unknown type. The <see cref="M:RendererMap.FindAndRender(object, TextWriter)"/>
  19191. method can be used to render these objects.
  19192. </para>
  19193. </remarks>
  19194. </member>
  19195. <member name="T:log4net.ObjectRenderer.RendererMap">
  19196. <summary>
  19197. Map class objects to an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  19198. </summary>
  19199. <remarks>
  19200. <para>
  19201. Maintains a mapping between types that require special
  19202. rendering and the <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> that
  19203. is used to render them.
  19204. </para>
  19205. <para>
  19206. The <see cref="M:FindAndRender(object)"/> method is used to render an
  19207. <c>object</c> using the appropriate renderers defined in this map.
  19208. </para>
  19209. </remarks>
  19210. <author>Nicko Cadell</author>
  19211. <author>Gert Driesen</author>
  19212. </member>
  19213. <member name="M:log4net.ObjectRenderer.RendererMap.#ctor">
  19214. <summary>
  19215. Default Constructor
  19216. </summary>
  19217. <remarks>
  19218. <para>
  19219. Default constructor.
  19220. </para>
  19221. </remarks>
  19222. </member>
  19223. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object)">
  19224. <summary>
  19225. Render <paramref name="obj"/> using the appropriate renderer.
  19226. </summary>
  19227. <param name="obj">the object to render to a string</param>
  19228. <returns>the object rendered as a string</returns>
  19229. <remarks>
  19230. <para>
  19231. This is a convenience method used to render an object to a string.
  19232. The alternative method <see cref="M:FindAndRender(object,TextWriter)"/>
  19233. should be used when streaming output to a <see cref="T:System.IO.TextWriter"/>.
  19234. </para>
  19235. </remarks>
  19236. </member>
  19237. <member name="M:log4net.ObjectRenderer.RendererMap.FindAndRender(System.Object,System.IO.TextWriter)">
  19238. <summary>
  19239. Render <paramref name="obj"/> using the appropriate renderer.
  19240. </summary>
  19241. <param name="obj">the object to render to a string</param>
  19242. <param name="writer">The writer to render to</param>
  19243. <remarks>
  19244. <para>
  19245. Find the appropriate renderer for the type of the
  19246. <paramref name="obj"/> parameter. This is accomplished by calling the
  19247. <see cref="M:Get(Type)"/> method. Once a renderer is found, it is
  19248. applied on the object <paramref name="obj"/> and the result is returned
  19249. as a <see cref="T:System.String"/>.
  19250. </para>
  19251. </remarks>
  19252. </member>
  19253. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Object)">
  19254. <summary>
  19255. Gets the renderer for the specified object type
  19256. </summary>
  19257. <param name="obj">the object to lookup the renderer for</param>
  19258. <returns>the renderer for <paramref name="obj"/></returns>
  19259. <remarks>
  19260. <param>
  19261. Gets the renderer for the specified object type.
  19262. </param>
  19263. <param>
  19264. Syntactic sugar method that calls <see cref="M:Get(Type)"/>
  19265. with the type of the object parameter.
  19266. </param>
  19267. </remarks>
  19268. </member>
  19269. <member name="M:log4net.ObjectRenderer.RendererMap.Get(System.Type)">
  19270. <summary>
  19271. Gets the renderer for the specified type
  19272. </summary>
  19273. <param name="type">the type to lookup the renderer for</param>
  19274. <returns>the renderer for the specified type</returns>
  19275. <remarks>
  19276. <para>
  19277. Returns the renderer for the specified type.
  19278. If no specific renderer has been defined the
  19279. <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/> will be returned.
  19280. </para>
  19281. </remarks>
  19282. </member>
  19283. <member name="M:log4net.ObjectRenderer.RendererMap.SearchTypeAndInterfaces(System.Type)">
  19284. <summary>
  19285. Internal function to recursively search interfaces
  19286. </summary>
  19287. <param name="type">the type to lookup the renderer for</param>
  19288. <returns>the renderer for the specified type</returns>
  19289. </member>
  19290. <member name="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer">
  19291. <summary>
  19292. Get the default renderer instance
  19293. </summary>
  19294. <value>the default renderer</value>
  19295. <remarks>
  19296. <para>
  19297. Get the default renderer
  19298. </para>
  19299. </remarks>
  19300. </member>
  19301. <member name="M:log4net.ObjectRenderer.RendererMap.Clear">
  19302. <summary>
  19303. Clear the map of renderers
  19304. </summary>
  19305. <remarks>
  19306. <para>
  19307. Clear the custom renderers defined by using
  19308. <see cref="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)"/>. The <see cref="P:log4net.ObjectRenderer.RendererMap.DefaultRenderer"/>
  19309. cannot be removed.
  19310. </para>
  19311. </remarks>
  19312. </member>
  19313. <member name="M:log4net.ObjectRenderer.RendererMap.Put(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  19314. <summary>
  19315. Register an <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> for <paramref name="typeToRender"/>.
  19316. </summary>
  19317. <param name="typeToRender">the type that will be rendered by <paramref name="renderer"/></param>
  19318. <param name="renderer">the renderer for <paramref name="typeToRender"/></param>
  19319. <remarks>
  19320. <para>
  19321. Register an object renderer for a specific source type.
  19322. This renderer will be returned from a call to <see cref="M:Get(Type)"/>
  19323. specifying the same <paramref name="typeToRender"/> as an argument.
  19324. </para>
  19325. </remarks>
  19326. </member>
  19327. <member name="T:log4net.Plugin.IPlugin">
  19328. <summary>
  19329. Interface implemented by logger repository plugins.
  19330. </summary>
  19331. <remarks>
  19332. <para>
  19333. Plugins define additional behavior that can be associated
  19334. with a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  19335. The <see cref="T:log4net.Plugin.PluginMap"/> held by the <see cref="P:log4net.Repository.ILoggerRepository.PluginMap"/>
  19336. property is used to store the plugins for a repository.
  19337. </para>
  19338. <para>
  19339. The <c>log4net.Config.PluginAttribute</c> can be used to
  19340. attach plugins to repositories created using configuration
  19341. attributes.
  19342. </para>
  19343. </remarks>
  19344. <author>Nicko Cadell</author>
  19345. <author>Gert Driesen</author>
  19346. </member>
  19347. <member name="P:log4net.Plugin.IPlugin.Name">
  19348. <summary>
  19349. Gets the name of the plugin.
  19350. </summary>
  19351. <value>
  19352. The name of the plugin.
  19353. </value>
  19354. <remarks>
  19355. <para>
  19356. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  19357. keyed by name. Each plugin instance attached to a
  19358. repository must be a unique name.
  19359. </para>
  19360. </remarks>
  19361. </member>
  19362. <member name="M:log4net.Plugin.IPlugin.Attach(log4net.Repository.ILoggerRepository)">
  19363. <summary>
  19364. Attaches the plugin to the specified <see cref="T:log4net.Repository.ILoggerRepository"/>.
  19365. </summary>
  19366. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  19367. <remarks>
  19368. <para>
  19369. A plugin may only be attached to a single repository.
  19370. </para>
  19371. <para>
  19372. This method is called when the plugin is attached to the repository.
  19373. </para>
  19374. </remarks>
  19375. </member>
  19376. <member name="M:log4net.Plugin.IPlugin.Shutdown">
  19377. <summary>
  19378. Is called when the plugin is to shutdown.
  19379. </summary>
  19380. <remarks>
  19381. <para>
  19382. This method is called to notify the plugin that
  19383. it should stop operating and should detach from
  19384. the repository.
  19385. </para>
  19386. </remarks>
  19387. </member>
  19388. <member name="T:log4net.Plugin.IPluginFactory">
  19389. <summary>
  19390. Interface used to create plugins.
  19391. </summary>
  19392. <remarks>
  19393. <para>
  19394. Interface used to create a plugin.
  19395. </para>
  19396. </remarks>
  19397. <author>Nicko Cadell</author>
  19398. <author>Gert Driesen</author>
  19399. </member>
  19400. <member name="M:log4net.Plugin.IPluginFactory.CreatePlugin">
  19401. <summary>
  19402. Creates the plugin object.
  19403. </summary>
  19404. <returns>the new plugin instance</returns>
  19405. <remarks>
  19406. <para>
  19407. Create and return a new plugin instance.
  19408. </para>
  19409. </remarks>
  19410. </member>
  19411. <member name="T:log4net.Plugin.PluginCollection">
  19412. <summary>
  19413. A strongly-typed collection of <see cref="T:log4net.Plugin.IPlugin"/> objects.
  19414. </summary>
  19415. <author>Nicko Cadell</author>
  19416. </member>
  19417. <member name="T:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator">
  19418. <summary>
  19419. Supports type-safe iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  19420. </summary>
  19421. <exclude/>
  19422. </member>
  19423. <member name="P:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Current">
  19424. <summary>
  19425. Gets the current element in the collection.
  19426. </summary>
  19427. </member>
  19428. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.MoveNext">
  19429. <summary>
  19430. Advances the enumerator to the next element in the collection.
  19431. </summary>
  19432. <returns>
  19433. <c>true</c> if the enumerator was successfully advanced to the next element;
  19434. <c>false</c> if the enumerator has passed the end of the collection.
  19435. </returns>
  19436. <exception cref="T:System.InvalidOperationException">
  19437. The collection was modified after the enumerator was created.
  19438. </exception>
  19439. </member>
  19440. <member name="M:log4net.Plugin.PluginCollection.IPluginCollectionEnumerator.Reset">
  19441. <summary>
  19442. Sets the enumerator to its initial position, before the first element in the collection.
  19443. </summary>
  19444. </member>
  19445. <member name="M:log4net.Plugin.PluginCollection.ReadOnly(log4net.Plugin.PluginCollection)">
  19446. <summary>
  19447. Creates a read-only wrapper for a <c>PluginCollection</c> instance.
  19448. </summary>
  19449. <param name="list">list to create a readonly wrapper arround</param>
  19450. <returns>
  19451. A <c>PluginCollection</c> wrapper that is read-only.
  19452. </returns>
  19453. </member>
  19454. <member name="M:log4net.Plugin.PluginCollection.#ctor">
  19455. <summary>
  19456. Initializes a new instance of the <c>PluginCollection</c> class
  19457. that is empty and has the default initial capacity.
  19458. </summary>
  19459. </member>
  19460. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Int32)">
  19461. <summary>
  19462. Initializes a new instance of the <c>PluginCollection</c> class
  19463. that has the specified initial capacity.
  19464. </summary>
  19465. <param name="capacity">
  19466. The number of elements that the new <c>PluginCollection</c> is initially capable of storing.
  19467. </param>
  19468. </member>
  19469. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection)">
  19470. <summary>
  19471. Initializes a new instance of the <c>PluginCollection</c> class
  19472. that contains elements copied from the specified <c>PluginCollection</c>.
  19473. </summary>
  19474. <param name="c">The <c>PluginCollection</c> whose elements are copied to the new collection.</param>
  19475. </member>
  19476. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.IPlugin[])">
  19477. <summary>
  19478. Initializes a new instance of the <c>PluginCollection</c> class
  19479. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> array.
  19480. </summary>
  19481. <param name="a">The <see cref="T:log4net.Plugin.IPlugin"/> array whose elements are copied to the new list.</param>
  19482. </member>
  19483. <member name="M:log4net.Plugin.PluginCollection.#ctor(System.Collections.ICollection)">
  19484. <summary>
  19485. Initializes a new instance of the <c>PluginCollection</c> class
  19486. that contains elements copied from the specified <see cref="T:log4net.Plugin.IPlugin"/> collection.
  19487. </summary>
  19488. <param name="col">The <see cref="T:log4net.Plugin.IPlugin"/> collection whose elements are copied to the new list.</param>
  19489. </member>
  19490. <member name="T:log4net.Plugin.PluginCollection.Tag">
  19491. <summary>
  19492. Type visible only to our subclasses
  19493. Used to access protected constructor
  19494. </summary>
  19495. <exclude/>
  19496. </member>
  19497. <member name="F:log4net.Plugin.PluginCollection.Tag.Default">
  19498. <summary>
  19499. A value
  19500. </summary>
  19501. </member>
  19502. <member name="M:log4net.Plugin.PluginCollection.#ctor(log4net.Plugin.PluginCollection.Tag)">
  19503. <summary>
  19504. Allow subclasses to avoid our default constructors
  19505. </summary>
  19506. <param name="tag"></param>
  19507. <exclude/>
  19508. </member>
  19509. <member name="P:log4net.Plugin.PluginCollection.Count">
  19510. <summary>
  19511. Gets the number of elements actually contained in the <c>PluginCollection</c>.
  19512. </summary>
  19513. </member>
  19514. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[])">
  19515. <summary>
  19516. Copies the entire <c>PluginCollection</c> to a one-dimensional
  19517. <see cref="T:log4net.Plugin.IPlugin"/> array.
  19518. </summary>
  19519. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  19520. </member>
  19521. <member name="M:log4net.Plugin.PluginCollection.CopyTo(log4net.Plugin.IPlugin[],System.Int32)">
  19522. <summary>
  19523. Copies the entire <c>PluginCollection</c> to a one-dimensional
  19524. <see cref="T:log4net.Plugin.IPlugin"/> array, starting at the specified index of the target array.
  19525. </summary>
  19526. <param name="array">The one-dimensional <see cref="T:log4net.Plugin.IPlugin"/> array to copy to.</param>
  19527. <param name="start">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  19528. </member>
  19529. <member name="P:log4net.Plugin.PluginCollection.IsSynchronized">
  19530. <summary>
  19531. Gets a value indicating whether access to the collection is synchronized (thread-safe).
  19532. </summary>
  19533. <returns>false, because the backing type is an array, which is never thread-safe.</returns>
  19534. </member>
  19535. <member name="P:log4net.Plugin.PluginCollection.SyncRoot">
  19536. <summary>
  19537. Gets an object that can be used to synchronize access to the collection.
  19538. </summary>
  19539. <value>
  19540. An object that can be used to synchronize access to the collection.
  19541. </value>
  19542. </member>
  19543. <member name="P:log4net.Plugin.PluginCollection.Item(System.Int32)">
  19544. <summary>
  19545. Gets or sets the <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  19546. </summary>
  19547. <value>
  19548. The <see cref="T:log4net.Plugin.IPlugin"/> at the specified index.
  19549. </value>
  19550. <param name="index">The zero-based index of the element to get or set.</param>
  19551. <exception cref="T:System.ArgumentOutOfRangeException">
  19552. <para><paramref name="index"/> is less than zero.</para>
  19553. <para>-or-</para>
  19554. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19555. </exception>
  19556. </member>
  19557. <member name="M:log4net.Plugin.PluginCollection.Add(log4net.Plugin.IPlugin)">
  19558. <summary>
  19559. Adds a <see cref="T:log4net.Plugin.IPlugin"/> to the end of the <c>PluginCollection</c>.
  19560. </summary>
  19561. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to be added to the end of the <c>PluginCollection</c>.</param>
  19562. <returns>The index at which the value has been added.</returns>
  19563. </member>
  19564. <member name="M:log4net.Plugin.PluginCollection.Clear">
  19565. <summary>
  19566. Removes all elements from the <c>PluginCollection</c>.
  19567. </summary>
  19568. </member>
  19569. <member name="M:log4net.Plugin.PluginCollection.Clone">
  19570. <summary>
  19571. Creates a shallow copy of the <see cref="T:log4net.Plugin.PluginCollection"/>.
  19572. </summary>
  19573. <returns>A new <see cref="T:log4net.Plugin.PluginCollection"/> with a shallow copy of the collection data.</returns>
  19574. </member>
  19575. <member name="M:log4net.Plugin.PluginCollection.Contains(log4net.Plugin.IPlugin)">
  19576. <summary>
  19577. Determines whether a given <see cref="T:log4net.Plugin.IPlugin"/> is in the <c>PluginCollection</c>.
  19578. </summary>
  19579. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to check for.</param>
  19580. <returns><c>true</c> if <paramref name="item"/> is found in the <c>PluginCollection</c>; otherwise, <c>false</c>.</returns>
  19581. </member>
  19582. <member name="M:log4net.Plugin.PluginCollection.IndexOf(log4net.Plugin.IPlugin)">
  19583. <summary>
  19584. Returns the zero-based index of the first occurrence of a <see cref="T:log4net.Plugin.IPlugin"/>
  19585. in the <c>PluginCollection</c>.
  19586. </summary>
  19587. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to locate in the <c>PluginCollection</c>.</param>
  19588. <returns>
  19589. The zero-based index of the first occurrence of <paramref name="item"/>
  19590. in the entire <c>PluginCollection</c>, if found; otherwise, -1.
  19591. </returns>
  19592. </member>
  19593. <member name="M:log4net.Plugin.PluginCollection.Insert(System.Int32,log4net.Plugin.IPlugin)">
  19594. <summary>
  19595. Inserts an element into the <c>PluginCollection</c> at the specified index.
  19596. </summary>
  19597. <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
  19598. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to insert.</param>
  19599. <exception cref="T:System.ArgumentOutOfRangeException">
  19600. <para><paramref name="index"/> is less than zero</para>
  19601. <para>-or-</para>
  19602. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19603. </exception>
  19604. </member>
  19605. <member name="M:log4net.Plugin.PluginCollection.Remove(log4net.Plugin.IPlugin)">
  19606. <summary>
  19607. Removes the first occurrence of a specific <see cref="T:log4net.Plugin.IPlugin"/> from the <c>PluginCollection</c>.
  19608. </summary>
  19609. <param name="item">The <see cref="T:log4net.Plugin.IPlugin"/> to remove from the <c>PluginCollection</c>.</param>
  19610. <exception cref="T:System.ArgumentException">
  19611. The specified <see cref="T:log4net.Plugin.IPlugin"/> was not found in the <c>PluginCollection</c>.
  19612. </exception>
  19613. </member>
  19614. <member name="M:log4net.Plugin.PluginCollection.RemoveAt(System.Int32)">
  19615. <summary>
  19616. Removes the element at the specified index of the <c>PluginCollection</c>.
  19617. </summary>
  19618. <param name="index">The zero-based index of the element to remove.</param>
  19619. <exception cref="T:System.ArgumentOutOfRangeException">
  19620. <para><paramref name="index"/> is less than zero.</para>
  19621. <para>-or-</para>
  19622. <para><paramref name="index"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19623. </exception>
  19624. </member>
  19625. <member name="P:log4net.Plugin.PluginCollection.IsFixedSize">
  19626. <summary>
  19627. Gets a value indicating whether the collection has a fixed size.
  19628. </summary>
  19629. <value><c>true</c> if the collection has a fixed size; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  19630. </member>
  19631. <member name="P:log4net.Plugin.PluginCollection.IsReadOnly">
  19632. <summary>
  19633. Gets a value indicating whether the IList is read-only.
  19634. </summary>
  19635. <value><c>true</c> if the collection is read-only; otherwise, <c>false</c>. The default is <c>false</c>.</value>
  19636. </member>
  19637. <member name="M:log4net.Plugin.PluginCollection.GetEnumerator">
  19638. <summary>
  19639. Returns an enumerator that can iterate through the <c>PluginCollection</c>.
  19640. </summary>
  19641. <returns>An <see cref="T:log4net.Plugin.PluginCollection.Enumerator"/> for the entire <c>PluginCollection</c>.</returns>
  19642. </member>
  19643. <member name="P:log4net.Plugin.PluginCollection.Capacity">
  19644. <summary>
  19645. Gets or sets the number of elements the <c>PluginCollection</c> can contain.
  19646. </summary>
  19647. <value>
  19648. The number of elements the <c>PluginCollection</c> can contain.
  19649. </value>
  19650. </member>
  19651. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.PluginCollection)">
  19652. <summary>
  19653. Adds the elements of another <c>PluginCollection</c> to the current <c>PluginCollection</c>.
  19654. </summary>
  19655. <param name="x">The <c>PluginCollection</c> whose elements should be added to the end of the current <c>PluginCollection</c>.</param>
  19656. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  19657. </member>
  19658. <member name="M:log4net.Plugin.PluginCollection.AddRange(log4net.Plugin.IPlugin[])">
  19659. <summary>
  19660. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> array to the current <c>PluginCollection</c>.
  19661. </summary>
  19662. <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>
  19663. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  19664. </member>
  19665. <member name="M:log4net.Plugin.PluginCollection.AddRange(System.Collections.ICollection)">
  19666. <summary>
  19667. Adds the elements of a <see cref="T:log4net.Plugin.IPlugin"/> collection to the current <c>PluginCollection</c>.
  19668. </summary>
  19669. <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>
  19670. <returns>The new <see cref="P:log4net.Plugin.PluginCollection.Count"/> of the <c>PluginCollection</c>.</returns>
  19671. </member>
  19672. <member name="M:log4net.Plugin.PluginCollection.TrimToSize">
  19673. <summary>
  19674. Sets the capacity to the actual number of elements.
  19675. </summary>
  19676. </member>
  19677. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32)">
  19678. <exception cref="T:System.ArgumentOutOfRangeException">
  19679. <para><paramref name="i"/> is less than zero.</para>
  19680. <para>-or-</para>
  19681. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19682. </exception>
  19683. </member>
  19684. <member name="M:log4net.Plugin.PluginCollection.ValidateIndex(System.Int32,System.Boolean)">
  19685. <exception cref="T:System.ArgumentOutOfRangeException">
  19686. <para><paramref name="i"/> is less than zero.</para>
  19687. <para>-or-</para>
  19688. <para><paramref name="i"/> is equal to or greater than <see cref="P:log4net.Plugin.PluginCollection.Count"/>.</para>
  19689. </exception>
  19690. </member>
  19691. <member name="T:log4net.Plugin.PluginCollection.Enumerator">
  19692. <summary>
  19693. Supports simple iteration over a <see cref="T:log4net.Plugin.PluginCollection"/>.
  19694. </summary>
  19695. <exclude/>
  19696. </member>
  19697. <member name="M:log4net.Plugin.PluginCollection.Enumerator.#ctor(log4net.Plugin.PluginCollection)">
  19698. <summary>
  19699. Initializes a new instance of the <c>Enumerator</c> class.
  19700. </summary>
  19701. <param name="tc"></param>
  19702. </member>
  19703. <member name="P:log4net.Plugin.PluginCollection.Enumerator.Current">
  19704. <summary>
  19705. Gets the current element in the collection.
  19706. </summary>
  19707. <value>
  19708. The current element in the collection.
  19709. </value>
  19710. </member>
  19711. <member name="M:log4net.Plugin.PluginCollection.Enumerator.MoveNext">
  19712. <summary>
  19713. Advances the enumerator to the next element in the collection.
  19714. </summary>
  19715. <returns>
  19716. <c>true</c> if the enumerator was successfully advanced to the next element;
  19717. <c>false</c> if the enumerator has passed the end of the collection.
  19718. </returns>
  19719. <exception cref="T:System.InvalidOperationException">
  19720. The collection was modified after the enumerator was created.
  19721. </exception>
  19722. </member>
  19723. <member name="M:log4net.Plugin.PluginCollection.Enumerator.Reset">
  19724. <summary>
  19725. Sets the enumerator to its initial position, before the first element in the collection.
  19726. </summary>
  19727. </member>
  19728. <member name="T:log4net.Plugin.PluginCollection.ReadOnlyPluginCollection">
  19729. <exclude/>
  19730. </member>
  19731. <member name="T:log4net.Plugin.PluginMap">
  19732. <summary>
  19733. Map of repository plugins.
  19734. </summary>
  19735. <remarks>
  19736. <para>
  19737. This class is a name keyed map of the plugins that are
  19738. attached to a repository.
  19739. </para>
  19740. </remarks>
  19741. <author>Nicko Cadell</author>
  19742. <author>Gert Driesen</author>
  19743. </member>
  19744. <member name="M:log4net.Plugin.PluginMap.#ctor(log4net.Repository.ILoggerRepository)">
  19745. <summary>
  19746. Constructor
  19747. </summary>
  19748. <param name="repository">The repository that the plugins should be attached to.</param>
  19749. <remarks>
  19750. <para>
  19751. Initialize a new instance of the <see cref="T:log4net.Plugin.PluginMap" /> class with a
  19752. repository that the plugins should be attached to.
  19753. </para>
  19754. </remarks>
  19755. </member>
  19756. <member name="P:log4net.Plugin.PluginMap.Item(System.String)">
  19757. <summary>
  19758. Gets a <see cref="T:log4net.Plugin.IPlugin" /> by name.
  19759. </summary>
  19760. <param name="name">The name of the <see cref="T:log4net.Plugin.IPlugin" /> to lookup.</param>
  19761. <returns>
  19762. The <see cref="T:log4net.Plugin.IPlugin" /> from the map with the name specified, or
  19763. <c>null</c> if no plugin is found.
  19764. </returns>
  19765. <remarks>
  19766. <para>
  19767. Lookup a plugin by name. If the plugin is not found <c>null</c>
  19768. will be returned.
  19769. </para>
  19770. </remarks>
  19771. </member>
  19772. <member name="P:log4net.Plugin.PluginMap.AllPlugins">
  19773. <summary>
  19774. Gets all possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin" /> objects.
  19775. </summary>
  19776. <value>All possible plugins as a list of <see cref="T:log4net.Plugin.IPlugin" /> objects.</value>
  19777. <remarks>
  19778. <para>
  19779. Get a collection of all the plugins defined in this map.
  19780. </para>
  19781. </remarks>
  19782. </member>
  19783. <member name="M:log4net.Plugin.PluginMap.Add(log4net.Plugin.IPlugin)">
  19784. <summary>
  19785. Adds a <see cref="T:log4net.Plugin.IPlugin" /> to the map.
  19786. </summary>
  19787. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin" /> to add to the map.</param>
  19788. <remarks>
  19789. <para>
  19790. The <see cref="T:log4net.Plugin.IPlugin" /> will be attached to the repository when added.
  19791. </para>
  19792. <para>
  19793. If there already exists a plugin with the same name
  19794. attached to the repository then the old plugin will
  19795. be <see cref="M:log4net.Plugin.IPlugin.Shutdown"/> and replaced with
  19796. the new plugin.
  19797. </para>
  19798. </remarks>
  19799. </member>
  19800. <member name="M:log4net.Plugin.PluginMap.Remove(log4net.Plugin.IPlugin)">
  19801. <summary>
  19802. Removes a <see cref="T:log4net.Plugin.IPlugin" /> from the map.
  19803. </summary>
  19804. <param name="plugin">The <see cref="T:log4net.Plugin.IPlugin" /> to remove from the map.</param>
  19805. <remarks>
  19806. <para>
  19807. Remove a specific plugin from this map.
  19808. </para>
  19809. </remarks>
  19810. </member>
  19811. <member name="T:log4net.Plugin.PluginSkeleton">
  19812. <summary>
  19813. Base implementation of <see cref="T:log4net.Plugin.IPlugin"/>
  19814. </summary>
  19815. <remarks>
  19816. <para>
  19817. Default abstract implementation of the <see cref="T:log4net.Plugin.IPlugin"/>
  19818. interface. This base class can be used by implementors
  19819. of the <see cref="T:log4net.Plugin.IPlugin"/> interface.
  19820. </para>
  19821. </remarks>
  19822. <author>Nicko Cadell</author>
  19823. <author>Gert Driesen</author>
  19824. </member>
  19825. <member name="M:log4net.Plugin.PluginSkeleton.#ctor(System.String)">
  19826. <summary>
  19827. Constructor
  19828. </summary>
  19829. <param name="name">the name of the plugin</param>
  19830. <remarks>
  19831. Initializes a new Plugin with the specified name.
  19832. </remarks>
  19833. </member>
  19834. <member name="P:log4net.Plugin.PluginSkeleton.Name">
  19835. <summary>
  19836. Gets or sets the name of the plugin.
  19837. </summary>
  19838. <value>
  19839. The name of the plugin.
  19840. </value>
  19841. <remarks>
  19842. <para>
  19843. Plugins are stored in the <see cref="T:log4net.Plugin.PluginMap"/>
  19844. keyed by name. Each plugin instance attached to a
  19845. repository must be a unique name.
  19846. </para>
  19847. <para>
  19848. The name of the plugin must not change one the
  19849. plugin has been attached to a repository.
  19850. </para>
  19851. </remarks>
  19852. </member>
  19853. <member name="M:log4net.Plugin.PluginSkeleton.Attach(log4net.Repository.ILoggerRepository)">
  19854. <summary>
  19855. Attaches this plugin to a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  19856. </summary>
  19857. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository"/> that this plugin should be attached to.</param>
  19858. <remarks>
  19859. <para>
  19860. A plugin may only be attached to a single repository.
  19861. </para>
  19862. <para>
  19863. This method is called when the plugin is attached to the repository.
  19864. </para>
  19865. </remarks>
  19866. </member>
  19867. <member name="M:log4net.Plugin.PluginSkeleton.Shutdown">
  19868. <summary>
  19869. Is called when the plugin is to shutdown.
  19870. </summary>
  19871. <remarks>
  19872. <para>
  19873. This method is called to notify the plugin that
  19874. it should stop operating and should detach from
  19875. the repository.
  19876. </para>
  19877. </remarks>
  19878. </member>
  19879. <member name="P:log4net.Plugin.PluginSkeleton.LoggerRepository">
  19880. <summary>
  19881. The repository for this plugin
  19882. </summary>
  19883. <value>
  19884. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this plugin is attached to.
  19885. </value>
  19886. <remarks>
  19887. <para>
  19888. Gets or sets the <see cref="T:log4net.Repository.ILoggerRepository" /> that this plugin is
  19889. attached to.
  19890. </para>
  19891. </remarks>
  19892. </member>
  19893. <member name="F:log4net.Plugin.PluginSkeleton.m_name">
  19894. <summary>
  19895. The name of this plugin.
  19896. </summary>
  19897. </member>
  19898. <member name="F:log4net.Plugin.PluginSkeleton.m_repository">
  19899. <summary>
  19900. The repository this plugin is attached to.
  19901. </summary>
  19902. </member>
  19903. <member name="T:log4net.Repository.ConfigurationChangedEventArgs">
  19904. <summary>
  19905. </summary>
  19906. </member>
  19907. <member name="M:log4net.Repository.ConfigurationChangedEventArgs.#ctor(System.Collections.ICollection)">
  19908. <summary>
  19909. </summary>
  19910. <param name="configurationMessages"></param>
  19911. </member>
  19912. <member name="P:log4net.Repository.ConfigurationChangedEventArgs.ConfigurationMessages">
  19913. <summary>
  19914. </summary>
  19915. </member>
  19916. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory">
  19917. <summary>
  19918. Default implementation of <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  19919. </summary>
  19920. <remarks>
  19921. <para>
  19922. This default implementation of the <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  19923. interface is used to create the default subclass
  19924. of the <see cref="T:log4net.Repository.Hierarchy.Logger"/> object.
  19925. </para>
  19926. </remarks>
  19927. <author>Nicko Cadell</author>
  19928. <author>Gert Driesen</author>
  19929. </member>
  19930. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.#ctor">
  19931. <summary>
  19932. Default constructor
  19933. </summary>
  19934. <remarks>
  19935. <para>
  19936. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory" /> class.
  19937. </para>
  19938. </remarks>
  19939. </member>
  19940. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  19941. <summary>
  19942. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance
  19943. </summary>
  19944. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository" /> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  19945. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  19946. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance for the specified name.</returns>
  19947. <remarks>
  19948. <para>
  19949. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance with the
  19950. specified name.
  19951. </para>
  19952. <para>
  19953. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  19954. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  19955. </para>
  19956. <para>
  19957. If the <paramref name="name"/> is <c>null</c> then the root logger
  19958. must be returned.
  19959. </para>
  19960. </remarks>
  19961. </member>
  19962. <member name="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl">
  19963. <summary>
  19964. Default internal subclass of <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  19965. </summary>
  19966. <remarks>
  19967. <para>
  19968. This subclass has no additional behavior over the
  19969. <see cref="T:log4net.Repository.Hierarchy.Logger"/> class but does allow instances
  19970. to be created.
  19971. </para>
  19972. </remarks>
  19973. </member>
  19974. <member name="M:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl.#ctor(System.String)">
  19975. <summary>
  19976. Construct a new Logger
  19977. </summary>
  19978. <param name="name">the name of the logger</param>
  19979. <remarks>
  19980. <para>
  19981. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory.LoggerImpl" /> class
  19982. with the specified name.
  19983. </para>
  19984. </remarks>
  19985. </member>
  19986. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventHandler">
  19987. <summary>
  19988. Delegate used to handle logger creation event notifications.
  19989. </summary>
  19990. <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>
  19991. <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>
  19992. <remarks>
  19993. <para>
  19994. Delegate used to handle logger creation event notifications.
  19995. </para>
  19996. </remarks>
  19997. </member>
  19998. <member name="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs">
  19999. <summary>
  20000. Provides data for the <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event.
  20001. </summary>
  20002. <remarks>
  20003. <para>
  20004. A <see cref="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent"/> event is raised every time a
  20005. <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> is created.
  20006. </para>
  20007. </remarks>
  20008. </member>
  20009. <member name="F:log4net.Repository.Hierarchy.LoggerCreationEventArgs.m_log">
  20010. <summary>
  20011. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> created
  20012. </summary>
  20013. </member>
  20014. <member name="M:log4net.Repository.Hierarchy.LoggerCreationEventArgs.#ctor(log4net.Repository.Hierarchy.Logger)">
  20015. <summary>
  20016. Constructor
  20017. </summary>
  20018. <param name="log">The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.</param>
  20019. <remarks>
  20020. <para>
  20021. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerCreationEventArgs" /> event argument
  20022. class,with the specified <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/>.
  20023. </para>
  20024. </remarks>
  20025. </member>
  20026. <member name="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger">
  20027. <summary>
  20028. Gets the <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  20029. </summary>
  20030. <value>
  20031. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  20032. </value>
  20033. <remarks>
  20034. <para>
  20035. The <see cref="P:log4net.Repository.Hierarchy.LoggerCreationEventArgs.Logger"/> that has been created.
  20036. </para>
  20037. </remarks>
  20038. </member>
  20039. <member name="T:log4net.Repository.Hierarchy.Hierarchy">
  20040. <summary>
  20041. Hierarchical organization of loggers
  20042. </summary>
  20043. <remarks>
  20044. <para>
  20045. <i>The casual user should not have to deal with this class
  20046. directly.</i>
  20047. </para>
  20048. <para>
  20049. This class is specialized in retrieving loggers by name and
  20050. also maintaining the logger hierarchy. Implements the
  20051. <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  20052. </para>
  20053. <para>
  20054. The structure of the logger hierarchy is maintained by the
  20055. <see cref="M:GetLogger(string)"/> method. The hierarchy is such that children
  20056. link to their parent but parents do not have any references to their
  20057. children. Moreover, loggers can be instantiated in any order, in
  20058. particular descendant before ancestor.
  20059. </para>
  20060. <para>
  20061. In case a descendant is created before a particular ancestor,
  20062. then it creates a provision node for the ancestor and adds itself
  20063. to the provision node. Other descendants of the same ancestor add
  20064. themselves to the previously created provision node.
  20065. </para>
  20066. </remarks>
  20067. <author>Nicko Cadell</author>
  20068. <author>Gert Driesen</author>
  20069. </member>
  20070. <member name="E:log4net.Repository.Hierarchy.Hierarchy.LoggerCreatedEvent">
  20071. <summary>
  20072. Event used to notify that a logger has been created.
  20073. </summary>
  20074. <remarks>
  20075. <para>
  20076. Event raised when a logger is created.
  20077. </para>
  20078. </remarks>
  20079. </member>
  20080. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor">
  20081. <summary>
  20082. Default constructor
  20083. </summary>
  20084. <remarks>
  20085. <para>
  20086. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class.
  20087. </para>
  20088. </remarks>
  20089. </member>
  20090. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary)">
  20091. <summary>
  20092. Construct with properties
  20093. </summary>
  20094. <param name="properties">The properties to pass to this repository.</param>
  20095. <remarks>
  20096. <para>
  20097. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class.
  20098. </para>
  20099. </remarks>
  20100. </member>
  20101. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Repository.Hierarchy.ILoggerFactory)">
  20102. <summary>
  20103. Construct with a logger factory
  20104. </summary>
  20105. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  20106. <remarks>
  20107. <para>
  20108. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class with
  20109. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" />.
  20110. </para>
  20111. </remarks>
  20112. </member>
  20113. <member name="M:log4net.Repository.Hierarchy.Hierarchy.#ctor(log4net.Util.PropertiesDictionary,log4net.Repository.Hierarchy.ILoggerFactory)">
  20114. <summary>
  20115. Construct with properties and a logger factory
  20116. </summary>
  20117. <param name="properties">The properties to pass to this repository.</param>
  20118. <param name="loggerFactory">The factory to use to create new logger instances.</param>
  20119. <remarks>
  20120. <para>
  20121. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> class with
  20122. the specified <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" />.
  20123. </para>
  20124. </remarks>
  20125. </member>
  20126. <member name="P:log4net.Repository.Hierarchy.Hierarchy.EmittedNoAppenderWarning">
  20127. <summary>
  20128. Has no appender warning been emitted
  20129. </summary>
  20130. <remarks>
  20131. <para>
  20132. Flag to indicate if we have already issued a warning
  20133. about not having an appender warning.
  20134. </para>
  20135. </remarks>
  20136. </member>
  20137. <member name="P:log4net.Repository.Hierarchy.Hierarchy.Root">
  20138. <summary>
  20139. Get the root of this hierarchy
  20140. </summary>
  20141. <remarks>
  20142. <para>
  20143. Get the root of this hierarchy.
  20144. </para>
  20145. </remarks>
  20146. </member>
  20147. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LoggerFactory">
  20148. <summary>
  20149. Gets or sets the default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" /> instance.
  20150. </summary>
  20151. <value>The default <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory" /></value>
  20152. <remarks>
  20153. <para>
  20154. The logger factory is used to create logger instances.
  20155. </para>
  20156. </remarks>
  20157. </member>
  20158. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Exists(System.String)">
  20159. <summary>
  20160. Test if a logger exists
  20161. </summary>
  20162. <param name="name">The name of the logger to lookup</param>
  20163. <returns>The Logger object with the name specified</returns>
  20164. <remarks>
  20165. <para>
  20166. Check if the named logger exists in the hierarchy. If so return
  20167. its reference, otherwise returns <c>null</c>.
  20168. </para>
  20169. </remarks>
  20170. </member>
  20171. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetCurrentLoggers">
  20172. <summary>
  20173. Returns all the currently defined loggers in the hierarchy as an Array
  20174. </summary>
  20175. <returns>All the defined loggers</returns>
  20176. <remarks>
  20177. <para>
  20178. Returns all the currently defined loggers in the hierarchy as an Array.
  20179. The root logger is <b>not</b> included in the returned
  20180. enumeration.
  20181. </para>
  20182. </remarks>
  20183. </member>
  20184. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String)">
  20185. <summary>
  20186. Return a new logger instance named as the first parameter using
  20187. the default factory.
  20188. </summary>
  20189. <remarks>
  20190. <para>
  20191. Return a new logger instance named as the first parameter using
  20192. the default factory.
  20193. </para>
  20194. <para>
  20195. If a logger of that name already exists, then it will be
  20196. returned. Otherwise, a new logger will be instantiated and
  20197. then linked with its existing ancestors as well as children.
  20198. </para>
  20199. </remarks>
  20200. <param name="name">The name of the logger to retrieve</param>
  20201. <returns>The logger object with the name specified</returns>
  20202. </member>
  20203. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Shutdown">
  20204. <summary>
  20205. Shutting down a hierarchy will <i>safely</i> close and remove
  20206. all appenders in all loggers including the root logger.
  20207. </summary>
  20208. <remarks>
  20209. <para>
  20210. Shutting down a hierarchy will <i>safely</i> close and remove
  20211. all appenders in all loggers including the root logger.
  20212. </para>
  20213. <para>
  20214. Some appenders need to be closed before the
  20215. application exists. Otherwise, pending logging events might be
  20216. lost.
  20217. </para>
  20218. <para>
  20219. The <c>Shutdown</c> method is careful to close nested
  20220. appenders before closing regular appenders. This is allows
  20221. configurations where a regular appender is attached to a logger
  20222. and again to a nested appender.
  20223. </para>
  20224. </remarks>
  20225. </member>
  20226. <member name="M:log4net.Repository.Hierarchy.Hierarchy.ResetConfiguration">
  20227. <summary>
  20228. Reset all values contained in this hierarchy instance to their default.
  20229. </summary>
  20230. <remarks>
  20231. <para>
  20232. Reset all values contained in this hierarchy instance to their
  20233. default. This removes all appenders from all loggers, sets
  20234. the level of all non-root loggers to <c>null</c>,
  20235. sets their additivity flag to <c>true</c> and sets the level
  20236. of the root logger to <see cref="F:log4net.Core.Level.Debug"/>. Moreover,
  20237. message disabling is set its default "off" value.
  20238. </para>
  20239. <para>
  20240. Existing loggers are not removed. They are just reset.
  20241. </para>
  20242. <para>
  20243. This method should be used sparingly and with care as it will
  20244. block all logging until it is completed.
  20245. </para>
  20246. </remarks>
  20247. </member>
  20248. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Log(log4net.Core.LoggingEvent)">
  20249. <summary>
  20250. Log the logEvent through this hierarchy.
  20251. </summary>
  20252. <param name="logEvent">the event to log</param>
  20253. <remarks>
  20254. <para>
  20255. This method should not normally be used to log.
  20256. The <see cref="T:log4net.ILog"/> interface should be used
  20257. for routine logging. This interface can be obtained
  20258. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  20259. </para>
  20260. <para>
  20261. The <c>logEvent</c> is delivered to the appropriate logger and
  20262. that logger is then responsible for logging the event.
  20263. </para>
  20264. </remarks>
  20265. </member>
  20266. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetAppenders">
  20267. <summary>
  20268. Returns all the Appenders that are currently configured
  20269. </summary>
  20270. <returns>An array containing all the currently configured appenders</returns>
  20271. <remarks>
  20272. <para>
  20273. Returns all the <see cref="T:log4net.Appender.IAppender"/> instances that are currently configured.
  20274. All the loggers are searched for appenders. The appenders may also be containers
  20275. for appenders and these are also searched for additional loggers.
  20276. </para>
  20277. <para>
  20278. The list returned is unordered but does not contain duplicates.
  20279. </para>
  20280. </remarks>
  20281. </member>
  20282. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppender(System.Collections.ArrayList,log4net.Appender.IAppender)">
  20283. <summary>
  20284. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/>.
  20285. The appender may also be a container.
  20286. </summary>
  20287. <param name="appenderList"></param>
  20288. <param name="appender"></param>
  20289. </member>
  20290. <member name="M:log4net.Repository.Hierarchy.Hierarchy.CollectAppenders(System.Collections.ArrayList,log4net.Core.IAppenderAttachable)">
  20291. <summary>
  20292. Collect the appenders from an <see cref="T:log4net.Core.IAppenderAttachable"/> container
  20293. </summary>
  20294. <param name="appenderList"></param>
  20295. <param name="container"></param>
  20296. </member>
  20297. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IBasicRepositoryConfigurator#Configure(log4net.Appender.IAppender)">
  20298. <summary>
  20299. Initialize the log4net system using the specified appender
  20300. </summary>
  20301. <param name="appender">the appender to use to log all logging events</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 appenders
  20306. </summary>
  20307. <param name="appenders">the appenders to use to log all logging events</param>
  20308. </member>
  20309. <member name="M:log4net.Repository.Hierarchy.Hierarchy.BasicRepositoryConfigure(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. <remarks>
  20315. <para>
  20316. This method provides the same functionality as the
  20317. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  20318. on this object, but it is protected and therefore can be called by subclasses.
  20319. </para>
  20320. </remarks>
  20321. </member>
  20322. <member name="M:log4net.Repository.Hierarchy.Hierarchy.log4net#Repository#IXmlRepositoryConfigurator#Configure(System.Xml.XmlElement)">
  20323. <summary>
  20324. Initialize the log4net system using the specified config
  20325. </summary>
  20326. <param name="element">the element containing the root of the config</param>
  20327. </member>
  20328. <member name="M:log4net.Repository.Hierarchy.Hierarchy.XmlRepositoryConfigure(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. <remarks>
  20334. <para>
  20335. This method provides the same functionality as the
  20336. <see cref="M:IBasicRepositoryConfigurator.Configure(IAppender)"/> method implemented
  20337. on this object, but it is protected and therefore can be called by subclasses.
  20338. </para>
  20339. </remarks>
  20340. </member>
  20341. <member name="M:log4net.Repository.Hierarchy.Hierarchy.IsDisabled(log4net.Core.Level)">
  20342. <summary>
  20343. Test if this hierarchy is disabled for the specified <see cref="T:log4net.Core.Level"/>.
  20344. </summary>
  20345. <param name="level">The level to check against.</param>
  20346. <returns>
  20347. <c>true</c> if the repository is disabled for the level argument, <c>false</c> otherwise.
  20348. </returns>
  20349. <remarks>
  20350. <para>
  20351. If this hierarchy has not been configured then this method will
  20352. always return <c>true</c>.
  20353. </para>
  20354. <para>
  20355. This method will return <c>true</c> if this repository is
  20356. disabled for <c>level</c> object passed as parameter and
  20357. <c>false</c> otherwise.
  20358. </para>
  20359. <para>
  20360. See also the <see cref="P:log4net.Repository.ILoggerRepository.Threshold"/> property.
  20361. </para>
  20362. </remarks>
  20363. </member>
  20364. <member name="M:log4net.Repository.Hierarchy.Hierarchy.Clear">
  20365. <summary>
  20366. Clear all logger definitions from the internal hashtable
  20367. </summary>
  20368. <remarks>
  20369. <para>
  20370. This call will clear all logger definitions from the internal
  20371. hashtable. Invoking this method will irrevocably mess up the
  20372. logger hierarchy.
  20373. </para>
  20374. <para>
  20375. You should <b>really</b> know what you are doing before
  20376. invoking this method.
  20377. </para>
  20378. </remarks>
  20379. </member>
  20380. <member name="M:log4net.Repository.Hierarchy.Hierarchy.GetLogger(System.String,log4net.Repository.Hierarchy.ILoggerFactory)">
  20381. <summary>
  20382. Return a new logger instance named as the first parameter using
  20383. <paramref name="factory"/>.
  20384. </summary>
  20385. <param name="name">The name of the logger to retrieve</param>
  20386. <param name="factory">The factory that will make the new logger instance</param>
  20387. <returns>The logger object with the name specified</returns>
  20388. <remarks>
  20389. <para>
  20390. If a logger of that name already exists, then it will be
  20391. returned. Otherwise, a new logger will be instantiated by the
  20392. <paramref name="factory"/> parameter and linked with its existing
  20393. ancestors as well as children.
  20394. </para>
  20395. </remarks>
  20396. </member>
  20397. <member name="M:log4net.Repository.Hierarchy.Hierarchy.OnLoggerCreationEvent(log4net.Repository.Hierarchy.Logger)">
  20398. <summary>
  20399. Sends a logger creation event to all registered listeners
  20400. </summary>
  20401. <param name="logger">The newly created logger</param>
  20402. <remarks>
  20403. Raises the logger creation event.
  20404. </remarks>
  20405. </member>
  20406. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateParents(log4net.Repository.Hierarchy.Logger)">
  20407. <summary>
  20408. Updates all the parents of the specified logger
  20409. </summary>
  20410. <param name="log">The logger to update the parents for</param>
  20411. <remarks>
  20412. <para>
  20413. This method loops through all the <i>potential</i> parents of
  20414. <paramref name="log"/>. There 3 possible cases:
  20415. </para>
  20416. <list type="number">
  20417. <item>
  20418. <term>No entry for the potential parent of <paramref name="log"/> exists</term>
  20419. <description>
  20420. We create a ProvisionNode for this potential
  20421. parent and insert <paramref name="log"/> in that provision node.
  20422. </description>
  20423. </item>
  20424. <item>
  20425. <term>The entry is of type Logger for the potential parent.</term>
  20426. <description>
  20427. The entry is <paramref name="log"/>'s nearest existing parent. We
  20428. update <paramref name="log"/>'s parent field with this entry. We also break from
  20429. he loop because updating our parent's parent is our parent's
  20430. responsibility.
  20431. </description>
  20432. </item>
  20433. <item>
  20434. <term>The entry is of type ProvisionNode for this potential parent.</term>
  20435. <description>
  20436. We add <paramref name="log"/> to the list of children for this
  20437. potential parent.
  20438. </description>
  20439. </item>
  20440. </list>
  20441. </remarks>
  20442. </member>
  20443. <member name="M:log4net.Repository.Hierarchy.Hierarchy.UpdateChildren(log4net.Repository.Hierarchy.ProvisionNode,log4net.Repository.Hierarchy.Logger)">
  20444. <summary>
  20445. Replace a <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> with a <see cref="T:log4net.Repository.Hierarchy.Logger"/> in the hierarchy.
  20446. </summary>
  20447. <param name="pn"></param>
  20448. <param name="log"></param>
  20449. <remarks>
  20450. <para>
  20451. We update the links for all the children that placed themselves
  20452. in the provision node 'pn'. The second argument 'log' is a
  20453. reference for the newly created Logger, parent of all the
  20454. children in 'pn'.
  20455. </para>
  20456. <para>
  20457. We loop on all the children 'c' in 'pn'.
  20458. </para>
  20459. <para>
  20460. If the child 'c' has been already linked to a child of
  20461. 'log' then there is no need to update 'c'.
  20462. </para>
  20463. <para>
  20464. Otherwise, we set log's parent field to c's parent and set
  20465. c's parent field to log.
  20466. </para>
  20467. </remarks>
  20468. </member>
  20469. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddLevel(log4net.Repository.Hierarchy.Hierarchy.LevelEntry)">
  20470. <summary>
  20471. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  20472. </summary>
  20473. <param name="levelEntry">the level values</param>
  20474. <remarks>
  20475. <para>
  20476. Define or redefine a Level using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  20477. </para>
  20478. <para>
  20479. Supports setting levels via the configuration file.
  20480. </para>
  20481. </remarks>
  20482. </member>
  20483. <member name="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry">
  20484. <summary>
  20485. A class to hold the value, name and display name for a level
  20486. </summary>
  20487. <remarks>
  20488. <para>
  20489. A class to hold the value, name and display name for a level
  20490. </para>
  20491. </remarks>
  20492. </member>
  20493. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Value">
  20494. <summary>
  20495. Value of the level
  20496. </summary>
  20497. <remarks>
  20498. <para>
  20499. If the value is not set (defaults to -1) the value will be looked
  20500. up for the current level with the same name.
  20501. </para>
  20502. </remarks>
  20503. </member>
  20504. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.Name">
  20505. <summary>
  20506. Name of the level
  20507. </summary>
  20508. <value>
  20509. The name of the level
  20510. </value>
  20511. <remarks>
  20512. <para>
  20513. The name of the level.
  20514. </para>
  20515. </remarks>
  20516. </member>
  20517. <member name="P:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.DisplayName">
  20518. <summary>
  20519. Display name for the level
  20520. </summary>
  20521. <value>
  20522. The display name of the level
  20523. </value>
  20524. <remarks>
  20525. <para>
  20526. The display name of the level.
  20527. </para>
  20528. </remarks>
  20529. </member>
  20530. <member name="M:log4net.Repository.Hierarchy.Hierarchy.LevelEntry.ToString">
  20531. <summary>
  20532. Override <c>Object.ToString</c> to return sensible debug info
  20533. </summary>
  20534. <returns>string info about this object</returns>
  20535. </member>
  20536. <member name="M:log4net.Repository.Hierarchy.Hierarchy.AddProperty(log4net.Util.PropertyEntry)">
  20537. <summary>
  20538. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument
  20539. </summary>
  20540. <param name="propertyEntry">the property value</param>
  20541. <remarks>
  20542. <para>
  20543. Set a Property using the values in the <see cref="T:log4net.Repository.Hierarchy.Hierarchy.LevelEntry"/> argument.
  20544. </para>
  20545. <para>
  20546. Supports setting property values via the configuration file.
  20547. </para>
  20548. </remarks>
  20549. </member>
  20550. <member name="F:log4net.Repository.Hierarchy.Hierarchy.declaringType">
  20551. <summary>
  20552. The fully qualified type of the Hierarchy class.
  20553. </summary>
  20554. <remarks>
  20555. Used by the internal logger to record the Type of the
  20556. log message.
  20557. </remarks>
  20558. </member>
  20559. <member name="T:log4net.Repository.Hierarchy.ILoggerFactory">
  20560. <summary>
  20561. Interface abstracts creation of <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances
  20562. </summary>
  20563. <remarks>
  20564. <para>
  20565. This interface is used by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to
  20566. create new <see cref="T:log4net.Repository.Hierarchy.Logger"/> objects.
  20567. </para>
  20568. <para>
  20569. The <see cref="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)"/> method is called
  20570. to create a named <see cref="T:log4net.Repository.Hierarchy.Logger" />.
  20571. </para>
  20572. <para>
  20573. Implement this interface to create new subclasses of <see cref="T:log4net.Repository.Hierarchy.Logger" />.
  20574. </para>
  20575. </remarks>
  20576. <author>Nicko Cadell</author>
  20577. <author>Gert Driesen</author>
  20578. </member>
  20579. <member name="M:log4net.Repository.Hierarchy.ILoggerFactory.CreateLogger(log4net.Repository.ILoggerRepository,System.String)">
  20580. <summary>
  20581. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance
  20582. </summary>
  20583. <param name="repository">The <see cref="T:log4net.Repository.ILoggerRepository" /> that will own the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  20584. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  20585. <returns>The <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance for the specified name.</returns>
  20586. <remarks>
  20587. <para>
  20588. Create a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance with the
  20589. specified name.
  20590. </para>
  20591. <para>
  20592. Called by the <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> to create
  20593. new named <see cref="T:log4net.Repository.Hierarchy.Logger"/> instances.
  20594. </para>
  20595. <para>
  20596. If the <paramref name="name"/> is <c>null</c> then the root logger
  20597. must be returned.
  20598. </para>
  20599. </remarks>
  20600. </member>
  20601. <member name="T:log4net.Repository.Hierarchy.Logger">
  20602. <summary>
  20603. Implementation of <see cref="T:log4net.Core.ILogger"/> used by <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>
  20604. </summary>
  20605. <remarks>
  20606. <para>
  20607. Internal class used to provide implementation of <see cref="T:log4net.Core.ILogger"/>
  20608. interface. Applications should use <see cref="T:log4net.LogManager"/> to get
  20609. logger instances.
  20610. </para>
  20611. <para>
  20612. This is one of the central classes in the log4net implementation. One of the
  20613. distinctive features of log4net are hierarchical loggers and their
  20614. evaluation. The <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> organizes the <see cref="T:log4net.Repository.Hierarchy.Logger"/>
  20615. instances into a rooted tree hierarchy.
  20616. </para>
  20617. <para>
  20618. The <see cref="T:log4net.Repository.Hierarchy.Logger"/> class is abstract. Only concrete subclasses of
  20619. <see cref="T:log4net.Repository.Hierarchy.Logger"/> can be created. The <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  20620. is used to create instances of this type for the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  20621. </para>
  20622. </remarks>
  20623. <author>Nicko Cadell</author>
  20624. <author>Gert Driesen</author>
  20625. <author>Aspi Havewala</author>
  20626. <author>Douglas de la Torre</author>
  20627. </member>
  20628. <member name="M:log4net.Repository.Hierarchy.Logger.#ctor(System.String)">
  20629. <summary>
  20630. This constructor created a new <see cref="T:log4net.Repository.Hierarchy.Logger" /> instance and
  20631. sets its name.
  20632. </summary>
  20633. <param name="name">The name of the <see cref="T:log4net.Repository.Hierarchy.Logger" />.</param>
  20634. <remarks>
  20635. <para>
  20636. This constructor is protected and designed to be used by
  20637. a subclass that is not abstract.
  20638. </para>
  20639. <para>
  20640. Loggers are constructed by <see cref="T:log4net.Repository.Hierarchy.ILoggerFactory"/>
  20641. objects. See <see cref="T:log4net.Repository.Hierarchy.DefaultLoggerFactory"/> for the default
  20642. logger creator.
  20643. </para>
  20644. </remarks>
  20645. </member>
  20646. <member name="P:log4net.Repository.Hierarchy.Logger.Parent">
  20647. <summary>
  20648. Gets or sets the parent logger in the hierarchy.
  20649. </summary>
  20650. <value>
  20651. The parent logger in the hierarchy.
  20652. </value>
  20653. <remarks>
  20654. <para>
  20655. Part of the Composite pattern that makes the hierarchy.
  20656. The hierarchy is parent linked rather than child linked.
  20657. </para>
  20658. </remarks>
  20659. </member>
  20660. <member name="P:log4net.Repository.Hierarchy.Logger.Additivity">
  20661. <summary>
  20662. Gets or sets a value indicating if child loggers inherit their parent's appenders.
  20663. </summary>
  20664. <value>
  20665. <c>true</c> if child loggers inherit their parent's appenders.
  20666. </value>
  20667. <remarks>
  20668. <para>
  20669. Additivity is set to <c>true</c> by default, that is children inherit
  20670. the appenders of their ancestors by default. If this variable is
  20671. set to <c>false</c> then the appenders found in the
  20672. ancestors of this logger are not used. However, the children
  20673. of this logger will inherit its appenders, unless the children
  20674. have their additivity flag set to <c>false</c> too. See
  20675. the user manual for more details.
  20676. </para>
  20677. </remarks>
  20678. </member>
  20679. <member name="P:log4net.Repository.Hierarchy.Logger.EffectiveLevel">
  20680. <summary>
  20681. Gets the effective level for this logger.
  20682. </summary>
  20683. <returns>The nearest level in the logger hierarchy.</returns>
  20684. <remarks>
  20685. <para>
  20686. Starting from this logger, searches the logger hierarchy for a
  20687. non-null level and returns it. Otherwise, returns the level of the
  20688. root logger.
  20689. </para>
  20690. <para>The Logger class is designed so that this method executes as
  20691. quickly as possible.</para>
  20692. </remarks>
  20693. </member>
  20694. <member name="P:log4net.Repository.Hierarchy.Logger.Hierarchy">
  20695. <summary>
  20696. Gets or sets the <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/> where this
  20697. <c>Logger</c> instance is attached to.
  20698. </summary>
  20699. <value>The hierarchy that this logger belongs to.</value>
  20700. <remarks>
  20701. <para>
  20702. This logger must be attached to a single <see cref="P:log4net.Repository.Hierarchy.Logger.Hierarchy"/>.
  20703. </para>
  20704. </remarks>
  20705. </member>
  20706. <member name="P:log4net.Repository.Hierarchy.Logger.Level">
  20707. <summary>
  20708. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>, if any, for this Logger.
  20709. </summary>
  20710. <value>
  20711. The <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> of this logger.
  20712. </value>
  20713. <remarks>
  20714. <para>
  20715. The assigned <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> can be <c>null</c>.
  20716. </para>
  20717. </remarks>
  20718. </member>
  20719. <member name="M:log4net.Repository.Hierarchy.Logger.AddAppender(log4net.Appender.IAppender)">
  20720. <summary>
  20721. Add <paramref name="newAppender"/> to the list of appenders of this
  20722. Logger instance.
  20723. </summary>
  20724. <param name="newAppender">An appender to add to this logger</param>
  20725. <remarks>
  20726. <para>
  20727. Add <paramref name="newAppender"/> to the list of appenders of this
  20728. Logger instance.
  20729. </para>
  20730. <para>
  20731. If <paramref name="newAppender"/> is already in the list of
  20732. appenders, then it won't be added again.
  20733. </para>
  20734. </remarks>
  20735. </member>
  20736. <member name="P:log4net.Repository.Hierarchy.Logger.Appenders">
  20737. <summary>
  20738. Get the appenders contained in this logger as an
  20739. <see cref="T:System.Collections.ICollection"/>.
  20740. </summary>
  20741. <returns>A collection of the appenders in this logger</returns>
  20742. <remarks>
  20743. <para>
  20744. Get the appenders contained in this logger as an
  20745. <see cref="T:System.Collections.ICollection"/>. If no appenders
  20746. can be found, then a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  20747. </para>
  20748. </remarks>
  20749. </member>
  20750. <member name="M:log4net.Repository.Hierarchy.Logger.GetAppender(System.String)">
  20751. <summary>
  20752. Look for the appender named as <c>name</c>
  20753. </summary>
  20754. <param name="name">The name of the appender to lookup</param>
  20755. <returns>The appender with the name specified, or <c>null</c>.</returns>
  20756. <remarks>
  20757. <para>
  20758. Returns the named appender, or null if the appender is not found.
  20759. </para>
  20760. </remarks>
  20761. </member>
  20762. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAllAppenders">
  20763. <summary>
  20764. Remove all previously added appenders from this Logger instance.
  20765. </summary>
  20766. <remarks>
  20767. <para>
  20768. Remove all previously added appenders from this Logger instance.
  20769. </para>
  20770. <para>
  20771. This is useful when re-reading configuration information.
  20772. </para>
  20773. </remarks>
  20774. </member>
  20775. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(log4net.Appender.IAppender)">
  20776. <summary>
  20777. Remove the appender passed as parameter form the list of appenders.
  20778. </summary>
  20779. <param name="appender">The appender to remove</param>
  20780. <returns>The appender removed from the list</returns>
  20781. <remarks>
  20782. <para>
  20783. Remove the appender passed as parameter form the list of appenders.
  20784. The appender removed is not closed.
  20785. If you are discarding the appender you must call
  20786. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  20787. </para>
  20788. </remarks>
  20789. </member>
  20790. <member name="M:log4net.Repository.Hierarchy.Logger.RemoveAppender(System.String)">
  20791. <summary>
  20792. Remove the appender passed as parameter form the list of appenders.
  20793. </summary>
  20794. <param name="name">The name of the appender to remove</param>
  20795. <returns>The appender removed from the list</returns>
  20796. <remarks>
  20797. <para>
  20798. Remove the named appender passed as parameter form the list of appenders.
  20799. The appender removed is not closed.
  20800. If you are discarding the appender you must call
  20801. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  20802. </para>
  20803. </remarks>
  20804. </member>
  20805. <member name="P:log4net.Repository.Hierarchy.Logger.Name">
  20806. <summary>
  20807. Gets the logger name.
  20808. </summary>
  20809. <value>
  20810. The name of the logger.
  20811. </value>
  20812. <remarks>
  20813. <para>
  20814. The name of this logger
  20815. </para>
  20816. </remarks>
  20817. </member>
  20818. <member name="M:log4net.Repository.Hierarchy.Logger.Log(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  20819. <summary>
  20820. This generic form is intended to be used by wrappers.
  20821. </summary>
  20822. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  20823. the stack boundary into the logging system for this call.</param>
  20824. <param name="level">The level of the message to be logged.</param>
  20825. <param name="message">The message object to log.</param>
  20826. <param name="exception">The exception to log, including its stack trace.</param>
  20827. <remarks>
  20828. <para>
  20829. Generate a logging event for the specified <paramref name="level"/> using
  20830. the <paramref name="message"/> and <paramref name="exception"/>.
  20831. </para>
  20832. <para>
  20833. This method must not throw any exception to the caller.
  20834. </para>
  20835. </remarks>
  20836. </member>
  20837. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.LoggingEvent)">
  20838. <summary>
  20839. This is the most generic printing method that is intended to be used
  20840. by wrappers.
  20841. </summary>
  20842. <param name="logEvent">The event being logged.</param>
  20843. <remarks>
  20844. <para>
  20845. Logs the specified logging event through this logger.
  20846. </para>
  20847. <para>
  20848. This method must not throw any exception to the caller.
  20849. </para>
  20850. </remarks>
  20851. </member>
  20852. <member name="M:log4net.Repository.Hierarchy.Logger.IsEnabledFor(log4net.Core.Level)">
  20853. <summary>
  20854. Checks if this logger is enabled for a given <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/> passed as parameter.
  20855. </summary>
  20856. <param name="level">The level to check.</param>
  20857. <returns>
  20858. <c>true</c> if this logger is enabled for <c>level</c>, otherwise <c>false</c>.
  20859. </returns>
  20860. <remarks>
  20861. <para>
  20862. Test if this logger is going to log events of the specified <paramref name="level"/>.
  20863. </para>
  20864. <para>
  20865. This method must not throw any exception to the caller.
  20866. </para>
  20867. </remarks>
  20868. </member>
  20869. <member name="P:log4net.Repository.Hierarchy.Logger.Repository">
  20870. <summary>
  20871. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  20872. <c>Logger</c> instance is attached to.
  20873. </summary>
  20874. <value>
  20875. The <see cref="T:log4net.Repository.ILoggerRepository" /> that this logger belongs to.
  20876. </value>
  20877. <remarks>
  20878. <para>
  20879. Gets the <see cref="T:log4net.Repository.ILoggerRepository"/> where this
  20880. <c>Logger</c> instance is attached to.
  20881. </para>
  20882. </remarks>
  20883. </member>
  20884. <member name="M:log4net.Repository.Hierarchy.Logger.CallAppenders(log4net.Core.LoggingEvent)">
  20885. <summary>
  20886. Deliver the <see cref="T:log4net.Core.LoggingEvent"/> to the attached appenders.
  20887. </summary>
  20888. <param name="loggingEvent">The event to log.</param>
  20889. <remarks>
  20890. <para>
  20891. Call the appenders in the hierarchy starting at
  20892. <c>this</c>. If no appenders could be found, emit a
  20893. warning.
  20894. </para>
  20895. <para>
  20896. This method calls all the appenders inherited from the
  20897. hierarchy circumventing any evaluation of whether to log or not
  20898. to log the particular log request.
  20899. </para>
  20900. </remarks>
  20901. </member>
  20902. <member name="M:log4net.Repository.Hierarchy.Logger.CloseNestedAppenders">
  20903. <summary>
  20904. Closes all attached appenders implementing the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  20905. </summary>
  20906. <remarks>
  20907. <para>
  20908. Used to ensure that the appenders are correctly shutdown.
  20909. </para>
  20910. </remarks>
  20911. </member>
  20912. <member name="M:log4net.Repository.Hierarchy.Logger.Log(log4net.Core.Level,System.Object,System.Exception)">
  20913. <summary>
  20914. This is the most generic printing method. This generic form is intended to be used by wrappers
  20915. </summary>
  20916. <param name="level">The level of the message to be logged.</param>
  20917. <param name="message">The message object to log.</param>
  20918. <param name="exception">The exception to log, including its stack trace.</param>
  20919. <remarks>
  20920. <para>
  20921. Generate a logging event for the specified <paramref name="level"/> using
  20922. the <paramref name="message"/>.
  20923. </para>
  20924. </remarks>
  20925. </member>
  20926. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(System.Type,log4net.Core.Level,System.Object,System.Exception)">
  20927. <summary>
  20928. Creates a new logging event and logs the event without further checks.
  20929. </summary>
  20930. <param name="callerStackBoundaryDeclaringType">The declaring type of the method that is
  20931. the stack boundary into the logging system for this call.</param>
  20932. <param name="level">The level of the message to be logged.</param>
  20933. <param name="message">The message object to log.</param>
  20934. <param name="exception">The exception to log, including its stack trace.</param>
  20935. <remarks>
  20936. <para>
  20937. Generates a logging event and delivers it to the attached
  20938. appenders.
  20939. </para>
  20940. </remarks>
  20941. </member>
  20942. <member name="M:log4net.Repository.Hierarchy.Logger.ForcedLog(log4net.Core.LoggingEvent)">
  20943. <summary>
  20944. Creates a new logging event and logs the event without further checks.
  20945. </summary>
  20946. <param name="logEvent">The event being logged.</param>
  20947. <remarks>
  20948. <para>
  20949. Delivers the logging event to the attached appenders.
  20950. </para>
  20951. </remarks>
  20952. </member>
  20953. <member name="F:log4net.Repository.Hierarchy.Logger.declaringType">
  20954. <summary>
  20955. The fully qualified type of the Logger class.
  20956. </summary>
  20957. </member>
  20958. <member name="F:log4net.Repository.Hierarchy.Logger.m_name">
  20959. <summary>
  20960. The name of this logger.
  20961. </summary>
  20962. </member>
  20963. <member name="F:log4net.Repository.Hierarchy.Logger.m_level">
  20964. <summary>
  20965. The assigned level of this logger.
  20966. </summary>
  20967. <remarks>
  20968. <para>
  20969. The <c>level</c> variable need not be
  20970. assigned a value in which case it is inherited
  20971. form the hierarchy.
  20972. </para>
  20973. </remarks>
  20974. </member>
  20975. <member name="F:log4net.Repository.Hierarchy.Logger.m_parent">
  20976. <summary>
  20977. The parent of this logger.
  20978. </summary>
  20979. <remarks>
  20980. <para>
  20981. The parent of this logger.
  20982. All loggers have at least one ancestor which is the root logger.
  20983. </para>
  20984. </remarks>
  20985. </member>
  20986. <member name="F:log4net.Repository.Hierarchy.Logger.m_hierarchy">
  20987. <summary>
  20988. Loggers need to know what Hierarchy they are in.
  20989. </summary>
  20990. <remarks>
  20991. <para>
  20992. Loggers need to know what Hierarchy they are in.
  20993. The hierarchy that this logger is a member of is stored
  20994. here.
  20995. </para>
  20996. </remarks>
  20997. </member>
  20998. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderAttachedImpl">
  20999. <summary>
  21000. Helper implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  21001. </summary>
  21002. </member>
  21003. <member name="F:log4net.Repository.Hierarchy.Logger.m_additive">
  21004. <summary>
  21005. Flag indicating if child loggers inherit their parents appenders
  21006. </summary>
  21007. <remarks>
  21008. <para>
  21009. Additivity is set to true by default, that is children inherit
  21010. the appenders of their ancestors by default. If this variable is
  21011. set to <c>false</c> then the appenders found in the
  21012. ancestors of this logger are not used. However, the children
  21013. of this logger will inherit its appenders, unless the children
  21014. have their additivity flag set to <c>false</c> too. See
  21015. the user manual for more details.
  21016. </para>
  21017. </remarks>
  21018. </member>
  21019. <member name="F:log4net.Repository.Hierarchy.Logger.m_appenderLock">
  21020. <summary>
  21021. Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl
  21022. </summary>
  21023. </member>
  21024. <member name="T:log4net.Repository.Hierarchy.LoggerKey">
  21025. <summary>
  21026. Used internally to accelerate hash table searches.
  21027. </summary>
  21028. <remarks>
  21029. <para>
  21030. Internal class used to improve performance of
  21031. string keyed hashtables.
  21032. </para>
  21033. <para>
  21034. The hashcode of the string is cached for reuse.
  21035. The string is stored as an interned value.
  21036. When comparing two <see cref="T:log4net.Repository.Hierarchy.LoggerKey"/> objects for equality
  21037. the reference equality of the interned strings is compared.
  21038. </para>
  21039. </remarks>
  21040. <author>Nicko Cadell</author>
  21041. <author>Gert Driesen</author>
  21042. </member>
  21043. <member name="M:log4net.Repository.Hierarchy.LoggerKey.#ctor(System.String)">
  21044. <summary>
  21045. Construct key with string name
  21046. </summary>
  21047. <remarks>
  21048. <para>
  21049. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.LoggerKey" /> class
  21050. with the specified name.
  21051. </para>
  21052. <para>
  21053. Stores the hashcode of the string and interns
  21054. the string key to optimize comparisons.
  21055. </para>
  21056. <note>
  21057. The Compact Framework 1.0 the <see cref="!:String.Intern"/>
  21058. method does not work. On the Compact Framework
  21059. the string keys are not interned nor are they
  21060. compared by reference.
  21061. </note>
  21062. </remarks>
  21063. <param name="name">The name of the logger.</param>
  21064. </member>
  21065. <member name="M:log4net.Repository.Hierarchy.LoggerKey.GetHashCode">
  21066. <summary>
  21067. Returns a hash code for the current instance.
  21068. </summary>
  21069. <returns>A hash code for the current instance.</returns>
  21070. <remarks>
  21071. <para>
  21072. Returns the cached hashcode.
  21073. </para>
  21074. </remarks>
  21075. </member>
  21076. <member name="M:log4net.Repository.Hierarchy.LoggerKey.Equals(System.Object)">
  21077. <summary>
  21078. Determines whether two <see cref="T:log4net.Repository.Hierarchy.LoggerKey" /> instances
  21079. are equal.
  21080. </summary>
  21081. <param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:log4net.Repository.Hierarchy.LoggerKey" />.</param>
  21082. <returns>
  21083. <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>.
  21084. </returns>
  21085. <remarks>
  21086. <para>
  21087. Compares the references of the interned strings.
  21088. </para>
  21089. </remarks>
  21090. </member>
  21091. <member name="T:log4net.Repository.Hierarchy.ProvisionNode">
  21092. <summary>
  21093. Provision nodes are used where no logger instance has been specified
  21094. </summary>
  21095. <remarks>
  21096. <para>
  21097. <see cref="T:log4net.Repository.Hierarchy.ProvisionNode"/> instances are used in the
  21098. <see cref="T:log4net.Repository.Hierarchy.Hierarchy" /> when there is no specified
  21099. <see cref="T:log4net.Repository.Hierarchy.Logger" /> for that node.
  21100. </para>
  21101. <para>
  21102. A provision node holds a list of child loggers on behalf of
  21103. a logger that does not exist.
  21104. </para>
  21105. </remarks>
  21106. <author>Nicko Cadell</author>
  21107. <author>Gert Driesen</author>
  21108. </member>
  21109. <member name="M:log4net.Repository.Hierarchy.ProvisionNode.#ctor(log4net.Repository.Hierarchy.Logger)">
  21110. <summary>
  21111. Create a new provision node with child node
  21112. </summary>
  21113. <param name="log">A child logger to add to this node.</param>
  21114. <remarks>
  21115. <para>
  21116. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.ProvisionNode" /> class
  21117. with the specified child logger.
  21118. </para>
  21119. </remarks>
  21120. </member>
  21121. <member name="T:log4net.Repository.Hierarchy.RootLogger">
  21122. <summary>
  21123. The <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> sits at the root of the logger hierarchy tree.
  21124. </summary>
  21125. <remarks>
  21126. <para>
  21127. The <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> is a regular <see cref="T:log4net.Repository.Hierarchy.Logger" /> except
  21128. that it provides several guarantees.
  21129. </para>
  21130. <para>
  21131. First, it cannot be assigned a <c>null</c>
  21132. level. Second, since the root logger cannot have a parent, the
  21133. <see cref="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel"/> property always returns the value of the
  21134. level field without walking the hierarchy.
  21135. </para>
  21136. </remarks>
  21137. <author>Nicko Cadell</author>
  21138. <author>Gert Driesen</author>
  21139. </member>
  21140. <member name="M:log4net.Repository.Hierarchy.RootLogger.#ctor(log4net.Core.Level)">
  21141. <summary>
  21142. Construct a <see cref="T:log4net.Repository.Hierarchy.RootLogger"/>
  21143. </summary>
  21144. <param name="level">The level to assign to the root logger.</param>
  21145. <remarks>
  21146. <para>
  21147. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.RootLogger" /> class with
  21148. the specified logging level.
  21149. </para>
  21150. <para>
  21151. The root logger names itself as "root". However, the root
  21152. logger cannot be retrieved by name.
  21153. </para>
  21154. </remarks>
  21155. </member>
  21156. <member name="P:log4net.Repository.Hierarchy.RootLogger.EffectiveLevel">
  21157. <summary>
  21158. Gets the assigned level value without walking the logger hierarchy.
  21159. </summary>
  21160. <value>The assigned level value without walking the logger hierarchy.</value>
  21161. <remarks>
  21162. <para>
  21163. Because the root logger cannot have a parent and its level
  21164. must not be <c>null</c> this property just returns the
  21165. value of <see cref="P:log4net.Repository.Hierarchy.Logger.Level"/>.
  21166. </para>
  21167. </remarks>
  21168. </member>
  21169. <member name="P:log4net.Repository.Hierarchy.RootLogger.Level">
  21170. <summary>
  21171. Gets or sets the assigned <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> for the root logger.
  21172. </summary>
  21173. <value>
  21174. The <see cref="P:log4net.Repository.Hierarchy.RootLogger.Level"/> of the root logger.
  21175. </value>
  21176. <remarks>
  21177. <para>
  21178. Setting the level of the root logger to a <c>null</c> reference
  21179. may have catastrophic results. We prevent this here.
  21180. </para>
  21181. </remarks>
  21182. </member>
  21183. <member name="F:log4net.Repository.Hierarchy.RootLogger.declaringType">
  21184. <summary>
  21185. The fully qualified type of the RootLogger class.
  21186. </summary>
  21187. <remarks>
  21188. Used by the internal logger to record the Type of the
  21189. log message.
  21190. </remarks>
  21191. </member>
  21192. <member name="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator">
  21193. <summary>
  21194. Initializes the log4net environment using an XML DOM.
  21195. </summary>
  21196. <remarks>
  21197. <para>
  21198. Configures a <see cref="T:log4net.Repository.Hierarchy.Hierarchy"/> using an XML DOM.
  21199. </para>
  21200. </remarks>
  21201. <author>Nicko Cadell</author>
  21202. <author>Gert Driesen</author>
  21203. </member>
  21204. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.#ctor(log4net.Repository.Hierarchy.Hierarchy)">
  21205. <summary>
  21206. Construct the configurator for a hierarchy
  21207. </summary>
  21208. <param name="hierarchy">The hierarchy to build.</param>
  21209. <remarks>
  21210. <para>
  21211. Initializes a new instance of the <see cref="T:log4net.Repository.Hierarchy.XmlHierarchyConfigurator" /> class
  21212. with the specified <see cref="T:log4net.Repository.Hierarchy.Hierarchy" />.
  21213. </para>
  21214. </remarks>
  21215. </member>
  21216. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.Configure(System.Xml.XmlElement)">
  21217. <summary>
  21218. Configure the hierarchy by parsing a DOM tree of XML elements.
  21219. </summary>
  21220. <param name="element">The root element to parse.</param>
  21221. <remarks>
  21222. <para>
  21223. Configure the hierarchy by parsing a DOM tree of XML elements.
  21224. </para>
  21225. </remarks>
  21226. </member>
  21227. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindAppenderByReference(System.Xml.XmlElement)">
  21228. <summary>
  21229. Parse appenders by IDREF.
  21230. </summary>
  21231. <param name="appenderRef">The appender ref element.</param>
  21232. <returns>The instance of the appender that the ref refers to.</returns>
  21233. <remarks>
  21234. <para>
  21235. Parse an XML element that represents an appender and return
  21236. the appender.
  21237. </para>
  21238. </remarks>
  21239. </member>
  21240. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseAppender(System.Xml.XmlElement)">
  21241. <summary>
  21242. Parses an appender element.
  21243. </summary>
  21244. <param name="appenderElement">The appender element.</param>
  21245. <returns>The appender instance or <c>null</c> when parsing failed.</returns>
  21246. <remarks>
  21247. <para>
  21248. Parse an XML element that represents an appender and return
  21249. the appender instance.
  21250. </para>
  21251. </remarks>
  21252. </member>
  21253. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLogger(System.Xml.XmlElement)">
  21254. <summary>
  21255. Parses a logger element.
  21256. </summary>
  21257. <param name="loggerElement">The logger element.</param>
  21258. <remarks>
  21259. <para>
  21260. Parse an XML element that represents a logger.
  21261. </para>
  21262. </remarks>
  21263. </member>
  21264. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRoot(System.Xml.XmlElement)">
  21265. <summary>
  21266. Parses the root logger element.
  21267. </summary>
  21268. <param name="rootElement">The root element.</param>
  21269. <remarks>
  21270. <para>
  21271. Parse an XML element that represents the root logger.
  21272. </para>
  21273. </remarks>
  21274. </member>
  21275. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseChildrenOfLoggerElement(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  21276. <summary>
  21277. Parses the children of a logger element.
  21278. </summary>
  21279. <param name="catElement">The category element.</param>
  21280. <param name="log">The logger instance.</param>
  21281. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  21282. <remarks>
  21283. <para>
  21284. Parse the child elements of a &lt;logger&gt; element.
  21285. </para>
  21286. </remarks>
  21287. </member>
  21288. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseRenderer(System.Xml.XmlElement)">
  21289. <summary>
  21290. Parses an object renderer.
  21291. </summary>
  21292. <param name="element">The renderer element.</param>
  21293. <remarks>
  21294. <para>
  21295. Parse an XML element that represents a renderer.
  21296. </para>
  21297. </remarks>
  21298. </member>
  21299. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ParseLevel(System.Xml.XmlElement,log4net.Repository.Hierarchy.Logger,System.Boolean)">
  21300. <summary>
  21301. Parses a level element.
  21302. </summary>
  21303. <param name="element">The level element.</param>
  21304. <param name="log">The logger object to set the level on.</param>
  21305. <param name="isRoot">Flag to indicate if the logger is the root logger.</param>
  21306. <remarks>
  21307. <para>
  21308. Parse an XML element that represents a level.
  21309. </para>
  21310. </remarks>
  21311. </member>
  21312. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.SetParameter(System.Xml.XmlElement,System.Object)">
  21313. <summary>
  21314. Sets a parameter on an object.
  21315. </summary>
  21316. <param name="element">The parameter element.</param>
  21317. <param name="target">The object to set the parameter on.</param>
  21318. <remarks>
  21319. The parameter name must correspond to a writable property
  21320. on the object. The value of the parameter is a string,
  21321. therefore this function will attempt to set a string
  21322. property first. If unable to set a string property it
  21323. will inspect the property and its argument type. It will
  21324. attempt to call a static method called <c>Parse</c> on the
  21325. type of the property. This method will take a single
  21326. string argument and return a value that can be used to
  21327. set the property.
  21328. </remarks>
  21329. </member>
  21330. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.HasAttributesOrElements(System.Xml.XmlElement)">
  21331. <summary>
  21332. Test if an element has no attributes or child elements
  21333. </summary>
  21334. <param name="element">the element to inspect</param>
  21335. <returns><c>true</c> if the element has any attributes or child elements, <c>false</c> otherwise</returns>
  21336. </member>
  21337. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.IsTypeConstructible(System.Type)">
  21338. <summary>
  21339. Test if a <see cref="T:System.Type"/> is constructible with <c>Activator.CreateInstance</c>.
  21340. </summary>
  21341. <param name="type">the type to inspect</param>
  21342. <returns><c>true</c> if the type is creatable using a default constructor, <c>false</c> otherwise</returns>
  21343. </member>
  21344. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.FindMethodInfo(System.Type,System.String)">
  21345. <summary>
  21346. Look for a method on the <paramref name="targetType"/> that matches the <paramref name="name"/> supplied
  21347. </summary>
  21348. <param name="targetType">the type that has the method</param>
  21349. <param name="name">the name of the method</param>
  21350. <returns>the method info found</returns>
  21351. <remarks>
  21352. <para>
  21353. The method must be a public instance method on the <paramref name="targetType"/>.
  21354. The method must be named <paramref name="name"/> or "Add" followed by <paramref name="name"/>.
  21355. The method must take a single parameter.
  21356. </para>
  21357. </remarks>
  21358. </member>
  21359. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.ConvertStringTo(System.Type,System.String)">
  21360. <summary>
  21361. Converts a string value to a target type.
  21362. </summary>
  21363. <param name="type">The type of object to convert the string to.</param>
  21364. <param name="value">The string value to use as the value of the object.</param>
  21365. <returns>
  21366. <para>
  21367. An object of type <paramref name="type"/> with value <paramref name="value"/> or
  21368. <c>null</c> when the conversion could not be performed.
  21369. </para>
  21370. </returns>
  21371. </member>
  21372. <member name="M:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.CreateObjectFromXml(System.Xml.XmlElement,System.Type,System.Type)">
  21373. <summary>
  21374. Creates an object as specified in XML.
  21375. </summary>
  21376. <param name="element">The XML element that contains the definition of the object.</param>
  21377. <param name="defaultTargetType">The object type to use if not explicitly specified.</param>
  21378. <param name="typeConstraint">The type that the returned object must be or must inherit from.</param>
  21379. <returns>The object or <c>null</c></returns>
  21380. <remarks>
  21381. <para>
  21382. Parse an XML element and create an object instance based on the configuration
  21383. data.
  21384. </para>
  21385. <para>
  21386. The type of the instance may be specified in the XML. If not
  21387. specified then the <paramref name="defaultTargetType"/> is used
  21388. as the type. However the type is specified it must support the
  21389. <paramref name="typeConstraint"/> type.
  21390. </para>
  21391. </remarks>
  21392. </member>
  21393. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_appenderBag">
  21394. <summary>
  21395. key: appenderName, value: appender.
  21396. </summary>
  21397. </member>
  21398. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.m_hierarchy">
  21399. <summary>
  21400. The Hierarchy being configured.
  21401. </summary>
  21402. </member>
  21403. <member name="F:log4net.Repository.Hierarchy.XmlHierarchyConfigurator.declaringType">
  21404. <summary>
  21405. The fully qualified type of the XmlHierarchyConfigurator class.
  21406. </summary>
  21407. <remarks>
  21408. Used by the internal logger to record the Type of the
  21409. log message.
  21410. </remarks>
  21411. </member>
  21412. <member name="T:log4net.Repository.IBasicRepositoryConfigurator">
  21413. <summary>
  21414. Basic Configurator interface for repositories
  21415. </summary>
  21416. <remarks>
  21417. <para>
  21418. Interface used by basic configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>
  21419. with a default <see cref="T:log4net.Appender.IAppender"/>.
  21420. </para>
  21421. <para>
  21422. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  21423. configuration by the <see cref="T:log4net.Config.BasicConfigurator"/>.
  21424. </para>
  21425. </remarks>
  21426. <author>Nicko Cadell</author>
  21427. <author>Gert Driesen</author>
  21428. </member>
  21429. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender)">
  21430. <summary>
  21431. Initialize the repository using the specified appender
  21432. </summary>
  21433. <param name="appender">the appender to use to log all logging events</param>
  21434. <remarks>
  21435. <para>
  21436. Configure the repository to route all logging events to the
  21437. specified appender.
  21438. </para>
  21439. </remarks>
  21440. </member>
  21441. <member name="M:log4net.Repository.IBasicRepositoryConfigurator.Configure(log4net.Appender.IAppender[])">
  21442. <summary>
  21443. Initialize the repository using the specified appenders
  21444. </summary>
  21445. <param name="appenders">the appenders to use to log all logging events</param>
  21446. <remarks>
  21447. <para>
  21448. Configure the repository to route all logging events to the
  21449. specified appenders.
  21450. </para>
  21451. </remarks>
  21452. </member>
  21453. <member name="T:log4net.Repository.LoggerRepositoryShutdownEventHandler">
  21454. <summary>
  21455. Delegate used to handle logger repository shutdown event notifications
  21456. </summary>
  21457. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that is shutting down.</param>
  21458. <param name="e">Empty event args</param>
  21459. <remarks>
  21460. <para>
  21461. Delegate used to handle logger repository shutdown event notifications.
  21462. </para>
  21463. </remarks>
  21464. </member>
  21465. <member name="T:log4net.Repository.LoggerRepositoryConfigurationResetEventHandler">
  21466. <summary>
  21467. Delegate used to handle logger repository configuration reset event notifications
  21468. </summary>
  21469. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration reset.</param>
  21470. <param name="e">Empty event args</param>
  21471. <remarks>
  21472. <para>
  21473. Delegate used to handle logger repository configuration reset event notifications.
  21474. </para>
  21475. </remarks>
  21476. </member>
  21477. <member name="T:log4net.Repository.LoggerRepositoryConfigurationChangedEventHandler">
  21478. <summary>
  21479. Delegate used to handle event notifications for logger repository configuration changes.
  21480. </summary>
  21481. <param name="sender">The <see cref="T:log4net.Repository.ILoggerRepository"/> that has had its configuration changed.</param>
  21482. <param name="e">Empty event arguments.</param>
  21483. <remarks>
  21484. <para>
  21485. Delegate used to handle event notifications for logger repository configuration changes.
  21486. </para>
  21487. </remarks>
  21488. </member>
  21489. <member name="T:log4net.Repository.ILoggerRepository">
  21490. <summary>
  21491. Interface implemented by logger repositories.
  21492. </summary>
  21493. <remarks>
  21494. <para>
  21495. This interface is implemented by logger repositories. e.g.
  21496. <see cref="N:log4net.Repository.Hierarchy"/>.
  21497. </para>
  21498. <para>
  21499. This interface is used by the <see cref="T:log4net.LogManager"/>
  21500. to obtain <see cref="T:log4net.ILog"/> interfaces.
  21501. </para>
  21502. </remarks>
  21503. <author>Nicko Cadell</author>
  21504. <author>Gert Driesen</author>
  21505. </member>
  21506. <member name="P:log4net.Repository.ILoggerRepository.Name">
  21507. <summary>
  21508. The name of the repository
  21509. </summary>
  21510. <value>
  21511. The name of the repository
  21512. </value>
  21513. <remarks>
  21514. <para>
  21515. The name of the repository.
  21516. </para>
  21517. </remarks>
  21518. </member>
  21519. <member name="P:log4net.Repository.ILoggerRepository.RendererMap">
  21520. <summary>
  21521. RendererMap accesses the object renderer map for this repository.
  21522. </summary>
  21523. <value>
  21524. RendererMap accesses the object renderer map for this repository.
  21525. </value>
  21526. <remarks>
  21527. <para>
  21528. RendererMap accesses the object renderer map for this repository.
  21529. </para>
  21530. <para>
  21531. The RendererMap holds a mapping between types and
  21532. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  21533. </para>
  21534. </remarks>
  21535. </member>
  21536. <member name="P:log4net.Repository.ILoggerRepository.PluginMap">
  21537. <summary>
  21538. The plugin map for this repository.
  21539. </summary>
  21540. <value>
  21541. The plugin map for this repository.
  21542. </value>
  21543. <remarks>
  21544. <para>
  21545. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  21546. that have been attached to this repository.
  21547. </para>
  21548. </remarks>
  21549. </member>
  21550. <member name="P:log4net.Repository.ILoggerRepository.LevelMap">
  21551. <summary>
  21552. Get the level map for the Repository.
  21553. </summary>
  21554. <remarks>
  21555. <para>
  21556. Get the level map for the Repository.
  21557. </para>
  21558. <para>
  21559. The level map defines the mappings between
  21560. level names and <see cref="T:log4net.Core.Level"/> objects in
  21561. this repository.
  21562. </para>
  21563. </remarks>
  21564. </member>
  21565. <member name="P:log4net.Repository.ILoggerRepository.Threshold">
  21566. <summary>
  21567. The threshold for all events in this repository
  21568. </summary>
  21569. <value>
  21570. The threshold for all events in this repository
  21571. </value>
  21572. <remarks>
  21573. <para>
  21574. The threshold for all events in this repository.
  21575. </para>
  21576. </remarks>
  21577. </member>
  21578. <member name="M:log4net.Repository.ILoggerRepository.Exists(System.String)">
  21579. <summary>
  21580. Check if the named logger exists in the repository. If so return
  21581. its reference, otherwise returns <c>null</c>.
  21582. </summary>
  21583. <param name="name">The name of the logger to lookup</param>
  21584. <returns>The Logger object with the name specified</returns>
  21585. <remarks>
  21586. <para>
  21587. If the names logger exists it is returned, otherwise
  21588. <c>null</c> is returned.
  21589. </para>
  21590. </remarks>
  21591. </member>
  21592. <member name="M:log4net.Repository.ILoggerRepository.GetCurrentLoggers">
  21593. <summary>
  21594. Returns all the currently defined loggers as an Array.
  21595. </summary>
  21596. <returns>All the defined loggers</returns>
  21597. <remarks>
  21598. <para>
  21599. Returns all the currently defined loggers as an Array.
  21600. </para>
  21601. </remarks>
  21602. </member>
  21603. <member name="M:log4net.Repository.ILoggerRepository.GetLogger(System.String)">
  21604. <summary>
  21605. Returns a named logger instance
  21606. </summary>
  21607. <param name="name">The name of the logger to retrieve</param>
  21608. <returns>The logger object with the name specified</returns>
  21609. <remarks>
  21610. <para>
  21611. Returns a named logger instance.
  21612. </para>
  21613. <para>
  21614. If a logger of that name already exists, then it will be
  21615. returned. Otherwise, a new logger will be instantiated and
  21616. then linked with its existing ancestors as well as children.
  21617. </para>
  21618. </remarks>
  21619. </member>
  21620. <member name="M:log4net.Repository.ILoggerRepository.Shutdown">
  21621. <summary>Shutdown the repository</summary>
  21622. <remarks>
  21623. <para>
  21624. Shutting down a repository will <i>safely</i> close and remove
  21625. all appenders in all loggers including the root logger.
  21626. </para>
  21627. <para>
  21628. Some appenders need to be closed before the
  21629. application exists. Otherwise, pending logging events might be
  21630. lost.
  21631. </para>
  21632. <para>
  21633. The <see cref="M:Shutdown()"/> method is careful to close nested
  21634. appenders before closing regular appenders. This is allows
  21635. configurations where a regular appender is attached to a logger
  21636. and again to a nested appender.
  21637. </para>
  21638. </remarks>
  21639. </member>
  21640. <member name="M:log4net.Repository.ILoggerRepository.ResetConfiguration">
  21641. <summary>
  21642. Reset the repositories configuration to a default state
  21643. </summary>
  21644. <remarks>
  21645. <para>
  21646. Reset all values contained in this instance to their
  21647. default state.
  21648. </para>
  21649. <para>
  21650. Existing loggers are not removed. They are just reset.
  21651. </para>
  21652. <para>
  21653. This method should be used sparingly and with care as it will
  21654. block all logging until it is completed.
  21655. </para>
  21656. </remarks>
  21657. </member>
  21658. <member name="M:log4net.Repository.ILoggerRepository.Log(log4net.Core.LoggingEvent)">
  21659. <summary>
  21660. Log the <see cref="T:log4net.Core.LoggingEvent"/> through this repository.
  21661. </summary>
  21662. <param name="logEvent">the event to log</param>
  21663. <remarks>
  21664. <para>
  21665. This method should not normally be used to log.
  21666. The <see cref="T:log4net.ILog"/> interface should be used
  21667. for routine logging. This interface can be obtained
  21668. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  21669. </para>
  21670. <para>
  21671. The <c>logEvent</c> is delivered to the appropriate logger and
  21672. that logger is then responsible for logging the event.
  21673. </para>
  21674. </remarks>
  21675. </member>
  21676. <member name="P:log4net.Repository.ILoggerRepository.Configured">
  21677. <summary>
  21678. Flag indicates if this repository has been configured.
  21679. </summary>
  21680. <value>
  21681. Flag indicates if this repository has been configured.
  21682. </value>
  21683. <remarks>
  21684. <para>
  21685. Flag indicates if this repository has been configured.
  21686. </para>
  21687. </remarks>
  21688. </member>
  21689. <member name="P:log4net.Repository.ILoggerRepository.ConfigurationMessages">
  21690. <summary>
  21691. Collection of internal messages captured during the most
  21692. recent configuration process.
  21693. </summary>
  21694. </member>
  21695. <member name="E:log4net.Repository.ILoggerRepository.ShutdownEvent">
  21696. <summary>
  21697. Event to notify that the repository has been shutdown.
  21698. </summary>
  21699. <value>
  21700. Event to notify that the repository has been shutdown.
  21701. </value>
  21702. <remarks>
  21703. <para>
  21704. Event raised when the repository has been shutdown.
  21705. </para>
  21706. </remarks>
  21707. </member>
  21708. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationReset">
  21709. <summary>
  21710. Event to notify that the repository has had its configuration reset.
  21711. </summary>
  21712. <value>
  21713. Event to notify that the repository has had its configuration reset.
  21714. </value>
  21715. <remarks>
  21716. <para>
  21717. Event raised when the repository's configuration has been
  21718. reset to default.
  21719. </para>
  21720. </remarks>
  21721. </member>
  21722. <member name="E:log4net.Repository.ILoggerRepository.ConfigurationChanged">
  21723. <summary>
  21724. Event to notify that the repository has had its configuration changed.
  21725. </summary>
  21726. <value>
  21727. Event to notify that the repository has had its configuration changed.
  21728. </value>
  21729. <remarks>
  21730. <para>
  21731. Event raised when the repository's configuration has been changed.
  21732. </para>
  21733. </remarks>
  21734. </member>
  21735. <member name="P:log4net.Repository.ILoggerRepository.Properties">
  21736. <summary>
  21737. Repository specific properties
  21738. </summary>
  21739. <value>
  21740. Repository specific properties
  21741. </value>
  21742. <remarks>
  21743. <para>
  21744. These properties can be specified on a repository specific basis.
  21745. </para>
  21746. </remarks>
  21747. </member>
  21748. <member name="M:log4net.Repository.ILoggerRepository.GetAppenders">
  21749. <summary>
  21750. Returns all the Appenders that are configured as an Array.
  21751. </summary>
  21752. <returns>All the Appenders</returns>
  21753. <remarks>
  21754. <para>
  21755. Returns all the Appenders that are configured as an Array.
  21756. </para>
  21757. </remarks>
  21758. </member>
  21759. <member name="T:log4net.Repository.IXmlRepositoryConfigurator">
  21760. <summary>
  21761. Configure repository using XML
  21762. </summary>
  21763. <remarks>
  21764. <para>
  21765. Interface used by Xml configurator to configure a <see cref="T:log4net.Repository.ILoggerRepository"/>.
  21766. </para>
  21767. <para>
  21768. A <see cref="T:log4net.Repository.ILoggerRepository"/> should implement this interface to support
  21769. configuration by the <see cref="T:log4net.Config.XmlConfigurator"/>.
  21770. </para>
  21771. </remarks>
  21772. <author>Nicko Cadell</author>
  21773. <author>Gert Driesen</author>
  21774. </member>
  21775. <member name="M:log4net.Repository.IXmlRepositoryConfigurator.Configure(System.Xml.XmlElement)">
  21776. <summary>
  21777. Initialize the repository using the specified config
  21778. </summary>
  21779. <param name="element">the element containing the root of the config</param>
  21780. <remarks>
  21781. <para>
  21782. The schema for the XML configuration data is defined by
  21783. the implementation.
  21784. </para>
  21785. </remarks>
  21786. </member>
  21787. <member name="T:log4net.Repository.LoggerRepositorySkeleton">
  21788. <summary>
  21789. Base implementation of <see cref="T:log4net.Repository.ILoggerRepository"/>
  21790. </summary>
  21791. <remarks>
  21792. <para>
  21793. Default abstract implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21794. </para>
  21795. <para>
  21796. Skeleton implementation of the <see cref="T:log4net.Repository.ILoggerRepository"/> interface.
  21797. All <see cref="T:log4net.Repository.ILoggerRepository"/> types can extend this type.
  21798. </para>
  21799. </remarks>
  21800. <author>Nicko Cadell</author>
  21801. <author>Gert Driesen</author>
  21802. </member>
  21803. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor">
  21804. <summary>
  21805. Default Constructor
  21806. </summary>
  21807. <remarks>
  21808. <para>
  21809. Initializes the repository with default (empty) properties.
  21810. </para>
  21811. </remarks>
  21812. </member>
  21813. <member name="M:log4net.Repository.LoggerRepositorySkeleton.#ctor(log4net.Util.PropertiesDictionary)">
  21814. <summary>
  21815. Construct the repository using specific properties
  21816. </summary>
  21817. <param name="properties">the properties to set for this repository</param>
  21818. <remarks>
  21819. <para>
  21820. Initializes the repository with specified properties.
  21821. </para>
  21822. </remarks>
  21823. </member>
  21824. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Name">
  21825. <summary>
  21826. The name of the repository
  21827. </summary>
  21828. <value>
  21829. The string name of the repository
  21830. </value>
  21831. <remarks>
  21832. <para>
  21833. The name of this repository. The name is
  21834. used to store and lookup the repositories
  21835. stored by the <see cref="T:log4net.Core.IRepositorySelector"/>.
  21836. </para>
  21837. </remarks>
  21838. </member>
  21839. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Threshold">
  21840. <summary>
  21841. The threshold for all events in this repository
  21842. </summary>
  21843. <value>
  21844. The threshold for all events in this repository
  21845. </value>
  21846. <remarks>
  21847. <para>
  21848. The threshold for all events in this repository
  21849. </para>
  21850. </remarks>
  21851. </member>
  21852. <member name="P:log4net.Repository.LoggerRepositorySkeleton.RendererMap">
  21853. <summary>
  21854. RendererMap accesses the object renderer map for this repository.
  21855. </summary>
  21856. <value>
  21857. RendererMap accesses the object renderer map for this repository.
  21858. </value>
  21859. <remarks>
  21860. <para>
  21861. RendererMap accesses the object renderer map for this repository.
  21862. </para>
  21863. <para>
  21864. The RendererMap holds a mapping between types and
  21865. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/> objects.
  21866. </para>
  21867. </remarks>
  21868. </member>
  21869. <member name="P:log4net.Repository.LoggerRepositorySkeleton.PluginMap">
  21870. <summary>
  21871. The plugin map for this repository.
  21872. </summary>
  21873. <value>
  21874. The plugin map for this repository.
  21875. </value>
  21876. <remarks>
  21877. <para>
  21878. The plugin map holds the <see cref="T:log4net.Plugin.IPlugin"/> instances
  21879. that have been attached to this repository.
  21880. </para>
  21881. </remarks>
  21882. </member>
  21883. <member name="P:log4net.Repository.LoggerRepositorySkeleton.LevelMap">
  21884. <summary>
  21885. Get the level map for the Repository.
  21886. </summary>
  21887. <remarks>
  21888. <para>
  21889. Get the level map for the Repository.
  21890. </para>
  21891. <para>
  21892. The level map defines the mappings between
  21893. level names and <see cref="T:log4net.Core.Level"/> objects in
  21894. this repository.
  21895. </para>
  21896. </remarks>
  21897. </member>
  21898. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Exists(System.String)">
  21899. <summary>
  21900. Test if logger exists
  21901. </summary>
  21902. <param name="name">The name of the logger to lookup</param>
  21903. <returns>The Logger object with the name specified</returns>
  21904. <remarks>
  21905. <para>
  21906. Check if the named logger exists in the repository. If so return
  21907. its reference, otherwise returns <c>null</c>.
  21908. </para>
  21909. </remarks>
  21910. </member>
  21911. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetCurrentLoggers">
  21912. <summary>
  21913. Returns all the currently defined loggers in the repository
  21914. </summary>
  21915. <returns>All the defined loggers</returns>
  21916. <remarks>
  21917. <para>
  21918. Returns all the currently defined loggers in the repository as an Array.
  21919. </para>
  21920. </remarks>
  21921. </member>
  21922. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetLogger(System.String)">
  21923. <summary>
  21924. Return a new logger instance
  21925. </summary>
  21926. <param name="name">The name of the logger to retrieve</param>
  21927. <returns>The logger object with the name specified</returns>
  21928. <remarks>
  21929. <para>
  21930. Return a new logger instance.
  21931. </para>
  21932. <para>
  21933. If a logger of that name already exists, then it will be
  21934. returned. Otherwise, a new logger will be instantiated and
  21935. then linked with its existing ancestors as well as children.
  21936. </para>
  21937. </remarks>
  21938. </member>
  21939. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Shutdown">
  21940. <summary>
  21941. Shutdown the repository
  21942. </summary>
  21943. <remarks>
  21944. <para>
  21945. Shutdown the repository. Can be overridden in a subclass.
  21946. This base class implementation notifies the <see cref="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent"/>
  21947. listeners and all attached plugins of the shutdown event.
  21948. </para>
  21949. </remarks>
  21950. </member>
  21951. <member name="M:log4net.Repository.LoggerRepositorySkeleton.ResetConfiguration">
  21952. <summary>
  21953. Reset the repositories configuration to a default state
  21954. </summary>
  21955. <remarks>
  21956. <para>
  21957. Reset all values contained in this instance to their
  21958. default state.
  21959. </para>
  21960. <para>
  21961. Existing loggers are not removed. They are just reset.
  21962. </para>
  21963. <para>
  21964. This method should be used sparingly and with care as it will
  21965. block all logging until it is completed.
  21966. </para>
  21967. </remarks>
  21968. </member>
  21969. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Log(log4net.Core.LoggingEvent)">
  21970. <summary>
  21971. Log the logEvent through this repository.
  21972. </summary>
  21973. <param name="logEvent">the event to log</param>
  21974. <remarks>
  21975. <para>
  21976. This method should not normally be used to log.
  21977. The <see cref="T:log4net.ILog"/> interface should be used
  21978. for routine logging. This interface can be obtained
  21979. using the <see cref="M:log4net.LogManager.GetLogger(string)"/> method.
  21980. </para>
  21981. <para>
  21982. The <c>logEvent</c> is delivered to the appropriate logger and
  21983. that logger is then responsible for logging the event.
  21984. </para>
  21985. </remarks>
  21986. </member>
  21987. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Configured">
  21988. <summary>
  21989. Flag indicates if this repository has been configured.
  21990. </summary>
  21991. <value>
  21992. Flag indicates if this repository has been configured.
  21993. </value>
  21994. <remarks>
  21995. <para>
  21996. Flag indicates if this repository has been configured.
  21997. </para>
  21998. </remarks>
  21999. </member>
  22000. <member name="P:log4net.Repository.LoggerRepositorySkeleton.ConfigurationMessages">
  22001. <summary>
  22002. Contains a list of internal messages captures during the
  22003. last configuration.
  22004. </summary>
  22005. </member>
  22006. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ShutdownEvent">
  22007. <summary>
  22008. Event to notify that the repository has been shutdown.
  22009. </summary>
  22010. <value>
  22011. Event to notify that the repository has been shutdown.
  22012. </value>
  22013. <remarks>
  22014. <para>
  22015. Event raised when the repository has been shutdown.
  22016. </para>
  22017. </remarks>
  22018. </member>
  22019. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationReset">
  22020. <summary>
  22021. Event to notify that the repository has had its configuration reset.
  22022. </summary>
  22023. <value>
  22024. Event to notify that the repository has had its configuration reset.
  22025. </value>
  22026. <remarks>
  22027. <para>
  22028. Event raised when the repository's configuration has been
  22029. reset to default.
  22030. </para>
  22031. </remarks>
  22032. </member>
  22033. <member name="E:log4net.Repository.LoggerRepositorySkeleton.ConfigurationChanged">
  22034. <summary>
  22035. Event to notify that the repository has had its configuration changed.
  22036. </summary>
  22037. <value>
  22038. Event to notify that the repository has had its configuration changed.
  22039. </value>
  22040. <remarks>
  22041. <para>
  22042. Event raised when the repository's configuration has been changed.
  22043. </para>
  22044. </remarks>
  22045. </member>
  22046. <member name="P:log4net.Repository.LoggerRepositorySkeleton.Properties">
  22047. <summary>
  22048. Repository specific properties
  22049. </summary>
  22050. <value>
  22051. Repository specific properties
  22052. </value>
  22053. <remarks>
  22054. These properties can be specified on a repository specific basis
  22055. </remarks>
  22056. </member>
  22057. <member name="M:log4net.Repository.LoggerRepositorySkeleton.GetAppenders">
  22058. <summary>
  22059. Returns all the Appenders that are configured as an Array.
  22060. </summary>
  22061. <returns>All the Appenders</returns>
  22062. <remarks>
  22063. <para>
  22064. Returns all the Appenders that are configured as an Array.
  22065. </para>
  22066. </remarks>
  22067. </member>
  22068. <member name="F:log4net.Repository.LoggerRepositorySkeleton.declaringType">
  22069. <summary>
  22070. The fully qualified type of the LoggerRepositorySkeleton class.
  22071. </summary>
  22072. <remarks>
  22073. Used by the internal logger to record the Type of the
  22074. log message.
  22075. </remarks>
  22076. </member>
  22077. <member name="M:log4net.Repository.LoggerRepositorySkeleton.AddRenderer(System.Type,log4net.ObjectRenderer.IObjectRenderer)">
  22078. <summary>
  22079. Adds an object renderer for a specific class.
  22080. </summary>
  22081. <param name="typeToRender">The type that will be rendered by the renderer supplied.</param>
  22082. <param name="rendererInstance">The object renderer used to render the object.</param>
  22083. <remarks>
  22084. <para>
  22085. Adds an object renderer for a specific class.
  22086. </para>
  22087. </remarks>
  22088. </member>
  22089. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnShutdown(System.EventArgs)">
  22090. <summary>
  22091. Notify the registered listeners that the repository is shutting down
  22092. </summary>
  22093. <param name="e">Empty EventArgs</param>
  22094. <remarks>
  22095. <para>
  22096. Notify any listeners that this repository is shutting down.
  22097. </para>
  22098. </remarks>
  22099. </member>
  22100. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationReset(System.EventArgs)">
  22101. <summary>
  22102. Notify the registered listeners that the repository has had its configuration reset
  22103. </summary>
  22104. <param name="e">Empty EventArgs</param>
  22105. <remarks>
  22106. <para>
  22107. Notify any listeners that this repository's configuration has been reset.
  22108. </para>
  22109. </remarks>
  22110. </member>
  22111. <member name="M:log4net.Repository.LoggerRepositorySkeleton.OnConfigurationChanged(System.EventArgs)">
  22112. <summary>
  22113. Notify the registered listeners that the repository has had its configuration changed
  22114. </summary>
  22115. <param name="e">Empty EventArgs</param>
  22116. <remarks>
  22117. <para>
  22118. Notify any listeners that this repository's configuration has changed.
  22119. </para>
  22120. </remarks>
  22121. </member>
  22122. <member name="M:log4net.Repository.LoggerRepositorySkeleton.RaiseConfigurationChanged(System.EventArgs)">
  22123. <summary>
  22124. Raise a configuration changed event on this repository
  22125. </summary>
  22126. <param name="e">EventArgs.Empty</param>
  22127. <remarks>
  22128. <para>
  22129. Applications that programmatically change the configuration of the repository should
  22130. raise this event notification to notify listeners.
  22131. </para>
  22132. </remarks>
  22133. </member>
  22134. <member name="M:log4net.Repository.LoggerRepositorySkeleton.Flush(System.Int32)">
  22135. <summary>
  22136. Flushes all configured Appenders that implement <see cref="T:log4net.Appender.IFlushable"/>.
  22137. </summary>
  22138. <param name="millisecondsTimeout">The maximum time in milliseconds to wait for logging events from asycnhronous appenders to be flushed,
  22139. or <see cref="F:System.Threading.Timeout.Infinite"/> to wait indefinitely.</param>
  22140. <returns><c>True</c> if all logging events were flushed successfully, else <c>false</c>.</returns>
  22141. </member>
  22142. <member name="T:log4net.ThreadContext">
  22143. <summary>
  22144. The log4net Thread Context.
  22145. </summary>
  22146. <remarks>
  22147. <para>
  22148. The <c>ThreadContext</c> provides a location for thread specific debugging
  22149. information to be stored.
  22150. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  22151. properties with the same name.
  22152. </para>
  22153. <para>
  22154. The thread context has a properties map and a stack.
  22155. The properties and stack can
  22156. be included in the output of log messages. The <see cref="T:log4net.Layout.PatternLayout"/>
  22157. supports selecting and outputting these properties.
  22158. </para>
  22159. <para>
  22160. The Thread Context provides a diagnostic context for the current thread.
  22161. This is an instrument for distinguishing interleaved log
  22162. output from different sources. Log output is typically interleaved
  22163. when a server handles multiple clients near-simultaneously.
  22164. </para>
  22165. <para>
  22166. The Thread Context is managed on a per thread basis.
  22167. </para>
  22168. </remarks>
  22169. <example>Example of using the thread context properties to store a username.
  22170. <code lang="C#">
  22171. ThreadContext.Properties["user"] = userName;
  22172. log.Info("This log message has a ThreadContext Property called 'user'");
  22173. </code>
  22174. </example>
  22175. <example>Example of how to push a message into the context stack
  22176. <code lang="C#">
  22177. using(ThreadContext.Stacks["NDC"].Push("my context message"))
  22178. {
  22179. log.Info("This log message has a ThreadContext Stack message that includes 'my context message'");
  22180. } // at the end of the using block the message is automatically popped
  22181. </code>
  22182. </example>
  22183. <threadsafety static="true" instance="true" />
  22184. <author>Nicko Cadell</author>
  22185. </member>
  22186. <member name="M:log4net.ThreadContext.#ctor">
  22187. <summary>
  22188. Private Constructor.
  22189. </summary>
  22190. <remarks>
  22191. <para>
  22192. Uses a private access modifier to prevent instantiation of this class.
  22193. </para>
  22194. </remarks>
  22195. </member>
  22196. <member name="P:log4net.ThreadContext.Properties">
  22197. <summary>
  22198. The thread properties map
  22199. </summary>
  22200. <value>
  22201. The thread properties map
  22202. </value>
  22203. <remarks>
  22204. <para>
  22205. The <c>ThreadContext</c> properties override any <see cref="T:log4net.GlobalContext"/>
  22206. properties with the same name.
  22207. </para>
  22208. </remarks>
  22209. </member>
  22210. <member name="P:log4net.ThreadContext.Stacks">
  22211. <summary>
  22212. The thread stacks
  22213. </summary>
  22214. <value>
  22215. stack map
  22216. </value>
  22217. <remarks>
  22218. <para>
  22219. The thread local stacks.
  22220. </para>
  22221. </remarks>
  22222. </member>
  22223. <member name="F:log4net.ThreadContext.s_properties">
  22224. <summary>
  22225. The thread context properties instance
  22226. </summary>
  22227. </member>
  22228. <member name="F:log4net.ThreadContext.s_stacks">
  22229. <summary>
  22230. The thread context stacks instance
  22231. </summary>
  22232. </member>
  22233. <member name="T:log4net.Util.AppenderAttachedImpl">
  22234. <summary>
  22235. A straightforward implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface.
  22236. </summary>
  22237. <remarks>
  22238. <para>
  22239. This is the default implementation of the <see cref="T:log4net.Core.IAppenderAttachable"/>
  22240. interface. Implementors of the <see cref="T:log4net.Core.IAppenderAttachable"/> interface
  22241. should aggregate an instance of this type.
  22242. </para>
  22243. </remarks>
  22244. <author>Nicko Cadell</author>
  22245. <author>Gert Driesen</author>
  22246. </member>
  22247. <member name="M:log4net.Util.AppenderAttachedImpl.#ctor">
  22248. <summary>
  22249. Constructor
  22250. </summary>
  22251. <remarks>
  22252. <para>
  22253. Initializes a new instance of the <see cref="T:log4net.Util.AppenderAttachedImpl"/> class.
  22254. </para>
  22255. </remarks>
  22256. </member>
  22257. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent)">
  22258. <summary>
  22259. Append on on all attached appenders.
  22260. </summary>
  22261. <param name="loggingEvent">The event being logged.</param>
  22262. <returns>The number of appenders called.</returns>
  22263. <remarks>
  22264. <para>
  22265. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)" /> method on all
  22266. attached appenders.
  22267. </para>
  22268. </remarks>
  22269. </member>
  22270. <member name="M:log4net.Util.AppenderAttachedImpl.AppendLoopOnAppenders(log4net.Core.LoggingEvent[])">
  22271. <summary>
  22272. Append on on all attached appenders.
  22273. </summary>
  22274. <param name="loggingEvents">The array of events being logged.</param>
  22275. <returns>The number of appenders called.</returns>
  22276. <remarks>
  22277. <para>
  22278. Calls the <see cref="M:log4net.Appender.IAppender.DoAppend(log4net.Core.LoggingEvent)" /> method on all
  22279. attached appenders.
  22280. </para>
  22281. </remarks>
  22282. </member>
  22283. <member name="M:log4net.Util.AppenderAttachedImpl.CallAppend(log4net.Appender.IAppender,log4net.Core.LoggingEvent[])">
  22284. <summary>
  22285. Calls the DoAppende method on the <see cref="T:log4net.Appender.IAppender"/> with
  22286. the <see cref="T:log4net.Core.LoggingEvent"/> objects supplied.
  22287. </summary>
  22288. <param name="appender">The appender</param>
  22289. <param name="loggingEvents">The events</param>
  22290. <remarks>
  22291. <para>
  22292. If the <paramref name="appender" /> supports the <see cref="T:log4net.Appender.IBulkAppender"/>
  22293. interface then the <paramref name="loggingEvents" /> will be passed
  22294. through using that interface. Otherwise the <see cref="T:log4net.Core.LoggingEvent"/>
  22295. objects in the array will be passed one at a time.
  22296. </para>
  22297. </remarks>
  22298. </member>
  22299. <member name="M:log4net.Util.AppenderAttachedImpl.AddAppender(log4net.Appender.IAppender)">
  22300. <summary>
  22301. Attaches an appender.
  22302. </summary>
  22303. <param name="newAppender">The appender to add.</param>
  22304. <remarks>
  22305. <para>
  22306. If the appender is already in the list it won't be added again.
  22307. </para>
  22308. </remarks>
  22309. </member>
  22310. <member name="P:log4net.Util.AppenderAttachedImpl.Appenders">
  22311. <summary>
  22312. Gets all attached appenders.
  22313. </summary>
  22314. <returns>
  22315. A collection of attached appenders, or <c>null</c> if there
  22316. are no attached appenders.
  22317. </returns>
  22318. <remarks>
  22319. <para>
  22320. The read only collection of all currently attached appenders.
  22321. </para>
  22322. </remarks>
  22323. </member>
  22324. <member name="M:log4net.Util.AppenderAttachedImpl.GetAppender(System.String)">
  22325. <summary>
  22326. Gets an attached appender with the specified name.
  22327. </summary>
  22328. <param name="name">The name of the appender to get.</param>
  22329. <returns>
  22330. The appender with the name specified, or <c>null</c> if no appender with the
  22331. specified name is found.
  22332. </returns>
  22333. <remarks>
  22334. <para>
  22335. Lookup an attached appender by name.
  22336. </para>
  22337. </remarks>
  22338. </member>
  22339. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAllAppenders">
  22340. <summary>
  22341. Removes all attached appenders.
  22342. </summary>
  22343. <remarks>
  22344. <para>
  22345. Removes and closes all attached appenders
  22346. </para>
  22347. </remarks>
  22348. </member>
  22349. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(log4net.Appender.IAppender)">
  22350. <summary>
  22351. Removes the specified appender from the list of attached appenders.
  22352. </summary>
  22353. <param name="appender">The appender to remove.</param>
  22354. <returns>The appender removed from the list</returns>
  22355. <remarks>
  22356. <para>
  22357. The appender removed is not closed.
  22358. If you are discarding the appender you must call
  22359. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  22360. </para>
  22361. </remarks>
  22362. </member>
  22363. <member name="M:log4net.Util.AppenderAttachedImpl.RemoveAppender(System.String)">
  22364. <summary>
  22365. Removes the appender with the specified name from the list of appenders.
  22366. </summary>
  22367. <param name="name">The name of the appender to remove.</param>
  22368. <returns>The appender removed from the list</returns>
  22369. <remarks>
  22370. <para>
  22371. The appender removed is not closed.
  22372. If you are discarding the appender you must call
  22373. <see cref="M:log4net.Appender.IAppender.Close"/> on the appender removed.
  22374. </para>
  22375. </remarks>
  22376. </member>
  22377. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderList">
  22378. <summary>
  22379. List of appenders
  22380. </summary>
  22381. </member>
  22382. <member name="F:log4net.Util.AppenderAttachedImpl.m_appenderArray">
  22383. <summary>
  22384. Array of appenders, used to cache the m_appenderList
  22385. </summary>
  22386. </member>
  22387. <member name="F:log4net.Util.AppenderAttachedImpl.declaringType">
  22388. <summary>
  22389. The fully qualified type of the AppenderAttachedImpl class.
  22390. </summary>
  22391. <remarks>
  22392. Used by the internal logger to record the Type of the
  22393. log message.
  22394. </remarks>
  22395. </member>
  22396. <member name="T:log4net.Util.CompositeProperties">
  22397. <summary>
  22398. This class aggregates several PropertiesDictionary collections together.
  22399. </summary>
  22400. <remarks>
  22401. <para>
  22402. Provides a dictionary style lookup over an ordered list of
  22403. <see cref="T:log4net.Util.PropertiesDictionary"/> collections.
  22404. </para>
  22405. </remarks>
  22406. <author>Nicko Cadell</author>
  22407. </member>
  22408. <member name="M:log4net.Util.CompositeProperties.#ctor">
  22409. <summary>
  22410. Constructor
  22411. </summary>
  22412. <remarks>
  22413. <para>
  22414. Initializes a new instance of the <see cref="T:log4net.Util.CompositeProperties" /> class.
  22415. </para>
  22416. </remarks>
  22417. </member>
  22418. <member name="P:log4net.Util.CompositeProperties.Item(System.String)">
  22419. <summary>
  22420. Gets the value of a property
  22421. </summary>
  22422. <value>
  22423. The value for the property with the specified key
  22424. </value>
  22425. <remarks>
  22426. <para>
  22427. Looks up the value for the <paramref name="key" /> specified.
  22428. The <see cref="T:log4net.Util.PropertiesDictionary"/> collections are searched
  22429. in the order in which they were added to this collection. The value
  22430. returned is the value held by the first collection that contains
  22431. the specified key.
  22432. </para>
  22433. <para>
  22434. If none of the collections contain the specified key then
  22435. <c>null</c> is returned.
  22436. </para>
  22437. </remarks>
  22438. </member>
  22439. <member name="M:log4net.Util.CompositeProperties.Add(log4net.Util.ReadOnlyPropertiesDictionary)">
  22440. <summary>
  22441. Add a Properties Dictionary to this composite collection
  22442. </summary>
  22443. <param name="properties">the properties to add</param>
  22444. <remarks>
  22445. <para>
  22446. Properties dictionaries added first take precedence over dictionaries added
  22447. later.
  22448. </para>
  22449. </remarks>
  22450. </member>
  22451. <member name="M:log4net.Util.CompositeProperties.Flatten">
  22452. <summary>
  22453. Flatten this composite collection into a single properties dictionary
  22454. </summary>
  22455. <returns>the flattened dictionary</returns>
  22456. <remarks>
  22457. <para>
  22458. Reduces the collection of ordered dictionaries to a single dictionary
  22459. containing the resultant values for the keys.
  22460. </para>
  22461. </remarks>
  22462. </member>
  22463. <member name="T:log4net.Util.ContextPropertiesBase">
  22464. <summary>
  22465. Base class for Context Properties implementations
  22466. </summary>
  22467. <remarks>
  22468. <para>
  22469. This class defines a basic property get set accessor
  22470. </para>
  22471. </remarks>
  22472. <author>Nicko Cadell</author>
  22473. </member>
  22474. <member name="P:log4net.Util.ContextPropertiesBase.Item(System.String)">
  22475. <summary>
  22476. Gets or sets the value of a property
  22477. </summary>
  22478. <value>
  22479. The value for the property with the specified key
  22480. </value>
  22481. <remarks>
  22482. <para>
  22483. Gets or sets the value of a property
  22484. </para>
  22485. </remarks>
  22486. </member>
  22487. <member name="T:log4net.Util.ConverterInfo">
  22488. <summary>
  22489. Wrapper class used to map converter names to converter types
  22490. </summary>
  22491. <remarks>
  22492. <para>
  22493. Pattern converter info class used during configuration by custom
  22494. PatternString and PatternLayer converters.
  22495. </para>
  22496. </remarks>
  22497. </member>
  22498. <member name="M:log4net.Util.ConverterInfo.#ctor">
  22499. <summary>
  22500. default constructor
  22501. </summary>
  22502. </member>
  22503. <member name="P:log4net.Util.ConverterInfo.Name">
  22504. <summary>
  22505. Gets or sets the name of the conversion pattern
  22506. </summary>
  22507. <remarks>
  22508. <para>
  22509. The name of the pattern in the format string
  22510. </para>
  22511. </remarks>
  22512. </member>
  22513. <member name="P:log4net.Util.ConverterInfo.Type">
  22514. <summary>
  22515. Gets or sets the type of the converter
  22516. </summary>
  22517. <remarks>
  22518. <para>
  22519. The value specified must extend the
  22520. <see cref="T:log4net.Util.PatternConverter"/> type.
  22521. </para>
  22522. </remarks>
  22523. </member>
  22524. <member name="M:log4net.Util.ConverterInfo.AddProperty(log4net.Util.PropertyEntry)">
  22525. <summary>
  22526. </summary>
  22527. <param name="entry"></param>
  22528. </member>
  22529. <member name="P:log4net.Util.ConverterInfo.Properties">
  22530. <summary>
  22531. </summary>
  22532. </member>
  22533. <member name="T:log4net.Util.CountingQuietTextWriter">
  22534. <summary>
  22535. Subclass of <see cref="T:log4net.Util.QuietTextWriter"/> that maintains a count of
  22536. the number of bytes written.
  22537. </summary>
  22538. <remarks>
  22539. <para>
  22540. This writer counts the number of bytes written.
  22541. </para>
  22542. </remarks>
  22543. <author>Nicko Cadell</author>
  22544. <author>Gert Driesen</author>
  22545. </member>
  22546. <member name="M:log4net.Util.CountingQuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  22547. <summary>
  22548. Constructor
  22549. </summary>
  22550. <param name="writer">The <see cref="T:System.IO.TextWriter" /> to actually write to.</param>
  22551. <param name="errorHandler">The <see cref="T:log4net.Core.IErrorHandler" /> to report errors to.</param>
  22552. <remarks>
  22553. <para>
  22554. Creates a new instance of the <see cref="T:log4net.Util.CountingQuietTextWriter" /> class
  22555. with the specified <see cref="T:System.IO.TextWriter" /> and <see cref="T:log4net.Core.IErrorHandler" />.
  22556. </para>
  22557. </remarks>
  22558. </member>
  22559. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char)">
  22560. <summary>
  22561. Writes a character to the underlying writer and counts the number of bytes written.
  22562. </summary>
  22563. <param name="value">the char to write</param>
  22564. <remarks>
  22565. <para>
  22566. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  22567. the number of bytes written.
  22568. </para>
  22569. </remarks>
  22570. </member>
  22571. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  22572. <summary>
  22573. Writes a buffer to the underlying writer and counts the number of bytes written.
  22574. </summary>
  22575. <param name="buffer">the buffer to write</param>
  22576. <param name="index">the start index to write from</param>
  22577. <param name="count">the number of characters to write</param>
  22578. <remarks>
  22579. <para>
  22580. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  22581. the number of bytes written.
  22582. </para>
  22583. </remarks>
  22584. </member>
  22585. <member name="M:log4net.Util.CountingQuietTextWriter.Write(System.String)">
  22586. <summary>
  22587. Writes a string to the output and counts the number of bytes written.
  22588. </summary>
  22589. <param name="str">The string data to write to the output.</param>
  22590. <remarks>
  22591. <para>
  22592. Overrides implementation of <see cref="T:log4net.Util.QuietTextWriter"/>. Counts
  22593. the number of bytes written.
  22594. </para>
  22595. </remarks>
  22596. </member>
  22597. <member name="P:log4net.Util.CountingQuietTextWriter.Count">
  22598. <summary>
  22599. Gets or sets the total number of bytes written.
  22600. </summary>
  22601. <value>
  22602. The total number of bytes written.
  22603. </value>
  22604. <remarks>
  22605. <para>
  22606. Gets or sets the total number of bytes written.
  22607. </para>
  22608. </remarks>
  22609. </member>
  22610. <member name="F:log4net.Util.CountingQuietTextWriter.m_countBytes">
  22611. <summary>
  22612. Total number of bytes written.
  22613. </summary>
  22614. </member>
  22615. <member name="T:log4net.Util.CyclicBuffer">
  22616. <summary>
  22617. A fixed size rolling buffer of logging events.
  22618. </summary>
  22619. <remarks>
  22620. <para>
  22621. An array backed fixed size leaky bucket.
  22622. </para>
  22623. </remarks>
  22624. <author>Nicko Cadell</author>
  22625. <author>Gert Driesen</author>
  22626. </member>
  22627. <member name="M:log4net.Util.CyclicBuffer.#ctor(System.Int32)">
  22628. <summary>
  22629. Constructor
  22630. </summary>
  22631. <param name="maxSize">The maximum number of logging events in the buffer.</param>
  22632. <remarks>
  22633. <para>
  22634. Initializes a new instance of the <see cref="T:log4net.Util.CyclicBuffer" /> class with
  22635. the specified maximum number of buffered logging events.
  22636. </para>
  22637. </remarks>
  22638. <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="maxSize"/> argument is not a positive integer.</exception>
  22639. </member>
  22640. <member name="M:log4net.Util.CyclicBuffer.Append(log4net.Core.LoggingEvent)">
  22641. <summary>
  22642. Appends a <paramref name="loggingEvent"/> to the buffer.
  22643. </summary>
  22644. <param name="loggingEvent">The event to append to the buffer.</param>
  22645. <returns>The event discarded from the buffer, if the buffer is full, otherwise <c>null</c>.</returns>
  22646. <remarks>
  22647. <para>
  22648. Append an event to the buffer. If the buffer still contains free space then
  22649. <c>null</c> is returned. If the buffer is full then an event will be dropped
  22650. to make space for the new event, the event dropped is returned.
  22651. </para>
  22652. </remarks>
  22653. </member>
  22654. <member name="M:log4net.Util.CyclicBuffer.PopOldest">
  22655. <summary>
  22656. Get and remove the oldest event in the buffer.
  22657. </summary>
  22658. <returns>The oldest logging event in the buffer</returns>
  22659. <remarks>
  22660. <para>
  22661. Gets the oldest (first) logging event in the buffer and removes it
  22662. from the buffer.
  22663. </para>
  22664. </remarks>
  22665. </member>
  22666. <member name="M:log4net.Util.CyclicBuffer.PopAll">
  22667. <summary>
  22668. Pops all the logging events from the buffer into an array.
  22669. </summary>
  22670. <returns>An array of all the logging events in the buffer.</returns>
  22671. <remarks>
  22672. <para>
  22673. Get all the events in the buffer and clear the buffer.
  22674. </para>
  22675. </remarks>
  22676. </member>
  22677. <member name="M:log4net.Util.CyclicBuffer.Clear">
  22678. <summary>
  22679. Clear the buffer
  22680. </summary>
  22681. <remarks>
  22682. <para>
  22683. Clear the buffer of all events. The events in the buffer are lost.
  22684. </para>
  22685. </remarks>
  22686. </member>
  22687. <member name="P:log4net.Util.CyclicBuffer.Item(System.Int32)">
  22688. <summary>
  22689. Gets the <paramref name="i"/>th oldest event currently in the buffer.
  22690. </summary>
  22691. <value>The <paramref name="i"/>th oldest event currently in the buffer.</value>
  22692. <remarks>
  22693. <para>
  22694. If <paramref name="i"/> is outside the range 0 to the number of events
  22695. currently in the buffer, then <c>null</c> is returned.
  22696. </para>
  22697. </remarks>
  22698. </member>
  22699. <member name="P:log4net.Util.CyclicBuffer.MaxSize">
  22700. <summary>
  22701. Gets the maximum size of the buffer.
  22702. </summary>
  22703. <value>The maximum size of the buffer.</value>
  22704. <remarks>
  22705. <para>
  22706. Gets the maximum size of the buffer
  22707. </para>
  22708. </remarks>
  22709. </member>
  22710. <member name="P:log4net.Util.CyclicBuffer.Length">
  22711. <summary>
  22712. Gets the number of logging events in the buffer.
  22713. </summary>
  22714. <value>The number of logging events in the buffer.</value>
  22715. <remarks>
  22716. <para>
  22717. This number is guaranteed to be in the range 0 to <see cref="P:log4net.Util.CyclicBuffer.MaxSize"/>
  22718. (inclusive).
  22719. </para>
  22720. </remarks>
  22721. </member>
  22722. <member name="T:log4net.Util.EmptyCollection">
  22723. <summary>
  22724. An always empty <see cref="T:System.Collections.ICollection"/>.
  22725. </summary>
  22726. <remarks>
  22727. <para>
  22728. A singleton implementation of the <see cref="T:System.Collections.ICollection"/>
  22729. interface that always represents an empty collection.
  22730. </para>
  22731. </remarks>
  22732. <author>Nicko Cadell</author>
  22733. <author>Gert Driesen</author>
  22734. </member>
  22735. <member name="M:log4net.Util.EmptyCollection.#ctor">
  22736. <summary>
  22737. Initializes a new instance of the <see cref="T:log4net.Util.EmptyCollection" /> class.
  22738. </summary>
  22739. <remarks>
  22740. <para>
  22741. Uses a private access modifier to enforce the singleton pattern.
  22742. </para>
  22743. </remarks>
  22744. </member>
  22745. <member name="P:log4net.Util.EmptyCollection.Instance">
  22746. <summary>
  22747. Gets the singleton instance of the empty collection.
  22748. </summary>
  22749. <returns>The singleton instance of the empty collection.</returns>
  22750. <remarks>
  22751. <para>
  22752. Gets the singleton instance of the empty collection.
  22753. </para>
  22754. </remarks>
  22755. </member>
  22756. <member name="M:log4net.Util.EmptyCollection.CopyTo(System.Array,System.Int32)">
  22757. <summary>
  22758. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  22759. <see cref="T:System.Array"/>, starting at a particular Array index.
  22760. </summary>
  22761. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  22762. that is the destination of the elements copied from
  22763. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  22764. indexing.</param>
  22765. <param name="index">The zero-based index in array at which
  22766. copying begins.</param>
  22767. <remarks>
  22768. <para>
  22769. As the collection is empty no values are copied into the array.
  22770. </para>
  22771. </remarks>
  22772. </member>
  22773. <member name="P:log4net.Util.EmptyCollection.IsSynchronized">
  22774. <summary>
  22775. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  22776. </summary>
  22777. <value>
  22778. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  22779. </value>
  22780. <remarks>
  22781. <para>
  22782. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <c>true</c>.
  22783. </para>
  22784. </remarks>
  22785. </member>
  22786. <member name="P:log4net.Util.EmptyCollection.Count">
  22787. <summary>
  22788. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  22789. </summary>
  22790. <value>
  22791. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  22792. </value>
  22793. <remarks>
  22794. <para>
  22795. As the collection is empty the <see cref="P:log4net.Util.EmptyCollection.Count"/> is always <c>0</c>.
  22796. </para>
  22797. </remarks>
  22798. </member>
  22799. <member name="P:log4net.Util.EmptyCollection.SyncRoot">
  22800. <summary>
  22801. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  22802. </summary>
  22803. <value>
  22804. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  22805. </value>
  22806. <remarks>
  22807. <para>
  22808. As the collection is empty and thread safe and synchronized this instance is also
  22809. the <see cref="P:log4net.Util.EmptyCollection.SyncRoot"/> object.
  22810. </para>
  22811. </remarks>
  22812. </member>
  22813. <member name="M:log4net.Util.EmptyCollection.GetEnumerator">
  22814. <summary>
  22815. Returns an enumerator that can iterate through a collection.
  22816. </summary>
  22817. <returns>
  22818. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  22819. iterate through the collection.
  22820. </returns>
  22821. <remarks>
  22822. <para>
  22823. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  22824. </para>
  22825. </remarks>
  22826. </member>
  22827. <member name="F:log4net.Util.EmptyCollection.s_instance">
  22828. <summary>
  22829. The singleton instance of the empty collection.
  22830. </summary>
  22831. </member>
  22832. <member name="T:log4net.Util.EmptyDictionary">
  22833. <summary>
  22834. An always empty <see cref="T:System.Collections.IDictionary"/>.
  22835. </summary>
  22836. <remarks>
  22837. <para>
  22838. A singleton implementation of the <see cref="T:System.Collections.IDictionary"/>
  22839. interface that always represents an empty collection.
  22840. </para>
  22841. </remarks>
  22842. <author>Nicko Cadell</author>
  22843. <author>Gert Driesen</author>
  22844. </member>
  22845. <member name="M:log4net.Util.EmptyDictionary.#ctor">
  22846. <summary>
  22847. Initializes a new instance of the <see cref="T:log4net.Util.EmptyDictionary" /> class.
  22848. </summary>
  22849. <remarks>
  22850. <para>
  22851. Uses a private access modifier to enforce the singleton pattern.
  22852. </para>
  22853. </remarks>
  22854. </member>
  22855. <member name="P:log4net.Util.EmptyDictionary.Instance">
  22856. <summary>
  22857. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.
  22858. </summary>
  22859. <returns>The singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.</returns>
  22860. <remarks>
  22861. <para>
  22862. Gets the singleton instance of the <see cref="T:log4net.Util.EmptyDictionary" />.
  22863. </para>
  22864. </remarks>
  22865. </member>
  22866. <member name="M:log4net.Util.EmptyDictionary.CopyTo(System.Array,System.Int32)">
  22867. <summary>
  22868. Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an
  22869. <see cref="T:System.Array"/>, starting at a particular Array index.
  22870. </summary>
  22871. <param name="array">The one-dimensional <see cref="T:System.Array"/>
  22872. that is the destination of the elements copied from
  22873. <see cref="T:System.Collections.ICollection"/>. The Array must have zero-based
  22874. indexing.</param>
  22875. <param name="index">The zero-based index in array at which
  22876. copying begins.</param>
  22877. <remarks>
  22878. <para>
  22879. As the collection is empty no values are copied into the array.
  22880. </para>
  22881. </remarks>
  22882. </member>
  22883. <member name="P:log4net.Util.EmptyDictionary.IsSynchronized">
  22884. <summary>
  22885. Gets a value indicating if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe).
  22886. </summary>
  22887. <value>
  22888. <b>true</b> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread-safe); otherwise, <b>false</b>.
  22889. </value>
  22890. <remarks>
  22891. <para>
  22892. For the <see cref="T:log4net.Util.EmptyCollection"/> this property is always <b>true</b>.
  22893. </para>
  22894. </remarks>
  22895. </member>
  22896. <member name="P:log4net.Util.EmptyDictionary.Count">
  22897. <summary>
  22898. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>
  22899. </summary>
  22900. <value>
  22901. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  22902. </value>
  22903. <remarks>
  22904. <para>
  22905. As the collection is empty the <see cref="P:log4net.Util.EmptyDictionary.Count"/> is always <c>0</c>.
  22906. </para>
  22907. </remarks>
  22908. </member>
  22909. <member name="P:log4net.Util.EmptyDictionary.SyncRoot">
  22910. <summary>
  22911. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  22912. </summary>
  22913. <value>
  22914. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  22915. </value>
  22916. <remarks>
  22917. <para>
  22918. As the collection is empty and thread safe and synchronized this instance is also
  22919. the <see cref="P:log4net.Util.EmptyDictionary.SyncRoot"/> object.
  22920. </para>
  22921. </remarks>
  22922. </member>
  22923. <member name="M:log4net.Util.EmptyDictionary.System#Collections#IEnumerable#GetEnumerator">
  22924. <summary>
  22925. Returns an enumerator that can iterate through a collection.
  22926. </summary>
  22927. <returns>
  22928. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  22929. iterate through the collection.
  22930. </returns>
  22931. <remarks>
  22932. <para>
  22933. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  22934. </para>
  22935. </remarks>
  22936. </member>
  22937. <member name="M:log4net.Util.EmptyDictionary.Add(System.Object,System.Object)">
  22938. <summary>
  22939. Adds an element with the provided key and value to the
  22940. <see cref="T:log4net.Util.EmptyDictionary" />.
  22941. </summary>
  22942. <param name="key">The <see cref="T:System.Object" /> to use as the key of the element to add.</param>
  22943. <param name="value">The <see cref="T:System.Object" /> to use as the value of the element to add.</param>
  22944. <remarks>
  22945. <para>
  22946. As the collection is empty no new values can be added. A <see cref="T:System.InvalidOperationException"/>
  22947. is thrown if this method is called.
  22948. </para>
  22949. </remarks>
  22950. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  22951. </member>
  22952. <member name="M:log4net.Util.EmptyDictionary.Clear">
  22953. <summary>
  22954. Removes all elements from the <see cref="T:log4net.Util.EmptyDictionary" />.
  22955. </summary>
  22956. <remarks>
  22957. <para>
  22958. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  22959. is thrown if this method is called.
  22960. </para>
  22961. </remarks>
  22962. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  22963. </member>
  22964. <member name="M:log4net.Util.EmptyDictionary.Contains(System.Object)">
  22965. <summary>
  22966. Determines whether the <see cref="T:log4net.Util.EmptyDictionary" /> contains an element
  22967. with the specified key.
  22968. </summary>
  22969. <param name="key">The key to locate in the <see cref="T:log4net.Util.EmptyDictionary" />.</param>
  22970. <returns><c>false</c></returns>
  22971. <remarks>
  22972. <para>
  22973. As the collection is empty the <see cref="M:log4net.Util.EmptyDictionary.Contains(System.Object)"/> method always returns <c>false</c>.
  22974. </para>
  22975. </remarks>
  22976. </member>
  22977. <member name="M:log4net.Util.EmptyDictionary.GetEnumerator">
  22978. <summary>
  22979. Returns an enumerator that can iterate through a collection.
  22980. </summary>
  22981. <returns>
  22982. An <see cref="T:System.Collections.IEnumerator"/> that can be used to
  22983. iterate through the collection.
  22984. </returns>
  22985. <remarks>
  22986. <para>
  22987. As the collection is empty a <see cref="T:log4net.Util.NullEnumerator"/> is returned.
  22988. </para>
  22989. </remarks>
  22990. </member>
  22991. <member name="M:log4net.Util.EmptyDictionary.Remove(System.Object)">
  22992. <summary>
  22993. Removes the element with the specified key from the <see cref="T:log4net.Util.EmptyDictionary" />.
  22994. </summary>
  22995. <param name="key">The key of the element to remove.</param>
  22996. <remarks>
  22997. <para>
  22998. As the collection is empty no values can be removed. A <see cref="T:System.InvalidOperationException"/>
  22999. is thrown if this method is called.
  23000. </para>
  23001. </remarks>
  23002. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  23003. </member>
  23004. <member name="P:log4net.Util.EmptyDictionary.IsFixedSize">
  23005. <summary>
  23006. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary" /> has a fixed size.
  23007. </summary>
  23008. <value><c>true</c></value>
  23009. <remarks>
  23010. <para>
  23011. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsFixedSize"/> always returns <c>true</c>.
  23012. </para>
  23013. </remarks>
  23014. </member>
  23015. <member name="P:log4net.Util.EmptyDictionary.IsReadOnly">
  23016. <summary>
  23017. Gets a value indicating whether the <see cref="T:log4net.Util.EmptyDictionary" /> is read-only.
  23018. </summary>
  23019. <value><c>true</c></value>
  23020. <remarks>
  23021. <para>
  23022. As the collection is empty <see cref="P:log4net.Util.EmptyDictionary.IsReadOnly"/> always returns <c>true</c>.
  23023. </para>
  23024. </remarks>
  23025. </member>
  23026. <member name="P:log4net.Util.EmptyDictionary.Keys">
  23027. <summary>
  23028. Gets an <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary" />.
  23029. </summary>
  23030. <value>An <see cref="T:System.Collections.ICollection" /> containing the keys of the <see cref="T:log4net.Util.EmptyDictionary" />.</value>
  23031. <remarks>
  23032. <para>
  23033. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  23034. </para>
  23035. </remarks>
  23036. </member>
  23037. <member name="P:log4net.Util.EmptyDictionary.Values">
  23038. <summary>
  23039. Gets an <see cref="T:System.Collections.ICollection" /> containing the values of the <see cref="T:log4net.Util.EmptyDictionary" />.
  23040. </summary>
  23041. <value>An <see cref="T:System.Collections.ICollection" /> containing the values of the <see cref="T:log4net.Util.EmptyDictionary" />.</value>
  23042. <remarks>
  23043. <para>
  23044. As the collection is empty a <see cref="T:log4net.Util.EmptyCollection"/> is returned.
  23045. </para>
  23046. </remarks>
  23047. </member>
  23048. <member name="P:log4net.Util.EmptyDictionary.Item(System.Object)">
  23049. <summary>
  23050. Gets or sets the element with the specified key.
  23051. </summary>
  23052. <param name="key">The key of the element to get or set.</param>
  23053. <value><c>null</c></value>
  23054. <remarks>
  23055. <para>
  23056. As the collection is empty no values can be looked up or stored.
  23057. If the index getter is called then <c>null</c> is returned.
  23058. A <see cref="T:System.InvalidOperationException"/> is thrown if the setter is called.
  23059. </para>
  23060. </remarks>
  23061. <exception cref="T:System.InvalidOperationException">This dictionary is always empty and cannot be modified.</exception>
  23062. </member>
  23063. <member name="F:log4net.Util.EmptyDictionary.s_instance">
  23064. <summary>
  23065. The singleton instance of the empty dictionary.
  23066. </summary>
  23067. </member>
  23068. <member name="T:log4net.Util.FormattingInfo">
  23069. <summary>
  23070. Contain the information obtained when parsing formatting modifiers
  23071. in conversion modifiers.
  23072. </summary>
  23073. <remarks>
  23074. <para>
  23075. Holds the formatting information extracted from the format string by
  23076. the <see cref="T:log4net.Util.PatternParser"/>. This is used by the <see cref="T:log4net.Util.PatternConverter"/>
  23077. objects when rendering the output.
  23078. </para>
  23079. </remarks>
  23080. <author>Nicko Cadell</author>
  23081. <author>Gert Driesen</author>
  23082. </member>
  23083. <member name="M:log4net.Util.FormattingInfo.#ctor">
  23084. <summary>
  23085. Defaut Constructor
  23086. </summary>
  23087. <remarks>
  23088. <para>
  23089. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo" /> class.
  23090. </para>
  23091. </remarks>
  23092. </member>
  23093. <member name="M:log4net.Util.FormattingInfo.#ctor(System.Int32,System.Int32,System.Boolean)">
  23094. <summary>
  23095. Constructor
  23096. </summary>
  23097. <remarks>
  23098. <para>
  23099. Initializes a new instance of the <see cref="T:log4net.Util.FormattingInfo" /> class
  23100. with the specified parameters.
  23101. </para>
  23102. </remarks>
  23103. </member>
  23104. <member name="P:log4net.Util.FormattingInfo.Min">
  23105. <summary>
  23106. Gets or sets the minimum value.
  23107. </summary>
  23108. <value>
  23109. The minimum value.
  23110. </value>
  23111. <remarks>
  23112. <para>
  23113. Gets or sets the minimum value.
  23114. </para>
  23115. </remarks>
  23116. </member>
  23117. <member name="P:log4net.Util.FormattingInfo.Max">
  23118. <summary>
  23119. Gets or sets the maximum value.
  23120. </summary>
  23121. <value>
  23122. The maximum value.
  23123. </value>
  23124. <remarks>
  23125. <para>
  23126. Gets or sets the maximum value.
  23127. </para>
  23128. </remarks>
  23129. </member>
  23130. <member name="P:log4net.Util.FormattingInfo.LeftAlign">
  23131. <summary>
  23132. Gets or sets a flag indicating whether left align is enabled
  23133. or not.
  23134. </summary>
  23135. <value>
  23136. A flag indicating whether left align is enabled or not.
  23137. </value>
  23138. <remarks>
  23139. <para>
  23140. Gets or sets a flag indicating whether left align is enabled or not.
  23141. </para>
  23142. </remarks>
  23143. </member>
  23144. <member name="T:log4net.Util.GlobalContextProperties">
  23145. <summary>
  23146. Implementation of Properties collection for the <see cref="T:log4net.GlobalContext"/>
  23147. </summary>
  23148. <remarks>
  23149. <para>
  23150. This class implements a properties collection that is thread safe and supports both
  23151. storing properties and capturing a read only copy of the current propertied.
  23152. </para>
  23153. <para>
  23154. This class is optimized to the scenario where the properties are read frequently
  23155. and are modified infrequently.
  23156. </para>
  23157. </remarks>
  23158. <author>Nicko Cadell</author>
  23159. </member>
  23160. <member name="F:log4net.Util.GlobalContextProperties.m_readOnlyProperties">
  23161. <summary>
  23162. The read only copy of the properties.
  23163. </summary>
  23164. <remarks>
  23165. <para>
  23166. This variable is declared <c>volatile</c> to prevent the compiler and JIT from
  23167. reordering reads and writes of this thread performed on different threads.
  23168. </para>
  23169. </remarks>
  23170. </member>
  23171. <member name="F:log4net.Util.GlobalContextProperties.m_syncRoot">
  23172. <summary>
  23173. Lock object used to synchronize updates within this instance
  23174. </summary>
  23175. </member>
  23176. <member name="M:log4net.Util.GlobalContextProperties.#ctor">
  23177. <summary>
  23178. Constructor
  23179. </summary>
  23180. <remarks>
  23181. <para>
  23182. Initializes a new instance of the <see cref="T:log4net.Util.GlobalContextProperties" /> class.
  23183. </para>
  23184. </remarks>
  23185. </member>
  23186. <member name="P:log4net.Util.GlobalContextProperties.Item(System.String)">
  23187. <summary>
  23188. Gets or sets the value of a property
  23189. </summary>
  23190. <value>
  23191. The value for the property with the specified key
  23192. </value>
  23193. <remarks>
  23194. <para>
  23195. Reading the value for a key is faster than setting the value.
  23196. When the value is written a new read only copy of
  23197. the properties is created.
  23198. </para>
  23199. </remarks>
  23200. </member>
  23201. <member name="M:log4net.Util.GlobalContextProperties.Remove(System.String)">
  23202. <summary>
  23203. Remove a property from the global context
  23204. </summary>
  23205. <param name="key">the key for the entry to remove</param>
  23206. <remarks>
  23207. <para>
  23208. Removing an entry from the global context properties is relatively expensive compared
  23209. with reading a value.
  23210. </para>
  23211. </remarks>
  23212. </member>
  23213. <member name="M:log4net.Util.GlobalContextProperties.Clear">
  23214. <summary>
  23215. Clear the global context properties
  23216. </summary>
  23217. </member>
  23218. <member name="M:log4net.Util.GlobalContextProperties.GetReadOnlyProperties">
  23219. <summary>
  23220. Get a readonly immutable copy of the properties
  23221. </summary>
  23222. <returns>the current global context properties</returns>
  23223. <remarks>
  23224. <para>
  23225. This implementation is fast because the GlobalContextProperties class
  23226. stores a readonly copy of the properties.
  23227. </para>
  23228. </remarks>
  23229. </member>
  23230. <member name="T:log4net.Util.ILogExtensions">
  23231. <summary>
  23232. The static class ILogExtensions contains a set of widely used
  23233. methods that ease the interaction with the ILog interface implementations.
  23234. </summary>
  23235. <remarks>
  23236. <para>
  23237. This class contains methods for logging at different levels and checks the
  23238. properties for determining if those logging levels are enabled in the current
  23239. configuration.
  23240. </para>
  23241. </remarks>
  23242. <example>Simple example of logging messages
  23243. <code lang="C#">
  23244. using log4net.Util;
  23245. ILog log = LogManager.GetLogger("application-log");
  23246. log.InfoExt("Application Start");
  23247. log.DebugExt("This is a debug message");
  23248. </code>
  23249. </example>
  23250. </member>
  23251. <member name="F:log4net.Util.ILogExtensions.declaringType">
  23252. <summary>
  23253. The fully qualified type of the Logger class.
  23254. </summary>
  23255. </member>
  23256. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object})">
  23257. <summary>
  23258. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23259. </summary>
  23260. <param name="logger">The logger on which the message is logged.</param>
  23261. <param name="callback">The lambda expression that gets the object to log.</param>
  23262. <remarks>
  23263. <para>
  23264. This method first checks if this logger is <c>INFO</c>
  23265. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  23266. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23267. implementation. If this logger is <c>INFO</c> enabled, then it converts
  23268. the message object (retrieved by invocation of the provided callback) to a
  23269. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  23270. It then proceeds to call all the registered appenders in this logger
  23271. and also higher in the hierarchy depending on the value of
  23272. the additivity flag.
  23273. </para>
  23274. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23275. to this method will print the name of the <see cref="T:System.Exception"/>
  23276. but no stack trace. To print a stack trace use the
  23277. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  23278. </para>
  23279. </remarks>
  23280. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23281. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23282. </member>
  23283. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  23284. <summary>
  23285. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  23286. the stack trace of the <see cref="T:System.Exception"/> passed
  23287. as a parameter.
  23288. </summary>
  23289. <param name="logger">The logger on which the message is logged.</param>
  23290. <param name="callback">The lambda expression that gets the object to log.</param>
  23291. <param name="exception">The exception to log, including its stack trace.</param>
  23292. <remarks>
  23293. <para>
  23294. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23295. </para>
  23296. </remarks>
  23297. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23298. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23299. </member>
  23300. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)">
  23301. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.</overloads> //TODO
  23302. <summary>
  23303. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23304. </summary>
  23305. <param name="logger">The logger on which the message is logged.</param>
  23306. <param name="message">The message object to log.</param>
  23307. <remarks>
  23308. <para>
  23309. This method first checks if this logger is <c>INFO</c>
  23310. enabled by reading the value <seealso cref="P:log4net.ILog.IsDebugEnabled"/> property.
  23311. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23312. implementation. If this logger is <c>INFO</c> enabled, then it converts
  23313. the message object (passed as parameter) to a string by invoking the appropriate
  23314. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  23315. proceeds to call all the registered appenders in this logger
  23316. and also higher in the hierarchy depending on the value of
  23317. the additivity flag.
  23318. </para>
  23319. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23320. to this method will print the name of the <see cref="T:System.Exception"/>
  23321. but no stack trace. To print a stack trace use the
  23322. <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  23323. </para>
  23324. </remarks>
  23325. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23326. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23327. </member>
  23328. <member name="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object,System.Exception)">
  23329. <summary>
  23330. Log a message object with the <see cref="F:log4net.Core.Level.Debug"/> level including
  23331. the stack trace of the <see cref="T:System.Exception"/> passed
  23332. as a parameter.
  23333. </summary>
  23334. <param name="logger">The logger on which the message is logged.</param>
  23335. <param name="message">The message object to log.</param>
  23336. <param name="exception">The exception to log, including its stack trace.</param>
  23337. <remarks>
  23338. <para>
  23339. See the <see cref="M:log4net.Util.ILogExtensions.DebugExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23340. </para>
  23341. </remarks>
  23342. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23343. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23344. </member>
  23345. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object)">
  23346. <summary>
  23347. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23348. </summary>
  23349. <param name="logger">The logger on which the message is logged.</param>
  23350. <param name="format">A String containing zero or more format items</param>
  23351. <param name="arg0">An Object to format</param>
  23352. <remarks>
  23353. <para>
  23354. The message is formatted using the <c>String.Format</c> method. See
  23355. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23356. of the formatting.
  23357. </para>
  23358. <para>
  23359. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23360. 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)"/>
  23361. methods instead.
  23362. </para>
  23363. </remarks>
  23364. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23365. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23366. </member>
  23367. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object[])">
  23368. <summary>
  23369. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23370. </summary>
  23371. <param name="logger">The logger on which the message is logged.</param>
  23372. <param name="format">A String containing zero or more format items</param>
  23373. <param name="args">An Object array containing zero or more objects to format</param>
  23374. <remarks>
  23375. <para>
  23376. The message is formatted using the <c>String.Format</c> method. See
  23377. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23378. of the formatting.
  23379. </para>
  23380. <para>
  23381. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23382. 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)"/>
  23383. methods instead.
  23384. </para>
  23385. </remarks>
  23386. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23387. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23388. </member>
  23389. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  23390. <summary>
  23391. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23392. </summary>
  23393. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  23394. <param name="logger">The logger on which the message is logged.</param>
  23395. <param name="format">A String containing zero or more format items</param>
  23396. <param name="args">An Object array containing zero or more objects to format</param>
  23397. <remarks>
  23398. <para>
  23399. The message is formatted using the <c>String.Format</c> method. See
  23400. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23401. of the formatting.
  23402. </para>
  23403. <para>
  23404. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23405. 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)"/>
  23406. methods instead.
  23407. </para>
  23408. </remarks>
  23409. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23410. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23411. </member>
  23412. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  23413. <summary>
  23414. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23415. </summary>
  23416. <param name="logger">The logger on which the message is logged.</param>
  23417. <param name="format">A String containing zero or more format items</param>
  23418. <param name="arg0">An Object to format</param>
  23419. <param name="arg1">An Object to format</param>
  23420. <remarks>
  23421. <para>
  23422. The message is formatted using the <c>String.Format</c> method. See
  23423. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23424. of the formatting.
  23425. </para>
  23426. <para>
  23427. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23428. 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)"/>
  23429. methods instead.
  23430. </para>
  23431. </remarks>
  23432. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23433. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23434. </member>
  23435. <member name="M:log4net.Util.ILogExtensions.DebugFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  23436. <summary>
  23437. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Debug"/> level.
  23438. </summary>
  23439. <param name="logger">The logger on which the message is logged.</param>
  23440. <param name="format">A String containing zero or more format items</param>
  23441. <param name="arg0">An Object to format</param>
  23442. <param name="arg1">An Object to format</param>
  23443. <param name="arg2">An Object to format</param>
  23444. <remarks>
  23445. <para>
  23446. The message is formatted using the <c>String.Format</c> method. See
  23447. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23448. of the formatting.
  23449. </para>
  23450. <para>
  23451. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23452. 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)"/>
  23453. methods instead.
  23454. </para>
  23455. </remarks>
  23456. <seealso cref="M:log4net.ILog.Debug(System.Object)"/>
  23457. <seealso cref="P:log4net.ILog.IsDebugEnabled"/>
  23458. </member>
  23459. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object})">
  23460. <summary>
  23461. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  23462. </summary>
  23463. <param name="logger">The logger on which the message is logged.</param>
  23464. <param name="callback">The lambda expression that gets the object to log.</param>
  23465. <remarks>
  23466. <para>
  23467. This method first checks if this logger is <c>INFO</c>
  23468. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  23469. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23470. implementation. If this logger is <c>INFO</c> enabled, then it converts
  23471. the message object (retrieved by invocation of the provided callback) to a
  23472. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  23473. It then proceeds to call all the registered appenders in this logger
  23474. and also higher in the hierarchy depending on the value of
  23475. the additivity flag.
  23476. </para>
  23477. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23478. to this method will print the name of the <see cref="T:System.Exception"/>
  23479. but no stack trace. To print a stack trace use the
  23480. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  23481. </para>
  23482. </remarks>
  23483. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23484. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23485. </member>
  23486. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  23487. <summary>
  23488. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  23489. the stack trace of the <see cref="T:System.Exception"/> passed
  23490. as a parameter.
  23491. </summary>
  23492. <param name="logger">The logger on which the message is logged.</param>
  23493. <param name="callback">The lambda expression that gets the object to log.</param>
  23494. <param name="exception">The exception to log, including its stack trace.</param>
  23495. <remarks>
  23496. <para>
  23497. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23498. </para>
  23499. </remarks>
  23500. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23501. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23502. </member>
  23503. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)">
  23504. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.</overloads> //TODO
  23505. <summary>
  23506. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level.
  23507. </summary>
  23508. <param name="logger">The logger on which the message is logged.</param>
  23509. <param name="message">The message object to log.</param>
  23510. <remarks>
  23511. <para>
  23512. This method first checks if this logger is <c>INFO</c>
  23513. enabled by reading the value <seealso cref="P:log4net.ILog.IsInfoEnabled"/> property.
  23514. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23515. implementation. If this logger is <c>INFO</c> enabled, then it converts
  23516. the message object (passed as parameter) to a string by invoking the appropriate
  23517. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  23518. proceeds to call all the registered appenders in this logger
  23519. and also higher in the hierarchy depending on the value of
  23520. the additivity flag.
  23521. </para>
  23522. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23523. to this method will print the name of the <see cref="T:System.Exception"/>
  23524. but no stack trace. To print a stack trace use the
  23525. <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  23526. </para>
  23527. </remarks>
  23528. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23529. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23530. </member>
  23531. <member name="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object,System.Exception)">
  23532. <summary>
  23533. Log a message object with the <see cref="F:log4net.Core.Level.Info"/> level including
  23534. the stack trace of the <see cref="T:System.Exception"/> passed
  23535. as a parameter.
  23536. </summary>
  23537. <param name="logger">The logger on which the message is logged.</param>
  23538. <param name="message">The message object to log.</param>
  23539. <param name="exception">The exception to log, including its stack trace.</param>
  23540. <remarks>
  23541. <para>
  23542. See the <see cref="M:log4net.Util.ILogExtensions.InfoExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23543. </para>
  23544. </remarks>
  23545. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23546. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23547. </member>
  23548. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object)">
  23549. <summary>
  23550. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23551. </summary>
  23552. <param name="logger">The logger on which the message is logged.</param>
  23553. <param name="format">A String containing zero or more format items</param>
  23554. <param name="arg0">An Object to format</param>
  23555. <remarks>
  23556. <para>
  23557. The message is formatted using the <c>String.Format</c> method. See
  23558. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23559. of the formatting.
  23560. </para>
  23561. <para>
  23562. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23563. 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)"/>
  23564. methods instead.
  23565. </para>
  23566. </remarks>
  23567. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23568. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23569. </member>
  23570. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object[])">
  23571. <summary>
  23572. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23573. </summary>
  23574. <param name="logger">The logger on which the message is logged.</param>
  23575. <param name="format">A String containing zero or more format items</param>
  23576. <param name="args">An Object array containing zero or more objects to format</param>
  23577. <remarks>
  23578. <para>
  23579. The message is formatted using the <c>String.Format</c> method. See
  23580. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23581. of the formatting.
  23582. </para>
  23583. <para>
  23584. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23585. 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)"/>
  23586. methods instead.
  23587. </para>
  23588. </remarks>
  23589. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23590. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23591. </member>
  23592. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  23593. <summary>
  23594. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23595. </summary>
  23596. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  23597. <param name="logger">The logger on which the message is logged.</param>
  23598. <param name="format">A String containing zero or more format items</param>
  23599. <param name="args">An Object array containing zero or more objects to format</param>
  23600. <remarks>
  23601. <para>
  23602. The message is formatted using the <c>String.Format</c> method. See
  23603. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23604. of the formatting.
  23605. </para>
  23606. <para>
  23607. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23608. 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)"/>
  23609. methods instead.
  23610. </para>
  23611. </remarks>
  23612. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23613. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23614. </member>
  23615. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  23616. <summary>
  23617. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23618. </summary>
  23619. <param name="logger">The logger on which the message is logged.</param>
  23620. <param name="format">A String containing zero or more format items</param>
  23621. <param name="arg0">An Object to format</param>
  23622. <param name="arg1">An Object to format</param>
  23623. <remarks>
  23624. <para>
  23625. The message is formatted using the <c>String.Format</c> method. See
  23626. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23627. of the formatting.
  23628. </para>
  23629. <para>
  23630. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23631. 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)"/>
  23632. methods instead.
  23633. </para>
  23634. </remarks>
  23635. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23636. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23637. </member>
  23638. <member name="M:log4net.Util.ILogExtensions.InfoFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  23639. <summary>
  23640. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Info"/> level.
  23641. </summary>
  23642. <param name="logger">The logger on which the message is logged.</param>
  23643. <param name="format">A String containing zero or more format items</param>
  23644. <param name="arg0">An Object to format</param>
  23645. <param name="arg1">An Object to format</param>
  23646. <param name="arg2">An Object to format</param>
  23647. <remarks>
  23648. <para>
  23649. The message is formatted using the <c>String.Format</c> method. See
  23650. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23651. of the formatting.
  23652. </para>
  23653. <para>
  23654. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23655. 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)"/>
  23656. methods instead.
  23657. </para>
  23658. </remarks>
  23659. <seealso cref="M:log4net.ILog.Info(System.Object)"/>
  23660. <seealso cref="P:log4net.ILog.IsInfoEnabled"/>
  23661. </member>
  23662. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object})">
  23663. <summary>
  23664. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23665. </summary>
  23666. <param name="logger">The logger on which the message is logged.</param>
  23667. <param name="callback">The lambda expression that gets the object to log.</param>
  23668. <remarks>
  23669. <para>
  23670. This method first checks if this logger is <c>WARN</c>
  23671. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  23672. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23673. implementation. If this logger is <c>WARN</c> enabled, then it converts
  23674. the message object (retrieved by invocation of the provided callback) to a
  23675. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  23676. It then proceeds to call all the registered appenders in this logger
  23677. and also higher in the hierarchy depending on the value of
  23678. the additivity flag.
  23679. </para>
  23680. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23681. to this method will print the name of the <see cref="T:System.Exception"/>
  23682. but no stack trace. To print a stack trace use the
  23683. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  23684. </para>
  23685. </remarks>
  23686. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23687. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23688. </member>
  23689. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  23690. <summary>
  23691. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  23692. the stack trace of the <see cref="T:System.Exception"/> passed
  23693. as a parameter.
  23694. </summary>
  23695. <param name="logger">The logger on which the message is logged.</param>
  23696. <param name="callback">The lambda expression that gets the object to log.</param>
  23697. <param name="exception">The exception to log, including its stack trace.</param>
  23698. <remarks>
  23699. <para>
  23700. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23701. </para>
  23702. </remarks>
  23703. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23704. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23705. </member>
  23706. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)">
  23707. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.</overloads> //TODO
  23708. <summary>
  23709. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23710. </summary>
  23711. <param name="logger">The logger on which the message is logged.</param>
  23712. <param name="message">The message object to log.</param>
  23713. <remarks>
  23714. <para>
  23715. This method first checks if this logger is <c>WARN</c>
  23716. enabled by reading the value <seealso cref="P:log4net.ILog.IsWarnEnabled"/> property.
  23717. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23718. implementation. If this logger is <c>WARN</c> enabled, then it converts
  23719. the message object (passed as parameter) to a string by invoking the appropriate
  23720. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  23721. proceeds to call all the registered appenders in this logger
  23722. and also higher in the hierarchy depending on the value of
  23723. the additivity flag.
  23724. </para>
  23725. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23726. to this method will print the name of the <see cref="T:System.Exception"/>
  23727. but no stack trace. To print a stack trace use the
  23728. <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  23729. </para>
  23730. </remarks>
  23731. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23732. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23733. </member>
  23734. <member name="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object,System.Exception)">
  23735. <summary>
  23736. Log a message object with the <see cref="F:log4net.Core.Level.Warn"/> level including
  23737. the stack trace of the <see cref="T:System.Exception"/> passed
  23738. as a parameter.
  23739. </summary>
  23740. <param name="logger">The logger on which the message is logged.</param>
  23741. <param name="message">The message object to log.</param>
  23742. <param name="exception">The exception to log, including its stack trace.</param>
  23743. <remarks>
  23744. <para>
  23745. See the <see cref="M:log4net.Util.ILogExtensions.WarnExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23746. </para>
  23747. </remarks>
  23748. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23749. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23750. </member>
  23751. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object)">
  23752. <summary>
  23753. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23754. </summary>
  23755. <param name="logger">The logger on which the message is logged.</param>
  23756. <param name="format">A String containing zero or more format items</param>
  23757. <param name="arg0">An Object to format</param>
  23758. <remarks>
  23759. <para>
  23760. The message is formatted using the <c>String.Format</c> method. See
  23761. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23762. of the formatting.
  23763. </para>
  23764. <para>
  23765. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23766. 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)"/>
  23767. methods instead.
  23768. </para>
  23769. </remarks>
  23770. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23771. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23772. </member>
  23773. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object[])">
  23774. <summary>
  23775. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23776. </summary>
  23777. <param name="logger">The logger on which the message is logged.</param>
  23778. <param name="format">A String containing zero or more format items</param>
  23779. <param name="args">An Object array containing zero or more objects to format</param>
  23780. <remarks>
  23781. <para>
  23782. The message is formatted using the <c>String.Format</c> method. See
  23783. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23784. of the formatting.
  23785. </para>
  23786. <para>
  23787. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23788. 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)"/>
  23789. methods instead.
  23790. </para>
  23791. </remarks>
  23792. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23793. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23794. </member>
  23795. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  23796. <summary>
  23797. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23798. </summary>
  23799. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  23800. <param name="logger">The logger on which the message is logged.</param>
  23801. <param name="format">A String containing zero or more format items</param>
  23802. <param name="args">An Object array containing zero or more objects to format</param>
  23803. <remarks>
  23804. <para>
  23805. The message is formatted using the <c>String.Format</c> method. See
  23806. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23807. of the formatting.
  23808. </para>
  23809. <para>
  23810. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23811. 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)"/>
  23812. methods instead.
  23813. </para>
  23814. </remarks>
  23815. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23816. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23817. </member>
  23818. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  23819. <summary>
  23820. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23821. </summary>
  23822. <param name="logger">The logger on which the message is logged.</param>
  23823. <param name="format">A String containing zero or more format items</param>
  23824. <param name="arg0">An Object to format</param>
  23825. <param name="arg1">An Object to format</param>
  23826. <remarks>
  23827. <para>
  23828. The message is formatted using the <c>String.Format</c> method. See
  23829. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23830. of the formatting.
  23831. </para>
  23832. <para>
  23833. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23834. 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)"/>
  23835. methods instead.
  23836. </para>
  23837. </remarks>
  23838. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23839. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23840. </member>
  23841. <member name="M:log4net.Util.ILogExtensions.WarnFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  23842. <summary>
  23843. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Warn"/> level.
  23844. </summary>
  23845. <param name="logger">The logger on which the message is logged.</param>
  23846. <param name="format">A String containing zero or more format items</param>
  23847. <param name="arg0">An Object to format</param>
  23848. <param name="arg1">An Object to format</param>
  23849. <param name="arg2">An Object to format</param>
  23850. <remarks>
  23851. <para>
  23852. The message is formatted using the <c>String.Format</c> method. See
  23853. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23854. of the formatting.
  23855. </para>
  23856. <para>
  23857. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23858. 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)"/>
  23859. methods instead.
  23860. </para>
  23861. </remarks>
  23862. <seealso cref="M:log4net.ILog.Warn(System.Object)"/>
  23863. <seealso cref="P:log4net.ILog.IsWarnEnabled"/>
  23864. </member>
  23865. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object})">
  23866. <summary>
  23867. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  23868. </summary>
  23869. <param name="logger">The logger on which the message is logged.</param>
  23870. <param name="callback">The lambda expression that gets the object to log.</param>
  23871. <remarks>
  23872. <para>
  23873. This method first checks if this logger is <c>ERROR</c>
  23874. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  23875. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23876. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  23877. the message object (retrieved by invocation of the provided callback) to a
  23878. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  23879. It then proceeds to call all the registered appenders in this logger
  23880. and also higher in the hierarchy depending on the value of
  23881. the additivity flag.
  23882. </para>
  23883. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23884. to this method will print the name of the <see cref="T:System.Exception"/>
  23885. but no stack trace. To print a stack trace use the
  23886. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  23887. </para>
  23888. </remarks>
  23889. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23890. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23891. </member>
  23892. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  23893. <summary>
  23894. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  23895. the stack trace of the <see cref="T:System.Exception"/> passed
  23896. as a parameter.
  23897. </summary>
  23898. <param name="logger">The logger on which the message is logged.</param>
  23899. <param name="callback">The lambda expression that gets the object to log.</param>
  23900. <param name="exception">The exception to log, including its stack trace.</param>
  23901. <remarks>
  23902. <para>
  23903. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23904. </para>
  23905. </remarks>
  23906. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23907. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23908. </member>
  23909. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)">
  23910. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.</overloads> //TODO
  23911. <summary>
  23912. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level.
  23913. </summary>
  23914. <param name="logger">The logger on which the message is logged.</param>
  23915. <param name="message">The message object to log.</param>
  23916. <remarks>
  23917. <para>
  23918. This method first checks if this logger is <c>ERROR</c>
  23919. enabled by reading the value <seealso cref="P:log4net.ILog.IsErrorEnabled"/> property.
  23920. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  23921. implementation. If this logger is <c>ERROR</c> enabled, then it converts
  23922. the message object (passed as parameter) to a string by invoking the appropriate
  23923. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  23924. proceeds to call all the registered appenders in this logger
  23925. and also higher in the hierarchy depending on the value of
  23926. the additivity flag.
  23927. </para>
  23928. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  23929. to this method will print the name of the <see cref="T:System.Exception"/>
  23930. but no stack trace. To print a stack trace use the
  23931. <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  23932. </para>
  23933. </remarks>
  23934. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23935. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23936. </member>
  23937. <member name="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object,System.Exception)">
  23938. <summary>
  23939. Log a message object with the <see cref="F:log4net.Core.Level.Error"/> level including
  23940. the stack trace of the <see cref="T:System.Exception"/> passed
  23941. as a parameter.
  23942. </summary>
  23943. <param name="logger">The logger on which the message is logged.</param>
  23944. <param name="message">The message object to log.</param>
  23945. <param name="exception">The exception to log, including its stack trace.</param>
  23946. <remarks>
  23947. <para>
  23948. See the <see cref="M:log4net.Util.ILogExtensions.ErrorExt(log4net.ILog,System.Object)"/> form for more detailed information.
  23949. </para>
  23950. </remarks>
  23951. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23952. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23953. </member>
  23954. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object)">
  23955. <summary>
  23956. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  23957. </summary>
  23958. <param name="logger">The logger on which the message is logged.</param>
  23959. <param name="format">A String containing zero or more format items</param>
  23960. <param name="arg0">An Object to format</param>
  23961. <remarks>
  23962. <para>
  23963. The message is formatted using the <c>String.Format</c> method. See
  23964. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23965. of the formatting.
  23966. </para>
  23967. <para>
  23968. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23969. 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)"/>
  23970. methods instead.
  23971. </para>
  23972. </remarks>
  23973. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23974. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23975. </member>
  23976. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object[])">
  23977. <summary>
  23978. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  23979. </summary>
  23980. <param name="logger">The logger on which the message is logged.</param>
  23981. <param name="format">A String containing zero or more format items</param>
  23982. <param name="args">An Object array containing zero or more objects to format</param>
  23983. <remarks>
  23984. <para>
  23985. The message is formatted using the <c>String.Format</c> method. See
  23986. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  23987. of the formatting.
  23988. </para>
  23989. <para>
  23990. This method does not take an <see cref="T:System.Exception"/> object to include in the
  23991. 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)"/>
  23992. methods instead.
  23993. </para>
  23994. </remarks>
  23995. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  23996. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  23997. </member>
  23998. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  23999. <summary>
  24000. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  24001. </summary>
  24002. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  24003. <param name="logger">The logger on which the message is logged.</param>
  24004. <param name="format">A String containing zero or more format items</param>
  24005. <param name="args">An Object array containing zero or more objects to format</param>
  24006. <remarks>
  24007. <para>
  24008. The message is formatted using the <c>String.Format</c> method. See
  24009. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24010. of the formatting.
  24011. </para>
  24012. <para>
  24013. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24014. 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)"/>
  24015. methods instead.
  24016. </para>
  24017. </remarks>
  24018. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  24019. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  24020. </member>
  24021. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  24022. <summary>
  24023. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  24024. </summary>
  24025. <param name="logger">The logger on which the message is logged.</param>
  24026. <param name="format">A String containing zero or more format items</param>
  24027. <param name="arg0">An Object to format</param>
  24028. <param name="arg1">An Object to format</param>
  24029. <remarks>
  24030. <para>
  24031. The message is formatted using the <c>String.Format</c> method. See
  24032. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24033. of the formatting.
  24034. </para>
  24035. <para>
  24036. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24037. 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)"/>
  24038. methods instead.
  24039. </para>
  24040. </remarks>
  24041. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  24042. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  24043. </member>
  24044. <member name="M:log4net.Util.ILogExtensions.ErrorFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  24045. <summary>
  24046. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Error"/> level.
  24047. </summary>
  24048. <param name="logger">The logger on which the message is logged.</param>
  24049. <param name="format">A String containing zero or more format items</param>
  24050. <param name="arg0">An Object to format</param>
  24051. <param name="arg1">An Object to format</param>
  24052. <param name="arg2">An Object to format</param>
  24053. <remarks>
  24054. <para>
  24055. The message is formatted using the <c>String.Format</c> method. See
  24056. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24057. of the formatting.
  24058. </para>
  24059. <para>
  24060. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24061. 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)"/>
  24062. methods instead.
  24063. </para>
  24064. </remarks>
  24065. <seealso cref="M:log4net.ILog.Error(System.Object)"/>
  24066. <seealso cref="P:log4net.ILog.IsErrorEnabled"/>
  24067. </member>
  24068. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object})">
  24069. <summary>
  24070. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24071. </summary>
  24072. <param name="logger">The logger on which the message is logged.</param>
  24073. <param name="callback">The lambda expression that gets the object to log.</param>
  24074. <remarks>
  24075. <para>
  24076. This method first checks if this logger is <c>FATAL</c>
  24077. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  24078. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  24079. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  24080. the message object (retrieved by invocation of the provided callback) to a
  24081. string by invoking the appropriate <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>.
  24082. It then proceeds to call all the registered appenders in this logger
  24083. and also higher in the hierarchy depending on the value of
  24084. the additivity flag.
  24085. </para>
  24086. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  24087. to this method will print the name of the <see cref="T:System.Exception"/>
  24088. but no stack trace. To print a stack trace use the
  24089. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)"/> form instead.
  24090. </para>
  24091. </remarks>
  24092. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24093. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24094. </member>
  24095. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Func{System.Object},System.Exception)">
  24096. <summary>
  24097. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  24098. the stack trace of the <see cref="T:System.Exception"/> passed
  24099. as a parameter.
  24100. </summary>
  24101. <param name="logger">The logger on which the message is logged.</param>
  24102. <param name="callback">The lambda expression that gets the object to log.</param>
  24103. <param name="exception">The exception to log, including its stack trace.</param>
  24104. <remarks>
  24105. <para>
  24106. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  24107. </para>
  24108. </remarks>
  24109. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24110. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24111. </member>
  24112. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)">
  24113. <overloads>Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.</overloads> //TODO
  24114. <summary>
  24115. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24116. </summary>
  24117. <param name="logger">The logger on which the message is logged.</param>
  24118. <param name="message">The message object to log.</param>
  24119. <remarks>
  24120. <para>
  24121. This method first checks if this logger is <c>FATAL</c>
  24122. enabled by reading the value <seealso cref="P:log4net.ILog.IsFatalEnabled"/> property.
  24123. This check happens always and does not depend on the <seealso cref="T:log4net.ILog"/>
  24124. implementation. If this logger is <c>FATAL</c> enabled, then it converts
  24125. the message object (passed as parameter) to a string by invoking the appropriate
  24126. <see cref="T:log4net.ObjectRenderer.IObjectRenderer"/>. It then
  24127. proceeds to call all the registered appenders in this logger
  24128. and also higher in the hierarchy depending on the value of
  24129. the additivity flag.
  24130. </para>
  24131. <para><b>WARNING</b> Note that passing an <see cref="T:System.Exception"/>
  24132. to this method will print the name of the <see cref="T:System.Exception"/>
  24133. but no stack trace. To print a stack trace use the
  24134. <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)"/> form instead.
  24135. </para>
  24136. </remarks>
  24137. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24138. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24139. </member>
  24140. <member name="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object,System.Exception)">
  24141. <summary>
  24142. Log a message object with the <see cref="F:log4net.Core.Level.Fatal"/> level including
  24143. the stack trace of the <see cref="T:System.Exception"/> passed
  24144. as a parameter.
  24145. </summary>
  24146. <param name="logger">The logger on which the message is logged.</param>
  24147. <param name="message">The message object to log.</param>
  24148. <param name="exception">The exception to log, including its stack trace.</param>
  24149. <remarks>
  24150. <para>
  24151. See the <see cref="M:log4net.Util.ILogExtensions.FatalExt(log4net.ILog,System.Object)"/> form for more detailed information.
  24152. </para>
  24153. </remarks>
  24154. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24155. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24156. </member>
  24157. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object)">
  24158. <summary>
  24159. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24160. </summary>
  24161. <param name="logger">The logger on which the message is logged.</param>
  24162. <param name="format">A String containing zero or more format items</param>
  24163. <param name="arg0">An Object to format</param>
  24164. <remarks>
  24165. <para>
  24166. The message is formatted using the <c>String.Format</c> method. See
  24167. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24168. of the formatting.
  24169. </para>
  24170. <para>
  24171. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24172. 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)"/>
  24173. methods instead.
  24174. </para>
  24175. </remarks>
  24176. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24177. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24178. </member>
  24179. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object[])">
  24180. <summary>
  24181. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24182. </summary>
  24183. <param name="logger">The logger on which the message is logged.</param>
  24184. <param name="format">A String containing zero or more format items</param>
  24185. <param name="args">An Object array containing zero or more objects to format</param>
  24186. <remarks>
  24187. <para>
  24188. The message is formatted using the <c>String.Format</c> method. See
  24189. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24190. of the formatting.
  24191. </para>
  24192. <para>
  24193. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24194. 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)"/>
  24195. methods instead.
  24196. </para>
  24197. </remarks>
  24198. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24199. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24200. </member>
  24201. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.IFormatProvider,System.String,System.Object[])">
  24202. <summary>
  24203. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24204. </summary>
  24205. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information</param>
  24206. <param name="logger">The logger on which the message is logged.</param>
  24207. <param name="format">A String containing zero or more format items</param>
  24208. <param name="args">An Object array containing zero or more objects to format</param>
  24209. <remarks>
  24210. <para>
  24211. The message is formatted using the <c>String.Format</c> method. See
  24212. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24213. of the formatting.
  24214. </para>
  24215. <para>
  24216. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24217. 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)"/>
  24218. methods instead.
  24219. </para>
  24220. </remarks>
  24221. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24222. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24223. </member>
  24224. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object)">
  24225. <summary>
  24226. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24227. </summary>
  24228. <param name="logger">The logger on which the message is logged.</param>
  24229. <param name="format">A String containing zero or more format items</param>
  24230. <param name="arg0">An Object to format</param>
  24231. <param name="arg1">An Object to format</param>
  24232. <remarks>
  24233. <para>
  24234. The message is formatted using the <c>String.Format</c> method. See
  24235. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24236. of the formatting.
  24237. </para>
  24238. <para>
  24239. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24240. 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)"/>
  24241. methods instead.
  24242. </para>
  24243. </remarks>
  24244. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24245. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24246. </member>
  24247. <member name="M:log4net.Util.ILogExtensions.FatalFormatExt(log4net.ILog,System.String,System.Object,System.Object,System.Object)">
  24248. <summary>
  24249. Logs a formatted message string with the <see cref="F:log4net.Core.Level.Fatal"/> level.
  24250. </summary>
  24251. <param name="logger">The logger on which the message is logged.</param>
  24252. <param name="format">A String containing zero or more format items</param>
  24253. <param name="arg0">An Object to format</param>
  24254. <param name="arg1">An Object to format</param>
  24255. <param name="arg2">An Object to format</param>
  24256. <remarks>
  24257. <para>
  24258. The message is formatted using the <c>String.Format</c> method. See
  24259. <see cref="M:System.String.Format(System.String,System.Object[])"/> for details of the syntax of the format string and the behavior
  24260. of the formatting.
  24261. </para>
  24262. <para>
  24263. This method does not take an <see cref="T:System.Exception"/> object to include in the
  24264. 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)"/>
  24265. methods instead.
  24266. </para>
  24267. </remarks>
  24268. <seealso cref="M:log4net.ILog.Fatal(System.Object)"/>
  24269. <seealso cref="P:log4net.ILog.IsFatalEnabled"/>
  24270. </member>
  24271. <member name="T:log4net.Util.LevelMapping">
  24272. <summary>
  24273. Manages a mapping from levels to <see cref="T:log4net.Util.LevelMappingEntry"/>
  24274. </summary>
  24275. <remarks>
  24276. <para>
  24277. Manages an ordered mapping from <see cref="T:log4net.Core.Level"/> instances
  24278. to <see cref="T:log4net.Util.LevelMappingEntry"/> subclasses.
  24279. </para>
  24280. </remarks>
  24281. <author>Nicko Cadell</author>
  24282. </member>
  24283. <member name="M:log4net.Util.LevelMapping.#ctor">
  24284. <summary>
  24285. Default constructor
  24286. </summary>
  24287. <remarks>
  24288. <para>
  24289. Initialise a new instance of <see cref="T:log4net.Util.LevelMapping"/>.
  24290. </para>
  24291. </remarks>
  24292. </member>
  24293. <member name="M:log4net.Util.LevelMapping.Add(log4net.Util.LevelMappingEntry)">
  24294. <summary>
  24295. Add a <see cref="T:log4net.Util.LevelMappingEntry"/> to this mapping
  24296. </summary>
  24297. <param name="entry">the entry to add</param>
  24298. <remarks>
  24299. <para>
  24300. If a <see cref="T:log4net.Util.LevelMappingEntry"/> has previously been added
  24301. for the same <see cref="T:log4net.Core.Level"/> then that entry will be
  24302. overwritten.
  24303. </para>
  24304. </remarks>
  24305. </member>
  24306. <member name="M:log4net.Util.LevelMapping.Lookup(log4net.Core.Level)">
  24307. <summary>
  24308. Lookup the mapping for the specified level
  24309. </summary>
  24310. <param name="level">the level to lookup</param>
  24311. <returns>the <see cref="T:log4net.Util.LevelMappingEntry"/> for the level or <c>null</c> if no mapping found</returns>
  24312. <remarks>
  24313. <para>
  24314. Lookup the value for the specified level. Finds the nearest
  24315. mapping value for the level that is equal to or less than the
  24316. <paramref name="level"/> specified.
  24317. </para>
  24318. <para>
  24319. If no mapping could be found then <c>null</c> is returned.
  24320. </para>
  24321. </remarks>
  24322. </member>
  24323. <member name="M:log4net.Util.LevelMapping.ActivateOptions">
  24324. <summary>
  24325. Initialize options
  24326. </summary>
  24327. <remarks>
  24328. <para>
  24329. Caches the sorted list of <see cref="T:log4net.Util.LevelMappingEntry"/> in an array
  24330. </para>
  24331. </remarks>
  24332. </member>
  24333. <member name="T:log4net.Util.LevelMappingEntry">
  24334. <summary>
  24335. An entry in the <see cref="T:log4net.Util.LevelMapping"/>
  24336. </summary>
  24337. <remarks>
  24338. <para>
  24339. This is an abstract base class for types that are stored in the
  24340. <see cref="T:log4net.Util.LevelMapping"/> object.
  24341. </para>
  24342. </remarks>
  24343. <author>Nicko Cadell</author>
  24344. </member>
  24345. <member name="M:log4net.Util.LevelMappingEntry.#ctor">
  24346. <summary>
  24347. Default protected constructor
  24348. </summary>
  24349. <remarks>
  24350. <para>
  24351. Default protected constructor
  24352. </para>
  24353. </remarks>
  24354. </member>
  24355. <member name="P:log4net.Util.LevelMappingEntry.Level">
  24356. <summary>
  24357. The level that is the key for this mapping
  24358. </summary>
  24359. <value>
  24360. The <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this mapping
  24361. </value>
  24362. <remarks>
  24363. <para>
  24364. Get or set the <see cref="P:log4net.Util.LevelMappingEntry.Level"/> that is the key for this
  24365. mapping subclass.
  24366. </para>
  24367. </remarks>
  24368. </member>
  24369. <member name="M:log4net.Util.LevelMappingEntry.ActivateOptions">
  24370. <summary>
  24371. Initialize any options defined on this entry
  24372. </summary>
  24373. <remarks>
  24374. <para>
  24375. Should be overridden by any classes that need to initialise based on their options
  24376. </para>
  24377. </remarks>
  24378. </member>
  24379. <member name="T:log4net.Util.LogicalThreadContextProperties">
  24380. <summary>
  24381. Implementation of Properties collection for the <see cref="T:log4net.LogicalThreadContext"/>
  24382. </summary>
  24383. <remarks>
  24384. <para>
  24385. Class implements a collection of properties that is specific to each thread.
  24386. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  24387. </para>
  24388. <para>
  24389. This class stores its properties in a slot on the <see cref="!:CallContext"/> named
  24390. <c>log4net.Util.LogicalThreadContextProperties</c>.
  24391. </para>
  24392. <para>
  24393. For .NET Standard 1.3 this class uses
  24394. System.Threading.AsyncLocal rather than <see
  24395. cref="!:System.Runtime.Remoting.Messaging.CallContext"/>.
  24396. </para>
  24397. <para>
  24398. The <see cref="!:CallContext"/> requires a link time
  24399. <see cref="!:System.Security.Permissions.SecurityPermission"/> for the
  24400. <see cref="!:System.Security.Permissions.SecurityPermissionFlag.Infrastructure"/>.
  24401. If the calling code does not have this permission then this context will be disabled.
  24402. It will not store any property values set on it.
  24403. </para>
  24404. </remarks>
  24405. <author>Nicko Cadell</author>
  24406. </member>
  24407. <member name="F:log4net.Util.LogicalThreadContextProperties.m_disabled">
  24408. <summary>
  24409. Flag used to disable this context if we don't have permission to access the CallContext.
  24410. </summary>
  24411. </member>
  24412. <member name="M:log4net.Util.LogicalThreadContextProperties.#ctor">
  24413. <summary>
  24414. Constructor
  24415. </summary>
  24416. <remarks>
  24417. <para>
  24418. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextProperties" /> class.
  24419. </para>
  24420. </remarks>
  24421. </member>
  24422. <member name="P:log4net.Util.LogicalThreadContextProperties.Item(System.String)">
  24423. <summary>
  24424. Gets or sets the value of a property
  24425. </summary>
  24426. <value>
  24427. The value for the property with the specified key
  24428. </value>
  24429. <remarks>
  24430. <para>
  24431. Get or set the property value for the <paramref name="key"/> specified.
  24432. </para>
  24433. </remarks>
  24434. </member>
  24435. <member name="M:log4net.Util.LogicalThreadContextProperties.Remove(System.String)">
  24436. <summary>
  24437. Remove a property
  24438. </summary>
  24439. <param name="key">the key for the entry to remove</param>
  24440. <remarks>
  24441. <para>
  24442. Remove the value for the specified <paramref name="key"/> from the context.
  24443. </para>
  24444. </remarks>
  24445. </member>
  24446. <member name="M:log4net.Util.LogicalThreadContextProperties.Clear">
  24447. <summary>
  24448. Clear all the context properties
  24449. </summary>
  24450. <remarks>
  24451. <para>
  24452. Clear all the context properties
  24453. </para>
  24454. </remarks>
  24455. </member>
  24456. <member name="M:log4net.Util.LogicalThreadContextProperties.GetProperties(System.Boolean)">
  24457. <summary>
  24458. Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread.
  24459. </summary>
  24460. <param name="create">create the dictionary if it does not exist, otherwise return null if is does not exist</param>
  24461. <returns>the properties for this thread</returns>
  24462. <remarks>
  24463. <para>
  24464. The collection returned is only to be used on the calling thread. If the
  24465. caller needs to share the collection between different threads then the
  24466. caller must clone the collection before doings so.
  24467. </para>
  24468. </remarks>
  24469. </member>
  24470. <member name="M:log4net.Util.LogicalThreadContextProperties.GetLogicalProperties">
  24471. <summary>
  24472. Gets the call context get data.
  24473. </summary>
  24474. <returns>The peroperties dictionary stored in the call context</returns>
  24475. <remarks>
  24476. The <see cref="!:CallContext"/> method <see cref="!:CallContext.GetData"/> has a
  24477. security link demand, therfore we must put the method call in a seperate method
  24478. that we can wrap in an exception handler.
  24479. </remarks>
  24480. </member>
  24481. <member name="M:log4net.Util.LogicalThreadContextProperties.SetLogicalProperties(log4net.Util.PropertiesDictionary)">
  24482. <summary>
  24483. Sets the call context data.
  24484. </summary>
  24485. <param name="properties">The properties.</param>
  24486. <remarks>
  24487. The <see cref="!:CallContext"/> method <see cref="!:CallContext.SetData"/> has a
  24488. security link demand, therfore we must put the method call in a seperate method
  24489. that we can wrap in an exception handler.
  24490. </remarks>
  24491. </member>
  24492. <member name="F:log4net.Util.LogicalThreadContextProperties.declaringType">
  24493. <summary>
  24494. The fully qualified type of the LogicalThreadContextProperties class.
  24495. </summary>
  24496. <remarks>
  24497. Used by the internal logger to record the Type of the
  24498. log message.
  24499. </remarks>
  24500. </member>
  24501. <member name="T:log4net.Util.TwoArgAction`2">
  24502. <summary>
  24503. Delegate type used for LogicalThreadContextStack's callbacks.
  24504. </summary>
  24505. </member>
  24506. <member name="T:log4net.Util.LogicalThreadContextStack">
  24507. <summary>
  24508. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  24509. </summary>
  24510. <remarks>
  24511. <para>
  24512. Implementation of Stack for the <see cref="T:log4net.LogicalThreadContext"/>
  24513. </para>
  24514. </remarks>
  24515. <author>Nicko Cadell</author>
  24516. </member>
  24517. <member name="F:log4net.Util.LogicalThreadContextStack.m_stack">
  24518. <summary>
  24519. The stack store.
  24520. </summary>
  24521. </member>
  24522. <member name="F:log4net.Util.LogicalThreadContextStack.m_propertyKey">
  24523. <summary>
  24524. The name of this <see cref="T:log4net.Util.LogicalThreadContextStack"/> within the
  24525. <see cref="T:log4net.Util.LogicalThreadContextProperties"/>.
  24526. </summary>
  24527. </member>
  24528. <member name="F:log4net.Util.LogicalThreadContextStack.m_registerNew">
  24529. <summary>
  24530. The callback used to let the <see cref="T:log4net.Util.LogicalThreadContextStacks"/> register a
  24531. new instance of a <see cref="T:log4net.Util.LogicalThreadContextStack"/>.
  24532. </summary>
  24533. </member>
  24534. <member name="M:log4net.Util.LogicalThreadContextStack.#ctor(System.String,log4net.Util.TwoArgAction{System.String,log4net.Util.LogicalThreadContextStack})">
  24535. <summary>
  24536. Internal constructor
  24537. </summary>
  24538. <remarks>
  24539. <para>
  24540. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack" /> class.
  24541. </para>
  24542. </remarks>
  24543. </member>
  24544. <member name="P:log4net.Util.LogicalThreadContextStack.Count">
  24545. <summary>
  24546. The number of messages in the stack
  24547. </summary>
  24548. <value>
  24549. The current number of messages in the stack
  24550. </value>
  24551. <remarks>
  24552. <para>
  24553. The current number of messages in the stack. That is
  24554. the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> has been called
  24555. minus the number of times <see cref="M:log4net.Util.LogicalThreadContextStack.Pop"/> has been called.
  24556. </para>
  24557. </remarks>
  24558. </member>
  24559. <member name="M:log4net.Util.LogicalThreadContextStack.Clear">
  24560. <summary>
  24561. Clears all the contextual information held in this stack.
  24562. </summary>
  24563. <remarks>
  24564. <para>
  24565. Clears all the contextual information held in this stack.
  24566. Only call this if you think that this thread is being reused after
  24567. a previous call execution which may not have completed correctly.
  24568. You do not need to use this method if you always guarantee to call
  24569. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  24570. returned from <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  24571. for example by using the <c>using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  24572. syntax.
  24573. </para>
  24574. </remarks>
  24575. </member>
  24576. <member name="M:log4net.Util.LogicalThreadContextStack.Pop">
  24577. <summary>
  24578. Removes the top context from this stack.
  24579. </summary>
  24580. <returns>The message in the context that was removed from the top of this stack.</returns>
  24581. <remarks>
  24582. <para>
  24583. Remove the top context from this stack, and return
  24584. it to the caller. If this stack is empty then an
  24585. empty string (not <see langword="null"/>) is returned.
  24586. </para>
  24587. </remarks>
  24588. </member>
  24589. <member name="M:log4net.Util.LogicalThreadContextStack.Push(System.String)">
  24590. <summary>
  24591. Pushes a new context message into this stack.
  24592. </summary>
  24593. <param name="message">The new context message.</param>
  24594. <returns>
  24595. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  24596. </returns>
  24597. <remarks>
  24598. <para>
  24599. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  24600. is returned that can be used to clean up this stack. This
  24601. can be easily combined with the <c>using</c> keyword to scope the
  24602. context.
  24603. </para>
  24604. </remarks>
  24605. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  24606. <code lang="C#">
  24607. using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message"))
  24608. {
  24609. log.Warn("This should have an ThreadContext Stack message");
  24610. }
  24611. </code>
  24612. </example>
  24613. </member>
  24614. <member name="M:log4net.Util.LogicalThreadContextStack.GetFullMessage">
  24615. <summary>
  24616. Gets the current context information for this stack.
  24617. </summary>
  24618. <returns>The current context information.</returns>
  24619. </member>
  24620. <member name="P:log4net.Util.LogicalThreadContextStack.InternalStack">
  24621. <summary>
  24622. Gets and sets the internal stack used by this <see cref="T:log4net.Util.LogicalThreadContextStack"/>
  24623. </summary>
  24624. <value>The internal storage stack</value>
  24625. <remarks>
  24626. <para>
  24627. This property is provided only to support backward compatability
  24628. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  24629. be modified.
  24630. </para>
  24631. </remarks>
  24632. </member>
  24633. <member name="M:log4net.Util.LogicalThreadContextStack.ToString">
  24634. <summary>
  24635. Gets the current context information for this stack.
  24636. </summary>
  24637. <returns>Gets the current context information</returns>
  24638. <remarks>
  24639. <para>
  24640. Gets the current context information for this stack.
  24641. </para>
  24642. </remarks>
  24643. </member>
  24644. <member name="M:log4net.Util.LogicalThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  24645. <summary>
  24646. Get a portable version of this object
  24647. </summary>
  24648. <returns>the portable instance of this object</returns>
  24649. <remarks>
  24650. <para>
  24651. Get a cross thread portable version of this object
  24652. </para>
  24653. </remarks>
  24654. </member>
  24655. <member name="T:log4net.Util.LogicalThreadContextStack.StackFrame">
  24656. <summary>
  24657. Inner class used to represent a single context frame in the stack.
  24658. </summary>
  24659. <remarks>
  24660. <para>
  24661. Inner class used to represent a single context frame in the stack.
  24662. </para>
  24663. </remarks>
  24664. </member>
  24665. <member name="M:log4net.Util.LogicalThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.LogicalThreadContextStack.StackFrame)">
  24666. <summary>
  24667. Constructor
  24668. </summary>
  24669. <param name="message">The message for this context.</param>
  24670. <param name="parent">The parent context in the chain.</param>
  24671. <remarks>
  24672. <para>
  24673. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.StackFrame" /> class
  24674. with the specified message and parent context.
  24675. </para>
  24676. </remarks>
  24677. </member>
  24678. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.Message">
  24679. <summary>
  24680. Get the message.
  24681. </summary>
  24682. <value>The message.</value>
  24683. <remarks>
  24684. <para>
  24685. Get the message.
  24686. </para>
  24687. </remarks>
  24688. </member>
  24689. <member name="P:log4net.Util.LogicalThreadContextStack.StackFrame.FullMessage">
  24690. <summary>
  24691. Gets the full text of the context down to the root level.
  24692. </summary>
  24693. <value>
  24694. The full text of the context down to the root level.
  24695. </value>
  24696. <remarks>
  24697. <para>
  24698. Gets the full text of the context down to the root level.
  24699. </para>
  24700. </remarks>
  24701. </member>
  24702. <member name="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame">
  24703. <summary>
  24704. Struct returned from the <see cref="M:log4net.Util.LogicalThreadContextStack.Push(System.String)"/> method.
  24705. </summary>
  24706. <remarks>
  24707. <para>
  24708. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  24709. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  24710. </para>
  24711. </remarks>
  24712. </member>
  24713. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_frameDepth">
  24714. <summary>
  24715. The depth to trim the stack to when this instance is disposed
  24716. </summary>
  24717. </member>
  24718. <member name="F:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.m_logicalThreadContextStack">
  24719. <summary>
  24720. The outer LogicalThreadContextStack.
  24721. </summary>
  24722. </member>
  24723. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.#ctor(log4net.Util.LogicalThreadContextStack,System.Int32)">
  24724. <summary>
  24725. Constructor
  24726. </summary>
  24727. <param name="logicalThreadContextStack">The internal stack used by the ThreadContextStack.</param>
  24728. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  24729. <remarks>
  24730. <para>
  24731. Initializes a new instance of the <see cref="T:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame" /> class with
  24732. the specified stack and return depth.
  24733. </para>
  24734. </remarks>
  24735. </member>
  24736. <member name="M:log4net.Util.LogicalThreadContextStack.AutoPopStackFrame.Dispose">
  24737. <summary>
  24738. Returns the stack to the correct depth.
  24739. </summary>
  24740. <remarks>
  24741. <para>
  24742. Returns the stack to the correct depth.
  24743. </para>
  24744. </remarks>
  24745. </member>
  24746. <member name="T:log4net.Util.LogicalThreadContextStacks">
  24747. <summary>
  24748. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  24749. </summary>
  24750. <remarks>
  24751. <para>
  24752. Implementation of Stacks collection for the <see cref="T:log4net.LogicalThreadContext"/>
  24753. </para>
  24754. </remarks>
  24755. <author>Nicko Cadell</author>
  24756. </member>
  24757. <member name="M:log4net.Util.LogicalThreadContextStacks.#ctor(log4net.Util.LogicalThreadContextProperties)">
  24758. <summary>
  24759. Internal constructor
  24760. </summary>
  24761. <remarks>
  24762. <para>
  24763. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks" /> class.
  24764. </para>
  24765. </remarks>
  24766. </member>
  24767. <member name="P:log4net.Util.LogicalThreadContextStacks.Item(System.String)">
  24768. <summary>
  24769. Gets the named thread context stack
  24770. </summary>
  24771. <value>
  24772. The named stack
  24773. </value>
  24774. <remarks>
  24775. <para>
  24776. Gets the named thread context stack
  24777. </para>
  24778. </remarks>
  24779. </member>
  24780. <member name="F:log4net.Util.LogicalThreadContextStacks.declaringType">
  24781. <summary>
  24782. The fully qualified type of the ThreadContextStacks class.
  24783. </summary>
  24784. <remarks>
  24785. Used by the internal logger to record the Type of the
  24786. log message.
  24787. </remarks>
  24788. </member>
  24789. <member name="T:log4net.Util.LogReceivedEventHandler">
  24790. <summary>
  24791. </summary>
  24792. <param name="source"></param>
  24793. <param name="e"></param>
  24794. </member>
  24795. <member name="T:log4net.Util.LogLog">
  24796. <summary>
  24797. Outputs log statements from within the log4net assembly.
  24798. </summary>
  24799. <remarks>
  24800. <para>
  24801. Log4net components cannot make log4net logging calls. However, it is
  24802. sometimes useful for the user to learn about what log4net is
  24803. doing.
  24804. </para>
  24805. <para>
  24806. All log4net internal debug calls go to the standard output stream
  24807. whereas internal error messages are sent to the standard error output
  24808. stream.
  24809. </para>
  24810. </remarks>
  24811. <author>Nicko Cadell</author>
  24812. <author>Gert Driesen</author>
  24813. </member>
  24814. <member name="E:log4net.Util.LogLog.LogReceived">
  24815. <summary>
  24816. The event raised when an internal message has been received.
  24817. </summary>
  24818. </member>
  24819. <member name="P:log4net.Util.LogLog.Source">
  24820. <summary>
  24821. The Type that generated the internal message.
  24822. </summary>
  24823. </member>
  24824. <member name="P:log4net.Util.LogLog.TimeStamp">
  24825. <summary>
  24826. The DateTime stamp of when the internal message was received.
  24827. </summary>
  24828. </member>
  24829. <member name="P:log4net.Util.LogLog.TimeStampUtc">
  24830. <summary>
  24831. The UTC DateTime stamp of when the internal message was received.
  24832. </summary>
  24833. </member>
  24834. <member name="P:log4net.Util.LogLog.Prefix">
  24835. <summary>
  24836. A string indicating the severity of the internal message.
  24837. </summary>
  24838. <remarks>
  24839. "log4net: ",
  24840. "log4net:ERROR ",
  24841. "log4net:WARN "
  24842. </remarks>
  24843. </member>
  24844. <member name="P:log4net.Util.LogLog.Message">
  24845. <summary>
  24846. The internal log message.
  24847. </summary>
  24848. </member>
  24849. <member name="P:log4net.Util.LogLog.Exception">
  24850. <summary>
  24851. The Exception related to the message.
  24852. </summary>
  24853. <remarks>
  24854. Optional. Will be null if no Exception was passed.
  24855. </remarks>
  24856. </member>
  24857. <member name="M:log4net.Util.LogLog.ToString">
  24858. <summary>
  24859. Formats Prefix, Source, and Message in the same format as the value
  24860. sent to Console.Out and Trace.Write.
  24861. </summary>
  24862. <returns></returns>
  24863. </member>
  24864. <member name="M:log4net.Util.LogLog.#ctor(System.Type,System.String,System.String,System.Exception)">
  24865. <summary>
  24866. Initializes a new instance of the <see cref="T:log4net.Util.LogLog" /> class.
  24867. </summary>
  24868. <param name="source"></param>
  24869. <param name="prefix"></param>
  24870. <param name="message"></param>
  24871. <param name="exception"></param>
  24872. </member>
  24873. <member name="M:log4net.Util.LogLog.#cctor">
  24874. <summary>
  24875. Static constructor that initializes logging by reading
  24876. settings from the application configuration file.
  24877. </summary>
  24878. <remarks>
  24879. <para>
  24880. The <c>log4net.Internal.Debug</c> application setting
  24881. controls internal debugging. This setting should be set
  24882. to <c>true</c> to enable debugging.
  24883. </para>
  24884. <para>
  24885. The <c>log4net.Internal.Quiet</c> application setting
  24886. suppresses all internal logging including error messages.
  24887. This setting should be set to <c>true</c> to enable message
  24888. suppression.
  24889. </para>
  24890. </remarks>
  24891. </member>
  24892. <member name="P:log4net.Util.LogLog.InternalDebugging">
  24893. <summary>
  24894. Gets or sets a value indicating whether log4net internal logging
  24895. is enabled or disabled.
  24896. </summary>
  24897. <value>
  24898. <c>true</c> if log4net internal logging is enabled, otherwise
  24899. <c>false</c>.
  24900. </value>
  24901. <remarks>
  24902. <para>
  24903. When set to <c>true</c>, internal debug level logging will be
  24904. displayed.
  24905. </para>
  24906. <para>
  24907. This value can be set by setting the application setting
  24908. <c>log4net.Internal.Debug</c> in the application configuration
  24909. file.
  24910. </para>
  24911. <para>
  24912. The default value is <c>false</c>, i.e. debugging is
  24913. disabled.
  24914. </para>
  24915. </remarks>
  24916. <example>
  24917. <para>
  24918. The following example enables internal debugging using the
  24919. application configuration file :
  24920. </para>
  24921. <code lang="XML" escaped="true">
  24922. <configuration>
  24923. <appSettings>
  24924. <add key="log4net.Internal.Debug" value="true" />
  24925. </appSettings>
  24926. </configuration>
  24927. </code>
  24928. </example>
  24929. </member>
  24930. <member name="P:log4net.Util.LogLog.QuietMode">
  24931. <summary>
  24932. Gets or sets a value indicating whether log4net should generate no output
  24933. from internal logging, not even for errors.
  24934. </summary>
  24935. <value>
  24936. <c>true</c> if log4net should generate no output at all from internal
  24937. logging, otherwise <c>false</c>.
  24938. </value>
  24939. <remarks>
  24940. <para>
  24941. When set to <c>true</c> will cause internal logging at all levels to be
  24942. suppressed. This means that no warning or error reports will be logged.
  24943. This option overrides the <see cref="P:log4net.Util.LogLog.InternalDebugging"/> setting and
  24944. disables all debug also.
  24945. </para>
  24946. <para>This value can be set by setting the application setting
  24947. <c>log4net.Internal.Quiet</c> in the application configuration file.
  24948. </para>
  24949. <para>
  24950. The default value is <c>false</c>, i.e. internal logging is not
  24951. disabled.
  24952. </para>
  24953. </remarks>
  24954. <example>
  24955. The following example disables internal logging using the
  24956. application configuration file :
  24957. <code lang="XML" escaped="true">
  24958. <configuration>
  24959. <appSettings>
  24960. <add key="log4net.Internal.Quiet" value="true" />
  24961. </appSettings>
  24962. </configuration>
  24963. </code>
  24964. </example>
  24965. </member>
  24966. <member name="P:log4net.Util.LogLog.EmitInternalMessages">
  24967. <summary>
  24968. </summary>
  24969. </member>
  24970. <member name="M:log4net.Util.LogLog.OnLogReceived(System.Type,System.String,System.String,System.Exception)">
  24971. <summary>
  24972. Raises the LogReceived event when an internal messages is received.
  24973. </summary>
  24974. <param name="source"></param>
  24975. <param name="prefix"></param>
  24976. <param name="message"></param>
  24977. <param name="exception"></param>
  24978. </member>
  24979. <member name="P:log4net.Util.LogLog.IsDebugEnabled">
  24980. <summary>
  24981. Test if LogLog.Debug is enabled for output.
  24982. </summary>
  24983. <value>
  24984. <c>true</c> if Debug is enabled
  24985. </value>
  24986. <remarks>
  24987. <para>
  24988. Test if LogLog.Debug is enabled for output.
  24989. </para>
  24990. </remarks>
  24991. </member>
  24992. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String)">
  24993. <summary>
  24994. Writes log4net internal debug messages to the
  24995. standard output stream.
  24996. </summary>
  24997. <param name="source"></param>
  24998. <param name="message">The message to log.</param>
  24999. <remarks>
  25000. <para>
  25001. All internal debug messages are prepended with
  25002. the string "log4net: ".
  25003. </para>
  25004. </remarks>
  25005. </member>
  25006. <member name="M:log4net.Util.LogLog.Debug(System.Type,System.String,System.Exception)">
  25007. <summary>
  25008. Writes log4net internal debug messages to the
  25009. standard output stream.
  25010. </summary>
  25011. <param name="source">The Type that generated this message.</param>
  25012. <param name="message">The message to log.</param>
  25013. <param name="exception">An exception to log.</param>
  25014. <remarks>
  25015. <para>
  25016. All internal debug messages are prepended with
  25017. the string "log4net: ".
  25018. </para>
  25019. </remarks>
  25020. </member>
  25021. <member name="P:log4net.Util.LogLog.IsWarnEnabled">
  25022. <summary>
  25023. Test if LogLog.Warn is enabled for output.
  25024. </summary>
  25025. <value>
  25026. <c>true</c> if Warn is enabled
  25027. </value>
  25028. <remarks>
  25029. <para>
  25030. Test if LogLog.Warn is enabled for output.
  25031. </para>
  25032. </remarks>
  25033. </member>
  25034. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String)">
  25035. <summary>
  25036. Writes log4net internal warning messages to the
  25037. standard error stream.
  25038. </summary>
  25039. <param name="source">The Type that generated this message.</param>
  25040. <param name="message">The message to log.</param>
  25041. <remarks>
  25042. <para>
  25043. All internal warning messages are prepended with
  25044. the string "log4net:WARN ".
  25045. </para>
  25046. </remarks>
  25047. </member>
  25048. <member name="M:log4net.Util.LogLog.Warn(System.Type,System.String,System.Exception)">
  25049. <summary>
  25050. Writes log4net internal warning messages to the
  25051. standard error stream.
  25052. </summary>
  25053. <param name="source">The Type that generated this message.</param>
  25054. <param name="message">The message to log.</param>
  25055. <param name="exception">An exception to log.</param>
  25056. <remarks>
  25057. <para>
  25058. All internal warning messages are prepended with
  25059. the string "log4net:WARN ".
  25060. </para>
  25061. </remarks>
  25062. </member>
  25063. <member name="P:log4net.Util.LogLog.IsErrorEnabled">
  25064. <summary>
  25065. Test if LogLog.Error is enabled for output.
  25066. </summary>
  25067. <value>
  25068. <c>true</c> if Error is enabled
  25069. </value>
  25070. <remarks>
  25071. <para>
  25072. Test if LogLog.Error is enabled for output.
  25073. </para>
  25074. </remarks>
  25075. </member>
  25076. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String)">
  25077. <summary>
  25078. Writes log4net internal error messages to the
  25079. standard error stream.
  25080. </summary>
  25081. <param name="source">The Type that generated this message.</param>
  25082. <param name="message">The message to log.</param>
  25083. <remarks>
  25084. <para>
  25085. All internal error messages are prepended with
  25086. the string "log4net:ERROR ".
  25087. </para>
  25088. </remarks>
  25089. </member>
  25090. <member name="M:log4net.Util.LogLog.Error(System.Type,System.String,System.Exception)">
  25091. <summary>
  25092. Writes log4net internal error messages to the
  25093. standard error stream.
  25094. </summary>
  25095. <param name="source">The Type that generated this message.</param>
  25096. <param name="message">The message to log.</param>
  25097. <param name="exception">An exception to log.</param>
  25098. <remarks>
  25099. <para>
  25100. All internal debug messages are prepended with
  25101. the string "log4net:ERROR ".
  25102. </para>
  25103. </remarks>
  25104. </member>
  25105. <member name="M:log4net.Util.LogLog.EmitOutLine(System.String)">
  25106. <summary>
  25107. Writes output to the standard output stream.
  25108. </summary>
  25109. <param name="message">The message to log.</param>
  25110. <remarks>
  25111. <para>
  25112. Writes to both Console.Out and System.Diagnostics.Trace.
  25113. Note that the System.Diagnostics.Trace is not supported
  25114. on the Compact Framework.
  25115. </para>
  25116. <para>
  25117. If the AppDomain is not configured with a config file then
  25118. the call to System.Diagnostics.Trace may fail. This is only
  25119. an issue if you are programmatically creating your own AppDomains.
  25120. </para>
  25121. </remarks>
  25122. </member>
  25123. <member name="M:log4net.Util.LogLog.EmitErrorLine(System.String)">
  25124. <summary>
  25125. Writes output to the standard error stream.
  25126. </summary>
  25127. <param name="message">The message to log.</param>
  25128. <remarks>
  25129. <para>
  25130. Writes to both Console.Error and System.Diagnostics.Trace.
  25131. Note that the System.Diagnostics.Trace is not supported
  25132. on the Compact Framework.
  25133. </para>
  25134. <para>
  25135. If the AppDomain is not configured with a config file then
  25136. the call to System.Diagnostics.Trace may fail. This is only
  25137. an issue if you are programmatically creating your own AppDomains.
  25138. </para>
  25139. </remarks>
  25140. </member>
  25141. <member name="F:log4net.Util.LogLog.s_debugEnabled">
  25142. <summary>
  25143. Default debug level
  25144. </summary>
  25145. </member>
  25146. <member name="F:log4net.Util.LogLog.s_quietMode">
  25147. <summary>
  25148. In quietMode not even errors generate any output.
  25149. </summary>
  25150. </member>
  25151. <member name="T:log4net.Util.LogLog.LogReceivedAdapter">
  25152. <summary>
  25153. Subscribes to the LogLog.LogReceived event and stores messages
  25154. to the supplied IList instance.
  25155. </summary>
  25156. </member>
  25157. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.#ctor(System.Collections.IList)">
  25158. <summary>
  25159. </summary>
  25160. <param name="items"></param>
  25161. </member>
  25162. <member name="P:log4net.Util.LogLog.LogReceivedAdapter.Items">
  25163. <summary>
  25164. </summary>
  25165. </member>
  25166. <member name="M:log4net.Util.LogLog.LogReceivedAdapter.Dispose">
  25167. <summary>
  25168. </summary>
  25169. </member>
  25170. <member name="T:log4net.Util.LogReceivedEventArgs">
  25171. <summary>
  25172. </summary>
  25173. </member>
  25174. <member name="M:log4net.Util.LogReceivedEventArgs.#ctor(log4net.Util.LogLog)">
  25175. <summary>
  25176. </summary>
  25177. <param name="loglog"></param>
  25178. </member>
  25179. <member name="P:log4net.Util.LogReceivedEventArgs.LogLog">
  25180. <summary>
  25181. </summary>
  25182. </member>
  25183. <member name="T:log4net.Util.NativeError">
  25184. <summary>
  25185. Represents a native error code and message.
  25186. </summary>
  25187. <remarks>
  25188. <para>
  25189. Represents a Win32 platform native error.
  25190. </para>
  25191. </remarks>
  25192. <author>Nicko Cadell</author>
  25193. <author>Gert Driesen</author>
  25194. </member>
  25195. <member name="M:log4net.Util.NativeError.#ctor(System.Int32,System.String)">
  25196. <summary>
  25197. Create an instance of the <see cref="T:log4net.Util.NativeError" /> class with the specified
  25198. error number and message.
  25199. </summary>
  25200. <param name="number">The number of the native error.</param>
  25201. <param name="message">The message of the native error.</param>
  25202. <remarks>
  25203. <para>
  25204. Create an instance of the <see cref="T:log4net.Util.NativeError" /> class with the specified
  25205. error number and message.
  25206. </para>
  25207. </remarks>
  25208. </member>
  25209. <member name="P:log4net.Util.NativeError.Number">
  25210. <summary>
  25211. Gets the number of the native error.
  25212. </summary>
  25213. <value>
  25214. The number of the native error.
  25215. </value>
  25216. <remarks>
  25217. <para>
  25218. Gets the number of the native error.
  25219. </para>
  25220. </remarks>
  25221. </member>
  25222. <member name="P:log4net.Util.NativeError.Message">
  25223. <summary>
  25224. Gets the message of the native error.
  25225. </summary>
  25226. <value>
  25227. The message of the native error.
  25228. </value>
  25229. <remarks>
  25230. <para>
  25231. </para>
  25232. Gets the message of the native error.
  25233. </remarks>
  25234. </member>
  25235. <member name="M:log4net.Util.NativeError.GetLastError">
  25236. <summary>
  25237. Create a new instance of the <see cref="T:log4net.Util.NativeError" /> class for the last Windows error.
  25238. </summary>
  25239. <returns>
  25240. An instance of the <see cref="T:log4net.Util.NativeError" /> class for the last windows error.
  25241. </returns>
  25242. <remarks>
  25243. <para>
  25244. The message for the <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/> error number is lookup up using the
  25245. native Win32 <c>FormatMessage</c> function.
  25246. </para>
  25247. </remarks>
  25248. </member>
  25249. <member name="M:log4net.Util.NativeError.GetError(System.Int32)">
  25250. <summary>
  25251. Create a new instance of the <see cref="T:log4net.Util.NativeError" /> class.
  25252. </summary>
  25253. <param name="number">the error number for the native error</param>
  25254. <returns>
  25255. An instance of the <see cref="T:log4net.Util.NativeError" /> class for the specified
  25256. error number.
  25257. </returns>
  25258. <remarks>
  25259. <para>
  25260. The message for the specified error number is lookup up using the
  25261. native Win32 <c>FormatMessage</c> function.
  25262. </para>
  25263. </remarks>
  25264. </member>
  25265. <member name="M:log4net.Util.NativeError.GetErrorMessage(System.Int32)">
  25266. <summary>
  25267. Retrieves the message corresponding with a Win32 message identifier.
  25268. </summary>
  25269. <param name="messageId">Message identifier for the requested message.</param>
  25270. <returns>
  25271. The message corresponding with the specified message identifier.
  25272. </returns>
  25273. <remarks>
  25274. <para>
  25275. The message will be searched for in system message-table resource(s)
  25276. using the native <c>FormatMessage</c> function.
  25277. </para>
  25278. </remarks>
  25279. </member>
  25280. <member name="M:log4net.Util.NativeError.ToString">
  25281. <summary>
  25282. Return error information string
  25283. </summary>
  25284. <returns>error information string</returns>
  25285. <remarks>
  25286. <para>
  25287. Return error information string
  25288. </para>
  25289. </remarks>
  25290. </member>
  25291. <member name="M:log4net.Util.NativeError.FormatMessage(System.Int32,System.IntPtr@,System.Int32,System.Int32,System.String@,System.Int32,System.IntPtr)">
  25292. <summary>
  25293. Formats a message string.
  25294. </summary>
  25295. <param name="dwFlags">Formatting options, and how to interpret the <paramref name="lpSource" /> parameter.</param>
  25296. <param name="lpSource">Location of the message definition.</param>
  25297. <param name="dwMessageId">Message identifier for the requested message.</param>
  25298. <param name="dwLanguageId">Language identifier for the requested message.</param>
  25299. <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>
  25300. <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>
  25301. <param name="Arguments">Pointer to an array of values that are used as insert values in the formatted message.</param>
  25302. <remarks>
  25303. <para>
  25304. The function requires a message definition as input. The message definition can come from a
  25305. buffer passed into the function. It can come from a message table resource in an
  25306. already-loaded module. Or the caller can ask the function to search the system's message
  25307. table resource(s) for the message definition. The function finds the message definition
  25308. in a message table resource based on a message identifier and a language identifier.
  25309. The function copies the formatted message text to an output buffer, processing any embedded
  25310. insert sequences if requested.
  25311. </para>
  25312. <para>
  25313. To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message.
  25314. </para>
  25315. </remarks>
  25316. <returns>
  25317. <para>
  25318. If the function succeeds, the return value is the number of TCHARs stored in the output
  25319. buffer, excluding the terminating null character.
  25320. </para>
  25321. <para>
  25322. If the function fails, the return value is zero. To get extended error information,
  25323. call <see cref="M:Marshal.GetLastWin32Error()" />.
  25324. </para>
  25325. </returns>
  25326. </member>
  25327. <member name="T:log4net.Util.NullDictionaryEnumerator">
  25328. <summary>
  25329. An always empty <see cref="T:System.Collections.IDictionaryEnumerator"/>.
  25330. </summary>
  25331. <remarks>
  25332. <para>
  25333. A singleton implementation of the <see cref="T:System.Collections.IDictionaryEnumerator"/> over a collection
  25334. that is empty and not modifiable.
  25335. </para>
  25336. </remarks>
  25337. <author>Nicko Cadell</author>
  25338. <author>Gert Driesen</author>
  25339. </member>
  25340. <member name="M:log4net.Util.NullDictionaryEnumerator.#ctor">
  25341. <summary>
  25342. Initializes a new instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" /> class.
  25343. </summary>
  25344. <remarks>
  25345. <para>
  25346. Uses a private access modifier to enforce the singleton pattern.
  25347. </para>
  25348. </remarks>
  25349. </member>
  25350. <member name="P:log4net.Util.NullDictionaryEnumerator.Instance">
  25351. <summary>
  25352. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  25353. </summary>
  25354. <returns>The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.</returns>
  25355. <remarks>
  25356. <para>
  25357. Gets the singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  25358. </para>
  25359. </remarks>
  25360. </member>
  25361. <member name="P:log4net.Util.NullDictionaryEnumerator.Current">
  25362. <summary>
  25363. Gets the current object from the enumerator.
  25364. </summary>
  25365. <remarks>
  25366. Throws an <see cref="T:System.InvalidOperationException" /> because the
  25367. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  25368. </remarks>
  25369. <remarks>
  25370. <para>
  25371. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25372. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25373. will throw an <see cref="T:System.InvalidOperationException"/>.
  25374. </para>
  25375. </remarks>
  25376. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25377. cannot be positioned over a valid location.</exception>
  25378. </member>
  25379. <member name="M:log4net.Util.NullDictionaryEnumerator.MoveNext">
  25380. <summary>
  25381. Test if the enumerator can advance, if so advance.
  25382. </summary>
  25383. <returns><c>false</c> as the <see cref="T:log4net.Util.NullDictionaryEnumerator" /> cannot advance.</returns>
  25384. <remarks>
  25385. <para>
  25386. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25387. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullDictionaryEnumerator.MoveNext"/>
  25388. will always return <c>false</c>.
  25389. </para>
  25390. </remarks>
  25391. </member>
  25392. <member name="M:log4net.Util.NullDictionaryEnumerator.Reset">
  25393. <summary>
  25394. Resets the enumerator back to the start.
  25395. </summary>
  25396. <remarks>
  25397. <para>
  25398. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullDictionaryEnumerator.Reset"/> does nothing.
  25399. </para>
  25400. </remarks>
  25401. </member>
  25402. <member name="P:log4net.Util.NullDictionaryEnumerator.Key">
  25403. <summary>
  25404. Gets the current key from the enumerator.
  25405. </summary>
  25406. <remarks>
  25407. Throws an exception because the <see cref="T:log4net.Util.NullDictionaryEnumerator" />
  25408. never has a current value.
  25409. </remarks>
  25410. <remarks>
  25411. <para>
  25412. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25413. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Key"/>
  25414. will throw an <see cref="T:System.InvalidOperationException"/>.
  25415. </para>
  25416. </remarks>
  25417. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25418. cannot be positioned over a valid location.</exception>
  25419. </member>
  25420. <member name="P:log4net.Util.NullDictionaryEnumerator.Value">
  25421. <summary>
  25422. Gets the current value from the enumerator.
  25423. </summary>
  25424. <value>The current value from the enumerator.</value>
  25425. <remarks>
  25426. Throws an <see cref="T:System.InvalidOperationException" /> because the
  25427. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  25428. </remarks>
  25429. <remarks>
  25430. <para>
  25431. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25432. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Value"/>
  25433. will throw an <see cref="T:System.InvalidOperationException"/>.
  25434. </para>
  25435. </remarks>
  25436. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25437. cannot be positioned over a valid location.</exception>
  25438. </member>
  25439. <member name="P:log4net.Util.NullDictionaryEnumerator.Entry">
  25440. <summary>
  25441. Gets the current entry from the enumerator.
  25442. </summary>
  25443. <remarks>
  25444. Throws an <see cref="T:System.InvalidOperationException" /> because the
  25445. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current entry.
  25446. </remarks>
  25447. <remarks>
  25448. <para>
  25449. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25450. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullDictionaryEnumerator.Entry"/>
  25451. will throw an <see cref="T:System.InvalidOperationException"/>.
  25452. </para>
  25453. </remarks>
  25454. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullDictionaryEnumerator.Current"/>
  25455. cannot be positioned over a valid location.</exception>
  25456. </member>
  25457. <member name="F:log4net.Util.NullDictionaryEnumerator.s_instance">
  25458. <summary>
  25459. The singleton instance of the <see cref="T:log4net.Util.NullDictionaryEnumerator" />.
  25460. </summary>
  25461. </member>
  25462. <member name="T:log4net.Util.NullEnumerator">
  25463. <summary>
  25464. An always empty <see cref="T:System.Collections.IEnumerator"/>.
  25465. </summary>
  25466. <remarks>
  25467. <para>
  25468. A singleton implementation of the <see cref="T:System.Collections.IEnumerator"/> over a collection
  25469. that is empty and not modifiable.
  25470. </para>
  25471. </remarks>
  25472. <author>Nicko Cadell</author>
  25473. <author>Gert Driesen</author>
  25474. </member>
  25475. <member name="M:log4net.Util.NullEnumerator.#ctor">
  25476. <summary>
  25477. Initializes a new instance of the <see cref="T:log4net.Util.NullEnumerator" /> class.
  25478. </summary>
  25479. <remarks>
  25480. <para>
  25481. Uses a private access modifier to enforce the singleton pattern.
  25482. </para>
  25483. </remarks>
  25484. </member>
  25485. <member name="P:log4net.Util.NullEnumerator.Instance">
  25486. <summary>
  25487. Get the singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  25488. </summary>
  25489. <returns>The singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.</returns>
  25490. <remarks>
  25491. <para>
  25492. Gets the singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  25493. </para>
  25494. </remarks>
  25495. </member>
  25496. <member name="P:log4net.Util.NullEnumerator.Current">
  25497. <summary>
  25498. Gets the current object from the enumerator.
  25499. </summary>
  25500. <remarks>
  25501. Throws an <see cref="T:System.InvalidOperationException" /> because the
  25502. <see cref="T:log4net.Util.NullDictionaryEnumerator" /> never has a current value.
  25503. </remarks>
  25504. <remarks>
  25505. <para>
  25506. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  25507. value cannot be moved over a valid position, therefore <see cref="P:log4net.Util.NullEnumerator.Current"/>
  25508. will throw an <see cref="T:System.InvalidOperationException"/>.
  25509. </para>
  25510. </remarks>
  25511. <exception cref="T:System.InvalidOperationException">The collection is empty and <see cref="P:log4net.Util.NullEnumerator.Current"/>
  25512. cannot be positioned over a valid location.</exception>
  25513. </member>
  25514. <member name="M:log4net.Util.NullEnumerator.MoveNext">
  25515. <summary>
  25516. Test if the enumerator can advance, if so advance
  25517. </summary>
  25518. <returns><c>false</c> as the <see cref="T:log4net.Util.NullEnumerator" /> cannot advance.</returns>
  25519. <remarks>
  25520. <para>
  25521. As the enumerator is over an empty collection its <see cref="P:log4net.Util.NullEnumerator.Current"/>
  25522. value cannot be moved over a valid position, therefore <see cref="M:log4net.Util.NullEnumerator.MoveNext"/>
  25523. will always return <c>false</c>.
  25524. </para>
  25525. </remarks>
  25526. </member>
  25527. <member name="M:log4net.Util.NullEnumerator.Reset">
  25528. <summary>
  25529. Resets the enumerator back to the start.
  25530. </summary>
  25531. <remarks>
  25532. <para>
  25533. As the enumerator is over an empty collection <see cref="M:log4net.Util.NullEnumerator.Reset"/> does nothing.
  25534. </para>
  25535. </remarks>
  25536. </member>
  25537. <member name="F:log4net.Util.NullEnumerator.s_instance">
  25538. <summary>
  25539. The singleton instance of the <see cref="T:log4net.Util.NullEnumerator" />.
  25540. </summary>
  25541. </member>
  25542. <member name="T:log4net.Util.NullSecurityContext">
  25543. <summary>
  25544. A SecurityContext used when a SecurityContext is not required
  25545. </summary>
  25546. <remarks>
  25547. <para>
  25548. The <see cref="T:log4net.Util.NullSecurityContext"/> is a no-op implementation of the
  25549. <see cref="T:log4net.Core.SecurityContext"/> base class. It is used where a <see cref="T:log4net.Core.SecurityContext"/>
  25550. is required but one has not been provided.
  25551. </para>
  25552. </remarks>
  25553. <author>Nicko Cadell</author>
  25554. </member>
  25555. <member name="F:log4net.Util.NullSecurityContext.Instance">
  25556. <summary>
  25557. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  25558. </summary>
  25559. <remarks>
  25560. <para>
  25561. Singleton instance of <see cref="T:log4net.Util.NullSecurityContext"/>
  25562. </para>
  25563. </remarks>
  25564. </member>
  25565. <member name="M:log4net.Util.NullSecurityContext.#ctor">
  25566. <summary>
  25567. Private constructor
  25568. </summary>
  25569. <remarks>
  25570. <para>
  25571. Private constructor for singleton pattern.
  25572. </para>
  25573. </remarks>
  25574. </member>
  25575. <member name="M:log4net.Util.NullSecurityContext.Impersonate(System.Object)">
  25576. <summary>
  25577. Impersonate this SecurityContext
  25578. </summary>
  25579. <param name="state">State supplied by the caller</param>
  25580. <returns><c>null</c></returns>
  25581. <remarks>
  25582. <para>
  25583. No impersonation is done and <c>null</c> is always returned.
  25584. </para>
  25585. </remarks>
  25586. </member>
  25587. <member name="T:log4net.Util.OnlyOnceErrorHandler">
  25588. <summary>
  25589. Implements log4net's default error handling policy which consists
  25590. of emitting a message for the first error in an appender and
  25591. ignoring all subsequent errors.
  25592. </summary>
  25593. <remarks>
  25594. <para>
  25595. The error message is processed using the LogLog sub-system by default.
  25596. </para>
  25597. <para>
  25598. This policy aims at protecting an otherwise working application
  25599. from being flooded with error messages when logging fails.
  25600. </para>
  25601. </remarks>
  25602. <author>Nicko Cadell</author>
  25603. <author>Gert Driesen</author>
  25604. <author>Ron Grabowski</author>
  25605. </member>
  25606. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor">
  25607. <summary>
  25608. Default Constructor
  25609. </summary>
  25610. <remarks>
  25611. <para>
  25612. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler" /> class.
  25613. </para>
  25614. </remarks>
  25615. </member>
  25616. <member name="M:log4net.Util.OnlyOnceErrorHandler.#ctor(System.String)">
  25617. <summary>
  25618. Constructor
  25619. </summary>
  25620. <param name="prefix">The prefix to use for each message.</param>
  25621. <remarks>
  25622. <para>
  25623. Initializes a new instance of the <see cref="T:log4net.Util.OnlyOnceErrorHandler" /> class
  25624. with the specified prefix.
  25625. </para>
  25626. </remarks>
  25627. </member>
  25628. <member name="M:log4net.Util.OnlyOnceErrorHandler.Reset">
  25629. <summary>
  25630. Reset the error handler back to its initial disabled state.
  25631. </summary>
  25632. </member>
  25633. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception,log4net.Core.ErrorCode)">
  25634. <summary>
  25635. Log an Error
  25636. </summary>
  25637. <param name="message">The error message.</param>
  25638. <param name="e">The exception.</param>
  25639. <param name="errorCode">The internal error code.</param>
  25640. <remarks>
  25641. <para>
  25642. 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.
  25643. </para>
  25644. </remarks>
  25645. </member>
  25646. <member name="M:log4net.Util.OnlyOnceErrorHandler.FirstError(System.String,System.Exception,log4net.Core.ErrorCode)">
  25647. <summary>
  25648. Log the very first error
  25649. </summary>
  25650. <param name="message">The error message.</param>
  25651. <param name="e">The exception.</param>
  25652. <param name="errorCode">The internal error code.</param>
  25653. <remarks>
  25654. <para>
  25655. Sends the error information to <see cref="T:log4net.Util.LogLog"/>'s Error method.
  25656. </para>
  25657. </remarks>
  25658. </member>
  25659. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String,System.Exception)">
  25660. <summary>
  25661. Log an Error
  25662. </summary>
  25663. <param name="message">The error message.</param>
  25664. <param name="e">The exception.</param>
  25665. <remarks>
  25666. <para>
  25667. 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.
  25668. </para>
  25669. </remarks>
  25670. </member>
  25671. <member name="M:log4net.Util.OnlyOnceErrorHandler.Error(System.String)">
  25672. <summary>
  25673. Log an error
  25674. </summary>
  25675. <param name="message">The error message.</param>
  25676. <remarks>
  25677. <para>
  25678. 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.
  25679. </para>
  25680. </remarks>
  25681. </member>
  25682. <member name="P:log4net.Util.OnlyOnceErrorHandler.IsEnabled">
  25683. <summary>
  25684. Is error logging enabled
  25685. </summary>
  25686. <remarks>
  25687. <para>
  25688. Is error logging enabled. Logging is only enabled for the
  25689. first error delivered to the <see cref="T:log4net.Util.OnlyOnceErrorHandler"/>.
  25690. </para>
  25691. </remarks>
  25692. </member>
  25693. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDate">
  25694. <summary>
  25695. The date the first error that trigged this error handler occurred, or <see cref="F:System.DateTime.MinValue"/> if it has not been triggered.
  25696. </summary>
  25697. </member>
  25698. <member name="P:log4net.Util.OnlyOnceErrorHandler.EnabledDateUtc">
  25699. <summary>
  25700. 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.
  25701. </summary>
  25702. </member>
  25703. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorMessage">
  25704. <summary>
  25705. The message from the first error that trigged this error handler.
  25706. </summary>
  25707. </member>
  25708. <member name="P:log4net.Util.OnlyOnceErrorHandler.Exception">
  25709. <summary>
  25710. The exception from the first error that trigged this error handler.
  25711. </summary>
  25712. <remarks>
  25713. May be <see langword="null" />.
  25714. </remarks>
  25715. </member>
  25716. <member name="P:log4net.Util.OnlyOnceErrorHandler.ErrorCode">
  25717. <summary>
  25718. The error code from the first error that trigged this error handler.
  25719. </summary>
  25720. <remarks>
  25721. Defaults to <see cref="F:log4net.Core.ErrorCode.GenericFailure"/>
  25722. </remarks>
  25723. </member>
  25724. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_enabledDateUtc">
  25725. <summary>
  25726. The UTC date the error was recorded.
  25727. </summary>
  25728. </member>
  25729. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_firstTime">
  25730. <summary>
  25731. Flag to indicate if it is the first error
  25732. </summary>
  25733. </member>
  25734. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_message">
  25735. <summary>
  25736. The message recorded during the first error.
  25737. </summary>
  25738. </member>
  25739. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_exception">
  25740. <summary>
  25741. The exception recorded during the first error.
  25742. </summary>
  25743. </member>
  25744. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_errorCode">
  25745. <summary>
  25746. The error code recorded during the first error.
  25747. </summary>
  25748. </member>
  25749. <member name="F:log4net.Util.OnlyOnceErrorHandler.m_prefix">
  25750. <summary>
  25751. String to prefix each message with
  25752. </summary>
  25753. </member>
  25754. <member name="F:log4net.Util.OnlyOnceErrorHandler.declaringType">
  25755. <summary>
  25756. The fully qualified type of the OnlyOnceErrorHandler class.
  25757. </summary>
  25758. <remarks>
  25759. Used by the internal logger to record the Type of the
  25760. log message.
  25761. </remarks>
  25762. </member>
  25763. <member name="T:log4net.Util.OptionConverter">
  25764. <summary>
  25765. A convenience class to convert property values to specific types.
  25766. </summary>
  25767. <remarks>
  25768. <para>
  25769. Utility functions for converting types and parsing values.
  25770. </para>
  25771. </remarks>
  25772. <author>Nicko Cadell</author>
  25773. <author>Gert Driesen</author>
  25774. </member>
  25775. <member name="M:log4net.Util.OptionConverter.#ctor">
  25776. <summary>
  25777. Initializes a new instance of the <see cref="T:log4net.Util.OptionConverter" /> class.
  25778. </summary>
  25779. <remarks>
  25780. <para>
  25781. Uses a private access modifier to prevent instantiation of this class.
  25782. </para>
  25783. </remarks>
  25784. </member>
  25785. <member name="M:log4net.Util.OptionConverter.ToBoolean(System.String,System.Boolean)">
  25786. <summary>
  25787. Converts a string to a <see cref="T:System.Boolean" /> value.
  25788. </summary>
  25789. <param name="argValue">String to convert.</param>
  25790. <param name="defaultValue">The default value.</param>
  25791. <returns>The <see cref="T:System.Boolean" /> value of <paramref name="argValue" />.</returns>
  25792. <remarks>
  25793. <para>
  25794. If <paramref name="argValue"/> is "true", then <c>true</c> is returned.
  25795. If <paramref name="argValue"/> is "false", then <c>false</c> is returned.
  25796. Otherwise, <paramref name="defaultValue"/> is returned.
  25797. </para>
  25798. </remarks>
  25799. </member>
  25800. <member name="M:log4net.Util.OptionConverter.ToFileSize(System.String,System.Int64)">
  25801. <summary>
  25802. Parses a file size into a number.
  25803. </summary>
  25804. <param name="argValue">String to parse.</param>
  25805. <param name="defaultValue">The default value.</param>
  25806. <returns>The <see cref="T:System.Int64" /> value of <paramref name="argValue" />.</returns>
  25807. <remarks>
  25808. <para>
  25809. Parses a file size of the form: number[KB|MB|GB] into a
  25810. long value. It is scaled with the appropriate multiplier.
  25811. </para>
  25812. <para>
  25813. <paramref name="defaultValue"/> is returned when <paramref name="argValue"/>
  25814. cannot be converted to a <see cref="T:System.Int64" /> value.
  25815. </para>
  25816. </remarks>
  25817. </member>
  25818. <member name="M:log4net.Util.OptionConverter.ConvertStringTo(System.Type,System.String)">
  25819. <summary>
  25820. Converts a string to an object.
  25821. </summary>
  25822. <param name="target">The target type to convert to.</param>
  25823. <param name="txt">The string to convert to an object.</param>
  25824. <returns>
  25825. The object converted from a string or <c>null</c> when the
  25826. conversion failed.
  25827. </returns>
  25828. <remarks>
  25829. <para>
  25830. Converts a string to an object. Uses the converter registry to try
  25831. to convert the string value into the specified target type.
  25832. </para>
  25833. </remarks>
  25834. </member>
  25835. <member name="M:log4net.Util.OptionConverter.CanConvertTypeTo(System.Type,System.Type)">
  25836. <summary>
  25837. Checks if there is an appropriate type conversion from the source type to the target type.
  25838. </summary>
  25839. <param name="sourceType">The type to convert from.</param>
  25840. <param name="targetType">The type to convert to.</param>
  25841. <returns><c>true</c> if there is a conversion from the source type to the target type.</returns>
  25842. <remarks>
  25843. Checks if there is an appropriate type conversion from the source type to the target type.
  25844. <para>
  25845. </para>
  25846. </remarks>
  25847. </member>
  25848. <member name="M:log4net.Util.OptionConverter.ConvertTypeTo(System.Object,System.Type)">
  25849. <summary>
  25850. Converts an object to the target type.
  25851. </summary>
  25852. <param name="sourceInstance">The object to convert to the target type.</param>
  25853. <param name="targetType">The type to convert to.</param>
  25854. <returns>The converted object.</returns>
  25855. <remarks>
  25856. <para>
  25857. Converts an object to the target type.
  25858. </para>
  25859. </remarks>
  25860. </member>
  25861. <member name="M:log4net.Util.OptionConverter.InstantiateByClassName(System.String,System.Type,System.Object)">
  25862. <summary>
  25863. Instantiates an object given a class name.
  25864. </summary>
  25865. <param name="className">The fully qualified class name of the object to instantiate.</param>
  25866. <param name="superClass">The class to which the new object should belong.</param>
  25867. <param name="defaultValue">The object to return in case of non-fulfillment.</param>
  25868. <returns>
  25869. An instance of the <paramref name="className"/> or <paramref name="defaultValue"/>
  25870. if the object could not be instantiated.
  25871. </returns>
  25872. <remarks>
  25873. <para>
  25874. Checks that the <paramref name="className"/> is a subclass of
  25875. <paramref name="superClass"/>. If that test fails or the object could
  25876. not be instantiated, then <paramref name="defaultValue"/> is returned.
  25877. </para>
  25878. </remarks>
  25879. </member>
  25880. <member name="M:log4net.Util.OptionConverter.SubstituteVariables(System.String,System.Collections.IDictionary)">
  25881. <summary>
  25882. Performs variable substitution in string <paramref name="value"/> from the
  25883. values of keys found in <paramref name="props"/>.
  25884. </summary>
  25885. <param name="value">The string on which variable substitution is performed.</param>
  25886. <param name="props">The dictionary to use to lookup variables.</param>
  25887. <returns>The result of the substitutions.</returns>
  25888. <remarks>
  25889. <para>
  25890. The variable substitution delimiters are <b>${</b> and <b>}</b>.
  25891. </para>
  25892. <para>
  25893. For example, if props contains <c>key=value</c>, then the call
  25894. </para>
  25895. <para>
  25896. <code lang="C#">
  25897. string s = OptionConverter.SubstituteVariables("Value of key is ${key}.");
  25898. </code>
  25899. </para>
  25900. <para>
  25901. will set the variable <c>s</c> to "Value of key is value.".
  25902. </para>
  25903. <para>
  25904. If no value could be found for the specified key, then substitution
  25905. defaults to an empty string.
  25906. </para>
  25907. <para>
  25908. For example, if system properties contains no value for the key
  25909. "nonExistentKey", then the call
  25910. </para>
  25911. <para>
  25912. <code lang="C#">
  25913. string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]");
  25914. </code>
  25915. </para>
  25916. <para>
  25917. will set <s>s</s> to "Value of nonExistentKey is []".
  25918. </para>
  25919. <para>
  25920. An Exception is thrown if <paramref name="value"/> contains a start
  25921. delimiter "${" which is not balanced by a stop delimiter "}".
  25922. </para>
  25923. </remarks>
  25924. </member>
  25925. <member name="M:log4net.Util.OptionConverter.ParseEnum(System.Type,System.String,System.Boolean)">
  25926. <summary>
  25927. Converts the string representation of the name or numeric value of one or
  25928. more enumerated constants to an equivalent enumerated object.
  25929. </summary>
  25930. <param name="enumType">The type to convert to.</param>
  25931. <param name="value">The enum string value.</param>
  25932. <param name="ignoreCase">If <c>true</c>, ignore case; otherwise, regard case.</param>
  25933. <returns>An object of type <paramref name="enumType" /> whose value is represented by <paramref name="value" />.</returns>
  25934. </member>
  25935. <member name="F:log4net.Util.OptionConverter.declaringType">
  25936. <summary>
  25937. The fully qualified type of the OptionConverter class.
  25938. </summary>
  25939. <remarks>
  25940. Used by the internal logger to record the Type of the
  25941. log message.
  25942. </remarks>
  25943. </member>
  25944. <member name="T:log4net.Util.PatternConverter">
  25945. <summary>
  25946. Abstract class that provides the formatting functionality that
  25947. derived classes need.
  25948. </summary>
  25949. <remarks>
  25950. <para>
  25951. Conversion specifiers in a conversion patterns are parsed to
  25952. individual PatternConverters. Each of which is responsible for
  25953. converting a logging event in a converter specific manner.
  25954. </para>
  25955. </remarks>
  25956. <author>Nicko Cadell</author>
  25957. <author>Gert Driesen</author>
  25958. </member>
  25959. <member name="M:log4net.Util.PatternConverter.#ctor">
  25960. <summary>
  25961. Protected constructor
  25962. </summary>
  25963. <remarks>
  25964. <para>
  25965. Initializes a new instance of the <see cref="T:log4net.Util.PatternConverter" /> class.
  25966. </para>
  25967. </remarks>
  25968. </member>
  25969. <member name="P:log4net.Util.PatternConverter.Next">
  25970. <summary>
  25971. Get the next pattern converter in the chain
  25972. </summary>
  25973. <value>
  25974. the next pattern converter in the chain
  25975. </value>
  25976. <remarks>
  25977. <para>
  25978. Get the next pattern converter in the chain
  25979. </para>
  25980. </remarks>
  25981. </member>
  25982. <member name="P:log4net.Util.PatternConverter.FormattingInfo">
  25983. <summary>
  25984. Gets or sets the formatting info for this converter
  25985. </summary>
  25986. <value>
  25987. The formatting info for this converter
  25988. </value>
  25989. <remarks>
  25990. <para>
  25991. Gets or sets the formatting info for this converter
  25992. </para>
  25993. </remarks>
  25994. </member>
  25995. <member name="P:log4net.Util.PatternConverter.Option">
  25996. <summary>
  25997. Gets or sets the option value for this converter
  25998. </summary>
  25999. <summary>
  26000. The option for this converter
  26001. </summary>
  26002. <remarks>
  26003. <para>
  26004. Gets or sets the option value for this converter
  26005. </para>
  26006. </remarks>
  26007. </member>
  26008. <member name="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26009. <summary>
  26010. Evaluate this pattern converter and write the output to a writer.
  26011. </summary>
  26012. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  26013. <param name="state">The state object on which the pattern converter should be executed.</param>
  26014. <remarks>
  26015. <para>
  26016. Derived pattern converters must override this method in order to
  26017. convert conversion specifiers in the appropriate way.
  26018. </para>
  26019. </remarks>
  26020. </member>
  26021. <member name="M:log4net.Util.PatternConverter.SetNext(log4net.Util.PatternConverter)">
  26022. <summary>
  26023. Set the next pattern converter in the chains
  26024. </summary>
  26025. <param name="patternConverter">the pattern converter that should follow this converter in the chain</param>
  26026. <returns>the next converter</returns>
  26027. <remarks>
  26028. <para>
  26029. The PatternConverter can merge with its neighbor during this method (or a sub class).
  26030. Therefore the return value may or may not be the value of the argument passed in.
  26031. </para>
  26032. </remarks>
  26033. </member>
  26034. <member name="M:log4net.Util.PatternConverter.Format(System.IO.TextWriter,System.Object)">
  26035. <summary>
  26036. Write the pattern converter to the writer with appropriate formatting
  26037. </summary>
  26038. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  26039. <param name="state">The state object on which the pattern converter should be executed.</param>
  26040. <remarks>
  26041. <para>
  26042. This method calls <see cref="M:log4net.Util.PatternConverter.Convert(System.IO.TextWriter,System.Object)"/> to allow the subclass to perform
  26043. appropriate conversion of the pattern converter. If formatting options have
  26044. been specified via the <see cref="P:log4net.Util.PatternConverter.FormattingInfo"/> then this method will
  26045. apply those formattings before writing the output.
  26046. </para>
  26047. </remarks>
  26048. </member>
  26049. <member name="M:log4net.Util.PatternConverter.SpacePad(System.IO.TextWriter,System.Int32)">
  26050. <summary>
  26051. Fast space padding method.
  26052. </summary>
  26053. <param name="writer"><see cref="T:System.IO.TextWriter" /> to which the spaces will be appended.</param>
  26054. <param name="length">The number of spaces to be padded.</param>
  26055. <remarks>
  26056. <para>
  26057. Fast space padding method.
  26058. </para>
  26059. </remarks>
  26060. </member>
  26061. <member name="F:log4net.Util.PatternConverter.m_option">
  26062. <summary>
  26063. The option string to the converter
  26064. </summary>
  26065. </member>
  26066. <member name="F:log4net.Util.PatternConverter.c_renderBufferSize">
  26067. <summary>
  26068. Initial buffer size
  26069. </summary>
  26070. </member>
  26071. <member name="F:log4net.Util.PatternConverter.c_renderBufferMaxCapacity">
  26072. <summary>
  26073. Maximum buffer size before it is recycled
  26074. </summary>
  26075. </member>
  26076. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionary)">
  26077. <summary>
  26078. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  26079. </summary>
  26080. <param name="writer">the writer to write to</param>
  26081. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  26082. <param name="value">the value to write to the writer</param>
  26083. <remarks>
  26084. <para>
  26085. Writes the <see cref="T:System.Collections.IDictionary"/> to a writer in the form:
  26086. </para>
  26087. <code>
  26088. {key1=value1, key2=value2, key3=value3}
  26089. </code>
  26090. <para>
  26091. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  26092. is not null then it is used to render the key and value to text, otherwise
  26093. the object's ToString method is called.
  26094. </para>
  26095. </remarks>
  26096. </member>
  26097. <member name="M:log4net.Util.PatternConverter.WriteDictionary(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Collections.IDictionaryEnumerator)">
  26098. <summary>
  26099. Write an dictionary to a <see cref="T:System.IO.TextWriter"/>
  26100. </summary>
  26101. <param name="writer">the writer to write to</param>
  26102. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  26103. <param name="value">the value to write to the writer</param>
  26104. <remarks>
  26105. <para>
  26106. Writes the <see cref="T:System.Collections.IDictionaryEnumerator"/> to a writer in the form:
  26107. </para>
  26108. <code>
  26109. {key1=value1, key2=value2, key3=value3}
  26110. </code>
  26111. <para>
  26112. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  26113. is not null then it is used to render the key and value to text, otherwise
  26114. the object's ToString method is called.
  26115. </para>
  26116. </remarks>
  26117. </member>
  26118. <member name="M:log4net.Util.PatternConverter.WriteObject(System.IO.TextWriter,log4net.Repository.ILoggerRepository,System.Object)">
  26119. <summary>
  26120. Write an object to a <see cref="T:System.IO.TextWriter"/>
  26121. </summary>
  26122. <param name="writer">the writer to write to</param>
  26123. <param name="repository">a <see cref="T:log4net.Repository.ILoggerRepository"/> to use for object conversion</param>
  26124. <param name="value">the value to write to the writer</param>
  26125. <remarks>
  26126. <para>
  26127. Writes the Object to a writer. If the <see cref="T:log4net.Repository.ILoggerRepository"/> specified
  26128. is not null then it is used to render the object to text, otherwise
  26129. the object's ToString method is called.
  26130. </para>
  26131. </remarks>
  26132. </member>
  26133. <member name="P:log4net.Util.PatternConverter.Properties">
  26134. <summary>
  26135. </summary>
  26136. </member>
  26137. <member name="T:log4net.Util.PatternParser">
  26138. <summary>
  26139. Most of the work of the <see cref="T:log4net.Layout.PatternLayout"/> class
  26140. is delegated to the PatternParser class.
  26141. </summary>
  26142. <remarks>
  26143. <para>
  26144. The <c>PatternParser</c> processes a pattern string and
  26145. returns a chain of <see cref="T:log4net.Util.PatternConverter"/> objects.
  26146. </para>
  26147. </remarks>
  26148. <author>Nicko Cadell</author>
  26149. <author>Gert Driesen</author>
  26150. </member>
  26151. <member name="M:log4net.Util.PatternParser.#ctor(System.String)">
  26152. <summary>
  26153. Constructor
  26154. </summary>
  26155. <param name="pattern">The pattern to parse.</param>
  26156. <remarks>
  26157. <para>
  26158. Initializes a new instance of the <see cref="T:log4net.Util.PatternParser" /> class
  26159. with the specified pattern string.
  26160. </para>
  26161. </remarks>
  26162. </member>
  26163. <member name="M:log4net.Util.PatternParser.Parse">
  26164. <summary>
  26165. Parses the pattern into a chain of pattern converters.
  26166. </summary>
  26167. <returns>The head of a chain of pattern converters.</returns>
  26168. <remarks>
  26169. <para>
  26170. Parses the pattern into a chain of pattern converters.
  26171. </para>
  26172. </remarks>
  26173. </member>
  26174. <member name="P:log4net.Util.PatternParser.PatternConverters">
  26175. <summary>
  26176. Get the converter registry used by this parser
  26177. </summary>
  26178. <value>
  26179. The converter registry used by this parser
  26180. </value>
  26181. <remarks>
  26182. <para>
  26183. Get the converter registry used by this parser
  26184. </para>
  26185. </remarks>
  26186. </member>
  26187. <member name="M:log4net.Util.PatternParser.BuildCache">
  26188. <summary>
  26189. Build the unified cache of converters from the static and instance maps
  26190. </summary>
  26191. <returns>the list of all the converter names</returns>
  26192. <remarks>
  26193. <para>
  26194. Build the unified cache of converters from the static and instance maps
  26195. </para>
  26196. </remarks>
  26197. </member>
  26198. <member name="T:log4net.Util.PatternParser.StringLengthComparer">
  26199. <summary>
  26200. Sort strings by length
  26201. </summary>
  26202. <remarks>
  26203. <para>
  26204. <see cref="T:System.Collections.IComparer" /> that orders strings by string length.
  26205. The longest strings are placed first
  26206. </para>
  26207. </remarks>
  26208. </member>
  26209. <member name="M:log4net.Util.PatternParser.ParseInternal(System.String,System.String[])">
  26210. <summary>
  26211. Internal method to parse the specified pattern to find specified matches
  26212. </summary>
  26213. <param name="pattern">the pattern to parse</param>
  26214. <param name="matches">the converter names to match in the pattern</param>
  26215. <remarks>
  26216. <para>
  26217. The matches param must be sorted such that longer strings come before shorter ones.
  26218. </para>
  26219. </remarks>
  26220. </member>
  26221. <member name="M:log4net.Util.PatternParser.ProcessLiteral(System.String)">
  26222. <summary>
  26223. Process a parsed literal
  26224. </summary>
  26225. <param name="text">the literal text</param>
  26226. </member>
  26227. <member name="M:log4net.Util.PatternParser.ProcessConverter(System.String,System.String,log4net.Util.FormattingInfo)">
  26228. <summary>
  26229. Process a parsed converter pattern
  26230. </summary>
  26231. <param name="converterName">the name of the converter</param>
  26232. <param name="option">the optional option for the converter</param>
  26233. <param name="formattingInfo">the formatting info for the converter</param>
  26234. </member>
  26235. <member name="M:log4net.Util.PatternParser.AddConverter(log4net.Util.PatternConverter)">
  26236. <summary>
  26237. Resets the internal state of the parser and adds the specified pattern converter
  26238. to the chain.
  26239. </summary>
  26240. <param name="pc">The pattern converter to add.</param>
  26241. </member>
  26242. <member name="F:log4net.Util.PatternParser.m_head">
  26243. <summary>
  26244. The first pattern converter in the chain
  26245. </summary>
  26246. </member>
  26247. <member name="F:log4net.Util.PatternParser.m_tail">
  26248. <summary>
  26249. the last pattern converter in the chain
  26250. </summary>
  26251. </member>
  26252. <member name="F:log4net.Util.PatternParser.m_pattern">
  26253. <summary>
  26254. The pattern
  26255. </summary>
  26256. </member>
  26257. <member name="F:log4net.Util.PatternParser.m_patternConverters">
  26258. <summary>
  26259. Internal map of converter identifiers to converter types
  26260. </summary>
  26261. <remarks>
  26262. <para>
  26263. This map overrides the static s_globalRulesRegistry map.
  26264. </para>
  26265. </remarks>
  26266. </member>
  26267. <member name="F:log4net.Util.PatternParser.declaringType">
  26268. <summary>
  26269. The fully qualified type of the PatternParser class.
  26270. </summary>
  26271. <remarks>
  26272. Used by the internal logger to record the Type of the
  26273. log message.
  26274. </remarks>
  26275. </member>
  26276. <member name="T:log4net.Util.PatternString">
  26277. <summary>
  26278. This class implements a patterned string.
  26279. </summary>
  26280. <remarks>
  26281. <para>
  26282. This string has embedded patterns that are resolved and expanded
  26283. when the string is formatted.
  26284. </para>
  26285. <para>
  26286. This class functions similarly to the <see cref="T:log4net.Layout.PatternLayout"/>
  26287. in that it accepts a pattern and renders it to a string. Unlike the
  26288. <see cref="T:log4net.Layout.PatternLayout"/> however the <c>PatternString</c>
  26289. does not render the properties of a specific <see cref="T:log4net.Core.LoggingEvent"/> but
  26290. of the process in general.
  26291. </para>
  26292. <para>
  26293. The recognized conversion pattern names are:
  26294. </para>
  26295. <list type="table">
  26296. <listheader>
  26297. <term>Conversion Pattern Name</term>
  26298. <description>Effect</description>
  26299. </listheader>
  26300. <item>
  26301. <term>appdomain</term>
  26302. <description>
  26303. <para>
  26304. Used to output the friendly name of the current AppDomain.
  26305. </para>
  26306. </description>
  26307. </item>
  26308. <item>
  26309. <term>appsetting</term>
  26310. <description>
  26311. <para>
  26312. Used to output the value of a specific appSetting key in the application
  26313. configuration file.
  26314. </para>
  26315. </description>
  26316. </item>
  26317. <item>
  26318. <term>date</term>
  26319. <description>
  26320. <para>
  26321. Used to output the current date and time in the local time zone.
  26322. To output the date in universal time use the <c>%utcdate</c> pattern.
  26323. The date conversion
  26324. specifier may be followed by a <i>date format specifier</i> enclosed
  26325. between braces. For example, <b>%date{HH:mm:ss,fff}</b> or
  26326. <b>%date{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  26327. given then ISO8601 format is
  26328. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  26329. </para>
  26330. <para>
  26331. The date format specifier admits the same syntax as the
  26332. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  26333. </para>
  26334. <para>
  26335. For better results it is recommended to use the log4net date
  26336. formatters. These can be specified using one of the strings
  26337. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  26338. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  26339. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  26340. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  26341. <b>%date{ISO8601}</b> or <b>%date{ABSOLUTE}</b>.
  26342. </para>
  26343. <para>
  26344. These dedicated date formatters perform significantly
  26345. better than <see cref="M:DateTime.ToString(string)"/>.
  26346. </para>
  26347. </description>
  26348. </item>
  26349. <item>
  26350. <term>env</term>
  26351. <description>
  26352. <para>
  26353. Used to output the a specific environment variable. The key to
  26354. lookup must be specified within braces and directly following the
  26355. pattern specifier, e.g. <b>%env{COMPUTERNAME}</b> would include the value
  26356. of the <c>COMPUTERNAME</c> environment variable.
  26357. </para>
  26358. <para>
  26359. The <c>env</c> pattern is not supported on the .NET Compact Framework.
  26360. </para>
  26361. </description>
  26362. </item>
  26363. <item>
  26364. <term>identity</term>
  26365. <description>
  26366. <para>
  26367. Used to output the user name for the currently active user
  26368. (Principal.Identity.Name).
  26369. </para>
  26370. </description>
  26371. </item>
  26372. <item>
  26373. <term>newline</term>
  26374. <description>
  26375. <para>
  26376. Outputs the platform dependent line separator character or
  26377. characters.
  26378. </para>
  26379. <para>
  26380. This conversion pattern name offers the same performance as using
  26381. non-portable line separator strings such as "\n", or "\r\n".
  26382. Thus, it is the preferred way of specifying a line separator.
  26383. </para>
  26384. </description>
  26385. </item>
  26386. <item>
  26387. <term>processid</term>
  26388. <description>
  26389. <para>
  26390. Used to output the system process ID for the current process.
  26391. </para>
  26392. </description>
  26393. </item>
  26394. <item>
  26395. <term>property</term>
  26396. <description>
  26397. <para>
  26398. Used to output a specific context property. The key to
  26399. lookup must be specified within braces and directly following the
  26400. pattern specifier, e.g. <b>%property{user}</b> would include the value
  26401. from the property that is keyed by the string 'user'. Each property value
  26402. that is to be included in the log must be specified separately.
  26403. Properties are stored in logging contexts. By default
  26404. the <c>log4net:HostName</c> property is set to the name of machine on
  26405. which the event was originally logged.
  26406. </para>
  26407. <para>
  26408. If no key is specified, e.g. <b>%property</b> then all the keys and their
  26409. values are printed in a comma separated list.
  26410. </para>
  26411. <para>
  26412. The properties of an event are combined from a number of different
  26413. contexts. These are listed below in the order in which they are searched.
  26414. </para>
  26415. <list type="definition">
  26416. <item>
  26417. <term>the thread properties</term>
  26418. <description>
  26419. The <see cref="P:log4net.ThreadContext.Properties"/> that are set on the current
  26420. thread. These properties are shared by all events logged on this thread.
  26421. </description>
  26422. </item>
  26423. <item>
  26424. <term>the global properties</term>
  26425. <description>
  26426. The <see cref="P:log4net.GlobalContext.Properties"/> that are set globally. These
  26427. properties are shared by all the threads in the AppDomain.
  26428. </description>
  26429. </item>
  26430. </list>
  26431. </description>
  26432. </item>
  26433. <item>
  26434. <term>random</term>
  26435. <description>
  26436. <para>
  26437. Used to output a random string of characters. The string is made up of
  26438. uppercase letters and numbers. By default the string is 4 characters long.
  26439. The length of the string can be specified within braces directly following the
  26440. pattern specifier, e.g. <b>%random{8}</b> would output an 8 character string.
  26441. </para>
  26442. </description>
  26443. </item>
  26444. <item>
  26445. <term>username</term>
  26446. <description>
  26447. <para>
  26448. Used to output the WindowsIdentity for the currently
  26449. active user.
  26450. </para>
  26451. </description>
  26452. </item>
  26453. <item>
  26454. <term>utcdate</term>
  26455. <description>
  26456. <para>
  26457. Used to output the date of the logging event in universal time.
  26458. The date conversion
  26459. specifier may be followed by a <i>date format specifier</i> enclosed
  26460. between braces. For example, <b>%utcdate{HH:mm:ss,fff}</b> or
  26461. <b>%utcdate{dd MMM yyyy HH:mm:ss,fff}</b>. If no date format specifier is
  26462. given then ISO8601 format is
  26463. assumed (<see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>).
  26464. </para>
  26465. <para>
  26466. The date format specifier admits the same syntax as the
  26467. time pattern string of the <see cref="M:DateTime.ToString(string)"/>.
  26468. </para>
  26469. <para>
  26470. For better results it is recommended to use the log4net date
  26471. formatters. These can be specified using one of the strings
  26472. "ABSOLUTE", "DATE" and "ISO8601" for specifying
  26473. <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/>,
  26474. <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> and respectively
  26475. <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/>. For example,
  26476. <b>%utcdate{ISO8601}</b> or <b>%utcdate{ABSOLUTE}</b>.
  26477. </para>
  26478. <para>
  26479. These dedicated date formatters perform significantly
  26480. better than <see cref="M:DateTime.ToString(string)"/>.
  26481. </para>
  26482. </description>
  26483. </item>
  26484. <item>
  26485. <term>%</term>
  26486. <description>
  26487. <para>
  26488. The sequence %% outputs a single percent sign.
  26489. </para>
  26490. </description>
  26491. </item>
  26492. </list>
  26493. <para>
  26494. Additional pattern converters may be registered with a specific <see cref="T:log4net.Util.PatternString"/>
  26495. instance using <see cref="M:AddConverter(ConverterInfo)"/> or
  26496. <see cref="M:AddConverter(string, Type)" />.
  26497. </para>
  26498. <para>
  26499. See the <see cref="T:log4net.Layout.PatternLayout"/> for details on the
  26500. <i>format modifiers</i> supported by the patterns.
  26501. </para>
  26502. </remarks>
  26503. <author>Nicko Cadell</author>
  26504. </member>
  26505. <member name="F:log4net.Util.PatternString.s_globalRulesRegistry">
  26506. <summary>
  26507. Internal map of converter identifiers to converter types.
  26508. </summary>
  26509. </member>
  26510. <member name="F:log4net.Util.PatternString.m_pattern">
  26511. <summary>
  26512. the pattern
  26513. </summary>
  26514. </member>
  26515. <member name="F:log4net.Util.PatternString.m_head">
  26516. <summary>
  26517. the head of the pattern converter chain
  26518. </summary>
  26519. </member>
  26520. <member name="F:log4net.Util.PatternString.m_instanceRulesRegistry">
  26521. <summary>
  26522. patterns defined on this PatternString only
  26523. </summary>
  26524. </member>
  26525. <member name="M:log4net.Util.PatternString.#cctor">
  26526. <summary>
  26527. Initialize the global registry
  26528. </summary>
  26529. </member>
  26530. <member name="M:log4net.Util.PatternString.#ctor">
  26531. <summary>
  26532. Default constructor
  26533. </summary>
  26534. <remarks>
  26535. <para>
  26536. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/>
  26537. </para>
  26538. </remarks>
  26539. </member>
  26540. <member name="M:log4net.Util.PatternString.#ctor(System.String)">
  26541. <summary>
  26542. Constructs a PatternString
  26543. </summary>
  26544. <param name="pattern">The pattern to use with this PatternString</param>
  26545. <remarks>
  26546. <para>
  26547. Initialize a new instance of <see cref="T:log4net.Util.PatternString"/> with the pattern specified.
  26548. </para>
  26549. </remarks>
  26550. </member>
  26551. <member name="P:log4net.Util.PatternString.ConversionPattern">
  26552. <summary>
  26553. Gets or sets the pattern formatting string
  26554. </summary>
  26555. <value>
  26556. The pattern formatting string
  26557. </value>
  26558. <remarks>
  26559. <para>
  26560. The <b>ConversionPattern</b> option. This is the string which
  26561. controls formatting and consists of a mix of literal content and
  26562. conversion specifiers.
  26563. </para>
  26564. </remarks>
  26565. </member>
  26566. <member name="M:log4net.Util.PatternString.ActivateOptions">
  26567. <summary>
  26568. Initialize object options
  26569. </summary>
  26570. <remarks>
  26571. <para>
  26572. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  26573. activation scheme. The <see cref="M:log4net.Util.PatternString.ActivateOptions"/> method must
  26574. be called on this object after the configuration properties have
  26575. been set. Until <see cref="M:log4net.Util.PatternString.ActivateOptions"/> is called this
  26576. object is in an undefined state and must not be used.
  26577. </para>
  26578. <para>
  26579. If any of the configuration properties are modified then
  26580. <see cref="M:log4net.Util.PatternString.ActivateOptions"/> must be called again.
  26581. </para>
  26582. </remarks>
  26583. </member>
  26584. <member name="M:log4net.Util.PatternString.CreatePatternParser(System.String)">
  26585. <summary>
  26586. Create the <see cref="T:log4net.Util.PatternParser"/> used to parse the pattern
  26587. </summary>
  26588. <param name="pattern">the pattern to parse</param>
  26589. <returns>The <see cref="T:log4net.Util.PatternParser"/></returns>
  26590. <remarks>
  26591. <para>
  26592. Returns PatternParser used to parse the conversion string. Subclasses
  26593. may override this to return a subclass of PatternParser which recognize
  26594. custom conversion pattern name.
  26595. </para>
  26596. </remarks>
  26597. </member>
  26598. <member name="M:log4net.Util.PatternString.Format(System.IO.TextWriter)">
  26599. <summary>
  26600. Produces a formatted string as specified by the conversion pattern.
  26601. </summary>
  26602. <param name="writer">The TextWriter to write the formatted event to</param>
  26603. <remarks>
  26604. <para>
  26605. Format the pattern to the <paramref name="writer"/>.
  26606. </para>
  26607. </remarks>
  26608. </member>
  26609. <member name="M:log4net.Util.PatternString.Format">
  26610. <summary>
  26611. Format the pattern as a string
  26612. </summary>
  26613. <returns>the pattern formatted as a string</returns>
  26614. <remarks>
  26615. <para>
  26616. Format the pattern to a string.
  26617. </para>
  26618. </remarks>
  26619. </member>
  26620. <member name="M:log4net.Util.PatternString.AddConverter(log4net.Util.ConverterInfo)">
  26621. <summary>
  26622. Add a converter to this PatternString
  26623. </summary>
  26624. <param name="converterInfo">the converter info</param>
  26625. <remarks>
  26626. <para>
  26627. This version of the method is used by the configurator.
  26628. Programmatic users should use the alternative <see cref="M:AddConverter(string,Type)"/> method.
  26629. </para>
  26630. </remarks>
  26631. </member>
  26632. <member name="M:log4net.Util.PatternString.AddConverter(System.String,System.Type)">
  26633. <summary>
  26634. Add a converter to this PatternString
  26635. </summary>
  26636. <param name="name">the name of the conversion pattern for this converter</param>
  26637. <param name="type">the type of the converter</param>
  26638. <remarks>
  26639. <para>
  26640. Add a converter to this PatternString
  26641. </para>
  26642. </remarks>
  26643. </member>
  26644. <member name="T:log4net.Util.PatternStringConverters.AppDomainPatternConverter">
  26645. <summary>
  26646. Write the name of the current AppDomain to the output
  26647. </summary>
  26648. <remarks>
  26649. <para>
  26650. Write the name of the current AppDomain to the output writer
  26651. </para>
  26652. </remarks>
  26653. <author>Nicko Cadell</author>
  26654. </member>
  26655. <member name="M:log4net.Util.PatternStringConverters.AppDomainPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26656. <summary>
  26657. Write the name of the current AppDomain to the output
  26658. </summary>
  26659. <param name="writer">the writer to write to</param>
  26660. <param name="state">null, state is not set</param>
  26661. <remarks>
  26662. <para>
  26663. Writes name of the current AppDomain to the output <paramref name="writer"/>.
  26664. </para>
  26665. </remarks>
  26666. </member>
  26667. <member name="T:log4net.Util.PatternStringConverters.DatePatternConverter">
  26668. <summary>
  26669. Write the current date to the output
  26670. </summary>
  26671. <remarks>
  26672. <para>
  26673. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  26674. the current date and time to the writer as a string.
  26675. </para>
  26676. <para>
  26677. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  26678. the formatting of the date. The following values are allowed:
  26679. <list type="definition">
  26680. <listheader>
  26681. <term>Option value</term>
  26682. <description>Output</description>
  26683. </listheader>
  26684. <item>
  26685. <term>ISO8601</term>
  26686. <description>
  26687. Uses the <see cref="T:log4net.DateFormatter.Iso8601DateFormatter"/> formatter.
  26688. Formats using the <c>"yyyy-MM-dd HH:mm:ss,fff"</c> pattern.
  26689. </description>
  26690. </item>
  26691. <item>
  26692. <term>DATE</term>
  26693. <description>
  26694. Uses the <see cref="T:log4net.DateFormatter.DateTimeDateFormatter"/> formatter.
  26695. Formats using the <c>"dd MMM yyyy HH:mm:ss,fff"</c> for example, <c>"06 Nov 1994 15:49:37,459"</c>.
  26696. </description>
  26697. </item>
  26698. <item>
  26699. <term>ABSOLUTE</term>
  26700. <description>
  26701. Uses the <see cref="T:log4net.DateFormatter.AbsoluteTimeDateFormatter"/> formatter.
  26702. Formats using the <c>"HH:mm:ss,fff"</c> for example, <c>"15:49:37,459"</c>.
  26703. </description>
  26704. </item>
  26705. <item>
  26706. <term>other</term>
  26707. <description>
  26708. Any other pattern string uses the <see cref="T:log4net.DateFormatter.SimpleDateFormatter"/> formatter.
  26709. This formatter passes the pattern string to the <see cref="T:System.DateTime"/>
  26710. <see cref="M:DateTime.ToString(string)"/> method.
  26711. For details on valid patterns see
  26712. <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfsystemglobalizationdatetimeformatinfoclasstopic.asp">DateTimeFormatInfo Class</a>.
  26713. </description>
  26714. </item>
  26715. </list>
  26716. </para>
  26717. <para>
  26718. The date and time is in the local time zone and is rendered in that zone.
  26719. To output the time in Universal time see <see cref="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter"/>.
  26720. </para>
  26721. </remarks>
  26722. <author>Nicko Cadell</author>
  26723. </member>
  26724. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.m_dateFormatter">
  26725. <summary>
  26726. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  26727. </summary>
  26728. <remarks>
  26729. <para>
  26730. The <see cref="T:log4net.DateFormatter.IDateFormatter"/> used to render the date to a string
  26731. </para>
  26732. </remarks>
  26733. </member>
  26734. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions">
  26735. <summary>
  26736. Initialize the converter options
  26737. </summary>
  26738. <remarks>
  26739. <para>
  26740. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  26741. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> method must
  26742. be called on this object after the configuration properties have
  26743. been set. Until <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> is called this
  26744. object is in an undefined state and must not be used.
  26745. </para>
  26746. <para>
  26747. If any of the configuration properties are modified then
  26748. <see cref="M:log4net.Util.PatternStringConverters.DatePatternConverter.ActivateOptions"/> must be called again.
  26749. </para>
  26750. </remarks>
  26751. </member>
  26752. <member name="M:log4net.Util.PatternStringConverters.DatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26753. <summary>
  26754. Write the current date to the output
  26755. </summary>
  26756. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  26757. <param name="state">null, state is not set</param>
  26758. <remarks>
  26759. <para>
  26760. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  26761. for it to render it to the writer.
  26762. </para>
  26763. <para>
  26764. The date and time passed is in the local time zone.
  26765. </para>
  26766. </remarks>
  26767. </member>
  26768. <member name="F:log4net.Util.PatternStringConverters.DatePatternConverter.declaringType">
  26769. <summary>
  26770. The fully qualified type of the DatePatternConverter class.
  26771. </summary>
  26772. <remarks>
  26773. Used by the internal logger to record the Type of the
  26774. log message.
  26775. </remarks>
  26776. </member>
  26777. <member name="T:log4net.Util.PatternStringConverters.EnvironmentPatternConverter">
  26778. <summary>
  26779. Write an environment variable to the output
  26780. </summary>
  26781. <remarks>
  26782. <para>
  26783. Write an environment variable to the output writer.
  26784. The value of the <see cref="P:log4net.Util.PatternConverter.Option"/> determines
  26785. the name of the variable to output.
  26786. </para>
  26787. </remarks>
  26788. <author>Nicko Cadell</author>
  26789. </member>
  26790. <member name="M:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26791. <summary>
  26792. Write an environment variable to the output
  26793. </summary>
  26794. <param name="writer">the writer to write to</param>
  26795. <param name="state">null, state is not set</param>
  26796. <remarks>
  26797. <para>
  26798. Writes the environment variable to the output <paramref name="writer"/>.
  26799. The name of the environment variable to output must be set
  26800. using the <see cref="P:log4net.Util.PatternConverter.Option"/>
  26801. property.
  26802. </para>
  26803. </remarks>
  26804. </member>
  26805. <member name="F:log4net.Util.PatternStringConverters.EnvironmentPatternConverter.declaringType">
  26806. <summary>
  26807. The fully qualified type of the EnvironmentPatternConverter class.
  26808. </summary>
  26809. <remarks>
  26810. Used by the internal logger to record the Type of the
  26811. log message.
  26812. </remarks>
  26813. </member>
  26814. <member name="T:log4net.Util.PatternStringConverters.IdentityPatternConverter">
  26815. <summary>
  26816. Write the current thread identity to the output
  26817. </summary>
  26818. <remarks>
  26819. <para>
  26820. Write the current thread identity to the output writer
  26821. </para>
  26822. </remarks>
  26823. <author>Nicko Cadell</author>
  26824. </member>
  26825. <member name="M:log4net.Util.PatternStringConverters.IdentityPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26826. <summary>
  26827. Write the current thread identity to the output
  26828. </summary>
  26829. <param name="writer">the writer to write to</param>
  26830. <param name="state">null, state is not set</param>
  26831. <remarks>
  26832. <para>
  26833. Writes the current thread identity to the output <paramref name="writer"/>.
  26834. </para>
  26835. </remarks>
  26836. </member>
  26837. <member name="F:log4net.Util.PatternStringConverters.IdentityPatternConverter.declaringType">
  26838. <summary>
  26839. The fully qualified type of the IdentityPatternConverter class.
  26840. </summary>
  26841. <remarks>
  26842. Used by the internal logger to record the Type of the
  26843. log message.
  26844. </remarks>
  26845. </member>
  26846. <member name="T:log4net.Util.PatternStringConverters.LiteralPatternConverter">
  26847. <summary>
  26848. Pattern converter for literal string instances in the pattern
  26849. </summary>
  26850. <remarks>
  26851. <para>
  26852. Writes the literal string value specified in the
  26853. <see cref="P:log4net.Util.PatternConverter.Option"/> property to
  26854. the output.
  26855. </para>
  26856. </remarks>
  26857. <author>Nicko Cadell</author>
  26858. </member>
  26859. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.SetNext(log4net.Util.PatternConverter)">
  26860. <summary>
  26861. Set the next converter in the chain
  26862. </summary>
  26863. <param name="pc">The next pattern converter in the chain</param>
  26864. <returns>The next pattern converter</returns>
  26865. <remarks>
  26866. <para>
  26867. Special case the building of the pattern converter chain
  26868. for <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> instances. Two adjacent
  26869. literals in the pattern can be represented by a single combined
  26870. pattern converter. This implementation detects when a
  26871. <see cref="T:log4net.Util.PatternStringConverters.LiteralPatternConverter"/> is added to the chain
  26872. after this converter and combines its value with this converter's
  26873. literal value.
  26874. </para>
  26875. </remarks>
  26876. </member>
  26877. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Format(System.IO.TextWriter,System.Object)">
  26878. <summary>
  26879. Write the literal to the output
  26880. </summary>
  26881. <param name="writer">the writer to write to</param>
  26882. <param name="state">null, not set</param>
  26883. <remarks>
  26884. <para>
  26885. Override the formatting behavior to ignore the FormattingInfo
  26886. because we have a literal instead.
  26887. </para>
  26888. <para>
  26889. Writes the value of <see cref="P:log4net.Util.PatternConverter.Option"/>
  26890. to the output <paramref name="writer"/>.
  26891. </para>
  26892. </remarks>
  26893. </member>
  26894. <member name="M:log4net.Util.PatternStringConverters.LiteralPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26895. <summary>
  26896. Convert this pattern into the rendered message
  26897. </summary>
  26898. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  26899. <param name="state">null, not set</param>
  26900. <remarks>
  26901. <para>
  26902. This method is not used.
  26903. </para>
  26904. </remarks>
  26905. </member>
  26906. <member name="T:log4net.Util.PatternStringConverters.NewLinePatternConverter">
  26907. <summary>
  26908. Writes a newline to the output
  26909. </summary>
  26910. <remarks>
  26911. <para>
  26912. Writes the system dependent line terminator to the output.
  26913. This behavior can be overridden by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>:
  26914. </para>
  26915. <list type="definition">
  26916. <listheader>
  26917. <term>Option Value</term>
  26918. <description>Output</description>
  26919. </listheader>
  26920. <item>
  26921. <term>DOS</term>
  26922. <description>DOS or Windows line terminator <c>"\r\n"</c></description>
  26923. </item>
  26924. <item>
  26925. <term>UNIX</term>
  26926. <description>UNIX line terminator <c>"\n"</c></description>
  26927. </item>
  26928. </list>
  26929. </remarks>
  26930. <author>Nicko Cadell</author>
  26931. </member>
  26932. <member name="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions">
  26933. <summary>
  26934. Initialize the converter
  26935. </summary>
  26936. <remarks>
  26937. <para>
  26938. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  26939. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> method must
  26940. be called on this object after the configuration properties have
  26941. been set. Until <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> is called this
  26942. object is in an undefined state and must not be used.
  26943. </para>
  26944. <para>
  26945. If any of the configuration properties are modified then
  26946. <see cref="M:log4net.Util.PatternStringConverters.NewLinePatternConverter.ActivateOptions"/> must be called again.
  26947. </para>
  26948. </remarks>
  26949. </member>
  26950. <member name="T:log4net.Util.PatternStringConverters.ProcessIdPatternConverter">
  26951. <summary>
  26952. Write the current process ID to the output
  26953. </summary>
  26954. <remarks>
  26955. <para>
  26956. Write the current process ID to the output writer
  26957. </para>
  26958. </remarks>
  26959. <author>Nicko Cadell</author>
  26960. </member>
  26961. <member name="M:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  26962. <summary>
  26963. Write the current process ID to the output
  26964. </summary>
  26965. <param name="writer">the writer to write to</param>
  26966. <param name="state">null, state is not set</param>
  26967. <remarks>
  26968. <para>
  26969. Write the current process ID to the output <paramref name="writer"/>.
  26970. </para>
  26971. </remarks>
  26972. </member>
  26973. <member name="F:log4net.Util.PatternStringConverters.ProcessIdPatternConverter.declaringType">
  26974. <summary>
  26975. The fully qualified type of the ProcessIdPatternConverter class.
  26976. </summary>
  26977. <remarks>
  26978. Used by the internal logger to record the Type of the
  26979. log message.
  26980. </remarks>
  26981. </member>
  26982. <member name="T:log4net.Util.PatternStringConverters.PropertyPatternConverter">
  26983. <summary>
  26984. Property pattern converter
  26985. </summary>
  26986. <remarks>
  26987. <para>
  26988. This pattern converter reads the thread and global properties.
  26989. The thread properties take priority over global properties.
  26990. See <see cref="P:log4net.ThreadContext.Properties"/> for details of the
  26991. thread properties. See <see cref="P:log4net.GlobalContext.Properties"/> for
  26992. details of the global properties.
  26993. </para>
  26994. <para>
  26995. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is specified then that will be used to
  26996. lookup a single property. If no <see cref="P:log4net.Util.PatternConverter.Option"/> is specified
  26997. then all properties will be dumped as a list of key value pairs.
  26998. </para>
  26999. </remarks>
  27000. <author>Nicko Cadell</author>
  27001. </member>
  27002. <member name="M:log4net.Util.PatternStringConverters.PropertyPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  27003. <summary>
  27004. Write the property value to the output
  27005. </summary>
  27006. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  27007. <param name="state">null, state is not set</param>
  27008. <remarks>
  27009. <para>
  27010. Writes out the value of a named property. The property name
  27011. should be set in the <see cref="P:log4net.Util.PatternConverter.Option"/>
  27012. property.
  27013. </para>
  27014. <para>
  27015. If the <see cref="P:log4net.Util.PatternConverter.Option"/> is set to <c>null</c>
  27016. then all the properties are written as key value pairs.
  27017. </para>
  27018. </remarks>
  27019. </member>
  27020. <member name="T:log4net.Util.PatternStringConverters.RandomStringPatternConverter">
  27021. <summary>
  27022. A Pattern converter that generates a string of random characters
  27023. </summary>
  27024. <remarks>
  27025. <para>
  27026. The converter generates a string of random characters. By default
  27027. the string is length 4. This can be changed by setting the <see cref="P:log4net.Util.PatternConverter.Option"/>
  27028. to the string value of the length required.
  27029. </para>
  27030. <para>
  27031. The random characters in the string are limited to uppercase letters
  27032. and numbers only.
  27033. </para>
  27034. <para>
  27035. The random number generator used by this class is not cryptographically secure.
  27036. </para>
  27037. </remarks>
  27038. <author>Nicko Cadell</author>
  27039. </member>
  27040. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.s_random">
  27041. <summary>
  27042. Shared random number generator
  27043. </summary>
  27044. </member>
  27045. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.m_length">
  27046. <summary>
  27047. Length of random string to generate. Default length 4.
  27048. </summary>
  27049. </member>
  27050. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions">
  27051. <summary>
  27052. Initialize the converter options
  27053. </summary>
  27054. <remarks>
  27055. <para>
  27056. This is part of the <see cref="T:log4net.Core.IOptionHandler"/> delayed object
  27057. activation scheme. The <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> method must
  27058. be called on this object after the configuration properties have
  27059. been set. Until <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> is called this
  27060. object is in an undefined state and must not be used.
  27061. </para>
  27062. <para>
  27063. If any of the configuration properties are modified then
  27064. <see cref="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.ActivateOptions"/> must be called again.
  27065. </para>
  27066. </remarks>
  27067. </member>
  27068. <member name="M:log4net.Util.PatternStringConverters.RandomStringPatternConverter.Convert(System.IO.TextWriter,System.Object)">
  27069. <summary>
  27070. Write a randoim string to the output
  27071. </summary>
  27072. <param name="writer">the writer to write to</param>
  27073. <param name="state">null, state is not set</param>
  27074. <remarks>
  27075. <para>
  27076. Write a randoim string to the output <paramref name="writer"/>.
  27077. </para>
  27078. </remarks>
  27079. </member>
  27080. <member name="F:log4net.Util.PatternStringConverters.RandomStringPatternConverter.declaringType">
  27081. <summary>
  27082. The fully qualified type of the RandomStringPatternConverter class.
  27083. </summary>
  27084. <remarks>
  27085. Used by the internal logger to record the Type of the
  27086. log message.
  27087. </remarks>
  27088. </member>
  27089. <member name="T:log4net.Util.PatternStringConverters.UserNamePatternConverter">
  27090. <summary>
  27091. Write the current threads username to the output
  27092. </summary>
  27093. <remarks>
  27094. <para>
  27095. Write the current threads username to the output writer
  27096. </para>
  27097. </remarks>
  27098. <author>Nicko Cadell</author>
  27099. </member>
  27100. <member name="M:log4net.Util.PatternStringConverters.UserNamePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  27101. <summary>
  27102. Write the current threads username to the output
  27103. </summary>
  27104. <param name="writer">the writer to write to</param>
  27105. <param name="state">null, state is not set</param>
  27106. <remarks>
  27107. <para>
  27108. Write the current threads username to the output <paramref name="writer"/>.
  27109. </para>
  27110. </remarks>
  27111. </member>
  27112. <member name="F:log4net.Util.PatternStringConverters.UserNamePatternConverter.declaringType">
  27113. <summary>
  27114. The fully qualified type of the UserNamePatternConverter class.
  27115. </summary>
  27116. <remarks>
  27117. Used by the internal logger to record the Type of the
  27118. log message.
  27119. </remarks>
  27120. </member>
  27121. <member name="T:log4net.Util.PatternStringConverters.UtcDatePatternConverter">
  27122. <summary>
  27123. Write the UTC date time to the output
  27124. </summary>
  27125. <remarks>
  27126. <para>
  27127. Date pattern converter, uses a <see cref="T:log4net.DateFormatter.IDateFormatter"/> to format
  27128. the current date and time in Universal time.
  27129. </para>
  27130. <para>
  27131. See the <see cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/> for details on the date pattern syntax.
  27132. </para>
  27133. </remarks>
  27134. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  27135. <author>Nicko Cadell</author>
  27136. </member>
  27137. <member name="M:log4net.Util.PatternStringConverters.UtcDatePatternConverter.Convert(System.IO.TextWriter,System.Object)">
  27138. <summary>
  27139. Write the current date and time to the output
  27140. </summary>
  27141. <param name="writer"><see cref="T:System.IO.TextWriter" /> that will receive the formatted result.</param>
  27142. <param name="state">null, state is not set</param>
  27143. <remarks>
  27144. <para>
  27145. Pass the current date and time to the <see cref="T:log4net.DateFormatter.IDateFormatter"/>
  27146. for it to render it to the writer.
  27147. </para>
  27148. <para>
  27149. The date is in Universal time when it is rendered.
  27150. </para>
  27151. </remarks>
  27152. <seealso cref="T:log4net.Util.PatternStringConverters.DatePatternConverter"/>
  27153. </member>
  27154. <member name="F:log4net.Util.PatternStringConverters.UtcDatePatternConverter.declaringType">
  27155. <summary>
  27156. The fully qualified type of the UtcDatePatternConverter class.
  27157. </summary>
  27158. <remarks>
  27159. Used by the internal logger to record the Type of the
  27160. log message.
  27161. </remarks>
  27162. </member>
  27163. <member name="T:log4net.Util.PropertiesDictionary">
  27164. <summary>
  27165. String keyed object map.
  27166. </summary>
  27167. <remarks>
  27168. <para>
  27169. While this collection is serializable only member
  27170. objects that are serializable will
  27171. be serialized along with this collection.
  27172. </para>
  27173. </remarks>
  27174. <author>Nicko Cadell</author>
  27175. <author>Gert Driesen</author>
  27176. </member>
  27177. <member name="M:log4net.Util.PropertiesDictionary.#ctor">
  27178. <summary>
  27179. Constructor
  27180. </summary>
  27181. <remarks>
  27182. <para>
  27183. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class.
  27184. </para>
  27185. </remarks>
  27186. </member>
  27187. <member name="M:log4net.Util.PropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  27188. <summary>
  27189. Constructor
  27190. </summary>
  27191. <param name="propertiesDictionary">properties to copy</param>
  27192. <remarks>
  27193. <para>
  27194. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class.
  27195. </para>
  27196. </remarks>
  27197. </member>
  27198. <member name="M:log4net.Util.PropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27199. <summary>
  27200. Initializes a new instance of the <see cref="T:log4net.Util.PropertiesDictionary" /> class
  27201. with serialized data.
  27202. </summary>
  27203. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  27204. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  27205. <remarks>
  27206. <para>
  27207. Because this class is sealed the serialization constructor is private.
  27208. </para>
  27209. </remarks>
  27210. </member>
  27211. <member name="P:log4net.Util.PropertiesDictionary.Item(System.String)">
  27212. <summary>
  27213. Gets or sets the value of the property with the specified key.
  27214. </summary>
  27215. <value>
  27216. The value of the property with the specified key.
  27217. </value>
  27218. <param name="key">The key of the property to get or set.</param>
  27219. <remarks>
  27220. <para>
  27221. The property value will only be serialized if it is serializable.
  27222. If it cannot be serialized it will be silently ignored if
  27223. a serialization operation is performed.
  27224. </para>
  27225. </remarks>
  27226. </member>
  27227. <member name="M:log4net.Util.PropertiesDictionary.Remove(System.String)">
  27228. <summary>
  27229. Remove the entry with the specified key from this dictionary
  27230. </summary>
  27231. <param name="key">the key for the entry to remove</param>
  27232. <remarks>
  27233. <para>
  27234. Remove the entry with the specified key from this dictionary
  27235. </para>
  27236. </remarks>
  27237. </member>
  27238. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  27239. <summary>
  27240. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  27241. </summary>
  27242. <returns>an enumerator</returns>
  27243. <remarks>
  27244. <para>
  27245. Returns a <see cref="T:System.Collections.IDictionaryEnumerator"/> over the contest of this collection.
  27246. </para>
  27247. </remarks>
  27248. </member>
  27249. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  27250. <summary>
  27251. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  27252. </summary>
  27253. <param name="key">the key to remove</param>
  27254. <remarks>
  27255. <para>
  27256. Remove the entry with the specified key from this dictionary
  27257. </para>
  27258. </remarks>
  27259. </member>
  27260. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  27261. <summary>
  27262. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  27263. </summary>
  27264. <param name="key">the key to lookup in the collection</param>
  27265. <returns><c>true</c> if the collection contains the specified key</returns>
  27266. <remarks>
  27267. <para>
  27268. Test if this collection contains a specified key.
  27269. </para>
  27270. </remarks>
  27271. </member>
  27272. <member name="M:log4net.Util.PropertiesDictionary.Clear">
  27273. <summary>
  27274. Remove all properties from the properties collection
  27275. </summary>
  27276. <remarks>
  27277. <para>
  27278. Remove all properties from the properties collection
  27279. </para>
  27280. </remarks>
  27281. </member>
  27282. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  27283. <summary>
  27284. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  27285. </summary>
  27286. <param name="key">the key</param>
  27287. <param name="value">the value to store for the key</param>
  27288. <remarks>
  27289. <para>
  27290. Store a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  27291. </para>
  27292. </remarks>
  27293. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  27294. </member>
  27295. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  27296. <summary>
  27297. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  27298. </summary>
  27299. <value>
  27300. <c>false</c>
  27301. </value>
  27302. <remarks>
  27303. <para>
  27304. This collection is modifiable. This property always
  27305. returns <c>false</c>.
  27306. </para>
  27307. </remarks>
  27308. </member>
  27309. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  27310. <summary>
  27311. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  27312. </summary>
  27313. <value>
  27314. The value for the key specified.
  27315. </value>
  27316. <remarks>
  27317. <para>
  27318. Get or set a value for the specified <see cref="T:System.String"/> <paramref name="key"/>.
  27319. </para>
  27320. </remarks>
  27321. <exception cref="T:System.ArgumentException">Thrown if the <paramref name="key"/> is not a string</exception>
  27322. </member>
  27323. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Values">
  27324. <summary>
  27325. See <see cref="P:System.Collections.IDictionary.Values"/>
  27326. </summary>
  27327. </member>
  27328. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#Keys">
  27329. <summary>
  27330. See <see cref="P:System.Collections.IDictionary.Keys"/>
  27331. </summary>
  27332. </member>
  27333. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  27334. <summary>
  27335. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  27336. </summary>
  27337. </member>
  27338. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  27339. <summary>
  27340. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  27341. </summary>
  27342. <param name="array"></param>
  27343. <param name="index"></param>
  27344. </member>
  27345. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  27346. <summary>
  27347. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  27348. </summary>
  27349. </member>
  27350. <member name="P:log4net.Util.PropertiesDictionary.System#Collections#ICollection#SyncRoot">
  27351. <summary>
  27352. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  27353. </summary>
  27354. </member>
  27355. <member name="M:log4net.Util.PropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  27356. <summary>
  27357. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  27358. </summary>
  27359. </member>
  27360. <member name="T:log4net.Util.PropertyEntry">
  27361. <summary>
  27362. A class to hold the key and data for a property set in the config file
  27363. </summary>
  27364. <remarks>
  27365. <para>
  27366. A class to hold the key and data for a property set in the config file
  27367. </para>
  27368. </remarks>
  27369. </member>
  27370. <member name="P:log4net.Util.PropertyEntry.Key">
  27371. <summary>
  27372. Property Key
  27373. </summary>
  27374. <value>
  27375. Property Key
  27376. </value>
  27377. <remarks>
  27378. <para>
  27379. Property Key.
  27380. </para>
  27381. </remarks>
  27382. </member>
  27383. <member name="P:log4net.Util.PropertyEntry.Value">
  27384. <summary>
  27385. Property Value
  27386. </summary>
  27387. <value>
  27388. Property Value
  27389. </value>
  27390. <remarks>
  27391. <para>
  27392. Property Value.
  27393. </para>
  27394. </remarks>
  27395. </member>
  27396. <member name="M:log4net.Util.PropertyEntry.ToString">
  27397. <summary>
  27398. Override <c>Object.ToString</c> to return sensible debug info
  27399. </summary>
  27400. <returns>string info about this object</returns>
  27401. </member>
  27402. <member name="T:log4net.Util.ProtectCloseTextWriter">
  27403. <summary>
  27404. A <see cref="T:System.IO.TextWriter"/> that ignores the <see cref="M:log4net.Util.ProtectCloseTextWriter.Close"/> message
  27405. </summary>
  27406. <remarks>
  27407. <para>
  27408. This writer is used in special cases where it is necessary
  27409. to protect a writer from being closed by a client.
  27410. </para>
  27411. </remarks>
  27412. <author>Nicko Cadell</author>
  27413. </member>
  27414. <member name="M:log4net.Util.ProtectCloseTextWriter.#ctor(System.IO.TextWriter)">
  27415. <summary>
  27416. Constructor
  27417. </summary>
  27418. <param name="writer">the writer to actually write to</param>
  27419. <remarks>
  27420. <para>
  27421. Create a new ProtectCloseTextWriter using a writer
  27422. </para>
  27423. </remarks>
  27424. </member>
  27425. <member name="M:log4net.Util.ProtectCloseTextWriter.Attach(System.IO.TextWriter)">
  27426. <summary>
  27427. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  27428. </summary>
  27429. <param name="writer">the writer to attach to</param>
  27430. <remarks>
  27431. <para>
  27432. Attach this instance to a different underlying <see cref="T:System.IO.TextWriter"/>
  27433. </para>
  27434. </remarks>
  27435. </member>
  27436. <member name="M:log4net.Util.ProtectCloseTextWriter.Close">
  27437. <summary>
  27438. Does not close the underlying output writer.
  27439. </summary>
  27440. <remarks>
  27441. <para>
  27442. Does not close the underlying output writer.
  27443. This method does nothing.
  27444. </para>
  27445. </remarks>
  27446. </member>
  27447. <member name="T:log4net.Util.QuietTextWriter">
  27448. <summary>
  27449. <see cref="T:System.IO.TextWriter"/> that does not leak exceptions
  27450. </summary>
  27451. <remarks>
  27452. <para>
  27453. <see cref="T:log4net.Util.QuietTextWriter"/> does not throw exceptions when things go wrong.
  27454. Instead, it delegates error handling to its <see cref="T:log4net.Core.IErrorHandler"/>.
  27455. </para>
  27456. </remarks>
  27457. <author>Nicko Cadell</author>
  27458. <author>Gert Driesen</author>
  27459. </member>
  27460. <member name="M:log4net.Util.QuietTextWriter.#ctor(System.IO.TextWriter,log4net.Core.IErrorHandler)">
  27461. <summary>
  27462. Constructor
  27463. </summary>
  27464. <param name="writer">the writer to actually write to</param>
  27465. <param name="errorHandler">the error handler to report error to</param>
  27466. <remarks>
  27467. <para>
  27468. Create a new QuietTextWriter using a writer and error handler
  27469. </para>
  27470. </remarks>
  27471. </member>
  27472. <member name="P:log4net.Util.QuietTextWriter.ErrorHandler">
  27473. <summary>
  27474. Gets or sets the error handler that all errors are passed to.
  27475. </summary>
  27476. <value>
  27477. The error handler that all errors are passed to.
  27478. </value>
  27479. <remarks>
  27480. <para>
  27481. Gets or sets the error handler that all errors are passed to.
  27482. </para>
  27483. </remarks>
  27484. </member>
  27485. <member name="P:log4net.Util.QuietTextWriter.Closed">
  27486. <summary>
  27487. Gets a value indicating whether this writer is closed.
  27488. </summary>
  27489. <value>
  27490. <c>true</c> if this writer is closed, otherwise <c>false</c>.
  27491. </value>
  27492. <remarks>
  27493. <para>
  27494. Gets a value indicating whether this writer is closed.
  27495. </para>
  27496. </remarks>
  27497. </member>
  27498. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char)">
  27499. <summary>
  27500. Writes a character to the underlying writer
  27501. </summary>
  27502. <param name="value">the char to write</param>
  27503. <remarks>
  27504. <para>
  27505. Writes a character to the underlying writer
  27506. </para>
  27507. </remarks>
  27508. </member>
  27509. <member name="M:log4net.Util.QuietTextWriter.Write(System.Char[],System.Int32,System.Int32)">
  27510. <summary>
  27511. Writes a buffer to the underlying writer
  27512. </summary>
  27513. <param name="buffer">the buffer to write</param>
  27514. <param name="index">the start index to write from</param>
  27515. <param name="count">the number of characters to write</param>
  27516. <remarks>
  27517. <para>
  27518. Writes a buffer to the underlying writer
  27519. </para>
  27520. </remarks>
  27521. </member>
  27522. <member name="M:log4net.Util.QuietTextWriter.Write(System.String)">
  27523. <summary>
  27524. Writes a string to the output.
  27525. </summary>
  27526. <param name="value">The string data to write to the output.</param>
  27527. <remarks>
  27528. <para>
  27529. Writes a string to the output.
  27530. </para>
  27531. </remarks>
  27532. </member>
  27533. <member name="M:log4net.Util.QuietTextWriter.Close">
  27534. <summary>
  27535. Closes the underlying output writer.
  27536. </summary>
  27537. <remarks>
  27538. <para>
  27539. Closes the underlying output writer.
  27540. </para>
  27541. </remarks>
  27542. </member>
  27543. <member name="F:log4net.Util.QuietTextWriter.m_errorHandler">
  27544. <summary>
  27545. The error handler instance to pass all errors to
  27546. </summary>
  27547. </member>
  27548. <member name="F:log4net.Util.QuietTextWriter.m_closed">
  27549. <summary>
  27550. Flag to indicate if this writer is closed
  27551. </summary>
  27552. </member>
  27553. <member name="T:log4net.Util.ReaderWriterLock">
  27554. <summary>
  27555. Defines a lock that supports single writers and multiple readers
  27556. </summary>
  27557. <remarks>
  27558. <para>
  27559. <c>ReaderWriterLock</c> is used to synchronize access to a resource.
  27560. At any given time, it allows either concurrent read access for
  27561. multiple threads, or write access for a single thread. In a
  27562. situation where a resource is changed infrequently, a
  27563. <c>ReaderWriterLock</c> provides better throughput than a simple
  27564. one-at-a-time lock, such as <see cref="T:System.Threading.Monitor"/>.
  27565. </para>
  27566. <para>
  27567. If a platform does not support a <c>System.Threading.ReaderWriterLock</c>
  27568. implementation then all readers and writers are serialized. Therefore
  27569. the caller must not rely on multiple simultaneous readers.
  27570. </para>
  27571. </remarks>
  27572. <author>Nicko Cadell</author>
  27573. </member>
  27574. <member name="M:log4net.Util.ReaderWriterLock.#ctor">
  27575. <summary>
  27576. Constructor
  27577. </summary>
  27578. <remarks>
  27579. <para>
  27580. Initializes a new instance of the <see cref="T:log4net.Util.ReaderWriterLock" /> class.
  27581. </para>
  27582. </remarks>
  27583. </member>
  27584. <member name="M:log4net.Util.ReaderWriterLock.AcquireReaderLock">
  27585. <summary>
  27586. Acquires a reader lock
  27587. </summary>
  27588. <remarks>
  27589. <para>
  27590. <see cref="M:log4net.Util.ReaderWriterLock.AcquireReaderLock"/> blocks if a different thread has the writer
  27591. lock, or if at least one thread is waiting for the writer lock.
  27592. </para>
  27593. </remarks>
  27594. </member>
  27595. <member name="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock">
  27596. <summary>
  27597. Decrements the lock count
  27598. </summary>
  27599. <remarks>
  27600. <para>
  27601. <see cref="M:log4net.Util.ReaderWriterLock.ReleaseReaderLock"/> decrements the lock count. When the count
  27602. reaches zero, the lock is released.
  27603. </para>
  27604. </remarks>
  27605. </member>
  27606. <member name="M:log4net.Util.ReaderWriterLock.AcquireWriterLock">
  27607. <summary>
  27608. Acquires the writer lock
  27609. </summary>
  27610. <remarks>
  27611. <para>
  27612. This method blocks if another thread has a reader lock or writer lock.
  27613. </para>
  27614. </remarks>
  27615. </member>
  27616. <member name="M:log4net.Util.ReaderWriterLock.ReleaseWriterLock">
  27617. <summary>
  27618. Decrements the lock count on the writer lock
  27619. </summary>
  27620. <remarks>
  27621. <para>
  27622. ReleaseWriterLock decrements the writer lock count.
  27623. When the count reaches zero, the writer lock is released.
  27624. </para>
  27625. </remarks>
  27626. </member>
  27627. <member name="T:log4net.Util.ReadOnlyPropertiesDictionary">
  27628. <summary>
  27629. String keyed object map that is read only.
  27630. </summary>
  27631. <remarks>
  27632. <para>
  27633. This collection is readonly and cannot be modified.
  27634. </para>
  27635. <para>
  27636. While this collection is serializable only member
  27637. objects that are serializable will
  27638. be serialized along with this collection.
  27639. </para>
  27640. </remarks>
  27641. <author>Nicko Cadell</author>
  27642. <author>Gert Driesen</author>
  27643. </member>
  27644. <member name="F:log4net.Util.ReadOnlyPropertiesDictionary.m_hashtable">
  27645. <summary>
  27646. The Hashtable used to store the properties data
  27647. </summary>
  27648. </member>
  27649. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor">
  27650. <summary>
  27651. Constructor
  27652. </summary>
  27653. <remarks>
  27654. <para>
  27655. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class.
  27656. </para>
  27657. </remarks>
  27658. </member>
  27659. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(log4net.Util.ReadOnlyPropertiesDictionary)">
  27660. <summary>
  27661. Copy Constructor
  27662. </summary>
  27663. <param name="propertiesDictionary">properties to copy</param>
  27664. <remarks>
  27665. <para>
  27666. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class.
  27667. </para>
  27668. </remarks>
  27669. </member>
  27670. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27671. <summary>
  27672. Deserialization constructor
  27673. </summary>
  27674. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data.</param>
  27675. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
  27676. <remarks>
  27677. <para>
  27678. Initializes a new instance of the <see cref="T:log4net.Util.ReadOnlyPropertiesDictionary" /> class
  27679. with serialized data.
  27680. </para>
  27681. </remarks>
  27682. </member>
  27683. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetKeys">
  27684. <summary>
  27685. Gets the key names.
  27686. </summary>
  27687. <returns>An array of all the keys.</returns>
  27688. <remarks>
  27689. <para>
  27690. Gets the key names.
  27691. </para>
  27692. </remarks>
  27693. </member>
  27694. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Item(System.String)">
  27695. <summary>
  27696. Gets or sets the value of the property with the specified key.
  27697. </summary>
  27698. <value>
  27699. The value of the property with the specified key.
  27700. </value>
  27701. <param name="key">The key of the property to get or set.</param>
  27702. <remarks>
  27703. <para>
  27704. The property value will only be serialized if it is serializable.
  27705. If it cannot be serialized it will be silently ignored if
  27706. a serialization operation is performed.
  27707. </para>
  27708. </remarks>
  27709. </member>
  27710. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Contains(System.String)">
  27711. <summary>
  27712. Test if the dictionary contains a specified key
  27713. </summary>
  27714. <param name="key">the key to look for</param>
  27715. <returns>true if the dictionary contains the specified key</returns>
  27716. <remarks>
  27717. <para>
  27718. Test if the dictionary contains a specified key
  27719. </para>
  27720. </remarks>
  27721. </member>
  27722. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.InnerHashtable">
  27723. <summary>
  27724. The hashtable used to store the properties
  27725. </summary>
  27726. <value>
  27727. The internal collection used to store the properties
  27728. </value>
  27729. <remarks>
  27730. <para>
  27731. The hashtable used to store the properties
  27732. </para>
  27733. </remarks>
  27734. </member>
  27735. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  27736. <summary>
  27737. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  27738. </summary>
  27739. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> to populate with data.</param>
  27740. <param name="context">The destination for this serialization.</param>
  27741. <remarks>
  27742. <para>
  27743. Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> provided.
  27744. </para>
  27745. </remarks>
  27746. </member>
  27747. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#GetEnumerator">
  27748. <summary>
  27749. See <see cref="M:System.Collections.IDictionary.GetEnumerator"/>
  27750. </summary>
  27751. </member>
  27752. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Remove(System.Object)">
  27753. <summary>
  27754. See <see cref="M:System.Collections.IDictionary.Remove(System.Object)"/>
  27755. </summary>
  27756. <param name="key"></param>
  27757. </member>
  27758. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Contains(System.Object)">
  27759. <summary>
  27760. See <see cref="M:System.Collections.IDictionary.Contains(System.Object)"/>
  27761. </summary>
  27762. <param name="key"></param>
  27763. <returns></returns>
  27764. </member>
  27765. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.Clear">
  27766. <summary>
  27767. Remove all properties from the properties collection
  27768. </summary>
  27769. </member>
  27770. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Add(System.Object,System.Object)">
  27771. <summary>
  27772. See <see cref="M:System.Collections.IDictionary.Add(System.Object,System.Object)"/>
  27773. </summary>
  27774. <param name="key"></param>
  27775. <param name="value"></param>
  27776. </member>
  27777. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsReadOnly">
  27778. <summary>
  27779. See <see cref="P:System.Collections.IDictionary.IsReadOnly"/>
  27780. </summary>
  27781. </member>
  27782. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Item(System.Object)">
  27783. <summary>
  27784. See <see cref="P:System.Collections.IDictionary.Item(System.Object)"/>
  27785. </summary>
  27786. </member>
  27787. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Values">
  27788. <summary>
  27789. See <see cref="P:System.Collections.IDictionary.Values"/>
  27790. </summary>
  27791. </member>
  27792. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#Keys">
  27793. <summary>
  27794. See <see cref="P:System.Collections.IDictionary.Keys"/>
  27795. </summary>
  27796. </member>
  27797. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IDictionary#IsFixedSize">
  27798. <summary>
  27799. See <see cref="P:System.Collections.IDictionary.IsFixedSize"/>
  27800. </summary>
  27801. </member>
  27802. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
  27803. <summary>
  27804. See <see cref="M:System.Collections.ICollection.CopyTo(System.Array,System.Int32)"/>
  27805. </summary>
  27806. <param name="array"></param>
  27807. <param name="index"></param>
  27808. </member>
  27809. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#IsSynchronized">
  27810. <summary>
  27811. See <see cref="P:System.Collections.ICollection.IsSynchronized"/>
  27812. </summary>
  27813. </member>
  27814. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.Count">
  27815. <summary>
  27816. The number of properties in this collection
  27817. </summary>
  27818. </member>
  27819. <member name="P:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#ICollection#SyncRoot">
  27820. <summary>
  27821. See <see cref="P:System.Collections.ICollection.SyncRoot"/>
  27822. </summary>
  27823. </member>
  27824. <member name="M:log4net.Util.ReadOnlyPropertiesDictionary.System#Collections#IEnumerable#GetEnumerator">
  27825. <summary>
  27826. See <see cref="M:System.Collections.IEnumerable.GetEnumerator"/>
  27827. </summary>
  27828. </member>
  27829. <member name="T:log4net.Util.ReusableStringWriter">
  27830. <summary>
  27831. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused
  27832. </summary>
  27833. <remarks>
  27834. <para>
  27835. A <see cref="T:System.IO.StringWriter"/> that can be <see cref="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)"/> and reused.
  27836. This uses a single buffer for string operations.
  27837. </para>
  27838. </remarks>
  27839. <author>Nicko Cadell</author>
  27840. </member>
  27841. <member name="M:log4net.Util.ReusableStringWriter.#ctor(System.IFormatProvider)">
  27842. <summary>
  27843. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  27844. </summary>
  27845. <param name="formatProvider">the format provider to use</param>
  27846. <remarks>
  27847. <para>
  27848. Create an instance of <see cref="T:log4net.Util.ReusableStringWriter"/>
  27849. </para>
  27850. </remarks>
  27851. </member>
  27852. <member name="M:log4net.Util.ReusableStringWriter.Dispose(System.Boolean)">
  27853. <summary>
  27854. Override Dispose to prevent closing of writer
  27855. </summary>
  27856. <param name="disposing">flag</param>
  27857. <remarks>
  27858. <para>
  27859. Override Dispose to prevent closing of writer
  27860. </para>
  27861. </remarks>
  27862. </member>
  27863. <member name="M:log4net.Util.ReusableStringWriter.Reset(System.Int32,System.Int32)">
  27864. <summary>
  27865. Reset this string writer so that it can be reused.
  27866. </summary>
  27867. <param name="maxCapacity">the maximum buffer capacity before it is trimmed</param>
  27868. <param name="defaultSize">the default size to make the buffer</param>
  27869. <remarks>
  27870. <para>
  27871. Reset this string writer so that it can be reused.
  27872. The internal buffers are cleared and reset.
  27873. </para>
  27874. </remarks>
  27875. </member>
  27876. <member name="T:log4net.Util.SystemInfo">
  27877. <summary>
  27878. Utility class for system specific information.
  27879. </summary>
  27880. <remarks>
  27881. <para>
  27882. Utility class of static methods for system specific information.
  27883. </para>
  27884. </remarks>
  27885. <author>Nicko Cadell</author>
  27886. <author>Gert Driesen</author>
  27887. <author>Alexey Solofnenko</author>
  27888. </member>
  27889. <member name="M:log4net.Util.SystemInfo.#ctor">
  27890. <summary>
  27891. Private constructor to prevent instances.
  27892. </summary>
  27893. <remarks>
  27894. <para>
  27895. Only static methods are exposed from this type.
  27896. </para>
  27897. </remarks>
  27898. </member>
  27899. <member name="M:log4net.Util.SystemInfo.#cctor">
  27900. <summary>
  27901. Initialize default values for private static fields.
  27902. </summary>
  27903. <remarks>
  27904. <para>
  27905. Only static methods are exposed from this type.
  27906. </para>
  27907. </remarks>
  27908. </member>
  27909. <member name="P:log4net.Util.SystemInfo.NewLine">
  27910. <summary>
  27911. Gets the system dependent line terminator.
  27912. </summary>
  27913. <value>
  27914. The system dependent line terminator.
  27915. </value>
  27916. <remarks>
  27917. <para>
  27918. Gets the system dependent line terminator.
  27919. </para>
  27920. </remarks>
  27921. </member>
  27922. <member name="P:log4net.Util.SystemInfo.ApplicationBaseDirectory">
  27923. <summary>
  27924. Gets the base directory for this <see cref="!:AppDomain"/>.
  27925. </summary>
  27926. <value>The base directory path for the current <see cref="!:AppDomain"/>.</value>
  27927. <remarks>
  27928. <para>
  27929. Gets the base directory for this <see cref="!:AppDomain"/>.
  27930. </para>
  27931. <para>
  27932. The value returned may be either a local file path or a URI.
  27933. </para>
  27934. </remarks>
  27935. </member>
  27936. <member name="P:log4net.Util.SystemInfo.ConfigurationFileLocation">
  27937. <summary>
  27938. Gets the path to the configuration file for the current <see cref="!:AppDomain"/>.
  27939. </summary>
  27940. <value>The path to the configuration file for the current <see cref="!:AppDomain"/>.</value>
  27941. <remarks>
  27942. <para>
  27943. The .NET Compact Framework 1.0 does not have a concept of a configuration
  27944. file. For this runtime, we use the entry assembly location as the root for
  27945. the configuration file name.
  27946. </para>
  27947. <para>
  27948. The value returned may be either a local file path or a URI.
  27949. </para>
  27950. </remarks>
  27951. </member>
  27952. <member name="P:log4net.Util.SystemInfo.EntryAssemblyLocation">
  27953. <summary>
  27954. Gets the path to the file that first executed in the current <see cref="!:AppDomain"/>.
  27955. </summary>
  27956. <value>The path to the entry assembly.</value>
  27957. <remarks>
  27958. <para>
  27959. Gets the path to the file that first executed in the current <see cref="!:AppDomain"/>.
  27960. </para>
  27961. </remarks>
  27962. </member>
  27963. <member name="P:log4net.Util.SystemInfo.CurrentThreadId">
  27964. <summary>
  27965. Gets the ID of the current thread.
  27966. </summary>
  27967. <value>The ID of the current thread.</value>
  27968. <remarks>
  27969. <para>
  27970. On the .NET framework, the <c>AppDomain.GetCurrentThreadId</c> method
  27971. is used to obtain the thread ID for the current thread. This is the
  27972. operating system ID for the thread.
  27973. </para>
  27974. <para>
  27975. On the .NET Compact Framework 1.0 it is not possible to get the
  27976. operating system thread ID for the current thread. The native method
  27977. <c>GetCurrentThreadId</c> is implemented inline in a header file
  27978. and cannot be called.
  27979. </para>
  27980. <para>
  27981. On the .NET Framework 2.0 the <c>Thread.ManagedThreadId</c> is used as this
  27982. gives a stable id unrelated to the operating system thread ID which may
  27983. change if the runtime is using fibers.
  27984. </para>
  27985. </remarks>
  27986. </member>
  27987. <member name="P:log4net.Util.SystemInfo.HostName">
  27988. <summary>
  27989. Get the host name or machine name for the current machine
  27990. </summary>
  27991. <value>
  27992. The hostname or machine name
  27993. </value>
  27994. <remarks>
  27995. <para>
  27996. Get the host name or machine name for the current machine
  27997. </para>
  27998. <para>
  27999. The host name (<see cref="M:System.Net.Dns.GetHostName"/>) or
  28000. the machine name (<c>Environment.MachineName</c>) for
  28001. the current machine, or if neither of these are available
  28002. then <c>NOT AVAILABLE</c> is returned.
  28003. </para>
  28004. </remarks>
  28005. </member>
  28006. <member name="P:log4net.Util.SystemInfo.ApplicationFriendlyName">
  28007. <summary>
  28008. Get this application's friendly name
  28009. </summary>
  28010. <value>
  28011. The friendly name of this application as a string
  28012. </value>
  28013. <remarks>
  28014. <para>
  28015. If available the name of the application is retrieved from
  28016. the <c>AppDomain</c> using <c>AppDomain.CurrentDomain.FriendlyName</c>.
  28017. </para>
  28018. <para>
  28019. Otherwise the file name of the entry assembly is used.
  28020. </para>
  28021. </remarks>
  28022. </member>
  28023. <member name="P:log4net.Util.SystemInfo.ProcessStartTime">
  28024. <summary>
  28025. Get the start time for the current process.
  28026. </summary>
  28027. <remarks>
  28028. <para>
  28029. This is the time at which the log4net library was loaded into the
  28030. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  28031. this is not the start time for the current process.
  28032. </para>
  28033. <para>
  28034. The log4net library should be loaded by an application early during its
  28035. startup, therefore this start time should be a good approximation for
  28036. the actual start time.
  28037. </para>
  28038. <para>
  28039. Note that AppDomains may be loaded and unloaded within the
  28040. same process without the process terminating, however this start time
  28041. will be set per AppDomain.
  28042. </para>
  28043. </remarks>
  28044. </member>
  28045. <member name="P:log4net.Util.SystemInfo.ProcessStartTimeUtc">
  28046. <summary>
  28047. Get the UTC start time for the current process.
  28048. </summary>
  28049. <remarks>
  28050. <para>
  28051. This is the UTC time at which the log4net library was loaded into the
  28052. AppDomain. Due to reports of a hang in the call to <c>System.Diagnostics.Process.StartTime</c>
  28053. this is not the start time for the current process.
  28054. </para>
  28055. <para>
  28056. The log4net library should be loaded by an application early during its
  28057. startup, therefore this start time should be a good approximation for
  28058. the actual start time.
  28059. </para>
  28060. <para>
  28061. Note that AppDomains may be loaded and unloaded within the
  28062. same process without the process terminating, however this start time
  28063. will be set per AppDomain.
  28064. </para>
  28065. </remarks>
  28066. </member>
  28067. <member name="P:log4net.Util.SystemInfo.NullText">
  28068. <summary>
  28069. Text to output when a <c>null</c> is encountered.
  28070. </summary>
  28071. <remarks>
  28072. <para>
  28073. Use this value to indicate a <c>null</c> has been encountered while
  28074. outputting a string representation of an item.
  28075. </para>
  28076. <para>
  28077. The default value is <c>(null)</c>. This value can be overridden by specifying
  28078. a value for the <c>log4net.NullText</c> appSetting in the application's
  28079. .config file.
  28080. </para>
  28081. </remarks>
  28082. </member>
  28083. <member name="P:log4net.Util.SystemInfo.NotAvailableText">
  28084. <summary>
  28085. Text to output when an unsupported feature is requested.
  28086. </summary>
  28087. <remarks>
  28088. <para>
  28089. Use this value when an unsupported feature is requested.
  28090. </para>
  28091. <para>
  28092. The default value is <c>NOT AVAILABLE</c>. This value can be overridden by specifying
  28093. a value for the <c>log4net.NotAvailableText</c> appSetting in the application's
  28094. .config file.
  28095. </para>
  28096. </remarks>
  28097. </member>
  28098. <member name="M:log4net.Util.SystemInfo.AssemblyLocationInfo(System.Reflection.Assembly)">
  28099. <summary>
  28100. Gets the assembly location path for the specified assembly.
  28101. </summary>
  28102. <param name="myAssembly">The assembly to get the location for.</param>
  28103. <returns>The location of the assembly.</returns>
  28104. <remarks>
  28105. <para>
  28106. This method does not guarantee to return the correct path
  28107. to the assembly. If only tries to give an indication as to
  28108. where the assembly was loaded from.
  28109. </para>
  28110. </remarks>
  28111. </member>
  28112. <member name="M:log4net.Util.SystemInfo.AssemblyQualifiedName(System.Type)">
  28113. <summary>
  28114. Gets the fully qualified name of the <see cref="T:System.Type" />, including
  28115. the name of the assembly from which the <see cref="T:System.Type" /> was
  28116. loaded.
  28117. </summary>
  28118. <param name="type">The <see cref="T:System.Type" /> to get the fully qualified name for.</param>
  28119. <returns>The fully qualified name for the <see cref="T:System.Type" />.</returns>
  28120. <remarks>
  28121. <para>
  28122. This is equivalent to the <c>Type.AssemblyQualifiedName</c> property,
  28123. but this method works on the .NET Compact Framework 1.0 as well as
  28124. the full .NET runtime.
  28125. </para>
  28126. </remarks>
  28127. </member>
  28128. <member name="M:log4net.Util.SystemInfo.AssemblyShortName(System.Reflection.Assembly)">
  28129. <summary>
  28130. Gets the short name of the <see cref="T:System.Reflection.Assembly" />.
  28131. </summary>
  28132. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly" /> to get the name for.</param>
  28133. <returns>The short name of the <see cref="T:System.Reflection.Assembly" />.</returns>
  28134. <remarks>
  28135. <para>
  28136. The short name of the assembly is the <see cref="P:System.Reflection.Assembly.FullName" />
  28137. without the version, culture, or public key. i.e. it is just the
  28138. assembly's file name without the extension.
  28139. </para>
  28140. <para>
  28141. Use this rather than <c>Assembly.GetName().Name</c> because that
  28142. is not available on the Compact Framework.
  28143. </para>
  28144. <para>
  28145. Because of a FileIOPermission security demand we cannot do
  28146. the obvious Assembly.GetName().Name. We are allowed to get
  28147. the <see cref="P:System.Reflection.Assembly.FullName" /> of the assembly so we
  28148. start from there and strip out just the assembly name.
  28149. </para>
  28150. </remarks>
  28151. </member>
  28152. <member name="M:log4net.Util.SystemInfo.AssemblyFileName(System.Reflection.Assembly)">
  28153. <summary>
  28154. Gets the file name portion of the <see cref="T:System.Reflection.Assembly" />, including the extension.
  28155. </summary>
  28156. <param name="myAssembly">The <see cref="T:System.Reflection.Assembly" /> to get the file name for.</param>
  28157. <returns>The file name of the assembly.</returns>
  28158. <remarks>
  28159. <para>
  28160. Gets the file name portion of the <see cref="T:System.Reflection.Assembly" />, including the extension.
  28161. </para>
  28162. </remarks>
  28163. </member>
  28164. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Type,System.String,System.Boolean,System.Boolean)">
  28165. <summary>
  28166. Loads the type specified in the type string.
  28167. </summary>
  28168. <param name="relativeType">A sibling type to use to load the type.</param>
  28169. <param name="typeName">The name of the type to load.</param>
  28170. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  28171. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  28172. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  28173. <remarks>
  28174. <para>
  28175. If the type name is fully qualified, i.e. if contains an assembly name in
  28176. the type name, the type will be loaded from the system using
  28177. <see cref="M:Type.GetType(string,bool)"/>.
  28178. </para>
  28179. <para>
  28180. If the type name is not fully qualified, it will be loaded from the assembly
  28181. containing the specified relative type. If the type is not found in the assembly
  28182. then all the loaded assemblies will be searched for the type.
  28183. </para>
  28184. </remarks>
  28185. </member>
  28186. <member name="M:log4net.Util.SystemInfo.GetTypeFromString(System.Reflection.Assembly,System.String,System.Boolean,System.Boolean)">
  28187. <summary>
  28188. Loads the type specified in the type string.
  28189. </summary>
  28190. <param name="relativeAssembly">An assembly to load the type from.</param>
  28191. <param name="typeName">The name of the type to load.</param>
  28192. <param name="throwOnError">Flag set to <c>true</c> to throw an exception if the type cannot be loaded.</param>
  28193. <param name="ignoreCase"><c>true</c> to ignore the case of the type name; otherwise, <c>false</c></param>
  28194. <returns>The type loaded or <c>null</c> if it could not be loaded.</returns>
  28195. <remarks>
  28196. <para>
  28197. If the type name is fully qualified, i.e. if contains an assembly name in
  28198. the type name, the type will be loaded from the system using
  28199. <see cref="M:Type.GetType(string,bool)"/>.
  28200. </para>
  28201. <para>
  28202. If the type name is not fully qualified it will be loaded from the specified
  28203. assembly. If the type is not found in the assembly then all the loaded assemblies
  28204. will be searched for the type.
  28205. </para>
  28206. </remarks>
  28207. </member>
  28208. <member name="M:log4net.Util.SystemInfo.NewGuid">
  28209. <summary>
  28210. Generate a new guid
  28211. </summary>
  28212. <returns>A new Guid</returns>
  28213. <remarks>
  28214. <para>
  28215. Generate a new guid
  28216. </para>
  28217. </remarks>
  28218. </member>
  28219. <member name="M:log4net.Util.SystemInfo.CreateArgumentOutOfRangeException(System.String,System.Object,System.String)">
  28220. <summary>
  28221. Create an <see cref="T:System.ArgumentOutOfRangeException"/>
  28222. </summary>
  28223. <param name="parameterName">The name of the parameter that caused the exception</param>
  28224. <param name="actualValue">The value of the argument that causes this exception</param>
  28225. <param name="message">The message that describes the error</param>
  28226. <returns>the ArgumentOutOfRangeException object</returns>
  28227. <remarks>
  28228. <para>
  28229. Create a new instance of the <see cref="T:System.ArgumentOutOfRangeException"/> class
  28230. with a specified error message, the parameter name, and the value
  28231. of the argument.
  28232. </para>
  28233. <para>
  28234. The Compact Framework does not support the 3 parameter constructor for the
  28235. <see cref="T:System.ArgumentOutOfRangeException"/> type. This method provides an
  28236. implementation that works for all platforms.
  28237. </para>
  28238. </remarks>
  28239. </member>
  28240. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int32@)">
  28241. <summary>
  28242. Parse a string into an <see cref="T:System.Int32"/> value
  28243. </summary>
  28244. <param name="s">the string to parse</param>
  28245. <param name="val">out param where the parsed value is placed</param>
  28246. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28247. <remarks>
  28248. <para>
  28249. Attempts to parse the string into an integer. If the string cannot
  28250. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28251. </para>
  28252. </remarks>
  28253. </member>
  28254. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int64@)">
  28255. <summary>
  28256. Parse a string into an <see cref="T:System.Int64"/> value
  28257. </summary>
  28258. <param name="s">the string to parse</param>
  28259. <param name="val">out param where the parsed value is placed</param>
  28260. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28261. <remarks>
  28262. <para>
  28263. Attempts to parse the string into an integer. If the string cannot
  28264. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28265. </para>
  28266. </remarks>
  28267. </member>
  28268. <member name="M:log4net.Util.SystemInfo.TryParse(System.String,System.Int16@)">
  28269. <summary>
  28270. Parse a string into an <see cref="T:System.Int16"/> value
  28271. </summary>
  28272. <param name="s">the string to parse</param>
  28273. <param name="val">out param where the parsed value is placed</param>
  28274. <returns><c>true</c> if the string was able to be parsed into an integer</returns>
  28275. <remarks>
  28276. <para>
  28277. Attempts to parse the string into an integer. If the string cannot
  28278. be parsed then this method returns <c>false</c>. The method does not throw an exception.
  28279. </para>
  28280. </remarks>
  28281. </member>
  28282. <member name="M:log4net.Util.SystemInfo.GetAppSetting(System.String)">
  28283. <summary>
  28284. Lookup an application setting
  28285. </summary>
  28286. <param name="key">the application settings key to lookup</param>
  28287. <returns>the value for the key, or <c>null</c></returns>
  28288. <remarks>
  28289. <para>
  28290. Configuration APIs are not supported under the Compact Framework
  28291. </para>
  28292. </remarks>
  28293. </member>
  28294. <member name="M:log4net.Util.SystemInfo.ConvertToFullPath(System.String)">
  28295. <summary>
  28296. Convert a path into a fully qualified local file path.
  28297. </summary>
  28298. <param name="path">The path to convert.</param>
  28299. <returns>The fully qualified path.</returns>
  28300. <remarks>
  28301. <para>
  28302. Converts the path specified to a fully
  28303. qualified path. If the path is relative it is
  28304. taken as relative from the application base
  28305. directory.
  28306. </para>
  28307. <para>
  28308. The path specified must be a local file path, a URI is not supported.
  28309. </para>
  28310. </remarks>
  28311. </member>
  28312. <member name="M:log4net.Util.SystemInfo.CreateCaseInsensitiveHashtable">
  28313. <summary>
  28314. Creates a new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity.
  28315. </summary>
  28316. <returns>A new case-insensitive instance of the <see cref="T:System.Collections.Hashtable"/> class with the default initial capacity</returns>
  28317. <remarks>
  28318. <para>
  28319. The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer.
  28320. </para>
  28321. </remarks>
  28322. </member>
  28323. <member name="M:log4net.Util.SystemInfo.EqualsIgnoringCase(System.String,System.String)">
  28324. <summary>
  28325. Tests two strings for equality, the ignoring case.
  28326. </summary>
  28327. <remarks>
  28328. If the platform permits, culture information is ignored completely (ordinal comparison).
  28329. The aim of this method is to provide a fast comparison that deals with <c>null</c> and ignores different casing.
  28330. It is not supposed to deal with various, culture-specific habits.
  28331. Use it to compare against pure ASCII constants, like keywords etc.
  28332. </remarks>
  28333. <param name="a">The one string.</param>
  28334. <param name="b">The other string.</param>
  28335. <returns><c>true</c> if the strings are equal, <c>false</c> otherwise.</returns>
  28336. </member>
  28337. <member name="F:log4net.Util.SystemInfo.EmptyTypes">
  28338. <summary>
  28339. Gets an empty array of types.
  28340. </summary>
  28341. <remarks>
  28342. <para>
  28343. The <c>Type.EmptyTypes</c> field is not available on
  28344. the .NET Compact Framework 1.0.
  28345. </para>
  28346. </remarks>
  28347. </member>
  28348. <member name="F:log4net.Util.SystemInfo.declaringType">
  28349. <summary>
  28350. The fully qualified type of the SystemInfo class.
  28351. </summary>
  28352. <remarks>
  28353. Used by the internal logger to record the Type of the
  28354. log message.
  28355. </remarks>
  28356. </member>
  28357. <member name="F:log4net.Util.SystemInfo.s_hostName">
  28358. <summary>
  28359. Cache the host name for the current machine
  28360. </summary>
  28361. </member>
  28362. <member name="F:log4net.Util.SystemInfo.s_appFriendlyName">
  28363. <summary>
  28364. Cache the application friendly name
  28365. </summary>
  28366. </member>
  28367. <member name="F:log4net.Util.SystemInfo.s_nullText">
  28368. <summary>
  28369. Text to output when a <c>null</c> is encountered.
  28370. </summary>
  28371. </member>
  28372. <member name="F:log4net.Util.SystemInfo.s_notAvailableText">
  28373. <summary>
  28374. Text to output when an unsupported feature is requested.
  28375. </summary>
  28376. </member>
  28377. <member name="F:log4net.Util.SystemInfo.s_processStartTimeUtc">
  28378. <summary>
  28379. Start time for the current process.
  28380. </summary>
  28381. </member>
  28382. <member name="T:log4net.Util.SystemStringFormat">
  28383. <summary>
  28384. Utility class that represents a format string.
  28385. </summary>
  28386. <remarks>
  28387. <para>
  28388. Utility class that represents a format string.
  28389. </para>
  28390. </remarks>
  28391. <author>Nicko Cadell</author>
  28392. </member>
  28393. <member name="M:log4net.Util.SystemStringFormat.#ctor(System.IFormatProvider,System.String,System.Object[])">
  28394. <summary>
  28395. Initialise the <see cref="T:log4net.Util.SystemStringFormat"/>
  28396. </summary>
  28397. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  28398. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  28399. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  28400. </member>
  28401. <member name="M:log4net.Util.SystemStringFormat.ToString">
  28402. <summary>
  28403. Format the string and arguments
  28404. </summary>
  28405. <returns>the formatted string</returns>
  28406. </member>
  28407. <member name="M:log4net.Util.SystemStringFormat.StringFormat(System.IFormatProvider,System.String,System.Object[])">
  28408. <summary>
  28409. Replaces the format item in a specified <see cref="T:System.String"/> with the text equivalent
  28410. of the value of a corresponding <see cref="T:System.Object"/> instance in a specified array.
  28411. A specified parameter supplies culture-specific formatting information.
  28412. </summary>
  28413. <param name="provider">An <see cref="T:System.IFormatProvider"/> that supplies culture-specific formatting information.</param>
  28414. <param name="format">A <see cref="T:System.String"/> containing zero or more format items.</param>
  28415. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  28416. <returns>
  28417. A copy of format in which the format items have been replaced by the <see cref="T:System.String"/>
  28418. equivalent of the corresponding instances of <see cref="T:System.Object"/> in args.
  28419. </returns>
  28420. <remarks>
  28421. <para>
  28422. This method does not throw exceptions. If an exception thrown while formatting the result the
  28423. exception and arguments are returned in the result string.
  28424. </para>
  28425. </remarks>
  28426. </member>
  28427. <member name="M:log4net.Util.SystemStringFormat.StringFormatError(System.Exception,System.String,System.Object[])">
  28428. <summary>
  28429. Process an error during StringFormat
  28430. </summary>
  28431. </member>
  28432. <member name="M:log4net.Util.SystemStringFormat.RenderArray(System.Array,System.Text.StringBuilder)">
  28433. <summary>
  28434. Dump the contents of an array into a string builder
  28435. </summary>
  28436. </member>
  28437. <member name="M:log4net.Util.SystemStringFormat.RenderObject(System.Object,System.Text.StringBuilder)">
  28438. <summary>
  28439. Dump an object to a string
  28440. </summary>
  28441. </member>
  28442. <member name="F:log4net.Util.SystemStringFormat.declaringType">
  28443. <summary>
  28444. The fully qualified type of the SystemStringFormat class.
  28445. </summary>
  28446. <remarks>
  28447. Used by the internal logger to record the Type of the
  28448. log message.
  28449. </remarks>
  28450. </member>
  28451. <member name="T:log4net.Util.TextWriterAdapter">
  28452. <summary>
  28453. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  28454. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  28455. </summary>
  28456. <remarks>
  28457. <para>
  28458. Adapter that extends <see cref="T:System.IO.TextWriter"/> and forwards all
  28459. messages to an instance of <see cref="T:System.IO.TextWriter"/>.
  28460. </para>
  28461. </remarks>
  28462. <author>Nicko Cadell</author>
  28463. </member>
  28464. <member name="F:log4net.Util.TextWriterAdapter.m_writer">
  28465. <summary>
  28466. The writer to forward messages to
  28467. </summary>
  28468. </member>
  28469. <member name="M:log4net.Util.TextWriterAdapter.#ctor(System.IO.TextWriter)">
  28470. <summary>
  28471. Create an instance of <see cref="T:log4net.Util.TextWriterAdapter"/> that forwards all
  28472. messages to a <see cref="T:System.IO.TextWriter"/>.
  28473. </summary>
  28474. <param name="writer">The <see cref="T:System.IO.TextWriter"/> to forward to</param>
  28475. <remarks>
  28476. <para>
  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. </para>
  28480. </remarks>
  28481. </member>
  28482. <member name="P:log4net.Util.TextWriterAdapter.Writer">
  28483. <summary>
  28484. Gets or sets the underlying <see cref="T:System.IO.TextWriter" />.
  28485. </summary>
  28486. <value>
  28487. The underlying <see cref="T:System.IO.TextWriter" />.
  28488. </value>
  28489. <remarks>
  28490. <para>
  28491. Gets or sets the underlying <see cref="T:System.IO.TextWriter" />.
  28492. </para>
  28493. </remarks>
  28494. </member>
  28495. <member name="P:log4net.Util.TextWriterAdapter.Encoding">
  28496. <summary>
  28497. The Encoding in which the output is written
  28498. </summary>
  28499. <value>
  28500. The <see cref="P:log4net.Util.TextWriterAdapter.Encoding"/>
  28501. </value>
  28502. <remarks>
  28503. <para>
  28504. The Encoding in which the output is written
  28505. </para>
  28506. </remarks>
  28507. </member>
  28508. <member name="P:log4net.Util.TextWriterAdapter.FormatProvider">
  28509. <summary>
  28510. Gets an object that controls formatting
  28511. </summary>
  28512. <value>
  28513. The format provider
  28514. </value>
  28515. <remarks>
  28516. <para>
  28517. Gets an object that controls formatting
  28518. </para>
  28519. </remarks>
  28520. </member>
  28521. <member name="P:log4net.Util.TextWriterAdapter.NewLine">
  28522. <summary>
  28523. Gets or sets the line terminator string used by the TextWriter
  28524. </summary>
  28525. <value>
  28526. The line terminator to use
  28527. </value>
  28528. <remarks>
  28529. <para>
  28530. Gets or sets the line terminator string used by the TextWriter
  28531. </para>
  28532. </remarks>
  28533. </member>
  28534. <member name="M:log4net.Util.TextWriterAdapter.Close">
  28535. <summary>
  28536. Closes the writer and releases any system resources associated with the writer
  28537. </summary>
  28538. <remarks>
  28539. <para>
  28540. </para>
  28541. </remarks>
  28542. </member>
  28543. <member name="M:log4net.Util.TextWriterAdapter.Dispose(System.Boolean)">
  28544. <summary>
  28545. Dispose this writer
  28546. </summary>
  28547. <param name="disposing">flag indicating if we are being disposed</param>
  28548. <remarks>
  28549. <para>
  28550. Dispose this writer
  28551. </para>
  28552. </remarks>
  28553. </member>
  28554. <member name="M:log4net.Util.TextWriterAdapter.Flush">
  28555. <summary>
  28556. Flushes any buffered output
  28557. </summary>
  28558. <remarks>
  28559. <para>
  28560. Clears all buffers for the writer and causes any buffered data to be written
  28561. to the underlying device
  28562. </para>
  28563. </remarks>
  28564. </member>
  28565. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char)">
  28566. <summary>
  28567. Writes a character to the wrapped TextWriter
  28568. </summary>
  28569. <param name="value">the value to write to the TextWriter</param>
  28570. <remarks>
  28571. <para>
  28572. Writes a character to the wrapped TextWriter
  28573. </para>
  28574. </remarks>
  28575. </member>
  28576. <member name="M:log4net.Util.TextWriterAdapter.Write(System.Char[],System.Int32,System.Int32)">
  28577. <summary>
  28578. Writes a character buffer to the wrapped TextWriter
  28579. </summary>
  28580. <param name="buffer">the data buffer</param>
  28581. <param name="index">the start index</param>
  28582. <param name="count">the number of characters to write</param>
  28583. <remarks>
  28584. <para>
  28585. Writes a character buffer to the wrapped TextWriter
  28586. </para>
  28587. </remarks>
  28588. </member>
  28589. <member name="M:log4net.Util.TextWriterAdapter.Write(System.String)">
  28590. <summary>
  28591. Writes a string to the wrapped TextWriter
  28592. </summary>
  28593. <param name="value">the value to write to the TextWriter</param>
  28594. <remarks>
  28595. <para>
  28596. Writes a string to the wrapped TextWriter
  28597. </para>
  28598. </remarks>
  28599. </member>
  28600. <member name="T:log4net.Util.ThreadContextProperties">
  28601. <summary>
  28602. Implementation of Properties collection for the <see cref="T:log4net.ThreadContext"/>
  28603. </summary>
  28604. <remarks>
  28605. <para>
  28606. Class implements a collection of properties that is specific to each thread.
  28607. The class is not synchronized as each thread has its own <see cref="T:log4net.Util.PropertiesDictionary"/>.
  28608. </para>
  28609. </remarks>
  28610. <author>Nicko Cadell</author>
  28611. </member>
  28612. <member name="F:log4net.Util.ThreadContextProperties._dictionary">
  28613. <summary>
  28614. Each thread will automatically have its instance.
  28615. </summary>
  28616. </member>
  28617. <member name="M:log4net.Util.ThreadContextProperties.#ctor">
  28618. <summary>
  28619. Internal constructor
  28620. </summary>
  28621. <remarks>
  28622. <para>
  28623. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextProperties" /> class.
  28624. </para>
  28625. </remarks>
  28626. </member>
  28627. <member name="P:log4net.Util.ThreadContextProperties.Item(System.String)">
  28628. <summary>
  28629. Gets or sets the value of a property
  28630. </summary>
  28631. <value>
  28632. The value for the property with the specified key
  28633. </value>
  28634. <remarks>
  28635. <para>
  28636. Gets or sets the value of a property
  28637. </para>
  28638. </remarks>
  28639. </member>
  28640. <member name="M:log4net.Util.ThreadContextProperties.Remove(System.String)">
  28641. <summary>
  28642. Remove a property
  28643. </summary>
  28644. <param name="key">the key for the entry to remove</param>
  28645. <remarks>
  28646. <para>
  28647. Remove a property
  28648. </para>
  28649. </remarks>
  28650. </member>
  28651. <member name="M:log4net.Util.ThreadContextProperties.GetKeys">
  28652. <summary>
  28653. Get the keys stored in the properties.
  28654. </summary>
  28655. <para>
  28656. Gets the keys stored in the properties.
  28657. </para>
  28658. <returns>a set of the defined keys</returns>
  28659. </member>
  28660. <member name="M:log4net.Util.ThreadContextProperties.Clear">
  28661. <summary>
  28662. Clear all properties
  28663. </summary>
  28664. <remarks>
  28665. <para>
  28666. Clear all properties
  28667. </para>
  28668. </remarks>
  28669. </member>
  28670. <member name="M:log4net.Util.ThreadContextProperties.GetProperties(System.Boolean)">
  28671. <summary>
  28672. Get the <c>PropertiesDictionary</c> for this thread.
  28673. </summary>
  28674. <param name="create">create the dictionary if it does not exist, otherwise return null if does not exist</param>
  28675. <returns>the properties for this thread</returns>
  28676. <remarks>
  28677. <para>
  28678. The collection returned is only to be used on the calling thread. If the
  28679. caller needs to share the collection between different threads then the
  28680. caller must clone the collection before doing so.
  28681. </para>
  28682. </remarks>
  28683. </member>
  28684. <member name="T:log4net.Util.ThreadContextStack">
  28685. <summary>
  28686. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  28687. </summary>
  28688. <remarks>
  28689. <para>
  28690. Implementation of Stack for the <see cref="T:log4net.ThreadContext"/>
  28691. </para>
  28692. </remarks>
  28693. <author>Nicko Cadell</author>
  28694. </member>
  28695. <member name="F:log4net.Util.ThreadContextStack.m_stack">
  28696. <summary>
  28697. The stack store.
  28698. </summary>
  28699. </member>
  28700. <member name="M:log4net.Util.ThreadContextStack.#ctor">
  28701. <summary>
  28702. Internal constructor
  28703. </summary>
  28704. <remarks>
  28705. <para>
  28706. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack" /> class.
  28707. </para>
  28708. </remarks>
  28709. </member>
  28710. <member name="P:log4net.Util.ThreadContextStack.Count">
  28711. <summary>
  28712. The number of messages in the stack
  28713. </summary>
  28714. <value>
  28715. The current number of messages in the stack
  28716. </value>
  28717. <remarks>
  28718. <para>
  28719. The current number of messages in the stack. That is
  28720. the number of times <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> has been called
  28721. minus the number of times <see cref="M:log4net.Util.ThreadContextStack.Pop"/> has been called.
  28722. </para>
  28723. </remarks>
  28724. </member>
  28725. <member name="M:log4net.Util.ThreadContextStack.Clear">
  28726. <summary>
  28727. Clears all the contextual information held in this stack.
  28728. </summary>
  28729. <remarks>
  28730. <para>
  28731. Clears all the contextual information held in this stack.
  28732. Only call this if you think that this tread is being reused after
  28733. a previous call execution which may not have completed correctly.
  28734. You do not need to use this method if you always guarantee to call
  28735. the <see cref="M:System.IDisposable.Dispose"/> method of the <see cref="T:System.IDisposable"/>
  28736. returned from <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> even in exceptional circumstances,
  28737. for example by using the <c>using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))</c>
  28738. syntax.
  28739. </para>
  28740. </remarks>
  28741. </member>
  28742. <member name="M:log4net.Util.ThreadContextStack.Pop">
  28743. <summary>
  28744. Removes the top context from this stack.
  28745. </summary>
  28746. <returns>The message in the context that was removed from the top of this stack.</returns>
  28747. <remarks>
  28748. <para>
  28749. Remove the top context from this stack, and return
  28750. it to the caller. If this stack is empty then an
  28751. empty string (not <see langword="null"/>) is returned.
  28752. </para>
  28753. </remarks>
  28754. </member>
  28755. <member name="M:log4net.Util.ThreadContextStack.Push(System.String)">
  28756. <summary>
  28757. Pushes a new context message into this stack.
  28758. </summary>
  28759. <param name="message">The new context message.</param>
  28760. <returns>
  28761. An <see cref="T:System.IDisposable"/> that can be used to clean up the context stack.
  28762. </returns>
  28763. <remarks>
  28764. <para>
  28765. Pushes a new context onto this stack. An <see cref="T:System.IDisposable"/>
  28766. is returned that can be used to clean up this stack. This
  28767. can be easily combined with the <c>using</c> keyword to scope the
  28768. context.
  28769. </para>
  28770. </remarks>
  28771. <example>Simple example of using the <c>Push</c> method with the <c>using</c> keyword.
  28772. <code lang="C#">
  28773. using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message"))
  28774. {
  28775. log.Warn("This should have an ThreadContext Stack message");
  28776. }
  28777. </code>
  28778. </example>
  28779. </member>
  28780. <member name="M:log4net.Util.ThreadContextStack.GetFullMessage">
  28781. <summary>
  28782. Gets the current context information for this stack.
  28783. </summary>
  28784. <returns>The current context information.</returns>
  28785. </member>
  28786. <member name="P:log4net.Util.ThreadContextStack.InternalStack">
  28787. <summary>
  28788. Gets and sets the internal stack used by this <see cref="T:log4net.Util.ThreadContextStack"/>
  28789. </summary>
  28790. <value>The internal storage stack</value>
  28791. <remarks>
  28792. <para>
  28793. This property is provided only to support backward compatability
  28794. of the <see cref="T:log4net.NDC"/>. Tytpically the internal stack should not
  28795. be modified.
  28796. </para>
  28797. </remarks>
  28798. </member>
  28799. <member name="M:log4net.Util.ThreadContextStack.ToString">
  28800. <summary>
  28801. Gets the current context information for this stack.
  28802. </summary>
  28803. <returns>Gets the current context information</returns>
  28804. <remarks>
  28805. <para>
  28806. Gets the current context information for this stack.
  28807. </para>
  28808. </remarks>
  28809. </member>
  28810. <member name="M:log4net.Util.ThreadContextStack.log4net#Core#IFixingRequired#GetFixedObject">
  28811. <summary>
  28812. Get a portable version of this object
  28813. </summary>
  28814. <returns>the portable instance of this object</returns>
  28815. <remarks>
  28816. <para>
  28817. Get a cross thread portable version of this object
  28818. </para>
  28819. </remarks>
  28820. </member>
  28821. <member name="T:log4net.Util.ThreadContextStack.StackFrame">
  28822. <summary>
  28823. Inner class used to represent a single context frame in the stack.
  28824. </summary>
  28825. <remarks>
  28826. <para>
  28827. Inner class used to represent a single context frame in the stack.
  28828. </para>
  28829. </remarks>
  28830. </member>
  28831. <member name="M:log4net.Util.ThreadContextStack.StackFrame.#ctor(System.String,log4net.Util.ThreadContextStack.StackFrame)">
  28832. <summary>
  28833. Constructor
  28834. </summary>
  28835. <param name="message">The message for this context.</param>
  28836. <param name="parent">The parent context in the chain.</param>
  28837. <remarks>
  28838. <para>
  28839. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.StackFrame" /> class
  28840. with the specified message and parent context.
  28841. </para>
  28842. </remarks>
  28843. </member>
  28844. <member name="P:log4net.Util.ThreadContextStack.StackFrame.Message">
  28845. <summary>
  28846. Get the message.
  28847. </summary>
  28848. <value>The message.</value>
  28849. <remarks>
  28850. <para>
  28851. Get the message.
  28852. </para>
  28853. </remarks>
  28854. </member>
  28855. <member name="P:log4net.Util.ThreadContextStack.StackFrame.FullMessage">
  28856. <summary>
  28857. Gets the full text of the context down to the root level.
  28858. </summary>
  28859. <value>
  28860. The full text of the context down to the root level.
  28861. </value>
  28862. <remarks>
  28863. <para>
  28864. Gets the full text of the context down to the root level.
  28865. </para>
  28866. </remarks>
  28867. </member>
  28868. <member name="T:log4net.Util.ThreadContextStack.AutoPopStackFrame">
  28869. <summary>
  28870. Struct returned from the <see cref="M:log4net.Util.ThreadContextStack.Push(System.String)"/> method.
  28871. </summary>
  28872. <remarks>
  28873. <para>
  28874. This struct implements the <see cref="T:System.IDisposable"/> and is designed to be used
  28875. with the <see langword="using"/> pattern to remove the stack frame at the end of the scope.
  28876. </para>
  28877. </remarks>
  28878. </member>
  28879. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameStack">
  28880. <summary>
  28881. The ThreadContextStack internal stack
  28882. </summary>
  28883. </member>
  28884. <member name="F:log4net.Util.ThreadContextStack.AutoPopStackFrame.m_frameDepth">
  28885. <summary>
  28886. The depth to trim the stack to when this instance is disposed
  28887. </summary>
  28888. </member>
  28889. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.#ctor(System.Collections.Stack,System.Int32)">
  28890. <summary>
  28891. Constructor
  28892. </summary>
  28893. <param name="frameStack">The internal stack used by the ThreadContextStack.</param>
  28894. <param name="frameDepth">The depth to return the stack to when this object is disposed.</param>
  28895. <remarks>
  28896. <para>
  28897. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStack.AutoPopStackFrame" /> class with
  28898. the specified stack and return depth.
  28899. </para>
  28900. </remarks>
  28901. </member>
  28902. <member name="M:log4net.Util.ThreadContextStack.AutoPopStackFrame.Dispose">
  28903. <summary>
  28904. Returns the stack to the correct depth.
  28905. </summary>
  28906. <remarks>
  28907. <para>
  28908. Returns the stack to the correct depth.
  28909. </para>
  28910. </remarks>
  28911. </member>
  28912. <member name="T:log4net.Util.ThreadContextStacks">
  28913. <summary>
  28914. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  28915. </summary>
  28916. <remarks>
  28917. <para>
  28918. Implementation of Stacks collection for the <see cref="T:log4net.ThreadContext"/>
  28919. </para>
  28920. </remarks>
  28921. <author>Nicko Cadell</author>
  28922. </member>
  28923. <member name="M:log4net.Util.ThreadContextStacks.#ctor(log4net.Util.ContextPropertiesBase)">
  28924. <summary>
  28925. Internal constructor
  28926. </summary>
  28927. <remarks>
  28928. <para>
  28929. Initializes a new instance of the <see cref="T:log4net.Util.ThreadContextStacks" /> class.
  28930. </para>
  28931. </remarks>
  28932. </member>
  28933. <member name="P:log4net.Util.ThreadContextStacks.Item(System.String)">
  28934. <summary>
  28935. Gets the named thread context stack
  28936. </summary>
  28937. <value>
  28938. The named stack
  28939. </value>
  28940. <remarks>
  28941. <para>
  28942. Gets the named thread context stack
  28943. </para>
  28944. </remarks>
  28945. </member>
  28946. <member name="F:log4net.Util.ThreadContextStacks.declaringType">
  28947. <summary>
  28948. The fully qualified type of the ThreadContextStacks class.
  28949. </summary>
  28950. <remarks>
  28951. Used by the internal logger to record the Type of the
  28952. log message.
  28953. </remarks>
  28954. </member>
  28955. <member name="T:log4net.Util.Transform">
  28956. <summary>
  28957. Utility class for transforming strings.
  28958. </summary>
  28959. <remarks>
  28960. <para>
  28961. Utility class for transforming strings.
  28962. </para>
  28963. </remarks>
  28964. <author>Nicko Cadell</author>
  28965. <author>Gert Driesen</author>
  28966. </member>
  28967. <member name="M:log4net.Util.Transform.#ctor">
  28968. <summary>
  28969. Initializes a new instance of the <see cref="T:log4net.Util.Transform" /> class.
  28970. </summary>
  28971. <remarks>
  28972. <para>
  28973. Uses a private access modifier to prevent instantiation of this class.
  28974. </para>
  28975. </remarks>
  28976. </member>
  28977. <member name="M:log4net.Util.Transform.WriteEscapedXmlString(System.Xml.XmlWriter,System.String,System.String)">
  28978. <summary>
  28979. Write a string to an <see cref="T:System.Xml.XmlWriter"/>
  28980. </summary>
  28981. <param name="writer">the writer to write to</param>
  28982. <param name="textData">the string to write</param>
  28983. <param name="invalidCharReplacement">The string to replace non XML compliant chars with</param>
  28984. <remarks>
  28985. <para>
  28986. The test is escaped either using XML escape entities
  28987. or using CDATA sections.
  28988. </para>
  28989. </remarks>
  28990. </member>
  28991. <member name="M:log4net.Util.Transform.MaskXmlInvalidCharacters(System.String,System.String)">
  28992. <summary>
  28993. Replace invalid XML characters in text string
  28994. </summary>
  28995. <param name="textData">the XML text input string</param>
  28996. <param name="mask">the string to use in place of invalid characters</param>
  28997. <returns>A string that does not contain invalid XML characters.</returns>
  28998. <remarks>
  28999. <para>
  29000. Certain Unicode code points are not allowed in the XML InfoSet, for
  29001. details see: <a href="http://www.w3.org/TR/REC-xml/#charsets">http://www.w3.org/TR/REC-xml/#charsets</a>.
  29002. </para>
  29003. <para>
  29004. This method replaces any illegal characters in the input string
  29005. with the mask string specified.
  29006. </para>
  29007. </remarks>
  29008. </member>
  29009. <member name="M:log4net.Util.Transform.CountSubstrings(System.String,System.String)">
  29010. <summary>
  29011. Count the number of times that the substring occurs in the text
  29012. </summary>
  29013. <param name="text">the text to search</param>
  29014. <param name="substring">the substring to find</param>
  29015. <returns>the number of times the substring occurs in the text</returns>
  29016. <remarks>
  29017. <para>
  29018. The substring is assumed to be non repeating within itself.
  29019. </para>
  29020. </remarks>
  29021. </member>
  29022. <member name="F:log4net.Util.Transform.INVALIDCHARS">
  29023. <summary>
  29024. Characters illegal in XML 1.0
  29025. </summary>
  29026. </member>
  29027. <member name="T:log4net.Util.TypeConverters.BooleanConverter">
  29028. <summary>
  29029. Type converter for Boolean.
  29030. </summary>
  29031. <remarks>
  29032. <para>
  29033. Supports conversion from string to <c>bool</c> type.
  29034. </para>
  29035. </remarks>
  29036. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29037. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29038. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29039. <author>Nicko Cadell</author>
  29040. <author>Gert Driesen</author>
  29041. </member>
  29042. <member name="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)">
  29043. <summary>
  29044. Can the source type be converted to the type supported by this object
  29045. </summary>
  29046. <param name="sourceType">the type to convert</param>
  29047. <returns>true if the conversion is possible</returns>
  29048. <remarks>
  29049. <para>
  29050. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29051. the <see cref="T:System.String"/> type.
  29052. </para>
  29053. </remarks>
  29054. </member>
  29055. <member name="M:log4net.Util.TypeConverters.BooleanConverter.ConvertFrom(System.Object)">
  29056. <summary>
  29057. Convert the source object to the type supported by this object
  29058. </summary>
  29059. <param name="source">the object to convert</param>
  29060. <returns>the converted object</returns>
  29061. <remarks>
  29062. <para>
  29063. Uses the <see cref="M:System.Boolean.Parse(System.String)"/> method to convert the
  29064. <see cref="T:System.String"/> argument to a <see cref="T:System.Boolean"/>.
  29065. </para>
  29066. </remarks>
  29067. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29068. The <paramref name="source"/> object cannot be converted to the
  29069. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.BooleanConverter.CanConvertFrom(System.Type)"/>
  29070. method.
  29071. </exception>
  29072. </member>
  29073. <member name="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29074. <summary>
  29075. Exception base type for conversion errors.
  29076. </summary>
  29077. <remarks>
  29078. <para>
  29079. This type extends <see cref="!:ApplicationException"/>. It
  29080. does not add any new functionality but does differentiate the
  29081. type of exception being thrown.
  29082. </para>
  29083. </remarks>
  29084. <author>Nicko Cadell</author>
  29085. <author>Gert Driesen</author>
  29086. </member>
  29087. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor">
  29088. <summary>
  29089. Constructor
  29090. </summary>
  29091. <remarks>
  29092. <para>
  29093. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29094. </para>
  29095. </remarks>
  29096. </member>
  29097. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String)">
  29098. <summary>
  29099. Constructor
  29100. </summary>
  29101. <param name="message">A message to include with the exception.</param>
  29102. <remarks>
  29103. <para>
  29104. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  29105. with the specified message.
  29106. </para>
  29107. </remarks>
  29108. </member>
  29109. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.#ctor(System.String,System.Exception)">
  29110. <summary>
  29111. Constructor
  29112. </summary>
  29113. <param name="message">A message to include with the exception.</param>
  29114. <param name="innerException">A nested exception to include.</param>
  29115. <remarks>
  29116. <para>
  29117. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class
  29118. with the specified message and inner exception.
  29119. </para>
  29120. </remarks>
  29121. </member>
  29122. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object)">
  29123. <summary>
  29124. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29125. </summary>
  29126. <param name="destinationType">The conversion destination type.</param>
  29127. <param name="sourceValue">The value to convert.</param>
  29128. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" />.</returns>
  29129. <remarks>
  29130. <para>
  29131. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29132. </para>
  29133. </remarks>
  29134. </member>
  29135. <member name="M:log4net.Util.TypeConverters.ConversionNotSupportedException.Create(System.Type,System.Object,System.Exception)">
  29136. <summary>
  29137. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29138. </summary>
  29139. <param name="destinationType">The conversion destination type.</param>
  29140. <param name="sourceValue">The value to convert.</param>
  29141. <param name="innerException">A nested exception to include.</param>
  29142. <returns>An instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" />.</returns>
  29143. <remarks>
  29144. <para>
  29145. Creates a new instance of the <see cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException" /> class.
  29146. </para>
  29147. </remarks>
  29148. </member>
  29149. <member name="T:log4net.Util.TypeConverters.ConverterRegistry">
  29150. <summary>
  29151. Register of type converters for specific types.
  29152. </summary>
  29153. <remarks>
  29154. <para>
  29155. Maintains a registry of type converters used to convert between
  29156. types.
  29157. </para>
  29158. <para>
  29159. Use the <see cref="M:AddConverter(Type, object)"/> and
  29160. <see cref="M:AddConverter(Type, Type)"/> methods to register new converters.
  29161. 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
  29162. lookup appropriate converters to use.
  29163. </para>
  29164. </remarks>
  29165. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29166. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29167. <author>Nicko Cadell</author>
  29168. <author>Gert Driesen</author>
  29169. </member>
  29170. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#ctor">
  29171. <summary>
  29172. Private constructor
  29173. </summary>
  29174. <remarks>
  29175. Initializes a new instance of the <see cref="T:log4net.Util.TypeConverters.ConverterRegistry" /> class.
  29176. </remarks>
  29177. </member>
  29178. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.#cctor">
  29179. <summary>
  29180. Static constructor.
  29181. </summary>
  29182. <remarks>
  29183. <para>
  29184. This constructor defines the intrinsic type converters.
  29185. </para>
  29186. </remarks>
  29187. </member>
  29188. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Object)">
  29189. <summary>
  29190. Adds a converter for a specific type.
  29191. </summary>
  29192. <param name="destinationType">The type being converted to.</param>
  29193. <param name="converter">The type converter to use to convert to the destination type.</param>
  29194. <remarks>
  29195. <para>
  29196. Adds a converter instance for a specific type.
  29197. </para>
  29198. </remarks>
  29199. </member>
  29200. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.AddConverter(System.Type,System.Type)">
  29201. <summary>
  29202. Adds a converter for a specific type.
  29203. </summary>
  29204. <param name="destinationType">The type being converted to.</param>
  29205. <param name="converterType">The type of the type converter to use to convert to the destination type.</param>
  29206. <remarks>
  29207. <para>
  29208. Adds a converter <see cref="T:System.Type"/> for a specific type.
  29209. </para>
  29210. </remarks>
  29211. </member>
  29212. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertTo(System.Type,System.Type)">
  29213. <summary>
  29214. Gets the type converter to use to convert values to the destination type.
  29215. </summary>
  29216. <param name="sourceType">The type being converted from.</param>
  29217. <param name="destinationType">The type being converted to.</param>
  29218. <returns>
  29219. The type converter instance to use for type conversions or <c>null</c>
  29220. if no type converter is found.
  29221. </returns>
  29222. <remarks>
  29223. <para>
  29224. Gets the type converter to use to convert values to the destination type.
  29225. </para>
  29226. </remarks>
  29227. </member>
  29228. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConvertFrom(System.Type)">
  29229. <summary>
  29230. Gets the type converter to use to convert values to the destination type.
  29231. </summary>
  29232. <param name="destinationType">The type being converted to.</param>
  29233. <returns>
  29234. The type converter instance to use for type conversions or <c>null</c>
  29235. if no type converter is found.
  29236. </returns>
  29237. <remarks>
  29238. <para>
  29239. Gets the type converter to use to convert values to the destination type.
  29240. </para>
  29241. </remarks>
  29242. </member>
  29243. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.GetConverterFromAttribute(System.Type)">
  29244. <summary>
  29245. Lookups the type converter to use as specified by the attributes on the
  29246. destination type.
  29247. </summary>
  29248. <param name="destinationType">The type being converted to.</param>
  29249. <returns>
  29250. The type converter instance to use for type conversions or <c>null</c>
  29251. if no type converter is found.
  29252. </returns>
  29253. </member>
  29254. <member name="M:log4net.Util.TypeConverters.ConverterRegistry.CreateConverterInstance(System.Type)">
  29255. <summary>
  29256. Creates the instance of the type converter.
  29257. </summary>
  29258. <param name="converterType">The type of the type converter.</param>
  29259. <returns>
  29260. The type converter instance to use for type conversions or <c>null</c>
  29261. if no type converter is found.
  29262. </returns>
  29263. <remarks>
  29264. <para>
  29265. The type specified for the type converter must implement
  29266. the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/> or <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces
  29267. and must have a public default (no argument) constructor.
  29268. </para>
  29269. </remarks>
  29270. </member>
  29271. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.declaringType">
  29272. <summary>
  29273. The fully qualified type of the ConverterRegistry class.
  29274. </summary>
  29275. <remarks>
  29276. Used by the internal logger to record the Type of the
  29277. log message.
  29278. </remarks>
  29279. </member>
  29280. <member name="F:log4net.Util.TypeConverters.ConverterRegistry.s_type2converter">
  29281. <summary>
  29282. Mapping from <see cref="T:System.Type" /> to type converter.
  29283. </summary>
  29284. </member>
  29285. <member name="T:log4net.Util.TypeConverters.EncodingConverter">
  29286. <summary>
  29287. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  29288. </summary>
  29289. <remarks>
  29290. <para>
  29291. Supports conversion from string to <see cref="T:System.Text.Encoding"/> type.
  29292. </para>
  29293. </remarks>
  29294. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29295. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29296. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29297. <author>Nicko Cadell</author>
  29298. <author>Gert Driesen</author>
  29299. </member>
  29300. <member name="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)">
  29301. <summary>
  29302. Can the source type be converted to the type supported by this object
  29303. </summary>
  29304. <param name="sourceType">the type to convert</param>
  29305. <returns>true if the conversion is possible</returns>
  29306. <remarks>
  29307. <para>
  29308. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29309. the <see cref="T:System.String"/> type.
  29310. </para>
  29311. </remarks>
  29312. </member>
  29313. <member name="M:log4net.Util.TypeConverters.EncodingConverter.ConvertFrom(System.Object)">
  29314. <summary>
  29315. Overrides the ConvertFrom method of IConvertFrom.
  29316. </summary>
  29317. <param name="source">the object to convert to an encoding</param>
  29318. <returns>the encoding</returns>
  29319. <remarks>
  29320. <para>
  29321. Uses the <see cref="M:Encoding.GetEncoding(string)"/> method to
  29322. convert the <see cref="T:System.String"/> argument to an <see cref="T:System.Text.Encoding"/>.
  29323. </para>
  29324. </remarks>
  29325. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29326. The <paramref name="source"/> object cannot be converted to the
  29327. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.EncodingConverter.CanConvertFrom(System.Type)"/>
  29328. method.
  29329. </exception>
  29330. </member>
  29331. <member name="T:log4net.Util.TypeConverters.IConvertFrom">
  29332. <summary>
  29333. Interface supported by type converters
  29334. </summary>
  29335. <remarks>
  29336. <para>
  29337. This interface supports conversion from arbitrary types
  29338. to a single target type. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  29339. </para>
  29340. </remarks>
  29341. <author>Nicko Cadell</author>
  29342. <author>Gert Driesen</author>
  29343. </member>
  29344. <member name="M:log4net.Util.TypeConverters.IConvertFrom.CanConvertFrom(System.Type)">
  29345. <summary>
  29346. Can the source type be converted to the type supported by this object
  29347. </summary>
  29348. <param name="sourceType">the type to convert</param>
  29349. <returns>true if the conversion is possible</returns>
  29350. <remarks>
  29351. <para>
  29352. Test if the <paramref name="sourceType"/> can be converted to the
  29353. type supported by this converter.
  29354. </para>
  29355. </remarks>
  29356. </member>
  29357. <member name="M:log4net.Util.TypeConverters.IConvertFrom.ConvertFrom(System.Object)">
  29358. <summary>
  29359. Convert the source object to the type supported by this object
  29360. </summary>
  29361. <param name="source">the object to convert</param>
  29362. <returns>the converted object</returns>
  29363. <remarks>
  29364. <para>
  29365. Converts the <paramref name="source"/> to the type supported
  29366. by this converter.
  29367. </para>
  29368. </remarks>
  29369. </member>
  29370. <member name="T:log4net.Util.TypeConverters.IConvertTo">
  29371. <summary>
  29372. Interface supported by type converters
  29373. </summary>
  29374. <remarks>
  29375. <para>
  29376. This interface supports conversion from a single type to arbitrary types.
  29377. See <see cref="T:log4net.Util.TypeConverters.TypeConverterAttribute"/>.
  29378. </para>
  29379. </remarks>
  29380. <author>Nicko Cadell</author>
  29381. </member>
  29382. <member name="M:log4net.Util.TypeConverters.IConvertTo.CanConvertTo(System.Type)">
  29383. <summary>
  29384. Returns whether this converter can convert the object to the specified type
  29385. </summary>
  29386. <param name="targetType">A Type that represents the type you want to convert to</param>
  29387. <returns>true if the conversion is possible</returns>
  29388. <remarks>
  29389. <para>
  29390. Test if the type supported by this converter can be converted to the
  29391. <paramref name="targetType"/>.
  29392. </para>
  29393. </remarks>
  29394. </member>
  29395. <member name="M:log4net.Util.TypeConverters.IConvertTo.ConvertTo(System.Object,System.Type)">
  29396. <summary>
  29397. Converts the given value object to the specified type, using the arguments
  29398. </summary>
  29399. <param name="source">the object to convert</param>
  29400. <param name="targetType">The Type to convert the value parameter to</param>
  29401. <returns>the converted object</returns>
  29402. <remarks>
  29403. <para>
  29404. Converts the <paramref name="source"/> (which must be of the type supported
  29405. by this converter) to the <paramref name="targetType"/> specified..
  29406. </para>
  29407. </remarks>
  29408. </member>
  29409. <member name="T:log4net.Util.TypeConverters.IPAddressConverter">
  29410. <summary>
  29411. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  29412. </summary>
  29413. <remarks>
  29414. <para>
  29415. Supports conversion from string to <see cref="T:System.Net.IPAddress"/> type.
  29416. </para>
  29417. </remarks>
  29418. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29419. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29420. <author>Nicko Cadell</author>
  29421. </member>
  29422. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)">
  29423. <summary>
  29424. Can the source type be converted to the type supported by this object
  29425. </summary>
  29426. <param name="sourceType">the type to convert</param>
  29427. <returns>true if the conversion is possible</returns>
  29428. <remarks>
  29429. <para>
  29430. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29431. the <see cref="T:System.String"/> type.
  29432. </para>
  29433. </remarks>
  29434. </member>
  29435. <member name="M:log4net.Util.TypeConverters.IPAddressConverter.ConvertFrom(System.Object)">
  29436. <summary>
  29437. Overrides the ConvertFrom method of IConvertFrom.
  29438. </summary>
  29439. <param name="source">the object to convert to an IPAddress</param>
  29440. <returns>the IPAddress</returns>
  29441. <remarks>
  29442. <para>
  29443. Uses the <see cref="M:System.Net.IPAddress.Parse(System.String)"/> method to convert the
  29444. <see cref="T:System.String"/> argument to an <see cref="T:System.Net.IPAddress"/>.
  29445. If that fails then the string is resolved as a DNS hostname.
  29446. </para>
  29447. </remarks>
  29448. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29449. The <paramref name="source"/> object cannot be converted to the
  29450. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.IPAddressConverter.CanConvertFrom(System.Type)"/>
  29451. method.
  29452. </exception>
  29453. </member>
  29454. <member name="F:log4net.Util.TypeConverters.IPAddressConverter.validIpAddressChars">
  29455. <summary>
  29456. Valid characters in an IPv4 or IPv6 address string. (Does not support subnets)
  29457. </summary>
  29458. </member>
  29459. <member name="T:log4net.Util.TypeConverters.PatternLayoutConverter">
  29460. <summary>
  29461. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  29462. </summary>
  29463. <remarks>
  29464. <para>
  29465. Supports conversion from string to <see cref="T:log4net.Layout.PatternLayout"/> type.
  29466. </para>
  29467. <para>
  29468. The string is used as the <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>
  29469. of the <see cref="T:log4net.Layout.PatternLayout"/>.
  29470. </para>
  29471. </remarks>
  29472. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29473. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29474. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29475. <author>Nicko Cadell</author>
  29476. </member>
  29477. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)">
  29478. <summary>
  29479. Can the source type be converted to the type supported by this object
  29480. </summary>
  29481. <param name="sourceType">the type to convert</param>
  29482. <returns>true if the conversion is possible</returns>
  29483. <remarks>
  29484. <para>
  29485. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29486. the <see cref="T:System.String"/> type.
  29487. </para>
  29488. </remarks>
  29489. </member>
  29490. <member name="M:log4net.Util.TypeConverters.PatternLayoutConverter.ConvertFrom(System.Object)">
  29491. <summary>
  29492. Overrides the ConvertFrom method of IConvertFrom.
  29493. </summary>
  29494. <param name="source">the object to convert to a PatternLayout</param>
  29495. <returns>the PatternLayout</returns>
  29496. <remarks>
  29497. <para>
  29498. Creates and returns a new <see cref="T:log4net.Layout.PatternLayout"/> using
  29499. the <paramref name="source"/> <see cref="T:System.String"/> as the
  29500. <see cref="P:log4net.Layout.PatternLayout.ConversionPattern"/>.
  29501. </para>
  29502. </remarks>
  29503. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29504. The <paramref name="source"/> object cannot be converted to the
  29505. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternLayoutConverter.CanConvertFrom(System.Type)"/>
  29506. method.
  29507. </exception>
  29508. </member>
  29509. <member name="T:log4net.Util.TypeConverters.PatternStringConverter">
  29510. <summary>
  29511. Convert between string and <see cref="T:log4net.Util.PatternString"/>
  29512. </summary>
  29513. <remarks>
  29514. <para>
  29515. Supports conversion from string to <see cref="T:log4net.Util.PatternString"/> type,
  29516. and from a <see cref="T:log4net.Util.PatternString"/> type to a string.
  29517. </para>
  29518. <para>
  29519. The string is used as the <see cref="P:log4net.Util.PatternString.ConversionPattern"/>
  29520. of the <see cref="T:log4net.Util.PatternString"/>.
  29521. </para>
  29522. </remarks>
  29523. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29524. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29525. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29526. <author>Nicko Cadell</author>
  29527. </member>
  29528. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)">
  29529. <summary>
  29530. Can the target type be converted to the type supported by this object
  29531. </summary>
  29532. <param name="targetType">A <see cref="T:System.Type"/> that represents the type you want to convert to</param>
  29533. <returns>true if the conversion is possible</returns>
  29534. <remarks>
  29535. <para>
  29536. Returns <c>true</c> if the <paramref name="targetType"/> is
  29537. assignable from a <see cref="T:System.String"/> type.
  29538. </para>
  29539. </remarks>
  29540. </member>
  29541. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertTo(System.Object,System.Type)">
  29542. <summary>
  29543. Converts the given value object to the specified type, using the arguments
  29544. </summary>
  29545. <param name="source">the object to convert</param>
  29546. <param name="targetType">The Type to convert the value parameter to</param>
  29547. <returns>the converted object</returns>
  29548. <remarks>
  29549. <para>
  29550. Uses the <see cref="M:PatternString.Format()"/> method to convert the
  29551. <see cref="T:log4net.Util.PatternString"/> argument to a <see cref="T:System.String"/>.
  29552. </para>
  29553. </remarks>
  29554. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29555. The <paramref name="source"/> object cannot be converted to the
  29556. <paramref name="targetType"/>. To check for this condition use the
  29557. <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertTo(System.Type)"/> method.
  29558. </exception>
  29559. </member>
  29560. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)">
  29561. <summary>
  29562. Can the source type be converted to the type supported by this object
  29563. </summary>
  29564. <param name="sourceType">the type to convert</param>
  29565. <returns>true if the conversion is possible</returns>
  29566. <remarks>
  29567. <para>
  29568. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29569. the <see cref="T:System.String"/> type.
  29570. </para>
  29571. </remarks>
  29572. </member>
  29573. <member name="M:log4net.Util.TypeConverters.PatternStringConverter.ConvertFrom(System.Object)">
  29574. <summary>
  29575. Overrides the ConvertFrom method of IConvertFrom.
  29576. </summary>
  29577. <param name="source">the object to convert to a PatternString</param>
  29578. <returns>the PatternString</returns>
  29579. <remarks>
  29580. <para>
  29581. Creates and returns a new <see cref="T:log4net.Util.PatternString"/> using
  29582. the <paramref name="source"/> <see cref="T:System.String"/> as the
  29583. <see cref="P:log4net.Util.PatternString.ConversionPattern"/>.
  29584. </para>
  29585. </remarks>
  29586. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29587. The <paramref name="source"/> object cannot be converted to the
  29588. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.PatternStringConverter.CanConvertFrom(System.Type)"/>
  29589. method.
  29590. </exception>
  29591. </member>
  29592. <member name="T:log4net.Util.TypeConverters.TypeConverter">
  29593. <summary>
  29594. Supports conversion from string to <see cref="T:System.Type"/> type.
  29595. </summary>
  29596. <remarks>
  29597. <para>
  29598. Supports conversion from string to <see cref="T:System.Type"/> type.
  29599. </para>
  29600. </remarks>
  29601. <seealso cref="T:log4net.Util.TypeConverters.ConverterRegistry"/>
  29602. <seealso cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29603. <seealso cref="T:log4net.Util.TypeConverters.IConvertTo"/>
  29604. <author>Nicko Cadell</author>
  29605. </member>
  29606. <member name="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)">
  29607. <summary>
  29608. Can the source type be converted to the type supported by this object
  29609. </summary>
  29610. <param name="sourceType">the type to convert</param>
  29611. <returns>true if the conversion is possible</returns>
  29612. <remarks>
  29613. <para>
  29614. Returns <c>true</c> if the <paramref name="sourceType"/> is
  29615. the <see cref="T:System.String"/> type.
  29616. </para>
  29617. </remarks>
  29618. </member>
  29619. <member name="M:log4net.Util.TypeConverters.TypeConverter.ConvertFrom(System.Object)">
  29620. <summary>
  29621. Overrides the ConvertFrom method of IConvertFrom.
  29622. </summary>
  29623. <param name="source">the object to convert to a Type</param>
  29624. <returns>the Type</returns>
  29625. <remarks>
  29626. <para>
  29627. Uses the <see cref="M:Type.GetType(string,bool)"/> method to convert the
  29628. <see cref="T:System.String"/> argument to a <see cref="T:System.Type"/>.
  29629. Additional effort is made to locate partially specified types
  29630. by searching the loaded assemblies.
  29631. </para>
  29632. </remarks>
  29633. <exception cref="T:log4net.Util.TypeConverters.ConversionNotSupportedException">
  29634. The <paramref name="source"/> object cannot be converted to the
  29635. target type. To check for this condition use the <see cref="M:log4net.Util.TypeConverters.TypeConverter.CanConvertFrom(System.Type)"/>
  29636. method.
  29637. </exception>
  29638. </member>
  29639. <member name="T:log4net.Util.TypeConverters.TypeConverterAttribute">
  29640. <summary>
  29641. Attribute used to associate a type converter
  29642. </summary>
  29643. <remarks>
  29644. <para>
  29645. Class and Interface level attribute that specifies a type converter
  29646. to use with the associated type.
  29647. </para>
  29648. <para>
  29649. To associate a type converter with a target type apply a
  29650. <c>TypeConverterAttribute</c> to the target type. Specify the
  29651. type of the type converter on the attribute.
  29652. </para>
  29653. </remarks>
  29654. <author>Nicko Cadell</author>
  29655. <author>Gert Driesen</author>
  29656. </member>
  29657. <member name="F:log4net.Util.TypeConverters.TypeConverterAttribute.m_typeName">
  29658. <summary>
  29659. The string type name of the type converter
  29660. </summary>
  29661. </member>
  29662. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor">
  29663. <summary>
  29664. Default constructor
  29665. </summary>
  29666. <remarks>
  29667. <para>
  29668. Default constructor
  29669. </para>
  29670. </remarks>
  29671. </member>
  29672. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.String)">
  29673. <summary>
  29674. Create a new type converter attribute for the specified type name
  29675. </summary>
  29676. <param name="typeName">The string type name of the type converter</param>
  29677. <remarks>
  29678. <para>
  29679. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29680. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  29681. </para>
  29682. </remarks>
  29683. </member>
  29684. <member name="M:log4net.Util.TypeConverters.TypeConverterAttribute.#ctor(System.Type)">
  29685. <summary>
  29686. Create a new type converter attribute for the specified type
  29687. </summary>
  29688. <param name="converterType">The type of the type converter</param>
  29689. <remarks>
  29690. <para>
  29691. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29692. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  29693. </para>
  29694. </remarks>
  29695. </member>
  29696. <member name="P:log4net.Util.TypeConverters.TypeConverterAttribute.ConverterTypeName">
  29697. <summary>
  29698. The string type name of the type converter
  29699. </summary>
  29700. <value>
  29701. The string type name of the type converter
  29702. </value>
  29703. <remarks>
  29704. <para>
  29705. The type specified must implement the <see cref="T:log4net.Util.TypeConverters.IConvertFrom"/>
  29706. or the <see cref="T:log4net.Util.TypeConverters.IConvertTo"/> interfaces.
  29707. </para>
  29708. </remarks>
  29709. </member>
  29710. </members>
  29711. </doc>